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

Add new send_frame method to WebSockets #9348

Merged
merged 12 commits into from
Sep 29, 2024
Merged

Add new send_frame method to WebSockets #9348

merged 12 commits into from
Sep 29, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Sep 29, 2024

What do these changes do?

Currently there is no way to send TEXT frames when the source data is a UTF-8 encoded bytes object without having decode the bytes to string before passing it to send_str, and than having the WebSocket internals encode it back to bytes. When sending at volume, the extra decode/encode cycle is a significant bottleneck.

Are there changes in behavior for the user?

no

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

no

Currently there is no way to send TEXT frames when the source
data is a UTF-8 encoded bytes object without having decode the
bytes to string before passing it to `send_str`, and than having
the WebSocket internals encode it back to `bytes`. When sending
at volume, the extra decode/encode cycle is a significant bottleneck.
@bdraco bdraco added the backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot label Sep 29, 2024
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Sep 29, 2024
@bdraco
Copy link
Member Author

bdraco commented Sep 29, 2024

Thanks for the review

Copy link

codecov bot commented Sep 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.56%. Comparing base (9314651) to head (2a29b72).
Report is 1 commits behind head on master.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #9348   +/-   ##
=======================================
  Coverage   98.55%   98.56%           
=======================================
  Files         107      107           
  Lines       34915    34949   +34     
  Branches     4138     4139    +1     
=======================================
+ Hits        34412    34446   +34     
  Misses        335      335           
  Partials      168      168           
Flag Coverage Δ
CI-GHA 98.44% <100.00%> (+<0.01%) ⬆️
OS-Linux 98.10% <100.00%> (+<0.01%) ⬆️
OS-Windows 96.51% <100.00%> (+<0.01%) ⬆️
OS-macOS 97.79% <100.00%> (+<0.01%) ⬆️
Py-3.10.11 97.66% <100.00%> (+<0.01%) ⬆️
Py-3.10.15 97.60% <100.00%> (+<0.01%) ⬆️
Py-3.11.10 97.66% <100.00%> (+<0.01%) ⬆️
Py-3.11.9 97.72% <100.00%> (-0.01%) ⬇️
Py-3.12.6 98.15% <100.00%> (+<0.01%) ⬆️
Py-3.13.0-rc.2 98.13% <100.00%> (+<0.01%) ⬆️
Py-3.9.13 97.56% <100.00%> (-0.01%) ⬇️
Py-3.9.20 97.50% <100.00%> (+<0.01%) ⬆️
Py-pypy7.3.16 97.12% <100.00%> (+<0.01%) ⬆️
VM-macos 97.79% <100.00%> (+<0.01%) ⬆️
VM-ubuntu 98.10% <100.00%> (+<0.01%) ⬆️
VM-windows 96.51% <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.

@bdraco bdraco marked this pull request as ready for review September 29, 2024 18:12
@bdraco bdraco merged commit 2628256 into master Sep 29, 2024
38 of 39 checks passed
@bdraco bdraco deleted the send_frame branch September 29, 2024 19:18
Copy link
Contributor

patchback bot commented Sep 29, 2024

Backport to 3.11: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 2628256 on top of patchback/backports/3.11/2628256c0a4bea74b9fec9169c7fbefe622fcac1/pr-9348

Backporting merged PR #9348 into master

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/aio-libs/aiohttp.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/3.11/2628256c0a4bea74b9fec9169c7fbefe622fcac1/pr-9348 upstream/3.11
  4. Now, cherry-pick PR Add new send_frame method to WebSockets #9348 contents into that branch:
    $ git cherry-pick -x 2628256c0a4bea74b9fec9169c7fbefe622fcac1
    If it'll yell at you with something like fatal: Commit 2628256c0a4bea74b9fec9169c7fbefe622fcac1 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 2628256c0a4bea74b9fec9169c7fbefe622fcac1
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Add new send_frame method to WebSockets #9348 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.11/2628256c0a4bea74b9fec9169c7fbefe622fcac1/pr-9348
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

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

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