golang-context

por samber

Uso idiomático de context.Context em Golang — propagação através de limites de API, cancelamento, timeouts e deadlines, valores de escopo de requisição, context.WithoutCancel para trabalhos em segundo plano que sobrevivem às requisições. Aplicar ao projetar propagação de contexto entre camadas, depurar contextos vazados ou não expirados, escolher entre context.Background/TODO/WithoutCancel, ou armazenar valores no contexto. Não se aplica a código que apenas aceita ctx como primeiro parâmetro.

npx skills add https://github.com/samber/cc-skills-golang --skill golang-context

Community default. A company skill that explicitly supersedes samber/cc-skills-golang@golang-context skill takes precedence.

Go context.Context Best Practices

context.Context is Go's mechanism for propagating cancellation signals, deadlines, and request-scoped values across API boundaries and between goroutines. Think of it as the "session" of a request — it ties together every operation that belongs to the same unit of work.

Best Practices Summary

  1. The same context MUST be propagated through the entire request lifecycle: HTTP handler → service → DB → external APIs
  2. ctx MUST be the first parameter, named ctx context.Context
  3. NEVER store context in a struct — pass explicitly through function parameters
  4. NEVER pass nil context — use context.TODO() if unsure
  5. cancel() MUST be called on all control-flow paths for WithCancel/WithTimeout/WithDeadline, unless ownership of the context and cancel function is explicitly returned or transferred
  6. context.Background() MUST only be used at the top level (main, init, tests)
  7. Use context.TODO() as a placeholder when you know a context is needed but don't have one yet
  8. NEVER create a new context.Background() in the middle of a request path
  9. Context value keys MUST be unexported types to prevent collisions
  10. Context values MUST only carry request-scoped metadata — NEVER function parameters
  11. Use context.WithoutCancel (Go 1.21+) when spawning background work that must outlive the parent request

Creating Contexts

SituationUse
Entry point (main, init, test)context.Background()
Function needs context but caller doesn't provide one yetcontext.TODO()
Inside an HTTP handlerr.Context()
Need cancellation controlcontext.WithCancel(parentCtx)
Need a deadline/timeoutcontext.WithTimeout(parentCtx, duration)

Context Propagation: The Core Principle

The most important rule: propagate the same context through the entire call chain. When you propagate correctly, cancelling the parent context cancels all downstream work automatically.

// ✗ Bad — creates a new context, breaking the chain
func (s *OrderService) Create(ctx context.Context, order Order) error {
    return s.db.ExecContext(context.Background(), "INSERT INTO orders ...", order.ID)
}

// ✓ Good — propagates the caller's context
func (s *OrderService) Create(ctx context.Context, order Order) error {
    return s.db.ExecContext(ctx, "INSERT INTO orders ...", order.ID)
}

Deep Dives

  • Cancellation, Timeouts & Deadlines — How cancellation propagates: WithCancel for manual cancellation, WithTimeout for automatic cancellation after a duration, WithDeadline for absolute time deadlines. Patterns for listening (<-ctx.Done()) in concurrent code, AfterFunc callbacks, and WithoutCancel for operations that must outlive their parent request (e.g., audit logs).

  • Context Values & Cross-Service Tracing — Safe context value patterns: unexported key types to prevent namespace collisions, when to use context values (request ID, user ID) vs function parameters. Trace context propagation: OpenTelemetry trace headers, correlation IDs for log aggregation, and marshaling/unmarshaling context across service boundaries.

  • Context in HTTP Servers & Service Calls — HTTP handler context: r.Context() for request-scoped cancellation, middleware integration, and propagating to services. HTTP client patterns: NewRequestWithContext, client timeouts, and retries with context awareness. Database operations: always use *Context variants (QueryContext, ExecContext) to respect deadlines.

Cross-References

  • → See the samber/cc-skills-golang@golang-concurrency skill for goroutine cancellation patterns using context
  • → See the samber/cc-skills-golang@golang-database skill for context-aware database operations (QueryContext, ExecContext)
  • → See the samber/cc-skills-golang@golang-observability skill for trace context propagation with OpenTelemetry
  • → See the samber/cc-skills-golang@golang-design-patterns skill for timeout and resilience patterns

Enforce with Linters

Many context pitfalls are caught automatically by linters: govet, staticcheck. → See the samber/cc-skills-golang@golang-lint skill for configuration and usage.

Mais skills de samber

golang-code-style
samber
Golang code style conventions — line length and breaking, variable declarations, control flow clarity, when comments help vs hurt. Use when writing or reviewing Go code, asking about style or clarity, or establishing project coding standards. Not for naming conventions (→ See `samber/cc-skills-golang@golang-naming` skill), linter configuration (→ See `samber/cc-skills-golang@golang-lint` skill), or doc comments (→ See `samber/cc-skills-golang@golang-documentation` skill).
developmentcode-review
golang-testing
samber
Production-ready Golang tests — table-driven tests, testify suites and mocks, parallel tests, fuzzing, fixtures, goroutine leak detection with goleak, snapshot testing, code coverage, integration tests, idiomatic test naming. Use when writing or reviewing Go tests, choosing a testing approach, setting up Go test CI, or debugging flaky/slow tests. For testify-specific APIs see `samber/cc-skills-golang@golang-stretchr-testify`; for measurement methodology see...
developmenttestingcode-review
golang-design-patterns
samber
Padrões de design idiomáticos em Golang — opções funcionais, construtores, fluxo e cascata de erros, gerenciamento e ciclo de vida de recursos, desligamento gracioso, resiliência, arquitetura, injeção de dependência, manipulação de dados, streaming e mais. Aplicar ao escolher explicitamente entre padrões arquiteturais, implementar opções funcionais, projetar APIs de construtores, configurar desligamento gracioso, aplicar padrões de resiliência ou perguntar qual padrão idiomático Go se adequa a um problema específico.
developmentdesigncode-review
golang-error-handling
samber
Idiomatic Golang error handling — creation, wrapping with %w, errors.Is/As, errors.Join, custom error types, sentinel errors, panic/recover, the single handling rule, structured logging with slog, HTTP request logging middleware, and samber/oops for production errors. Built to make logs usable at scale with log aggregation 3rd-party tools. Apply when creating, wrapping, inspecting, or logging errors in Go code. For samber/oops specifics → See `samber/cc-skills-golang@golang-samber-oops`...
developmentcode-review
golang-performance
samber
Padrões e metodologia de otimização de desempenho em Golang - se gargalo X, então aplique Y. Abrange redução de alocação, eficiência de CPU, layout de memória, ajuste de GC, pooling, caching e otimização de hot-path. Use quando profiling ou benchmarks identificaram um gargalo e você precisa do padrão de otimização correto para corrigi-lo. Use também ao realizar revisão de código de desempenho para sugerir melhorias ou benchmarks que possam ajudar a identificar ganhos rápidos de desempenho. Não é para metodologia de medição (→...
developmentcode-review
golang-security
samber
Práticas recomendadas de segurança e prevenção de vulnerabilidades para Golang. Aborda injeção (SQL, comando, XSS), criptografia, segurança de sistema de arquivos, segurança de rede, cookies, gerenciamento de segredos, segurança de memória e registro. Aplicar ao escrever, revisar ou auditar código Go para segurança, ou ao trabalhar em qualquer código arriscado envolvendo criptografia, E/S, gerenciamento de segredos, manipulação de entrada do usuário ou autenticação. Inclui configuração de ferramentas de segurança.
securitycode-reviewdevelopment
golang-database
samber
Guia abrangente para acesso a banco de dados em Go — consultas parametrizadas, escaneamento de structs, colunas anuláveis, transações, níveis de isolamento, SELECT FOR UPDATE, pool de conexões, processamento em lote, propagação de contexto e ferramentas de migração. Use ao escrever, revisar ou depurar código Golang que interage com PostgreSQL, MariaDB, MySQL ou SQLite; para testes de banco de dados; ou para dúvidas sobre database/sql, sqlx ou pgx. NÃO gera esquemas de banco de dados ou SQL de migração.
developmentdatabase
golang-lint
samber
Melhores práticas de linting e configuração do golangci-lint para projetos Golang — execução de linters, configuração do .golangci.yml, supressão de avisos com diretivas nolint, interpretação da saída de lint e seleção de linters. Use ao configurar o golangci-lint, ao perguntar sobre avisos de lint ou supressões nolint, ao configurar ferramentas de qualidade de código ou ao escolher linters. Use também quando o usuário mencionar golangci-lint, go vet, staticcheck ou revive.
developmentcode-reviewtesting