chore(api): Switch to use vitest over jest

.github/workflows/ci.yml

@@ -134,7 +134,7 @@ jobs:
         uses: SimenB/github-actions-cpu-cores@v2
 
       - name: 🧪 Test
-        run: yarn test-ci ${{ steps.cpu-cores.outputs.count }}
+        run: yarn test-ci --minWorkers=1 --maxWorkers=${{ steps.cpu-cores.outputs.count }}
 
   build-lint-test-skip:
     needs: detect-changes

package.json

@@ -34,8 +34,8 @@
     "release:notes": "node ./tasks/release/generateReleaseNotes.mjs",
     "release:triage": "node ./tasks/release/triage/triage.mjs",
     "smoke-tests": "node ./tasks/smoke-tests/smoke-tests.mjs",
-    "test": "nx run-many -t test -- --colors --maxWorkers=4",
-    "test-ci": "nx run-many -t test -- --colors --maxWorkers",
+    "test": "nx run-many -t test -- --minWorkers=1 --maxWorkers=4",
+    "test-ci": "nx run-many -t test",
     "test:k6": "tsx ./tasks/k6-test/run-k6-tests.mts",
     "test:types": "tstyche"
   },

packages/api/package.json

@@ -28,8 +28,8 @@
     "build:types": "tsc --build --verbose",
     "build:watch": "nodemon --watch src --ext \"js,jsx,ts,tsx\" --ignore dist --exec \"yarn build\"",
     "prepublishOnly": "NODE_ENV=production yarn build",
-    "test": "jest src",
-    "test:watch": "yarn test --watch"
+    "test": "vitest run src",
+    "test:watch": "vitest watch src"
   },
   "dependencies": {
     "@babel/runtime-corejs3": "7.23.6",
@@ -50,12 +50,12 @@
     "@types/memjs": "1",
     "@types/pascalcase": "1.0.3",
     "@types/split2": "4.2.3",
-    "jest": "29.7.0",
     "memjs": "1.3.1",
     "redis": "4.6.7",
     "split2": "4.2.0",
     "ts-toolbelt": "9.6.0",
-    "typescript": "5.3.3"
+    "typescript": "5.3.3",
+    "vitest": "1.2.1"
   },
   "peerDependencies": {
     "memjs": "1.3.1",

packages/api/src/__tests__/normalizeRequest.test.ts

@@ -1,5 +1,6 @@
 import { Headers } from '@whatwg-node/fetch'
 import type { APIGatewayProxyEvent } from 'aws-lambda'
+import { test, expect } from 'vitest'
 
 import { normalizeRequest } from '../transforms'
 

packages/api/src/__tests__/transforms.test.ts

@@ -1,3 +1,5 @@
+import { describe, it, expect } from 'vitest'
+
 import { removeNulls } from '../transforms'
 
 describe('removeNulls utility', () => {

packages/api/src/auth/__tests__/getAuthenticationContext.test.ts

@@ -1,4 +1,5 @@
 import type { APIGatewayProxyEvent, Context } from 'aws-lambda'
+import { describe, it, expect } from 'vitest'
 
 import { getAuthenticationContext } from '../index'
 

packages/api/src/auth/__tests__/parseJWT.test.ts

@@ -1,3 +1,5 @@
+import { describe, test, expect } from 'vitest'
+
 import { parseJWT } from '../parseJWT'
 
 const JWT_CLAIMS: Record<string, unknown> = {

packages/api/src/auth/verifiers/__tests__/base64Sha1Verifier.test.ts

@@ -1,3 +1,5 @@
+import { describe, test, expect } from 'vitest'
+
 import { createVerifier, WebhookVerificationError } from '../index'
 
 const stringPayload = 'No more secrets, Marty.'

packages/api/src/auth/verifiers/__tests__/base64Sha256Verifier.test.ts

@@ -1,3 +1,5 @@
+import { describe, test, expect } from 'vitest'
+
 import { createVerifier, WebhookVerificationError } from '../index'
 
 const stringPayload = 'No more secrets, Marty.'

packages/api/src/auth/verifiers/__tests__/jwtVerifier.test.ts

@@ -1,3 +1,5 @@
+import { describe, test, expect } from 'vitest'
+
 import {
   createVerifier,
   WebhookSignError,

packages/api/src/auth/verifiers/__tests__/secretKeyVerifier.test.ts

@@ -1,3 +1,5 @@
+import { beforeEach, afterEach, describe, test, vi, expect } from 'vitest'
+
 import { createVerifier, WebhookVerificationError } from '../index'
 
 const payload = 'No more secrets, Marty.'
@@ -6,11 +8,11 @@ const secret = 'MY_VOICE_IS_MY_PASSPORT_VERIFY_ME'
 const { sign, verify } = createVerifier('secretKeyVerifier')
 
 beforeEach(() => {
-  jest.spyOn(console, 'warn').mockImplementation(jest.fn())
+  vi.spyOn(console, 'warn').mockImplementation(vi.fn())
 })
 
 afterEach(() => {
-  jest.spyOn(console, 'warn').mockRestore()
+  vi.spyOn(console, 'warn').mockRestore()
 })
 
 describe('secretKey verifier', () => {
@@ -21,10 +23,10 @@ describe('secretKey verifier', () => {
     })
 
     test('it verifies that the secret and signature are identical', () => {
-      jest.spyOn(console, 'warn').mockImplementation(jest.fn())
+      vi.spyOn(console, 'warn').mockImplementation(vi.fn())
       const signature = sign({ payload, secret })
       expect(verify({ payload, secret, signature })).toBeTruthy()
-      jest.spyOn(console, 'warn').mockRestore()
+      vi.spyOn(console, 'warn').mockRestore()
     })
 
     test('it denies verification if the secret and signature are not the same', () => {

packages/api/src/auth/verifiers/__tests__/sha1Verifier.test.ts

@@ -1,3 +1,5 @@
+import { describe, test, expect } from 'vitest'
+
 import { createVerifier, WebhookVerificationError } from '../index'
 
 const stringPayload = 'No more secrets, Marty.'

packages/api/src/auth/verifiers/__tests__/sha256Verifier.test.ts

@@ -1,3 +1,5 @@
+import { describe, expect, test } from 'vitest'
+
 import { createVerifier, WebhookVerificationError } from '../index'
 
 const stringPayload = 'No more secrets, Marty.'

packages/api/src/auth/verifiers/__tests__/skipVerifier.test.ts

@@ -1,3 +1,5 @@
+import { beforeEach, afterEach, describe, test, expect, vi } from 'vitest'
+
 import { createVerifier } from '../index'
 
 const payload = 'No more secrets, Marty.'
@@ -6,11 +8,11 @@ const secret = 'MY_VOICE_IS_MY_PASSPORT_VERIFY_ME'
 const { sign, verify } = createVerifier('skipVerifier')
 
 beforeEach(() => {
-  jest.spyOn(console, 'warn').mockImplementation(jest.fn())
+  vi.spyOn(console, 'warn').mockImplementation(vi.fn())
 })
 
 afterEach(() => {
-  jest.spyOn(console, 'warn').mockRestore()
+  vi.spyOn(console, 'warn').mockRestore()
 })
 
 describe('skips verification verifier', () => {

packages/api/src/auth/verifiers/__tests__/timestampSchemeVerifier.test.ts

@@ -1,5 +1,7 @@
 // import type { APIGatewayProxyEvent } from 'aws-lambda'
 
+import { describe, test, expect } from 'vitest'
+
 import { createVerifier, WebhookVerificationError } from '../index'
 
 const payload = 'No more secrets, Marty.'

packages/api/src/cache/__tests__/cache.test.ts

@@ -1,3 +1,5 @@
+import { describe, it, expect } from 'vitest'
+
 import InMemoryClient from '../clients/InMemoryClient'
 import { createCache } from '../index'
 

packages/api/src/cache/__tests__/cacheFindMany.test.ts

@@ -1,23 +1,26 @@
 import { PrismaClient } from '@prisma/client'
+import { describe, afterEach, it, vi, expect } from 'vitest'
 
 import InMemoryClient from '../clients/InMemoryClient'
 import { createCache } from '../index'
 
-const mockFindFirst = jest.fn()
-const mockFindMany = jest.fn()
+const mockFindFirst = vi.fn()
+const mockFindMany = vi.fn()
 
-jest.mock('@prisma/client', () => ({
-  PrismaClient: jest.fn(() => ({
+vi.mock('@prisma/client', () => ({
+  PrismaClient: vi.fn(() => ({
     user: {
       findFirst: mockFindFirst,
       findMany: mockFindMany,
     },
   })),
+  // NOTE: This is only available after `prisma generate` has been run
+  PrismaClientValidationError: new Error('PrismaClientValidationError'),
 }))
 
 describe('cacheFindMany', () => {
   afterEach(() => {
-    jest.clearAllMocks()
+    vi.clearAllMocks()
   })
 
   it('adds the collection to the cache based on latest updated user', async () => {
@@ -33,7 +36,7 @@ describe('cacheFindMany', () => {
 
     const client = new InMemoryClient()
     const { cacheFindMany } = createCache(client)
-    const spy = jest.spyOn(client, 'set')
+    const spy = vi.spyOn(client, 'set')
 
     await cacheFindMany('test', PrismaClient().user)
 
@@ -66,7 +69,7 @@ describe('cacheFindMany', () => {
     mockFindMany.mockImplementation(() => [user])
 
     const { cacheFindMany } = createCache(client)
-    const spy = jest.spyOn(client, 'set')
+    const spy = vi.spyOn(client, 'set')
 
     await cacheFindMany('test', PrismaClient().user)
 
@@ -86,8 +89,8 @@ describe('cacheFindMany', () => {
     mockFindFirst.mockImplementation(() => null)
     mockFindMany.mockImplementation(() => [])
     const { cacheFindMany } = createCache(client)
-    const getSpy = jest.spyOn(client, 'get')
-    const setSpy = jest.spyOn(client, 'set')
+    const getSpy = vi.spyOn(client, 'get')
+    const setSpy = vi.spyOn(client, 'set')
 
     const result = await cacheFindMany('test', PrismaClient().user)
 

packages/api/src/cache/__tests__/deleteCacheKey.test.js

@@ -1,3 +1,5 @@
+import { describe, it, expect } from 'vitest'
+
 import InMemoryClient from '../clients/InMemoryClient'
 import { createCache } from '../index'
 

packages/api/src/cache/__tests__/disconnect.test.ts

@@ -1,20 +1,22 @@
+import { describe, beforeEach, it, expect, vi } from 'vitest'
+
 import InMemoryClient from '../clients/InMemoryClient'
 import { CacheTimeoutError } from '../errors'
 import { createCache } from '../index'
 
 describe('client.disconnect', () => {
   beforeEach(() => {
-    jest.clearAllMocks()
+    vi.clearAllMocks()
   })
 
   it('attempts to disconnect on timeout error', async () => {
     const client = new InMemoryClient()
     const { cache } = createCache(client)
-    const getSpy = jest.spyOn(client, 'get')
+    const getSpy = vi.spyOn(client, 'get')
     getSpy.mockImplementation(() => {
       throw new CacheTimeoutError()
     })
-    const disconnectSpy = jest.spyOn(client, 'disconnect')
+    const disconnectSpy = vi.spyOn(client, 'disconnect')
 
     await cache('test', () => {
       return { bar: 'baz' }

packages/api/src/cache/__tests__/shared.test.ts

@@ -1,3 +1,5 @@
+import { describe, it, expect } from 'vitest'
+
 import { createCache, formatCacheKey, InMemoryClient } from '../index'
 
 describe('exports', () => {

packages/api/src/logger/logger.test.ts

@@ -3,6 +3,7 @@ import os from 'os'
 import { join } from 'path'
 
 import split from 'split2'
+import { describe, test, expect } from 'vitest'
 
 const pid = process.pid
 const hostname = os.hostname()

packages/api/src/validations/__tests__/validations.test.js

@@ -1,3 +1,5 @@
+import { describe, it, expect, vi, beforeEach } from 'vitest'
+
 import * as ValidationErrors from '../errors'
 import {
   validate,
@@ -1153,7 +1155,7 @@ describe('validate', () => {
 
 describe('validateWithSync', () => {
   it('runs a custom function as a validation', () => {
-    const validateFunction = jest.fn()
+    const validateFunction = vi.fn()
     validateWithSync(validateFunction)
 
     expect(validateFunction).toBeCalledWith()
@@ -1186,7 +1188,7 @@ describe('validateWithSync', () => {
 
 describe('validateWith', () => {
   it('runs a custom function as a validation', () => {
-    const validateFunction = jest.fn()
+    const validateFunction = vi.fn()
     validateWith(validateFunction)
 
     expect(validateFunction).toBeCalledWith()
@@ -1220,9 +1222,9 @@ describe('validateWith', () => {
 // the actual methods of an instance of the class
 //
 // mockFindFirst.mockImplementation() to change what `findFirst()` would return
-const mockFindFirst = jest.fn()
-jest.mock('@prisma/client', () => ({
-  PrismaClient: jest.fn(() => ({
+const mockFindFirst = vi.fn()
+vi.mock('@prisma/client', () => ({
+  PrismaClient: vi.fn(() => ({
     $transaction: async (func) =>
       func({
         user: {
@@ -1309,7 +1311,7 @@ describe('validateUniqueness', () => {
   })
 
   it('uses the given prisma client', async () => {
-    const mockFindFirstOther = jest.fn()
+    const mockFindFirstOther = vi.fn()
     mockFindFirstOther.mockImplementation(() => ({
       id: 2,
       email: 'rob@redwoodjs.com',

packages/api/src/webhooks/webhooks.test.ts

@@ -1,4 +1,5 @@
 import type { APIGatewayProxyEvent } from 'aws-lambda'
+import { beforeEach, afterEach, describe, test, expect, vi } from 'vitest'
 
 import {
   signPayload,
@@ -44,11 +45,11 @@ const buildEvent = ({
 }
 
 beforeEach(() => {
-  jest.spyOn(console, 'warn').mockImplementation(jest.fn())
+  vi.spyOn(console, 'warn').mockImplementation(vi.fn())
 })
 
 afterEach(() => {
-  jest.spyOn(console, 'warn').mockRestore()
+  vi.spyOn(console, 'warn').mockRestore()
 })
 
 describe('webhooks', () => {

packages/api/vitest.config.mts

@@ -0,0 +1,13 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    sequence: {
+      hooks: 'list',
+    },
+    setupFiles: [
+      './vitest.setup.mts'
+    ],
+    logHeapUsage: true,
+  },
+})

packages/api/jest.config.js → packages/api/vitest.setup.mts

@@ -1,5 +1,4 @@
-module.exports = {}
-
+// Set the default webhook secret for all tests
 process.env = Object.assign(process.env, {
   WEBHOOK_SECRET: 'MY_VOICE_IS_MY_PASSPORT_VERIFY_ME',
 })