fix: session config breaks tool registration - cannot use tools with … #377
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…audio customization - Fix _getMergedSessionConfig to only include tools field when tools are present - Prevent sending empty/undefined tools array which disables tool calls - Add comprehensive tests covering the issue scenarios - Resolves mutual exclusivity between session config and tool functionality Fixes #339
🦋 Changeset detectedLatest commit: c352690 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
…roperty.call - Resolves ESLint error: Do not access Object.prototype method 'hasOwnProperty' from target object - Uses safer Object.prototype.hasOwnProperty.call() pattern to avoid prototype pollution issues - Maintains same test functionality while following ESLint no-prototype-builtins rule
|
Hi @seratch, I’ve pushed the changes to resolve the CI issues. Could you please review the updates when you have a chance? Thank you. |
seratch
requested changes
Aug 26, 2025
Co-authored-by: Kazuhiro Sera <seratch@openai.com>
Co-authored-by: Kazuhiro Sera <seratch@openai.com>
- Fix voice config precedence: session config voice now overrides agent default voice - Fix updateSessionConfig test expectations: add agent updates to trigger updateSessionConfig calls - Tests now properly trigger updateSessionConfig by calling updateAgent() - Preserves session config voice setting instead of always using agent default Fixes 4 failing tests: - includes tools in session config when session config is provided - preserves tools when updateSessionConfig is called - does not include tools field when no tools are provided - reproduces the original issue - tools work with config provided
|
@dkundel-openai Although the CI jobs are still failing, the change itself looks good to me for resolving the reported issue. Can you take a look? |
….com/AjayKumbham/openai-agents-js into fix/session-config-tool-registration
…ols are present - Modified #getSessionConfig to only include tools field when #currentTools.length > 0 - Fixes failing test 'does not include tools field when no tools are provided' - Preserves existing behavior for agents with actual tools
|
Hi @dkundel-openai, this PR has passing checks and has already been approved by @seratch. Could you please review when you get a chance? Thanks! |
|
Thanks for your contribution. Since I worked on the GA launch we couldn't merge this directly but I ported your change into #402 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fixes issue #339 where initializing a RealtimeSession with any config object would break tool registration, making it impossible to use tools with audio customization.
Problem
When a RealtimeSession was initialized with session config (even just voice settings), the tool registration became broken because:
_getMergedSessionConfigmethod would includetools: undefinedin session data when no tools were explicitly provided in the configSolution
_getMergedSessionConfigto only include thetoolsfield when tools are actually present and non-emptyChanges
packages/agents-realtime/src/openaiRealtimeBase.tspackages/agents-realtime/test/realtimeSession.test.tsTesting
Added tests covering:
Fixes #339