fix: preserve OpenAI responses stream metadata

[etnperlong]

Summary

Preserve missing OpenAI Responses stream metadata so Bifrost does not drop reasoning-summary and multi-phase message fields during normal streaming.

Changes

• add summary_index and obfuscation to BifrostResponsesStreamResponse
• add phase to ResponsesMessage
• preserve these fields in WithDefaults() and streaming deep-copy helpers
• add regression tests covering unmarshal, defaulting, and marshal paths

Type of change

• Bug fix
• Feature
• Refactor
• Documentation
• Chore/CI

Affected areas

• Core (Go)
• Transports (HTTP)
• Providers/Integrations
• Plugins
• UI (React)
• Docs

How to test

go test ./core/schemas
go test ./framework/streaming

Expected outcome: both test commands pass, and the regression tests confirm summary_index, obfuscation, and phase survive unmarshal, defaulting, deep-copy, and re-serialization.

Screenshots/Recordings

N/A

Breaking changes

• Yes
• No

Related issues

Related to reasoning summary metadata loss in OpenAI Responses streaming.

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

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0d1075ad-59cb-4cb6-8452-b673abed0eae

📥 Commits

Reviewing files that changed from the base of the PR and between 171c9a7 and e65987a.

📒 Files selected for processing (3)

• core/schemas/responses.go
• core/schemas/responses_test.go
• framework/streaming/responses.go

---

📝 Walkthrough

Summary by CodeRabbit

Release Notes

• New Features

  • Messages now support an optional phase field
  • Stream responses now include optional summary index and obfuscation metadata fields
  • Enhanced preservation of optional fields throughout serialization operations

• Tests

  • Added comprehensive test coverage for new response fields, verifying proper retention across all serialization workflows

Walkthrough

This PR extends response schema structs with optional OpenAI metadata fields (phase, summary_index, obfuscation), ensures they persist through serialization cycles via updated defaults, and synchronizes deep-copy helpers to prevent accidental data mutation between instances.

Changes

OpenAI metadata field support

Layer / File(s)	Summary
Schema field definitions and defaults core/schemas/responses.go	ResponsesMessage gains optional phase field; BifrostResponsesStreamResponse gains summary_index and obfuscation fields. WithDefaults() updated to copy new fields from source into result.
Serialization test coverage core/schemas/responses_test.go	Tests verify that summary_index, obfuscation, and phase fields survive unmarshal, defaults application, and sorted JSON marshalling, including when wrapped in stream chunks.
Deep-copy helper synchronization framework/streaming/responses.go	deepCopyResponsesStreamResponse now clones SummaryIndex, Signature, and Obfuscation; deepCopyResponsesMessage now clones Status and Phase pointer fields.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

• akshaydeo

Poem

A rabbit hops through schemas bright,
With new fields shining in the light—
phase and index, obfuscation too,
All copied deep, both old and new! 🐰✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'fix: preserve OpenAI responses stream metadata' directly and clearly describes the main change—preserving missing metadata fields in OpenAI stream responses.
Description check	✅ Passed	The description includes all required template sections: summary, changes, type of change, affected areas, how to test, breaking changes, and checklist. Tests were added, and non-applicable sections are properly marked.
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 unit tests (beta)

• Create PR with unit tests

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"

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[CLAassistant]

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.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[greptile-apps]

Confidence Score: 4/5

Safe to merge; all three new fields are correctly wired through struct definition, WithDefaults(), and deep-copy. The one gap is that SummaryIndex is now stored but not yet used to route multi-summary deltas during accumulation.

The struct additions, WithDefaults() propagation, and deep-copy branches are all consistent and tested. The only open question is whether multi-summary streaming responses (multiple distinct SummaryIndex values) would produce correct accumulated output — the accumulator still merges everything into Summary[0]. This is a noted pre-existing limitation rather than a regression, but it means the newly captured SummaryIndex has no behavioral effect yet on the accumulation path.

framework/streaming/responses.go — the reasoning summary accumulation loop does not use SummaryIndex to route deltas to the correct summary slot.

Important Files Changed

Filename	Overview
core/schemas/responses.go	Adds SummaryIndex, Obfuscation to BifrostResponsesStreamResponse and Phase to ResponsesMessage; updates WithDefaults() to carry them through. Changes are minimal and correct.
core/schemas/responses_test.go	New regression test file covering unmarshal, WithDefaults(), and re-serialization paths for the three new fields. Tests are well-structured and use real JSON payloads.
framework/streaming/responses.go	Adds deep-copy branches for SummaryIndex, Obfuscation, Signature, Status, and Phase; accumulation logic in appendReasoningDeltaToResponsesMessage does not yet use SummaryIndex to route multi-summary deltas.

Comments Outside Diff (1)

1. framework/streaming/responses.go, line 577-619 (link)

   SummaryIndex captured but not used for delta routing

   SummaryIndex is now correctly preserved in the struct and deep-copied, but appendReasoningDeltaToResponsesMessage still hard-codes accumulation into Summary[0] regardless of the incoming index. If OpenAI emits deltas interleaved across two summary entries (e.g. summary_index=0 and summary_index=1), the second entry's text will be silently concatenated into Summary[0], producing a garbled merged summary instead of two separate entries. The resp.SummaryIndex value on the chunk is available at the call site (line 612) but is never threaded into the append helper.

_{Reviews (1): Last reviewed commit: "fix: preserve OpenAI responses stream me..." | Re-trigger Greptile}

[akshaydeo]

❤️ for the PR @etnperlong