move the TargetPurpose default value to the actual validation step

Author: milaGGL

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

@@ -74,7 +74,7 @@ export interface LimboMap {
 
 export interface ActiveTargetSpec {
   queries: SpecQuery[];
-  targetPurpose: TargetPurpose;
+  targetPurpose?: TargetPurpose;
   resumeToken?: string;
   readTime?: TestSnapshotVersion;
 }
@@ -281,12 +281,7 @@ export class SpecBuilder {
       }
 
       this.queryMapping.set(target, targetId);
-      this.addQueryToActiveTargets(
-        targetId,
-        query,
-        TargetPurpose.Listen,
-        resume
-      );
+      this.addQueryToActiveTargets(targetId, query, resume);
       this.currentStep = {
         userListen: { targetId, query: SpecBuilder.queryToSpec(query) },
         expectedState: { activeTargets: { ...this.activeTargets } }
@@ -306,7 +301,7 @@ export class SpecBuilder {
       throw new Error("Can't restore an unknown query: " + query);
     }
 
-    this.addQueryToActiveTargets(targetId!, query, TargetPurpose.Listen, {
+    this.addQueryToActiveTargets(targetId!, query, {
       resumeToken
     });
 
@@ -542,24 +537,17 @@ export class SpecBuilder {
     this.assertStep('Active target expectation requires previous step');
     const currentStep = this.currentStep!;
     this.clientState.activeTargets = {};
-    targets.forEach(
-      ({
+    targets.forEach(({ query, targetPurpose, resumeToken, readTime }) => {
+      this.addQueryToActiveTargets(
+        this.getTargetId(query),
         query,
-        targetPurpose = TargetPurpose.Listen,
-        resumeToken,
-        readTime
-      }) => {
-        this.addQueryToActiveTargets(
-          this.getTargetId(query),
-          query,
-          targetPurpose,
-          {
-            resumeToken,
-            readTime
-          }
-        );
-      }
-    );
+        {
+          resumeToken,
+          readTime
+        },
+        targetPurpose
+      );
+    });
     currentStep.expectedState = currentStep.expectedState || {};
     currentStep.expectedState.activeTargets = { ...this.activeTargets };
     return this;
@@ -589,8 +577,8 @@ export class SpecBuilder {
       this.addQueryToActiveTargets(
         this.limboMapping[path],
         newQueryForPath(key.path),
-        TargetPurpose.LimboResolution,
-        { resumeToken: '' }
+        { resumeToken: '' },
+        TargetPurpose.LimboResolution
       );
     });
 
@@ -932,7 +920,7 @@ export class SpecBuilder {
     const targetId = this.queryIdGenerator.cachedId(target);
     this.queryMapping.set(target, targetId);
 
-    this.addQueryToActiveTargets(targetId, query, TargetPurpose.Listen, resume);
+    this.addQueryToActiveTargets(targetId, query, resume);
 
     const currentStep = this.currentStep!;
     currentStep.expectedState = currentStep.expectedState || {};
@@ -1100,8 +1088,8 @@ export class SpecBuilder {
   private addQueryToActiveTargets(
     targetId: number,
     query: Query,
-    targetPurpose: TargetPurpose,
-    resume?: ResumeSpec
+    resume: ResumeSpec = {},
+    targetPurpose?: TargetPurpose
   ): void {
     if (this.activeTargets[targetId]) {
       const activeQueries = this.activeTargets[targetId].queries;

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

@@ -83,7 +83,7 @@ import {
   SharedClientState
 } from '../../../src/local/shared_client_state';
 import { SimpleDb } from '../../../src/local/simple_db';
-import { TargetData } from '../../../src/local/target_data';
+import { TargetData, TargetPurpose } from '../../../src/local/target_data';
 import { DocumentKey } from '../../../src/model/document_key';
 import { FieldIndex } from '../../../src/model/field_index';
 import { Mutation } from '../../../src/model/mutation';
@@ -1102,7 +1102,7 @@ abstract class TestRunner {
       let targetData = new TargetData(
         queryToTarget(parseQuery(expected.queries[0])),
         targetId,
-        expected.targetPurpose,
+        expected.targetPurpose || TargetPurpose.Listen,
         ARBITRARY_SEQUENCE_NUMBER
       );
       if (expected.resumeToken && expected.resumeToken !== '') {