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

Improve performance of generating random WebSocket mask #8667

Merged
merged 3 commits into from
Aug 9, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Aug 9, 2024

What do these changes do?

The mask was being generated with randint and than converted to bytes. We can skip a few steps and generate it with getrandbits() and pack it into bytes.

related RFC: https://datatracker.ietf.org/doc/html/rfc6455#section-5.3

Are there changes in behavior for the user?

No

Is it a substantial burden for the maintainers to support this?

no

I was looking at pings and noticed that most of the time is spent in randrange
Screenshot 2024-08-08 at 9 13 27 PM

The mask was being generated with randint and than
converted to bytes. We can skip a few steps and
generate it with getrandbits() and pack it into
bytes.
@bdraco bdraco added this to the 3.10.3 milestone Aug 9, 2024
@bdraco bdraco added backport-3.10 backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot labels Aug 9, 2024
Copy link

codecov bot commented Aug 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.97%. Comparing base (4d604ea) to head (f9b3ccd).
Report is 815 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #8667   +/-   ##
=======================================
  Coverage   97.97%   97.97%           
=======================================
  Files         107      107           
  Lines       33790    33791    +1     
  Branches     3969     3969           
=======================================
+ Hits        33106    33107    +1     
  Misses        507      507           
  Partials      177      177           
Flag Coverage Δ
CI-GHA 97.88% <100.00%> (+<0.01%) ⬆️
OS-Linux 97.54% <100.00%> (+<0.01%) ⬆️
OS-Windows 95.91% <100.00%> (+<0.01%) ⬆️
OS-macOS 97.20% <100.00%> (+<0.01%) ⬆️
Py-3.10.11 97.34% <100.00%> (+<0.01%) ⬆️
Py-3.10.14 97.28% <100.00%> (+<0.01%) ⬆️
Py-3.11.9 97.50% <100.00%> (+<0.01%) ⬆️
Py-3.12.4 97.62% <100.00%> (+<0.01%) ⬆️
Py-3.8.10 95.55% <100.00%> (+<0.01%) ⬆️
Py-3.8.18 97.06% <100.00%> (+<0.01%) ⬆️
Py-3.9.13 97.21% <100.00%> (+<0.01%) ⬆️
Py-3.9.19 97.16% <100.00%> (+<0.01%) ⬆️
Py-pypy7.3.16 96.75% <100.00%> (+<0.01%) ⬆️
VM-macos 97.20% <100.00%> (+<0.01%) ⬆️
VM-ubuntu 97.54% <100.00%> (+<0.01%) ⬆️
VM-windows 95.91% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Aug 9, 2024
@bdraco bdraco marked this pull request as ready for review August 9, 2024 02:32
@bdraco
Copy link
Member Author

bdraco commented Aug 9, 2024

thanks

@bdraco bdraco merged commit 406cd2c into master Aug 9, 2024
37 of 38 checks passed
@bdraco bdraco deleted the websocket_random_mask branch August 9, 2024 13:35
Copy link
Contributor

patchback bot commented Aug 9, 2024

Backport to 3.10: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.10/406cd2c7512db5a3f7e389be926eedd5a3bf6dc4/pr-8667

Backported as #8668

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

Copy link
Contributor

patchback bot commented Aug 9, 2024

Backport to 3.11: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.11/406cd2c7512db5a3f7e389be926eedd5a3bf6dc4/pr-8667

Backported as #8669

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Aug 9, 2024
bdraco added a commit that referenced this pull request Aug 9, 2024
…random WebSocket mask (#8668)

Co-authored-by: J. Nick Koston <nick@koston.org>
bdraco added a commit that referenced this pull request Aug 9, 2024
…random WebSocket mask (#8669)

Co-authored-by: J. Nick Koston <nick@koston.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot bot:chronographer:provided There is a change note present in this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants