Skip to content

fix: Watch thread deadlock on exit #1014

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.

Sign up for GitHub

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

Merged
daniel-sanche merged 3 commits into from
Feb 25, 2025
Merged

fix: Watch thread deadlock on exit #1014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c7feaa1
fix: fix thread cleanup when destroying Watch instance
daniel-sanche Feb 1, 2025
809330f
added test for on_snapshot while closing
daniel-sanche Feb 21, 2025
83770e3
Merge branch 'main' into fix_watch_deadlock
daniel-sanche Feb 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions google/cloud/firestore_v1/watch.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,6 +440,9 @@ def on_snapshot(self, proto):
proto(`google.cloud.firestore_v1.types.ListenResponse`):
Callback method that receives a object to
"""
if self._closing.locked():
# don't process on_snapshot responses while spinning down, to prevent deadlock
return
if proto is None:
self.close()
return
Expand Down
9 changes: 9 additions & 0 deletions tests/unit/v1/test_watch.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,15 @@ def test_watch_on_snapshot_target_w_none():
assert inst._rpc is None


def test_watch_on_snapshot_while_closing():
inst = _make_watch()
inst.close = mock.Mock()
with inst._closing:
inst.on_snapshot(mock.Mock())
# close should not be called again when already closing
inst.close.assert_not_called()


def test_watch_on_snapshot_target_no_change_no_target_ids_not_current():
inst = _make_watch()
proto = _make_listen_response()
Expand Down
Loading