Add support for returning all response headers in node sdk for error responses (#625)

* feat: add support for returning all response headers in node sdk for error responses

* Ensure current tests pass with the new change

* feat: add support for returning all response headers in node sdk for error responses

* Fix: renamed x-flow-id to x-fastly-id

* prettier

* Fix: tests

* code clean-up

* fixed lint errors

Author: AaronDDM

src/apiClient.ts

@@ -11,6 +11,15 @@ import { SDK_VERSION } from './version.js';
 import FormData from 'form-data';
 import { snakeCase } from 'change-case';
 
+/**
+ * The header key for the debugging flow ID
+ */
+export const FLOW_ID_HEADER = 'x-fastly-id';
+/**
+ * The header key for the request ID
+ */
+export const REQUEST_ID_HEADER = 'x-request-id';
+
 /**
  * Options for a request to the Nylas API
  * @property path The path to the API endpoint
@@ -162,6 +171,12 @@ export default class APIClient {
         throw new Error('Failed to fetch response');
       }
 
+      const headers = response?.headers?.entries
+        ? Object.fromEntries(response.headers.entries())
+        : {};
+      const flowId = headers[FLOW_ID_HEADER];
+      const requestId = headers[REQUEST_ID_HEADER];
+
       if (response.status > 299) {
         const text = await response.text();
         let error: Error;
@@ -175,13 +190,27 @@ export default class APIClient {
             options.path.includes('connect/revoke');
 
           if (isAuthRequest) {
-            error = new NylasOAuthError(camelCaseError, response.status);
+            error = new NylasOAuthError(
+              camelCaseError,
+              response.status,
+              requestId,
+              flowId,
+              headers
+            );
           } else {
-            error = new NylasApiError(camelCaseError, response.status);
+            error = new NylasApiError(
+              camelCaseError,
+              response.status,
+              requestId,
+              flowId,
+              headers
+            );
           }
         } catch (e) {
           throw new Error(
-            `Received an error but could not parse response from the server: ${text}`
+            `Received an error but could not parse response from the server${
+              flowId ? ` with flow ID ${flowId}` : ''
+            }: ${text}`
           );
         }
 
@@ -234,10 +263,17 @@ export default class APIClient {
   }
 
   async requestWithResponse<T>(response: Response): Promise<T> {
+    const headers = response?.headers?.entries
+      ? Object.fromEntries(response.headers.entries())
+      : {};
+    const flowId = headers[FLOW_ID_HEADER];
     const text = await response.text();
 
     try {
       const responseJSON = JSON.parse(text);
+      // Inject the flow ID and headers into the response
+      responseJSON.flowId = flowId;
+      responseJSON.headers = headers;
       return objKeysToCamelCase(responseJSON, ['metadata']);
     } catch (e) {
       throw new Error(`Could not parse response from the server: ${text}`);

src/models/error.ts

@@ -10,6 +10,15 @@ export abstract class AbstractNylasApiError extends Error {
    * The HTTP status code of the error response.
    */
   statusCode?: number;
+  /**
+   * The flow ID
+   * Provide this to Nylas support to help trace requests and responses
+   */
+  flowId?: string | null;
+  /**
+   * The response headers
+   */
+  headers?: Record<string, string>;
 }
 
 /**
@@ -31,10 +40,18 @@ export class NylasApiError extends AbstractNylasApiError
    */
   providerError: any;
 
-  constructor(apiError: NylasApiErrorResponse, statusCode?: number) {
+  constructor(
+    apiError: NylasApiErrorResponse,
+    statusCode?: number,
+    requestId?: string,
+    flowId?: string,
+    headers?: Record<string, string>
+  ) {
     super(apiError.error.message);
     this.type = apiError.error.type;
-    this.requestId = apiError.requestId;
+    this.requestId = requestId;
+    this.flowId = flowId;
+    this.headers = headers;
     this.providerError = apiError.error.providerError;
     this.statusCode = statusCode;
   }
@@ -62,13 +79,22 @@ export class NylasOAuthError extends AbstractNylasApiError
    */
   errorUri: string;
 
-  constructor(apiError: NylasOAuthErrorResponse, statusCode?: number) {
+  constructor(
+    apiError: NylasOAuthErrorResponse,
+    statusCode?: number,
+    requestId?: string,
+    flowId?: string,
+    headers?: Record<string, string>
+  ) {
     super(apiError.errorDescription);
     this.error = apiError.error;
     this.errorCode = apiError.errorCode;
     this.errorDescription = apiError.errorDescription;
     this.errorUri = apiError.errorUri;
     this.statusCode = statusCode;
+    this.requestId = requestId;
+    this.flowId = flowId;
+    this.headers = headers;
   }
 }
 
@@ -84,11 +110,33 @@ export class NylasSdkTimeoutError extends AbstractNylasSdkError {
    * The timeout value set in the Nylas SDK, in seconds
    */
   timeout: number;
+  /**
+   * The request ID
+   */
+  requestId?: string;
+  /**
+   * The flow ID
+   * Provide this to Nylas support to help trace requests and responses
+   */
+  flowId?: string;
+  /**
+   * The response headers
+   */
+  headers?: Record<string, string>;
 
-  constructor(url: string, timeout: number) {
+  constructor(
+    url: string,
+    timeout: number,
+    requestId?: string,
+    flowId?: string,
+    headers?: Record<string, string>
+  ) {
     super('Nylas SDK timed out before receiving a response from the server.');
     this.url = url;
     this.timeout = timeout;
+    this.requestId = requestId;
+    this.flowId = flowId;
+    this.headers = headers;
   }
 }
 
@@ -99,6 +147,8 @@ export class NylasSdkTimeoutError extends AbstractNylasSdkError {
 export interface NylasApiErrorResponse {
   requestId: string;
   error: NylasApiErrorResponseData;
+  flowId?: string;
+  headers?: Record<string, string>;
 }
 
 /**

src/models/response.ts

@@ -17,6 +17,15 @@ export interface NylasResponse<T> {
    * The request ID
    */
   requestId: string;
+  /**
+   * The flow ID
+   * Provide this t
+   */
+  flowId?: string;
+  /**
+   * The response headers
+   */
+  headers?: Record<string, string>;
 }
 
 /**