fix(ping): enable the documented ping default for httpStream - #369
Merged
Conversation
|
🎉 This PR is included in version 4.20.10 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
ping.enabledis documented as defaulting to true for HTTP Stream and false for stdio, but the httpStream default was never actually being applied.#getPingConfigtries to detect httpStream with"type" in transport && transport.type === "httpStream", but the SDK'sTransportinterface doesn't have atypefield and nothing in fastmcp, mcp-proxy or the SDK sets one. So this branch is never reached and ping stays disabled by default. The existing ping tests also setenabledexplicitly, so this wasn't covered.FastMCPSessionalready gets the transport type and uses it for#needsEventLoopFlush, so I stored it and used that to determine the ping default instead of checking the transport object. SSE isn't a separate transport type here, sotransportType === "httpStream"covers both HTTP Stream and the/sseendpoint.I added a test with an httpStream server using
ping: { intervalMs: 500 }without settingenabled. On main it receives no pings, while with this change it does.This does change the default behaviour for existing httpStream users who don't configure ping — they will start sending a ping every 5s. If the documented default is not intended and ping should stay disabled unless explicitly enabled, I'm also happy to change the docs instead and keep the current runtime behaviour. The main thing I wanted to fix here is the mismatch between the documented behaviour and the actual behaviour.