fix: Use isolated axios instance to prevent multiple error wrapping (#355)

* fix: Don't wrap HubSpotHTTPError

* chore: bump npm-scripts version

* fix: Use axios instances

* fix: Use axios instance for all requests

* fix: Use httpClient in trackUsage. Update tests

* refactor: Move interceptor to client

Author: chiragchadha1

api/developerTestAccounts.ts

@@ -1,4 +1,4 @@
-import axios from 'axios';
+import { httpClient } from '../http/client';
 import { http } from '../http';
 import { getAxiosConfig } from '../http/getAxiosConfig';
 import { ENVIRONMENTS } from '../constants/environments';
@@ -88,7 +88,7 @@ export function fetchDeveloperTestAccountData(
     },
   };
 
-  return axios<DeveloperTestAccount>(reqWithToken);
+  return httpClient<DeveloperTestAccount>(reqWithToken);
 }
 
 export function installOauthAppIntoDeveloperTestAccount(

api/localDevAuth.ts

@@ -8,7 +8,7 @@ import {
   EnabledFeaturesResponse,
   ScopeAuthorizationResponse,
 } from '../types/Accounts';
-import axios from 'axios';
+import { httpClient } from '../http/client';
 import { PublicAppInstallationData } from '../types/Apps';
 import { HubSpotPromise } from '../types/Http';
 
@@ -31,7 +31,7 @@ export function fetchAccessToken(
     params: portalId ? { portalId } : {},
   });
 
-  return axios<AccessTokenResponse>({
+  return httpClient<AccessTokenResponse>({
     ...axiosConfig,
     method: 'post',
   });

api/sandboxHubs.ts

@@ -1,4 +1,5 @@
-import axios, { AxiosPromise } from 'axios';
+import { AxiosPromise } from 'axios';
+import { httpClient } from '../http/client';
 import { http } from '../http';
 import { getAxiosConfig } from '../http/getAxiosConfig';
 import { ENVIRONMENTS } from '../constants/environments';
@@ -63,7 +64,7 @@ export function fetchSandboxHubData(
     },
   };
 
-  return axios<SandboxHubData>(reqWithToken);
+  return httpClient<SandboxHubData>(reqWithToken);
 }
 
 export function createV2Sandbox(

http/__tests__/index.test.ts

@@ -1,4 +1,5 @@
-import axios, { AxiosError } from 'axios';
+import { AxiosError } from 'axios';
+import { httpClient } from '../client';
 import fs from 'fs-extra';
 import moment from 'moment';
 import {
@@ -11,7 +12,7 @@ import { version } from '../../package.json';
 import { HubSpotConfigAccount } from '../../types/Accounts';
 
 jest.mock('fs-extra');
-jest.mock('axios');
+jest.mock('../client');
 jest.mock('../../config');
 jest.mock('../../lib/logger');
 
@@ -27,7 +28,7 @@ jest.mock('https', () => ({
   }),
 }));
 
-const mockedAxios = jest.mocked(axios);
+const mockedAxios = jest.mocked(httpClient);
 const getConfig = __getConfig as jest.MockedFunction<typeof __getConfig>;
 const getConfigAccountById = __getConfigAccountById as jest.MockedFunction<
   typeof __getConfigAccountById

http/__tests__/unauthed.ts

@@ -1,9 +1,9 @@
-import axios from 'axios';
+import { httpClient } from '../client';
 import { getConfig as __getConfig } from '../../config';
 import { http } from '../unauthed';
 import { version } from '../../package.json';
 
-jest.mock('axios');
+jest.mock('../client');
 jest.mock('../../config');
 
 jest.mock('http', () => ({
@@ -18,7 +18,7 @@ jest.mock('https', () => ({
   }),
 }));
 
-const mockedAxios = jest.mocked(axios);
+const mockedAxios = jest.mocked(httpClient);
 const getConfig = __getConfig as jest.MockedFunction<typeof __getConfig>;
 
 describe('http/index', () => {

http/client.ts

@@ -0,0 +1,77 @@
+import axios, { AxiosResponse, isAxiosError } from 'axios';
+import { HubSpotHttpError } from '../models/HubSpotHttpError';
+import { logger } from '../lib/logger';
+import { LOCALDEVAUTH_ACCESS_TOKEN_PATH } from '../api/localDevAuth';
+import { FIREALARM_API_AUTH_PATH } from '../api/fireAlarm';
+import * as util from 'util';
+import { CMS_CLI_USAGE_PATH, VSCODE_USAGE_PATH } from '../lib/trackUsage';
+
+// Create an isolated axios instance for this copy of local-dev-lib.
+// This prevents issues when multiple copies are loaded and share the global
+// axios, where each copy would register interceptors on the shared instance
+// causing errors to be wrapped multiple times.
+export const httpClient = axios.create();
+
+const IGNORE_URLS_NETWORK_DEBUG = [
+  LOCALDEVAUTH_ACCESS_TOKEN_PATH,
+  CMS_CLI_USAGE_PATH,
+  VSCODE_USAGE_PATH,
+  FIREALARM_API_AUTH_PATH,
+];
+
+function logRequest(response: AxiosResponse) {
+  try {
+    if (!process.env.HUBSPOT_NETWORK_LOGGING) {
+      return;
+    }
+
+    if (
+      !process.env.HUBSPOT_DEBUG_LOGGING_VERBOSE &&
+      IGNORE_URLS_NETWORK_DEBUG.some(
+        url => response?.config?.url && response.config.url.includes(url)
+      )
+    ) {
+      return;
+    }
+
+    logger.debug(
+      util.inspect(
+        {
+          method: response.config.method,
+          baseURL: response.config.baseURL,
+          url: response.config.url,
+          data: response.data,
+          status: response.status,
+        },
+        false,
+        null,
+        true
+      )
+    );
+  } catch (error) {
+    // Ignore any errors that occur while logging the response
+  }
+}
+
+// Register interceptor on our isolated instance
+httpClient.interceptors.response.use(
+  (response: AxiosResponse) => {
+    logRequest(response);
+    return response;
+  },
+  error => {
+    try {
+      if (isAxiosError(error) && error.response) {
+        logRequest(error.response);
+      }
+    } catch (e) {
+      // Ignore any errors that occur while logging the response
+    }
+
+    // Wrap all axios errors in our own Error class. Attach the error
+    // as the cause for the new error, so we maintain the stack trace
+    return Promise.reject(
+      new HubSpotHttpError(error.message, { cause: error })
+    );
+  }
+);

http/index.ts

@@ -1,7 +1,7 @@
 import path from 'path';
 import fs from 'fs-extra';
 import contentDisposition from 'content-disposition';
-import axios, {
+import {
   AxiosRequestConfig,
   AxiosResponse,
   AxiosPromise,
@@ -23,76 +23,10 @@ import {
   OAUTH_AUTH_METHOD,
   API_KEY_AUTH_METHOD,
 } from '../constants/auth';
-import { LOCALDEVAUTH_ACCESS_TOKEN_PATH } from '../api/localDevAuth';
-import { FIREALARM_API_AUTH_PATH } from '../api/fireAlarm';
-import * as util from 'util';
-import { CMS_CLI_USAGE_PATH, VSCODE_USAGE_PATH } from '../lib/trackUsage';
+import { httpClient } from './client';
 
 const i18nKey = 'http.index';
 
-const IGNORE_URLS_NETWORK_DEBUG = [
-  LOCALDEVAUTH_ACCESS_TOKEN_PATH,
-  CMS_CLI_USAGE_PATH,
-  VSCODE_USAGE_PATH,
-  FIREALARM_API_AUTH_PATH,
-];
-
-function logRequest(response: AxiosResponse) {
-  try {
-    if (!process.env.HUBSPOT_NETWORK_LOGGING) {
-      return;
-    }
-
-    if (
-      !process.env.HUBSPOT_DEBUG_LOGGING_VERBOSE &&
-      IGNORE_URLS_NETWORK_DEBUG.some(
-        url => response?.config?.url && response.config.url.includes(url)
-      )
-    ) {
-      return;
-    }
-
-    logger.debug(
-      util.inspect(
-        {
-          method: response.config.method,
-          baseURL: response.config.baseURL,
-          url: response.config.url,
-          data: response.data,
-          status: response.status,
-        },
-        false,
-        null,
-        true
-      )
-    );
-  } catch (error) {
-    // Ignore any errors that occur while logging the response
-  }
-}
-
-axios.interceptors.response.use(
-  (response: AxiosResponse) => {
-    logRequest(response);
-    return response;
-  },
-  error => {
-    try {
-      if (isAxiosError(error) && error.response) {
-        logRequest(error.response);
-      }
-    } catch (e) {
-      // Ignore any errors that occur while logging the response
-    }
-
-    // Wrap all axios errors in our own Error class.  Attach the error
-    // as the cause for the new error, so we maintain the stack trace
-    return Promise.reject(
-      new HubSpotHttpError(error.message, { cause: error })
-    );
-  }
-);
-
 export function addUserAgentHeader(key: string, value: string) {
   USER_AGENTS[key] = value;
 }
@@ -198,39 +132,39 @@ async function getRequest<T>(
   const optionsWithParams = addQueryParams(rest, params);
   const requestConfig = await withAuth(accountId, optionsWithParams);
 
-  return axios<T>(requestConfig);
+  return httpClient<T>(requestConfig);
 }
 
 async function postRequest<T>(
   accountId: number,
   options: HttpOptions
 ): HubSpotPromise<T> {
   const requestConfig = await withAuth(accountId, options);
-  return axios<T>({ ...requestConfig, method: 'post' });
+  return httpClient<T>({ ...requestConfig, method: 'post' });
 }
 
 async function putRequest<T>(
   accountId: number,
   options: HttpOptions
 ): HubSpotPromise<T> {
   const requestConfig = await withAuth(accountId, options);
-  return axios<T>({ ...requestConfig, method: 'put' });
+  return httpClient<T>({ ...requestConfig, method: 'put' });
 }
 
 async function patchRequest<T>(
   accountId: number,
   options: HttpOptions
 ): HubSpotPromise<T> {
   const requestConfig = await withAuth(accountId, options);
-  return axios<T>({ ...requestConfig, method: 'patch' });
+  return httpClient<T>({ ...requestConfig, method: 'patch' });
 }
 
 async function deleteRequest<T>(
   accountId: number,
   options: HttpOptions
 ): HubSpotPromise<T> {
   const requestConfig = await withAuth(accountId, options);
-  return axios<T>({ ...requestConfig, method: 'delete' });
+  return httpClient<T>({ ...requestConfig, method: 'delete' });
 }
 
 function createGetRequestStream(contentType: string) {
@@ -246,7 +180,7 @@ function createGetRequestStream(contentType: string) {
     return new Promise<AxiosResponse>(async (resolve, reject) => {
       try {
         const { headers, ...opts } = await withAuth(accountId, axiosConfig);
-        const res = await axios({
+        const res = await httpClient({
           method: 'get',
           ...opts,
           headers: {

http/unauthed.ts

@@ -1,4 +1,4 @@
-import axios from 'axios';
+import { httpClient } from './client';
 import { getAxiosConfig } from './getAxiosConfig';
 import { addQueryParams } from './addQueryParams';
 import { HttpOptions, HubSpotPromise } from '../types/Http';
@@ -8,27 +8,27 @@ async function getRequest<T>(options: HttpOptions): HubSpotPromise<T> {
   const optionsWithParams = addQueryParams(rest, params);
   const requestConfig = await getAxiosConfig(optionsWithParams);
 
-  return axios<T>(requestConfig);
+  return httpClient<T>(requestConfig);
 }
 
 async function postRequest<T>(options: HttpOptions): HubSpotPromise<T> {
   const requestConfig = await getAxiosConfig(options);
-  return axios<T>({ ...requestConfig, method: 'post' });
+  return httpClient<T>({ ...requestConfig, method: 'post' });
 }
 
 async function putRequest<T>(options: HttpOptions): HubSpotPromise<T> {
   const requestConfig = await getAxiosConfig(options);
-  return axios<T>({ ...requestConfig, method: 'put' });
+  return httpClient<T>({ ...requestConfig, method: 'put' });
 }
 
 async function patchRequest<T>(options: HttpOptions): HubSpotPromise<T> {
   const requestConfig = await getAxiosConfig(options);
-  return axios<T>({ ...requestConfig, method: 'patch' });
+  return httpClient<T>({ ...requestConfig, method: 'patch' });
 }
 
 async function deleteRequest<T>(options: HttpOptions): HubSpotPromise<T> {
   const requestConfig = await getAxiosConfig(options);
-  return axios<T>({ ...requestConfig, method: 'delete' });
+  return httpClient<T>({ ...requestConfig, method: 'delete' });
 }
 
 export const http = {

lib/__tests__/trackUsage.test.ts

@@ -1,4 +1,4 @@
-import axios from 'axios';
+import { httpClient } from '../../http/client';
 import {
   trackUsage,
   CMS_CLI_USAGE_PATH,
@@ -14,12 +14,12 @@ import { FILE_MAPPER_API_PATH } from '../../api/fileMapper';
 import { logger } from '../logger';
 import { http } from '../../http';
 
-jest.mock('axios');
 jest.mock('../../config');
 jest.mock('../logger');
 jest.mock('../../http');
+jest.mock('../../http/client');
 
-const mockedAxios = jest.mocked(axios);
+const mockedAxios = jest.mocked(httpClient);
 const mockedLogger = jest.mocked(logger);
 const mockedHttp = jest.mocked(http);
 const getConfigAccountById = __getConfigAccountById as jest.MockedFunction<

lib/__tests__/watch.test.ts

@@ -6,7 +6,7 @@ import { watch } from '../cms/watch';
 import { CMS_PUBLISH_MODE } from '../../constants/files';
 
 jest.mock('chokidar');
-jest.mock('axios');
+jest.mock('../../http/client');
 jest.mock('p-queue');
 jest.mock('../cms/uploadFolder');