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

[Bug] Fix Document.Get behavior to send unary gRPC request instead of setting up a Listen stream for Document updates #1700

Open
jimit-j-shah opened this issue Mar 13, 2025 · 3 comments

Comments

@jimit-j-shah
Copy link

[REQUIRED] Please fill in the following fields:

  • Pre-built SDK from the website or open-source from this repo: _____
  • Firebase C++ SDK version: unity-v11.8.0 onwards
  • Problematic Firebase Component: Firestore Database API
  • Other Firebase Components in use: N/A
  • Platform you are using the C++ SDK on: Linux (but exists on all platforms)
  • Platform you are targeting: desktop

[REQUIRED] Please describe the issue here:

The Firestore C++ Mobile SDK API implementation for DocumentReference.Get() is sub-optimal. Instead a sending a single gRPC request for Firestore.GetDocument, it opens a Firestore.Listen stream to listen for DocumentSnapshots and serves the first snapshot as response to the Get() call.

At minimum, this has latency impact - cost of setting up and tearing down a Listen stream is higher and using it to only read first version of the DocumentSnapshot, the cost is not amortized. Arguably, this may even be construed as incorrect behavior if one were to look at the network messages generated by these calls by this implementation as it deviates from the intent of the Firestore API.

Steps to reproduce:

Have you been able to reproduce this issue with just the Firebase C++ quickstarts ?
What's the issue repro rate? (eg 100%, 1/5 etc)

100%. Using the DocumentReference.Get() API.

What happened? How can we make the problem occur?
This could be a description, log/console output, etc.

If you have a downloadable sample project that reproduces the bug you're reporting, you will
likely receive a faster response on your issue.

Relevant Code:

Future<DocumentSnapshot> DocumentReferenceInternal::Get(Source source) {

// Get should send a unary RPC - not a Streaming Listen RPC
Future<DocumentSnapshot> DocumentReferenceInternal::Get(Source source) {
  auto promise =
      promise_factory_.CreatePromise<DocumentSnapshot>(AsyncApis::kGet);
  auto listener = ListenerWithPromise<api::DocumentSnapshot>(promise);
  reference_.GetDocument(ToCoreApi(source), std::move(listener));
  return promise.future();
}
@MarkDuckworth
Copy link

Hi @jimit-j-shah, DocumentReference.Get() uses Listen's global snapshot to ensure that when the SDK raises any snapshot, the data is consistent across all get doc(s) or snapshot listeners that are concurrently active in the SDK. This is something that we will not be able to change, however tou may be able to use transactions if you wish to read documents without creating a Listen stream.

@jimit-j-shah
Copy link
Author

the data is consistent across all get doc(s) or snapshot listeners that are concurrently active in the SDK.

This doesn't seem to be a requirement or intended behavior of the API. https://firebase.google.com/docs/reference/cpp/class/firebase/firestore/document-reference#get

@MarkDuckworth
Copy link

I linked to some internal documentation of this behavior on b/403273151.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants