Switch test runner from Jest to Vitest (#1609)

* Initial work to switch from Jest to Vitest * Fix for tsconfig.test.json to satisfy picocolors import * Enable Vitest globals and remove imports for Vitest * Undo formatting changes to files that didn't need touched * Fix issue with test-types task by including Vitest global types * Fix coverage tests by adding @vitest/coverage-istanbul * Add lcov recorder for test coverage * Remove Jest config * Add text reporter so CLI still reports coverage amounts * Move Vite config to Solid package * Split include into include/exclude paths * Switch to c8 instead of istanbul for coverage * Create twenty-jobs-study.md --------- Co-authored-by: Ryan Carniato <ryansolid@gmail.com>
solidjs · Mar 26, 2023 · 620c763 · 620c763
1 parent 220a289
commit 620c763
Show file tree

Hide file tree

Showing 27 changed files with 1,359 additions and 1,930 deletions.
diff --git a/.changeset/twenty-jobs-study.md b/.changeset/twenty-jobs-study.md
@@ -0,0 +1,6 @@
+---
+"solid-js": patch
+"test-integration": patch
+---
+
+Switch test runner from Jest to Vitest
diff --git a/package.json b/package.json
@@ -30,29 +30,27 @@
     "@rollup/plugin-json": "^6.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
     "@rollup/plugin-replace": "^5.0.2",
-    "@types/jest": "^28.1.6",
     "@types/node": "^18.11.19",
-    "babel-jest": "^28.1.3",
+    "@vitest/coverage-c8": "^0.29.7",
     "babel-plugin-jsx-dom-expressions": "^0.35.19",
     "coveralls": "^3.1.1",
     "csstype": "^3.1.0",
     "dom-expressions": "0.35.22",
     "fast-glob": "^3.2.11",
     "hyper-dom-expressions": "0.35.22",
-    "jest": "^28.1.3",
-    "jest-environment-jsdom": "^28.1.3",
-    "jest-ts-webcompat-resolver": "^1.0.0",
+    "jsdom": "^21.1.1",
     "lit-dom-expressions": "0.35.22",
     "ncp": "^2.0.0",
     "npm-run-all": "^4.1.5",
     "rimraf": "^3.0.2",
     "rollup": "^3.7.5",
     "rollup-plugin-cleanup": "^3.2.1",
     "rollup-plugin-copy": "^3.4.0",
-    "solid-jest": "^0.2.0",
     "symlink-dir": "^5.0.1",
     "tsconfig-replace-paths": "^0.0.11",
     "turbo": "^1.3.1",
-    "typescript": "^4.9.5"
+    "typescript": "^4.9.5",
+    "vite-plugin-solid": "^2.6.1",
+    "vitest": "^0.29.3"
   }
 }
diff --git a/packages/solid/jest.config.cjs b/packages/solid/jest.config.cjs
diff --git a/packages/solid/package.json b/packages/solid/package.json
@@ -266,8 +266,8 @@
     "types:universal": "tsc --project ./universal/tsconfig.json && ncp ../../node_modules/dom-expressions/src/universal.d.ts ./universal/types/universal.d.ts",
     "bench": "node --allow-natives-syntax bench/bench.cjs",
     "link": "symlink-dir . node_modules/solid-js",
-    "test": "jest",
-    "coverage": "jest --coverage",
+    "test": "vitest run",
+    "coverage": "vitest run --coverage",
     "test-types": "tsc --project tsconfig.test.json"
   },
   "keywords": [

diff --git a/packages/solid/store/test/mutable.spec.ts b/packages/solid/store/test/mutable.spec.ts
@@ -219,18 +219,19 @@ describe("Setting state from Effects", () => {
     expect(state!.data).toBe("signal");
   });
 
-  test("Select Promise", done => {
-    createRoot(async () => {
-      const p = new Promise<string>(resolve => {
-          setTimeout(resolve, 20, "promised");
-        }),
-        state = createMutable({ data: "" });
-      p.then(v => (state.data = v));
-      await p;
-      expect(state.data).toBe("promised");
-      done();
-    });
-  });
+  test("Select Promise", () =>
+    new Promise(done => {
+      createRoot(async () => {
+        const p = new Promise<string>(resolve => {
+            setTimeout(resolve, 20, "promised");
+          }),
+          state = createMutable({ data: "" });
+        p.then(v => (state.data = v));
+        await p;
+        expect(state.data).toBe("promised");
+        done(undefined);
+      });
+    }));
 });
 
 describe("State wrapping", () => {

diff --git a/packages/solid/store/test/store.spec.ts b/packages/solid/store/test/store.spec.ts
@@ -548,18 +548,19 @@ describe("Setting state from Effects", () => {
     expect(state.data).toBe("signal");
   });
 
-  test("Select Promise", done => {
-    createRoot(async () => {
-      const p = new Promise<string>(resolve => {
-        setTimeout(resolve, 20, "promised");
+  test("Select Promise", () =>
+    new Promise(done => {
+      createRoot(async () => {
+        const p = new Promise<string>(resolve => {
+          setTimeout(resolve, 20, "promised");
+        });
+        const [state, setState] = createStore({ data: "" });
+        p.then(v => setState("data", v));
+        await p;
+        expect(state.data).toBe("promised");
+        done(undefined);
       });
-      const [state, setState] = createStore({ data: "" });
-      p.then(v => setState("data", v));
-      await p;
-      expect(state.data).toBe("promised");
-      done();
-    });
-  });
+    }));
 });
 
 describe("Batching", () => {

diff --git a/packages/solid/test/component.spec.ts b/packages/solid/test/component.spec.ts
@@ -104,14 +104,19 @@ describe("Clone Props", () => {
 });
 
 describe("Clone Store", () => {
-  const [state, setState] = createStore<{ a: string; b: string; c?: string }>({ a: "Hi", b: "Jo" });
-  const clone = mergeProps(state);
-  expect(clone.a).toBe("Hi");
-  expect(clone.b).toBe("Jo");
-  setState({ a: "Greetings", c: "John" });
-  expect(clone.a).toBe("Greetings");
-  expect(clone.b).toBe("Jo");
-  expect(clone.c).toBe("John");
+  test("simple set", () => {
+    const [state, setState] = createStore<{ a: string; b: string; c?: string }>({
+      a: "Hi",
+      b: "Jo"
+    });
+    const clone = mergeProps(state);
+    expect(clone.a).toBe("Hi");
+    expect(clone.b).toBe("Jo");
+    setState({ a: "Greetings", c: "John" });
+    expect(clone.a).toBe("Greetings");
+    expect(clone.b).toBe("Jo");
+    expect(clone.c).toBe("John");
+  });
 });
 
 describe("Merge Signal", () => {
@@ -124,7 +129,7 @@ describe("Merge Signal", () => {
         c: "j"
       }),
       defaults: SimplePropTypes = { a: "yy", b: "ggg", d: "DD" };
-    let props!: SimplePropTypes;;
+    let props!: SimplePropTypes;
     const res: string[] = [];
     createRoot(() => {
       props = mergeProps(defaults, s);

diff --git a/packages/solid/test/dev.spec.ts b/packages/solid/test/dev.spec.ts
@@ -124,7 +124,7 @@ describe("Dev features", () => {
   });
 
   test("OnStoreNodeUpdate Hook", () => {
-    const cb = jest.fn();
+    const cb = vi.fn();
     global._$onStoreNodeUpdate = cb;
     const [s, set] = createStore({ firstName: "John", lastName: "Smith", inner: { foo: 1 } });
     expect(cb).toHaveBeenCalledTimes(0);

diff --git a/packages/solid/test/observable.spec.ts b/packages/solid/test/observable.spec.ts
@@ -18,7 +18,7 @@ describe("Observable operator", () => {
 
   test("preserve the observer's next binding", () => {
     const observer = {
-      next: jest.fn().mockReturnThis()
+      next: vi.fn().mockReturnThis()
     };
 
     createRoot(() => {

diff --git a/packages/solid/test/scheduler.spec.ts b/packages/solid/test/scheduler.spec.ts
@@ -1,40 +1,44 @@
-/** @jest-environment jsdom */
+/** @vitest-environment jsdom */
 import { cancelCallback, requestCallback } from "../src";
 import "./MessageChannel";
 
 describe("requestCallback basics", () => {
-  test("queue a task", done => {
-    requestCallback(() => {
-      done();
-    });
-  });
+  test("queue a task", () =>
+    new Promise(done => {
+      requestCallback(() => {
+        done(undefined);
+      });
+    }));
 
-  test("queue a task in correct order", done => {
-    let count = 0;
-    requestCallback(() => {
-      expect(count).toBe(2);
-      done();
-    });
-    requestCallback(
-      () => {
-        count++;
-        expect(count).toBe(1);
-      },
-      { timeout: 10 }
-    );
-    requestCallback(
-      () => {
-        count++;
+  test("queue a task in correct order", () =>
+    new Promise(done => {
+      let count = 0;
+      requestCallback(() => {
         expect(count).toBe(2);
-      },
-      { timeout: 40 }
-    );
-  });
-
-  test("supports cancelling a callback", done => {
-    const task = requestCallback(() => { done(new Error('should not be called')) });
-    cancelCallback(task);
-    requestCallback(done);
-  });
+        done(undefined);
+      });
+      requestCallback(
+        () => {
+          count++;
+          expect(count).toBe(1);
+        },
+        { timeout: 10 }
+      );
+      requestCallback(
+        () => {
+          count++;
+          expect(count).toBe(2);
+        },
+        { timeout: 40 }
+      );
+    }));
 
+  test("supports cancelling a callback", () =>
+    new Promise((done, reject) => {
+      const task = requestCallback(() => {
+        reject(new Error("should not be called"));
+      });
+      cancelCallback(task);
+      requestCallback(() => done(undefined));
+    }));
 });