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 support for adjusting the server WebSocket writer limit #9572

Merged
merged 6 commits into from
Oct 28, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Oct 28, 2024

What do these changes do?

Downstream is currently manually patching to increase the limit because the WebSocket has too much back pressure on reconnect as significant number of large messages get sent right after the connection is established. These sometimes take a while to get delivered because of latency, and too much back pressure causes downstream application to hit a timeout and disconnect prematurely.

#1367 added the limit but there has never been a way to adjust it in the public API.

Are there changes in behavior for the user?

no

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

no

Downstream is currently manually patching to increase the limit
because the WebSocket has too much back pressure on reconnect
as significant number of large messages get sent right after
the connection is established. These sometimes take a while
to get delivered because of latancy over the internet and
too much back pressure causes downstream application to hit
timeouts.
@bdraco bdraco added the backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot label Oct 28, 2024
aiohttp/web_ws.py Outdated Show resolved Hide resolved
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Oct 28, 2024
Copy link

codspeed-hq bot commented Oct 28, 2024

CodSpeed Performance Report

Merging #9572 will not alter performance

Comparing writer_limit (bef4411) with master (06b2398)

Summary

✅ 5 untouched benchmarks

@bdraco bdraco marked this pull request as ready for review October 28, 2024 20:01
@bdraco bdraco enabled auto-merge (squash) October 28, 2024 20:01
Copy link

codecov bot commented Oct 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.60%. Comparing base (06b2398) to head (bef4411).
Report is 610 commits behind head on master.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #9572   +/-   ##
=======================================
  Coverage   98.60%   98.60%           
=======================================
  Files         113      113           
  Lines       35290    35301   +11     
  Branches     4191     4191           
=======================================
+ Hits        34797    34808   +11     
  Misses        331      331           
  Partials      162      162           
Flag Coverage Δ
CI-GHA 98.48% <100.00%> (+<0.01%) ⬆️
OS-Linux 98.16% <100.00%> (+<0.01%) ⬆️
OS-Windows 96.05% <100.00%> (+<0.01%) ⬆️
OS-macOS 97.37% <100.00%> (+<0.01%) ⬆️
Py-3.10.11 97.23% <100.00%> (+<0.01%) ⬆️
Py-3.10.15 97.64% <100.00%> (+<0.01%) ⬆️
Py-3.11.10 97.72% <100.00%> (+<0.01%) ⬆️
Py-3.11.9 97.31% <100.00%> (+1.62%) ⬆️
Py-3.12.7 98.20% <100.00%> (+<0.01%) ⬆️
Py-3.13.0 98.18% <100.00%> (+<0.01%) ⬆️
Py-3.9.13 97.14% <100.00%> (+<0.01%) ⬆️
Py-3.9.20 97.55% <100.00%> (+<0.01%) ⬆️
Py-pypy7.3.16 97.17% <100.00%> (+<0.01%) ⬆️
VM-macos 97.37% <100.00%> (+<0.01%) ⬆️
VM-ubuntu 98.16% <100.00%> (+<0.01%) ⬆️
VM-windows 96.05% <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 merged commit e36c5f0 into master Oct 28, 2024
40 of 41 checks passed
@bdraco bdraco deleted the writer_limit branch October 28, 2024 20:56
Copy link
Contributor

patchback bot commented Oct 28, 2024

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

❌ Failed to cleanly apply e36c5f0 on top of patchback/backports/3.11/e36c5f0ffeeea0076736c5756d63f5933c91eb8d/pr-9572

Backporting merged PR #9572 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/e36c5f0ffeeea0076736c5756d63f5933c91eb8d/pr-9572 upstream/3.11
  4. Now, cherry-pick PR Add support for adjusting the server WebSocket writer limit #9572 contents into that branch:
    $ git cherry-pick -x e36c5f0ffeeea0076736c5756d63f5933c91eb8d
    If it'll yell at you with something like fatal: Commit e36c5f0ffeeea0076736c5756d63f5933c91eb8d is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x e36c5f0ffeeea0076736c5756d63f5933c91eb8d
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Add support for adjusting the server WebSocket writer limit #9572 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.11/e36c5f0ffeeea0076736c5756d63f5933c91eb8d/pr-9572
  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.

bdraco added a commit that referenced this pull request Oct 28, 2024
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.

1 participant