chore(monorepo): upgrade to Jest 30 (#11702)

Co-authored-by: slorber <[email protected]>

Author: slorber

jest/snapshotPathNormalizer.ts

@@ -10,11 +10,60 @@
 
 import os from 'os';
 import path from 'path';
+import fs from 'fs';
 import _ from 'lodash';
 import {escapePath} from '@docusaurus/utils';
 import {version} from '@docusaurus/core/package.json';
 import stripAnsi from 'strip-ansi';
 
+/*
+This weird thing is to normalize paths on our Windows GitHub Actions runners
+
+For some reason, os.tmpdir() returns the "legacy 8.3 DOS short paths"
+This prevents snapshot normalization on Windows
+
+      tempDir: 'C:\\Users\\RUNNER~1\\AppData\\Local\\Temp',
+      tempDirReal: 'C:\\Users\\RUNNER~1\\AppData\\Local\\Temp',
+      homeDir: 'C:\\Users\\runneradmin',
+      homeDirReal: 'C:\\Users\\runneradmin',
+ */
+function normalizeWindowTempDirShortPath(str: string): string {
+  return str.replace('\\RUNNER~1\\', '\\runneradmin\\');
+}
+
+function readPathsForNormalization() {
+  const cwd = process.cwd();
+
+  const tempDir = os.tmpdir();
+  const homeDir = os.homedir();
+
+  // Can we get rid of this legacy sync FS function?
+  function getRealPathSync(pathname: string): string {
+    try {
+      // eslint-disable-next-line no-restricted-properties
+      return fs.realpathSync(pathname);
+    } catch (err) {
+      return pathname;
+    }
+  }
+
+  const tempDirReal = getRealPathSync(tempDir);
+  const homeDirReal = getRealPathSync(homeDir);
+
+  return {
+    cwd,
+    tempDir: normalizeWindowTempDirShortPath(tempDir),
+    tempDirReal: normalizeWindowTempDirShortPath(tempDirReal),
+    homeDir,
+    homeDirReal,
+  };
+}
+
+// We memoize it to avoid useless FS calls on each path normalization
+const getPathsForNormalization: typeof readPathsForNormalization = _.memoize(
+  readPathsForNormalization,
+);
+
 export function print(
   val: unknown,
   serialize: (val: unknown) => string,
@@ -63,9 +112,8 @@ function normalizePaths<T>(value: T): T {
     return value;
   }
 
-  const cwd = process.cwd();
-  const tempDir = os.tmpdir();
-  const homeDir = os.homedir();
+  const {cwd, tempDir, tempDirReal, homeDir, homeDirReal} =
+    getPathsForNormalization();
 
   const homeRelativeToTemp = path.relative(tempDir, homeDir);
 
@@ -75,17 +123,36 @@ function normalizePaths<T>(value: T): T {
     (val) => val.split(cwd).join('<PROJECT_ROOT>'),
 
     // Replace temp directory with <TEMP_DIR>
+    (val) => val.split(tempDirReal).join('<TEMP_DIR>'),
+    (val) => val.split(tempDir).join('<TEMP_DIR>'),
+
+    (val) => val.split(tempDirReal).join('<TEMP_DIR>'),
     (val) => val.split(tempDir).join('<TEMP_DIR>'),
 
     // Replace home directory with <HOME_DIR>
+    (val) => val.split(homeDirReal).join('<HOME_DIR>'),
     (val) => val.split(homeDir).join('<HOME_DIR>'),
 
     // Handle HOME_DIR nested inside TEMP_DIR
+    // This happens on windows GitHub actions runners
+    // tempDir: 'C:\\Users\\RUNNER~1\\AppData\\Local\\Temp',
+    // homeDir: 'C:\\Users\\runneradmin',
     (val) =>
       val
         .split(`<TEMP_DIR>${path.sep + homeRelativeToTemp}`)
         .join('<HOME_DIR>'),
 
+    // replace /prefix___MKDTEMP_DIR___ABC123 with /prefix<MKDTEMP_DIR_STABLE>
+    // The random 6-char suffix of mkdtemp() is removed to make snapshots stable
+    (val) => {
+      const [before, after] = val.split('___MKDTEMP_DIR___');
+      if (after) {
+        const afterSub = after.substring(6);
+        return [before, afterSub].join('<MKDTEMP_DIR_STABLE>');
+      }
+      return before;
+    },
+
     // Replace the Docusaurus version with a stub
     (val) => val.split(version).join('<CURRENT_VERSION>'),
 

package.json

@@ -78,10 +78,10 @@
     "@crowdin/cli": "^3.13.0",
     "@prettier/plugin-xml": "^2.2.0",
     "@swc/core": "^1.7.14",
-    "@swc/jest": "^0.2.36",
+    "@swc/jest": "^0.2.39",
     "@testing-library/react-hooks": "^8.0.1",
     "@types/fs-extra": "^9.0.13",
-    "@types/jest": "^29.5.12",
+    "@types/jest": "^30.0.0",
     "@types/lodash": "^4.14.197",
     "@types/node": "^18.16.19",
     "@types/prompts": "^2.4.4",
@@ -98,17 +98,17 @@
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jest": "^27.2.3",
+    "eslint-plugin-jest": "^27.9.0",
     "eslint-plugin-jsx-a11y": "^6.7.1",
     "eslint-plugin-react": "^7.32.2",
     "eslint-plugin-react-compiler": "^19.0.0-beta-40c6c23-20250301",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-regexp": "^1.15.0",
     "husky": "^8.0.3",
     "image-size": "^2.0.2",
-    "jest": "^29.7.0",
-    "jest-environment-jsdom": "^29.7.0",
-    "jest-serializer-ansi-escapes": "^3.0.0",
+    "jest": "^30.2.0",
+    "jest-environment-jsdom": "^30.2.0",
+    "jest-serializer-ansi-escapes": "^4.0.0",
     "jest-serializer-react-helmet-async": "^1.0.21",
     "lerna": "^6.6.2",
     "lerna-changelog": "^2.2.0",

packages/docusaurus-cssnano-preset/src/remove-overridden-custom-properties/__tests__/__snapshots__/index.test.ts.snap

@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`remove-overridden-custom-properties overridden custom properties should be removed 1`] = `
 "/* stylelint-disable docusaurus/copyright-header, declaration-block-no-duplicate-custom-properties */

packages/docusaurus-logger/src/__tests__/__snapshots__/index.test.ts.snap

@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`error prints objects 1`] = `
 [

packages/docusaurus-mdx-loader/src/remark/admonitions/__tests__/__snapshots__/index.test.ts.snap

@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`admonitions remark plugin add custom keyword 1`] = `
 "<p>The blog feature enables you to deploy in no time a full-featured blog.</p>

packages/docusaurus-mdx-loader/src/remark/toc/__tests__/__snapshots__/index.test.ts.snap

@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`toc remark plugin does not overwrite TOC var if no TOC 1`] = `
 "import {Fragment as _Fragment, jsx as _jsx, jsxs as _jsxs} from "react/jsx-runtime";

packages/docusaurus-mdx-loader/src/remark/transformImage/__tests__/__snapshots__/index.test.ts.snap

@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`transformImage plugin does not choke on invalid image 1`] = `
 "<img alt="invalid image" src={require("!<PROJECT_ROOT>/node_modules/url-loader/dist/cjs.js?limit=10000&name=assets/images/[name]-[contenthash].[ext]&fallback=<PROJECT_ROOT>/node_modules/file-loader/dist/cjs.js!./../static/invalid.png").default} />

packages/docusaurus-mdx-loader/src/remark/transformLinks/__tests__/__snapshots__/index.test.ts.snap

@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`transformLinks plugin transform md links to <a /> 1`] = `
 "[asset](https://example.com/asset.pdf)

packages/docusaurus-mdx-loader/src/remark/unusedDirectives/__tests__/__snapshots__/index.test.ts.snap

@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`directives remark plugin - client compiler default behavior for container directives: console 1`] = `
 [

packages/docusaurus-plugin-client-redirects/src/__tests__/__snapshots__/collectRedirects.test.ts.snap

@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`collectRedirects throw if plugin option redirects contain invalid to paths 1`] = `
 "You are trying to create client-side redirections to invalid paths.