[typescript] Allow client to understand other subprotocols #916
Conversation
This file contains 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
bryfox
commented
Jan 30, 2025
| * A list subprotocols supported by this client. Typically, this will agree with the subprotocols | ||
| * advertised by the provided `IWebSocket` implementation. | ||
| */ | ||
| protected supportedSubprotocols: string[] = [FoxgloveClient.SUPPORTED_SUBPROTOCOL]; |
There was a problem hiding this comment.
SUPPORTED_SUBPROTOCOL is public, so arguably this should be too, but I'm not sure why the former is (or if it still needs to be).
jtbandes
reviewed
Jan 30, 2025
I think that's reasonable. I presume this is a check to make sure the provided ws client is advertising a subprotocol that this library understands (and so can provide a better error), but we could document instead. |
|
I updated the PR and description to remove the check entirely. |
jtbandes
approved these changes
Jan 30, 2025
jtbandes
reviewed
Jan 30, 2025
Co-authored-by: Jacob Bandes-Storch <jacob@foxglove.dev>
bryfox
added a commit
that referenced
this pull request
Jan 31, 2025
### Changelog Remove the explicit check for a supported subprotocol in `FoxgloveClient`. Rely on the WS client to advertise the correct value and the handshake to enforce it. ### Description Version bump for #916
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changelog
None
Docs
None
Description
This removes the "supported subprotocol" check performed after the handshake, instead relying on the underlying websocket client to advertise the correct subprotocol.
The
FoxgloveClientalready accepts a websocket client (IWebSocket), which is free to choose its advertised subprotocols. This change would allow it to be extended with backwards-compatible subprotocols (for example, v2).This change is not breaking as long as existing clients are advertising the correct subprotocol.