migrate @graphiql/react to vitest (#3829)

dimaMachina · web-flow · commit d3584b21a825 · 2024-12-14T23:09:29.000+08:00
* aa

* aa

* aa

* aa

* rm

* fix lint
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -333,7 +333,14 @@ module.exports = {
         'unicorn/prefer-node-protocol': 'error',
         'import-x/no-unresolved': [
           'error',
-          { ignore: ['^node:', '\\.svg\\?react$', 'vitest/config'] },
+          {
+            ignore: [
+              '^node:',
+              '\\.svg\\?react$',
+              'vitest/config',
+              './vite.config.mjs',
+            ],
+          },
         ],
         'no-extra-boolean-cast': [
           'error',
@@ -430,6 +437,7 @@ module.exports = {
         '**/tests/**',
         'test.config.js',
         'vitest.config.mts',
+        'setup-files.ts',
       ],
       rules: {
         'import-x/no-extraneous-dependencies': 'off',
diff --git a/packages/graphiql-react/__mocks__/svg.jsx b/packages/graphiql-react/__mocks__/svg.jsx
diff --git a/packages/graphiql-react/jest.config.js b/packages/graphiql-react/jest.config.js
diff --git a/packages/graphiql-react/package.json b/packages/graphiql-react/package.json
@@ -40,7 +40,8 @@
   "scripts": {
     "prebuild": "rimraf dist types",
     "dev": "concurrently 'tsc --emitDeclarationOnly --watch' 'vite build --watch'",
-    "build": "tsc --emitDeclarationOnly && vite build"
+    "build": "tsc --emitDeclarationOnly && vite build",
+    "test": "vitest"
   },
   "peerDependencies": {
     "graphql": "^15.5.0 || ^16.0.0 || ^17.0.0",
diff --git a/packages/graphiql-react/setup-files.ts b/packages/graphiql-react/setup-files.ts
@@ -0,0 +1,3 @@
+'use no memo';
+
+import '@testing-library/jest-dom';
diff --git a/packages/graphiql-react/src/editor/__tests__/common.spec.ts b/packages/graphiql-react/src/editor/__tests__/common.spec.ts
@@ -1,3 +1,5 @@
+'use no memo';
+
 import { importCodeMirror } from '../common';
 
 describe('importCodeMirror', () => {
diff --git a/packages/graphiql-react/src/editor/__tests__/tabs.spec.ts b/packages/graphiql-react/src/editor/__tests__/tabs.spec.ts
@@ -1,3 +1,5 @@
+'use no memo';
+
 import { StorageAPI } from '@graphiql/toolkit';
 import {
   createTab,
diff --git a/packages/graphiql-react/src/editor/__tests__/whitespace.spec.ts b/packages/graphiql-react/src/editor/__tests__/whitespace.spec.ts
@@ -1,3 +1,5 @@
+'use no memo';
+
 import { invalidCharacters, normalizeWhitespace } from '../whitespace';
 
 describe('normalizeWhitespace', () => {
diff --git a/packages/graphiql-react/src/explorer/components/__tests__/doc-explorer.spec.tsx b/packages/graphiql-react/src/explorer/components/__tests__/doc-explorer.spec.tsx
@@ -1,3 +1,5 @@
+'use no memo';
+
 import { render } from '@testing-library/react';
 import { GraphQLInt, GraphQLObjectType, GraphQLSchema } from 'graphql';
 import { useContext, useEffect } from 'react';
diff --git a/packages/graphiql-react/src/explorer/components/__tests__/field-documentation.spec.tsx b/packages/graphiql-react/src/explorer/components/__tests__/field-documentation.spec.tsx
@@ -1,3 +1,5 @@
+'use no memo';
+
 import { fireEvent, render } from '@testing-library/react';
 import { GraphQLString, GraphQLObjectType, Kind } from 'graphql';
 
diff --git a/packages/graphiql-react/src/explorer/components/__tests__/test-utils.ts b/packages/graphiql-react/src/explorer/components/__tests__/test-utils.ts
@@ -1,3 +1,5 @@
+'use no memo';
+
 import { GraphQLNamedType, GraphQLType } from 'graphql';
 
 import { ExplorerContextType, ExplorerNavStackItem } from '../../context';
diff --git a/packages/graphiql-react/src/explorer/components/__tests__/type-documentation.spec.tsx b/packages/graphiql-react/src/explorer/components/__tests__/type-documentation.spec.tsx
@@ -1,3 +1,5 @@
+'use no memo';
+
 import { fireEvent, render } from '@testing-library/react';
 import {
   GraphQLBoolean,
diff --git a/packages/graphiql-react/src/explorer/components/__tests__/type-link.spec.tsx b/packages/graphiql-react/src/explorer/components/__tests__/type-link.spec.tsx
@@ -1,3 +1,5 @@
+'use no memo';
+
 import { fireEvent, render } from '@testing-library/react';
 import { GraphQLNonNull, GraphQLList, GraphQLString } from 'graphql';
 import { ComponentProps } from 'react';
diff --git a/packages/graphiql-react/src/history/__tests__/components.spec.tsx b/packages/graphiql-react/src/history/__tests__/components.spec.tsx
@@ -1,14 +1,17 @@
+'use no memo';
+
+import { Mock } from 'vitest';
 import { fireEvent, render } from '@testing-library/react';
 import { ComponentProps } from 'react';
 import { formatQuery, HistoryItem } from '../components';
 import { HistoryContextProvider } from '../context';
 import { useEditorContext } from '../../editor';
 import { Tooltip } from '../../ui';
 
-jest.mock('../../editor', () => {
-  const mockedSetQueryEditor = jest.fn();
-  const mockedSetVariableEditor = jest.fn();
-  const mockedSetHeaderEditor = jest.fn();
+vi.mock('../../editor', () => {
+  const mockedSetQueryEditor = vi.fn();
+  const mockedSetVariableEditor = vi.fn();
+  const mockedSetHeaderEditor = vi.fn();
   return {
     useEditorContext() {
       return {
@@ -66,12 +69,12 @@ function getMockProps(
 }
 
 describe('QueryHistoryItem', () => {
-  const mockedSetQueryEditor = useEditorContext()?.queryEditor
-    ?.setValue as jest.Mock;
-  const mockedSetVariableEditor = useEditorContext()?.variableEditor
-    ?.setValue as jest.Mock;
-  const mockedSetHeaderEditor = useEditorContext()?.headerEditor
-    ?.setValue as jest.Mock;
+  const mockedSetQueryEditor = useEditorContext()!.queryEditor!
+    .setValue as Mock;
+  const mockedSetVariableEditor = useEditorContext()!.variableEditor!
+    .setValue as Mock;
+  const mockedSetHeaderEditor = useEditorContext()!.headerEditor!
+    .setValue as Mock;
   beforeEach(() => {
     mockedSetQueryEditor.mockClear();
     mockedSetVariableEditor.mockClear();
diff --git a/packages/graphiql-react/tsconfig.json b/packages/graphiql-react/tsconfig.json
@@ -16,8 +16,7 @@
     "jsx": "react-jsx",
     "declaration": true,
     "declarationDir": "types",
-    "outDir": "tsc",
-    "types": ["jest", "@testing-library/jest-dom"]
+    "types": ["vitest/globals", "@testing-library/jest-dom"]
   },
   "include": ["src"],
   "references": [{ "path": "./tsconfig.node.json" }]
diff --git a/packages/graphiql-react/vite.config.mts b/packages/graphiql-react/vite.config.mts
@@ -1,4 +1,4 @@
-import { defineConfig } from 'vite';
+import { defineConfig, PluginOption } from 'vite';
 import react from '@vitejs/plugin-react';
 import svgr from 'vite-plugin-svgr';
 import postCssNestingPlugin from 'postcss-nesting';
@@ -7,24 +7,28 @@ import packageJSON from './package.json';
 const ReactCompilerConfig = {
   target: '17',
   sources(filename) {
+    if (filename.includes('__tests__')) {
+      return false;
+    }
     return filename.includes('graphiql-react');
   },
 };
 
+export const plugins: PluginOption[] = [
+  react({
+    babel: {
+      plugins: [['babel-plugin-react-compiler', ReactCompilerConfig]],
+    },
+  }),
+  svgr({
+    svgrOptions: {
+      titleProp: true,
+    },
+  }),
+];
+
 export default defineConfig({
-  plugins: [
-    react({
-      babel: {
-        plugins: [['babel-plugin-react-compiler', ReactCompilerConfig]],
-      },
-    }),
-    svgr({
-      exportAsDefault: true,
-      svgrOptions: {
-        titleProp: true,
-      },
-    }),
-  ],
+  plugins,
   css: {
     postcss: {
       plugins: [postCssNestingPlugin()],
diff --git a/packages/graphiql-react/vitest.config.mts b/packages/graphiql-react/vitest.config.mts
@@ -0,0 +1,11 @@
+import { defineConfig } from 'vitest/config';
+import { plugins } from './vite.config.mjs';
+
+export default defineConfig({
+  plugins,
+  test: {
+    globals: true,
+    environment: 'jsdom',
+    setupFiles: ['./setup-files.ts'],
+  },
+});
diff --git a/tsconfig.eslint.json b/tsconfig.eslint.json
@@ -12,14 +12,13 @@
     "packages/*/vite.config.mts",
     "packages/*/vitest.config.mts",
     "examples/*/vite.config.ts",
-    "packages/graphiql/setup-files.ts",
+    "packages/*/setup-files.ts",
     "packages/graphiql/src/*.spec.tsx",
     "packages/cm6-graphql/__tests__/**/*.ts",
     "packages/graphql-language-service/benchmark/index.ts",
     "packages/graphiql/cypress.config.ts",
     "packages/graphiql/__mocks__/codemirror.ts",
     "packages/monaco-graphql/test/*.test.ts",
-    "packages/graphiql-react/vite.config.d.ts",
     "packages/vscode-graphql-syntax/tests/**/*.ts",
     "packages/vscode-graphql-syntax/serializer.ts"
   ]
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+'use no memo';`
	`2`	`+`
	`3`	`+import '@testing-library/jest-dom';`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+'use no memo';`
	`2`	`+`
`1`	`3`	`import { importCodeMirror } from '../common';`
`2`	`4`
`3`	`5`	`describe('importCodeMirror', () => {`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+'use no memo';`
	`2`	`+`
`1`	`3`	`import { StorageAPI } from '@graphiql/toolkit';`
`2`	`4`	`import {`
`3`	`5`	`createTab,`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+'use no memo';`
	`2`	`+`
`1`	`3`	`import { invalidCharacters, normalizeWhitespace } from '../whitespace';`
`2`	`4`
`3`	`5`	`describe('normalizeWhitespace', () => {`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+'use no memo';`
	`2`	`+`
`1`	`3`	`import { render } from '@testing-library/react';`
`2`	`4`	`import { GraphQLInt, GraphQLObjectType, GraphQLSchema } from 'graphql';`
`3`	`5`	`import { useContext, useEffect } from 'react';`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+'use no memo';`
	`2`	`+`
`1`	`3`	`import { fireEvent, render } from '@testing-library/react';`
`2`	`4`	`import { GraphQLString, GraphQLObjectType, Kind } from 'graphql';`
`3`	`5`