fix(axios): update order of interceptors

2024-07-26 12:43:58 +00:00
parent 509a414151
commit 4c639f170e
3 changed files with 174 additions and 117 deletions
--- a/packages/backend/src/helpers/axios-with-proxy.js
+++ b/packages/backend/src/helpers/axios-with-proxy.js
@@ -3,70 +3,99 @@ import { HttpsProxyAgent } from 'https-proxy-agent';
 import { HttpProxyAgent } from 'http-proxy-agent';
 import appConfig from '../config/app.js';

-const config = axios.defaults;
-const httpProxyUrl = appConfig.httpProxy;
-const httpsProxyUrl = appConfig.httpsProxy;
-const supportsProxy = httpProxyUrl || httpsProxyUrl;
-const noProxyEnv = appConfig.noProxy;
-const noProxyHosts = noProxyEnv ? noProxyEnv.split(',').map(host => host.trim()) : [];
+export function createInstance(customConfig = {}, { requestInterceptor, responseErrorInterceptor } = {}) {
+  const config = {
+    ...axios.defaults,
+    ...customConfig
+  };
+  const httpProxyUrl = appConfig.httpProxy;
+  const httpsProxyUrl = appConfig.httpsProxy;
+  const supportsProxy = httpProxyUrl || httpsProxyUrl;
+  const noProxyEnv = appConfig.noProxy;
+  const noProxyHosts = noProxyEnv ? noProxyEnv.split(',').map(host => host.trim()) : [];

-if (supportsProxy) {
-  if (httpProxyUrl) {
-    config.httpAgent = new HttpProxyAgent(httpProxyUrl);
+  if (supportsProxy) {
+    if (httpProxyUrl) {
+      config.httpAgent = new HttpProxyAgent(httpProxyUrl);
+    }
+
+    if (httpsProxyUrl) {
+      config.httpsAgent = new HttpsProxyAgent(httpsProxyUrl);
+    }
+
+    config.proxy = false;
  }

-  if (httpsProxyUrl) {
-    config.httpsAgent = new HttpsProxyAgent(httpsProxyUrl);
+  const instance = axios.create(config);
+
+  function shouldSkipProxy(hostname) {
+    return noProxyHosts.some(noProxyHost => {
+      return hostname.endsWith(noProxyHost) || hostname === noProxyHost;
+    });
+  };
+
+  /**
+   * The interceptors are executed in the reverse order they are added.
+   */
+  instance.interceptors.request.use(
+    function skipProxyIfInNoProxy(requestConfig) {
+      const hostname = new URL(requestConfig.baseURL).hostname;
+
+      if (supportsProxy && shouldSkipProxy(hostname)) {
+        requestConfig.httpAgent = undefined;
+        requestConfig.httpsAgent = undefined;
+      }
+
+      return requestConfig;
+    },
+    (error) => Promise.reject(error)
+  );
+
+  // not always we have custom request interceptors
+  if (requestInterceptor) {
+    instance.interceptors.request.use(
+      function customInterceptor(requestConfig) {
+        const result = requestInterceptor.reduce((newConfig, requestInterceptor) => {
+          return requestInterceptor(newConfig);
+        }, requestConfig);
+
+        return result;
+      }
+    );
  }

-  config.proxy = false;
+  instance.interceptors.request.use(
+    function removeBaseUrlForAbsoluteUrls(requestConfig) {
+      /**
+       * If the URL is an absolute URL, we remove its origin out of the URL
+       * and set it as baseURL. This lets us streamlines the requests made by Automatisch
+       * and requests made by app integrations.
+       */
+      try {
+        const url = new URL(requestConfig.url);
+        requestConfig.baseURL = url.origin;
+        requestConfig.url = url.pathname + url.search;
+
+        return requestConfig;
+      } catch (err) {
+        return requestConfig;
+      }
+    },
+    (error) => Promise.reject(error)
+  );
+
+
+  // not always we have custom response error interceptor
+  if (responseErrorInterceptor) {
+    instance.interceptors.response.use(
+      (response) => response,
+      responseErrorInterceptor
+    );
+  }
+
+  return instance;
 }

-const axiosWithProxyInstance = axios.create(config);
+const defaultInstance = createInstance();

-function shouldSkipProxy(hostname) {
-  return noProxyHosts.some(noProxyHost => {
-    return hostname.endsWith(noProxyHost) || hostname === noProxyHost;
-  });
-};
-
-/**
- * The interceptors are executed in the reverse order they are added.
- */
-axiosWithProxyInstance.interceptors.request.use(
-  function skipProxyIfInNoProxy(requestConfig) {
-    const hostname = new URL(requestConfig.baseURL).hostname;
-
-    if (supportsProxy && shouldSkipProxy(hostname)) {
-      requestConfig.httpAgent = undefined;
-      requestConfig.httpsAgent = undefined;
-    }
-
-    return requestConfig;
-  },
-  undefined,
-  { synchronous: true }
-);
-
-axiosWithProxyInstance.interceptors.request.use(
-  function removeBaseUrlForAbsoluteUrls(requestConfig) {
-    /**
-     * If the URL is an absolute URL, we remove its origin out of the URL
-     * and set it as baseURL. This lets us streamlines the requests made by Automatisch
-     * and requests made by app integrations.
-     */
-    try {
-      const url = new URL(requestConfig.url);
-      requestConfig.baseURL = url.origin;
-      requestConfig.url = url.pathname + url.search;
-
-      return requestConfig;
-    } catch {
-      return requestConfig;
-    }
-  },
-  undefined,
-  { synchronous: true}
-);
-
-export default axiosWithProxyInstance;
+export default defaultInstance;