Bugfix: Add debug option to log response headers

packages/sdk-client/src/api/api-client-options-helper.ts

@@ -13,8 +13,11 @@ export const buildOAuth2ApiClientOptions = (params: SinchClientParameters, apiNa
   }
   const apiClientOptions: ApiClientOptions = {
     projectId: params.projectId,
-    requestPlugins: [new Oauth2TokenRequest(params.keyId, params.keySecret, params.authHostname)],
+    requestPlugins: [
+      new Oauth2TokenRequest(params.keyId, params.keySecret, params.authHostname, params.logHeadersOnError),
+    ],
     useServicePlanId: false,
+    logHeadersOnError: params.logHeadersOnError,
   };
   addPlugins(apiClientOptions, params);
   return apiClientOptions;
@@ -31,6 +34,7 @@ export const buildApplicationSignedApiClientOptions = (
       new XTimestampRequest(),
       new SigningRequest(params.applicationKey, params.applicationSecret),
     ],
+    logHeadersOnError: params.logHeadersOnError,
   };
   addPlugins(apiClientOptions, params);
   return apiClientOptions;
@@ -44,15 +48,19 @@ export const buildFlexibleOAuth2OrApiTokenApiClientOptions = (params: SinchClien
       projectId: params.servicePlanId,
       requestPlugins: [new ApiTokenRequest(params.apiToken)],
       useServicePlanId: true,
+      logHeadersOnError: params.logHeadersOnError,
     };
     if (params.projectId || params.keyId || params.keySecret) {
       console.warn('As the servicePlanId and the apiToken are provided, all other credentials will be disregarded.');
     }
   } else if (params.projectId && params.keyId && params.keySecret) {
     apiClientOptions = {
       projectId: params.projectId,
-      requestPlugins: [new Oauth2TokenRequest(params.keyId, params.keySecret, params.authHostname)],
+      requestPlugins: [
+        new Oauth2TokenRequest(params.keyId, params.keySecret, params.authHostname, params.logHeadersOnError),
+      ],
       useServicePlanId: false,
+      logHeadersOnError: params.logHeadersOnError,
     };
   }
   if (!apiClientOptions) {

packages/sdk-client/src/api/api-client-options.ts

@@ -1,5 +1,6 @@
 import { RequestPlugin } from '../plugins/core/request-plugin';
 import { ResponsePlugin } from '../plugins/core/response-plugin';
+import { DebugParameters } from '../domain';
 
 interface BaseApiClientOptions {
   /**
@@ -30,4 +31,4 @@ interface BaseApiClientOptions {
   useServicePlanId?: boolean;
 }
 
-export interface ApiClientOptions extends Partial<BaseApiClientOptions> {}
+export interface ApiClientOptions extends Partial<BaseApiClientOptions>, DebugParameters {}

packages/sdk-client/src/api/api-client.ts

@@ -133,6 +133,7 @@ export class ApiClient {
         opts = await plugin.load().transform(opts);
       }
     }
+    opts.logHeadersOnError = this.apiClientOptions.logHeadersOnError;
 
     return opts;
   };

packages/sdk-client/src/domain/domain-interface.ts

@@ -13,7 +13,8 @@ export interface SinchClientParameters extends
   Partial<ServicePlanIdCredentials>,
   Partial<ApplicationCredentials>,
   ApiHostname,
-  ApiPlugins {}
+  ApiPlugins,
+  DebugParameters {}
 
 export interface UnifiedCredentials {
   /** The project ID associated with the API Client. You can find this on your [Dashboard](https://dashboard.sinch.com/account/access-keys). */
@@ -158,3 +159,7 @@ export type ConversationRegion = SupportedConversationRegion | string;
 export const ConversationRegion = {
   ...SupportedConversationRegion,
 };
+
+export interface DebugParameters {
+  logHeadersOnError?: boolean;
+}

packages/sdk-client/src/plugins/core/request-plugin.ts

@@ -1,6 +1,7 @@
 import { Plugin, PluginRunner } from './plugin';
 import { Headers, RequestInit } from 'node-fetch';
 import FormData = require('form-data');
+import { DebugParameters } from '../../domain';
 
 export type RequestBody = string | FormData;
 
@@ -14,7 +15,7 @@ export enum RequestPluginEnum {
   X_TIMESTAMP_REQUEST = 'XTimestampRequest'
 }
 
-export interface RequestOptions extends RequestInit {
+export interface RequestOptions extends RequestInit, DebugParameters {
   /** Query Parameters */
   queryParams?: { [key: string]: string };
   /** Force body to string */

packages/sdk-client/src/plugins/exception/exception.response.ts

@@ -21,6 +21,7 @@ export class ExceptionResponse<
   ): PluginRunner<V | Record<string, unknown>, V> {
     return {
       transform: (res: V) => {
+        this.debug(context);
         if (context.exception) {
           return res;
         }
@@ -72,4 +73,13 @@ export class ExceptionResponse<
       },
     };
   }
+
+  private debug(context: ResponsePluginContext) {
+    if (context.requestOptions.logHeadersOnError && !context.response?.ok) {
+      console.debug(
+        `[Sinch SDK][Debug][${context.apiName}][${context.operationId}][${context.response?.status}]\nHTTP method: ${context.requestOptions.method}\nURL: ${context.url}\nResponse Headers: `,
+        context.response?.headers,
+      );
+    }
+  }
 }

packages/sdk-client/src/plugins/oauth2/oauth2-token.request.ts

@@ -20,6 +20,7 @@ export class Oauth2TokenRequest implements RequestPlugin {
     clientId: string,
     clientSecret: string,
     authenticationUrl?: string,
+    logHeadersOnError?: boolean,
   ) {
     const basicAuthenticationPlugin = new BasicAuthenticationRequest(
       clientId,
@@ -31,6 +32,7 @@ export class Oauth2TokenRequest implements RequestPlugin {
     this.apiClient = new ApiFetchClient({
       hostname: authenticationUrl,
       requestPlugins: [basicAuthenticationPlugin],
+      logHeadersOnError: logHeadersOnError,
     });
   }