update to override backoff

Author: Brian Chen

packages/firestore/src/api/database.ts

@@ -307,6 +307,9 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
   // are already set to synchronize on the async queue.
   private _firestoreClient: FirestoreClient | undefined;
 
+  // For tests only: Whether to skip all backoffs scheduled by transactions.
+  private skipTransactionBackoffs = false;
+
   // Public for use in tests.
   // TODO(mikelehen): Use modularized initialization instead.
   readonly _queue = new AsyncQueue();
@@ -613,6 +616,14 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
     );
   }
 
+  /**
+   * For tests: Skip all transaction backoffs to make integration tests
+   * complete faster.
+   */
+  removeTransactionBackoffs(): void {
+    this.skipTransactionBackoffs = true;
+  }
+
   runTransaction<T>(
     updateFunction: (transaction: firestore.Transaction) => Promise<T>
   ): Promise<T> {
@@ -621,7 +632,8 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
     return this.ensureClientConfigured().transaction(
       (transaction: InternalTransaction) => {
         return updateFunction(new Transaction(this, transaction));
-      }
+      },
+      this.skipTransactionBackoffs
     );
   }
 

packages/firestore/src/core/firestore_client.ts

@@ -607,17 +607,29 @@ export class FirestoreClient {
   }
 
   transaction<T>(
-    updateFunction: (transaction: Transaction) => Promise<T>
+    updateFunction: (transaction: Transaction) => Promise<T>,
+    skipTransactionBackoffs: boolean = false
   ): Promise<T> {
     this.verifyNotShutdown();
     // We have to wait for the async queue to be sure syncEngine is initialized.
     return this.asyncQueue
       .enqueue(async () => {})
       .then(() => {
-        const backoff = new ExponentialBackoff(
-          this.asyncQueue,
-          TimerId.RetryTransaction
-        );
+        let backoff;
+        if (skipTransactionBackoffs) {
+          backoff = new ExponentialBackoff(
+            this.asyncQueue,
+            TimerId.RetryTransaction,
+            1,
+            2,
+            10
+          );
+        } else {
+          backoff = new ExponentialBackoff(
+            this.asyncQueue,
+            TimerId.RetryTransaction
+          );
+        }
         return this.syncEngine.runTransaction(updateFunction, backoff);
       });
   }

packages/firestore/src/util/async_queue.ts

@@ -215,7 +215,6 @@ export class AsyncQueue {
     return this._isShuttingDown;
   }
 
-
   /**
    * Adds a new operation to the queue without waiting for it to complete (i.e.
    * we ignore the Promise result).
@@ -331,7 +330,7 @@ export class AsyncQueue {
       timerId,
       delayMs,
       op,
-    removedOp =>
+      removedOp =>
         this.removeDelayedOperation(removedOp as DelayedOperation<unknown>)
     );
     this.delayedOperations.push(delayedOp as DelayedOperation<unknown>);

packages/firestore/test/integration/api/transactions.test.ts

@@ -20,8 +20,7 @@ import { expect } from 'chai';
 import { Deferred } from '../../util/promise';
 import firebase from '../util/firebase_export';
 import * as integrationHelpers from '../util/helpers';
-import { asyncQueue } from '../util/internal_helpers';
-import { TimerId } from '../../../src/util/async_queue';
+import { removeTransactionBackoffs } from '../util/internal_helpers';
 
 const apiDescribe = integrationHelpers.apiDescribe;
 apiDescribe('Database transactions', (persistence: boolean) => {
@@ -461,7 +460,7 @@ apiDescribe('Database transactions', (persistence: boolean) => {
     let started = 0;
 
     return integrationHelpers.withTestDb(persistence, db => {
-      asyncQueue(db).skipDelaysForTimerId(TimerId.RetryTransaction);
+      removeTransactionBackoffs(db);
       const doc = db.collection('counters').doc();
       return doc
         .set({
@@ -518,7 +517,7 @@ apiDescribe('Database transactions', (persistence: boolean) => {
     let counter = 0;
 
     return integrationHelpers.withTestDb(persistence, db => {
-      asyncQueue(db).skipDelaysForTimerId(TimerId.RetryTransaction);
+      removeTransactionBackoffs(db);
       const doc = db.collection('counters').doc();
       return doc
         .set({
@@ -657,7 +656,7 @@ apiDescribe('Database transactions', (persistence: boolean) => {
 
   it('handle reading a doc twice with different versions', () => {
     return integrationHelpers.withTestDb(persistence, db => {
-      asyncQueue(db).skipDelaysForTimerId(TimerId.RetryTransaction);
+      removeTransactionBackoffs(db);
       const doc = db.collection('counters').doc();
       let counter = 0;
       return doc

packages/firestore/test/integration/util/internal_helpers.ts

@@ -34,6 +34,12 @@ export function asyncQueue(db: firestore.FirebaseFirestore): AsyncQueue {
   return (db as Firestore)._queue;
 }
 
+export function removeTransactionBackoffs(
+  db: firestore.FirebaseFirestore
+): void {
+  (db as Firestore).removeTransactionBackoffs();
+}
+
 export function getDefaultDatabaseInfo(): DatabaseInfo {
   return new DatabaseInfo(
     new DatabaseId(DEFAULT_PROJECT_ID),