Move isShutdown to state expectations (#2102)

Author: schmidt-sebastian

packages/firestore/test/unit/local/persistence_test_helpers.ts

@@ -144,8 +144,8 @@ export async function testMemoryLruPersistence(
 }
 
 /** Clears the persistence in tests */
-export async function clearTestPersistence(): Promise<void> {
-  await IndexedDbPersistence.clearPersistence(TEST_PERSISTENCE_PREFIX);
+export function clearTestPersistence(): Promise<void> {
+  return IndexedDbPersistence.clearPersistence(TEST_PERSISTENCE_PREFIX);
 }
 
 class NoOpSharedClientStateSyncer implements SharedClientStateSyncer {

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

@@ -395,10 +395,10 @@ export class SpecBuilder {
   }
 
   expectIsShutdown(): this {
-    this.nextStep();
-    this.currentStep = {
-      expectIsShutdown: true
-    };
+    this.assertStep('Active target expectation requires previous step');
+    const currentStep = this.currentStep!;
+    currentStep.stateExpect = currentStep.stateExpect || {};
+    currentStep.stateExpect.isShutdown = true;
     return this;
   }
 

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

@@ -569,8 +569,6 @@ abstract class TestRunner {
       return this.doRestart();
     } else if ('shutdown' in step) {
       return this.doShutdown();
-    } else if ('expectIsShutdown' in step) {
-      return this.doExpectIsShutdown();
     } else if ('applyClientState' in step) {
       // PORTING NOTE: Only used by web multi-tab tests.
       return this.doApplyClientState(step.applyClientState!);
@@ -885,11 +883,6 @@ abstract class TestRunner {
     this.started = false;
   }
 
-  /** Asserts that the client is shutdown by  */
-  private async doExpectIsShutdown(): Promise<void> {
-    expect(this.started).to.equal(false);
-  }
-
   private async doClearPersistence(): Promise<void> {
     await clearTestPersistence();
   }
@@ -985,6 +978,9 @@ abstract class TestRunner {
       if ('isPrimary' in expectation) {
         expect(this.isPrimaryClient).to.eq(expectation.isPrimary!, 'isPrimary');
       }
+      if ('isShutdown' in expectation) {
+        expect(this.started).to.equal(!expectation.isShutdown);
+      }
     }
 
     if (expectation && expectation.userCallbacks) {
@@ -1396,9 +1392,6 @@ export interface SpecStep {
   /** Shut down the client and close it network connection. */
   shutdown?: true;
 
-  /** Assert that the firestore client is shutdown. */
-  expectIsShutdown?: true;
-
   /**
    * Optional list of expected events.
    * If not provided, the test will fail if the step causes events to be raised.
@@ -1577,6 +1570,8 @@ export interface StateExpectation {
    * Whether the instance holds the primary lease. Used in multi-client tests.
    */
   isPrimary?: boolean;
+  /** Whether the client is shutdown. */
+  isShutdown?: boolean;
   /**
    * Current expected active targets. Verified in each step until overwritten.
    */