fix: header parsing correctly

devolite · Mar 28, 2024 · 8217304 · 8217304
1 parent 26d22df
commit 8217304
Show file tree

Hide file tree

Showing 5 changed files with 160 additions and 21 deletions.
diff --git a/projects/openapi-fetch-angular/package.json b/projects/openapi-fetch-angular/package.json
@@ -1,7 +1,7 @@
 {
   "name": "openapi-fetch-angular",
   "description": "Fast, typesafe fetch client for your OpenAPI schema. Works with Angular HTTPClient API.",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "license": "MIT",
   "author": "Luna Simons <luna@bddvlpr.com> (https://bddvlpr.com)",
   "contributors": [

diff --git a/projects/openapi-fetch-angular/src/lib/openapi-client.service.spec.ts b/projects/openapi-fetch-angular/src/lib/openapi-client.service.spec.ts
@@ -103,6 +103,131 @@ describe('OpenAPIClientService', () => {
         expect(httpMock.expectOne('/query-params?string=10')).toBeDefined();
       });
     });
+
+    describe('headers', () => {
+      it('should correctly type the headers', () => {
+        service
+          // @ts-expect-error - missing required parameter
+          .get('/header-params')
+          .subscribe(({ response }) => expect(response).toBeDefined());
+        let req = httpMock.expectOne('/header-params');
+        expect(req).toBeDefined();
+
+        service
+          .get('/header-params', {
+            // @ts-expect-error - empty object
+            params: {},
+          })
+          .subscribe(({ response }) => expect(response).toBeDefined());
+        req = httpMock.expectOne('/header-params');
+        expect(req).toBeDefined();
+
+        service
+          .get('/header-params', {
+            params: {
+              header: {
+                // @ts-expect-error - wrong type
+                'x-required-header': 123,
+              },
+            },
+          })
+          .subscribe(({ response }) => expect(response).toBeDefined());
+        req = httpMock.expectOne('/header-params');
+        expect(req).toBeDefined();
+
+        service
+          .get('/header-params', {
+            params: {
+              header: {
+                'x-required-header': '123',
+              },
+            },
+          })
+          .subscribe(({ response }) => expect(response).toBeDefined());
+        req = httpMock.expectOne('/header-params');
+        expect(req).toBeDefined();
+      });
+
+      it('should correctly send headers', () => {
+        service
+          .get('/header-params', {
+            params: {
+              header: {
+                'x-required-header': '123',
+              },
+            },
+          })
+          .subscribe(({ response }) =>
+            expect(response.headers.get('x-required-header-server')).toEqual(
+              '123',
+            ),
+          );
+        const req = httpMock.expectOne('/header-params');
+
+        expect(req.request.headers.get('Content-Type')).toEqual(
+          'application/json',
+        );
+        expect(req.request.headers.get('x-required-header')).toEqual('123');
+
+        req.flush(null, { headers: { 'x-required-header-server': '123' } });
+      });
+    });
+
+    describe('headers (promise)', () => {
+      it('should correctly type the headers', () => {
+        // @ts-expect-error - missing required parameter
+        service.getPromise('/header-params');
+        expect(httpMock.expectOne('/header-params')).toBeDefined();
+
+        service.getPromise('/header-params', {
+          // @ts-expect-error - empty object
+          params: {},
+        });
+        expect(httpMock.expectOne('/header-params')).toBeDefined();
+
+        service.getPromise('/header-params', {
+          params: {
+            header: {
+              // @ts-expect-error - wrong type
+              'x-required-header': 123,
+            },
+          },
+        });
+        expect(httpMock.expectOne('/header-params')).toBeDefined();
+
+        service.getPromise('/header-params', {
+          params: {
+            header: {
+              'x-required-header': '123',
+            },
+          },
+        });
+        expect(httpMock.expectOne('/header-params')).toBeDefined();
+      });
+
+      it('should correctly send headers', () => {
+        service
+          .getPromise('/header-params', {
+            params: {
+              header: {
+                'x-required-header': '123',
+              },
+            },
+          })
+          .then(({ response }) =>
+            expect(response.headers.get('x-required-header-server')).toEqual(
+              '123',
+            ),
+          );
+        const req = httpMock.expectOne('/header-params');
+
+        expect(req.request.headers.get('Content-Type')).toEqual(
+          'application/json',
+        );
+        expect(req.request.headers.get('x-required-header')).toEqual('123');
+        req.flush(null, { headers: { 'x-required-header-server': '123' } });
+      });
+    });
   });
 
   describe('body', () => {

diff --git a/projects/openapi-fetch-angular/src/lib/openapi-client.service.ts b/projects/openapi-fetch-angular/src/lib/openapi-client.service.ts
@@ -1,7 +1,6 @@
 import {
   HttpClient,
   HttpErrorResponse,
-  HttpHeaders,
   HttpRequest,
   HttpResponse,
 } from '@angular/common/http';
@@ -13,15 +12,16 @@ import {
   FetchOptions,
 } from './openapi-client.types';
 import {
+  convertHeaders,
   createFinalURL,
   createQuerySerializer,
   mergeHeaders,
 } from './openapi-serializer';
 import { catchError, filter, lastValueFrom, map, of } from 'rxjs';
 
-export const DEFAULT_HEADERS = new HttpHeaders({
+export const DEFAULT_HEADERS = {
   'Content-Type': 'application/json',
-});
+};
 
 @Injectable({
   providedIn: 'root',
@@ -92,7 +92,9 @@ export abstract class OpenAPIClientService<Paths extends {}> {
       const requestInit = {
         ...baseOptions,
         ...init,
-        headers: mergeHeaders(baseHeaders, headers, params.headers),
+        headers: convertHeaders(
+          mergeHeaders(baseHeaders, headers, params.header),
+        ),
       };
 
       const request = new HttpRequest(
@@ -160,7 +162,9 @@ export abstract class OpenAPIClientService<Paths extends {}> {
       const requestInit = {
         ...baseOptions,
         ...init,
-        headers: mergeHeaders(baseHeaders, headers, params.headers),
+        headers: convertHeaders(
+          mergeHeaders(baseHeaders, headers, params.header),
+        ),
       };
 
       const request = new HttpRequest(

diff --git a/projects/openapi-fetch-angular/src/lib/openapi-client.types.ts b/projects/openapi-fetch-angular/src/lib/openapi-client.types.ts
@@ -1,4 +1,4 @@
-import { HttpHeaders, HttpRequest, HttpResponse } from '@angular/common/http';
+import { HttpRequest, HttpResponse } from '@angular/common/http';
 import {
   ErrorResponse,
   FilterKeys,
@@ -35,7 +35,10 @@ export interface ClientOptions
   headers?: HeadersOptions;
 }
 
-export type HeadersOptions = HttpHeaders;
+export type HeadersOptions = Record<
+  string,
+  string | number | boolean | (string | number | boolean)[] | null | undefined
+>;
 
 export type ParamsOption<T> = T extends {
   parameters: any;
@@ -67,7 +70,7 @@ export type RequestBodyOption<T> =
 export type RequestOptions<T> = ParamsOption<T> &
   RequestBodyOption<T> & {
     querySerializer?: QuerySerializer<T> | QuerySerializerOptions;
-    headers?: HttpHeaders;
+    headers?: HeadersOptions;
   };
 
 export type FetchOptions<T> = RequestOptions<T> &

diff --git a/projects/openapi-fetch-angular/src/lib/openapi-serializer.ts b/projects/openapi-fetch-angular/src/lib/openapi-serializer.ts
@@ -1,5 +1,6 @@
 import { HttpHeaders } from '@angular/common/http';
 import {
+  HeadersOptions,
   QuerySerializer,
   QuerySerializerOptions,
 } from './openapi-client.types';
@@ -201,20 +202,26 @@ export const serializeObjectParam = (
 };
 
 export const mergeHeaders = (
-  ...allHeaders: (HttpHeaders | undefined)[]
-): HttpHeaders => {
-  let headers = new HttpHeaders();
-  for (const h of allHeaders) {
-    if (h) {
-      for (const key of h.keys()) {
-        const v = h.get(key);
-        if (v) {
-          headers = headers.append(key, v);
-        }
-      }
+  ...allHeaders: (HeadersOptions | undefined)[]
+): HeadersOptions => {
+  return allHeaders.reduce<HeadersOptions>((acc, headers) => {
+    if (!headers) {
+      return acc;
+    }
+    for (const key in headers) {
+      acc[key] = headers[key];
     }
+    return acc;
+  }, {});
+};
+
+export const convertHeaders = (headers?: HeadersOptions): HttpHeaders => {
+  let httpHeaders = new HttpHeaders();
+  for (const key in headers) {
+    if (!headers[key]) continue;
+    httpHeaders = httpHeaders.set(key, headers[key] as string);
   }
-  return headers;
+  return httpHeaders;
 };
 
 export const defaultPathSerializer = (