Replace node-fetch with undici fetch

Ethan Arrowood · Ethan Arrowood · commit c2e41fa85dfe · 2023-11-28T16:25:46.000-07:00
diff --git a/README.md b/README.md
@@ -228,7 +228,7 @@ Request parameters that correspond to file uploads can be passed in many differe
 
 ```ts
 import fs from 'fs';
-import fetch from 'node-fetch';
+import { fetch } from 'undici';
 import OpenAI, { toFile } from 'openai';
 
 const openai = new OpenAI();
diff --git a/ecosystem-tests/node-ts-cjs/tests/test-node.ts b/ecosystem-tests/node-ts-cjs/tests/test-node.ts
@@ -1,11 +1,12 @@
 import 'openai/shims/node';
 import OpenAI, { toFile } from 'openai';
 import { TranscriptionCreateParams } from 'openai/resources/audio/transcriptions';
-import fetch from 'node-fetch';
 import { File as FormDataFile, Blob as FormDataBlob } from 'formdata-node';
 import * as fs from 'fs';
 import { distance } from 'fastest-levenshtein';
 import { ChatCompletion } from 'openai/resources/chat/completions';
+import { Readable } from 'node:stream';
+import { ReadableStream } from 'node:stream/web';
 
 const url = 'https://audio-samples.github.io/samples/mp3/blizzard_biased/sample-1.mp3';
 const filename = 'sample-1.mp3';
@@ -67,10 +68,11 @@ it(`raw response`, async function () {
 
   // test that we can use node-fetch Response API
   const chunks: string[] = [];
-  response.body.on('data', (chunk) => chunks.push(chunk));
+  const body = Readable.fromWeb(response.body as ReadableStream<any>)
+  body.on('data', (chunk) => chunks.push(chunk));
   await new Promise<void>((resolve, reject) => {
-    response.body.once('end', resolve);
-    response.body.once('error', reject);
+    body.once('end', resolve);
+    body.once('error', reject);
   });
   const json: ChatCompletion = JSON.parse(chunks.join(''));
   expect(json.choices[0]?.message.content || '').toBeSimilarTo('This is a test', 10);
diff --git a/ecosystem-tests/node-ts-esm-auto/tests/test.ts b/ecosystem-tests/node-ts-esm-auto/tests/test.ts
@@ -6,6 +6,8 @@ import { File as FormDataFile, Blob as FormDataBlob } from 'formdata-node';
 import * as fs from 'fs';
 import { distance } from 'fastest-levenshtein';
 import { ChatCompletion } from 'openai/resources/chat/completions';
+import { Readable } from 'node:stream';
+import { ReadableStream } from 'node:stream/web';
 
 const url = 'https://audio-samples.github.io/samples/mp3/blizzard_biased/sample-1.mp3';
 const filename = 'sample-1.mp3';
@@ -67,7 +69,7 @@ it(`raw response`, async function () {
 
   // test that we can use node-fetch Response API
   const chunks: string[] = [];
-  const { body } = response;
+  const body = Readable.fromWeb(response.body as ReadableStream<any>)
   if (!body) throw new Error(`expected response.body to be defined`);
   body.on('data', (chunk) => chunks.push(chunk));
   await new Promise<void>((resolve, reject) => {
diff --git a/ecosystem-tests/node-ts-esm/tests/test-esnext.ts b/ecosystem-tests/node-ts-esm/tests/test-esnext.ts
@@ -3,6 +3,8 @@ import OpenAI from 'openai';
 import { distance } from 'fastest-levenshtein';
 import { ChatCompletion } from 'openai/resources/chat/completions';
 import * as shims from 'openai/_shims/index';
+import { Readable } from 'node:stream';
+import { ReadableStream } from 'node:stream/web';
 
 // The tests in this file don't typecheck with "moduleResolution": "node"
 
@@ -54,7 +56,7 @@ it(`raw response`, async function () {
 
   // test that we can use node-fetch Response API
   const chunks: string[] = [];
-  const { body } = response;
+  const body = Readable.fromWeb(response.body as ReadableStream<any>)
   if (!body) throw new Error(`expected response.body to be defined`);
   body.on('data', (chunk) => chunks.push(chunk));
   await new Promise<void>((resolve, reject) => {
diff --git a/ecosystem-tests/node-ts4.5-jest27/tests/test.ts b/ecosystem-tests/node-ts4.5-jest27/tests/test.ts
@@ -6,6 +6,8 @@ import { File as FormDataFile, Blob as FormDataBlob } from 'formdata-node';
 import * as fs from 'fs';
 import { distance } from 'fastest-levenshtein';
 import { ChatCompletion } from 'openai/resources/chat/completions';
+import { Readable } from 'node:stream';
+import { ReadableStream } from 'node:stream/web';
 
 const url = 'https://audio-samples.github.io/samples/mp3/blizzard_biased/sample-1.mp3';
 const filename = 'sample-1.mp3';
@@ -67,10 +69,11 @@ it(`raw response`, async function () {
 
   // test that we can use node-fetch Response API
   const chunks: string[] = [];
-  response.body.on('data', (chunk) => chunks.push(chunk));
+  const body = Readable.fromWeb(response.body as ReadableStream<any>)
+  body.on('data', (chunk) => chunks.push(chunk));
   await new Promise<void>((resolve, reject) => {
-    response.body.once('end', resolve);
-    response.body.once('error', reject);
+    body.once('end', resolve);
+    body.once('error', reject);
   });
   const json: ChatCompletion = JSON.parse(chunks.join(''));
   expect(json.choices[0]?.message.content || '').toBeSimilarTo('This is a test', 10);
diff --git a/ecosystem-tests/vercel-edge/tests/test.ts b/ecosystem-tests/vercel-edge/tests/test.ts
@@ -1,5 +1,3 @@
-import fetch from 'node-fetch';
-
 const baseUrl = process.env.TEST_BASE_URL || 'http://localhost:3000';
 console.log(baseUrl);
 
diff --git a/package.json b/package.json
@@ -29,6 +29,7 @@
     "form-data-encoder": "1.7.2",
     "formdata-node": "^4.3.2",
     "node-fetch": "^2.6.7",
+    "undici": "^5.28.1",
     "web-streams-polyfill": "^3.2.1"
   },
   "devDependencies": {
diff --git a/src/_shims/node-runtime.ts b/src/_shims/node-runtime.ts
@@ -1,22 +1,18 @@
 /**
  * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
  */
-import * as nf from 'node-fetch';
-import * as fd from 'formdata-node';
-import { type File, type FilePropertyBag } from 'formdata-node';
-import KeepAliveAgent from 'agentkeepalive';
-import { AbortController as AbortControllerPolyfill } from 'abort-controller';
-import { ReadStream as FsReadStream } from 'node:fs';
-import { type Agent } from 'node:http';
+import uf from 'undici';
+import type { File, Agent, FormData } from 'undici';
+import type { FilePropertyBag } from 'formdata-node';
 import { FormDataEncoder } from 'form-data-encoder';
+import { ReadStream as FsReadStream } from 'node:fs';
 import { Readable } from 'node:stream';
+import { ReadableStream } from 'node:stream/web';
+import { Blob } from 'node:buffer';
 import { type RequestOptions } from '../core';
 import { MultipartBody } from './MultipartBody';
 import { type Shims } from './registry';
 
-// @ts-ignore (this package does not have proper export maps for this export)
-import { ReadableStream } from 'web-streams-polyfill/dist/ponyfill.es2018.js';
-
 type FileFromPathOptions = Omit<FilePropertyBag, 'lastModified'>;
 
 let fileFromPathWarned = false;
@@ -40,11 +36,11 @@ async function fileFromPath(path: string, ...args: any[]): Promise<File> {
   return await _fileFromPath(path, ...args);
 }
 
-const defaultHttpAgent: Agent = new KeepAliveAgent({ keepAlive: true, timeout: 5 * 60 * 1000 });
-const defaultHttpsAgent: Agent = new KeepAliveAgent.HttpsAgent({ keepAlive: true, timeout: 5 * 60 * 1000 });
+const defaultHttpAgent = new uf.Agent({ keepAliveTimeout: 5 * 60 * 1000 });
+const defaultHttpsAgent = new uf.Agent({ keepAliveTimeout: 5 * 60 * 1000 });
 
 async function getMultipartRequestOptions<T extends {} = Record<string, unknown>>(
-  form: fd.FormData,
+  form: FormData,
   opts: RequestOptions<T>,
 ): Promise<RequestOptions<T>> {
   const encoder = new FormDataEncoder(form);
@@ -67,13 +63,13 @@ export function getRuntime(): Shims {
   }
   return {
     kind: 'node',
-    fetch: nf.default,
-    Request: nf.Request,
-    Response: nf.Response,
-    Headers: nf.Headers,
-    FormData: fd.FormData,
-    Blob: fd.Blob,
-    File: fd.File,
+    fetch: uf.fetch,
+    Request: uf.Request,
+    Response: uf.Response,
+    Headers: uf.Headers,
+    FormData: uf.FormData,
+    Blob: Blob,
+    File: uf.File,
     ReadableStream,
     getMultipartRequestOptions,
     getDefaultAgent: (url: string): Agent => (url.startsWith('https') ? defaultHttpsAgent : defaultHttpAgent),
diff --git a/src/_shims/node-types.d.ts b/src/_shims/node-types.d.ts
@@ -1,26 +1,25 @@
 /**
  * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
  */
-import * as nf from 'node-fetch';
-import * as fd from 'formdata-node';
+import undici from 'undici';
 
 export { type Agent } from 'node:http';
-export { type Readable } from 'node:stream';
+export { type ReadableStream } from 'node:stream/web';
 export { type ReadStream as FsReadStream } from 'node:fs';
-export { ReadableStream } from 'web-streams-polyfill';
+import { Blob } from 'node:buffer';
 
-export const fetch: typeof nf.default;
+export const fetch: typeof undici.fetch;
 
-export type Request = nf.Request;
-export type RequestInfo = nf.RequestInfo;
-export type RequestInit = nf.RequestInit;
+export type Request = undici.Request;
+export type RequestInfo = undici.RequestInfo;
+export type RequestInit = undici.RequestInit;
 
-export type Response = nf.Response;
-export type ResponseInit = nf.ResponseInit;
-export type ResponseType = nf.ResponseType;
-export type BodyInit = nf.BodyInit;
-export type Headers = nf.Headers;
-export type HeadersInit = nf.HeadersInit;
+export type Response = undici.Response;
+export type ResponseInit = undici.ResponseInit;
+export type ResponseType = undici.ResponseType;
+export type BodyInit = undici.BodyInit;
+export type Headers = undici.Headers;
+export type HeadersInit = undici.HeadersInit;
 
 type EndingType = 'native' | 'transparent';
 export interface BlobPropertyBag {
@@ -34,9 +33,9 @@ export interface FilePropertyBag extends BlobPropertyBag {
 
 export type FileFromPathOptions = Omit<FilePropertyBag, 'lastModified'>;
 
-export type FormData = fd.FormData;
-export const FormData: typeof fd.FormData;
-export type File = fd.File;
-export const File: typeof fd.File;
-export type Blob = fd.Blob;
-export const Blob: typeof fd.Blob;
+export type FormData = undici.FormData;
+export const FormData: typeof undici.FormData;
+export type File = undici.File;
+export const File: typeof undici.File;
+export type Blob = Blob;
+export const Blob: typeof Blob;
diff --git a/src/core.ts b/src/core.ts
@@ -319,8 +319,6 @@ export abstract class APIClient {
       ...(body && { body: body as any }),
       headers: reqHeaders,
       ...(httpAgent && { agent: httpAgent }),
-      // @ts-ignore node-fetch uses a custom AbortSignal type that is
-      // not compatible with standard web types
       signal: options.signal ?? null,
     };
 
diff --git a/src/index.ts b/src/index.ts
@@ -43,7 +43,7 @@ export interface ClientOptions {
   /**
    * Specify a custom `fetch` function implementation.
    *
-   * If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is
+   * If not provided, we use `undici` on Node.js and otherwise expect that `fetch` is
    * defined globally.
    */
   fetch?: Core.Fetch | undefined;
diff --git a/src/uploads.ts b/src/uploads.ts
@@ -26,7 +26,7 @@ export type BlobPart = string | ArrayBuffer | ArrayBufferView | Blob | Uint8Arra
 export type Uploadable = FileLike | ResponseLike | FsReadStream;
 
 /**
- * Intended to match web.Blob, node.Blob, node-fetch.Blob, etc.
+ * Intended to match web.Blob, node.Blob, undici.Blob, etc.
  */
 export interface BlobLike {
   /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/size) */
@@ -125,7 +125,7 @@ export async function toFile(
     }
   }
 
-  return new File(bits, name, options);
+  return new File(bits as (string | Blob | NodeJS.ArrayBufferView)[], name, options);
 }
 
 async function getBytes(value: ToFileInput): Promise<Array<BlobPart>> {
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-import fetch from 'node-fetch';`
`2`		`-`
`3`	`1`	`const baseUrl = process.env.TEST_BASE_URL \|\| 'http://localhost:3000';`
`4`	`2`	`console.log(baseUrl);`
`5`	`3`