fix: retry writes that fail with status code ABORTED (#854)

.nycrc

@@ -12,6 +12,7 @@
     "**/scripts",
     "**/protos",
     "**/test",
+    "**/*.d.ts",
     ".jsdoc.js",
     "**/.jsdoc.js",
     "karma.conf.js",

README.md

@@ -15,7 +15,9 @@ This is the Node.js Server SDK for [Google Cloud Firestore](https://firebase.goo
 
 This Cloud Firestore Server SDK uses Google’s Cloud Identity and Access Management for authentication and should only be used in trusted environments. Your Cloud Identity credentials allow you bypass all access restrictions and provide read and write access to all data in your Cloud Firestore project.
 
-Applications that use Google's Server SDKs should not be used in end-user environments, such as on phones or on publicly hosted websites. If you are developing a Web or Node.js application that accesses Cloud Firestore on behalf of end users, use the Firebase Client SDK.
+The Cloud Firestore Server SDKs are designed to manage the full set of data in your Cloud Firestore project and work best with reliable network connectivity. Data operations performed via these SDKs directly access the Cloud Firestore backend and all document reads and writes are optimized for high throughput.
+
+Applications that use Google's Server SDKs should not be used in end-user environments, such as on phones or on publicly hosted websites. If you are developing a Web or Node.js application that accesses Cloud Firestore on behalf of end users, use the firebase Client SDK.
 
 **Note:** This Cloud Firestore Server SDK does not support Firestore databases created in [Datastore mode](https://cloud.google.com/datastore/docs/firestore-or-datastore#in_datastore_mode). To access these databases, use the [Datastore SDK](https://www.npmjs.com/package/@google-cloud/datastore).
 

dev/protos/protos.json

@@ -1139,13 +1139,6 @@
                         }
                       }
                     },
-                    "Direction": {
-                      "values": {
-                        "DIRECTION_UNSPECIFIED": 0,
-                        "ASCENDING": 1,
-                        "DESCENDING": 2
-                      }
-                    },
                     "FieldReference": {
                       "fields": {
                         "fieldPath": {
@@ -1162,6 +1155,13 @@
                           "id": 2
                         }
                       }
+                    },
+                    "Direction": {
+                      "values": {
+                        "DIRECTION_UNSPECIFIED": 0,
+                        "ASCENDING": 1,
+                        "DESCENDING": 2
+                      }
                     }
                   }
                 },

dev/src/v1/firestore_admin_client.ts

@@ -278,6 +278,9 @@ export class FirestoreAdminClient {
     for (const methodName of firestoreAdminStubMethods) {
       const innerCallPromise = this.firestoreAdminStub.then(
         stub => (...args: Array<{}>) => {
+          if (this._terminated) {
+            return Promise.reject('The client has already been closed.');
+          }
           return stub[methodName].apply(stub, args);
         },
         (err: Error | null | undefined) => () => {
@@ -298,9 +301,6 @@ export class FirestoreAdminClient {
         callOptions?: CallOptions,
         callback?: APICallback
       ) => {
-        if (this._terminated) {
-          return Promise.reject('The client has already been closed.');
-        }
         return apiCall(argument, callOptions, callback);
       };
     }
@@ -1270,7 +1270,7 @@ export class FirestoreAdminClient {
    * @param {string} collection
    * @returns {string} Resource name string.
    */
-  collectiongroupPath(project: string, database: string, collection: string) {
+  collectionGroupPath(project: string, database: string, collection: string) {
     return this._pathTemplates.collectiongroupPathTemplate.render({
       project,
       database,

dev/src/v1/firestore_client.ts

@@ -37,20 +37,12 @@ const version = require('../../../package.json').version;
 /**
  *  The Cloud Firestore service.
  *
- *  This service exposes several types of comparable timestamps:
- *
- *  *    `create_time` - The time at which a document was created. Changes only
- *       when a document is deleted, then re-created. Increases in a strict
- *        monotonic fashion.
- *  *    `update_time` - The time at which a document was last updated. Changes
- *       every time a document is modified. Does not change when a write results
- *       in no modifications. Increases in a strict monotonic fashion.
- *  *    `read_time` - The time at which a particular state was observed. Used
- *       to denote a consistent snapshot of the database or the time at which a
- *       Document was observed to not exist.
- *  *    `commit_time` - The time at which the writes in a transaction were
- *       committed. Any read with an equal or greater `read_time` is guaranteed
- *       to see the effects of the transaction.
+ *  Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL
+ *  document database that simplifies storing, syncing, and querying data for
+ *  your mobile, web, and IoT apps at global scale. Its client libraries provide
+ *  live synchronization and offline support, while its security features and
+ *  integrations with Firebase and Google Cloud Platform (GCP) accelerate
+ *  building truly serverless apps.
  * @class
  * @memberof v1
  */
@@ -225,6 +217,9 @@ export class FirestoreClient {
     for (const methodName of firestoreStubMethods) {
       const innerCallPromise = this.firestoreStub.then(
         stub => (...args: Array<{}>) => {
+          if (this._terminated) {
+            return Promise.reject('The client has already been closed.');
+          }
           return stub[methodName].apply(stub, args);
         },
         (err: Error | null | undefined) => () => {
@@ -245,9 +240,6 @@ export class FirestoreClient {
         callOptions?: CallOptions,
         callback?: APICallback
       ) => {
-        if (this._terminated) {
-          return Promise.reject('The client has already been closed.');
-        }
         return apiCall(argument, callOptions, callback);
       };
     }

dev/src/v1/firestore_client_config.json

@@ -7,8 +7,9 @@
           "DEADLINE_EXCEEDED",
           "UNAVAILABLE"
         ],
-        "deadline_exceeded_internal_unavailable": [
+        "deadline_exceeded_aborted_internal_unavailable": [
           "DEADLINE_EXCEEDED",
+          "ABORTED",
           "INTERNAL",
           "UNAVAILABLE"
         ]
@@ -27,12 +28,12 @@
       "methods": {
         "GetDocument": {
           "timeout_millis": 60000,
-          "retry_codes_name": "deadline_exceeded_internal_unavailable",
+          "retry_codes_name": "deadline_exceeded_aborted_internal_unavailable",
           "retry_params_name": "default"
         },
         "ListDocuments": {
           "timeout_millis": 60000,
-          "retry_codes_name": "deadline_exceeded_internal_unavailable",
+          "retry_codes_name": "deadline_exceeded_aborted_internal_unavailable",
           "retry_params_name": "default"
         },
         "CreateDocument": {
@@ -47,17 +48,17 @@
         },
         "DeleteDocument": {
           "timeout_millis": 60000,
-          "retry_codes_name": "deadline_exceeded_internal_unavailable",
+          "retry_codes_name": "deadline_exceeded_aborted_internal_unavailable",
           "retry_params_name": "default"
         },
         "BatchGetDocuments": {
           "timeout_millis": 300000,
-          "retry_codes_name": "deadline_exceeded_internal_unavailable",
+          "retry_codes_name": "deadline_exceeded_aborted_internal_unavailable",
           "retry_params_name": "default"
         },
         "BeginTransaction": {
           "timeout_millis": 60000,
-          "retry_codes_name": "deadline_exceeded_internal_unavailable",
+          "retry_codes_name": "deadline_exceeded_aborted_internal_unavailable",
           "retry_params_name": "default"
         },
         "Commit": {
@@ -67,12 +68,12 @@
         },
         "Rollback": {
           "timeout_millis": 60000,
-          "retry_codes_name": "deadline_exceeded_internal_unavailable",
+          "retry_codes_name": "deadline_exceeded_aborted_internal_unavailable",
           "retry_params_name": "default"
         },
         "RunQuery": {
           "timeout_millis": 300000,
-          "retry_codes_name": "deadline_exceeded_internal_unavailable",
+          "retry_codes_name": "deadline_exceeded_aborted_internal_unavailable",
           "retry_params_name": "default"
         },
         "Write": {
@@ -82,12 +83,12 @@
         },
         "Listen": {
           "timeout_millis": 86400000,
-          "retry_codes_name": "deadline_exceeded_internal_unavailable",
+          "retry_codes_name": "deadline_exceeded_aborted_internal_unavailable",
           "retry_params_name": "default"
         },
         "ListCollectionIds": {
           "timeout_millis": 60000,
-          "retry_codes_name": "deadline_exceeded_internal_unavailable",
+          "retry_codes_name": "deadline_exceeded_aborted_internal_unavailable",
           "retry_params_name": "default"
         }
       }

dev/src/v1beta1/firestore_client.ts

@@ -225,6 +225,9 @@ export class FirestoreClient {
     for (const methodName of firestoreStubMethods) {
       const innerCallPromise = this.firestoreStub.then(
         stub => (...args: Array<{}>) => {
+          if (this._terminated) {
+            return Promise.reject('The client has already been closed.');
+          }
           return stub[methodName].apply(stub, args);
         },
         (err: Error | null | undefined) => () => {
@@ -245,9 +248,6 @@ export class FirestoreClient {
         callOptions?: CallOptions,
         callback?: APICallback
       ) => {
-        if (this._terminated) {
-          return Promise.reject('The client has already been closed.');
-        }
         return apiCall(argument, callOptions, callback);
       };
     }