Support transport agnostic token passing in channels #6086
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
For WebSocket, the `Sec-WebSocket-Protocol` header is used. For LongPoll, an `Authorization` header is passed instead. Fixes #5778.
josevalim
reviewed
Feb 14, 2025
josevalim
reviewed
Feb 14, 2025
josevalim
reviewed
Feb 14, 2025
josevalim
reviewed
Feb 15, 2025
josevalim
reviewed
Feb 15, 2025
| conn | ||
| |> fetch_query_params() | ||
| |> Transport.code_reload(endpoint, opts) | ||
| |> Transport.transport_log(opts[:transport_log]) | ||
| |> Transport.check_origin(handler, endpoint, opts) | ||
| |> Transport.check_subprotocols(opts[:subprotocols]) | ||
| |> maybe_auth_token_from_header(opts[:auth_token]) | ||
| |> Transport.check_subprotocols(subprotocols) |
There was a problem hiding this comment.
Honestly, it feels we should just bring this function to this module and have it deal with both auth_token and subprotocols at once, or move auth_token to check subprotocols. Transport is meant to have transport agnostic functions, and that one is clearly websockets related, so it shouldn't exist in the first place.
There was a problem hiding this comment.
It is part of the public API, so we can't really change it, can we?
https://hexdocs.pm/phoenix/Phoenix.Socket.Transport.html#check_subprotocols/2
There was a problem hiding this comment.
Yes, we cannot, but maybe we can move the auth token handling there anyway?
josevalim
approved these changes
Feb 15, 2025
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
For WebSocket, the
Sec-WebSocket-Protocolheader is used. For LongPoll, anAuthorizationheader is passed instead.Fixes #5778.