Replace node-fetch dependency with undici (#7705)

Update our dependency on aging `node-fetch` `v2.6.7` to `undici` `v5.26.5`. This should fix some vulnerabilities within node-fetch as well as fix user issue #7660.
firebase · Nov 12, 2023 · bebecda · bebecda
1 parent a89e05b
commit bebecda
Show file tree

Hide file tree

Showing 27 changed files with 147,757 additions and 195 deletions.
diff --git a/.changeset/real-dolls-type.md b/.changeset/real-dolls-type.md
@@ -0,0 +1,11 @@
+---
+'@firebase/auth-compat': minor
+'@firebase/firestore': minor
+'@firebase/functions': minor
+'@firebase/storage': minor
+'@firebase/auth': minor
+'firebase': minor
+---
+
+Replaced node-fetch v2.6.7 dependency with the latest version of undici (v5.26.5) in Node.js SDK
+builds for auth, firestore, functions and storage.
diff --git a/.yarn/releases/yarn-1.22.11.cjs b/.yarn/releases/yarn-1.22.11.cjs
diff --git a/integration/messaging/package.json b/integration/messaging/package.json
@@ -15,7 +15,7 @@
     "express": "4.18.2",
     "geckodriver": "2.0.4",
     "mocha": "9.2.2",
-    "node-fetch": "2.6.7",
+    "undici": "5.26.5",
     "selenium-assistant": "6.1.1"
   }
 }
diff --git a/integration/messaging/test/utils/sendMessage.js b/integration/messaging/test/utils/sendMessage.js
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-const fetch = require('node-fetch');
+const undici = require('undici');
 const FCM_SEND_ENDPOINT = 'https://fcm.googleapis.com/fcm/send';
 // Rotatable fcm server key. It's generally a bad idea to expose server keys. The reason is to
 // simplify testing process (no need to implement server side decryption of git secret). The
@@ -28,7 +28,7 @@ module.exports = async payload => {
     'Requesting to send an FCM message with payload: ' + JSON.stringify(payload)
   );
 
-  const response = await fetch(FCM_SEND_ENDPOINT, {
+  const response = await undici.fetch(FCM_SEND_ENDPOINT, {
     method: 'POST',
     body: JSON.stringify(payload),
     headers: {

diff --git a/package.json b/package.json
@@ -153,6 +153,7 @@
     "tslint": "6.1.3",
     "typedoc": "0.16.11",
     "typescript": "4.7.4",
+    "undici": "5.26.5",
     "watch": "1.0.2",
     "webpack": "5.76.0",
     "yargs": "17.7.2"

diff --git a/packages/auth-compat/index.node.ts b/packages/auth-compat/index.node.ts
@@ -23,11 +23,15 @@
  */
 export * from './index';
 import { FetchProvider } from '@firebase/auth/internal';
-import * as fetchImpl from 'node-fetch';
+import {
+  fetch as undiciFetch,
+  Headers as undiciHeaders,
+  Response as undiciResponse
+} from 'undici';
 import './index';
 
 FetchProvider.initialize(
-  fetchImpl.default as unknown as typeof fetch,
-  fetchImpl.Headers as unknown as typeof Headers,
-  fetchImpl.Response as unknown as typeof Response
+  undiciFetch as unknown as typeof fetch,
+  undiciHeaders as unknown as typeof Headers,
+  undiciResponse as unknown as typeof Response
 );
diff --git a/packages/auth-compat/karma.conf.js b/packages/auth-compat/karma.conf.js
@@ -16,6 +16,7 @@
  */
 
 const karmaBase = require('../../config/karma.base');
+const webpackBase = require('../../config/webpack.test');
 const { argv } = require('yargs');
 
 const files = ['src/**/*.test.ts'];
@@ -29,6 +30,17 @@ module.exports = function (config) {
     // frameworks to use
     // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
     frameworks: ['mocha'],
+    // undici is a fetch polyfill that test helpers call for Node tests, and browser tests should
+    // ingore its import to avoid compilation errors in those test helpers.
+    webpack: {
+      ...webpackBase,
+      resolve: {
+        ...webpackBase.resolve,
+        alias: {
+          'undici': false
+        }
+      }
+    },
 
     client: Object.assign({}, karmaBase.client, getClientConfig())
   });

diff --git a/packages/auth-compat/package.json b/packages/auth-compat/package.json
@@ -54,7 +54,7 @@
     "@firebase/auth-types": "0.12.0",
     "@firebase/component": "0.6.4",
     "@firebase/util": "1.9.3",
-    "node-fetch": "2.6.7",
+    "undici": "5.26.5",
     "tslib": "^2.1.0"
   },
   "license": "Apache-2.0",

diff --git a/packages/auth/karma.conf.js b/packages/auth/karma.conf.js
@@ -16,6 +16,7 @@
  */
 
 const karmaBase = require('../../config/karma.base');
+const webpackBase = require('../../config/webpack.test');
 const { argv } = require('yargs');
 
 module.exports = function (config) {
@@ -26,7 +27,17 @@ module.exports = function (config) {
     // frameworks to use
     // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
     frameworks: ['mocha'],
-
+    // undici is a fetch polyfill that test helpers call for Node tests, and browser tests should
+    // ingore its import to avoid compilation errors in those test helpers.
+    webpack: {
+      ...webpackBase,
+      resolve: {
+        ...webpackBase.resolve,
+        alias: {
+          'undici': false
+        }
+      }
+    },
     client: Object.assign({}, karmaBase.client, getClientConfig(argv))
   });
 

diff --git a/packages/auth/package.json b/packages/auth/package.json
@@ -115,7 +115,7 @@
     "@firebase/component": "0.6.4",
     "@firebase/logger": "0.4.0",
     "@firebase/util": "1.9.3",
-    "node-fetch": "2.6.7",
+    "undici": "5.26.5",
     "tslib": "^2.1.0"
   },
   "license": "Apache-2.0",

diff --git a/packages/auth/src/platform_node/index.ts b/packages/auth/src/platform_node/index.ts
@@ -27,14 +27,18 @@ import { ClientPlatform } from '../core/util/version';
 import { AuthImpl } from '../core/auth/auth_impl';
 
 import { FetchProvider } from '../core/util/fetch_provider';
-import * as fetchImpl from 'node-fetch';
 import { getDefaultEmulatorHost } from '@firebase/util';
+import {
+  fetch as undiciFetch,
+  Headers as undiciHeaders,
+  Response as undiciResponse
+} from 'undici';
 
 // Initialize the fetch polyfill, the types are slightly off so just cast and hope for the best
 FetchProvider.initialize(
-  fetchImpl.default as unknown as typeof fetch,
-  fetchImpl.Headers as unknown as typeof Headers,
-  fetchImpl.Response as unknown as typeof Response
+  undiciFetch as unknown as typeof fetch,
+  undiciHeaders as unknown as typeof Headers,
+  undiciResponse as unknown as typeof Response
 );
 
 // First, we set up the various platform-specific features for Node (register

diff --git a/packages/auth/test/helpers/integration/emulator_rest_helpers.ts b/packages/auth/test/helpers/integration/emulator_rest_helpers.ts
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import * as fetchImpl from 'node-fetch';
+import { fetch as undiciFetch, RequestInit as undiciRequestInit } from 'undici';
 import { getAppConfig, getEmulatorUrl } from './settings';
 
 export interface VerificationSession {
@@ -87,10 +87,10 @@ function buildEmulatorUrlForPath(endpoint: string): string {
 function doFetch(url: string, request?: RequestInit): ReturnType<typeof fetch> {
   if (typeof document !== 'undefined') {
     return fetch(url, request);
+  } else {
+    return undiciFetch(
+      url,
+      request as undiciRequestInit
+    ) as unknown as ReturnType<typeof fetch>;
   }
-
-  return fetchImpl.default(
-    url,
-    request as fetchImpl.RequestInit
-  ) as unknown as ReturnType<typeof fetch>;
 }
diff --git a/packages/firestore/package.json b/packages/firestore/package.json
@@ -102,7 +102,7 @@
     "@firebase/webchannel-wrapper": "0.10.3",
     "@grpc/grpc-js": "~1.9.0",
     "@grpc/proto-loader": "^0.7.8",
-    "node-fetch": "2.6.7",
+    "undici": "5.26.5",
     "tslib": "^2.1.0"
   },
   "peerDependencies": {

diff --git a/packages/firestore/src/platform/node_lite/connection.ts b/packages/firestore/src/platform/node_lite/connection.ts
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import nodeFetch from 'node-fetch';
+import { fetch as undiciFetch } from 'undici';
 
 import { DatabaseInfo } from '../../core/database_info';
 import { Connection } from '../../remote/connection';
@@ -25,8 +25,8 @@ export { newConnectivityMonitor } from '../browser/connection';
 
 /** Initializes the HTTP connection for the REST API. */
 export function newConnection(databaseInfo: DatabaseInfo): Connection {
-  // node-fetch is meant to be API compatible with `fetch`, but its type doesn't
+  // undici is meant to be API compatible with `fetch`, but its type doesn't
   // match 100%.
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  return new FetchConnection(databaseInfo, nodeFetch as any);
+  return new FetchConnection(databaseInfo, undiciFetch as any);
 }
diff --git a/packages/functions/karma.conf.js b/packages/functions/karma.conf.js
@@ -16,6 +16,7 @@
  */
 
 const karmaBase = require('../../config/karma.base');
+const webpackBase = require('../../config/webpack.test');
 
 const files = [`src/**/*.test.ts`];
 
@@ -25,7 +26,18 @@ module.exports = function (config) {
     files,
     // frameworks to use
     // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
-    frameworks: ['mocha']
+    frameworks: ['mocha'],
+    // undici is a fetch polyfill that test helpers call for Node tests, and browser tests should
+    // ingore its import to avoid compilation errors in those test helpers.
+    webpack: {
+      ...webpackBase,
+      resolve: {
+        ...webpackBase.resolve,
+        alias: {
+          'undici': false
+        }
+      }
+    }
   });
 
   config.set(karmaConfig);

diff --git a/packages/functions/package.json b/packages/functions/package.json
@@ -71,7 +71,7 @@
     "@firebase/auth-interop-types": "0.2.1",
     "@firebase/app-check-interop-types": "0.3.0",
     "@firebase/util": "1.9.3",
-    "node-fetch": "2.6.7",
+    "undici": "5.26.5",
     "tslib": "^2.1.0"
   },
   "nyc": {

diff --git a/packages/functions/src/index.node.ts b/packages/functions/src/index.node.ts
@@ -15,9 +15,9 @@
  * limitations under the License.
  */
 import { registerFunctions } from './config';
-import nodeFetch from 'node-fetch';
+import { fetch as undiciFetch } from 'undici';
 
 export * from './api';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-registerFunctions(nodeFetch as any, 'node');
+registerFunctions(undiciFetch as any, 'node');
diff --git a/packages/functions/test/utils.ts b/packages/functions/test/utils.ts
@@ -21,7 +21,7 @@ import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
 import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
 import { FunctionsService } from '../src/service';
 import { connectFunctionsEmulator } from '../src/api';
-import nodeFetch from 'node-fetch';
+import { fetch as undiciFetch } from 'undici';
 import { MessagingInternalComponentName } from '../../../packages/messaging-interop-types';
 
 export function makeFakeApp(options: FirebaseOptions = {}): FirebaseApp {
@@ -59,7 +59,7 @@ export function createTestService(
   )
 ): FunctionsService {
   const fetchImpl: typeof fetch =
-    typeof window !== 'undefined' ? fetch.bind(window) : (nodeFetch as any);
+    typeof window !== 'undefined' ? fetch.bind(window) : (undiciFetch as any);
   const functions = new FunctionsService(
     app,
     authProvider,