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.

Sign up for GitHub

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

Jump to bottom

Bump ws from 8.16.0 to 8.17.0 #143

Merged
merged 1 commit into from
May 30, 2024
Merged

Bump ws from 8.16.0 to 8.17.0 #143

merged 1 commit into from
May 30, 2024

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github May 13, 2024 •
edited
Loading

Bumps ws from 8.16.0 to 8.17.0.

Release notes

Sourced from ws's releases.

8.17.0

Features

  • The WebSocket constructor now accepts the createConnection option (#2219).

Other notable changes

  • The default value of the allowSynchronousEvents option has been changed to true (#2221).

This is a breaking change in a patch release. The assumption is that the option is not widely used.

Commits

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code labels May 13, 2024
@dependabot dependabot bot requested review from a team and acronhub and removed request for a team May 13, 2024 05:09
@dependabot
Bump ws from 8.16.0 to 8.17.0
9a5c5ac 
Bumps [ws](https://github.com/websockets/ws) from 8.16.0 to 8.17.0.
- [Release notes](https://github.com/websockets/ws/releases)
- [Commits](websockets/ws@8.16.0...8.17.0)

---
updated-dependencies:
- dependency-name: ws
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/ws-8.17.0 branch from 1372cd2 to 9a5c5ac Compare May 30, 2024 02:33
@kimkim0814 kimkim0814 requested review from kimkim0814 and removed request for acronhub May 30, 2024 07:40
@kimkim0814
Copy link
Member

kimkim0814 commented May 30, 2024 •
edited
Loading

8.16.0から8.17.0の変更点

he default value of the allowSynchronousEvents option has been changed to
true (websockets/ws#2221).

allowSynchronousEventsのデフォルト値がfalseからtrueに変更された

該当コード:https://github.com/websockets/ws/pull/2221/files

allowSynchronousEventsとは

allowSynchronousEvents {Boolean} Specifies whether any of the 'message', 'ping', and 'pong' events can be emitted multiple times in the same tick. Defaults to true. Setting it to false improves compatibility with the WHATWG standardbut may negatively impact performance.
ref:https://github.com/websockets/ws/blob/master/doc/ws.md

WebSocketサーバーのオプションの一つで、message、ping、pongといったイベントが同じtick（イベントループの一周）内で複数回発火できるかどうかを指定する。
同じtick内で複数のイベントが発火できると、高速な通信や大量のイベントを処理する必要がある場合にパフォーマンスを向上させることができる。

false に設定すると 、同じtick内で一つのイベントしか発火できない。
WHATWG 標準との互換性が向上するが、パフォーマンスに悪影響を与える可能性がある。

【上記を考えた上での対応】
以前と全く同じ挙動を保証するなら、allowSynchronousEventsオプションをfalseにすれば良いが
パフォーマンスに差異次第ではtrueにしても良さそう。

  • falseならコードを書き換える必要がある
  • trueならコードを書き換える必要がない
    • できる限りデフォルト値にしたいのと、パフォーマンスを考慮してtrueにする

kimkim0814
kimkim0814 approved these changes May 30, 2024
View reviewed changes
Copy link
Member

@kimkim0814 kimkim0814 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

開発環境でプレビューを開いたが問題なく動作した。
LGTM!

@kimkim0814 kimkim0814 merged commit 9e92c63 into main May 30, 2024
6 checks passed
@kimkim0814 kimkim0814 deleted the dependabot/npm_and_yarn/ws-8.17.0 branch May 30, 2024 08:33
@wataru86 wataru86 mentioned this pull request Jun 14, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kimkim0814 kimkim0814 kimkim0814 approved these changes

Assignees
No one assigned
Labels
dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@kimkim0814