Add example on how to perform authorization when using subscriptions #1694
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: #394
There are no instructions on how to authenticate users when using subscriptions.
What is the new behavior?
Adds a basic example following the Apollo documentation (with links), and instructions on how to add user information to the GraphQL request context (e.g, for guards and decorators). More advanced authentication methods (e.g., via headers) would rely on how
subscriptions-transport-ws
and itsonConnect
work, and are out of the scope of NestJS. Adding user information to the context in this cases would be similar.Does this PR introduce a breaking change?
Other information
I added a warning about the bug of
subscriptions-transport-ws
that allows connections to be established without going through theonConnect
.