feat(websockets): add prefix option for api versioning #10597
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
Pull Request Test Coverage Report for Build efd3d236-d3d5-498c-b8d8-1f7f949aa4d5
💛 - Coveralls |
Tony133
suggested changes
Nov 24, 2022
| options: TOptions, | ||
| ) { | ||
| const { path = '', prefix = '', ...passthrough } = options; | ||
| console.log(options); |
There was a problem hiding this comment.
Suggested change
| console.log(options); |
The console.log() should be removed
0b84258
to
b683ae9
Compare
Tony133
approved these changes
Nov 26, 2022
micalevisk
reviewed
Jan 24, 2023
| * Api version acts as prefix to path | ||
| * @default undefined | ||
| */ | ||
| prefix?: string; |
There was a problem hiding this comment.
since we have prefix and versioning for @Controller(), I found "using prefix for api versioning" a bit strange
Can't we avoid mention that specific use case? 🤔 This leaves room for adding first-class versioning in the future
There was a problem hiding this comment.
do you mean leave the description as just "path prefix"?
micalevisk
reviewed
Feb 6, 2023
| @@ -27,16 +27,21 @@ describe('@WebSocketGateway', () => { | |||
| expect(port).to.be.eql(0); | |||
| }); | |||
|
|
|||
| @WebSocketGateway({ namespace: '/' }) | |||
| @WebSocketGateway({ namespace: '/', path: '/path', prefix: '/prefix' }) | |||
There was a problem hiding this comment.
can we add another test solely to check if the prefix is being added, instead of replacing this one that has no prefix? so we will test both versions
1 task
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.
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?
Websocket gateway options has only
pathand no 'prefix'Issue Number: (#9376)
What is the new behavior?
websocket gateway options now has
pathandprefixwhich get joined for the full path. this can be used for api versioningDoes this PR introduce a breaking change?
Other information