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.logger),
+    ],
     useServicePlanId: false,
+    logger: params.logger,
   };
   addPlugins(apiClientOptions, params);
   return apiClientOptions;
@@ -31,6 +34,7 @@ export const buildApplicationSignedApiClientOptions = (
       new XTimestampRequest(),
       new SigningRequest(params.applicationKey, params.applicationSecret),
     ],
+    logger: params.logger,
   };
   addPlugins(apiClientOptions, params);
   return apiClientOptions;
@@ -44,15 +48,19 @@ export const buildFlexibleOAuth2OrApiTokenApiClientOptions = (params: SinchClien
       projectId: params.servicePlanId,
       requestPlugins: [new ApiTokenRequest(params.apiToken)],
       useServicePlanId: true,
+      logger: params.logger,
     };
     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.logger),
+      ],
       useServicePlanId: false,
+      logger: params.logger,
     };
   }
   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 { LoggerParameters } from '../domain';
 
 interface BaseApiClientOptions {
   /**
@@ -30,4 +31,4 @@ interface BaseApiClientOptions {
   useServicePlanId?: boolean;
 }
 
-export interface ApiClientOptions extends Partial<BaseApiClientOptions> {}
+export interface ApiClientOptions extends Partial<BaseApiClientOptions>, LoggerParameters {}

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

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

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

@@ -41,7 +41,7 @@ export class ApiFetchClient extends ApiClient {
       ...options,
       requestPlugins: [new VersionRequest(), ...(options.requestPlugins || [])],
       responsePlugins: [
-        new ExceptionResponse(),
+        new ExceptionResponse(undefined, options.logger),
         ...(options.responsePlugins || []),
       ],
     });

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

@@ -1,5 +1,6 @@
 import { RequestPlugin } from '../plugins/core/request-plugin';
 import { ResponsePlugin } from '../plugins/core/response-plugin';
+import { Logger } from '../logger';
 
 /**
  * Global object that holds the API configuration.
@@ -13,7 +14,8 @@ export interface SinchClientParameters extends
   Partial<ServicePlanIdCredentials>,
   Partial<ApplicationCredentials>,
   ApiHostname,
-  ApiPlugins {}
+  ApiPlugins,
+  LoggerParameters {}
 
 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 +160,8 @@ export type ConversationRegion = SupportedConversationRegion | string;
 export const ConversationRegion = {
   ...SupportedConversationRegion,
 };
+
+export interface LoggerParameters {
+  /** Logger instance to be used by the SDK */
+  logger?: Logger;
+}

packages/sdk-client/src/index.ts

@@ -1,5 +1,6 @@
 export * from './api';
 export * from './client';
 export * from './domain';
+export * from './logger';
 export * from './plugins';
 export * from './utils';

packages/sdk-client/src/logger/index.ts

@@ -0,0 +1 @@
+export * from './logger';

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

@@ -0,0 +1,6 @@
+export interface Logger {
+  debug(message: string, ...meta: any[]): void;
+  info(message: string, ...meta: any[]): void;
+  warn(message: string, ...meta: any[]): void;
+  error(message: string, ...meta: any[]): void;
+}

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 { LoggerParameters } 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, LoggerParameters {
   /** Query Parameters */
   queryParams?: { [key: string]: string };
   /** Force body to string */

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

@@ -1,6 +1,7 @@
 import { EmptyResponseError, RequestFailedError } from '../../api/api-errors';
 import { PluginRunner } from '../core';
 import { ResponsePlugin, ResponsePluginContext } from '../core/response-plugin';
+import { Logger } from '../../logger';
 
 /**
  * Plugin to fire an exception on wrong response / data
@@ -13,14 +14,19 @@ export class ExceptionResponse<
  * Initialize an instance of the class, with an optional callback function for exception handling.
  *
  * @param {Function} [callback] - A function called in case of an exception. If provided, this function is responsible for throwing the exception or not.
+ * @param {Logger} logger
  */
-  constructor(private callback?: (res: V, error: Error | undefined) => V) {}
+  constructor(
+    private callback?: (res: V, error: Error | undefined) => V,
+    private logger: Logger = console,
+  ) {}
 
   public load(
     context: ResponsePluginContext,
   ): PluginRunner<V | Record<string, unknown>, V> {
     return {
       transform: (res: V) => {
+        this.debug(context);
         if (context.exception) {
           return res;
         }
@@ -72,4 +78,27 @@ export class ExceptionResponse<
       },
     };
   }
+
+  private debug(context: ResponsePluginContext) {
+    if (!context.response?.ok) {
+      this.logger.debug(
+        `[Sinch SDK][Debug][${context.apiName}][${context.operationId}][${context.response?.status}]\nHTTP method: ${context.requestOptions.method}\nURL: ${context.url}\nResponse Headers: ${this.formatHeaders(context.response?.headers)}`,
+      );
+    }
+  }
+
+  private formatHeaders(headers: any) {
+    if (!headers || typeof headers !== 'object') {
+      return '';
+    }
+
+    return Object.entries(Object.fromEntries(headers.entries()))
+      .map(([key, value]: [any, any]) => {
+        if (value === undefined) { return `${key}=undefined`; }
+        if (value === null) { return `${key}=null`; }
+        if (typeof value === 'object') { return `${key}=${JSON.stringify(value)}`; }
+        return `${key}=${String(value)}`;
+      })
+      .join(', ');
+  }
 }

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

@@ -6,6 +6,7 @@ import { OAuth2Api } from './oauth2-api';
 import { BasicAuthenticationRequest } from '../basicAuthentication';
 import { ApiFetchClient } from '../../client/api-fetch-client';
 import { AUTH_HOSTNAME } from '../../domain';
+import { Logger } from '../../logger';
 
 export class Oauth2TokenRequest implements RequestPlugin {
   private readonly apiClient: ApiClient;
@@ -20,6 +21,7 @@ export class Oauth2TokenRequest implements RequestPlugin {
     clientId: string,
     clientSecret: string,
     authenticationUrl?: string,
+    logger?: Logger,
   ) {
     const basicAuthenticationPlugin = new BasicAuthenticationRequest(
       clientId,
@@ -31,6 +33,7 @@ export class Oauth2TokenRequest implements RequestPlugin {
     this.apiClient = new ApiFetchClient({
       hostname: authenticationUrl,
       requestPlugins: [basicAuthenticationPlugin],
+      logger,
     });
   }
 

packages/sdk-core/src/sinch-client.ts

@@ -24,6 +24,9 @@ export class SinchClient {
    * @param {SinchClientParameters} params - The object containing the Sinch credentials.
    */
   constructor(params: SinchClientParameters) {
+    if (!params.logger) {
+      params.logger = console;
+    }
     this.conversation = new ConversationService(params);
     this.elasticSipTrunking = new ElasticSipTrunkingService(params);
     this.fax = new FaxService(params);