Making keepInQueue optional

Author: schmidt-sebastian

packages/firestore/test/unit/specs/spec_builder.ts

@@ -46,7 +46,9 @@ import {
   SpecQueryFilter,
   SpecQueryOrderBy,
   SpecStep,
-  SpecWatchFilter
+  SpecWatchFilter,
+  SpecWriteAck,
+  SpecWriteFailure
 } from './spec_test_runner';
 import { TimerId } from '../../../src/util/async_queue';
 
@@ -474,9 +476,11 @@ export class SpecBuilder {
     this.nextStep();
     options = options || {};
 
-    this.currentStep = {
-      writeAck: { version, keepInQueue: !!options.keepInQueue }
-    };
+    const writeAck: SpecWriteAck = { version };
+    if (options.keepInQueue) {
+      writeAck.keepInQueue = true;
+    }
+    this.currentStep = { writeAck };
 
     if (options.expectUserCallback !== false) {
       return this.expectUserCallbacks({ acknowledged: [doc] });
@@ -506,7 +510,11 @@ export class SpecBuilder {
         ? options.keepInQueue
         : !isPermanentFailure;
 
-    this.currentStep = { failWrite: { error, keepInQueue } };
+    const failWrite: SpecWriteFailure = { error };
+    if (keepInQueue) {
+      failWrite.keepInQueue = true;
+    }
+    this.currentStep = { failWrite };
 
     if (options.expectUserCallback !== false) {
       return this.expectUserCallbacks({ rejected: [doc] });

packages/firestore/test/unit/specs/spec_test_runner.ts

@@ -1393,9 +1393,11 @@ export type SpecWriteAck = {
    * Whether we should keep the write in our internal queue. This should only
    * be set to 'true' if the client ignores the write (e.g. a secondary client
    * which ignores write acknowledgments).
+   *
+   * Defaults to false.
    */
   // PORTING NOTE: Multi-Tab only.
-  keepInQueue: boolean;
+  keepInQueue?: boolean;
 };
 
 export type SpecWriteFailure = {
@@ -1405,8 +1407,10 @@ export type SpecWriteFailure = {
    * Whether we should keep the write in our internal queue. This should be set
    * to 'true' for transient errors or if the client ignores the failure
    * (e.g. a secondary client which ignores write rejections).
+   *
+   * Defaults to false.
    */
-  keepInQueue: boolean;
+  keepInQueue?: boolean;
 };
 
 export interface SpecWatchEntity {