Repository navigation
Commit 03867b0
committed
Bound the listen teardown on transport close
## Motivation and Context
`StreamableHTTPTransport#close` writes each open `subscriptions/listen` stream its `SubscriptionsListenResult`
before closing it, under the stream's write mutex. Both the write and the wait for that mutex are unbounded:
a client that stopped reading leaves its socket buffers full, so the result write blocks for as long as
the connection lasts, and so does a delivery already holding the mutex, with `close` waiting behind it.
A single such client kept the transport from closing at all.
The results are now written on a helper thread that `close` waits for at most `LISTEN_TEARDOWN_TIMEOUT`
(5 seconds) in all. When the time is up, every stream still open is closed from `close` itself: on a Ruby IO
that ends a write stalled on it with an `IOError` the helper rescues, while a stream object of another kind may
keep the helper blocked, which no longer holds `close`. Either way that stream goes without its result, like one
whose acknowledgement was never written, so the client re-sends. The helper is left to finish rather than
killed, so a write mutex is never dropped in the middle of a write. An error other than a lost peer raised by
a stream's write is reported through the exception reporter and no longer escapes `close`, which would
have skipped the remaining streams and the session cleanup.
Nor does an exception reporter that raises on that report: it is dropped, and the teardown goes on.
Whichever of the helper and `close` takes a stream out of the pending set closes it, so a stream is closed
once in either order.
## How Has This Been Tested?
Three new tests in `test/mcp/server/transports/streamable_http_transport_test.rb`: the teardown returns within
its timeout behind a held write mutex and behind a stalled result write, closing the stream and letting the helper
end on its own, and a result write failing with an unexpected error is reported while the other streams
still get their result. Against the previous library the third raises out of `close`, and a probe holding
a stream's write mutex while calling `close` never returns, where it returns after 5 seconds now.
A fourth test pairs the failing write with an exception reporter that raises: `close` still returns and tears
the rest down, where the previous library raised out of it.
The held-mutex and stalled-write tests count one close of their stream.
## Breaking Changes
None.1 parent a391d32 commit 03867b0
3 files changed
Lines changed: 198 additions & 27 deletions
File tree
- docs/_server
- lib/mcp/server/transports
- test/mcp/server/transports
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
88 | 88 | | |
89 | 89 | | |
90 | 90 | | |
| 91 | + | |
| 92 | + | |
91 | 93 | | |
92 | 94 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
361 | 361 | | |
362 | 362 | | |
363 | 363 | | |
| 364 | + | |
| 365 | + | |
| 366 | + | |
364 | 367 | | |
365 | 368 | | |
366 | 369 | | |
| |||
1453 | 1456 | | |
1454 | 1457 | | |
1455 | 1458 | | |
1456 | | - | |
1457 | | - | |
| 1459 | + | |
| 1460 | + | |
| 1461 | + | |
| 1462 | + | |
| 1463 | + | |
| 1464 | + | |
| 1465 | + | |
| 1466 | + | |
1458 | 1467 | | |
1459 | 1468 | | |
1460 | 1469 | | |
| |||
1465 | 1474 | | |
1466 | 1475 | | |
1467 | 1476 | | |
| 1477 | + | |
1468 | 1478 | | |
1469 | | - | |
1470 | | - | |
1471 | | - | |
1472 | | - | |
1473 | | - | |
1474 | | - | |
| 1479 | + | |
| 1480 | + | |
| 1481 | + | |
| 1482 | + | |
| 1483 | + | |
| 1484 | + | |
| 1485 | + | |
| 1486 | + | |
| 1487 | + | |
| 1488 | + | |
1475 | 1489 | | |
1476 | | - | |
1477 | | - | |
1478 | | - | |
| 1490 | + | |
| 1491 | + | |
| 1492 | + | |
| 1493 | + | |
| 1494 | + | |
1479 | 1495 | | |
1480 | | - | |
1481 | | - | |
1482 | | - | |
1483 | | - | |
1484 | | - | |
1485 | | - | |
1486 | | - | |
1487 | | - | |
1488 | | - | |
1489 | | - | |
1490 | | - | |
1491 | | - | |
1492 | | - | |
1493 | | - | |
1494 | | - | |
| 1496 | + | |
| 1497 | + | |
| 1498 | + | |
| 1499 | + | |
| 1500 | + | |
| 1501 | + | |
| 1502 | + | |
| 1503 | + | |
| 1504 | + | |
| 1505 | + | |
| 1506 | + | |
| 1507 | + | |
| 1508 | + | |
| 1509 | + | |
| 1510 | + | |
| 1511 | + | |
| 1512 | + | |
| 1513 | + | |
| 1514 | + | |
| 1515 | + | |
| 1516 | + | |
| 1517 | + | |
| 1518 | + | |
| 1519 | + | |
| 1520 | + | |
| 1521 | + | |
| 1522 | + | |
| 1523 | + | |
| 1524 | + | |
| 1525 | + | |
| 1526 | + | |
| 1527 | + | |
| 1528 | + | |
| 1529 | + | |
1495 | 1530 | | |
1496 | | - | |
| 1531 | + | |
| 1532 | + | |
| 1533 | + | |
| 1534 | + | |
| 1535 | + | |
| 1536 | + | |
| 1537 | + | |
| 1538 | + | |
| 1539 | + | |
| 1540 | + | |
| 1541 | + | |
| 1542 | + | |
1497 | 1543 | | |
1498 | 1544 | | |
1499 | 1545 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6927 | 6927 | | |
6928 | 6928 | | |
6929 | 6929 | | |
| 6930 | + | |
| 6931 | + | |
| 6932 | + | |
| 6933 | + | |
| 6934 | + | |
| 6935 | + | |
| 6936 | + | |
| 6937 | + | |
| 6938 | + | |
| 6939 | + | |
| 6940 | + | |
| 6941 | + | |
| 6942 | + | |
| 6943 | + | |
| 6944 | + | |
| 6945 | + | |
| 6946 | + | |
| 6947 | + | |
| 6948 | + | |
| 6949 | + | |
| 6950 | + | |
| 6951 | + | |
| 6952 | + | |
| 6953 | + | |
| 6954 | + | |
| 6955 | + | |
| 6956 | + | |
| 6957 | + | |
| 6958 | + | |
| 6959 | + | |
| 6960 | + | |
| 6961 | + | |
| 6962 | + | |
| 6963 | + | |
| 6964 | + | |
| 6965 | + | |
| 6966 | + | |
| 6967 | + | |
| 6968 | + | |
| 6969 | + | |
| 6970 | + | |
| 6971 | + | |
| 6972 | + | |
| 6973 | + | |
| 6974 | + | |
| 6975 | + | |
| 6976 | + | |
| 6977 | + | |
| 6978 | + | |
| 6979 | + | |
| 6980 | + | |
| 6981 | + | |
| 6982 | + | |
| 6983 | + | |
| 6984 | + | |
| 6985 | + | |
| 6986 | + | |
| 6987 | + | |
| 6988 | + | |
| 6989 | + | |
| 6990 | + | |
| 6991 | + | |
| 6992 | + | |
| 6993 | + | |
| 6994 | + | |
| 6995 | + | |
| 6996 | + | |
| 6997 | + | |
| 6998 | + | |
| 6999 | + | |
| 7000 | + | |
| 7001 | + | |
| 7002 | + | |
| 7003 | + | |
| 7004 | + | |
| 7005 | + | |
| 7006 | + | |
| 7007 | + | |
| 7008 | + | |
| 7009 | + | |
| 7010 | + | |
| 7011 | + | |
| 7012 | + | |
| 7013 | + | |
| 7014 | + | |
| 7015 | + | |
| 7016 | + | |
| 7017 | + | |
| 7018 | + | |
| 7019 | + | |
| 7020 | + | |
| 7021 | + | |
| 7022 | + | |
| 7023 | + | |
| 7024 | + | |
| 7025 | + | |
| 7026 | + | |
| 7027 | + | |
| 7028 | + | |
| 7029 | + | |
| 7030 | + | |
| 7031 | + | |
| 7032 | + | |
| 7033 | + | |
| 7034 | + | |
| 7035 | + | |
| 7036 | + | |
| 7037 | + | |
| 7038 | + | |
| 7039 | + | |
| 7040 | + | |
| 7041 | + | |
| 7042 | + | |
| 7043 | + | |
| 7044 | + | |
| 7045 | + | |
| 7046 | + | |
| 7047 | + | |
| 7048 | + | |
| 7049 | + | |
| 7050 | + | |
| 7051 | + | |
| 7052 | + | |
6930 | 7053 | | |
6931 | 7054 | | |
6932 | 7055 | | |
| |||
0 commit comments