feat(vest): use key prop to retain test state after reorder (#732)

.eslintrc.js

@@ -37,7 +37,10 @@ module.exports = {
         'plugin:@typescript-eslint/recommended',
         'plugin:import/typescript',
       ],
-      files: ['*.ts'],
+      files: ['packages/**/*.ts'],
+      parserOptions: {
+        project: ['./tsconfig.json'], // Specify it only for TypeScript files
+      },
       rules: {
         '@typescript-eslint/no-explicit-any': 'off',
         '@typescript-eslint/explicit-module-boundary-types': 'off',
@@ -91,6 +94,7 @@ module.exports = {
     'no-multi-spaces': 1,
     'no-prototype-builtins': 0,
     'no-trailing-spaces': [2, { ignoreComments: false }],
+    'no-undef': 2,
     'no-unneeded-ternary': 2,
     'no-unused-expressions': 2,
     'no-useless-catch': 2,

CHANGELOG.md

@@ -7,37 +7,44 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 ## vest: [3.2.8] - 2021-11-02
 
 ### Fixed and improved
-- 9555d1b  types: Add types for skipWhen (ealush)
+
+- 9555d1b types: Add types for skipWhen (ealush)
 
 ## vest: [3.2.7] - 2021-10-16
 
 ### Fixed and improved
-- c2964e0  patch: add skipWhen for forward compatibility (ealush)
+
+- c2964e0 patch: add skipWhen for forward compatibility (ealush)
 
 ## n4s: [3.1.0] - 2021-10-09
 
 ### Added
-- 5adc337  feat: add isBlank rule (Luca Pizzini)
+
+- 5adc337 feat: add isBlank rule (Luca Pizzini)
 
 ## vest: [3.2.6] - 2021-10-09
 
 ### Fixed and improved
-- e538e5b  patch: remove incorrect messaging from group initialization error (ealush)
+
+- e538e5b patch: remove incorrect messaging from group initialization error (ealush)
 
 ## vest: [3.2.5] - 2021-07-31
 
 ### Fixed and improved
-- 3bb7f76  patch: Fix crashing of setFnName in IE11 (#671) (Václav Jančařík)
+
+- 3bb7f76 patch: Fix crashing of setFnName in IE11 (#671) (Václav Jančařík)
 
 ## vest: [3.2.4] - 2021-07-19
 
 ### Fixed and improved
-- ba6c296  patch: remove unused optional references from the state (ealush)
+
+- ba6c296 patch: remove unused optional references from the state (ealush)
 
 ## vest: [3.2.3] - 2021-05-27
 
 ### Fixed and improved
-- c02f22f  patch: use context only as dev dep (ealush)
+
+- c02f22f patch: use context only as dev dep (ealush)
 
 ## vest: [3.2.2] - 2021-05-17
 

README.md

@@ -4,7 +4,7 @@
 
 If you want to try it out, you can already install it with the `next` tag.
 
-```npm install vest@next```
+`npm install vest@next`
 
 This version brings many enhancements to Vest. This version is well tested, and can be used safely. If you do, however encounter any issues or have any thoughts on the next version, please report them on the issues page.
 

packages/context/README.md

@@ -4,6 +4,7 @@ Simple utility for context propagation within Javascript applications and librar
 It allows you to keep reference for shared variables, and access them down in your function call even if not declared in the same scope.
 
 ## How Context Works?
+
 The way context works is quite simple. Creating a context initializes a closure with a context storage object. When you run your context call, it takes your values, and places them in the context storage object. When your function finishes running, the context is cleared.
 
 ![image](https://user-images.githubusercontent.com/11255103/137119151-6912d3f1-ab48-4c91-a426-76af8abc8c55.png)
@@ -125,13 +126,15 @@ Working with context inside within async code may lead to unexpected results whe
 This is known and expected behavior. Context is a synchronous context propagation tool that completely relies on the synchronous nature of function calls in JS - this is exactly what allows context to run.
 
 #### But my function is still running. Why did the context clear?
+
 The async parts of your function are actually not executed along with your sync code, and even though you "await" it, the browser carries on and allows other code to run in between instead of blocking execution until your async code is complete.
 
 #### Ok, so what do I do?
+
 There are multiple strategies of handling async functions with context.
 
 1. Pulling your values from context right before your async call
-This is the most obvious and easiest to achieve, though not always what you need. The basic idea is that you take whatever you need from the context when it is still available to you.
+   This is the most obvious and easiest to achieve, though not always what you need. The basic idea is that you take whatever you need from the context when it is still available to you.
 
 2. context.bind or context.run your async function to the context you extracted
-This is the next logical step - you have a function that you know should run later with your context. You can bind your context to it for delayed execution. When your function runs later down the line within your asynchronous code, internally it will still have access to whatever you bound to it.
+   This is the next logical step - you have a function that you know should run later with your context. You can bind your context to it for delayed execution. When your function runs later down the line within your asynchronous code, internally it will still have access to whatever you bound to it.

packages/n4s/src/plugins/schema/optional.ts

@@ -1,12 +1,12 @@
+import isNullish from 'isNullish';
+
 import type { TLazy } from 'genEnforceLazy';
-import { isNull } from 'isNull';
-import { isUndefined } from 'isUndefined';
 import type { TRuleDetailedResult } from 'ruleReturn';
 import * as ruleReturn from 'ruleReturn';
 import runLazyRule from 'runLazyRule';
 
 export function optional(value: any, ruleChain: TLazy): TRuleDetailedResult {
-  if (isUndefined(value) || isNull(value)) {
+  if (isNullish(value)) {
     return ruleReturn.passing();
   }
   return runLazyRule(ruleChain, value);

packages/n4s/src/runtime/enforceEager.ts

@@ -25,14 +25,14 @@ export default function enforceEager(value: TRuleValue): IRules {
     return target;
   }
 
-  const proxy = new Proxy(target, {
+  const proxy: TEnforceEager = new Proxy(target, {
     get: (_, ruleName: string) => {
       const rule = getRule(ruleName);
       if (rule) {
         return genRuleCall(proxy, rule, ruleName);
       }
     },
-  }) as IRules;
+  });
 
   return proxy;
 

packages/shared/src/isNullish.ts

@@ -0,0 +1,6 @@
+import { isNull } from 'isNull';
+import { isUndefined } from 'isUndefined';
+
+export default function isNullish(value: any): value is null | undefined {
+  return isNull(value) || isUndefined(value);
+}

packages/vest/README.md

@@ -4,7 +4,7 @@
 
 If you want to try it out, you can already install it with the `next` tag.
 
-```npm install vest@next```
+`npm install vest@next`
 
 This version brings many enhancements to Vest. This version is well tested, and can be used safely. If you do, however encounter any issues or have any thoughts on the next version, please report them on the issues page.
 

packages/vest/src/__tests__/isolate.test.ts

@@ -1,20 +1,17 @@
+import mockThrowError from '../../testUtils/mockThrowError';
+
 import { IsolateTypes } from 'IsolateTypes';
 
 describe('isolate', () => {
   let firstRun = true;
   let vest, isolate, skipWhen, dummyTest;
-  let throwError, throwErrorDeferred;
+  let throwErrorDeferred;
 
   beforeEach(() => {
     firstRun = true;
-    jest.resetModules();
-    throwError = jest.fn();
-    throwErrorDeferred = jest.fn();
-    jest.mock('throwError', () => ({
-      throwErrorDeferred,
-      default: throwError,
-    }));
-    vest = require('vest');
+    const mock = mockThrowError();
+    throwErrorDeferred = mock.throwErrorDeferred;
+    vest = mock.vest;
     skipWhen = vest.skipWhen;
     isolate = require('isolate').isolate;
     dummyTest = require('../../testUtils/testDummy').dummyTest;

packages/vest/src/core/ctx/ctx.ts

@@ -2,7 +2,7 @@ import assign from 'assign';
 import { createContext } from 'context';
 import { createCursor } from 'cursor';
 
-import { IsolateTypes } from 'IsolateTypes';
+import { IsolateKeys, IsolateTypes } from 'IsolateTypes';
 import VestTest from 'VestTest';
 import type { TStateRef } from 'createStateRef';
 
@@ -12,19 +12,28 @@ export default createContext<CTXType>((ctxRef, parentContext) =>
     : assign(
         {},
         {
-          isolate: { type: IsolateTypes.DEFAULT },
-          testCursor: createCursor(),
           exclusion: {
             tests: {},
             groups: {},
           },
+          isolate: {
+            type: IsolateTypes.DEFAULT,
+            keys: {
+              current: {},
+              prev: {},
+            },
+          },
+          testCursor: createCursor(),
         },
         ctxRef
       )
 );
 
 type CTXType = {
-  isolate: { type: IsolateTypes };
+  isolate: {
+    type: IsolateTypes;
+    keys: IsolateKeys;
+  };
   testCursor: ReturnType<typeof createCursor>;
   stateRef?: TStateRef;
   exclusion: {

packages/vest/src/core/isolate/IsolateTypes.ts

@@ -1,7 +1,14 @@
+import VestTest from 'VestTest';
+
 export enum IsolateTypes {
   DEFAULT,
   SUITE,
   EACH,
   SKIP_WHEN,
   GROUP,
 }
+
+export type IsolateKeys = {
+  current: Record<string, VestTest>;
+  prev: Record<string, VestTest>;
+};

packages/vest/src/core/isolate/isolate.ts

@@ -1,9 +1,10 @@
 import isFunction from 'isFunction';
 import * as nestedArray from 'nestedArray';
 
-import { IsolateTypes } from 'IsolateTypes';
+import { IsolateKeys, IsolateTypes } from 'IsolateTypes';
 import VestTest from 'VestTest';
 import ctx from 'ctx';
+import { usePrevKeys } from 'key';
 import { useSetTests } from 'stateHooks';
 import * as testCursor from 'testCursor';
 
@@ -14,11 +15,17 @@ export function isolate(
   if (!isFunction(callback)) {
     return;
   }
+  const keys: IsolateKeys = {
+    current: {},
+    prev: {},
+  };
 
   const path = testCursor.usePath();
-  return ctx.run({ isolate: { type } }, () => {
+  return ctx.run({ isolate: { type, keys } }, () => {
     testCursor.addLevel();
 
+    keys.prev = usePrevKeys();
+
     useSetTests(tests => nestedArray.setValueAtPath(tests, path, []));
 
     const res = callback();

packages/vest/src/core/state/createStateRef.ts

@@ -26,7 +26,7 @@ export default function createStateRef(
       current: NestedArray<VestTest>;
     }>(prev => {
       return {
-        prev: (prev ? prev.current : []) as NestedArray<VestTest>,
+        prev: prev ? prev.current : [],
         current: [] as NestedArray<VestTest>,
       };
     }),

packages/vest/src/core/test/VestTest.ts

@@ -14,6 +14,7 @@ export default class VestTest {
   asyncTest?: TAsyncTest;
   groupName?: string;
   message?: string;
+  key?: null | string = null;
 
   id = genId();
   severity = TestSeverity.Error;
@@ -22,7 +23,11 @@ export default class VestTest {
   constructor(
     fieldName: string,
     testFn: TTestFn,
-    { message, groupName }: { message?: string; groupName?: string } = {}
+    {
+      message,
+      groupName,
+      key,
+    }: { message?: string; groupName?: string; key?: string } = {}
   ) {
     this.fieldName = fieldName;
     this.testFn = testFn;
@@ -34,6 +39,10 @@ export default class VestTest {
     if (message) {
       this.message = message;
     }
+
+    if (key) {
+      this.key = key;
+    }
   }
 
   run(): TTestResult {

packages/vest/src/core/test/__tests__/__snapshots__/VestTest.test.ts.snap

@@ -4,6 +4,7 @@ exports[`VestTest TestObject constructor 1`] = `
 VestTest {
   "fieldName": "unicycle",
   "id": "0",
+  "key": null,
   "message": "I am Root.",
   "severity": "error",
   "status": "UNTESTED",
@@ -15,6 +16,7 @@ exports[`VestTest testObject.warn Should mark the test as warning 1`] = `
 VestTest {
   "fieldName": "unicycle",
   "id": "102",
+  "key": null,
   "message": "I am Root.",
   "severity": "warning",
   "status": "UNTESTED",

packages/vest/src/core/test/__tests__/__snapshots__/test.test.ts.snap

@@ -0,0 +1,47 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Test Vest's \`test\` function test params creates a test with a message and with a key 1`] = `
+VestTest {
+  "fieldName": "field_name",
+  "id": "21",
+  "key": "keyboardcat",
+  "message": "failure message",
+  "severity": "error",
+  "status": "PASSING",
+  "testFn": [Function],
+}
+`;
+
+exports[`Test Vest's \`test\` function test params creates a test without a key 1`] = `
+VestTest {
+  "fieldName": "field_name",
+  "id": "17",
+  "key": null,
+  "message": "failure message",
+  "severity": "error",
+  "status": "PASSING",
+  "testFn": [Function],
+}
+`;
+
+exports[`Test Vest's \`test\` function test params creates a test without a message and with a key 1`] = `
+VestTest {
+  "fieldName": "field_name",
+  "id": "19",
+  "key": "keyboardcat",
+  "severity": "error",
+  "status": "PASSING",
+  "testFn": [Function],
+}
+`;
+
+exports[`Test Vest's \`test\` function test params creates a test without a message and without a key 1`] = `
+VestTest {
+  "fieldName": "field_name",
+  "id": "15",
+  "key": null,
+  "severity": "error",
+  "status": "PASSING",
+  "testFn": [Function],
+}
+`;