Skip to content

Conversation

@gn00295120
Copy link
Contributor

Summary

Fixes resource leak and error handling issue in VoiceStreamResult where tasks are cancelled but not properly awaited during cleanup, and CancelledError could mask real exceptions.

Problem

The _cleanup_tasks() method in VoiceStreamResult had two issues:

  1. Resource leak: Only calling task.cancel() without awaiting could lead to:

    • Unhandled task exception warnings
    • Potential resource leaks from abandoned tasks
    • Improper cleanup of background tasks
  2. Error masking: _check_errors() calling task.exception() on cancelled tasks would raise CancelledError, masking the real exception

Evidence

Solution

  1. Made _cleanup_tasks() async
  2. Collect all real asyncio.Task objects that need to be awaited
  3. Added await asyncio.gather() with return_exceptions=True to properly collect exceptions from cancelled tasks
  4. Updated _check_errors() to check task.cancelled() before calling task.exception() to avoid CancelledError
  5. Updated stream() async generator to await _cleanup_tasks()

Testing

Files Changed

  • src/agents/voice/result.py: Fix task cleanup and error checking

…asks

Problem:
The _cleanup_tasks() method in VoiceStreamResult was only calling
task.cancel() on pending tasks but not awaiting them. Additionally,
_check_errors() could raise CancelledError when checking cancelled tasks.
This could lead to:
1. Unhandled task exception warnings
2. Potential resource leaks from abandoned tasks
3. CancelledError masking real exceptions

Evidence:
- Similar to fixed guardrail tasks cleanup (PR openai#1976)
- Similar to fixed voice STT cleanup (PR openai#1977)
- Similar to fixed websocket cleanup (PR openai#1955)
- Bug documented in .claude/bug-analysis/03-resource-leaks.md

Solution:
1. Made _cleanup_tasks() async
2. Collect all real asyncio.Task objects that need to be awaited
3. Added await asyncio.gather() with return_exceptions=True to properly
   collect exceptions from cancelled tasks
4. Updated _check_errors() to skip cancelled tasks using task.cancelled()
   check to avoid CancelledError when calling task.exception()
5. Updated stream() async generator to await _cleanup_tasks()

Testing:
- Linting passes
- No breaking changes to public API
- Follows same pattern as PR openai#1976, openai#1977, openai#1955
@Copilot Copilot AI review requested due to automatic review settings October 22, 2025 17:00
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR fixes a resource leak in the VoiceStreamResult class by properly awaiting cancelled tasks during cleanup and preventing CancelledError from masking real exceptions.

Key Changes:

  • Made _cleanup_tasks() async to properly await cancelled tasks using asyncio.gather() with return_exceptions=True
  • Enhanced _check_errors() to check task.cancelled() before calling task.exception() to avoid CancelledError
  • Updated the stream() method to await the now-async _cleanup_tasks()

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copy link

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

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.

ℹ️ 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".

Lucas Wang added 2 commits October 23, 2025 01:08
The task.cancelled() check on line 281 already ensures that CancelledError
will never be raised when calling task.exception(). The try-except block
was redundant and added unnecessary complexity.

Thanks to reviewer comment for catching this.
@seratch seratch marked this pull request as draft October 23, 2025 22:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants