Skip to content

Fix hanging on streams when stdio_client exiting #559

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
May 13, 2025

Conversation

LionNatsu
Copy link
Contributor

@LionNatsu LionNatsu commented Apr 22, 2025

Triggers a TaskGroup cancel after reaching the finally code block.

Motivation and Context

stdin_writer in the task group hangs when pressing Ctrl+c.
Now we explicitly close the streams blocking.

How Has This Been Tested?

Tested in a new simple no-op test and a real Uvicorn Starlette application.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

@LionNatsu LionNatsu changed the title Fix the TaskGroup hanging on stdin_writer when stdio_client exiting Fix hanging on streams when stdio_client exiting Apr 22, 2025
@ihrpr ihrpr added this to the r-05-25 milestone Apr 29, 2025
Copy link
Contributor

@ihrpr ihrpr left a comment

Choose a reason for hiding this comment

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

Thank you, the clean up change looks good.
Please can you move the test to tests/client/test_stdio.py

@LionNatsu
Copy link
Contributor Author

You're welcome, @ihrpr. Just so you know, all requested changes are resolved :)

Use async versions of .close()

Co-authored-by: ihrpr <inna.hrpr@gmail.com>
@LionNatsu
Copy link
Contributor Author

@ihrpr Resolved

Copy link
Contributor

@ihrpr ihrpr left a comment

Choose a reason for hiding this comment

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

Thank you!

@ihrpr ihrpr merged commit c578212 into modelcontextprotocol:main May 13, 2025
6 checks passed
@LionNatsu LionNatsu deleted the patch-1 branch May 13, 2025 18:55
felixweinberger added a commit that referenced this pull request Jun 26, 2025
This commit demonstrates that PR #559's stream cleanup alone is sufficient
to prevent hanging, even with servers that ignore SIGTERM. Testing shows:

1. PR #559 stream cleanup alone handles all tested hanging scenarios
2. Timeout mechanism may be unnecessary additional complexity
3. Existing Unix behavior works fine without timeouts
4. Original timeout tests still pass, confirming no regression

This simpler approach preserves Unix behavior while eliminating
platform-specific timeout handling complexity.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
felixweinberger added a commit that referenced this pull request Jun 26, 2025
This commit demonstrates that PR #559's stream cleanup alone is sufficient
to prevent hanging, even with servers that ignore SIGTERM. Testing shows:

1. PR #559 stream cleanup alone handles all tested hanging scenarios
2. Timeout mechanism may be unnecessary additional complexity
3. Existing Unix behavior works fine without timeouts
4. Original timeout tests still pass, confirming no regression

This simpler approach preserves Unix behavior while eliminating
platform-specific timeout handling complexity.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
felixweinberger added a commit that referenced this pull request Jun 26, 2025
This change demonstrates a simpler approach than PR #555's timeout mechanism:

1. **Evidence**: Extensive testing shows PR #559 stream cleanup alone prevents
   hanging, even with servers that ignore SIGTERM and keep streams open.

2. **Simplification**: Removes all timeout logic and Windows-specific termination
   function in favor of unified `process.terminate()` + stream cleanup.

3. **Benefits**:
   - Less code complexity (no timeout handling, no platform branching)
   - Preserves proven stream cleanup protection from PR #559
   - Makes behavior consistent across all platforms
   - All existing timeout tests still pass

4. **Risk reduction**: Avoids changing process termination semantics while
   maintaining hanging protection through stream cleanup.

The core insight: process hanging was caused by stream management issues
(solved by PR #559), not termination timing issues (targeted by PR #555).
felixweinberger added a commit that referenced this pull request Jun 26, 2025
Copy of #555

Testing shows PR #559 stream cleanup alone prevents hanging,
even with servers that ignore SIGTERM and keep streams open.

Removes all timeout logic and Windows-specific termination
function in favor of unified `process.terminate()`.
felixweinberger added a commit that referenced this pull request Jun 26, 2025
NOTE: These tests FAIL without the changes introduced in #559.

These tests verify that stdio_client completes cleanup within reasonable
time for both slow-terminating and fast-exiting processes, preventing
the hanging issues reported in #559.
felixweinberger added a commit that referenced this pull request Jun 26, 2025
**NOTE: These tests FAIL without the changes introduced in #559**

- test_stdio_client_universal_timeout
- test_stdio_client_immediate_completion

await read_stream.aclose()
await write_stream.aclose()
await read_stream_writer.aclose()
await write_stream_reader.aclose()

These tests verify that stdio_client completes cleanup within reasonable
time for both slow-terminating and fast-exiting processes, preventing
the hanging issues reported in #559.

**NOTE: This test FAILS without the changes introduced in #555**

- test_stdio_client_sigint_only_process

try:
    process.terminate()
    with anyio.fail_after(2.0):
        await process.wait()
except TimeoutError:
    # If process doesn't terminate in time, force kill it
    process.kill()
felixweinberger added a commit that referenced this pull request Jun 26, 2025
**NOTE: These tests FAIL without the changes introduced in #559**

- test_stdio_client_universal_timeout
- test_stdio_client_immediate_completion

await read_stream.aclose()
await write_stream.aclose()
await read_stream_writer.aclose()
await write_stream_reader.aclose()

These tests verify that stdio_client completes cleanup within reasonable
time for both slow-terminating and fast-exiting processes, preventing
the hanging issues reported in #559.

**NOTE: This test FAILS without the changes introduced in #555**

- test_stdio_client_sigint_only_process

try:
    process.terminate()
    with anyio.fail_after(2.0):
        await process.wait()
except TimeoutError:
    # If process doesn't terminate in time, force kill it
    process.kill()
felixweinberger added a commit that referenced this pull request Jun 26, 2025
**NOTE: These tests FAIL without the changes introduced in #559**

- test_stdio_client_universal_timeout
- test_stdio_client_immediate_completion

await read_stream.aclose()
await write_stream.aclose()
await read_stream_writer.aclose()
await write_stream_reader.aclose()

These tests verify that stdio_client completes cleanup within reasonable
time for both slow-terminating and fast-exiting processes, preventing
the hanging issues reported in #559.

**NOTE: This test FAILS without the changes introduced in #555**

- test_stdio_client_sigint_only_process

try:
    process.terminate()
    with anyio.fail_after(2.0):
        await process.wait()
except TimeoutError:
    # If process doesn't terminate in time, force kill it
    process.kill()

This test verifies that on UNIX systems MCP servers that don't respect
SIGTERM but e.g. SIGINT still get terminated after a grace period.
felixweinberger added a commit that referenced this pull request Jun 26, 2025
**NOTE: These tests FAIL without the changes introduced in #559**

- test_stdio_client_universal_timeout
- test_stdio_client_immediate_completion

await read_stream.aclose()
await write_stream.aclose()
await read_stream_writer.aclose()
await write_stream_reader.aclose()

These tests verify that stdio_client completes cleanup within reasonable
time for both slow-terminating and fast-exiting processes, preventing
the hanging issues reported in #559.

**NOTE: This test FAILS without the changes introduced in #555**

- test_stdio_client_sigint_only_process

try:
    process.terminate()
    with anyio.fail_after(2.0):
        await process.wait()
except TimeoutError:
    # If process doesn't terminate in time, force kill it
    process.kill()

This test verifies that on UNIX systems MCP servers that don't respect
SIGTERM but e.g. SIGINT still get terminated after a grace period.
felixweinberger added a commit that referenced this pull request Jun 26, 2025
**NOTE: These tests FAIL without the changes introduced in #559**

- test_stdio_client_universal_timeout
- test_stdio_client_immediate_completion

await read_stream.aclose()
await write_stream.aclose()
await read_stream_writer.aclose()
await write_stream_reader.aclose()

These tests verify that stdio_client completes cleanup within reasonable
time for both slow-terminating and fast-exiting processes, preventing
the hanging issues reported in #559.

**NOTE: This test FAILS without the changes introduced in #555**

- test_stdio_client_sigint_only_process

try:
    process.terminate()
    with anyio.fail_after(2.0):
        await process.wait()
except TimeoutError:
    # If process doesn't terminate in time, force kill it
    process.kill()

This test verifies that on UNIX systems MCP servers that don't respect
SIGTERM but e.g. SIGINT still get terminated after a grace period.
felixweinberger added a commit that referenced this pull request Jun 26, 2025
**NOTE: These tests FAIL without the changes introduced in #559**

- test_stdio_client_universal_timeout
- test_stdio_client_immediate_completion

await read_stream.aclose()
await write_stream.aclose()
await read_stream_writer.aclose()
await write_stream_reader.aclose()

These tests verify that stdio_client completes cleanup within reasonable
time for both slow-terminating and fast-exiting processes, preventing
the hanging issues reported in #559.

**NOTE: This test FAILS without the changes introduced in #555**

- test_stdio_client_sigint_only_process

try:
    process.terminate()
    with anyio.fail_after(2.0):
        await process.wait()
except TimeoutError:
    # If process doesn't terminate in time, force kill it
    process.kill()

This test verifies that on UNIX systems MCP servers that don't respect
SIGTERM but e.g. SIGINT still get terminated after a grace period.
felixweinberger added a commit that referenced this pull request Jun 26, 2025
**NOTE: These tests FAIL without the changes introduced in #559**

- test_stdio_client_universal_timeout
- test_stdio_client_immediate_completion

await read_stream.aclose()
await write_stream.aclose()
await read_stream_writer.aclose()
await write_stream_reader.aclose()

These tests verify that stdio_client completes cleanup within reasonable
time for both slow-terminating and fast-exiting processes, preventing
the hanging issues reported in #559.

**NOTE: This test FAILS without the changes introduced in #555**

- test_stdio_client_sigint_only_process

try:
    process.terminate()
    with anyio.fail_after(2.0):
        await process.wait()
except TimeoutError:
    # If process doesn't terminate in time, force kill it
    process.kill()

This test verifies that on UNIX systems MCP servers that don't respect
SIGTERM but e.g. SIGINT still get terminated after a grace period.
felixweinberger added a commit that referenced this pull request Jun 26, 2025
**NOTE: These tests FAIL without the changes introduced in #559**

- test_stdio_client_universal_timeout
- test_stdio_client_immediate_completion

await read_stream.aclose()
await write_stream.aclose()
await read_stream_writer.aclose()
await write_stream_reader.aclose()

These tests verify that stdio_client completes cleanup within reasonable
time for both slow-terminating and fast-exiting processes, preventing
the hanging issues reported in #559.

**NOTE: This test FAILS without the changes introduced in #555**

- test_stdio_client_sigint_only_process

try:
    process.terminate()
    with anyio.fail_after(2.0):
        await process.wait()
except TimeoutError:
    # If process doesn't terminate in time, force kill it
    process.kill()

This test verifies that on UNIX systems MCP servers that don't respect
SIGTERM but e.g. SIGINT still get terminated after a grace period.
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