firebase / firebase/firebase-cpp-sdk

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

未关闭
#1,700 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
api: firestore new type: question
主要语言
C++
星标
326
派生
137
平均合并
3 天 9 小时
30 天内合并 PR
5

描述

### [REQUIRED] Please fill in the following fields:

* Pre-built SDK from the [website](https://firebase.google.com/download/cpp) or open-source from this repo: _____
* Firebase C++ SDK version: [unity-v11.8.0](https://github.com/firebase/firebase-cpp-sdk/releases/tag/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](https://github.com/firebase/quickstart-cpp) ?
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:

https://github.com/firebase/firebase-cpp-sdk/blob/5fead53b4e57ed355c40dd313634a91dd51c3671/firestore/src/main/document_reference_main.cc#L59

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

贡献指南

打开贡献指南

调研方向

从 firestore/src/main/document_reference_main.cc 中的 DocumentReferenceInternal::Get 开始,跟踪所引用的 Firestore API 实现。确认如何选择 GetDocument 和 Listen 路径,然后验证 Get() 使用 unary 请求,并且仍会返回预期的第一个 DocumentSnapshot,而不会打开 Listen 流。

由索引模型根据 Issue 内容生成。

评估

技术栈
cpp, grpc
领域
backend-api-design, databases
Issue 类型
缺陷
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
描述清楚
新手友好度
48/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。