Go Chi Context-Bound Buffer Pooling and Allocation Quota Standard

--- description: Go Chi Context-Bound Buffer Pooling and Allocation Quota Standard - Enforces strict buffer pooling lifecycle management and per-request allocation quotas within Go Chi HTTP services. Eliminates catastrophic GC pauses, stop-the-world spikes, and sync.Pool heap fragmentation caused by unbounded allocations and oversized buffer retention during fragmented multipart and chunked payload ingestion. globs: **/*.go alwaysApply: true verified_by: "agentrules.org" license: "CC-BY-4.0" source: "https://agentrules.org/rules/go-chi-context-buffer-pool-quota-standard" --- # Go Chi Context-Bound Buffer Pooling and Allocation Quota Standard > **Severity**: CRITICAL | **Category**: backend > **Anti-Pattern Warning**: Unbounded io.ReadAll and Naked Buffer Allocations Inducing Memory Fragmentation and GC Spikes ## System Constraints You are a Principal Go Systems Architect enforcing strict memory pooling, slice lifecycle control, and bounded context allocation quotas across high-throughput Chi HTTP microservices. Ensure zero raw allocations during stream/multipart reads, eliminate sync.Pool buffer retention poisoning, and enforce hard allocation quotas. ## Strict Guidelines - Engineers MUST NEVER use `io.ReadAll` or naked `bytes.Buffer` instantiations inside Chi route handlers or middleware processing stream or multipart request bodies. - Engineers MUST ALWAYS wrap `r.Body` with `io.LimitReader(r.Body, maxBytesQuota)` before initiating read operations to enforce hard payload quotas at the transport layer. - Engineers MUST implement tiered buffer pools with fixed size tiers (e.g., Small 4KB, Medium 64KB, Large 512KB) instead of dynamic arbitrary slice expansions. - Engineers MUST ALWAYS inspect buffer capacity before returning it to `sync.Pool`; buffers that expanded beyond their tier threshold MUST be discarded to garbage collection rather than pooled to prevent permanent heap inflation. - Buffers MUST ALWAYS have their slice lengths reset to zero via `b.Reset()` or `buf = buf[:0]` prior to being recycled into a `sync.Pool`. - Code MUST bind buffer acquisition and deterministic release to either standard `defer` blocks within the handler scope or clean Context-cancellation hooks (`r.Context().Done()`) to avoid pool leakage on early client disconnects. ## Bad vs Good Implementations ### Chunked Payload Reading: Unbounded io.ReadAll vs. Bounded Tiered Pool Processing #### Bad Antipattern (AI Common Hallucination) > **Why it fails**: Using io.ReadAll allocates continuously on the heap as slices resize (1KB, 2KB, 4KB, 8KB...), exhausting allocator arenas and triggering frequent Stop-The-World GC sweeps under high concurrency. Additionally, unbounded reads allow malicious clients to exhaust pod memory. ```go package handler import ( "io" "net/http" "github.com/go-chi/chi/v5" ) func RegisterBadRoutes(r chi.Router) { r.Post("/upload", func(w http.ResponseWriter, r *http.Request) { // ANTI-PATTERN: io.ReadAll dynamically grows an unpooled slice without // upper memory bounds, creating severe GC allocation thrash and vulnerability to DoS. payload, err := io.ReadAll(r.Body) if err != nil { http.Error(w, "failed to read body", http.StatusBadRequest) return } defer r.Body.Close() w.WriteHeader(http.StatusOK) w.Write([]byte(payload)) }) } ``` #### Production Standard (Correct) > **Standard**: Employs a sync.Pool guarded by MaxPooledRetention to prevent oversized allocations from permanently occupying pool memory. It protects concurrency with io.LimitReader and recycles buffers with buf.Reset(), maintaining zero allocations on steady-state ingress and predictable GC latency. ```go package handler import ( "bytes" "io" "net/http" "sync" "github.com/go-chi/chi/v5" ) const ( MaxRequestQuotaBytes = 2 * 1024 * 1024 // 2MB hard quota PooledBufferCapacity = 64 * 1024 // 64KB initial chunk buffer MaxPooledRetention = 256 * 1024 // 256KB max retention limit ) var bufferPool = sync.Pool{ New: func() any { return bytes.NewBuffer(make([]byte, 0, PooledBufferCapacity)) }, } func getBuffer() *bytes.Buffer { return bufferPool.Get().(*bytes.Buffer) } func putBuffer(buf *bytes.Buffer) { // Guard against sync.Pool heap bloat: discard if buffer grew past threshold if buf.Cap() > MaxPooledRetention { return } buf.Reset() bufferPool.Put(buf) } func RegisterGoodRoutes(r chi.Router) { r.Post("/upload", func(w http.ResponseWriter, r *http.Request) { defer r.Body.Close() buf := getBuffer() defer putBuffer(buf) // Bound memory ingress using io.LimitReader to eliminate OOM exposure limitedReader := io.LimitReader(r.Body, MaxRequestQuotaBytes+1) n, err := buf.ReadFrom(limitedReader) if err != nil { http.Error(w, "read error", http.StatusInternalServerError) return } if n > MaxRequestQuotaBytes { http.Error(w, "payload exceeds allocation quota", http.StatusRequestEntityTooLarge) return } w.WriteHeader(http.StatusOK) w.Write(buf.Bytes()) }) } ```

Architectural Specification & Invariant Rationale

Architectural Invariant Design: Go Chi Context-Bound Buffer Pooling and Allocation Quota Standard

Go Chi Context-Bound Buffer Pooling and Allocation Quota Standard defines an industrial-grade behavioral standard for backend engineering. Enforces strict buffer pooling lifecycle management and per-request allocation quotas within Go Chi HTTP services. Eliminates catastrophic GC pauses, stop-the-world spikes, and sync.Pool heap fragmentation caused by unbounded allocations and oversized buffer retention during fragmented multipart and chunked payload ingestion. Modern software architectures require strict adherence to deterministic patterns to guarantee high availability, maintainability, and zero security vulnerabilities.

Framework Paradigm Shift & Drift MechanicsLLMs are trained on millions of open-source repositories containing outdated code, legacy idioms, and unpatched antipatterns. When coding assistants generate implementations for this stack, they default to common statistical tokens: Unbounded io.ReadAll and Naked Buffer Allocations Inducing Memory Fragmentation and GC Spikes Without an explicit system instruction file, developers spend hours debugging silent failures.

Failure Modes & Production Blast Radius

Hazard Analysis: What Breaks Without This Rule

The following failure modes have been cataloged from hundreds of hours of production code reviews where AI assistants produced non-compliant implementations:

Failure Mode	AI Symptom (The Anti-Pattern)	Severity	Production Impact & Remedy
AI Hallucination & Deprecation Drift	Unbounded io.ReadAll and Naked Buffer Allocations Inducing Memory Fragmentation and GC Spikes	Critical	Violating this industrial standard introduces regression bugs, security risks, and unexpected runtime failures in production. Enforce explicit behavioral system directives across all AI coding assistants in your repository.
Silent Architecture Inconsistency	AI assistants produce mixed paradigms across files, creating fragmented codebase conventions.	Medium	Increases cognitive load during code reviews and leads to maintenance debt across engineering teams. Pin project conventions in .cursor/rules, CLAUDE.md, and AGENTS.md so all team agents follow identical guardrails.

Architectural Directives in Detail

Step-by-Step Production Directives

Each rule constraint below is injected into the AI agent's system prompt to establish deterministic boundaries:

Engineers MUST NEVER use `io.ReadAll` or naked `bytes.Buffer` instantiations inside Chi route handlers or middleware processing stream or multipart request bodies.

Rationale:AI models frequently generate unconstrained code here because statistical language distributions lack project-specific architectural context. Mandating this directive ensures that generated code adheres to verified industrial production requirements.