refactor: cookie support via interceptors (#216)

* Removes axios-cookiejar-support dependency.
* Adds cookie-support.ts for providing interceptors to interact with tough-cookie.
* Updates cookiejar tests.

Author: ricellis

lib/cookie-support.ts

@@ -0,0 +1,78 @@
+/**
+ * (C) Copyright IBM Corp. 2022.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import extend from 'extend';
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { Cookie, CookieJar } from 'tough-cookie';
+import logger from './logger';
+
+export class CookieInterceptor {
+  private readonly cookieJar: CookieJar;
+
+  constructor(cookieJar: CookieJar | boolean) {
+    if (cookieJar) {
+      if (cookieJar === true) {
+        logger.debug('CookieInterceptor: creating new CookieJar');
+        this.cookieJar = new CookieJar();
+      } else {
+        logger.debug('CookieInterceptor: using supplied CookieJar');
+        this.cookieJar = cookieJar;
+      }
+    } else {
+      throw new Error('Must supply a cookie jar or true.');
+    }
+  }
+
+  public async requestInterceptor(config: AxiosRequestConfig) {
+    logger.debug('CookieInterceptor: intercepting request');
+    if (config && config.url) {
+      logger.debug(`CookieInterceptor: getting cookies for: ${config.url}`);
+      const cookieHeaderValue = await this.cookieJar.getCookieString(config.url);
+      if (cookieHeaderValue) {
+        logger.debug('CookieInterceptor: setting cookie header');
+        const cookieHeader = { cookie: cookieHeaderValue };
+        config.headers = extend(true, {}, config.headers, cookieHeader);
+      } else {
+        logger.debug(`CookieInterceptor: no cookies for: ${config.url}`);
+      }
+    } else {
+      logger.debug('CookieInterceptor: no request URL.');
+    }
+    return config;
+  }
+
+  public async responseInterceptor(response: AxiosResponse) {
+    logger.debug('CookieInterceptor: intercepting response.');
+    if (response && response.headers) {
+      logger.debug('CookieInterceptor: checking for set-cookie headers.');
+      const cookies: string[] = response.headers['set-cookie'];
+      if (cookies) {
+        logger.debug(`CookieInterceptor: setting cookies in jar for URL ${response.config.url}.`);
+        // Write cookies sequentially by chaining the promises in a reduce
+        await cookies.reduce(
+          (cookiePromise: Promise<Cookie>, cookie: string) =>
+            cookiePromise.then(() => this.cookieJar.setCookie(cookie, response.config.url)),
+          Promise.resolve(null)
+        );
+      } else {
+        logger.debug('CookieInterceptor: no set-cookie headers.');
+      }
+    } else {
+      logger.debug('CookieInterceptor: no response headers.');
+    }
+    return response;
+  }
+}

lib/request-wrapper.ts

@@ -1,7 +1,7 @@
 /* eslint-disable class-methods-use-this */
 
 /**
- * (C) Copyright IBM Corp. 2014, 2021.
+ * (C) Copyright IBM Corp. 2014, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,8 +18,6 @@
 
 import axios, { AxiosInstance, AxiosRequestConfig } from 'axios';
 import * as rax from 'retry-axios';
-
-import axiosCookieJarSupport from 'axios-cookiejar-support';
 import extend from 'extend';
 import FormData from 'form-data';
 import { OutgoingHttpHeaders } from 'http';
@@ -36,6 +34,7 @@ import {
 } from './helper';
 import logger from './logger';
 import { streamToPromise } from './stream-to-promise';
+import { CookieInterceptor } from './cookie-support';
 
 /**
  * Retry configuration options.
@@ -102,10 +101,13 @@ export class RequestWrapper {
 
     // if a cookie jar is provided, wrap the axios instance and update defaults
     if (axiosOptions.jar) {
-      axiosCookieJarSupport(this.axiosInstance);
-
       this.axiosInstance.defaults.withCredentials = true;
-      this.axiosInstance.defaults.jar = axiosOptions.jar;
+      const cookieInterceptor = new CookieInterceptor(axiosOptions.jar);
+      const requestCookieInterceptor = (config) => cookieInterceptor.requestInterceptor(config);
+      const responseCookieInterceptor = (response) =>
+        cookieInterceptor.responseInterceptor(response);
+      this.axiosInstance.interceptors.request.use(requestCookieInterceptor);
+      this.axiosInstance.interceptors.response.use(responseCookieInterceptor);
     }
 
     // get retry config properties and conditionally enable retries

package-lock.json

@@ -77,7 +77,6 @@
     "@types/node": "~10.14.19",
     "@types/tough-cookie": "^4.0.0",
     "axios": "^0.26.1",
-    "axios-cookiejar-support": "^1.0.0",
     "camelcase": "^5.3.1",
     "debug": "^4.1.1",
     "dotenv": "^6.2.0",