PER-9985

Move the response type to the request options in the http-v2 service

Author: crisnicandrei

src/app/shared/services/api/idpuser.repo.ts

@@ -18,8 +18,9 @@ export class IdPuser extends BaseRepo {
         '/v2/idpuser/send-enable-code',
         { method, value },
         undefined,
-        {},
-        'text',
+        {
+          responseType: 'text',
+        },
       ),
     );
   }
@@ -34,8 +35,9 @@ export class IdPuser extends BaseRepo {
           code,
         },
         undefined,
-        {},
-        'text',
+        {
+          responseType: 'text',
+        },
       ),
     );
   }
@@ -46,8 +48,7 @@ export class IdPuser extends BaseRepo {
         '/v2/idpuser/send-disable-code',
         { methodId },
         undefined,
-        {},
-        'text',
+        { responseType: 'text' },
       ),
     );
   }
@@ -58,8 +59,9 @@ export class IdPuser extends BaseRepo {
         '/v2/idpuser/disable-two-factor',
         { code, methodId },
         undefined,
-        {},
-        'text',
+        {
+          responseType: 'text',
+        },
       ),
     );
   }

src/app/shared/services/http-v2/http-v2.service.spec.ts

@@ -287,7 +287,9 @@ describe('HttpV2Service', () => {
 
   it('should correctly handle responseType: text', (done) => {
     service
-      .post('/api/v2/health', {}, undefined, {}, 'text')
+      .post('/api/v2/health', {}, undefined, {
+        responseType: 'text',
+      })
       .toPromise()
       .then((response) => {
         expect(typeof response[0]).toBe('string');

src/app/shared/services/http-v2/http-v2.service.ts

@@ -13,17 +13,20 @@ const AUTH_KEY = 'AUTH_TOKEN';
 
 type HttpMethod = 'post' | 'get' | 'put' | 'delete';
 type ResponseClass<T> = new (data: any) => T;
+type ResponseType = 'json' | 'text';
 
 interface RequestOptions {
   csrf?: boolean;
   authToken?: boolean;
   useStelaDomain?: boolean;
+  responseType?: ResponseType;
 }
 
 const defaultOptions: RequestOptions = {
   csrf: false,
   authToken: true,
   useStelaDomain: true,
+  responseType: 'json',
 };
 
 export function getFirst<T>(observable: Observable<T[]>): Observable<T> {
@@ -61,15 +64,13 @@ export class HttpV2Service {
     data: any = {},
     responseClass?: ResponseClass<T>,
     options: RequestOptions = defaultOptions,
-    responseType?: 'json' | 'text',
   ): Observable<T[]> {
     return this.makeHttpClientRequest(
       endpoint,
       data,
       'post',
       responseClass,
       this.getOptions(options),
-      responseType,
     );
   }
 
@@ -78,15 +79,13 @@ export class HttpV2Service {
     data: any = {},
     responseClass?: ResponseClass<T>,
     options: RequestOptions = defaultOptions,
-    responseType?: 'json' | 'text',
   ): Observable<T[]> {
     return this.makeHttpClientRequest(
       this.getEndpointWithData(endpoint, data),
       {},
       'get',
       responseClass,
       this.getOptions(options),
-      responseType,
     );
   }
 
@@ -95,15 +94,13 @@ export class HttpV2Service {
     data: any = {},
     responseClass?: ResponseClass<T>,
     options: RequestOptions = defaultOptions,
-    responseType?: 'json' | 'text',
   ): Observable<T[]> {
     return this.makeHttpClientRequest(
       endpoint,
       data,
       'put',
       responseClass,
       this.getOptions(options),
-      responseType,
     );
   }
 
@@ -112,15 +109,13 @@ export class HttpV2Service {
     data: any = {},
     responseClass?: ResponseClass<T>,
     options: RequestOptions = defaultOptions,
-    responseType?: 'json' | 'text',
   ): Observable<T[]> {
     return this.makeHttpClientRequest(
       this.getEndpointWithData(endpoint, data),
       {},
       'delete',
       responseClass,
       this.getOptions(options),
-      responseType,
     );
   }
 
@@ -194,56 +189,50 @@ export class HttpV2Service {
     data: any = {},
     method: HttpMethod,
     options: RequestOptions,
-    responseType: any = 'json',
   ): Observable<unknown> {
+    const requestOptions: Object = {
+      ...this.getHeaders(options),
+      responseType: options.responseType,
+    };
     if (method === 'put') {
-      return this.http.put(url, data, {
-        ...this.getHeaders(options),
-        responseType,
-      });
+      return this.http.put(url, data, requestOptions);
     }
-    return this.http.post(url, data, {
-      ...this.getHeaders(options),
-      responseType,
-    });
+    return this.http.post(url, data, requestOptions);
   }
 
   protected getObservableWithNoBody(
     url: string,
     method: HttpMethod,
     options: RequestOptions,
-    responseType: any = 'json',
   ): Observable<unknown> {
+    const requestOptions: Object = {
+      ...this.getHeaders(options),
+      responseType: options.responseType,
+    };
     if (method === 'delete') {
-      return this.http.delete(url, {
-        ...this.getHeaders(options),
-        responseType,
-      });
+      return this.http.delete(url, requestOptions);
     }
-    return this.http.get(url, { ...this.getHeaders(options), responseType });
+    return this.http.get(url, requestOptions);
   }
 
   protected getObservable(
     endpoint: string,
     data: any = {},
     method: HttpMethod = 'post',
     options: RequestOptions = defaultOptions,
-    responseType: 'json' | 'text' = 'json',
   ): Observable<unknown> {
     if (method === 'post' || method === 'put') {
       return this.getObservableWithBody(
         this.getFullUrl(endpoint, options),
         options.csrf ? this.appendCsrf(data) : data,
         method,
         options,
-        responseType,
       );
     }
     return this.getObservableWithNoBody(
       this.getFullUrl(endpoint, options),
       method,
       options,
-      responseType,
     );
   }
 
@@ -253,19 +242,12 @@ export class HttpV2Service {
     method: HttpMethod = 'post',
     responseClass?: new (data: any) => T,
     options: RequestOptions = defaultOptions,
-    responseType: 'json' | 'text' = 'json', // NEW: response type parameter
   ): Observable<T[]> {
-    const observable = this.getObservable(
-      endpoint,
-      data,
-      method,
-      options,
-      responseType,
-    );
+    const observable = this.getObservable(endpoint, data, method, options);
 
     return observable.pipe(
       map((response: Object | Array<Object>) => {
-        if (responseType === 'text') {
+        if (options.responseType === 'text') {
           return [response as unknown as T];
         }