Switch tester to Vitest

flevi29 · flevi29 · commit df3ae9f70b29 · 2025-01-20T11:04:58.000+02:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -37,7 +37,7 @@ yarn --dev
 Each PR should pass the tests and the linter to be accepted.
 
 ```bash
-# Tests with Jest
+# Tests with Vitest
 docker pull getmeili/meilisearch:latest # Fetch the latest version of Meilisearch image from Docker Hub
 docker run -p 7700:7700 getmeili/meilisearch:latest meilisearch --master-key=masterKey --no-analytics
 # Integration tests
diff --git a/package.json b/package.json
@@ -23,19 +23,17 @@
     "lint": "turbo lint",
     "lint:fix": "turbo lint:fix",
     "build": "turbo run build",
-    "test": "turbo test",
-    "test:watch": "turbo run test:watch",
-    "instant-meilisearch:test:watch": "yarn --cwd ./packages/instant-meilisearch test:watch",
-    "autocomplete:test:watch": "yarn --cwd ./packages/autocomplete-client test:watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "instant-meilisearch:test:watch": "vitest --project \"@meilisearch/instant-meilisearch\"",
+    "autocomplete:test:watch": "vitest --project \"@meilisearch/autocomplete-client\"",
     "test:types": "turbo run test:types",
     "version-packages": "changeset version && turbo version",
     "release": "yarn build && changeset publish"
   },
   "devDependencies": {
+    "vitest": "^3.0.2",
     "@testing-library/dom": "^9.2.0",
-    "@testing-library/jest-dom": "^5.16.5",
-    "@types/jest": "^29.5.1",
-    "@types/jest-diff": "^24.3.0",
     "parcel": "^2.12.0",
     "turbo": "^2.1.3"
   },
diff --git a/packages/autocomplete-client/jest.config.js b/packages/autocomplete-client/jest.config.js
diff --git a/packages/autocomplete-client/package.json b/packages/autocomplete-client/package.json
@@ -8,10 +8,7 @@
     "access": "public"
   },
   "scripts": {
-    "clear_jest": "jest --clearCache",
     "cleanup": "shx rm -rf dist/",
-    "test:watch": "yarn test --watchAll",
-    "test": "jest --runInBand --selectProjects dom --selectProjects node",
     "build": "yarn cleanup && rollup -c rollup.config.js && rollup --environment NODE_ENV:production -c rollup.config.js",
     "dev": "rollup -c rollup.config.js --watch",
     "lint": "eslint --ext .js,.ts,.tsx .",
@@ -56,22 +53,17 @@
     "@babel/preset-env": "^7.20.2",
     "@rollup/plugin-commonjs": "^17.1.0",
     "@rollup/plugin-node-resolve": "^11.2.0",
-    "@types/jest": "^27.0.2",
-    "babel-jest": "^27.2.2",
     "concurrently": "^7.1.0",
     "cssnano": "^4.1.10",
     "eslint-config-meilisearch": "*",
     "instantsearch.js": "^4.56.2",
-    "jest": "^27.2.2",
-    "jest-watch-typeahead": "^0.6.3",
     "regenerator-runtime": "^0.13.7",
     "rollup": "^2.79.2",
     "rollup-plugin-babel": "^4.4.0",
     "rollup-plugin-node-polyfills": "^0.2.1",
     "rollup-plugin-terser": "^7.0.0",
     "rollup-plugin-typescript2": "^0.32.1",
     "shx": "^0.3.4",
-    "ts-jest": "^27.0.7",
     "tslib": "^2.6.1",
     "typescript": "^4.9.3"
   }
diff --git a/packages/autocomplete-client/src/requesters/__tests__/getmeilisearchResults.test.ts b/packages/autocomplete-client/src/requesters/__tests__/getmeilisearchResults.test.ts
@@ -1,3 +1,4 @@
+import { describe, test, expect } from 'vitest'
 import { getMeilisearchResults } from '../'
 import { searchClient } from '../../../__tests__/test.utils'
 
diff --git a/packages/autocomplete-client/src/search/__tests__/fetchMeilisearchResults.test.ts b/packages/autocomplete-client/src/search/__tests__/fetchMeilisearchResults.test.ts
@@ -1,3 +1,4 @@
+import { describe, beforeAll, test, expect, afterAll } from 'vitest'
 import { fetchMeilisearchResults } from '../fetchMeilisearchResults'
 import {
   searchClient,
diff --git a/packages/autocomplete-client/vitest.config.ts b/packages/autocomplete-client/vitest.config.ts
@@ -0,0 +1,8 @@
+import { defineProject } from 'vitest/config'
+
+export default defineProject({
+  test: {
+    include: ['{src,__tests__}/**/*.test.ts'],
+    testTimeout: 100_000, // 100 seconds
+  },
+})
diff --git a/packages/eslint-config-meilisearch/index.js b/packages/eslint-config-meilisearch/index.js
@@ -12,7 +12,6 @@ module.exports = {
         commonjs: true, // Needed to avoid import is reserved error
         node: true,
         browser: true,
-        jest: true,
       },
       parser: 'babel-eslint',
       extends: [
@@ -46,25 +45,18 @@ module.exports = {
       env: {
         browser: true,
         es2020: true,
-        'jest/globals': true,
         node: true,
-        jasmine: true,
       },
       globals: {
         instantsearch: true,
         instantMeiliSearch: true,
-        page: true, // for jest/puppeteer tests in tests/env/express
-        browser: true, // for jest/puppeteer tests in tests/env/express
-        context: true, // for jest/puppeteer tests in tests/env/express
-        jestPuppeteer: true, // for jest/puppeteer tests in tests/env/express
       },
       extends: [
         'standard',
         'plugin:prettier/recommended',
         'eslint:recommended',
         'plugin:cypress/recommended',
       ],
-      plugins: ['jest'],
       parserOptions: {
         ecmaVersion: 2020,
       },
@@ -111,14 +103,6 @@ module.exports = {
       env: {
         browser: true,
         es2020: true,
-        'jest/globals': true,
-        jasmine: true,
-      },
-      globals: {
-        page: true, // for jest/puppeteer tests in tests/env/express
-        browser: true, // for jest/puppeteer tests in tests/env/express
-        context: true, // for jest/puppeteer tests in tests/env/express
-        jestPuppeteer: true, // for jest/puppeteer tests in tests/env/express
       },
       extends: [
         'standard',
@@ -134,7 +118,7 @@ module.exports = {
         projectFolderIgnoreList: ['dist'],
       },
 
-      plugins: ['jsdoc', '@typescript-eslint', 'jest'],
+      plugins: ['jsdoc', '@typescript-eslint'],
       rules: {
         '@typescript-eslint/no-empty-interface': 'off', // Due to vue-instantsearch not having typings
         'no-dupe-class-members': 'off', // Off due to conflict with typescript overload functions
diff --git a/packages/eslint-config-meilisearch/package.json b/packages/eslint-config-meilisearch/package.json
@@ -18,7 +18,6 @@
     "eslint-config-standard": "^17.0.0",
     "eslint-plugin-cypress": "^2.11.3",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jest": "^24.1.5",
     "eslint-plugin-jsdoc": "^32.2.0",
     "eslint-plugin-n": "^15.6.1",
     "eslint-plugin-prettier": "^4.2.1",
diff --git a/packages/instant-meilisearch/__tests__/configure.attributes-to-retrieve.test.ts b/packages/instant-meilisearch/__tests__/configure.attributes-to-retrieve.test.ts
@@ -1,3 +1,4 @@
+import { describe, beforeAll, test, expect } from 'vitest'
 import {
   searchClient,
   dataset,
diff --git a/packages/instant-meilisearch/__tests__/custom-http-client.test.ts b/packages/instant-meilisearch/__tests__/custom-http-client.test.ts
@@ -1,3 +1,4 @@
+import { describe, beforeAll, test, expect } from 'vitest'
 import { instantMeiliSearch } from '../src'
 import { meilisearchClient, dataset } from './assets/utils'
 
diff --git a/packages/instant-meilisearch/__tests__/disjunctive-facet-search.test.ts b/packages/instant-meilisearch/__tests__/disjunctive-facet-search.test.ts
@@ -1,3 +1,4 @@
+import { describe, beforeAll, test, expect } from 'vitest'
 import { instantMeiliSearch } from '../src'
 import { Movies, meilisearchClient } from './assets/utils'
 import movies from './assets/movies.json'
diff --git a/packages/instant-meilisearch/__tests__/facet-stats.test.ts b/packages/instant-meilisearch/__tests__/facet-stats.test.ts
@@ -1,3 +1,4 @@
+import { describe, beforeAll, test, expect } from 'vitest'
 import { searchClient, dataset, meilisearchClient } from './assets/utils'
 
 describe('Facet stats tests', () => {
diff --git a/packages/instant-meilisearch/__tests__/facets-distribution.test.ts b/packages/instant-meilisearch/__tests__/facets-distribution.test.ts
@@ -1,3 +1,4 @@
+import { describe, beforeAll, test, expect } from 'vitest'
 import { searchClient, dataset, meilisearchClient } from './assets/utils'
 
 describe('Instant Meilisearch Browser test', () => {
diff --git a/packages/instant-meilisearch/__tests__/filter.test.ts b/packages/instant-meilisearch/__tests__/filter.test.ts
@@ -1,3 +1,4 @@
+import { describe, beforeAll, test, expect } from 'vitest'
 import {
   searchClient,
   dataset,
diff --git a/packages/instant-meilisearch/__tests__/first-facets-distribution.test.ts b/packages/instant-meilisearch/__tests__/first-facets-distribution.test.ts
@@ -1,3 +1,4 @@
+import { describe, beforeAll, test, expect } from 'vitest'
 import { dataset, meilisearchClient, HOST, API_KEY } from './assets/utils'
 import { instantMeiliSearch } from '../src'
 
diff --git a/packages/instant-meilisearch/__tests__/geosearch.test.ts b/packages/instant-meilisearch/__tests__/geosearch.test.ts
@@ -1,3 +1,4 @@
+import { describe, beforeAll, test, expect } from 'vitest'
 import {
   searchClient,
   geoDataset,
diff --git a/packages/instant-meilisearch/__tests__/highlight.test.ts b/packages/instant-meilisearch/__tests__/highlight.test.ts
@@ -1,3 +1,4 @@
+import { describe, beforeAll, test, expect } from 'vitest'
 import {
   searchClient,
   dataset,
diff --git a/packages/instant-meilisearch/__tests__/instantiation.test.ts b/packages/instant-meilisearch/__tests__/instantiation.test.ts
@@ -1,3 +1,4 @@
+import { describe, test, expect } from 'vitest'
 import { instantMeiliSearch } from '../src'
 
 describe('InstantMeiliSearch instantiation', () => {
diff --git a/packages/instant-meilisearch/__tests__/multi-index-search.test.ts b/packages/instant-meilisearch/__tests__/multi-index-search.test.ts
@@ -1,3 +1,4 @@
+import { describe, beforeAll, test, expect } from 'vitest'
 import { instantMeiliSearch } from '../src'
 import { Movies, meilisearchClient } from './assets/utils'
 import movies from './assets/movies.json'
diff --git a/packages/instant-meilisearch/__tests__/overridden-meilisearch-parameters.test.ts b/packages/instant-meilisearch/__tests__/overridden-meilisearch-parameters.test.ts
@@ -1,3 +1,4 @@
+import { describe, beforeAll, test, expect } from 'vitest'
 import { instantMeiliSearch } from '../src'
 import { dataset, meilisearchClient, Movies } from './assets/utils'
 
diff --git a/packages/instant-meilisearch/__tests__/pagination.test.ts b/packages/instant-meilisearch/__tests__/pagination.test.ts
@@ -1,3 +1,4 @@
+import { describe, beforeAll, test, expect } from 'vitest'
 import {
   searchClient,
   dataset,
diff --git a/packages/instant-meilisearch/__tests__/placeholder-search.test.ts b/packages/instant-meilisearch/__tests__/placeholder-search.test.ts
@@ -1,3 +1,4 @@
+import { describe, beforeAll, test, expect } from 'vitest'
 import { instantMeiliSearch } from '../src'
 import { dataset, Movies, meilisearchClient } from './assets/utils'
 
diff --git a/packages/instant-meilisearch/__tests__/search-resolver.test.ts b/packages/instant-meilisearch/__tests__/search-resolver.test.ts
@@ -1,3 +1,4 @@
+import { describe, afterEach, test, expect } from 'vitest'
 import { Movies } from './assets/utils'
 import { instantMeiliSearch } from '../src'
 import { MeiliSearch } from 'meilisearch'
diff --git a/packages/instant-meilisearch/__tests__/snippets.test.ts b/packages/instant-meilisearch/__tests__/snippets.test.ts
@@ -1,3 +1,4 @@
+import { describe, beforeAll, test, expect } from 'vitest'
 import {
   searchClient,
   dataset,
diff --git a/packages/instant-meilisearch/__tests__/sort.test.ts b/packages/instant-meilisearch/__tests__/sort.test.ts
@@ -1,3 +1,4 @@
+import { describe, beforeAll, test, expect } from 'vitest'
 import {
   searchClient,
   dataset,
diff --git a/packages/instant-meilisearch/jest.config.js b/packages/instant-meilisearch/jest.config.js
diff --git a/packages/instant-meilisearch/package.json b/packages/instant-meilisearch/package.json
@@ -25,10 +25,7 @@
     "client"
   ],
   "scripts": {
-    "clear_jest": "jest --clearCache",
     "cleanup": "shx rm -rf dist/",
-    "test:watch": "yarn test --watchAll",
-    "test": "jest --runInBand --selectProjects dom --selectProjects node",
     "build": "yarn cleanup && rollup -c rollup.config.js && rollup --environment NODE_ENV:production -c rollup.config.js",
     "dev": "rollup -c rollup.config.js --watch",
     "lint": "eslint --ext .js,.ts,.tsx .",
@@ -58,23 +55,18 @@
     "@babel/preset-env": "^7.21.4",
     "@rollup/plugin-commonjs": "^17.1.0",
     "@rollup/plugin-node-resolve": "^11.2.0",
-    "@types/jest": "^27.0.2",
     "algoliasearch": "^4.17.2",
-    "babel-jest": "^27.2.2",
     "concurrently": "^7.1.0",
     "cssnano": "^4.1.10",
     "eslint-config-meilisearch": "*",
     "instantsearch.js": "^4.56.2",
-    "jest": "^27.2.2",
-    "jest-watch-typeahead": "^0.6.3",
     "regenerator-runtime": "^0.13.7",
     "rollup": "^2.79.2",
     "rollup-plugin-babel": "^4.4.0",
     "rollup-plugin-node-polyfills": "^0.2.1",
     "rollup-plugin-terser": "^7.0.0",
     "rollup-plugin-typescript2": "^0.32.1",
     "shx": "^0.3.4",
-    "ts-jest": "^27.0.7",
     "tslib": "^2.6.1",
     "typescript": "^4.9.5"
   }
diff --git a/packages/instant-meilisearch/scripts/jest_teardown.js b/packages/instant-meilisearch/scripts/jest_teardown.js
diff --git a/packages/instant-meilisearch/src/adapter/search-request-adapter/__tests__/geo-rules.test.ts b/packages/instant-meilisearch/src/adapter/search-request-adapter/__tests__/geo-rules.test.ts
@@ -1,3 +1,4 @@
+import { test, expect } from 'vitest'
 import { adaptGeoSearch } from '../geo-rules-adapter'
 
 test('Adapt instantsearch geo parameters to meilisearch filters without a boundingBox', () => {
diff --git a/packages/instant-meilisearch/src/adapter/search-request-adapter/__tests__/search-params.test.ts b/packages/instant-meilisearch/src/adapter/search-request-adapter/__tests__/search-params.test.ts
@@ -1,3 +1,4 @@
+import { describe, test, expect } from 'vitest'
 import { MatchingStrategies } from 'meilisearch'
 import { adaptSearchParams } from '../search-params-adapter'
 import {
diff --git a/packages/instant-meilisearch/src/adapter/search-response-adapter/__tests__/facet-distribution.test.ts b/packages/instant-meilisearch/src/adapter/search-response-adapter/__tests__/facet-distribution.test.ts
@@ -1,3 +1,4 @@
+import { describe, test, expect } from 'vitest'
 import { adaptFacetDistribution } from '../facet-distribution-adapter'
 
 const initialFacetDistribution = {
diff --git a/packages/instant-meilisearch/src/adapter/search-response-adapter/__tests__/geo-adapter.test.ts b/packages/instant-meilisearch/src/adapter/search-response-adapter/__tests__/geo-adapter.test.ts
@@ -1,3 +1,4 @@
+import { describe, test, expect } from 'vitest'
 import { adaptGeoResponse } from '../geo-reponse-adapter'
 
 describe('Geopoint adapter', () => {
diff --git a/packages/instant-meilisearch/src/adapter/search-response-adapter/__tests__/hit-adapter.test.ts b/packages/instant-meilisearch/src/adapter/search-response-adapter/__tests__/hit-adapter.test.ts
@@ -1,3 +1,4 @@
+import { describe, test, expect } from 'vitest'
 import { adaptHits } from '../hits-adapter'
 
 const searchResponsePositionMatchesFalse = {
diff --git a/packages/instant-meilisearch/src/adapter/search-response-adapter/__tests__/pagination-adapter.test.ts b/packages/instant-meilisearch/src/adapter/search-response-adapter/__tests__/pagination-adapter.test.ts
@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { adaptPaginationParameters } from '../pagination-adapter'
 import { ceiledDivision } from './../__tests__/assets/number'
 
diff --git a/packages/instant-meilisearch/src/cache/__tests__/fill-missing-facets.test.ts b/packages/instant-meilisearch/src/cache/__tests__/fill-missing-facets.test.ts
@@ -1,3 +1,4 @@
+import { describe, it, expect } from 'vitest'
 import { fillMissingFacets } from '../init-facets-distribution'
 
 describe('Fill missing facets', () => {
diff --git a/packages/instant-meilisearch/src/cache/__tests__/search-cache.test.ts b/packages/instant-meilisearch/src/cache/__tests__/search-cache.test.ts
@@ -1,3 +1,4 @@
+import { describe, test, expect } from 'vitest'
 import { SearchCache } from '../search-cache'
 import { searchResponse } from './assets/utils'
 
diff --git a/packages/instant-meilisearch/vitest.config.ts b/packages/instant-meilisearch/vitest.config.ts
diff --git a/vitest.config.ts b/vitest.config.ts
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import { describe, test, expect } from 'vitest'`
`1`	`2`	`import { getMeilisearchResults } from '../'`
`2`	`3`	`import { searchClient } from '../../../__tests__/test.utils'`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import { describe, beforeAll, test, expect, afterAll } from 'vitest'`
`1`	`2`	`import { fetchMeilisearchResults } from '../fetchMeilisearchResults'`
`2`	`3`	`import {`
`3`	`4`	`searchClient,`