Skip to content

Fix WebSocketResponse.prepared not correctly reflect the WebSocket's prepared state#10971

Merged
bdraco merged 9 commits intomasterfrom
fix_6009
May 23, 2025
Merged

Fix WebSocketResponse.prepared not correctly reflect the WebSocket's prepared state#10971
bdraco merged 9 commits intomasterfrom
fix_6009

Conversation

@bdraco
Copy link
Copy Markdown
Member

@bdraco bdraco commented May 23, 2025 •
edited
Loading

This PR fixes an issue where the WebSocketResponse.prepared property did not correctly reflect the WebSocket's prepared state, particularly during timeout scenarios.

Previously, the prepared property inherited from StreamResponse only checked for _payload_writer, but in WebSocket timeout scenarios, the _writer could be set while _payload_writer remained None, leading to incorrect state reporting.

Changes

  • Added an explicit prepared property to WebSocketResponse that checks for _writer instead of relying on the parent class's _payload_writer check
  • Added a check in the prepare() method to prevent double preparation when _writer is already set
  • Added comprehensive tests covering timeout scenarios and edge cases where WebSocket state needs to be correctly tracked

fixes #6009

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label May 23, 2025
@bdraco bdraco changed the title Fix websocket prepare Fix WebSocketResponse.prepared` not correctly reflect the WebSocket's prepared state May 23, 2025
@bdraco bdraco changed the title Fix WebSocketResponse.prepared` not correctly reflect the WebSocket's prepared state Fix WebSocketResponse.prepared not correctly reflect the WebSocket's prepared state May 23, 2025
@codecov
Copy link
Copy Markdown

codecov bot commented May 23, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.77%. Comparing base (1878509) to head (2cb4df5).
⚠️ Report is 483 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master   #10971      +/-   ##
==========================================
+ Coverage   98.10%   98.77%   +0.66%     
==========================================
  Files         129      129              
  Lines       39541    39620      +79     
  Branches     2185     2186       +1     
==========================================
+ Hits        38792    39133     +341     
+ Misses        591      339     -252     
+ Partials      158      148      -10
Flag Coverage Δ
CI-GHA 98.65% <100.00%> (+0.65%) ⬆️
OS-Linux 98.36% <100.00%> (+0.66%) ⬆️
OS-Windows 96.54% <100.00%> (+0.54%) ⬆️
OS-macOS 97.51% <100.00%> (-0.01%) ⬇️
Py-3.10.11 97.40% <100.00%> (+0.29%) ⬆️
Py-3.10.17 97.93% <100.00%> (+0.63%) ⬆️
Py-3.11.12 98.02% <100.00%> (?)
Py-3.11.9 97.48% <100.00%> (+0.29%) ⬆️
Py-3.12.10 98.42% <100.00%> (+0.93%) ⬆️
Py-3.13.3 98.40% <100.00%> (+1.10%) ⬆️
Py-3.9.13 97.28% <100.00%> (+<0.01%) ⬆️
Py-3.9.22 97.80% <100.00%> (+0.66%) ⬆️
Py-pypy7.3.16 84.87% <9.23%> (?)
VM-macos 97.51% <100.00%> (-0.01%) ⬇️
VM-ubuntu 98.36% <100.00%> (+0.66%) ⬆️
VM-windows 96.54% <100.00%> (+0.54%) ⬆️

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.

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq bot commented May 23, 2025 •
edited
Loading

CodSpeed Performance Report

Merging #10971 will not alter performance

Comparing fix_6009 (2cb4df5) with master (48f5324)

Summary

✅ 59 untouched benchmarks

@bdraco bdraco marked this pull request as ready for review May 23, 2025 18:50
@bdraco bdraco requested review from asvetlov and webknjaz as code owners May 23, 2025 18:50
@bdraco bdraco merged commit 1ee187c into master May 23, 2025
40 checks passed
@bdraco bdraco deleted the fix_6009 branch May 23, 2025 18:59
@patchback
Copy link
Copy Markdown
Contributor

patchback bot commented May 23, 2025 •
edited
Loading

Backport to 3.11: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.11/1ee187c08c9bb59acb53e1c80a06c79a4183de10/pr-10971

Backported as #10982

🤖 @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 May 23, 2025
@bdraco @patchback
Fix WebSocketResponse.prepared not correctly reflect the WebSocket'…
1cd0c38 
…s prepared state (#10971)

(cherry picked from commit 1ee187c)
@patchback patchback bot mentioned this pull request May 23, 2025
Merged
@patchback
Copy link
Copy Markdown
Contributor

patchback bot commented May 23, 2025 •
edited
Loading

Backport to 3.12: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.12/1ee187c08c9bb59acb53e1c80a06c79a4183de10/pr-10971

Backported as #10983

🤖 @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 May 23, 2025
@bdraco @patchback
Fix WebSocketResponse.prepared not correctly reflect the WebSocket'…
c283fcb 
…s prepared state (#10971)

(cherry picked from commit 1ee187c)
@patchback patchback bot mentioned this pull request May 23, 2025
Merged
bdraco added a commit that referenced this pull request May 23, 2025
@patchback @bdraco
[PR #10971/1ee187c0 backport][3.11] Fix WebSocketResponse.prepared …
39459ab 
…not correctly reflect the WebSocket's prepared state (#10982)

Co-authored-by: J. Nick Koston <[email protected]>
fixes #6009
bdraco added a commit that referenced this pull request May 23, 2025
@patchback @bdraco
[PR #10971/1ee187c0 backport][3.12] Fix WebSocketResponse.prepared …
b21ae98 
…not correctly reflect the WebSocket's prepared state (#10983)

Co-authored-by: J. Nick Koston <[email protected]>
fixes #6009
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@webknjaz webknjaz Awaiting requested review from webknjaz webknjaz is a code owner

@asvetlov asvetlov Awaiting requested review from asvetlov asvetlov is a code owner

Assignees

No one assigned

Labels

bot:chronographer:provided There is a change note present in this PR

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

WebSocket prepare property incorrectly reflects prepared state

1 participant

@bdraco