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.

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

fix: update resume token for restarting BiDi streams #10282

Merged
merged 4 commits into from
Jan 31, 2020
Merged

fix: update resume token for restarting BiDi streams #10282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eb98435
fix: fetch updated resume tokens for restarting of stream
crwilcox Jan 29, 2020
19a7e59
fix: Improve DummyRPC to call initial_request when necessary
crwilcox Jan 29, 2020
3c170a3
fix: rename method to reflect request is not initial only
crwilcox Jan 31, 2020
a20b5d8
fix: adjust test to use new function name
crwilcox Jan 31, 2020
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
16 changes: 11 additions & 5 deletions firestore/google/cloud/firestore_v1/watch.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,9 +213,9 @@ def __init__(
self._closing = threading.Lock()
self._closed = False

initial_request = firestore_pb2.ListenRequest(
database=self._firestore._database_string, add_target=self._targets
)
self.resume_token = None

rpc_request = self._get_rpc_request

if ResumableBidiRpc is None:
ResumableBidiRpc = self.ResumableBidiRpc # FBO unit tests
Expand All @@ -224,7 +224,7 @@ def __init__(
self._api.transport.listen,
should_recover=_should_recover,
should_terminate=_should_terminate,
initial_request=initial_request,
initial_request=rpc_request,
metadata=self._firestore._rpc_metadata,
)

Expand Down Expand Up @@ -252,13 +252,19 @@ def __init__(
self.has_pushed = False

# The server assigns and updates the resume token.
self.resume_token = None
if BackgroundConsumer is None: # FBO unit tests
BackgroundConsumer = self.BackgroundConsumer

self._consumer = BackgroundConsumer(self._rpc, self.on_snapshot)
self._consumer.start()

def _get_rpc_request(self):
if self.resume_token is not None:
self._targets["resume_token"] = self.resume_token
return firestore_pb2.ListenRequest(
database=self._firestore._database_string, add_target=self._targets
)

@property
def is_active(self):
"""bool: True if this manager is actively streaming.
Expand Down
8 changes: 7 additions & 1 deletion firestore/tests/unit/v1/test_watch.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -776,6 +776,12 @@ def test__reset_docs(self):
self.assertEqual(inst.resume_token, None)
self.assertFalse(inst.current)

def test_resume_token_sent_on_recovery(self):
inst = self._makeOne()
inst.resume_token = b"ABCD0123"
request = inst._get_rpc_request()
self.assertEqual(request.add_target.resume_token, b"ABCD0123")


class DummyFirestoreStub(object):
def Listen(self): # pragma: NO COVER
Expand Down Expand Up @@ -922,7 +928,7 @@ def __init__(
self.start_rpc = start_rpc
self.should_recover = should_recover
self.should_terminate = should_terminate
self.initial_request = initial_request
self.initial_request = initial_request()
self.metadata = metadata
self.closed = False
self.callbacks = []
Expand Down