Walkthrough

This PR introduces context-based enforcement for returning usage data in streaming responses. It adds a context key to control usage data injection, implements stream options cloning to prevent mutation, and updates handler logic to conditionally inject IncludeUsage when enforcement is enabled. Changes span context management, provider adapters, server handlers, and usage logging.

Changes

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Handler as Server Handler
    participant Context as Context Ctx
    participant Adapter as Provider Adapter
    participant Provider as Chat Provider

    Client->>Handler: Stream Chat Request
    Handler->>Handler: Check shouldEnforceReturningUsageData()
    alt Enforcement Enabled
        Handler->>Handler: cloneChatRequestForStreamUsage(req)
        Handler->>Handler: Set IncludeUsage: true in StreamOptions
        Handler->>Context: WithEnforceReturningUsageData(ctx, true)
    end
    Handler->>Provider: Call with enforced context & cloned request

    alt Responses Stream Path
        Provider->>Adapter: ConvertResponsesRequestToChat()
        Adapter->>Adapter: cloneStreamOptions()
        Adapter->>Context: GetEnforceReturningUsageData()
        alt Enforcement Active
            Adapter->>Adapter: Set IncludeUsage: true
        end
        Adapter->>Provider: ChatRequest with usage enabled
    end

    Provider-->>Handler: Stream response with usage
    Handler-->>Client: Usage data in stream

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• fix(gom-43): remove stream_options injection from Responses API handler #85 — Directly conflicts on the Responses streaming path in handlers.go; modifies the same conditional injection of stream_options.IncludeUsage behavior.
• refactor: extract duplicated Responses API adapters into shared helpers #99 — Modifies internal/providers/responses_adapter.go where this PR adds stream-options cloning and conditional IncludeUsage injection to the adapter.
• Feature: Add feature flag for token usage tracking #44 — Touches streaming usage-data behavior with stream_options.IncludeUsage propagation in handler and provider adapter logic.

Poem

🐰 A context hops through handlers bright,
With cloned requests held just right,
Stream options dance when told to play,
Usage data flows the modern way! ✨

❌ Failed checks (1 warning)

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

• 📝 Generate docstrings (stacked PR)
• 📝 Generate docstrings (commit on current branch)

• Generate coding plan for human review comments

• X
• Mastodon
• Reddit
• LinkedIn

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Learnt from: SantiagoDePolonia
URL: https://github.com/ENTERPILOT/GOModel/pull/141

Timestamp: 2026-03-12T22:39:09.713Z
Learning: In the GOModel repository (github.com/ENTERPILOT/GOModel), all providers that flow through the chat-backed responses adapter (`StreamResponsesViaChat` / `chatBackedResponsesProvider`) use OpenAI-compatible endpoints that support `stream_options.include_usage`. The `providerName` field is used in this code path. Do not flag concerns about provider compatibility with `stream_options.include_usage` for this path.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.