fix(vest): eager mode works inside of sub-isolates (#1134)

ealush · Jan 16, 2024 · b6400af · b6400af · vercel · Jan 16, 2024
1 parent 97662a7
commit b6400af
Show file tree

Hide file tree

Showing 14 changed files with 89 additions and 58 deletions.
diff --git a/packages/n4s/src/plugins/schema/__tests__/shape&loose.test.ts b/packages/n4s/src/plugins/schema/__tests__/shape&loose.test.ts
@@ -14,7 +14,7 @@ describe.each(['loose', 'shape'])('enforce.%s', (methodName: string) => {
         enforce[methodName]({
           username: enforce.isString(),
           age: enforce.isNumber().gt(18),
-        }).run({ username: 'ealush', age: 31 })
+        }).run({ username: 'ealush', age: 31 }),
       ).toEqual(ruleReturn.passing());
     });
 
@@ -23,7 +23,7 @@ describe.each(['loose', 'shape'])('enforce.%s', (methodName: string) => {
         enforce[methodName]({
           username: enforce.isString(),
           age: enforce.isNumber().gt(18),
-        }).run({ username: null, age: 0 })
+        }).run({ username: null, age: 0 }),
       ).toEqual(ruleReturn.failing());
     });
 
@@ -48,7 +48,7 @@ describe.each(['loose', 'shape'])('enforce.%s', (methodName: string) => {
               state: 'NY',
               zip: 12345,
             },
-          })
+          }),
         ).toEqual(ruleReturn.passing());
       });
       it('Should return a failing return when tests are invalid', () => {
@@ -69,7 +69,7 @@ describe.each(['loose', 'shape'])('enforce.%s', (methodName: string) => {
               street: '123 Main St',
               city: null,
             },
-          })
+          }),
         ).toEqual(ruleReturn.failing());
       });
     });

diff --git a/packages/vest/src/core/StateMachines/CommonStateMachine.ts b/packages/vest/src/core/StateMachines/CommonStateMachine.ts
@@ -3,11 +3,12 @@ import { TIsolate } from 'vestjs-runtime';
 
 export const CommonStates = {
   PENDING: 'PENDING',
+  INITIAL: 'INITIAL',
 };
 
-export const State = {
+const State = {
   [CommonStates.PENDING]: CommonStates.PENDING,
-  INITIAL: 'INITIAL',
+  [CommonStates.INITIAL]: CommonStates.INITIAL,
   DONE: 'DONE',
 };
 

diff --git a/packages/vest/src/core/VestBus/VestBus.ts b/packages/vest/src/core/VestBus/VestBus.ts
@@ -1,4 +1,3 @@
-import { SuiteWalker } from 'SuiteWalker';
 import { CB, ValueOf } from 'vest-utils';
 import { Bus, RuntimeEvents, TIsolate } from 'vestjs-runtime';
 
@@ -11,6 +10,7 @@ import {
   useResetSuite,
 } from 'Runtime';
 import { TFieldName } from 'SuiteResultTypes';
+import { SuiteWalker } from 'SuiteWalker';
 import { TestWalker } from 'TestWalker';
 import { VestTest } from 'VestTest';
 import { useOmitOptionalFields } from 'omitOptionalFields';

diff --git a/packages/vest/src/core/__tests__/runtime.test.ts b/packages/vest/src/core/__tests__/runtime.test.ts
@@ -65,6 +65,7 @@ describe('useLoadSuite', () => {
 
 function genDump() {
   const suite = vest.create(() => {
+    vest.mode(vest.Modes.ALL);
     vest.skip('t5');
 
     vest.test('t1', () => false);

diff --git a/packages/vest/src/core/isolate/VestIsolate.ts b/packages/vest/src/core/isolate/VestIsolate.ts
@@ -1,4 +1,4 @@
-import { nonnullish, TStateMachineApi } from 'vest-utils';
+import { TStateMachineApi } from 'vest-utils';
 import { TIsolate } from 'vestjs-runtime';
 
 import { CommonStateMachine, CommonStates } from 'CommonStateMachine';
@@ -7,14 +7,14 @@ export class VestIsolate {
   static stateMachine: TStateMachineApi = CommonStateMachine;
 
   static getStatus(isolate: TIsolate): string {
-    return nonnullish(isolate.status);
+    return isolate.status ?? CommonStates.INITIAL;
   }
 
   static setStatus(isolate: TIsolate, status: string, payload?: any): void {
     isolate.status = this.stateMachine.staticTransition(
       VestIsolate.getStatus(isolate),
       status,
-      payload
+      payload,
     );
   }
 

diff --git a/packages/vest/src/hooks/__tests__/mode.test.ts b/packages/vest/src/hooks/__tests__/mode.test.ts
@@ -178,6 +178,29 @@ describe('mode', () => {
         expect(suite.get().getErrors('field_1')).toEqual([]);
       });
     });
+
+    describe('When in a nested block', () => {
+      it('Should follow the same behavior as if it was not nested', () => {
+        const suite = create(() => {
+          group('group_1', () => {
+            dummyTest.failing('field_1', 'first-of-field_1');
+            dummyTest.failing('field_1', 'second-of-field_1');
+            dummyTest.failing('field_2', 'first-of-field_2');
+            dummyTest.failing('field_2', 'second-of-field_2');
+            dummyTest.failing('field_3', 'first-of-field_3');
+            dummyTest.failing('field_3', 'second-of-field_3');
+          });
+        });
+        expect(suite.get().testCount).toBe(0); // sanity
+        suite();
+
+        expect(suite.get().testCount).toBe(3);
+        expect(suite.get().errorCount).toBe(3);
+        expect(suite.get().getErrors('field_1')).toEqual(['first-of-field_1']);
+        expect(suite.get().getErrors('field_2')).toEqual(['first-of-field_2']);
+        expect(suite.get().getErrors('field_3')).toEqual(['first-of-field_3']);
+      });
+    });
   });
 
   describe('All', () => {

diff --git a/packages/vest/src/hooks/focused/useIsExcluded.ts b/packages/vest/src/hooks/focused/useIsExcluded.ts
@@ -10,7 +10,7 @@ import { useHasOnliedTests } from 'useHasOnliedTests';
 //Checks whether a certain test profile excluded by any of the exclusion groups.
 
 function useClosestMatchingFocus(
-  testObject: TIsolateTest
+  testObject: TIsolateTest,
 ): Nullable<TIsolateFocused> {
   return Walker.findClosest(testObject, (child: TIsolate) => {
     if (!FocusSelectors.isIsolateFocused(child)) return false;
@@ -21,7 +21,6 @@ function useClosestMatchingFocus(
   });
 }
 
-// eslint-disable-next-line complexity, max-statements
 export function useIsExcluded(testObject: TIsolateTest): boolean {
   const { fieldName } = VestTest.getData(testObject);
 

diff --git a/packages/vest/src/suiteResult/selectors/__tests__/hasFailuresByTestObject.test.ts b/packages/vest/src/suiteResult/selectors/__tests__/hasFailuresByTestObject.test.ts
@@ -1,8 +1,8 @@
 import { faker } from '@faker-js/faker';
-import { VestTest } from 'VestTest';
 
 import { TIsolateTest } from 'IsolateTest';
 import { Severity } from 'Severity';
+import { VestTest } from 'VestTest';
 import { hasFailuresByTestObject } from 'hasFailuresByTestObjects';
 import { mockIsolateTest } from 'vestMocks';
 
@@ -22,10 +22,10 @@ describe('hasFailuresByTestObject', () => {
     it('Should return false', () => {
       expect(hasFailuresByTestObject(testObject, Severity.ERRORS)).toBe(false);
       expect(hasFailuresByTestObject(testObject, Severity.WARNINGS)).toBe(
-        false
+        false,
       );
       expect(
-        hasFailuresByTestObject(testObject, Severity.ERRORS, fieldName)
+        hasFailuresByTestObject(testObject, Severity.ERRORS, fieldName),
       ).toBe(false);
     });
   });
@@ -38,23 +38,23 @@ describe('hasFailuresByTestObject', () => {
       describe('When non matching severity profile', () => {
         it('should return false', () => {
           expect(hasFailuresByTestObject(testObject, Severity.WARNINGS)).toBe(
-            false
+            false,
           );
           VestTest.warn(testObject);
           expect(hasFailuresByTestObject(testObject, Severity.ERRORS)).toBe(
-            false
+            false,
           );
         });
       });
 
       describe('When matching severity profile', () => {
         it('Should return true', () => {
           expect(hasFailuresByTestObject(testObject, Severity.ERRORS)).toBe(
-            true
+            true,
           );
           VestTest.warn(testObject);
           expect(hasFailuresByTestObject(testObject, Severity.WARNINGS)).toBe(
-            true
+            true,
           );
         });
       });
@@ -63,23 +63,27 @@ describe('hasFailuresByTestObject', () => {
       describe('When field name matches', () => {
         it('should return false', () => {
           expect(
-            hasFailuresByTestObject(testObject, Severity.ERRORS, 'non_matching')
+            hasFailuresByTestObject(
+              testObject,
+              Severity.ERRORS,
+              'non_matching',
+            ),
           ).toBe(false);
         });
       });
 
       describe('When field name matches', () => {
         it('Should continue with normal flow', () => {
           expect(hasFailuresByTestObject(testObject, Severity.WARNINGS)).toBe(
-            false
+            false,
           );
           VestTest.warn(testObject);
           expect(hasFailuresByTestObject(testObject, Severity.ERRORS)).toBe(
-            false
+            false,
           );
           VestTest.fail(testObject);
           expect(hasFailuresByTestObject(testObject, Severity.WARNINGS)).toBe(
-            true
+            true,
           );
         });
       });

diff --git a/packages/vest/src/suiteResult/selectors/__tests__/summaryFailures.test.ts b/packages/vest/src/suiteResult/selectors/__tests__/summaryFailures.test.ts
@@ -1,4 +1,5 @@
 import { TTestSuite } from 'testUtils/TVestMock';
+
 import * as vest from 'vest';
 
 describe('summaryFailures', () => {
@@ -68,6 +69,7 @@ describe('summaryFailures', () => {
 
     test('Should add the test group into the error object', () => {
       suite = vest.create(() => {
+        vest.mode(vest.Modes.ALL);
         vest.group('user', () => {
           vest.test('username', 'uxsername is required', () => false);
           vest.test('username', 'username is too short', () => false);

diff --git a/packages/vest/src/suiteResult/selectors/shouldAddValidProperty.ts b/packages/vest/src/suiteResult/selectors/shouldAddValidProperty.ts
@@ -1,4 +1,3 @@
-import { SuiteWalker } from 'SuiteWalker';
 import { useIsOptionalFieldApplied } from 'optional';
 import { Predicates } from 'vest-utils';
 import { VestRuntime } from 'vestjs-runtime';
@@ -8,6 +7,7 @@ import { TIsolateTest } from 'IsolateTest';
 import { OptionalFieldTypes } from 'OptionalTypes';
 import { Severity } from 'Severity';
 import { TFieldName, TGroupName } from 'SuiteResultTypes';
+import { SuiteWalker } from 'SuiteWalker';
 import { TestWalker } from 'TestWalker';
 import { VestTest } from 'VestTest';
 import {

diff --git a/packages/vest/src/suiteResult/selectors/useProduceSuiteSummary.ts b/packages/vest/src/suiteResult/selectors/useProduceSuiteSummary.ts
@@ -21,7 +21,7 @@ import {
 
 export function useProduceSuiteSummary<
   F extends TFieldName,
-  G extends TGroupName
+  G extends TGroupName,
 >(): SuiteSummary<F, G> {
   const summary: SuiteSummary<F, G> = new SuiteSummary();
 
@@ -31,12 +31,12 @@ export function useProduceSuiteSummary<
     summary.errors = appendFailures(
       Severity.ERRORS,
       summary.errors,
-      testObject
+      testObject,
     );
     summary.warnings = appendFailures(
       Severity.WARNINGS,
       summary.warnings,
-      testObject
+      testObject,
     );
   });
 
@@ -48,7 +48,7 @@ export function useProduceSuiteSummary<
 function appendFailures<F extends TFieldName, G extends TGroupName>(
   key: Severity,
   failures: SummaryFailure<F, G>[],
-  testObject: TIsolateTest<F, G>
+  testObject: TIsolateTest<F, G>,
 ): SummaryFailure<F, G>[] {
   if (VestTest.isOmitted(testObject)) {
     return failures;
@@ -67,7 +67,7 @@ function appendFailures<F extends TFieldName, G extends TGroupName>(
 
 function useAppendToTest<F extends TFieldName>(
   tests: Tests<F>,
-  testObject: TIsolateTest<F>
+  testObject: TIsolateTest<F>,
 ): Tests<F> {
   const fieldName = VestTest.getData<F>(testObject).fieldName;
 
@@ -90,7 +90,7 @@ function useAppendToTest<F extends TFieldName>(
  */
 function useAppendToGroup(
   groups: Groups<TGroupName, TFieldName>,
-  testObject: TIsolateTest
+  testObject: TIsolateTest,
 ): Groups<TGroupName, TFieldName> {
   const { groupName, fieldName } = VestTest.getData(testObject);
 
@@ -105,7 +105,7 @@ function useAppendToGroup(
   newGroups[groupName] = newGroups[groupName] || {};
   newGroups[groupName][fieldName] = appendTestObject(
     newGroups[groupName][fieldName],
-    testObject
+    testObject,
   );
 
   newGroups[groupName][fieldName].valid =
@@ -120,7 +120,7 @@ function useAppendToGroup(
  * Counts the failed tests and adds global counters
  */
 function countOverallStates<F extends TFieldName, G extends TGroupName>(
-  summary: SuiteSummary<F, G>
+  summary: SuiteSummary<F, G>,
 ): SuiteSummary<F, G> {
   for (const test in summary.tests) {
     summary.errorCount += summary.tests[test].errorCount;
@@ -137,14 +137,14 @@ function countOverallStates<F extends TFieldName, G extends TGroupName>(
 // eslint-disable-next-line max-statements, complexity
 function appendTestObject(
   summaryKey: Maybe<SingleTestSummary>,
-  testObject: TIsolateTest
+  testObject: TIsolateTest,
 ): SingleTestSummary {
   const { message } = VestTest.getData(testObject);
 
   // Let's first create a new object, so we don't mutate the original.
   const nextSummaryKey = defaultTo<SingleTestSummary>(
     summaryKey ? { ...summaryKey } : null,
-    baseTestStats
+    baseTestStats,
   );
 
   // If the test is not actionable, we don't need to append it to the summary.
@@ -174,7 +174,7 @@ function appendTestObject(
     nextSummaryKey[countKey]++;
     if (message) {
       nextSummaryKey[severity] = (nextSummaryKey[severity] || []).concat(
-        message
+        message,
       );
     }
   }

diff --git a/packages/vest/src/vest.ts b/packages/vest/src/vest.ts
@@ -1,7 +1,6 @@
 import { enforce } from 'n4s';
-
-// eslint-disable-next-line import/order -- will handle this circular dep issue later.
 import { optional } from 'optional';
+
 import { Modes } from 'Modes';
 import type {
   SuiteResult,