Skip to content

henriqueatila/golang-gin-best-practices / skills/golang-gin-api

golang-gin-api

Verified

Build REST APIs with Go Gin. Use when creating Go web servers, adding Gin routes, writing handlers, or asking about middleware, binding, error handling, or project structure.

FileKindSize
SKILL.mdskill md10.0 KB
metadata.jsonconfig482 B
references/background-jobs-goroutine-and-pool.mdmarkdown3.5 KB
references/background-jobs-queue-and-shutdown.mdmarkdown3.5 KB
references/defensive-handler-patterns.mdmarkdown3.7 KB
references/error-handling-apperror.mdmarkdown4.1 KB
references/error-handling-recovery.mdmarkdown1.8 KB
references/error-handling-validation.mdmarkdown3.0 KB
references/file-uploads-cloud.mdmarkdown2.4 KB
references/file-uploads-local.mdmarkdown4.0 KB
references/middleware-core.mdmarkdown4.2 KB
references/middleware-logging-and-recovery.mdmarkdown3.3 KB
references/middleware-timeout-and-custom.mdmarkdown3.2 KB
references/rate-limiting-algorithms.mdmarkdown3.5 KB
references/rate-limiting-fallback.mdmarkdown2.3 KB
references/rate-limiting-headers.mdmarkdown1.8 KB
references/rate-limiting-peruser.mdmarkdown2.4 KB
references/rate-limiting-redis-sliding.mdmarkdown2.2 KB
references/rate-limiting-redis.mdmarkdown2.9 KB
references/rate-limiting-sliding-window.mdmarkdown2.2 KB
references/rate-limiting-tiered.mdmarkdown3.0 KB
references/routing-groups-and-versioning.mdmarkdown3.8 KB
references/routing-params-and-wildcards.mdmarkdown3.4 KB
references/routing-validators-and-limits.mdmarkdown2.4 KB
references/safe-context-extraction.mdmarkdown4.3 KB
references/server-handlers-and-errors.mdmarkdown3.6 KB
references/server-setup-and-routes.mdmarkdown3.9 KB
references/websocket-auth-and-keepalive.mdmarkdown3.5 KB
references/websocket-chat-handler.mdmarkdown1.5 KB
references/websocket-hub-and-client.mdmarkdown3.9 KB
references/websocket-setup-and-echo.mdmarkdown3.4 KB
references/websocket-shutdown-and-messages.mdmarkdown3.8 KB
references/websocket-testing.mdmarkdown3.8 KB

references/websocket-testing.md

View on GitHub
# WebSocket — Testing

See also: `websocket-setup-and-echo.md`, `websocket-hub-and-client.md`, `websocket-auth-and-keepalive.md`, `websocket-shutdown-and-messages.md`

## Testing WebSocket Handlers

WebSocket tests require a real TCP server — `httptest.NewServer` + `websocket.DefaultDialer.Dial`. You cannot use `httptest.NewRecorder` because the upgrade requires a hijackable connection.

```go
// internal/ws/echo_test.go
package ws_test

import (
    "net/http/httptest"
    "strings"
    "testing"
    "time"

    "github.com/gin-gonic/gin"
    "github.com/gorilla/websocket"

    ws "github.com/yourorg/yourapp/internal/ws"
)

func newTestServer(t *testing.T) *httptest.Server {
    t.Helper()
    gin.SetMode(gin.TestMode)
    r := gin.New()
    r.GET("/ws/echo", ws.EchoHandler)
    return httptest.NewServer(r)
}

func wsURL(srv *httptest.Server, path string) string {
    return "ws" + strings.TrimPrefix(srv.URL, "http") + path
}

func TestEchoHandler_RoundTrip(t *testing.T) {
    srv := newTestServer(t)
    defer srv.Close()

    dialer := websocket.Dialer{HandshakeTimeout: 3 * time.Second}
    conn, resp, err := dialer.Dial(wsURL(srv, "/ws/echo"), nil)
    if err != nil {
        t.Fatalf("dial failed: %v (status %d)", err, resp.StatusCode)
    }
    defer conn.Close()

    want := "hello"
    if err := conn.WriteMessage(websocket.TextMessage, []byte(want)); err != nil {
        t.Fatalf("write failed: %v", err)
    }

    conn.SetReadDeadline(time.Now().Add(3 * time.Second))
    _, got, err := conn.ReadMessage()
    if err != nil {
        t.Fatalf("read failed: %v", err)
    }

    if string(got) != want {
        t.Errorf("got %q, want %q", got, want)
    }
}

func TestEchoHandler_ClientClose(t *testing.T) {
    srv := newTestServer(t)
    defer srv.Close()

    conn, _, err := websocket.DefaultDialer.Dial(wsURL(srv, "/ws/echo"), nil)
    if err != nil {
        t.Fatalf("dial failed: %v", err)
    }

    err = conn.WriteMessage(
        websocket.CloseMessage,
        websocket.FormatCloseMessage(websocket.CloseNormalClosure, "done"),
    )
    if err != nil {
        t.Fatalf("close write failed: %v", err)
    }

    conn.SetReadDeadline(time.Now().Add(2 * time.Second))
    _, _, err = conn.ReadMessage()
    if err == nil {
        t.Error("expected error after close, got nil")
    }
}

func TestChatHandler_Broadcast(t *testing.T) {
    gin.SetMode(gin.TestMode)
    hub := ws.NewHub()
    go hub.Run()
    defer hub.Shutdown()

    r := gin.New()
    r.GET("/ws/chat", ws.ChatHandler(hub))
    srv := httptest.NewServer(r)
    defer srv.Close()

    dial := func() *websocket.Conn {
        conn, _, err := websocket.DefaultDialer.Dial(wsURL(srv, "/ws/chat"), nil)
        if err != nil {
            t.Fatalf("dial failed: %v", err)
        }
        return conn
    }

    c1 := dial()
    c2 := dial()
    defer c1.Close()
    defer c2.Close()

    time.Sleep(50 * time.Millisecond) // let register events process

    want := "broadcast-test"
    if err := c1.WriteMessage(websocket.TextMessage, []byte(want)); err != nil {
        t.Fatalf("c1 write failed: %v", err)
    }

    for _, conn := range []*websocket.Conn{c1, c2} {
        conn.SetReadDeadline(time.Now().Add(2 * time.Second))
        _, msg, err := conn.ReadMessage()
        if err != nil {
            t.Fatalf("read failed: %v", err)
        }
        if string(msg) != want {
            t.Errorf("got %q, want %q", msg, want)
        }
    }
}
```

**Key testing patterns:**
- Use `httptest.NewServer` (not `httptest.NewRecorder`) — WebSocket requires a hijackable TCP connection.
- Convert `http://` to `ws://` with `strings.TrimPrefix`.
- Set `SetReadDeadline` in tests to prevent hangs on failure.
- Test both happy path and clean disconnect to verify server-side cleanup.
- `hub.Shutdown()` in defer ensures test goroutines exit cleanly.
receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementationStars: 322kUpdated Claude CodeCodexVerifiedInstall
requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirementsStars: 322kUpdated Claude CodeCodexVerifiedInstall
using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallbackStars: 322kUpdated Claude CodeCodexVerifiedInstall
verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions alwaysStars: 322kUpdated Claude CodeCodexVerifiedInstall