V11 release removal of node-fetch and undici dependencies (#8492)

DellaBitta · web-flow · commit c8937e724763 · 2024-09-20T15:53:48.000-04:00
Our v11 release will require node 18+. Since fetch has been introduced in these node versions, we can remove our dependency on third party fetch implementations.

This change removes our usage of fetch variants undici and node-fetch for our node target builds and our CI tools.
diff --git a/.changeset/plenty-beers-decide.md b/.changeset/plenty-beers-decide.md
@@ -0,0 +1,13 @@
+---
+'@firebase/rules-unit-testing': patch
+'@firebase/firestore-compat': patch
+'@firebase/functions-compat': patch
+'@firebase/storage-compat': patch
+'@firebase/auth-compat': patch
+'@firebase/firestore': patch
+'@firebase/functions': patch
+'@firebase/storage': patch
+'@firebase/auth': patch
+---
+
+Removed dependency on undici and node-fetch in our node bundles, replacing them with the native fetch implementation.
diff --git a/integration/messaging/package.json b/integration/messaging/package.json
@@ -15,7 +15,6 @@
     "express": "4.19.2",
     "geckodriver": "2.0.4",
     "mocha": "9.2.2",
-    "undici": "6.19.7",
     "selenium-assistant": "6.1.1"
   },
   "engines": {
diff --git a/integration/messaging/test/utils/sendMessage.js b/integration/messaging/test/utils/sendMessage.js
@@ -15,7 +15,6 @@
  * limitations under the License.
  */
 
-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 +27,7 @@ module.exports = async payload => {
     'Requesting to send an FCM message with payload: ' + JSON.stringify(payload)
   );
 
-  const response = await undici.fetch(FCM_SEND_ENDPOINT, {
+  const response = await fetch(FCM_SEND_ENDPOINT, {
     method: 'POST',
     body: JSON.stringify(payload),
     headers: {
diff --git a/package.json b/package.json
@@ -156,7 +156,6 @@
     "tslint": "6.1.3",
     "typedoc": "0.16.11",
     "typescript": "4.7.4",
-    "undici": "6.19.7",
     "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,15 +23,6 @@
  */
 export * from './index';
 import { FetchProvider } from '@firebase/auth/internal';
-import {
-  fetch as undiciFetch,
-  Headers as undiciHeaders,
-  Response as undiciResponse
-} from 'undici';
 import './index';
 
-FetchProvider.initialize(
-  undiciFetch as unknown as typeof fetch,
-  undiciHeaders as unknown as typeof Headers,
-  undiciResponse as unknown as typeof Response
-);
+FetchProvider.initialize(fetch, Headers, Response);
diff --git a/packages/auth-compat/karma.conf.js b/packages/auth-compat/karma.conf.js
@@ -30,18 +30,6 @@ 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
-    // ignore 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
@@ -55,7 +55,6 @@
     "@firebase/auth-types": "0.12.2",
     "@firebase/component": "0.6.8",
     "@firebase/util": "1.9.7",
-    "undici": "6.19.7",
     "tslib": "^2.1.0"
   },
   "license": "Apache-2.0",
diff --git a/packages/auth/karma.conf.js b/packages/auth/karma.conf.js
@@ -27,17 +27,6 @@ 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
-    // ignore 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
@@ -130,7 +130,6 @@
     "@firebase/component": "0.6.8",
     "@firebase/logger": "0.4.2",
     "@firebase/util": "1.9.7",
-    "undici": "6.19.7",
     "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
@@ -28,18 +28,9 @@ import { AuthImpl } from '../core/auth/auth_impl';
 
 import { FetchProvider } from '../core/util/fetch_provider';
 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(
-  undiciFetch as unknown as typeof fetch,
-  undiciHeaders as unknown as typeof Headers,
-  undiciResponse as unknown as typeof Response
-);
+FetchProvider.initialize(fetch, Headers, Response);
 
 // First, we set up the various platform-specific features for Node (register
 // the version and declare the Node getAuth function)
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,6 @@
  * limitations under the License.
  */
 
-import { fetch as undiciFetch, RequestInit as undiciRequestInit } from 'undici';
 import { getAppConfig, getEmulatorUrl } from './settings';
 
 export interface VerificationSession {
@@ -88,9 +87,8 @@ 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 fetch(url, request as RequestInit) as unknown as ReturnType<
+      typeof fetch
+    >;
   }
 }
diff --git a/packages/firestore/package.json b/packages/firestore/package.json
@@ -103,7 +103,6 @@
     "@firebase/webchannel-wrapper": "1.0.1",
     "@grpc/grpc-js": "~1.9.0",
     "@grpc/proto-loader": "^0.7.8",
-    "undici": "6.19.7",
     "tslib": "^2.1.0"
   },
   "peerDependencies": {
diff --git a/packages/firestore/src/platform/browser_lite/connection.ts b/packages/firestore/src/platform/browser_lite/connection.ts
@@ -24,5 +24,5 @@ export { newConnectivityMonitor } from '../browser/connection';
 
 /** Initializes the HTTP connection for the REST API. */
 export function newConnection(databaseInfo: DatabaseInfo): Connection {
-  return new FetchConnection(databaseInfo, fetch.bind(null));
+  return new FetchConnection(databaseInfo);
 }
diff --git a/packages/firestore/src/platform/browser_lite/fetch_connection.ts b/packages/firestore/src/platform/browser_lite/fetch_connection.ts
@@ -16,7 +16,6 @@
  */
 
 import { Token } from '../../api/credentials';
-import { DatabaseInfo } from '../../core/database_info';
 import { Stream } from '../../remote/connection';
 import { RestConnection } from '../../remote/rest_connection';
 import { mapCodeFromHttpStatus } from '../../remote/rpc_error';
@@ -28,17 +27,6 @@ import { StringMap } from '../../util/types';
  * (e.g. `fetch` or a polyfill).
  */
 export class FetchConnection extends RestConnection {
-  /**
-   * @param databaseInfo - The connection info.
-   * @param fetchImpl - `fetch` or a Polyfill that implements the fetch API.
-   */
-  constructor(
-    databaseInfo: DatabaseInfo,
-    private readonly fetchImpl: typeof fetch
-  ) {
-    super(databaseInfo);
-  }
-
   openStream<Req, Resp>(
     rpcName: string,
     token: Token | null
@@ -56,7 +44,7 @@ export class FetchConnection extends RestConnection {
     let response: Response;
 
     try {
-      response = await this.fetchImpl(url, {
+      response = await fetch(url, {
         method: 'POST',
         headers,
         body: requestJson
diff --git a/packages/firestore/src/platform/node_lite/connection.ts b/packages/firestore/src/platform/node_lite/connection.ts
@@ -15,8 +15,6 @@
  * limitations under the License.
  */
 
-import { fetch as undiciFetch } from 'undici';
-
 import { DatabaseInfo } from '../../core/database_info';
 import { Connection } from '../../remote/connection';
 import { FetchConnection } from '../browser_lite/fetch_connection';
@@ -25,8 +23,5 @@ export { newConnectivityMonitor } from '../browser/connection';
 
 /** Initializes the HTTP connection for the REST API. */
 export function newConnection(databaseInfo: DatabaseInfo): Connection {
-  // 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, undiciFetch as any);
+  return new FetchConnection(databaseInfo);
 }
diff --git a/packages/functions/karma.conf.js b/packages/functions/karma.conf.js
@@ -26,18 +26,7 @@ module.exports = function (config) {
     files,
     // 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
-    // ignore its import to avoid compilation errors in those test helpers.
-    webpack: {
-      ...webpackBase,
-      resolve: {
-        ...webpackBase.resolve,
-        alias: {
-          'undici': false
-        }
-      }
-    }
+    frameworks: ['mocha']
   });
 
   config.set(karmaConfig);
diff --git a/packages/functions/package.json b/packages/functions/package.json
@@ -72,7 +72,6 @@
     "@firebase/auth-interop-types": "0.2.3",
     "@firebase/app-check-interop-types": "0.3.2",
     "@firebase/util": "1.9.7",
-    "undici": "6.19.7",
     "tslib": "^2.1.0"
   },
   "nyc": {
diff --git a/packages/functions/src/config.ts b/packages/functions/src/config.ts
@@ -35,10 +35,7 @@ const APP_CHECK_INTERNAL_NAME: AppCheckInternalComponentName =
 const MESSAGING_INTERNAL_NAME: MessagingInternalComponentName =
   'messaging-internal';
 
-export function registerFunctions(
-  fetchImpl: typeof fetch,
-  variant?: string
-): void {
+export function registerFunctions(variant?: string): void {
   const factory: InstanceFactory<'functions'> = (
     container: ComponentContainer,
     { instanceIdentifier: regionOrCustomDomain }
@@ -55,8 +52,7 @@ export function registerFunctions(
       authProvider,
       messagingProvider,
       appCheckProvider,
-      regionOrCustomDomain,
-      fetchImpl
+      regionOrCustomDomain
     );
   };
 
diff --git a/packages/functions/src/index.node.ts b/packages/functions/src/index.node.ts
@@ -15,9 +15,8 @@
  * limitations under the License.
  */
 import { registerFunctions } from './config';
-import { fetch as undiciFetch } from 'undici';
 
 export * from './api';
+export * from './public-types';
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-registerFunctions(undiciFetch as any, 'node');
+registerFunctions('node');
diff --git a/packages/functions/src/index.ts b/packages/functions/src/index.ts
@@ -25,4 +25,4 @@ import { registerFunctions } from './config';
 export * from './api';
 export * from './public-types';
 
-registerFunctions(fetch.bind(self));
+registerFunctions();
diff --git a/packages/functions/src/service.ts b/packages/functions/src/service.ts
@@ -104,8 +104,7 @@ export class FunctionsService implements _FirebaseService {
     authProvider: Provider<FirebaseAuthInternalName>,
     messagingProvider: Provider<MessagingInternalComponentName>,
     appCheckProvider: Provider<AppCheckInternalComponentName>,
-    regionOrCustomDomain: string = DEFAULT_REGION,
-    readonly fetchImpl: typeof fetch
+    regionOrCustomDomain: string = DEFAULT_REGION
   ) {
     this.contextProvider = new ContextProvider(
       authProvider,
@@ -212,14 +211,13 @@ export function httpsCallableFromURL<RequestData, ResponseData>(
 async function postJSON(
   url: string,
   body: unknown,
-  headers: { [key: string]: string },
-  fetchImpl: typeof fetch
+  headers: { [key: string]: string }
 ): Promise<HttpResponse> {
   headers['Content-Type'] = 'application/json';
 
   let response: Response;
   try {
-    response = await fetchImpl(url, {
+    response = await fetch(url, {
       method: 'POST',
       body: JSON.stringify(body),
       headers
@@ -296,7 +294,7 @@ async function callAtURL(
 
   const failAfterHandle = failAfter(timeout);
   const response = await Promise.race([
-    postJSON(url, body, headers, functionsInstance.fetchImpl),
+    postJSON(url, body, headers),
     failAfterHandle.promise,
     functionsInstance.cancelAllRequests
   ]);
diff --git a/packages/functions/test/utils.ts b/packages/functions/test/utils.ts
@@ -21,7 +21,6 @@ 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 { fetch as undiciFetch } from 'undici';
 import { MessagingInternalComponentName } from '../../../packages/messaging-interop-types';
 
 export function makeFakeApp(options: FirebaseOptions = {}): FirebaseApp {
@@ -58,15 +57,12 @@ export function createTestService(
     new ComponentContainer('test')
   )
 ): FunctionsService {
-  const fetchImpl: typeof fetch =
-    typeof window !== 'undefined' ? fetch.bind(window) : (undiciFetch as any);
   const functions = new FunctionsService(
     app,
     authProvider,
     messagingProvider,
     appCheckProvider,
-    region,
-    fetchImpl
+    region
   );
   const useEmulator = !!process.env.FIREBASE_FUNCTIONS_EMULATOR_ORIGIN;
   if (useEmulator) {
diff --git a/packages/rules-unit-testing/package.json b/packages/rules-unit-testing/package.json
@@ -53,9 +53,5 @@
   "typings": "dist/index.d.ts",
   "bugs": {
     "url": "https://github.com/firebase/firebase-js-sdk/issues"
-  },
-  "dependencies": {
-    "node-fetch": "2.6.7",
-    "@types/node-fetch": "2.6.4"
   }
 }
diff --git a/packages/rules-unit-testing/src/impl/discovery.ts b/packages/rules-unit-testing/src/impl/discovery.ts
@@ -16,7 +16,6 @@
  */
 
 import { EmulatorConfig, HostAndPort } from '../public_types';
-import nodeFetch from 'node-fetch';
 import { makeUrl, fixHostname } from './url';
 
 /**
@@ -27,9 +26,9 @@ import { makeUrl, fixHostname } from './url';
  */
 export async function discoverEmulators(
   hub: HostAndPort,
-  fetch: typeof nodeFetch = nodeFetch
+  fetchImpl: typeof fetch = fetch
 ): Promise<DiscoveredEmulators> {
-  const res = await fetch(makeUrl(hub, '/emulators'));
+  const res = await fetchImpl(makeUrl(hub, '/emulators'));
   if (!res.ok) {
     throw new Error(
       `HTTP Error ${res.status} when attempting to reach Emulator Hub at ${res.url}, are you sure it is running?`
diff --git a/packages/rules-unit-testing/src/impl/rules.ts b/packages/rules-unit-testing/src/impl/rules.ts
@@ -17,7 +17,6 @@
 
 import { HostAndPort } from '../public_types';
 import { makeUrl } from './url';
-import fetch from 'node-fetch';
 
 /**
  * @private
diff --git a/packages/rules-unit-testing/src/impl/test_environment.ts b/packages/rules-unit-testing/src/impl/test_environment.ts
diff --git a/packages/rules-unit-testing/src/util.ts b/packages/rules-unit-testing/src/util.ts
diff --git a/packages/rules-unit-testing/test/impl/discovery.test.ts b/packages/rules-unit-testing/test/impl/discovery.test.ts
diff --git a/packages/rules-unit-testing/test/util.test.ts b/packages/rules-unit-testing/test/util.test.ts
diff --git a/packages/storage/package.json b/packages/storage/package.json
diff --git a/packages/storage/src/platform/node/connection.ts b/packages/storage/src/platform/node/connection.ts
diff --git a/packages/storage/test/node/connection.test.ts b/packages/storage/test/node/connection.test.ts
diff --git a/repo-scripts/changelog-generator/index.ts b/repo-scripts/changelog-generator/index.ts
diff --git a/repo-scripts/changelog-generator/package.json b/repo-scripts/changelog-generator/package.json
diff --git a/scripts/emulator-testing/emulators/emulator.ts b/scripts/emulator-testing/emulators/emulator.ts
diff --git a/yarn.lock b/yarn.lock
