chore(test): move @sanity/migrate to vitest

Author: bjoerge

packages/@sanity/migrate/.eslintrc.cjs

@@ -1,6 +1,4 @@
-'use strict'
-
-const path = require('path')
+const path = require('node:path')
 
 const ROOT_PATH = path.resolve(__dirname, '../../..')
 

packages/@sanity/migrate/jest.config.cjs

@@ -46,7 +46,7 @@
     "clean": "rimraf lib coverage",
     "lint": "eslint .",
     "prepublishOnly": "turbo run build",
-    "test": "jest",
+    "test": "vitest",
     "watch": "pkg-utils watch"
   },
   "dependencies": {
@@ -61,11 +61,12 @@
     "p-map": "^7.0.1"
   },
   "devDependencies": {
-    "@jest/globals": "^29.7.0",
     "@repo/package.config": "workspace:*",
+    "@repo/test-config": "workspace:*",
     "@types/arrify": "^2.0.1",
     "@types/debug": "^4.1.12",
-    "rimraf": "^3.0.2"
+    "rimraf": "^3.0.2",
+    "vitest": "^2.1.1"
   },
   "engines": {
     "node": ">=18"

packages/@sanity/migrate/package.json

@@ -1,4 +1,4 @@
-import {expect, test} from '@jest/globals'
+import {expect, test} from 'vitest'
 
 import {assert2xx} from '../fetchStream'
 
@@ -25,10 +25,12 @@ test('server responds with 4xx and error response', () => {
         message: 'More details',
       }),
   }
-  expect(assert2xx(mockResponse as unknown as Response)).rejects.toThrowError({
-    statusCode: 400,
-    message: 'Error message: More details',
-  })
+  expect(assert2xx(mockResponse as unknown as Response)).rejects.toThrowError(
+    expect.objectContaining({
+      statusCode: 400,
+      message: 'Error message: More details',
+    }),
+  )
 })
 
 test('server responds with 5xx and no json response', () => {
@@ -37,10 +39,12 @@ test('server responds with 5xx and no json response', () => {
     statusText: 'Internal Server Error',
     json: () => Promise.reject(new Error('Failed to parse JSON')),
   }
-  expect(assert2xx(mockResponse as unknown as Response)).rejects.toThrowError({
-    statusCode: 500,
-    message: 'HTTP Error 500: Internal Server Error',
-  })
+  expect(assert2xx(mockResponse as unknown as Response)).rejects.toThrowError(
+    expect.objectContaining({
+      statusCode: 500,
+      message: 'HTTP Error 500: Internal Server Error',
+    }),
+  )
 })
 
 test('server responds with 5xx and json response', () => {
@@ -56,8 +60,10 @@ test('server responds with 5xx and json response', () => {
         status: 500,
       }),
   }
-  expect(assert2xx(mockResponse as unknown as Response)).rejects.toThrowError({
-    statusCode: 500,
-    message: 'validationError: Document is not of valid type',
-  })
+  expect(assert2xx(mockResponse as unknown as Response)).rejects.toThrowError(
+    expect.objectContaining({
+      statusCode: 500,
+      message: 'validationError: Document is not of valid type',
+    }),
+  )
 })

packages/@sanity/migrate/src/fetch-utils/__test__/assert2xx.test.ts

@@ -2,7 +2,7 @@
 import {stat} from 'node:fs/promises'
 import path from 'node:path'
 
-import {describe, expect, test} from '@jest/globals'
+import {describe, expect, test} from 'vitest'
 
 import {decodeText, parse} from '../../it-utils'
 import {firstValueFrom} from '../../it-utils/firstValueFrom'
@@ -200,7 +200,7 @@ describe('using secondary stream', () => {
     await expect(() =>
       lastValueFrom(parse(decodeText(streamToAsyncIterator(createReader())))),
     ).rejects.toThrowErrorMatchingInlineSnapshot(
-      `"Cannot create new buffered readers on aborted stream"`,
+      `[Error: Cannot create new buffered readers on aborted stream]`,
     )
   })
 })

packages/@sanity/migrate/src/fs-webstream/__test__/bufferThroughFile.test.ts

@@ -1,4 +1,4 @@
-import {expect, test} from '@jest/globals'
+import {expect, test} from 'vitest'
 
 import {decodeText} from '../decodeText'
 import {toArray} from '../toArray'

packages/@sanity/migrate/src/it-utils/__test__/decodeText.test.ts

@@ -1,4 +1,4 @@
-import {expect, test} from '@jest/globals'
+import {expect, test} from 'vitest'
 
 import {parseJSON} from '../json'
 

packages/@sanity/migrate/src/it-utils/__test__/json.test.ts

@@ -1,4 +1,4 @@
-import {expect, test} from '@jest/globals'
+import {expect, test} from 'vitest'
 
 import {split} from '../split'
 

packages/@sanity/migrate/src/it-utils/__test__/split.test.ts

@@ -1,4 +1,4 @@
-import {expect, test} from '@jest/globals'
+import {expect, test} from 'vitest'
 
 import {at, create, createIfNotExists, createOrReplace, del, patch} from '../creators'
 import {inc, insert, set, setIfMissing, unset} from '../operations/creators'

packages/@sanity/migrate/src/mutations/__tests__/mutate.test.ts

@@ -1,13 +1,8 @@
-import {describe, expect, it, jest} from '@jest/globals'
 import {type SanityDocument} from '@sanity/types'
+import {describe, expect, it, vitest} from 'vitest'
 
 import {createIfNotExists} from '../../mutations'
-import {
-  type DocumentMigrationReturnValue,
-  type Migration,
-  type MigrationContext,
-  type NodeMigration,
-} from '../../types'
+import {type Migration, type MigrationContext, type NodeMigration} from '../../types'
 import {
   createAsyncIterableMutation,
   normalizeMigrateDefinition,
@@ -43,7 +38,7 @@ describe('#normalizeMigrateDefinition', () => {
     const result = normalizeMigrateDefinition(mockMigration)
 
     const res = []
-    for await (const item of result(jest.fn() as any, {} as any)) {
+    for await (const item of result(vitest.fn(), {} as any)) {
       res.push(item)
     }
 
@@ -96,7 +91,7 @@ describe('#normalizeMigrateDefinition', () => {
 describe('#createAsyncIterableMutation', () => {
   it('should return an async iterable', async () => {
     const mockMigration: NodeMigration = {
-      document: jest.fn<() => DocumentMigrationReturnValue>(),
+      document: vitest.fn(),
     }
 
     const iterable = createAsyncIterableMutation(mockMigration, {documentTypes: ['foo']})

packages/@sanity/migrate/src/runner/__tests__/normalizeMigrationDefinition.test.ts

@@ -1,4 +1,4 @@
-import {describe, expect, test} from '@jest/globals'
+import {describe, expect, test} from 'vitest'
 
 import {toArray} from '../../../it-utils'
 import {batchMutations} from '../batchMutations'

packages/@sanity/migrate/src/runner/utils/__tests__/batchMutations.test.ts

@@ -1,29 +1,27 @@
 /* eslint-disable simple-import-sort/imports */
 // Note: for some reason, this needs to be imported before the mocked module
-import {afterEach, describe, expect, it, jest} from '@jest/globals'
+import {afterEach, describe, expect, it, vitest} from 'vitest'
 /* eslint-enable simple-import-sort/imports */
 
 import {SanityEncoder} from '@sanity/mutate'
 
 import {type Mutation, type Transaction} from '../../../mutations'
 import {toSanityMutations, type TransactionPayload} from '../toSanityMutations'
 
-jest.mock('@sanity/mutate', () => {
+vitest.mock('@sanity/mutate', async () => {
   // eslint-disable-next-line @typescript-eslint/consistent-type-imports
-  const actual = jest.requireActual<typeof import('@sanity/mutate')>('@sanity/mutate')
+  const actual = await vitest.importActual<typeof import('@sanity/mutate')>('@sanity/mutate')
   return {
     ...actual,
     SanityEncoder: {
       ...actual.SanityEncoder,
-      encodeAll: jest
-        .fn<typeof actual.SanityEncoder.encodeAll>()
-        .mockImplementation(actual.SanityEncoder.encodeAll),
+      encodeAll: vitest.fn().mockImplementation(actual.SanityEncoder.encodeAll),
     },
   }
 })
 
 afterEach(() => {
-  jest.clearAllMocks()
+  vitest.clearAllMocks()
 })
 
 describe('#toSanityMutations', () => {

packages/@sanity/migrate/src/runner/utils/__tests__/toSanityMutations.test.ts

@@ -1,4 +1,4 @@
-import {expect, test} from '@jest/globals'
+import {expect, test} from 'vitest'
 
 import {decodeText, parse, toArray} from '../../it-utils'
 import {fromExportArchive} from '../fromExportArchive'

packages/@sanity/migrate/src/sources/__test__/fromExportArchive.test.ts

@@ -1,4 +1,4 @@
-import {expect, test} from '@jest/globals'
+import {expect, test} from 'vitest'
 
 import {readFileAsWebStream} from '../../fs-webstream/readFileAsWebStream'
 import {streamToAsyncIterator} from '../../utils/streamToAsyncIterator'
@@ -19,7 +19,7 @@ test('untar an empty tar file', async () => {
       }
     }
   }).rejects.toThrowErrorMatchingInlineSnapshot(
-    `"Unexpected end of tar file. Expected 512 bytes of headers."`,
+    `[Error: Unexpected end of tar file. Expected 512 bytes of headers.]`,
   )
 })
 
@@ -31,7 +31,7 @@ test('untar an invalid tar file of > 512b', async () => {
       }
     }
   }).rejects.toThrowErrorMatchingInlineSnapshot(
-    `"Invalid tar header. Maybe the tar is corrupted or it needs to be gunzipped?"`,
+    `[Error: Invalid tar header. Maybe the tar is corrupted or it needs to be gunzipped?]`,
   )
 })
 
@@ -43,6 +43,6 @@ test('untar a corrupted tar file', async () => {
       }
     }
   }).rejects.toThrowErrorMatchingInlineSnapshot(
-    `"Invalid tar header. Maybe the tar is corrupted or it needs to be gunzipped?"`,
+    `[Error: Invalid tar header. Maybe the tar is corrupted or it needs to be gunzipped?]`,
   )
 })

packages/@sanity/migrate/src/tar-webstream/__test__/invalid.test.ts

@@ -1,4 +1,4 @@
-import {expect, test} from '@jest/globals'
+import {expect, test} from 'vitest'
 
 import {readFileAsWebStream} from '../../fs-webstream/readFileAsWebStream'
 import {toArray} from '../../it-utils/toArray'

packages/@sanity/migrate/src/tar-webstream/__test__/movies.test.ts

@@ -1,4 +1,4 @@
-import {expect, test} from '@jest/globals'
+import {expect, test} from 'vitest'
 
 import {readFileAsWebStream} from '../../fs-webstream/readFileAsWebStream'
 import {decodeText} from '../../it-utils/decodeText'

packages/@sanity/migrate/src/tar-webstream/__test__/small.test.ts

@@ -0,0 +1,13 @@
+import {getViteAliases} from '@repo/dev-aliases/vitest'
+import {configDefaults, defineConfig} from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    alias: getViteAliases(),
+    typecheck: {
+      exclude: [...(configDefaults.typecheck?.exclude || []), '.tmp/**', './lib/**'],
+    },
+    exclude: [...configDefaults.exclude, '.tmp/**', './lib/**'],
+    includeSource: ['./src/**/*.ts'],
+  },
+})