minor(vest): staticSuite returns a promise (#1144)

packages/vest-utils/src/freezeAssign.ts

@@ -0,0 +1,5 @@
+import assign from 'assign';
+
+export function freezeAssign<T extends object>(...args: Partial<T>[]): T {
+  return Object.freeze(assign(...(args as [Partial<T>])));
+}

packages/vest-utils/src/vest-utils.ts

@@ -41,6 +41,7 @@ export * as tinyState from 'tinyState';
 export { StringObject } from 'StringObject';
 export { noop } from 'noop';
 export * as Predicates from 'Predicates';
+export { freezeAssign } from 'freezeAssign';
 
 export type {
   DropFirst,

packages/vest/src/exports/debounce.ts

@@ -1,8 +1,8 @@
-import { registerReconciler } from 'vest';
 import { CB, isPromise, Nullable } from 'vest-utils';
 import { Isolate, TIsolate, IsolateSelectors } from 'vestjs-runtime';
 
 import { TestFn, TestFnPayload } from 'TestTypes';
+import { registerReconciler } from 'vest';
 
 const isolateType = 'Debounce';
 

packages/vest/src/exports/parser.ts

@@ -1,15 +1,15 @@
-import { suiteSelectors } from 'vest';
 import { hasOwnProperty, invariant, isNullish, isPositive } from 'vest-utils';
 
 import { ErrorStrings } from 'ErrorStrings';
 import { SuiteSummary, TFieldName, TGroupName } from 'SuiteResultTypes';
+import { suiteSelectors } from 'vest';
 
 export function parse<F extends TFieldName, G extends TGroupName>(
-  summary: SuiteSummary<F, G>
+  summary: SuiteSummary<F, G>,
 ): ParsedVestObject<F> {
   invariant(
     summary && hasOwnProperty(summary, 'valid'),
-    ErrorStrings.PARSER_EXPECT_RESULT_OBJECT
+    ErrorStrings.PARSER_EXPECT_RESULT_OBJECT,
   );
 
   const sel = suiteSelectors(summary);

packages/vest/src/hooks/focused/__tests__/__snapshots__/focused.test.ts.snap

@@ -1,7 +1,7 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`Top Level Focus Top Level Skip When passing false Should run all fields 1`] = `
-{
+Promise {
   "done": [Function],
   "dump": [Function],
   "errorCount": 3,
@@ -83,7 +83,7 @@ exports[`Top Level Focus Top Level Skip When passing false Should run all fields
 `;
 
 exports[`Top Level Focus Top Level Skip When passing undefined Should run all fields 1`] = `
-{
+Promise {
   "done": [Function],
   "dump": [Function],
   "errorCount": 3,

packages/vest/src/suite/__tests__/staticSuite.test.ts

@@ -1,3 +1,5 @@
+import wait from 'wait';
+
 import { SuiteSerializer } from 'SuiteSerializer';
 import { VestIsolateType } from 'VestIsolateType';
 import * as vest from 'vest';
@@ -139,4 +141,34 @@ describe('runStatic', () => {
     expect(suite2.hasErrors('t3')).toBe(false);
     expect(suite2.hasErrors('t4')).toBe(false);
   });
+
+  describe('runStatic (promise)', () => {
+    it("Should resolve with the suite's result", async () => {
+      const suite = vest.create(() => {
+        vest.test('t1', async () => {
+          await wait(100);
+          throw new Error();
+        });
+      });
+
+      const res = suite.runStatic();
+      expect(res.errorCount).toBe(0);
+      const result = await res;
+      expect(result.errorCount).toBe(1);
+    });
+
+    it("Should have a dump method on the resolved suite's result", async () => {
+      const suite = vest.create(() => {
+        vest.test('t1', async () => {
+          await wait(100);
+          throw new Error();
+        });
+      });
+
+      const res = suite.runStatic();
+      const result = await res;
+      expect(result).toHaveProperty('dump');
+      expect(result.dump()).toHaveProperty('$type', VestIsolateType.Suite);
+    });
+  });
 });

packages/vest/src/suite/createSuite.ts

@@ -9,6 +9,7 @@ import { useCreateVestState, useLoadSuite } from 'Runtime';
 import { SuiteContext } from 'SuiteContext';
 import {
   SuiteName,
+  SuiteResult,
   SuiteRunResult,
   TFieldName,
   TGroupName,
@@ -154,14 +155,18 @@ function staticSuite<
 
       const result = suite(...args);
 
-      return Object.freeze(
-        assign(
-          {
-            dump: suite.dump,
-          },
-          result,
-        ),
-      ) as StaticSuiteRunResult<F, G>;
+      return assign(
+        new Promise<SuiteWithDump<F, G>>(resolve => {
+          result.done(res => {
+            resolve(withDump(res) as SuiteWithDump<F, G>);
+          });
+        }),
+        withDump(result),
+      );
+
+      function withDump(o: any) {
+        return assign({ dump: suite.dump }, o);
+      }
     },
     {
       ...getTypedMethods<F, G>(),
@@ -178,8 +183,12 @@ export type StaticSuite<
 export type StaticSuiteRunResult<
   F extends TFieldName = string,
   G extends TGroupName = string,
-> = SuiteRunResult<F, G> & {
-  dump: CB<TIsolateSuite>;
-} & TTypedMethods<F, G>;
+> = Promise<SuiteWithDump<F, G>> &
+  WithDump<SuiteRunResult<F, G> & TTypedMethods<F, G>>;
+
+type WithDump<T> = T & { dump: CB<TIsolateSuite> };
+type SuiteWithDump<F extends TFieldName, G extends TGroupName> = WithDump<
+  SuiteResult<F, G>
+>;
 
 export { createSuite, staticSuite };

packages/vest/src/suiteResult/suiteResult.ts

@@ -1,4 +1,4 @@
-import { assign } from 'vest-utils';
+import { freezeAssign } from 'vest-utils';
 
 import { useSuiteName, useSuiteResultCache } from 'Runtime';
 import { SuiteResult, TFieldName, TGroupName } from 'SuiteResultTypes';
@@ -7,18 +7,20 @@ import { useProduceSuiteSummary } from 'useProduceSuiteSummary';
 
 export function useCreateSuiteResult<
   F extends TFieldName,
-  G extends TGroupName
+  G extends TGroupName,
 >(): SuiteResult<F, G> {
   return useSuiteResultCache<F, G>(() => {
     // @vx-allow use-use
     const summary = useProduceSuiteSummary<F, G>();
 
     // @vx-allow use-use
     const suiteName = useSuiteName();
-    return Object.freeze(
-      assign(summary, suiteSelectors<F, G>(summary), {
+    return freezeAssign<SuiteResult<F, G>>(
+      summary,
+      suiteSelectors<F, G>(summary),
+      {
         suiteName,
-      })
+      },
     ) as SuiteResult<F, G>;
   });
 }

packages/vest/src/suiteResult/suiteRunResult.ts

@@ -1,4 +1,4 @@
-import { assign } from 'vest-utils';
+import { freezeAssign } from 'vest-utils';
 import { VestRuntime } from 'vestjs-runtime';
 
 import {
@@ -14,15 +14,13 @@ import { useCreateSuiteResult } from 'suiteResult';
 
 export function useSuiteRunResult<
   F extends TFieldName,
-  G extends TGroupName
+  G extends TGroupName,
 >(): SuiteRunResult<F, G> {
-  return Object.freeze(
-    assign(
-      {
-        done: VestRuntime.persist(done),
-      },
-      useCreateSuiteResult<F, G>()
-    )
+  return freezeAssign<SuiteRunResult<F, G>>(
+    {
+      done: VestRuntime.persist(done) as Done<F, G>,
+    },
+    useCreateSuiteResult<F, G>(),
   );
 }
 
@@ -36,7 +34,7 @@ function done<F extends TFieldName, G extends TGroupName>(
 ): SuiteRunResult<F, G> {
   const [callback, fieldName] = args.reverse() as [
     (res: SuiteResult<F, G>) => void,
-    F
+    F,
   ];
   const output = useSuiteRunResult<F, G>();
   if (shouldSkipDoneRegistration<F, G>(callback, fieldName, output)) {