fix(client-angular)!: ensures valid serialized or unserialized body is sent with request

BREAKING CHANGE: options.serializedBody is undefined by default, and will only be assigned a value when options.bodySerializer is defined

refs: #2553

Author: Fransis Young

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/sse-angular/client/client.gen.ts

@@ -69,7 +69,7 @@ export const createClient = (config: Config = {}): Client => {
       ...options,
       headers: mergeHeaders(_config.headers, options.headers),
       httpClient: options.httpClient ?? _config.httpClient,
-      serializedBody: options.body as any,
+      serializedBody: undefined,
     };
 
     if (!opts.httpClient) {
@@ -83,12 +83,12 @@ export const createClient = (config: Config = {}): Client => {
       }
     }
 
-    if (opts.body && opts.bodySerializer) {
+    if (opts.body !== undefined && opts.bodySerializer) {
       opts.serializedBody = opts.bodySerializer(opts.body);
     }
 
     // remove Content-Type header if body is empty to avoid sending invalid requests
-    if (opts.serializedBody === undefined || opts.serializedBody === '') {
+    if (opts.body === undefined || opts.serializedBody === '') {
       opts.headers.delete('Content-Type');
     }
 
@@ -97,7 +97,7 @@ export const createClient = (config: Config = {}): Client => {
     const req = new HttpRequest<unknown>(
       opts.method ?? 'GET',
       url,
-      opts.serializedBody || null,
+      getValidRequestBody(opts),
       {
         redirect: 'follow',
         ...opts,
@@ -201,6 +201,25 @@ export const createClient = (config: Config = {}): Client => {
     }
   };
 
+  function getValidRequestBody(options: ResolvedRequestOptions) {
+    const hasBody = options.body !== undefined;
+    const isSerializedBody = hasBody && options.bodySerializer;
+
+    if (isSerializedBody) {
+      const hasSerializedBody =
+        options.serializedBody !== undefined && options.serializedBody !== '';
+
+      return hasSerializedBody ? options.serializedBody : null;
+    }
+
+    // plain/text body
+    if (hasBody) {
+      return options.body;
+    }
+
+    return undefined;
+  }
+
   const makeMethodFn =
     (method: Uppercase<HttpMethod>) => (options: RequestOptions) =>
       request({ ...options, method });

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

@@ -1,4 +1,6 @@
-import { describe, expect, it } from 'vitest';
+import type { HttpClient } from '@angular/common/http';
+import { HttpHeaders } from '@angular/common/http';
+import { describe, expect, it, vi } from 'vitest';
 
 import { createClient } from '../bundle/client';
 
@@ -68,3 +70,89 @@ describe('buildUrl', () => {
     expect(client.buildUrl(options)).toBe(url);
   });
 });
+
+describe('unserialized request body handling', () => {
+  const client = createClient({ baseUrl: 'https://example.com' });
+
+  const scenarios = [
+    { body: 0 },
+    { body: false },
+    { body: 'test string' },
+    { body: '' },
+  ];
+
+  it.each(scenarios)(
+    'handles plain text body with $body value',
+    async ({ body }) => {
+      const spy = vi.spyOn(HttpHeaders.prototype, 'delete');
+
+      const request = client.requestOptions({
+        body,
+        bodySerializer: null,
+        httpClient: vi.fn() as Partial<HttpClient> as HttpClient,
+        url: '/test',
+      });
+
+      expect(request).toMatchObject(
+        expect.objectContaining({
+          body,
+        }),
+      );
+
+      expect(spy).toHaveBeenCalledTimes(0);
+    },
+  );
+});
+
+describe('requestOptions serialized request body handling', () => {
+  const client = createClient({ baseUrl: 'https://example.com' });
+
+  const scenarios = [
+    {
+      body: '',
+      expectBodyValue: false,
+      expectDeleteHeader: 1,
+      serializedBody: '',
+    },
+    {
+      body: 0,
+      expectBodyValue: true,
+      expectDeleteHeader: 0,
+      serializedBody: 0,
+    },
+    {
+      body: false,
+      expectBodyValue: true,
+      expectDeleteHeader: 0,
+      serializedBody: false,
+    },
+    {
+      body: {},
+      expectBodyValue: true,
+      expectDeleteHeader: 0,
+      serializedBody: '{"key":"value"}',
+    },
+  ];
+
+  it.each(scenarios)(
+    'handles $serializedBody serializedBody value',
+    async ({ body, expectBodyValue, expectDeleteHeader, serializedBody }) => {
+      const spy = vi.spyOn(HttpHeaders.prototype, 'delete');
+
+      const request = client.requestOptions({
+        body,
+        bodySerializer: () => serializedBody,
+        httpClient: vi.fn() as Partial<HttpClient> as HttpClient,
+        url: '/test',
+      });
+
+      expect(request).toMatchObject(
+        expect.objectContaining({
+          body: expectBodyValue ? serializedBody : null,
+        }),
+      );
+
+      expect(spy).toHaveBeenCalledTimes(expectDeleteHeader);
+    },
+  );
+});

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

@@ -67,7 +67,7 @@ export const createClient = (config: Config = {}): Client => {
       ...options,
       headers: mergeHeaders(_config.headers, options.headers),
       httpClient: options.httpClient ?? _config.httpClient,
-      serializedBody: options.body as any,
+      serializedBody: undefined,
     };
 
     if (!opts.httpClient) {
@@ -81,12 +81,12 @@ export const createClient = (config: Config = {}): Client => {
       }
     }
 
-    if (opts.body && opts.bodySerializer) {
+    if (opts.body !== undefined && opts.bodySerializer) {
       opts.serializedBody = opts.bodySerializer(opts.body);
     }
 
     // remove Content-Type header if body is empty to avoid sending invalid requests
-    if (opts.serializedBody === undefined || opts.serializedBody === '') {
+    if (opts.body === undefined || opts.serializedBody === '') {
       opts.headers.delete('Content-Type');
     }
 
@@ -95,7 +95,7 @@ export const createClient = (config: Config = {}): Client => {
     const req = new HttpRequest<unknown>(
       opts.method ?? 'GET',
       url,
-      opts.serializedBody || null,
+      getValidRequestBody(opts),
       {
         redirect: 'follow',
         ...opts,
@@ -199,6 +199,25 @@ export const createClient = (config: Config = {}): Client => {
     }
   };
 
+  function getValidRequestBody(options: ResolvedRequestOptions) {
+    const hasBody = options.body !== undefined;
+    const isSerializedBody = hasBody && options.bodySerializer;
+
+    if (isSerializedBody) {
+      const hasSerializedBody =
+        options.serializedBody !== undefined && options.serializedBody !== '';
+
+      return hasSerializedBody ? options.serializedBody : null;
+    }
+
+    // plain/text body
+    if (hasBody) {
+      return options.body;
+    }
+
+    return undefined;
+  }
+
   const makeMethodFn =
     (method: Uppercase<HttpMethod>) => (options: RequestOptions) =>
       request({ ...options, method });