Allow client option for custom dispatcher into fetch requests (e.g. to disable certificate validation) #1631

Author: mellster2012

packages/openapi-fetch/package.json

@@ -77,6 +77,7 @@
     "openapi-typescript-codegen": "^0.25.0",
     "openapi-typescript-fetch": "^2.0.0",
     "superagent": "^9.0.2",
+    "undici": "^6.14.1",
     "typescript": "^5.4.5",
     "vite": "^5.3.5"
   }

packages/openapi-fetch/src/index.d.ts

@@ -10,10 +10,14 @@ import type {
   SuccessResponse,
 } from "openapi-typescript-helpers";
 
+import type { Dispatcher } from "undici";
+
 /** Options for each client instance */
 export interface ClientOptions extends Omit<RequestInit, "headers"> {
   /** set the common root URL for all API requests */
   baseUrl?: string;
+  /** custom dispatcher */
+  dispatcher?: Dispatcher;
   /** custom fetch (defaults to globalThis.fetch) */
   fetch?: (input: Request) => Promise<Response>;
   /** global querySerializer */

packages/openapi-fetch/src/index.js

@@ -34,6 +34,7 @@ export function randomID() {
 export default function createClient(clientOptions) {
   let {
     baseUrl = "",
+    dispatcher = undefined,
     fetch: baseFetch = globalThis.fetch,
     querySerializer: globalQuerySerializer,
     bodySerializer: globalBodySerializer,
@@ -125,7 +126,7 @@ export default function createClient(clientOptions) {
     }
 
     // fetch!
-    let response = await fetch(request);
+    let response = await fetch(request, dispatcher ? { dispatcher } : undefined);
 
     // middleware (response)
     // execute in reverse-array order (first priority gets last transform)

packages/openapi-fetch/test/index.test.ts

@@ -8,6 +8,7 @@ import createClient, {
 } from "../src/index.js";
 import { server, baseUrl, useMockRequestHandler, toAbsoluteURL } from "./fixtures/mock-server.js";
 import type { paths } from "./fixtures/api.js";
+import { Agent } from "undici";
 
 beforeAll(() => {
   server.listen({
@@ -768,6 +769,33 @@ describe("client", () => {
       expect(getRequestUrl().href).toBe(toAbsoluteURL("/self"));
     });
 
+    it("dispatcher", async () => {
+      const dispatcher = new Agent({
+        connect: {
+          rejectUnauthorized: false,
+        },
+      });
+      let client = createClient<paths>({ baseUrl, dispatcher });
+
+      const { getRequestUrl } = useMockRequestHandler({
+        baseUrl,
+        method: "get",
+        path: "/self",
+        status: 200,
+        body: { message: "OK" },
+      });
+
+      await client.GET("/self");
+
+      // assert baseUrl and path mesh as expected
+      expect(getRequestUrl().href).toBe(toAbsoluteURL("/self"));
+
+      client = createClient<paths>({ baseUrl });
+      await client.GET("/self");
+      // assert trailing '/' was removed
+      expect(getRequestUrl().href).toBe(toAbsoluteURL("/self"));
+    });
+
     describe("headers", () => {
       it("persist", async () => {
         const headers: HeadersInit = { Authorization: "Bearer secrettoken" };