PluginBench
Skill
Pass
Audit score 90

golang-context

samber/cc-skills-golang

Idiomatic context.Context propagation, cancellation, timeouts, and request-scoped values in Go

What is golang-context?

context.Context is Go's mechanism for propagating cancellation signals, deadlines, and request-scoped values across API boundaries. This skill covers best practices for context propagation through request lifecycles, choosing the right context constructor, managing cancellation and timeouts, storing values safely, and using context.WithoutCancel for background work that outlives requests.

  • Propagate context through entire request lifecycle from HTTP handlers to services to databases
  • Manage cancellation signals, timeouts, and deadlines across goroutines and API boundaries
  • Store and retrieve request-scoped metadata (request IDs, user IDs, trace context) safely
  • Use context.WithoutCancel (Go 1.21+) for background operations that must outlive parent requests
  • Avoid common pitfalls: nil contexts, context in structs, creating Background() mid-request, leaked cancel functions

How to install golang-context

npx skills add https://github.com/samber/cc-skills-golang --skill golang-context
Prerequisites
  • Go 1.13+ (1.21+ recommended for context.WithoutCancel)
  • Familiarity with goroutines and basic concurrency patterns
Claude Code
Cursor
Windsurf
Cline

How to use golang-context

  1. 1.Review the context creation table to choose the right constructor for your entry point (Background, TODO, WithCancel, WithTimeout)
  2. 2.Ensure ctx is the first parameter in all functions that need it, named ctx context.Context
  3. 3.Propagate the same context through your entire call chain—never create a new Background() mid-request
  4. 4.For cancellation: call cancel() on all control-flow paths, or explicitly transfer ownership to the caller
  5. 5.Use unexported types as context value keys to prevent namespace collisions
  6. 6.Apply context.WithoutCancel when spawning background work that must outlive the parent request
  7. 7.Run linters (govet, staticcheck) to catch context pitfalls automatically

Use cases

Good for
  • Designing context propagation across HTTP handlers, service layers, and database operations
  • Implementing request timeouts and automatic cancellation of downstream work
  • Propagating trace context and correlation IDs across service boundaries
  • Spawning background tasks (audit logs, notifications) that survive request cancellation
  • Debugging context leaks and ensuring cancel() is called on all control-flow paths
Who it's for
  • Go backend developers designing layered architectures
  • Teams building microservices with cross-service context propagation
  • Developers implementing observability and tracing with context values
  • Anyone building concurrent systems that need coordinated cancellation

golang-context FAQ

When should I use context.Background() vs context.TODO()?

Use context.Background() only at entry points (main, init, tests). Use context.TODO() as a placeholder when you know a context is needed but don't have one yet—it signals intent to add proper context later.

Why shouldn't I store context in a struct?

Storing context in a struct breaks explicit propagation and makes cancellation semantics unclear. Always pass context as the first function parameter so the call chain is visible and cancellation flows naturally.

What is context.WithoutCancel and when do I use it?

context.WithoutCancel (Go 1.21+) creates a child context that inherits values but not cancellation. Use it when spawning background work (audit logs, notifications) that must complete even if the parent request is cancelled.

How do I safely store values in context?

Use unexported types as keys to prevent namespace collisions. Only store request-scoped metadata (request ID, user ID, trace context)—never use context for function parameters or application state.

What happens if I forget to call cancel()?

The context and its associated resources leak. Always call cancel() on all control-flow paths for WithCancel, WithTimeout, and WithDeadline, or explicitly transfer ownership to the caller.

Full instructions (SKILL.md)

Source of truth, from samber/cc-skills-golang.


name: golang-context description: "Idiomatic context.Context usage in Golang — propagation through API boundaries, cancellation, timeouts and deadlines, request-scoped values, context.WithoutCancel for background work outliving requests. Apply when designing context propagation across layers, debugging leaked or unexpired contexts, choosing between context.Background/TODO/WithoutCancel, or storing values in context. Not for code that merely accepts ctx as first parameter." user-invocable: true license: MIT compatibility: Designed for Claude Code or similar AI coding agents, and for projects using Golang. metadata: author: samber version: "1.2.1" openclaw: emoji: "🔗" homepage: https://github.com/samber/cc-skills-golang requires: bins: - go install: [] allowed-tools: Read Edit Write Glob Grep Bash(go:) Bash(golangci-lint:) Bash(git:*) Agent

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.