-
Notifications
You must be signed in to change notification settings - Fork 147
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: retry BatchGetDocuments RPCs that fail with errors (#1544)
- Loading branch information
1 parent
7473343
commit b39dd3c
Showing
4 changed files
with
245 additions
and
187 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,182 @@ | ||
| /*! | ||
| * Copyright 2021 Google LLC. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import {DocumentSnapshot, DocumentSnapshotBuilder} from './document'; | ||
| import {DocumentReference} from './reference'; | ||
| import {FieldPath} from './path'; | ||
| import {isPermanentRpcError} from './util'; | ||
| import {google} from '../protos/firestore_v1_proto_api'; | ||
| import {logger} from './logger'; | ||
| import {Firestore} from './index'; | ||
| import {DocumentData} from '@google-cloud/firestore'; | ||
| import api = google.firestore.v1; | ||
|
|
||
| /** | ||
| * A wrapper around BatchGetDocumentsRequest that retries request upon stream | ||
| * failure and returns ordered results. | ||
| * | ||
| * @private | ||
| */ | ||
| export class DocumentReader<T> { | ||
| /** An optional field mask to apply to this read. */ | ||
| fieldMask?: FieldPath[]; | ||
| /** An optional transaction ID to use for this read. */ | ||
| transactionId?: Uint8Array; | ||
|
|
||
| private outstandingDocuments = new Set<string>(); | ||
| private retrievedDocuments = new Map<string, DocumentSnapshot>(); | ||
|
|
||
| /** | ||
| * Creates a new DocumentReader that fetches the provided documents (via | ||
| * `get()`). | ||
| * | ||
| * @param firestore The Firestore instance to use. | ||
| * @param allDocuments The documents to get. | ||
| */ | ||
| constructor( | ||
| private firestore: Firestore, | ||
| private allDocuments: Array<DocumentReference<T>> | ||
| ) { | ||
| for (const docRef of this.allDocuments) { | ||
| this.outstandingDocuments.add(docRef.formattedName); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Invokes the BatchGetDocuments RPC and returns the results. | ||
| * | ||
| * @param requestTag A unique client-assigned identifier for this request. | ||
| */ | ||
| async get(requestTag: string): Promise<Array<DocumentSnapshot<T>>> { | ||
| await this.fetchDocuments(requestTag); | ||
|
|
||
| // BatchGetDocuments doesn't preserve document order. We use the request | ||
| // order to sort the resulting documents. | ||
| const orderedDocuments: Array<DocumentSnapshot<T>> = []; | ||
|
|
||
| for (const docRef of this.allDocuments) { | ||
| const document = this.retrievedDocuments.get(docRef.formattedName); | ||
| if (document !== undefined) { | ||
| // Recreate the DocumentSnapshot with the DocumentReference | ||
| // containing the original converter. | ||
| const finalDoc = new DocumentSnapshotBuilder( | ||
| docRef as DocumentReference<T> | ||
| ); | ||
| finalDoc.fieldsProto = document._fieldsProto; | ||
| finalDoc.readTime = document.readTime; | ||
| finalDoc.createTime = document.createTime; | ||
| finalDoc.updateTime = document.updateTime; | ||
| orderedDocuments.push(finalDoc.build()); | ||
| } else { | ||
| throw new Error(`Did not receive document for "${docRef.path}".`); | ||
| } | ||
| } | ||
|
|
||
| return orderedDocuments; | ||
| } | ||
|
|
||
| private async fetchDocuments(requestTag: string): Promise<void> { | ||
| if (!this.outstandingDocuments.size) { | ||
| return; | ||
| } | ||
|
|
||
| const request: api.IBatchGetDocumentsRequest = { | ||
| database: this.firestore.formattedName, | ||
| transaction: this.transactionId, | ||
| documents: Array.from(this.outstandingDocuments), | ||
| }; | ||
|
|
||
| if (this.fieldMask) { | ||
| const fieldPaths = this.fieldMask.map( | ||
| fieldPath => fieldPath.formattedName | ||
| ); | ||
| request.mask = {fieldPaths}; | ||
| } | ||
|
|
||
| let resultCount = 0; | ||
|
|
||
| try { | ||
| const stream = await this.firestore.requestStream( | ||
| 'batchGetDocuments', | ||
| request, | ||
| requestTag | ||
| ); | ||
| stream.resume(); | ||
|
|
||
| for await (const response of stream) { | ||
| let snapshot: DocumentSnapshot<DocumentData>; | ||
|
|
||
| if (response.found) { | ||
| logger( | ||
| 'DocumentReader.fetchDocuments', | ||
| requestTag, | ||
| 'Received document: %s', | ||
| response.found.name! | ||
| ); | ||
| snapshot = this.firestore.snapshot_( | ||
| response.found, | ||
| response.readTime! | ||
| ); | ||
| } else { | ||
| logger( | ||
| 'DocumentReader.fetchDocuments', | ||
| requestTag, | ||
| 'Document missing: %s', | ||
| response.missing! | ||
| ); | ||
| snapshot = this.firestore.snapshot_( | ||
| response.missing!, | ||
| response.readTime! | ||
| ); | ||
| } | ||
|
|
||
| const path = snapshot.ref.formattedName; | ||
| this.outstandingDocuments.delete(path); | ||
| this.retrievedDocuments.set(path, snapshot); | ||
| ++resultCount; | ||
| } | ||
| } catch (error) { | ||
| const shouldRetry = | ||
| // Transactional reads are retried via the transaction runner. | ||
| !this.transactionId && | ||
| // Only retry if we made progress. | ||
| resultCount > 0 && | ||
| // Don't retry permanent errors. | ||
| error.code !== undefined && | ||
| !isPermanentRpcError(error, 'batchGetDocuments'); | ||
|
|
||
| logger( | ||
| 'DocumentReader.fetchDocuments', | ||
| requestTag, | ||
| 'BatchGetDocuments failed with error: %s. Retrying: %s', | ||
| error, | ||
| shouldRetry | ||
| ); | ||
| if (shouldRetry) { | ||
| return this.fetchDocuments(requestTag); | ||
| } else { | ||
| throw error; | ||
| } | ||
| } finally { | ||
| logger( | ||
| 'DocumentReader.fetchDocuments', | ||
| requestTag, | ||
| 'Received %d results', | ||
| resultCount | ||
| ); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.