fix: support node 22 (#39349)

serhalp · web-flow · commit 7451d2ff56c4 · 2025-08-19T10:06:05.000-04:00
* test(gatsby-cli): tolerate varying stack traces * test: import mocked module the same way it's used This mismatch stopped working after node 18. * test: use more specific snapshot for res headers Some of the connection header defaults depend on the node.js major version wip this is a fix for the headers one * test: skip unstable GC tests on node 20+ * test: adjust assertion to work on node 22 locally See inline comment * test: fix sharp build error in lmdb-regeneration fixture The `lmdb-regeneration` integration test fixture had an `.npmrc` file forcing all packages to be built from source, which caused sharp to fail compilation in Node 20+ CircleCI images (Ubuntu Noble) due to... who knows what, honestly. Since this fixture specifically needs lmdb built from source but not sharp (it's testing something specific to this), this replaces the global `.npmrc` `build-from-source` flag with a targeted `postinstall` script that only rebuilds lmdb from source, allowing sharp to use prebuilt binaries. This resolves the "cannot find -l:libvips-cpp.so.42" linker errors that were blocking integration tests on Node 20+ while preserving the fixture's intended lmdb compilation testing. AFAICT this was... basically the only solution. Whew * fix(gatsby): bump `webpack-virtual-modules` to get this bug fix: sysgears/webpack-virtual-modules#172 causing this, unclear when: ``` TypeError: Cannot read properties of null (reading 'fileWatchers') ``` * ci: test against Node 18, 20, 22 - run unit tests against all three - run integration tests against earliest and latest - make sure to separate npm cache by node version * ci: test against node 22.13 to avoid bug for now
diff --git a/.circleci/config.yml b/.circleci/config.yml
diff --git a/integration-tests/functions/__tests__/__snapshots__/functions-dev.js.snap b/integration-tests/functions/__tests__/__snapshots__/functions-dev.js.snap
@@ -80,27 +80,17 @@ Object {
 
 exports[`develop response formats returns json correctly 2`] = `
 Object {
-  "access-control-allow-origin": "*",
-  "connection": "close",
   "content-length": "16",
   "content-type": "application/json; charset=utf-8",
-  "etag": "W/\\"10-R6td1pV+B+Xz9CJkNeaEI2kP+QY\\"",
-  "vary": "Accept-Encoding",
-  "x-powered-by": "Express",
 }
 `;
 
 exports[`develop response formats returns text correctly 1`] = `"I am typescript"`;
 
 exports[`develop response formats returns text correctly 2`] = `
 Object {
-  "access-control-allow-origin": "*",
-  "connection": "close",
   "content-length": "15",
   "content-type": "text/html; charset=utf-8",
-  "etag": "W/\\"f-zwggT56l/fnWBm4dI0PkA4E3i4E\\"",
-  "vary": "Accept-Encoding",
-  "x-powered-by": "Express",
 }
 `;
 
diff --git a/integration-tests/functions/__tests__/__snapshots__/functions-prod.js.snap b/integration-tests/functions/__tests__/__snapshots__/functions-prod.js.snap
@@ -80,23 +80,17 @@ Object {
 
 exports[`production response formats returns json correctly 2`] = `
 Object {
-  "connection": "close",
   "content-length": "16",
   "content-type": "application/json; charset=utf-8",
-  "etag": "W/\\"10-R6td1pV+B+Xz9CJkNeaEI2kP+QY\\"",
-  "x-powered-by": "Express",
 }
 `;
 
 exports[`production response formats returns text correctly 1`] = `"I am typescript"`;
 
 exports[`production response formats returns text correctly 2`] = `
 Object {
-  "connection": "close",
   "content-length": "15",
   "content-type": "text/html; charset=utf-8",
-  "etag": "W/\\"f-zwggT56l/fnWBm4dI0PkA4E3i4E\\"",
-  "x-powered-by": "Express",
 }
 `;
 
diff --git a/integration-tests/functions/test-helpers.js b/integration-tests/functions/test-helpers.js
@@ -164,17 +164,23 @@ export function runTests(env, host) {
         const res = await fetchWithRetry(`${host}/api/i-am-json`)
         const result = await res.json()
 
-        const { date, ...headers } = Object.fromEntries(res.headers)
+        const relevantHeaders = {
+          'content-type': res.headers.get('content-type'),
+          'content-length': res.headers.get('content-length')
+        }
         expect(result).toMatchSnapshot()
-        expect(headers).toMatchSnapshot()
+        expect(relevantHeaders).toMatchSnapshot()
       })
       test(`returns text correctly`, async () => {
         const res = await fetchWithRetry(`${host}/api/i-am-typescript`)
         const result = await res.text()
 
-        const { date, ...headers } = Object.fromEntries(res.headers)
+        const relevantHeaders = {
+          'content-type': res.headers.get('content-type'),
+          'content-length': res.headers.get('content-length')
+        }
         expect(result).toMatchSnapshot()
-        expect(headers).toMatchSnapshot()
+        expect(relevantHeaders).toMatchSnapshot()
       })
     })
 
diff --git a/integration-tests/lmdb-regeneration/.npmrc b/integration-tests/lmdb-regeneration/.npmrc
diff --git a/integration-tests/lmdb-regeneration/package.json b/integration-tests/lmdb-regeneration/package.json
@@ -8,6 +8,7 @@
   "scripts": {
     "build": "gatsby build",
     "clean": "gatsby clean",
+    "postinstall": "npm rebuild --build-from-source lmdb",
     "test": "jest --runInBand"
   },
   "dependencies": {
diff --git a/integration-tests/ssr/__tests__/ssr.js b/integration-tests/ssr/__tests__/ssr.js
@@ -129,7 +129,7 @@ describe(`SSR`, () => {
       it(
         title,
         async () => {
-          const src = path.join(__dirname, `/fixtures/`, fixture)
+          const src = path.join(__dirname, `fixtures`, fixture)
           const dest = getSrcLoc(fixture)
           fs.copySync(src, dest)
 
diff --git a/packages/gatsby-cli/src/reporter/__tests__/__snapshots__/index.ts.snap b/packages/gatsby-cli/src/reporter/__tests__/__snapshots__/index.ts.snap
@@ -38,7 +38,7 @@ Object {
   },
   "docsUrl": "https://gatsby.dev/issue-how-to",
   "level": "ERROR",
-  "stack": Array [],
+  "stack": Any<Array>,
   "text": "Error created in Jest",
   "type": "UNKNOWN",
 }
@@ -69,80 +69,7 @@ Object {
   "error": [Error: Message from new Error],
   "level": "ERROR",
   "pluginName": "gatsby-plugin-foo-bar",
-  "stack": Array [
-    Object {
-      "columnNumber": 7,
-      "fileName": "<PROJECT_ROOT>/packages/gatsby-cli/src/reporter/__tests__/index.ts",
-      "functionName": null,
-      "lineNumber": 100,
-    },
-    Object {
-      "columnNumber": 28,
-      "fileName": "<PROJECT_ROOT>/node_modules/jest-circus/build/utils.js",
-      "functionName": "Promise.then.completed",
-      "lineNumber": 293,
-    },
-    Object {
-      "columnNumber": 10,
-      "fileName": "<PROJECT_ROOT>/node_modules/jest-circus/build/utils.js",
-      "functionName": "callAsyncCircusFn",
-      "lineNumber": 226,
-    },
-    Object {
-      "columnNumber": 40,
-      "fileName": "<PROJECT_ROOT>/node_modules/jest-circus/build/run.js",
-      "functionName": "_callCircusTest",
-      "lineNumber": 297,
-    },
-    Object {
-      "columnNumber": 3,
-      "fileName": "<PROJECT_ROOT>/node_modules/jest-circus/build/run.js",
-      "functionName": "_runTest",
-      "lineNumber": 233,
-    },
-    Object {
-      "columnNumber": 9,
-      "fileName": "<PROJECT_ROOT>/node_modules/jest-circus/build/run.js",
-      "functionName": "_runTestsForDescribeBlock",
-      "lineNumber": 135,
-    },
-    Object {
-      "columnNumber": 9,
-      "fileName": "<PROJECT_ROOT>/node_modules/jest-circus/build/run.js",
-      "functionName": "_runTestsForDescribeBlock",
-      "lineNumber": 130,
-    },
-    Object {
-      "columnNumber": 3,
-      "fileName": "<PROJECT_ROOT>/node_modules/jest-circus/build/run.js",
-      "functionName": "run",
-      "lineNumber": 68,
-    },
-    Object {
-      "columnNumber": 21,
-      "fileName": "<PROJECT_ROOT>/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapterInit.js",
-      "functionName": "runAndTransformResultsToJestFormat",
-      "lineNumber": 122,
-    },
-    Object {
-      "columnNumber": 19,
-      "fileName": "<PROJECT_ROOT>/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapter.js",
-      "functionName": "jestAdapter",
-      "lineNumber": 79,
-    },
-    Object {
-      "columnNumber": 16,
-      "fileName": "<PROJECT_ROOT>/node_modules/jest-runner/build/runTest.js",
-      "functionName": "runTestInternal",
-      "lineNumber": 367,
-    },
-    Object {
-      "columnNumber": 34,
-      "fileName": "<PROJECT_ROOT>/node_modules/jest-runner/build/runTest.js",
-      "functionName": "runTest",
-      "lineNumber": 444,
-    },
-  ],
+  "stack": Any<Array>,
   "text": "Error string passed to reporter Message from new Error",
   "type": "UNKNOWN",
 }
@@ -157,7 +84,7 @@ Object {
   },
   "docsUrl": "https://gatsby.dev/debug-html",
   "level": "ERROR",
-  "stack": Array [],
+  "stack": Any<Array>,
   "text": "\\"navigator\\" is not available during server-side rendering. Enable \\"DEV_SSR\\" to debug this during \\"gatsby develop\\".",
   "type": "HTML.COMPILATION",
 }
@@ -171,7 +98,7 @@ Object {
   },
   "docsUrl": "https://www.gatsbyjs.com/docs/gatsby-cli/#new",
   "level": "ERROR",
-  "stack": Array [],
+  "stack": Any<Array>,
   "text": "Error text is test123",
   "type": "PLUGIN",
 }
@@ -186,7 +113,7 @@ Object {
   "docsUrl": "https://www.gatsbyjs.com/docs/gatsby-cli/#new",
   "level": "ERROR",
   "pluginName": "gatsby-plugin-foo-bar",
-  "stack": Array [],
+  "stack": Any<Array>,
   "text": "Error text is test123",
   "type": "PLUGIN",
 }
diff --git a/packages/gatsby-cli/src/reporter/__tests__/index.ts b/packages/gatsby-cli/src/reporter/__tests__/index.ts
@@ -83,15 +83,19 @@ describe(`report.error`, () => {
     const generatedError = getErrorMessages(
       reporterActions.createLog as jest.Mock
     )[0]
-    expect(generatedError).toMatchSnapshot()
+    expect(generatedError).toMatchSnapshot({
+      stack: expect.any(Array),
+    })
   })
 
   it(`handles "String" signature correctly`, () => {
     reporter.error(`Error created in Jest`)
     const generatedError = getErrorMessages(
       reporterActions.createLog as jest.Mock
     )[0]
-    expect(generatedError).toMatchSnapshot()
+    expect(generatedError).toMatchSnapshot({
+      stack: expect.any(Array),
+    })
   })
 
   it(`handles "String, Error, pluginName" signature correctly`, () => {
@@ -103,7 +107,9 @@ describe(`report.error`, () => {
     const generatedError = getErrorMessages(
       reporterActions.createLog as jest.Mock
     )[0]
-    expect(generatedError).toMatchSnapshot()
+    expect(generatedError).toMatchSnapshot({
+      stack: expect.any(Array),
+    })
   })
 
   it(`sets an error map if setErrorMap is called`, () => {
@@ -136,7 +142,9 @@ describe(`report.error`, () => {
     const generatedError = getErrorMessages(
       reporterActions.createLog as jest.Mock
     )[0]
-    expect(generatedError).toMatchSnapshot()
+    expect(generatedError).toMatchSnapshot({
+      stack: expect.any(Array),
+    })
   })
 
   // This is how it's potentially called from api-runner-node.js
@@ -163,6 +171,8 @@ describe(`report.error`, () => {
     const generatedError = getErrorMessages(
       reporterActions.createLog as jest.Mock
     )[0]
-    expect(generatedError).toMatchSnapshot()
+    expect(generatedError).toMatchSnapshot({
+      stack: expect.any(Array),
+    })
   })
 })
diff --git a/packages/gatsby-source-contentful/src/__tests__/gatsby-plugin-image.js b/packages/gatsby-source-contentful/src/__tests__/gatsby-plugin-image.js
@@ -8,7 +8,7 @@ import _ from "lodash"
 import { resolve } from "path"
 import { setFieldsOnGraphQLNodeType } from "../extend-node-type"
 import { generateImageSource } from "../gatsby-plugin-image"
-import * as gatsbyCoreUtils from "gatsby-core-utils"
+import * as fetchRemoteFileModule from "gatsby-core-utils/fetch-remote-file"
 import * as pluginSharp from "gatsby-plugin-sharp"
 
 const FIXTURES = resolve(__dirname, `..`, `__fixtures__`)
@@ -20,7 +20,7 @@ jest
   .spyOn(pluginSharp, `getDominantColor`)
   .mockImplementation(() => Promise.resolve(`#mocked`))
 jest
-  .spyOn(gatsbyCoreUtils, `fetchRemoteFile`)
+  .spyOn(fetchRemoteFileModule, `fetchRemoteFile`)
   .mockImplementation(() =>
     Promise.resolve(`${FIXTURES}/contentful-logo-256.png`)
   )
diff --git a/packages/gatsby/cache-dir/__tests__/minimal-config.js b/packages/gatsby/cache-dir/__tests__/minimal-config.js
@@ -25,8 +25,18 @@ it(`Builds cache-dir with minimal config`, done => {
   })
 
   spawn.on(`close`, function () {
-    expect(stderr).toEqual(``)
-    expect(stdout).not.toEqual(``)
+    try {
+      // This is a little weird but this node.js deprecation warning is printed on node 22+ BUT we
+      // fully suppress all node.js warnings in CI for some reason. This pattern allows either
+      // nothing or just this warning to be printed to stderr, allowing it to pass locally and in CI.
+      expect(stderr).toMatch(
+        /^(|\(node:\d+\) \[DEP0180\] DeprecationWarning: fs\.Stats constructor is deprecated\.\s+\(Use `node --trace-deprecation \.\.\.` to show where the warning was created\)[\s\n]*)$/s
+      )
+      expect(stdout).not.toEqual(``)
+    } catch (err) {
+      done(err)
+      return
+    }
     done()
   })
 }, 30000)
diff --git a/packages/gatsby/package.json b/packages/gatsby/package.json
@@ -173,7 +173,7 @@
     "webpack-dev-middleware": "^5.3.4",
     "webpack-merge": "^5.9.0",
     "webpack-stats-plugin": "^1.1.3",
-    "webpack-virtual-modules": "^0.5.0",
+    "webpack-virtual-modules": "^0.6.2",
     "xstate": "^4.38.0",
     "yaml-loader": "^0.8.0"
   },
@@ -196,7 +196,6 @@
     "@types/signal-exit": "^3.0.1",
     "@types/string-similarity": "^4.0.0",
     "@types/tmp": "^0.2.3",
-    "@types/webpack-virtual-modules": "^0.1.1",
     "babel-preset-gatsby-package": "^3.15.0-next.0",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
diff --git a/packages/gatsby/src/schema/__tests__/queries.js b/packages/gatsby/src/schema/__tests__/queries.js
diff --git a/yarn.lock b/yarn.lock
