fix: set baseUrl to empty string on axios call, but pass it again in getUrl while including axios defaults

Author: ben-pietsch

packages/openapi-ts/src/plugins/@hey-api/client-axios/__tests__/client.test.ts

@@ -168,3 +168,187 @@ describe('serialized request body handling', () => {
     },
   );
 });
+
+describe('calling axios instance', () => {
+  it.each([
+    {
+      description: 'with absolute baseURL',
+      expectedURL: 'https://api.example.com/users',
+      instanceBaseURL: 'https://api.example.com',
+      optionsURL: '/users',
+    },
+    {
+      description: 'without baseURL',
+      expectedURL: '/users',
+      instanceBaseURL: undefined,
+      optionsURL: '/users',
+    },
+    {
+      description: 'with relative baseURL',
+      expectedURL: '/some-base-url/users',
+      instanceBaseURL: '/some-base-url',
+      optionsURL: '/users',
+    },
+  ])(
+    'should call the axios instance with correct baseURL and url $description configured via createClient',
+    async ({ expectedURL, instanceBaseURL, optionsURL }) => {
+      const client = createClient({ baseURL: instanceBaseURL });
+      const mockAxios = vi.fn().mockResolvedValue({ data: { ok: true } });
+
+      const options = {
+        axios: mockAxios as Partial<AxiosInstance> as AxiosInstance,
+        headers: {},
+        url: optionsURL,
+      };
+
+      await client.get(options);
+
+      expect(mockAxios).toHaveBeenCalledWith(
+        expect.objectContaining({
+          baseURL: '',
+          url: expectedURL,
+        }),
+      );
+    },
+  );
+
+  it.each([
+    {
+      description: 'with absolute baseURL',
+      expectedURL: 'https://api.example.com/some-base-url/users',
+      optionsBaseURL: 'https://api.example.com/some-base-url',
+      optionsURL: '/users',
+    },
+    {
+      description: 'with relative baseURL',
+      expectedURL: '/some-base-url/users',
+      optionsBaseURL: '/some-base-url',
+      optionsURL: '/users',
+    },
+  ])(
+    'should call the axios instance with correct url $description configured via request options',
+    async ({ expectedURL, optionsBaseURL, optionsURL }) => {
+      const client = createClient({
+        baseURL: 'base-url-that-will-be-overridden',
+      });
+
+      const mockAxios = vi.fn().mockResolvedValue({ data: { ok: true } });
+
+      const options = {
+        axios: mockAxios as Partial<AxiosInstance> as AxiosInstance,
+        baseURL: optionsBaseURL,
+        headers: {},
+        url: optionsURL,
+      };
+
+      await client.get(options);
+
+      expect(mockAxios).toHaveBeenCalledWith(
+        expect.objectContaining({
+          baseURL: '',
+          url: expectedURL,
+        }),
+      );
+    },
+  );
+
+  it('should call the axios instance with correct url when baseURL configured via axios defaults', async () => {
+    const client = createClient();
+
+    const mockAxios = vi.fn().mockResolvedValue({
+      data: { ok: true },
+    }) as Partial<AxiosInstance> as AxiosInstance;
+    mockAxios.defaults = { baseURL: '/some-base-url', headers: {} as any };
+
+    const options = {
+      axios: mockAxios,
+      headers: {},
+      url: '/users',
+    };
+
+    await client.get(options);
+
+    expect(mockAxios).toHaveBeenCalledWith(
+      expect.objectContaining({
+        baseURL: '',
+        url: '/some-base-url/users',
+      }),
+    );
+  });
+
+  it('should prefer passed baseUrl over configs', async () => {
+    const client = createClient({ baseURL: 'base-url-from-config-1' });
+
+    const mockAxios = vi.fn().mockResolvedValue({
+      data: { ok: true },
+    }) as Partial<AxiosInstance> as AxiosInstance;
+    mockAxios.defaults = {
+      baseURL: 'base-url-from-config-2',
+      headers: {} as any,
+    };
+
+    const options = {
+      axios: mockAxios,
+      baseURL: '/some-base-url',
+      headers: {},
+      url: '/users',
+    };
+
+    await client.get(options);
+
+    expect(mockAxios).toHaveBeenCalledWith(
+      expect.objectContaining({
+        baseURL: '',
+        url: '/some-base-url/users',
+      }),
+    );
+  });
+});
+
+// TODO: remove this after confirmation
+describe('confirming axios behaviour for constructing URLs', () => {
+  it('resolves relative URLs against baseURL', async () => {
+    const client = axios.create({
+      baseURL: 'https://api.example.com',
+    });
+
+    const config = client.getUri({ url: '/users' });
+    expect(config).toBe('https://api.example.com/users');
+  });
+
+  it('resolves relative URLs against relative baseURL', async () => {
+    const client = axios.create({
+      baseURL: '/example',
+    });
+
+    const config = client.getUri({ url: '/users' });
+    expect(config).toBe('/example/users');
+  });
+
+  it('does not prepend baseURL when url is absolute', async () => {
+    const client = axios.create({
+      baseURL: 'https://api.example.com',
+    });
+
+    const config = client.getUri({ url: 'https://other.com/users' });
+    expect(config).toBe('https://other.com/users');
+  });
+
+  it('does not prepend baseURL when overriding baseURL with empty string', async () => {
+    const client = axios.create({
+      baseURL: 'https://api.example.com',
+    });
+
+    const config = client.getUri({ baseURL: '', url: '/users' });
+    expect(config).toBe('/users');
+  });
+
+  it('does prepend baseURL when overriding baseURL with undefined', async () => {
+    const client = axios.create({
+      baseURL: 'https://api.example.com',
+    });
+
+    const config = client.getUri({ baseURL: undefined, url: '/users' });
+    expect(config).toBe('https://api.example.com/users');
+  });
+});

packages/openapi-ts/src/plugins/@hey-api/client-axios/bundle/client.ts

@@ -78,7 +78,7 @@ export const createClient = (config: Config = {}): Client => {
       const { auth, ...optsWithoutAuth } = opts;
       const response = await _axios({
         ...optsWithoutAuth,
-        baseURL: opts.baseURL as string,
+        baseURL: '', // the baseURL is already included in `url`
         data: getValidRequestBody(opts),
         headers: opts.headers as RawAxiosRequestHeaders,
         // let `paramsSerializer()` handle query params if it exists

packages/openapi-ts/src/plugins/@hey-api/client-axios/bundle/types.ts

@@ -149,7 +149,7 @@ type BuildUrlFn = <
     url: string;
   },
 >(
-  options: Pick<TData, 'url'> & Omit<Options<TData>, 'axios'>,
+  options: Pick<TData, 'url'> & Options<TData>,
 ) => string;
 
 export type Client = CoreClient<

packages/openapi-ts/src/plugins/@hey-api/client-axios/bundle/utils.ts

@@ -123,8 +123,16 @@ export const setAuthParams = async ({
   }
 };
 
-export const buildUrl: Client['buildUrl'] = (options) =>
-  getUrl({
+export const buildUrl: Client['buildUrl'] = (options) => {
+  const instanceBaseUrl = options.axios?.defaults?.baseURL;
+
+  const baseUrl =
+    !!options.baseURL && typeof options.baseURL === 'string'
+      ? options.baseURL
+      : instanceBaseUrl;
+
+  return getUrl({
+    baseUrl: baseUrl as string,
     path: options.path,
     // let `paramsSerializer()` handle query params if it exists
     query: !options.paramsSerializer ? options.query : undefined,
@@ -134,6 +142,7 @@ export const buildUrl: Client['buildUrl'] = (options) =>
         : createQuerySerializer(options.querySerializer),
     url: options.url,
   });
+};
 
 export const mergeConfigs = (a: Config, b: Config): Config => {
   const config = { ...a, ...b };