test(utils): Switch to using vitest

Author: AbhiPrasad

packages/utils/jest.config.js

@@ -41,10 +41,6 @@
   "dependencies": {
     "@sentry/types": "8.20.0"
   },
-  "devDependencies": {
-    "@types/array.prototype.flat": "^1.2.1",
-    "array.prototype.flat": "^1.3.0"
-  },
   "scripts": {
     "build": "run-p build:transpile build:types",
     "build:dev": "yarn build",
@@ -61,8 +57,8 @@
     "clean": "rimraf build coverage cjs esm sentry-utils-*.tgz",
     "fix": "eslint . --format stylish --fix",
     "lint": "eslint . --format stylish",
-    "test": "jest",
-    "test:watch": "jest --watch",
+    "test": "vitest run",
+    "test:watch": "vitest --watch",
     "version": "node ../../scripts/versionbump.js src/version.ts",
     "yalc:publish": "yalc publish --push --sig"
   },

packages/utils/package.json

@@ -65,8 +65,9 @@ export function addNonEnumerableProperty(obj: object, name: string, value: unkno
 export function markFunctionWrapped(wrapped: WrappedFunction, original: WrappedFunction): void {
   try {
     const proto = original.prototype || {};
-    wrapped.prototype = original.prototype = proto;
+    wrapped.prototype = proto;
     addNonEnumerableProperty(wrapped, '__sentry_original__', original);
+    original.prototype = proto;
   } catch (o_O) {} // eslint-disable-line no-empty
 }
 

packages/utils/src/object.ts

@@ -1,3 +1,5 @@
+import { describe, expect } from 'vitest';
+
 import type { Event, EventHint, Exception, ExtendedError, StackParser } from '@sentry/types';
 
 import { applyAggregateErrorsToEvent, createStackParser } from '../src/index';

packages/utils/test/aggregate-errors.test.ts

@@ -1,3 +1,5 @@
+import { describe, expect, it } from 'vitest';
+
 import type { NestedArray } from '../src/array';
 import { flatten } from '../src/array';
 

packages/utils/test/array.test.ts

@@ -1,3 +1,5 @@
+import { expect, test } from 'vitest';
+
 import { baggageHeaderToDynamicSamplingContext, dynamicSamplingContextToSentryBaggageHeader } from '../src/baggage';
 
 test.each([

packages/utils/test/baggage.test.ts

@@ -1,3 +1,5 @@
+import { beforeAll, beforeEach, describe, expect, it } from 'vitest';
+
 import { JSDOM } from 'jsdom';
 
 import { getDomElement, htmlTreeAsString } from '../src/browser';

packages/utils/test/browser.test.ts

@@ -1,3 +1,5 @@
+import { describe, expect, it } from 'vitest';
+
 import { _nullishCoalesce } from '../../src/buildPolyfills';
 import type { Value } from '../../src/buildPolyfills/types';
 import { _nullishCoalesce as _nullishCoalesceOrig } from './originals';

packages/utils/test/buildPolyfills/nullishCoalesce.test.ts

@@ -1,13 +1,9 @@
-import { default as arrayFlat } from 'array.prototype.flat';
+import { describe, expect, it } from 'vitest';
 
 import { _optionalChain } from '../../src/buildPolyfills';
 import type { GenericFunction, GenericObject, Value } from '../../src/buildPolyfills/types';
 import { _optionalChain as _optionalChainOrig } from './originals';
 
-// Older versions of Node don't have `Array.prototype.flat`, which crashes these tests. On newer versions that do have
-// it, this is a no-op.
-arrayFlat.shim();
-
 type OperationType = 'access' | 'call' | 'optionalAccess' | 'optionalCall';
 type OperationExecutor =
   | ((intermediateValue: GenericObject) => Value)

packages/utils/test/buildPolyfills/optionalChain.test.ts

@@ -1,3 +1,5 @@
+import { describe, expect, it } from 'vitest';
+
 import type { ClientReport } from '@sentry/types';
 
 import { createClientReportEnvelope } from '../src/clientreport';

packages/utils/test/clientreport.test.ts

@@ -27,6 +27,7 @@
  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
+import { describe, expect, it } from 'vitest';
 
 import { parseCookie } from '../src/cookie';
 

packages/utils/test/cookie.test.ts

@@ -1,17 +1,19 @@
+import { beforeEach, describe, expect, test, vi } from 'vitest';
+
 import { DEBUG_BUILD } from '../src/debug-build';
 import { dsnToString, makeDsn } from '../src/dsn';
 import { logger } from '../src/logger';
 
-function testIf(condition: boolean): jest.It {
+function testIf(condition: boolean) {
   return condition ? test : test.skip;
 }
 
-const loggerErrorSpy = jest.spyOn(logger, 'error').mockImplementation(() => {});
-const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});
+const loggerErrorSpy = vi.spyOn(logger, 'error').mockImplementation(() => {});
+const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(() => {});
 
 describe('Dsn', () => {
   beforeEach(() => {
-    jest.clearAllMocks();
+    vi.clearAllMocks();
   });
 
   describe('fromComponents', () => {

packages/utils/test/dsn.test.ts

@@ -1,3 +1,5 @@
+import { afterEach, describe, expect, it, test, vi } from 'vitest';
+
 import type { Event, EventEnvelope, SpanAttributes } from '@sentry/types';
 
 import {
@@ -108,12 +110,8 @@ describe('envelope', () => {
         name: 'with TextEncoder/Decoder polyfill',
         before: () => {
           GLOBAL_OBJ.__SENTRY__ = {} as InternalGlobal['__SENTRY__'];
-          GLOBAL_OBJ.__SENTRY__.encodePolyfill = jest.fn<Uint8Array, [string]>((input: string) =>
-            new TextEncoder().encode(input),
-          );
-          GLOBAL_OBJ.__SENTRY__.decodePolyfill = jest.fn<string, [Uint8Array]>((input: Uint8Array) =>
-            new TextDecoder().decode(input),
-          );
+          GLOBAL_OBJ.__SENTRY__.encodePolyfill = vi.fn((input: string) => new TextEncoder().encode(input));
+          GLOBAL_OBJ.__SENTRY__.decodePolyfill = vi.fn((input: Uint8Array) => new TextDecoder().decode(input));
         },
         after: () => {
           expect(GLOBAL_OBJ.__SENTRY__.encodePolyfill).toHaveBeenCalled();

packages/utils/test/envelope.test.ts

@@ -1,3 +1,5 @@
+import { describe, expect, it, test } from 'vitest';
+
 import type { Client } from '@sentry/types';
 
 import { createStackParser, eventFromUnknownInput, nodeStackLineParser } from '../src';

packages/utils/test/eventbuilder.test.ts

@@ -1,3 +1,5 @@
+import { describe, expect, it } from 'vitest';
+
 import { parseFetchArgs } from '../../src/instrument/fetch';
 
 describe('instrument > parseFetchArgs', () => {

packages/utils/test/instrument/fetch.test.ts

@@ -1,3 +1,5 @@
+import { describe, expect, it, test } from 'vitest';
+
 import {
   isDOMError,
   isDOMException,

packages/utils/test/is.test.ts

@@ -1,3 +1,5 @@
+import { describe, expect, test } from 'vitest';
+
 import { LRUMap } from '../src/lru';
 
 describe('LRUMap', () => {

packages/utils/test/lru.test.ts

@@ -1,3 +1,7 @@
+import { afterEach, describe, expect, it, test, vi } from 'vitest';
+
+import * as cryptoMod from 'node:crypto';
+
 import type { Event, Mechanism, StackFrame } from '@sentry/types';
 
 import {
@@ -6,9 +10,26 @@ import {
   arrayify,
   checkOrSetAlreadyCaught,
   getEventDescription,
+  parseSemver,
   uuid4,
 } from '../src/misc';
 
+const NODE_VERSION = parseSemver(process.versions.node);
+/**
+ * Returns`describe` or `describe.skip` depending on allowed major versions of Node.
+ *
+ * @param {{ min?: number; max?: number }} allowedVersion
+ */
+export const conditionalTest = (allowedVersion: { min?: number; max?: number }) => {
+  if (!NODE_VERSION) {
+    return test.skip;
+  }
+
+  return NODE_VERSION < (allowedVersion.min || -Infinity) || NODE_VERSION > (allowedVersion.max || Infinity)
+    ? test.skip
+    : test;
+};
+
 describe('getEventDescription()', () => {
   test('message event', () => {
     expect(
@@ -290,6 +311,10 @@ describe('checkOrSetAlreadyCaught()', () => {
 });
 
 describe('uuid4 generation', () => {
+  afterEach(() => {
+    vi.unstubAllGlobals();
+  });
+
   const uuid4Regex = /^[0-9A-F]{12}[4][0-9A-F]{3}[89AB][0-9A-F]{15}$/i;
   // Jest messes with the global object, so there is no global crypto object in any node version
   // For this reason we need to create our own crypto object for each test to cover all the code paths
@@ -299,45 +324,39 @@ describe('uuid4 generation', () => {
     }
   });
 
-  it('returns valid uuid v4 ids via crypto.getRandomValues', () => {
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
-    const cryptoMod = require('crypto');
-
-    (global as any).crypto = { getRandomValues: cryptoMod.getRandomValues };
+  conditionalTest({ min: 17 })('returns valid uuid v4 ids via crypto.getRandomValues', () => {
+    vi.stubGlobal('crypto', { getRandomValues: (cryptoMod as any).getRandomValues });
 
     for (let index = 0; index < 1_000; index++) {
       expect(uuid4()).toMatch(uuid4Regex);
     }
   });
 
   it('returns valid uuid v4 ids via crypto.randomUUID', () => {
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
-    const cryptoMod = require('crypto');
-
-    (global as any).crypto = { randomUUID: cryptoMod.randomUUID };
+    vi.stubGlobal('crypto', { getRandomValues: cryptoMod.randomUUID });
 
     for (let index = 0; index < 1_000; index++) {
       expect(uuid4()).toMatch(uuid4Regex);
     }
   });
 
   it("return valid uuid v4 even if crypto doesn't exists", () => {
-    (global as any).crypto = { getRandomValues: undefined, randomUUID: undefined };
+    vi.stubGlobal('crypto', { getRandomValues: undefined, randomUUID: undefined });
 
     for (let index = 0; index < 1_000; index++) {
       expect(uuid4()).toMatch(uuid4Regex);
     }
   });
 
   it('return valid uuid v4 even if crypto invoked causes an error', () => {
-    (global as any).crypto = {
+    vi.stubGlobal('crypto', {
       getRandomValues: () => {
         throw new Error('yo');
       },
       randomUUID: () => {
         throw new Error('yo');
       },
-    };
+    });
 
     for (let index = 0; index < 1_000; index++) {
       expect(uuid4()).toMatch(uuid4Regex);
@@ -346,22 +365,22 @@ describe('uuid4 generation', () => {
 
   // Corner case related to crypto.getRandomValues being only
   // semi-implemented (e.g. Chromium 23.0.1235.0 (151422))
-  it('returns valid uuid v4 even if crypto.getRandomValues does not return a typed array', () => {
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
-    const cryptoMod = require('crypto');
-
-    const getRandomValues = (typedArray: Uint8Array) => {
-      if (cryptoMod.getRandomValues) {
-        cryptoMod.getRandomValues(typedArray);
+  conditionalTest({ min: 17 })(
+    'returns valid uuid v4 even if crypto.getRandomValues does not return a typed array',
+    () => {
+      const getRandomValues = (typedArray: Uint8Array) => {
+        if ((cryptoMod as any).getRandomValues) {
+          (cryptoMod as any).getRandomValues(typedArray);
+        }
+      };
+
+      vi.stubGlobal('crypto', { getRandomValues });
+
+      for (let index = 0; index < 1_000; index++) {
+        expect(uuid4()).toMatch(uuid4Regex);
       }
-    };
-
-    (global as any).crypto = { getRandomValues };
-
-    for (let index = 0; index < 1_000; index++) {
-      expect(uuid4()).toMatch(uuid4Regex);
-    }
-  });
+    },
+  );
 });
 
 describe('arrayify()', () => {

packages/utils/test/misc.test.ts

@@ -1,3 +1,5 @@
+import { describe, expect, it } from 'vitest';
+
 import { normalizeUrlToBase } from '../src/normalize';
 
 describe('normalizeUrlToBase()', () => {

packages/utils/test/normalize-url.test.ts

@@ -1,7 +1,9 @@
 /**
- * @jest-environment jsdom
+ * @vitest-environment jsdom
  */
 
+import { describe, expect, test, vi } from 'vitest';
+
 import * as isModule from '../src/is';
 import { normalize } from '../src/normalize';
 import { addNonEnumerableProperty } from '../src/object';
@@ -49,8 +51,8 @@ describe('normalize()', () => {
       });
     });
 
-    describe('extracts data from `Event` objects', () => {
-      const isElement = jest.spyOn(isModule, 'isElement').mockReturnValue(true);
+    test('extracts data from `Event` objects', () => {
+      const isElement = vi.spyOn(isModule, 'isElement').mockReturnValue(true);
       const getAttribute = () => undefined;
 
       const parkElement = { tagName: 'PARK', getAttribute };
@@ -593,7 +595,7 @@ describe('normalize()', () => {
 
   describe('handles serialization errors', () => {
     test('restricts effect of error to problematic node', () => {
-      jest.spyOn(stacktraceModule, 'getFunctionName').mockImplementationOnce(() => {
+      vi.spyOn(stacktraceModule, 'getFunctionName').mockImplementationOnce(() => {
         throw new Error('Nope');
       });