Skip to content

feat(realtime): add sideband WebSocket call control - #530

Merged
jbeckwith-oai merged 3 commits into
mainfrom
codex/realtime-sideband
Aug 25, 2026
Merged

feat(realtime): add sideband WebSocket call control#530
jbeckwith-oai merged 3 commits into
mainfrom
codex/realtime-sideband

Conversation

@jbeckwith-oai

@jbeckwith-oai jbeckwith-oai commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add client.realtime.connect_to_call(call_id:) and a typed OpenAI::Realtime::SidebandConnection for server-side control of existing, application-authorized WebRTC or SIP calls.
  • Expose sideband-only output_audio_buffer.clear and generic conversation.items.truncate, with documented cancel → truncate → clear interruption ordering and no implicit call ownership or hangup.
  • Preserve existing authenticated WebSocket lifecycle, URL encoding, proxy/TLS protections, workload-identity refresh, RBI/RBS typing, and call-ID/credential redaction across HTTP traces, pool telemetry, and connection-error URLs.
  • Add a packaged executable sideband example that confirms its own effective session-policy update, rejects stale updates, and keeps customer content out of diagnostics.
  • Extract shared connection-test support into focused sideband/error suites and cover real direct/proxied WebSocket traces, encoded/repeated/malformed call-ID redaction, handshake/socket/closed-connection errors, query injection, credential isolation, verified mutual TLS, tracing-disabled clients, retry ownership, stale update/error ordering, and gem packaging.

Verification

  • Ruby 4.0: bundle exec rake test — 1,404 tests, 12,703 assertions, zero failures.
  • Ruby 3.4: bundle exec rake test — 1,404 tests, 12,703 assertions, zero failures.
  • Ruby 3.3: bundle exec rake test — 1,404 tests, 12,702 assertions, zero failures.
  • bundle exec rake lint — RuboCop, rubyfmt, Sorbet, and 1,245 RBS files pass.
  • Example inventory and gem packaging pass; live sideband smoke testing is explicitly excluded because it requires an existing authorized WebRTC/SIP call.
  • Trusted-main custom-code budget passes at 2,933 / 4,000 lines with no budget-policy changes.
  • Two independent fresh-context reviews, strict maintainability review, and a security review scoped to this change.

@jbeckwith-oai
jbeckwith-oai requested a review from a team as a code owner August 25, 2026 18:34
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Aug 25, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-08-25T19:14:13.710200Z 561d724 New commits
🔒 Security Review Completed 2026-08-25T19:14:43.154729Z 561d724 New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@openai-sdks

openai-sdks Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

OkTest Summary

237/237 SDK tests passed in 8.657s for Ruby SDK PR #530.

Test results — 42 files
Test Result Time
tests/chat-completions-complex-body.test.ts ✅ Passed 140ms
tests/chat-completions-create.test.ts ✅ Passed 153ms
tests/chat-completions-stream.test.ts ✅ Passed 117ms
tests/files-content-binary.test.ts ✅ Passed 134ms
tests/files-create-multipart.test.ts ✅ Passed 135ms
tests/files-list-pagination.test.ts ✅ Passed 138ms
tests/initialize-config.test.ts ✅ Passed 145ms
tests/instance-isolation.test.ts ✅ Passed 161ms
tests/models-list.test.ts ✅ Passed 163ms
tests/responses-background-lifecycle.test.ts ✅ Passed 232ms
tests/responses-body-method-errors.test.ts ✅ Passed 343ms
tests/responses-cancel-timeout.test.ts ✅ Passed 187ms
tests/responses-cancel.test.ts ✅ Passed 181ms
tests/responses-compact-retries.test.ts ✅ Passed 322ms
tests/responses-compact.test.ts ✅ Passed 191ms
tests/responses-create-advanced-stream.test.ts ✅ Passed 131ms
tests/responses-create-advanced.test.ts ✅ Passed 151ms
tests/responses-create-disconnect.test.ts ✅ Passed 1.041s
tests/responses-create-errors.test.ts ✅ Passed 196ms
tests/responses-create-malformed-api-responses.test.ts ✅ Passed 157ms
tests/responses-create-retries.test.ts ✅ Passed 274ms
tests/responses-create-stream-failures.test.ts ✅ Passed 113ms
tests/responses-create-stream-timeout.test.ts ✅ Passed 194ms
tests/responses-create-stream-wire.test.ts ✅ Passed 2.065s
tests/responses-create-stream.test.ts ✅ Passed 77ms
tests/responses-create-terminal-states.test.ts ✅ Passed 202ms
tests/responses-create-timeout.test.ts ✅ Passed 256ms
tests/responses-create.test.ts ✅ Passed 253ms
tests/responses-delete.test.ts ✅ Passed 251ms
tests/responses-input-items-errors.test.ts ✅ Passed 152ms
tests/responses-input-items-list.test.ts ✅ Passed 148ms
tests/responses-input-items-options.test.ts ✅ Passed 160ms
tests/responses-input-tokens-count-timeout.test.ts ✅ Passed 295ms
tests/responses-input-tokens-count.test.ts ✅ Passed 173ms
tests/responses-malformed-inputs.test.ts ✅ Passed 1.691s
tests/responses-not-found-errors.test.ts ✅ Passed 294ms
tests/responses-parse.test.ts ✅ Passed 191ms
tests/responses-retrieve-retries.test.ts ✅ Passed 223ms
tests/responses-retrieve.test.ts ✅ Passed 280ms
tests/responses-stored-method-errors.test.ts ✅ Passed 549ms
tests/retry-behavior.test.ts ✅ Passed 3.003s
tests/sdk-error-shape.test.ts ✅ Passed 308ms

View OkTest run #32888233058

SDK merge (e935678bd799) · head (561d72481192) · base (d638c57853bc) · OkTest (2b1bdfd25e98)

@github-actions

github-actions Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Castiron custom code

✅ No new custom-code files detected.

47 mixed files remain; 0 existing customizations changed.

Compared d638c57853bc561d72481192. Generated baselines verified.

47 existing customizations unchanged
  • lib/openai.rb
  • lib/openai/client.rb
  • lib/openai/models/chat/chat_completion_message.rb
  • lib/openai/models/chat/chat_completion_message_function_tool_call.rb
  • lib/openai/models/chat/completion_create_params.rb
  • lib/openai/models/response_format_json_schema.rb
  • lib/openai/models/responses/function_tool.rb
  • lib/openai/models/responses/response.rb
  • lib/openai/models/responses/response_create_params.rb
  • lib/openai/models/responses/response_format_text_config.rb
  • lib/openai/models/responses/response_format_text_json_schema_config.rb
  • lib/openai/models/responses/response_function_tool_call.rb
  • lib/openai/models/responses/response_function_web_search.rb
  • lib/openai/models/responses/response_output_text.rb
  • lib/openai/models/responses/tool.rb
  • lib/openai/resources/beta/threads.rb
  • lib/openai/resources/chat/completions.rb
  • lib/openai/resources/files.rb
  • lib/openai/resources/responses.rb
  • lib/openai/resources/vector_stores/file_batches.rb
  • lib/openai/resources/vector_stores/files.rb
  • lib/openai/resources/webhooks.rb
  • rbi/openai/client.rbi
  • rbi/openai/models/chat/chat_completion_message.rbi
  • rbi/openai/models/chat/chat_completion_message_function_tool_call.rbi
  • rbi/openai/models/chat/completion_create_params.rbi
  • rbi/openai/models/response_format_json_schema.rbi
  • rbi/openai/models/responses/response.rbi
  • rbi/openai/models/responses/response_create_params.rbi
  • rbi/openai/models/responses/response_function_tool_call.rbi
  • rbi/openai/models/responses/response_function_web_search.rbi
  • rbi/openai/models/responses/response_output_text.rbi
  • rbi/openai/resources/chat/completions.rbi
  • rbi/openai/resources/files.rbi
  • rbi/openai/resources/responses.rbi
  • rbi/openai/resources/vector_stores/file_batches.rbi
  • rbi/openai/resources/vector_stores/files.rbi
  • scripts/castiron/README.md
  • scripts/castiron/custom_code_report.py
  • scripts/castiron/test_custom_code_report.py

7 more in the full report.

A changed generated baseline means this report cannot reliably identify which handwritten lines changed.

Inspect the custom-code diff

Download the exact patch produced by this run (requires repository access):

gh run download 32888347653 --repo openai/openai-ruby \
  --name castiron-custom-code-32888347653-1 --dir /tmp/castiron-custom-code-32888347653-1
git apply --stat /tmp/castiron-custom-code-32888347653-1/custom-code.patch
cat /tmp/castiron-custom-code-32888347653-1/custom-code.patch

Or reproduce it from an SDK checkout containing the vendored reporter:

git fetch --no-tags origin d638c57853bcd2d1afb44fdf5fc1f79e891c138e 561d72481192518108a4f96b6a00f4c8b7aa106a
python3 scripts/castiron/custom_code_report.py report \
  --base d638c57853bcd2d1afb44fdf5fc1f79e891c138e \
  --head 561d72481192518108a4f96b6a00f4c8b7aa106a --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-561d72481192
cat /tmp/castiron-custom-code-561d72481192/custom-code.patch

This is the current full custom patch for mixed files, not an attribution of only the handwritten lines changed by this PR.

Full report and patch

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: fa98d11024

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread test/openai/realtime/network_invariants_test.rb Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 828b0a7e79

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread lib/openai/helpers/realtime/resources/realtime_extension.rb

@HAYDEN-OAI HAYDEN-OAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed sideband authorization and call-ID isolation, WebSocket URL and credential handling, HTTP trace/error redaction, proxy/TLS protections, retry/lifecycle cleanup, and typed audio controls; no substantive issues found.

@jbeckwith-oai
jbeckwith-oai added this pull request to the merge queue Aug 25, 2026
Merged via the queue into main with commit 2fea73b Aug 25, 2026
21 checks passed
@jbeckwith-oai
jbeckwith-oai deleted the codex/realtime-sideband branch August 25, 2026 20:41
@openai-sdks openai-sdks Bot mentioned this pull request Aug 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants