Migrate workspace tests to Vitest

niemyjski · niemyjski · commit 0ad376f5e357 · 2026-03-24T18:58:47.000-05:00
Update the test suite to use Vitest imports and async patterns, add the core test setup needed to shield jsdom tests from Node 25's broken global localStorage, and keep the typed-array normalization fix that the migrated Utils tests now exercise for BigInt views.
diff --git a/packages/browser/test/plugins/BrowserErrorPlugin.test.ts b/packages/browser/test/plugins/BrowserErrorPlugin.test.ts
@@ -1,5 +1,4 @@
-import { beforeEach, describe, test } from "@jest/globals";
-import { expect } from "expect";
+import { beforeEach, describe, expect, test } from "vitest";
 
 import { ErrorInfo, Event, EventContext, EventPluginContext, ExceptionlessClient, KnownEventDataKeys } from "@exceptionless/core";
 
diff --git a/packages/browser/test/plugins/BrowserIgnoreExtensionErrorsPlugin.test.ts b/packages/browser/test/plugins/BrowserIgnoreExtensionErrorsPlugin.test.ts
@@ -1,5 +1,4 @@
-import { beforeEach, describe, test } from "@jest/globals";
-import { expect } from "expect";
+import { beforeEach, describe, expect, test } from "vitest";
 
 import { EventContext, EventPluginContext, ExceptionlessClient } from "@exceptionless/core";
 
diff --git a/packages/core/src/Utils.ts b/packages/core/src/Utils.ts
@@ -265,10 +265,9 @@ export function prune(value: unknown, depth: number = 10): unknown {
         return Array.from(value);
       }
 
-      // Check for typed arrays
-      const TypedArray = Object.getPrototypeOf(Uint8Array);
-      if (value instanceof TypedArray) {
-        return Array.from(value as Iterable<unknown>);
+      // Handle all TypedArray variants, including BigInt typed arrays.
+      if (ArrayBuffer.isView(value) && !(value instanceof DataView)) {
+        return Array.from(value as unknown as ArrayLike<unknown>);
       }
 
       if (hasToJSONFunction(value)) {
diff --git a/packages/core/test/ExceptionlessClient.test.ts b/packages/core/test/ExceptionlessClient.test.ts
@@ -1,5 +1,4 @@
-import { describe, test } from "@jest/globals";
-import { expect } from "expect";
+import { describe, expect, test } from "vitest";
 
 import { ExceptionlessClient } from "#/ExceptionlessClient.js";
 import { KnownEventDataKeys } from "#/models/Event.js";
diff --git a/packages/core/test/Utils.test.ts b/packages/core/test/Utils.test.ts
@@ -1,5 +1,4 @@
-import { describe, test } from "@jest/globals";
-import { expect } from "expect";
+import { describe, expect, test } from "vitest";
 
 import { endsWith, isEmpty, isMatch, parseVersion, prune, startsWith, stringify, toBoolean } from "#/Utils.js";
 
@@ -94,13 +93,9 @@ describe("Utils", () => {
       Object.entries(typedArrayValues).forEach(([key, value]) => {
         test(`for ${key}`, () => {
           const actual = prune(value, 1);
-
-          if (Array.isArray(actual)) {
-            expect(actual.length).toBe(1);
-            expect(actual).toContain(1);
-          } else {
-            throw new Error("actual is not an array");
-          }
+          expect(Array.isArray(actual)).toBe(true);
+          expect(actual).toHaveLength(1);
+          expect(actual).toContain(1);
         });
       });
 
@@ -112,13 +107,9 @@ describe("Utils", () => {
       Object.entries(bigIntTypedArrayValues).forEach(([key, value]) => {
         test(`for ${key}`, () => {
           const actual = prune(value, 1);
-
-          if (Array.isArray(actual)) {
-            expect(actual.length).toBe(1);
-            expect(actual).toContain("1n");
-          } else {
-            throw new Error("actual is not an array");
-          }
+          expect(Array.isArray(actual)).toBe(true);
+          expect(actual).toHaveLength(1);
+          expect(actual).toContain("1n");
         });
       });
 
@@ -166,15 +157,10 @@ describe("Utils", () => {
       });
 
       test("for Error", () => {
-        try {
-          throw new Error("error");
-        } catch (error) {
-          if (error instanceof Error) {
-            const expected = { message: error.message, stack: error.stack };
-            const actual = prune(error, 1);
-            expect(actual).toStrictEqual(expected);
-          }
-        }
+        const error = new Error("error");
+        const expected = { message: error.message, stack: error.stack };
+        const actual = prune(error, 1);
+        expect(actual).toStrictEqual(expected);
       });
 
       test("for Map", () => {
@@ -450,15 +436,10 @@ describe("Utils", () => {
       });
 
       test("for Error", () => {
-        try {
-          throw new Error("error");
-        } catch (error) {
-          if (error instanceof Error) {
-            const expected = JSON.stringify({ stack: error.stack, message: error.message });
-            const actual = stringify(error, [], 1);
-            expect(actual).toStrictEqual(expected);
-          }
-        }
+        const error = new Error("error");
+        const expected = JSON.stringify({ stack: error.stack, message: error.message });
+        const actual = stringify(error, [], 1);
+        expect(actual).toStrictEqual(expected);
       });
 
       test("for Map", () => {
@@ -619,11 +600,11 @@ describe("Utils", () => {
       });
 
       test("*password*", () => {
-        JSON.stringify(expect(stringify(user, ["*password*"])).toBe(JSON.stringify({ id: 1, name: "Blake", customValue: "Password", value: {} })));
+        expect(stringify(user, ["*password*"])).toBe(JSON.stringify({ id: 1, name: "Blake", customValue: "Password", value: {} }));
       });
 
       test("*Password*", () => {
-        JSON.stringify(expect(stringify(user, ["*Password*"])).toBe(JSON.stringify({ id: 1, name: "Blake", customValue: "Password", value: {} })));
+        expect(stringify(user, ["*Password*"])).toBe(JSON.stringify({ id: 1, name: "Blake", customValue: "Password", value: {} }));
       });
 
       test("*Address", () => {
diff --git a/packages/core/test/configuration/Configuration.test.ts b/packages/core/test/configuration/Configuration.test.ts
@@ -1,5 +1,4 @@
-import { describe, test } from "@jest/globals";
-import { expect } from "expect";
+import { describe, expect, test } from "vitest";
 
 import { Configuration } from "#/configuration/Configuration.js";
 
@@ -85,16 +84,18 @@ describe("Configuration", () => {
     expect(config.plugins[2].priority).toBe(3);
   });
 
-  test("should call subscribe handler", (done) => {
-    const config = new Configuration();
-    expect(config.settings.someValue).toBeUndefined();
+  test("should call subscribe handler", () => {
+    return new Promise<void>((resolve) => {
+      const config = new Configuration();
+      expect(config.settings.someValue).toBeUndefined();
 
-    config.subscribeServerSettingsChange((c: Configuration) => {
-      expect(c.settings.someValue).toBe("UNIT_TEST_API_KEY");
-      expect(config.settings.someValue).toBe("UNIT_TEST_API_KEY");
-      done();
-    });
+      config.subscribeServerSettingsChange((c: Configuration) => {
+        expect(c.settings.someValue).toBe("UNIT_TEST_API_KEY");
+        expect(config.settings.someValue).toBe("UNIT_TEST_API_KEY");
+        resolve();
+      });
 
-    config.applyServerSettings({ settings: { someValue: "UNIT_TEST_API_KEY" }, version: 2 });
+      config.applyServerSettings({ settings: { someValue: "UNIT_TEST_API_KEY" }, version: 2 });
+    });
   });
 });
diff --git a/packages/core/test/plugins/EventPluginManager.test.ts b/packages/core/test/plugins/EventPluginManager.test.ts
@@ -1,5 +1,4 @@
-import { describe, test } from "@jest/globals";
-import { expect } from "expect";
+import { describe, expect, test } from "vitest";
 
 import { EventContext } from "#/models/EventContext.js";
 import { ExceptionlessClient } from "#/ExceptionlessClient.js";
diff --git a/packages/core/test/plugins/default/ConfigurationDefaultsPlugin.test.ts b/packages/core/test/plugins/default/ConfigurationDefaultsPlugin.test.ts
@@ -1,5 +1,4 @@
-import { describe, test } from "@jest/globals";
-import { expect } from "expect";
+import { describe, expect, test } from "vitest";
 
 import { ExceptionlessClient } from "#/ExceptionlessClient.js";
 import { Event } from "#/models/Event.js";
diff --git a/packages/core/test/plugins/default/DuplicateCheckerPlugin.test.ts b/packages/core/test/plugins/default/DuplicateCheckerPlugin.test.ts
@@ -1,5 +1,4 @@
-import { beforeEach, describe, test } from "@jest/globals";
-import { expect } from "expect";
+import { beforeEach, describe, expect, test } from "vitest";
 
 import { DuplicateCheckerPlugin } from "#/plugins/default/DuplicateCheckerPlugin.js";
 import { ExceptionlessClient } from "#/ExceptionlessClient.js";
diff --git a/packages/core/test/plugins/default/EventExclusionPlugin.test.ts b/packages/core/test/plugins/default/EventExclusionPlugin.test.ts
@@ -1,5 +1,4 @@
-import { describe, test } from "@jest/globals";
-import { expect } from "expect";
+import { describe, expect, test } from "vitest";
 
 import { ExceptionlessClient } from "#/ExceptionlessClient.js";
 import { Event, EventType, KnownEventDataKeys, LogLevel } from "#/models/Event.js";
diff --git a/packages/core/test/queue/DefaultEventQueue.test.ts b/packages/core/test/queue/DefaultEventQueue.test.ts
@@ -1,5 +1,4 @@
-import { afterEach, beforeEach, describe, test } from "@jest/globals";
-import { expect } from "expect";
+import { afterEach, beforeEach, describe, expect, test } from "vitest";
 
 import { Configuration } from "#/configuration/Configuration.js";
 import { Event } from "#/models/Event.js";
@@ -15,7 +14,8 @@ describe("DefaultEventQueue", () => {
     config.serverUrl = "http://server.localhost:5000";
     config.usePersistedQueueStorage = true;
 
-    expect(await config.services.storage.length()).toBe(0);
+    // Ensure storage is empty before tests
+    await config.services.storage.clear();
   });
 
   afterEach(async () => {
@@ -57,11 +57,9 @@ describe("DefaultEventQueue", () => {
     expect(await config.services.storage.length()).toBe(1);
 
     await delay(25);
-    if (!(config.services.queue as { _suspendProcessingUntil?: Date })._suspendProcessingUntil) {
-      expect(await config.services.storage.length()).toBe(0);
-    } else {
-      expect(await config.services.storage.length()).toBe(1);
-    }
+    const suspendProcessingUntil = (config.services.queue as { _suspendProcessingUntil?: Date })._suspendProcessingUntil;
+    const expectedLength = suspendProcessingUntil ? 1 : 0;
+    expect(await config.services.storage.length()).toBe(expectedLength);
   });
 
   test("should respect max items", async () => {
diff --git a/packages/core/test/setup.ts b/packages/core/test/setup.ts
@@ -0,0 +1,71 @@
+import { beforeEach } from "vitest";
+
+function createLocalStoragePolyfill(): Storage {
+  const store: Record<string, string> = {};
+  const storageTarget: Record<string, string> = {};
+
+  return new Proxy(storageTarget, {
+    get(target, prop) {
+      if (prop === "getItem") {
+        return (key: string): string | null => store[key] ?? null;
+      }
+
+      if (prop === "setItem") {
+        return (key: string, value: string): void => {
+          store[key] = value;
+          target[key] = value;
+        };
+      }
+
+      if (prop === "removeItem") {
+        return (key: string): void => {
+          delete store[key];
+          delete target[key];
+        };
+      }
+
+      if (prop === "clear") {
+        return (): void => {
+          Object.keys(store).forEach((key) => delete store[key]);
+          Object.keys(target).forEach((key) => delete target[key]);
+        };
+      }
+
+      if (prop === "length") {
+        return Object.keys(store).length;
+      }
+
+      if (prop === "key") {
+        return (index: number): string | null => Object.keys(store)[index] ?? null;
+      }
+
+      return target[prop as string];
+    },
+    ownKeys() {
+      return Object.keys(store);
+    },
+    getOwnPropertyDescriptor(target, prop) {
+      if (typeof prop === "string" && prop in store) {
+        return {
+          enumerable: true,
+          configurable: true,
+          value: store[prop]
+        };
+      }
+
+      return Object.getOwnPropertyDescriptor(target, prop);
+    }
+  }) as Storage;
+}
+
+if (typeof localStorage === "undefined" || typeof localStorage.clear !== "function") {
+  Object.defineProperty(globalThis, "localStorage", {
+    value: createLocalStoragePolyfill(),
+    configurable: true,
+    writable: true
+  });
+}
+
+beforeEach(() => {
+  localStorage.clear();
+});
diff --git a/packages/core/test/storage/StorageTestBase.ts b/packages/core/test/storage/StorageTestBase.ts
@@ -1,5 +1,4 @@
-import { afterEach, beforeEach, describe, test } from "@jest/globals";
-import { expect } from "expect";
+import { afterEach, beforeEach, describe, expect, test } from "vitest";
 
 import { IStorage } from "#/storage/IStorage.js";
 
diff --git a/packages/core/test/submission/TestSubmissionClient.test.ts b/packages/core/test/submission/TestSubmissionClient.test.ts
@@ -1,5 +1,4 @@
-import { describe, jest, test } from "@jest/globals";
-import { expect } from "expect";
+import { describe, expect, test, vi } from "vitest";
 
 import { Configuration } from "#/configuration/Configuration.js";
 import { ServerSettings } from "#/configuration/SettingsManager.js";
@@ -17,7 +16,7 @@ describe("TestSubmissionClient", () => {
   config.heartbeatServerUrl = "http://heartbeat.localhost:5000";
 
   test("should submit events", async () => {
-    const apiFetchMock = jest
+    const apiFetchMock = vi
       .fn<(url: string, options: FetchOptions) => Promise<Response<undefined>>>()
       .mockReturnValueOnce(Promise.resolve(new Response(202, "", NaN, NaN, undefined)));
 
@@ -33,7 +32,7 @@ describe("TestSubmissionClient", () => {
   });
 
   test("should submit invalid object data", async () => {
-    const apiFetchMock = jest
+    const apiFetchMock = vi
       .fn<(url: string, options: FetchOptions) => Promise<Response<undefined>>>()
       .mockReturnValueOnce(Promise.resolve(new Response(202, "", NaN, NaN, undefined)));
 
@@ -62,7 +61,7 @@ describe("TestSubmissionClient", () => {
   });
 
   test("should submit user description", async () => {
-    const apiFetchMock = jest
+    const apiFetchMock = vi
       .fn<(url: string, options: FetchOptions) => Promise<Response<unknown>>>()
       .mockReturnValueOnce(Promise.resolve(new Response(202, "", NaN, 1, undefined)))
       .mockReturnValueOnce(Promise.resolve(new Response(202, "", NaN, NaN, JSON.stringify(new ServerSettings({}, 1)))));
@@ -85,7 +84,7 @@ describe("TestSubmissionClient", () => {
   });
 
   test("should submit heartbeat", async () => {
-    const apiFetchMock = jest
+    const apiFetchMock = vi
       .fn<(url: string, options: FetchOptions) => Promise<Response<undefined>>>()
       .mockReturnValueOnce(Promise.resolve(new Response(200, "", NaN, NaN, undefined)));
 
@@ -97,7 +96,7 @@ describe("TestSubmissionClient", () => {
   });
 
   test("should get project settings", async () => {
-    const apiFetchMock = jest
+    const apiFetchMock = vi
       .fn<(url: string, options: FetchOptions) => Promise<Response<unknown>>>()
       .mockReturnValueOnce(Promise.resolve(new Response(200, "", NaN, NaN, JSON.stringify(new ServerSettings({}, 1)))));
 
diff --git a/packages/node/test/storage/NodeDirectoryStorage.test.ts b/packages/node/test/storage/NodeDirectoryStorage.test.ts
@@ -2,12 +2,15 @@ import { IStorage } from "@exceptionless/core";
 import { describeStorage } from "../../../core/test/storage/StorageTestBase.js";
 import { NodeDirectoryStorage } from "#/storage/NodeDirectoryStorage.js";
 import { mkdirSync, rmSync } from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
 
-const directory: string = "./test/data";
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const directory: string = path.join(__dirname, "data");
 
 function resetStorageDirectory() {
   rmSync(directory, { recursive: true, force: true });
-  mkdirSync(directory);
+  mkdirSync(directory, { recursive: true });
 }
 
 describeStorage("NodeDirectoryStorage", (): IStorage => new NodeDirectoryStorage(directory), resetStorageDirectory, resetStorageDirectory);

Original file line number	Diff line number	Diff line change
`@@ -265,10 +265,9 @@ export function prune(value: unknown, depth: number = 10): unknown {`
`265`	`265`	`return Array.from(value);`
`266`	`266`	`}`
`267`	`267`
`268`		`- // Check for typed arrays`
`269`		`- const TypedArray = Object.getPrototypeOf(Uint8Array);`
`270`		`- if (value instanceof TypedArray) {`
`271`		`- return Array.from(value as Iterable<unknown>);`
	`268`	`+ // Handle all TypedArray variants, including BigInt typed arrays.`
	`269`	`+ if (ArrayBuffer.isView(value) && !(value instanceof DataView)) {`
	`270`	`+ return Array.from(value as unknown as ArrayLike<unknown>);`
`272`	`271`	`}`
`273`	`272`
`274`	`273`	`if (hasToJSONFunction(value)) {`