fix: remove usage from responses.created event in openai stream by TejasGhatte · Pull Request #4080 · maximhq/bifrost

TejasGhatte · 2026-06-05T10:17:23Z

Summary

The OpenAI Responses API expects usage to be null on response.created stream events, with final usage data only appearing on response.completed. This PR enforces that contract by nullifying usage on the created event within WithDefaults().

Changes

In BifrostResponsesStreamResponse.WithDefaults(), when the stream event type is ResponsesStreamResponseTypeCreated, the Usage field on the nested response is explicitly set to nil after defaults are applied, ensuring compliance with the OpenAI Responses API streaming specification.

Type of change

Affected areas

How to test

Send a streaming request through the Responses API and inspect the individual stream events. The response.created event should have usage: null, while the response.completed event should contain the populated usage object.

go test ./...

Breaking changes

Yes
No

Related issues

Security considerations

None.

Checklist

I read docs/contributing/README.md and followed the guidelines
I added/updated tests where appropriate
I updated documentation where needed
I verified builds succeed (Go and UI)
I verified the CI pipeline passes locally if applicable

Summary by CodeRabbit

Bug Fixes
- Corrected streaming response behavior so usage data is omitted on intermediate stream events and included only on the final completion event, ensuring accurate usage reporting for streamed responses.

coderabbitai · 2026-06-05T10:17:31Z

📝 Walkthrough

Walkthrough

The pull request modifies stream response defaulting to suppress the nested Usage field for response.created events, ensuring usage is omitted until the terminal response.completed event.

Changes

Stream response usage normalization for response.created events

Layer / File(s)	Summary
Force Usage nil for response.created events `core/schemas/responses.go`	The `WithDefaults()` method now explicitly sets `result.Response.Usage = nil` when handling `response.created` stream events with a non-nil response object, ensuring usage is omitted at that checkpoint.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

maximhq/bifrost#3527: The main PR changes how BifrostResponsesStreamResponse.WithDefaults() handles response.created (forcing result.Response.Usage = nil), while the retrieved PR modifies Bedrock stream finalization to synthesize missing response.created events—so they directly intersect on the response.created lifecycle event formatting.

Suggested reviewers

akshaydeo
danpiths

Poem

A rabbit trims the stream with care,
Nil where usage shouldn't share.
Created events keep fields light,
Completed waits to show the sight. 🐇🌿

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: removing usage from the responses.created event in OpenAI streaming, which is the primary purpose of this bug fix.
Description check	✅ Passed	The description follows the template structure with all required sections completed: Summary, Changes, Type of change (Bug fix selected), Affected areas (Core Go selected), How to test, Breaking changes (No selected), and Checklist items acknowledged.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch 06-05-fix_remove_usage_from_responses.created_event_in_openai_stream

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (2.12.2)

level=error msg="[linters_context] typechecking error: pattern ./...: directory prefix . does not contain main module or its selected dependencies"

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

TejasGhatte · 2026-06-05T10:17:38Z

This stack of pull requests is managed by Graphite. Learn more about stacking.

CLAassistant · 2026-06-05T10:17:48Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.

tejas ghatte seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

greptile-apps · 2026-06-05T10:22:14Z

Confidence Score: 5/5

Safe to merge — a minimal, well-guarded spec-compliance fix with no side effects on other code paths.

The change is a four-line, targeted nil-out of a single field inside an existing copy function, correctly placed after the deep-copy call and gated on a non-nil check. It does not touch provider logic, routing, pooling, or any shared state.

No files require special attention.

Important Files Changed

Filename	Overview
core/schemas/responses.go	Adds a nil-out of `Usage` on `response.created` stream events inside `WithDefaults()` to comply with the OpenAI Responses API spec; change is minimal and correctly guarded.

_{Reviews (2): Last reviewed commit: "fix: remove usage from responses.created..." | Re-trigger Greptile}

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@core/schemas/responses.go`:
- Around line 2637-2640: Add a deterministic unit test (e.g.,
TestStreamDefaults_CreatedVsCompletedUsage) that exercises the stream
normalization logic around ResponsesStreamResponseTypeCreated and
ResponsesStreamResponseTypeCompleted: construct a stream result where resp.Type
== ResponsesStreamResponseTypeCreated with a non-nil result.Response.Usage and
assert that after normalization result.Response.Usage == nil; then construct a
completed response (ResponsesStreamResponseTypeCompleted) with a non-nil Usage
and assert it is preserved. Target the same package as core/schemas and call the
normalization path that contains the code referencing result.Response.Usage so
the test fails on regressions.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 8ad8d3dc-5ae7-4f6d-8fbd-fe51d0cc33f9

📥 Commits

Reviewing files that changed from the base of the PR and between 41b64bf and a01df4b.

📒 Files selected for processing (1)

core/schemas/responses.go

akshaydeo · 2026-06-05T13:39:55Z

Merge activity

Jun 5, 1:39 PM UTC: A user started a stack merge that includes this pull request via Graphite.
Jun 5, 1:40 PM UTC: @akshaydeo merged this pull request with Graphite.

## Summary This PR bumps the Go toolchain version from `1.26.3` to `1.26.4` across all modules and CI workflows, and cuts a new release (`core` v1.5.17, `framework` v1.3.17, `transports` v1.5.9, `plugins/compat` v0.1.16, `plugins/governance` v1.5.17, and associated plugin versions) incorporating a large batch of features and fixes accumulated since the previous release. ## Changes - **Go 1.26.4** — Updated `go-version` in all GitHub Actions workflows (`e2e-tests`, `helm-release`, `pr-tests`, `release-cli`, `release-pipeline`, `snyk`) and all `go.mod` files (core, framework, transports, cli, all plugins, examples, and test modules). - **Core (v1.5.17)** — OpenAI compaction support, multi-customer logs and usage tracking, multiple team/business unit support, `request_headers` wildcard pattern capture for OTel and Maxim plugins, xAI `x_search` tool, fetch URL validation with SSRF hardening, `file://` pricing URL scheme, virtual key provider fan-out filtering, and a broad set of fixes including Anthropic prompt cache key, empty thinking block stripping, OpenAI stream usage event cleanup, Gemini numeric schema constraints, stale connection retries, Azure Claude diagnostic strip, and passthrough budget handling. - **Framework (v1.3.17)** — Scope-aware budgets and limits wired from model configs, provider-level governance, multiple customer budget support with `calendar_aligned` windows, paginated virtual key fetch, `config.json` source-of-truth flow, FTS index cap reduction, sync worker drift fix, cascade deletes for model configs, and high-scale virtual key flow improvements. - **Transports (v1.5.9)** — Full changelog covering all of the above plus UI improvements (log navigation, customer detail sheet, `BudgetDisplay` component, inline loading shell, materialized view alias), SCIM provisioning fields, Helm/config schema additions (`roles`, `per_user_oauth`), client IP resolution from forwarded headers, and dependency upgrades (`recharts` to 3.8.1, `golang.org/x` CVE remediation). - **Plugins** — `governance` v1.5.17 adds team budget/rate-limit exporters, ghost node reconciliation fix, and VK double usage counting fix; `logging` v1.5.17 adds wildcard header capture and file attachment rendering; `otel` v1.2.17 adds `disable_content_logging` and multiple collectors support; `maxim` v1.6.17 adds `request_headers` wildcard capture; `compat` v0.1.16 fixes `max_tokens` preservation during param filtering. ## Type of change - [ ] Bug fix - [x] Feature - [ ] Refactor - [ ] Documentation - [x] Chore/CI ## Affected areas - [x] Core (Go) - [x] Transports (HTTP) - [x] Providers/Integrations - [x] Plugins - [x] UI (React) - [ ] Docs ## How to test ```sh # Verify Go version go version # should report go1.26.4 # Run core tests cd core && go test ./... # Run framework tests cd framework && go test ./... # Run transports tests cd transports && go test ./... # Run plugin tests cd plugins/governance && go test ./... cd plugins/logging && go test ./... cd plugins/otel && go test ./... # UI cd ui pnpm i pnpm build pnpm test ``` ## Breaking changes - [ ] Yes - [x] No ## Related issues #4053, #4066, #4041, #4012, #3976, #3947, #3991, #4045, #3957, #3938, #3937, #3939, #3981, #3998, #3997, #4092, #4091, #4079, #4080, #4086, #3929, #3994, #4028, #3970, #3919, #3861, #3664, #3999, #4088, #4070, #4051, #4043, #4057, #4023, #3941, #3955, #4024, #3956, #3967, #3925, #3992, #3900 ## Security considerations - Fetch URL validation hardened against SSRF by tightening IP checks for private networks and link-local addresses (#4092, #3947, #3991). - Transitive `golang.org/x` dependencies (crypto, net, sys, text) bumped to address Docker Scout CVEs (#3900). ## Checklist - [x] I read `docs/contributing/README.md` and followed the guidelines - [x] I added/updated tests where appropriate - [x] I updated documentation where needed - [x] I verified builds succeed (Go and UI) - [x] I verified the CI pipeline passes locally if applicable  ## Summary by CodeRabbit * **New Features** * OpenAI compaction, multi-customer/team logstore support, request-header wildcard capture, enhanced governance (provider-level & scope-aware limits), disable-content-logging option, support for multiple OpenTelemetry collectors, SSRF hardening and URL validation. * **Chores** * Bumped Go toolchain across modules and updated component/plugin version releases.

## Summary The OpenAI Responses API expects `usage` to be `null` on `response.created` stream events, with final usage data only appearing on `response.completed`. This PR enforces that contract by nullifying usage on the created event within `WithDefaults()`. ## Changes - In `BifrostResponsesStreamResponse.WithDefaults()`, when the stream event type is `ResponsesStreamResponseTypeCreated`, the `Usage` field on the nested response is explicitly set to `nil` after defaults are applied, ensuring compliance with the OpenAI Responses API streaming specification. ## Type of change - [x] Bug fix - [ ] Feature - [ ] Refactor - [ ] Documentation - [ ] Chore/CI ## Affected areas - [x] Core (Go) - [ ] Transports (HTTP) - [ ] Providers/Integrations - [ ] Plugins - [ ] UI (React) - [ ] Docs ## How to test Send a streaming request through the Responses API and inspect the individual stream events. The `response.created` event should have `usage: null`, while the `response.completed` event should contain the populated usage object. ```sh go test ./... ``` ## Breaking changes - [ ] Yes - [x] No ## Related issues ## Security considerations None. ## Checklist - [ ] I read `docs/contributing/README.md` and followed the guidelines - [ ] I added/updated tests where appropriate - [ ] I updated documentation where needed - [ ] I verified builds succeed (Go and UI) - [ ] I verified the CI pipeline passes locally if applicable  ## Summary by CodeRabbit * **Bug Fixes** * Corrected streaming response behavior so usage data is omitted on intermediate stream events and included only on the final completion event, ensuring accurate usage reporting for streamed responses.

@chris-colinsky

## ✨ Features - **OpenAI Compaction** — Added OpenAI conversation compaction support across core, framework, logging, and the API surface (#4053) - **Multi-Customer & Org Hierarchy** — Logs and usage tracking now support multiple customers, teams, and business units, including business unit CRUD, team assignment, and governance endpoints in the OpenAPI spec (#4066, #4041, #4082) - **Provider-Level Governance** — Budgets & limits are now scope-aware and can be applied at the virtual-key top level and per provider, wired from the model configs table, with UI filters for scope and providers (#3938, #3937, #3939, #3981, #3962) - **Customer Budgets** — Customers support multiple budgets and `calendar_aligned` budget windows (#3998, #3997) - **Virtual Key Attribution & Controls** — Added a `created_by` user attribution column and a `blacklisted_models` column for virtual key provider configs (#3672, #3653) - **Request Header Capture** — OTel and Maxim observability plugins capture `request_headers` by pattern, with wildcard support (e.g. `x-custom-*`); logging gained the same wildcard header capture (#4012, #3958) - **OTel Content Controls & Collectors** — New `disable_content_logging` option drops message/tool content from exported spans, plus support for multiple OTel collectors (#4064, #3894) - **xAI x_search** — Added xAI `x_search` tool support (#3976) - **URL Validation** — Added fetch URL validation with private-network configuration and link-local blocking (#3947, #3991) - **File Scheme Pricing URLs** — Pricing source URLs now accept the `file://` scheme for air-gapped and self-hosted deployments (#4045) - **Paginated Virtual Keys** — Virtual key fetching is paginated to handle deployments with very large numbers of keys (#3957) - **Client IP Resolution** — Resolve client IP from `X-Forwarded-For`/`X-Real-IP` headers - **SCIM Provisioning** — Added `attributeType`/`attributeValue` SCIM provisioning fields - **Helm/Config Schema** — Added `roles` RBAC governance config and `per_user_oauth` MCP auth to the Helm chart and config schema (#4004, #4009) - **Log Navigation UI** — Added a "View logs" menu item to customer, team, and virtual key tables, clickable links in log detail views, a customer detail sheet, and a reusable `BudgetDisplay` component (#4073, #4054, #4026, #4055) - **Faster First Paint** — Added an inline loading shell to `#root` before React mounts (#4063) - **Materialized View Alias** — Added an `alias` column to the materialized view with filter support (#4078) ## 🐞 Fixed - **Fetch URL IP Checks** — Hardened fetch URL IP checks against SSRF (#4092) - **Mantle Model Matching** — Broadened Mantle model matching to all `gpt` variants (#4091) - **Empty Thinking Blocks** — Strip thinking blocks when the signature is empty (#4079) - **OpenAI Stream Usage** — Removed usage from the `responses.created` event in the OpenAI stream (#4080) - **Prompt Cache Key** — Set the prompt cache key from the Anthropic integration (#4086) - **Upstream Failure Status** — Map upstream connection failures to 502 instead of 400 (#3929) (thanks [@chris-colinsky](https://github.com/chris-colinsky)!) - **Gemini Schema Constraints** — Accept numeric schema integer constraints for Gemini (#3994) (thanks [@yanhao98](https://github.com/yanhao98)!) - **Files Provider Param** — Accept the `?provider=` query param on `GET /v1/files` (#3971) (thanks [@alexef](https://github.com/alexef)!) - **Optional Batch Model** — Made the `model` field optional on `POST /v1/batches` (#3973) (thanks [@alexef](https://github.com/alexef)!) - **Helm Azure Config** — Added missing `azure_key_config` fields to the Helm schema (#3996) (thanks [@axelray-dev](https://github.com/axelray-dev)!) - **Text Completion Chunk Model** — Added the missing `Model` field to `TextCompletionChunkResponse` (#3970) (thanks [@kuishou68](https://github.com/kuishou68)!) - **MCP Inline stdio Env** — MCP stdio server configs accept inline environment variable assignments (#3861) (thanks [@Shushmitaaaa](https://github.com/Shushmitaaaa)!) - **Orphaned Tool Results** — Orphaned tool results in the OpenAI to Anthropic conversion flow are no longer rejected by the Anthropic API (#3919) - **Node Usage Reconciliation** — Added a monotonic `inc_number` log cursor so node usage reconciliation does not skip late async log writes (#3664) - **Bedrock Output Assessments** — Corrected the type of `outputAssessments` in Bedrock responses (#4028) - **Model Pool Pricing Reloads** — Preserve non-pricing model pool entries across pricing reloads (#3999) - **Ghost Node Reconciliation** — Replicate the VK hierarchy flow for ghost node reconciliation (#4088) - **VK Double Usage Counting** — Fixed double usage counting when creating a virtual key (#4070) - **Model Config Lifecycle** — Cascade deletes for model configs and removal of stale in-memory model configs (#4051, #4043) - **FTS Index Cap** — Reduced the FTS index `left()` cap from 800k to 250k chars to stay within the tsvector limit (#4057) - **Sync Worker Drift** — Reduced the sync worker ticker period to 5m to prevent threshold drift (#4023) - **Passthrough** — Fixed passthrough budgets, gated passthrough models per VK, model extraction for Azure passthrough, and restricted fallbacks/provider selection to the VK boundary (#3941, #3988, #3983, #3924) - **Provider Response Headers** — Strip provider response headers and add a content-type filter (#3955, #4024) - **Stream Handling** — Drain non-SSE stream readers and retry stale connections (#3956, #3967) - **Azure Claude** — Strip Azure diagnostic property for Claude models (#3925) - **Compat max_tokens** — Preserve chat `max_tokens` during param filtering (#3992) - **Raw Request Flag** — Removed the raw request flag from providers that don't support it (#4058) - **UI Fixes** — Standardized page container layout, virtual key model configs UI, and dashboard chart tooltips (#4046, #4052, #4044) ## 🔧 Maintenance - **Dependency Upgrades** — Bumped transitive `golang.org/x` dependencies (crypto, net, sys, text) for Docker Scout CVE remediation and `recharts` to 3.8.1; cascaded version bumps across all modules (#3900, #4003)

TejasGhatte marked this pull request as ready for review June 5, 2026 10:17

greptile-apps Bot reviewed Jun 5, 2026

View reviewed changes

Comment thread core/schemas/responses.go

Comment thread core/schemas/responses.go

fix: remove usage from responses.created event in openai stream

a01df4b

TejasGhatte force-pushed the 06-05-fix_remove_usage_from_responses.created_event_in_openai_stream branch from 41b64bf to a01df4b Compare June 5, 2026 12:02

TejasGhatte mentioned this pull request Jun 5, 2026

fix: strip thinking block if signature is empty #4079

Merged

17 tasks

coderabbitai Bot reviewed Jun 5, 2026

View reviewed changes

Comment thread core/schemas/responses.go

coderabbitai Bot approved these changes Jun 5, 2026

View reviewed changes

akshaydeo merged commit 2bc63e8 into dev Jun 5, 2026
17 of 18 checks passed

akshaydeo deleted the 06-05-fix_remove_usage_from_responses.created_event_in_openai_stream branch June 5, 2026 13:40

akshaydeo mentioned this pull request Jun 5, 2026

changelogs and go upgrade to 1.26.4 #4096

Merged

18 tasks

akshaydeo mentioned this pull request Jun 7, 2026

v1.5.9 #4120

Merged

Navigation Menu

Uh oh!

fix: remove usage from responses.created event in openai stream - #4080

fix: remove usage from responses.created event in openai stream#4080
akshaydeo merged 1 commit into
devfrom
06-05-fix_remove_usage_from_responses.created_event_in_openai_stream

TejasGhatte commented Jun 5, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jun 5, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

TejasGhatte commented Jun 5, 2026 •

edited

Loading

Uh oh!

CLAassistant commented Jun 5, 2026

Uh oh!

greptile-apps Bot commented Jun 5, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

akshaydeo commented Jun 5, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

TejasGhatte commented Jun 5, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Type of change

Affected areas

How to test

Breaking changes

Related issues

Security considerations

Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jun 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

TejasGhatte commented Jun 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CLAassistant commented Jun 5, 2026

Uh oh!

greptile-apps Bot commented Jun 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Confidence Score: 5/5

Important Files Changed

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

akshaydeo commented Jun 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge activity

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

TejasGhatte commented Jun 5, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jun 5, 2026 •

edited

Loading

TejasGhatte commented Jun 5, 2026 •

edited

Loading

greptile-apps Bot commented Jun 5, 2026 •

edited

Loading

akshaydeo commented Jun 5, 2026 •

edited

Loading