ref: Move from Jest to Vitest (#120)

Migrate off of Jest over to Vitest for unit testing in the packages.

GH codecov/engineering-team#1596

Author: nsdeschenes

.github/workflows/ci.yml

@@ -187,7 +187,7 @@ jobs:
         run: pnpm run build
 
       - name: Run unit tests
-        run: pnpm run test:unit:ci --maxWorkers=2
+        run: pnpm run test:unit:ci
 
       - name: Upload coverage reports to codecov
         if: ${{ !github.event.pull_request.head.repo.fork && github.repository_owner == 'codecov' }}

package.json

@@ -16,6 +16,7 @@
     "format": "pnpm -r format && prettier --write '*.{cjs,json}' --ignore-unknown --no-error-on-unmatched-pattern",
     "format:check": "pnpm -r --filter='./packages/*' format:check && prettier --check '*.{cjs,json}' --ignore-unknown --no-error-on-unmatched-pattern",
     "test:unit": "pnpm -r --filter='./packages/*' run test:unit",
+    "test:unit:watch": "pnpm -r --filter='./packages/*' run test:unit:watch",
     "test:unit:update": "pnpm -r --filter='./packages/*' run test:unit:update",
     "test:unit:ci": "pnpm -r --filter='./packages/*' run test:unit:ci",
     "test:e2e": "pnpm -r --filter='./integration-tests' run test:e2e",
@@ -43,7 +44,9 @@
     "lint-staged": "^15.2.1",
     "prettier": "^3.2.4",
     "typedoc": "^0.25.12",
-    "typescript": "^5.3.3"
+    "typescript": "^5.3.3",
+    "vite-tsconfig-paths": "^4.3.2",
+    "vitest": "^1.5.0"
   },
   "lint-staged": {
     "*.{js,jsx,ts,tsx,json,css,scss,md,json}": [

packages/bundler-plugin-core/jest.config.ts

@@ -32,8 +32,10 @@
     "lint:fix": "pnpm lint --fix",
     "format": "prettier '**/*.{cjs,mjs,ts,tsx,md,json}' --ignore-path ../.gitignore --ignore-unknown --no-error-on-unmatched-pattern --write",
     "format:check": "prettier '**/*.{cjs,mjs,ts,tsx,md,json}' --ignore-path ../.gitignore --ignore-unknown --no-error-on-unmatched-pattern --check",
-    "test:unit": "jest --runInBand",
-    "test:unit:ci": "JEST_JUNIT_OUTPUT_NAME='bundler-plugin-core.junit.xml' jest --coverage --reporters=jest-junit",
+    "test:unit": "vitest run",
+    "test:unit:watch": "vitest watch",
+    "test:unit:ci": "vitest --coverage --reporter=junit --outputFile=./bundler-plugin-core.junit.xml run",
+    "test:unit:update": "vitest -u run",
     "generate:typedoc": "typedoc --options ./typedoc.json"
   },
   "dependencies": {
@@ -43,21 +45,19 @@
     "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@swc/core": "^1.3.107",
-    "@swc/jest": "^0.2.33",
-    "@types/jest": "^29.5.11",
     "@types/node": "^20.11.15",
     "@types/semver": "^7.5.6",
+    "@vitest/coverage-v8": "^1.5.0",
     "codecovProdRollupPlugin": "npm:@codecov/[email protected]",
-    "jest": "^29.7.0",
-    "jest-junit": "^16.0.0",
     "msw": "^2.1.5",
     "testdouble": "^3.20.1",
-    "testdouble-jest": "^2.0.0",
+    "testdouble-vitest": "^0.1.3",
     "ts-node": "^10.9.2",
     "typedoc": "^0.25.12",
     "typescript": "^5.3.3",
-    "unbuild": "^2.0.0"
+    "unbuild": "^2.0.0",
+    "vite-tsconfig-paths": "^4.3.2",
+    "vitest": "^1.5.0"
   },
   "volta": {
     "extends": "../../package.json"

packages/bundler-plugin-core/package.json

@@ -1,18 +1,27 @@
-import { type ProviderServiceParams } from "../../types";
+import {
+  describe,
+  it,
+  expect,
+  vi,
+  afterEach,
+  beforeAll,
+  afterAll,
+  type MockInstance,
+  type Mock,
+} from "vitest";
+
 import { detectProvider } from "../provider";
 import { Output } from "../Output";
 
-jest.mock("../provider");
+vi.mock("../provider");
 
-const mockedDetectProvider = detectProvider as jest.Mock<
-  Promise<ProviderServiceParams>
->;
+const mockedDetectProvider = detectProvider as Mock;
 
 afterEach(() => {
-  jest.resetAllMocks();
+  vi.resetAllMocks();
 });
 
-let consoleSpy: jest.SpyInstance;
+let consoleSpy: MockInstance;
 
 interface SetupArgs {
   statsSendError?: boolean;
@@ -31,9 +40,9 @@ describe("Output", () => {
     statsSendError,
     urlSendError,
   }: SetupArgs) {
-    const preSignedUrlBody = jest.fn();
-    const statsBody = jest.fn();
-    consoleSpy = jest.spyOn(console, "log").mockImplementation(() => null);
+    const preSignedUrlBody = vi.fn();
+    const statsBody = vi.fn();
+    consoleSpy = vi.spyOn(console, "log").mockImplementation(() => null);
 
     mockedDetectProvider.mockResolvedValue({
       branch: "main",
@@ -48,7 +57,7 @@ describe("Output", () => {
 
     // need to mock out fetch wholly and check to see if it was called with the correct stuff
 
-    const fetchMock = jest
+    const fetchMock = vi
       .spyOn(global, "fetch")
       // pre-signed URL
       // @ts-expect-error - testing fetch
@@ -87,11 +96,11 @@ describe("Output", () => {
 
   describe("start method", () => {
     beforeAll(() => {
-      jest.useFakeTimers().setSystemTime(1000);
+      vi.useFakeTimers().setSystemTime(1000);
     });
 
     afterAll(() => {
-      jest.useRealTimers();
+      vi.useRealTimers();
     });
 
     it("should set builtAt to the current time", () => {
@@ -117,11 +126,11 @@ describe("Output", () => {
 
   describe("end method", () => {
     beforeAll(() => {
-      jest.useFakeTimers().setSystemTime(1000);
+      vi.useFakeTimers().setSystemTime(1000);
     });
 
     afterAll(() => {
-      jest.useRealTimers();
+      vi.useRealTimers();
     });
 
     describe("builtAt is set", () => {

packages/bundler-plugin-core/src/utils/__tests__/Output.test.ts

@@ -1,9 +1,19 @@
+import {
+  vi,
+  beforeAll,
+  afterAll,
+  afterEach,
+  describe,
+  expect,
+  it,
+  type MockInstance,
+} from "vitest";
 import { HttpResponse, http } from "msw";
 import { setupServer } from "msw/node";
 
 import { fetchWithRetry } from "../fetchWithRetry";
 
-jest.mock("../delay.ts");
+vi.mock("../delay.ts");
 
 const server = setupServer();
 
@@ -28,7 +38,7 @@ interface SetupArgs {
 }
 
 describe("fetchWithRetry", () => {
-  let consoleSpy: jest.SpyInstance;
+  let consoleSpy: MockInstance;
 
   afterEach(() => {
     consoleSpy.mockReset();
@@ -41,7 +51,7 @@ describe("fetchWithRetry", () => {
     failFetch = false,
     retryCount = 0,
   }: SetupArgs) {
-    consoleSpy = jest.spyOn(console, "log").mockImplementation(() => null);
+    consoleSpy = vi.spyOn(console, "log").mockImplementation(() => null);
 
     server.use(
       http.all("http://localhost", ({}) => {

packages/bundler-plugin-core/src/utils/__tests__/fetchWithRetry.test.ts

@@ -1,3 +1,13 @@
+import {
+  vi,
+  describe,
+  it,
+  expect,
+  beforeAll,
+  afterAll,
+  afterEach,
+  type MockInstance,
+} from "vitest";
 import { HttpResponse, http } from "msw";
 import { setupServer } from "msw/node";
 
@@ -28,10 +38,10 @@ interface SetupArgs {
 }
 
 describe("getPreSignedURL", () => {
-  let consoleSpy: jest.SpyInstance;
+  let consoleSpy: MockInstance;
 
   function setup({ status = 200, data = {}, sendError = false }: SetupArgs) {
-    consoleSpy = jest.spyOn(console, "log").mockImplementation(() => null);
+    consoleSpy = vi.spyOn(console, "log").mockImplementation(() => null);
 
     server.use(
       http.post("http://localhost/upload/bundle_analysis/v1", ({}) => {
@@ -156,9 +166,9 @@ describe("getPreSignedURL", () => {
     });
 
     describe("returned data is undefined", () => {
-      let fetchSpy: jest.SpyInstance;
+      let fetchSpy: MockInstance;
       beforeAll(() => {
-        fetchSpy = jest
+        fetchSpy = vi
           .spyOn(global, "fetch")
           .mockResolvedValue(new Response(undefined, { status: 200 }));
       });
@@ -218,9 +228,9 @@ describe("getPreSignedURL", () => {
     });
 
     describe("fetch throws an error", () => {
-      let fetchSpy: jest.SpyInstance;
+      let fetchSpy: MockInstance;
       beforeAll(() => {
-        fetchSpy = jest
+        fetchSpy = vi
           .spyOn(global, "fetch")
           .mockRejectedValue(new Error("Failed to fetch"));
       });

packages/bundler-plugin-core/src/utils/__tests__/getPreSignedURL.test.ts

@@ -1,3 +1,4 @@
+import { describe, it, expect } from "vitest";
 import { type Options } from "../../types.ts";
 import {
   normalizeOptions,

packages/bundler-plugin-core/src/utils/__tests__/normalizeOptions.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from "vitest";
 import { normalizePath } from "../normalizePath";
 
 interface Test {

packages/bundler-plugin-core/src/utils/__tests__/normalizePath.test.ts

@@ -1,11 +1,20 @@
+import {
+  describe,
+  it,
+  expect,
+  beforeEach,
+  afterEach,
+  vi,
+  type MockInstance,
+} from "vitest";
 import { InvalidSlugError } from "../../errors/InvalidSlugError";
 import { preProcessBody } from "../preProcessBody";
 
 describe("preProcessBody", () => {
-  let consoleSpy: jest.SpyInstance;
+  let consoleSpy: MockInstance;
 
   beforeEach(() => {
-    consoleSpy = jest.spyOn(console, "log").mockImplementation(() => null);
+    consoleSpy = vi.spyOn(console, "log").mockImplementation(() => null);
   });
 
   afterEach(() => {