Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(websockets): require @nestjs/platform-socket.io correctly #6217

Merged
merged 1 commit into from
Feb 2, 2021

Conversation

merceyz
Copy link
Contributor

@merceyz merceyz commented Jan 21, 2021

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[x] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Other... Please describe:

What is the current behavior?

The undeclared peer dependency @nestjs/platform-socket.io is required from @nestjs/core instead of @nestjs/websockets

Issue Number: N/A

What is the new behavior?

The peer dependency is declared and required from @nestjs/websockets

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

See https://yarnpkg.com/advanced/rulebook#packages-should-only-ever-require-what-they-formally-list-in-their-dependencies
Similar to #5477

@coveralls
Copy link

coveralls commented Jan 21, 2021

Pull Request Test Coverage Report for Build 6f9f87d2-06ea-4c9a-976f-de9b11c5bb49

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 94.741%

Totals Coverage Status
Change from base Build fdd57427-3ec5-473b-b2a7-c14bbe01124b: 0.0%
Covered Lines: 5080
Relevant Lines: 5362

💛 - Coveralls

@kamilmysliwiec
Copy link
Member

kamilmysliwiec commented Jan 22, 2021

Thanks for your contribution! We should add the peerDependenciesMeta and mark this dependency as optional (+ we should add @nestjs/platform-ws too)

@merceyz
Copy link
Contributor Author

merceyz commented Jan 31, 2021

I didn't mark it as optional because it didn't look like it was.

(+ we should add @nestjs/platform-ws too)

Could you give me a pointer to where it's used / be more specific?

@merceyz merceyz force-pushed the merceyz/websockets-peer branch from 7114f79 to 142b39e Compare January 31, 2021 16:04
@kamilmysliwiec kamilmysliwiec added this to the 8.0.0 milestone Feb 2, 2021
@kamilmysliwiec kamilmysliwiec changed the base branch from master to 8.0.0 February 2, 2021 08:54
@kamilmysliwiec kamilmysliwiec merged commit f57d1c5 into nestjs:8.0.0 Feb 2, 2021
@merceyz merceyz deleted the merceyz/websockets-peer branch February 2, 2021 09:07
This was referenced Jul 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants