Fix timer handle churn in websocket heartbeat

[bdraco]

What do these changes do?

Each message would cancel and reset the timer handler which meant asyncio would have to rebuild the whole schedule heap frequently because so many timer handlers were being created and than cancelled.

When asyncio timer handle cancels reach the threadhold the whole heap has to be rebuilt
https://github.com/python/cpython/blob/1422500d020bd199b26357fc387f8b79b82226cd/Lib/asyncio/base_events.py#L1968 which is extremely inefficent.

To solve this, when a timer handle is already running, instead of cancelling it, we let it fire and reschedule if heartbeat would be sent to early.

The websocket ping/pong code was missing some coverage in this area so there are some new tests as well.

Are there changes in behavior for the user?

no

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

no

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.93%. Comparing base (b2691f2) to head (f9c6027).
Report is 854 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #8608      +/-   ##
==========================================
+ Coverage   97.90%   97.93%   +0.03%     
==========================================
  Files         107      107              
  Lines       33515    33669     +154     
  Branches     3941     3952      +11     
==========================================
+ Hits        32813    32974     +161     
+ Misses        518      515       -3     
+ Partials      184      180       -4     

Flag	Coverage Δ
CI-GHA	97.85% <100.00%> (+0.03%)	⬆️
OS-Linux	97.51% <100.00%> (+0.03%)	⬆️
OS-Windows	95.87% <100.00%> (+0.01%)	⬆️
OS-macOS	97.17% <98.48%> (+0.02%)	⬆️
Py-3.10.11	97.32% <98.48%> (+0.02%)	⬆️
Py-3.10.14	97.26% <100.00%> (+0.03%)	⬆️
Py-3.11.9	97.49% <100.00%> (+0.03%)	⬆️
Py-3.12.4	97.62% <100.00%> (+0.03%)	⬆️
Py-3.8.10	95.64% <100.00%> (+0.01%)	⬆️
Py-3.8.18	97.16% <100.00%> (+0.03%)	⬆️
Py-3.9.13	97.31% <98.48%> (+0.02%)	⬆️
Py-3.9.19	97.25% <100.00%> (+0.03%)	⬆️
Py-pypy7.3.16	96.84% <100.00%> (+0.03%)	⬆️
VM-macos	97.17% <98.48%> (+0.02%)	⬆️
VM-ubuntu	97.51% <100.00%> (+0.03%)	⬆️
VM-windows	95.87% <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]

We don't have any tests for when the heartbeat would get rescheduled. Need to write some.

[bdraco]

95.2% reduction in websocket client timer handler churn. That's even with the downstream libs that already have their own ping/pong implementation.

I'm happy with this. I'll let it bake overnight and than write some tests tomorrow if I don't have any more fires from my day job to put out.

[bdraco]

95.1% reduction on the other instance I tested this on

[Dreamsorcerer]

Looks good to me. I'm about to update these test files with type checking though, so would be great if you can update after those changes.

[bdraco]

Thanks!

[patchback]

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

❌ Failed to cleanly apply c4acabc on top of patchback/backports/3.10/c4acabc836ab969e95199aa976e85c01df720a27/pr-8608

Backporting merged PR #8608 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.10/c4acabc836ab969e95199aa976e85c01df720a27/pr-8608 upstream/3.10

4. Now, cherry-pick PR Fix timer handle churn in websocket heartbeat #8608 contents into that branch:

   $ git cherry-pick -x c4acabc836ab969e95199aa976e85c01df720a27

   If it'll yell at you with something like fatal: Commit c4acabc836ab969e95199aa976e85c01df720a27 is a merge but no -m option was given., add -m 1 as follows instead:

   $ git cherry-pick -m1 -x c4acabc836ab969e95199aa976e85c01df720a27

5. At this point, you'll probably encounter some merge conflicts. You must
   resolve them in to preserve the patch from PR Fix timer handle churn in websocket heartbeat #8608 as close to the
   original as possible.
6. Push this branch to your fork on GitHub:

   $ git push origin patchback/backports/3.10/c4acabc836ab969e95199aa976e85c01df720a27/pr-8608

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.

[patchback]

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

❌ Failed to cleanly apply c4acabc on top of patchback/backports/3.11/c4acabc836ab969e95199aa976e85c01df720a27/pr-8608

Backporting merged PR #8608 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/c4acabc836ab969e95199aa976e85c01df720a27/pr-8608 upstream/3.11

4. Now, cherry-pick PR Fix timer handle churn in websocket heartbeat #8608 contents into that branch:

   $ git cherry-pick -x c4acabc836ab969e95199aa976e85c01df720a27

   If it'll yell at you with something like fatal: Commit c4acabc836ab969e95199aa976e85c01df720a27 is a merge but no -m option was given., add -m 1 as follows instead:

   $ git cherry-pick -m1 -x c4acabc836ab969e95199aa976e85c01df720a27

5. At this point, you'll probably encounter some merge conflicts. You must
   resolve them in to preserve the patch from PR Fix timer handle churn in websocket heartbeat #8608 as close to the
   original as possible.
6. Push this branch to your fork on GitHub:

   $ git push origin patchback/backports/3.11/c4acabc836ab969e95199aa976e85c01df720a27/pr-8608

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.