golang-context

oleh samber

Penggunaan idiomatis context.Context di Golang — propagasi melalui batas API, pembatalan, batas waktu dan tenggat, nilai dalam lingkup permintaan, context.WithoutCancel untuk pekerjaan latar yang melampaui permintaan. Terapkan saat merancang propagasi konteks antar lapisan, men-debug konteks yang bocor atau tidak kedaluwarsa, memilih antara context.Background/TODO/WithoutCancel, atau menyimpan nilai dalam konteks. Bukan untuk kode yang hanya menerima ctx sebagai parameter pertama.

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.

Lebih banyak skill dari 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
Pola desain Golang yang idiomatis — opsi fungsional, konstruktor, aliran dan kaskade kesalahan, manajemen sumber daya dan siklus hidup, penghentian secara bertahap, ketahanan, arsitektur, injeksi dependensi, penanganan data, streaming, dan lainnya. Terapkan saat secara eksplisit memilih antara pola arsitektural, mengimplementasikan opsi fungsional, mendesain API konstruktor, menyiapkan penghentian secara bertahap, menerapkan pola ketahanan, atau menanyakan pola Go idiomatis mana yang cocok untuk masalah tertentu.
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
Pola dan metodologi optimasi performa Golang - jika X bottleneck, maka terapkan Y. Mencakup pengurangan alokasi, efisiensi CPU, tata letak memori, penyesuaian GC, pooling, caching, dan optimasi jalur panas. Gunakan saat profiling atau benchmark telah mengidentifikasi bottleneck dan Anda membutuhkan pola optimasi yang tepat untuk memperbaikinya. Juga gunakan saat melakukan tinjauan kode performa untuk menyarankan perbaikan atau benchmark yang dapat membantu mengidentifikasi peningkatan performa cepat. Bukan untuk metodologi pengukuran (→...
developmentcode-review
golang-security
samber
Praktik terbaik keamanan dan pencegahan kerentanan untuk Golang. Mencakup injeksi (SQL, command, XSS), kriptografi, keamanan sistem file, keamanan jaringan, cookie, manajemen rahasia, keamanan memori, dan pencatatan log. Terapkan saat menulis, meninjau, atau mengaudit kode Go untuk keamanan, atau saat mengerjakan kode berisiko yang melibatkan kripto, I/O, manajemen rahasia, penanganan input pengguna, atau autentikasi. Termasuk konfigurasi alat keamanan.
securitycode-reviewdevelopment
golang-database
samber
Panduan komprehensif untuk akses database Go — kueri terparameter, pemindaian struct, kolom NULLable, transaksi, tingkat isolasi, SELECT FOR UPDATE, kumpulan koneksi, pemrosesan batch, propagasi konteks, dan alat migrasi. Gunakan saat menulis, meninjau, atau men-debug kode Golang yang berinteraksi dengan PostgreSQL, MariaDB, MySQL, atau SQLite; untuk pengujian database; atau untuk pertanyaan tentang database/sql, sqlx, atau pgx. TIDAK menghasilkan skema database atau SQL migrasi.
developmentdatabase
golang-lint
samber
Praktik terbaik linting dan konfigurasi golangci-lint untuk proyek Golang — menjalankan linter, mengonfigurasi .golangci.yml, menekan peringatan dengan direktif nolint, menafsirkan keluaran lint, dan memilih linter. Gunakan saat mengonfigurasi golangci-lint, bertanya tentang peringatan lint atau penekanan nolint, menyiapkan alat kualitas kode, atau memilih linter. Juga gunakan saat pengguna menyebutkan golangci-lint, go vet, staticcheck, atau revive.
developmentcode-reviewtesting