ibm-cloud-sdk-core
Version:
Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.
125 lines (124 loc) • 5.6 kB
JavaScript
/**
* (C) Copyright IBM Corp. 2022, 2023.
*
* 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.
*/
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
import { isAxiosError } from 'axios';
import extend from 'extend';
import { CookieJar } from 'tough-cookie';
import logger from './logger';
const internalCreateCookieInterceptor = (cookieJar) => {
/**
* This is called by Axios when a request is about to be sent in order to
* set the "cookie" header in the request.
*
* @param config the Axios request config
* @returns the request config
*/
function requestInterceptor(config) {
return __awaiter(this, void 0, void 0, function* () {
logger.debug('CookieInterceptor: intercepting request');
if (config && config.url) {
logger.debug(`CookieInterceptor: getting cookies for: ${config.url}`);
const cookieHeaderValue = yield 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;
});
}
/**
* This is called by Axios when a 2xx response has been received.
* We'll invoke the configured cookie jar's setCookie() method to handle
* the "set-cookie" header.
* @param response the Axios response object
* @returns the response object
*/
function responseInterceptor(response) {
return __awaiter(this, void 0, void 0, function* () {
logger.debug('CookieInterceptor: intercepting response to check for set-cookie headers.');
if (response && response.headers) {
const cookies = 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
yield cookies.reduce((cookiePromise, cookie) => cookiePromise.then(() => 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;
});
}
/**
* This is called by Axios when a non-2xx response has been received.
* We'll simply delegate to the "responseInterceptor" method since we want to
* do the same cookie handling as for a success response.
* @param error the Axios error object that describes the non-2xx response
* @returns the error object
*/
function responseRejected(error) {
return __awaiter(this, void 0, void 0, function* () {
logger.debug('CookieIntercepter: intercepting error response');
if (isAxiosError(error) && error.response) {
logger.debug('CookieIntercepter: delegating to responseInterceptor()');
yield responseInterceptor(error.response);
}
else {
logger.debug('CookieInterceptor: no response field in error object, skipping...');
}
return Promise.reject(error);
});
}
return (axios) => {
axios.interceptors.request.use(requestInterceptor);
axios.interceptors.response.use(responseInterceptor, responseRejected);
};
};
export const createCookieInterceptor = (cookieJar) => {
if (cookieJar) {
if (cookieJar === true) {
logger.debug('CookieInterceptor: creating new CookieJar');
return internalCreateCookieInterceptor(new CookieJar());
}
else {
logger.debug('CookieInterceptor: using supplied CookieJar');
return internalCreateCookieInterceptor(cookieJar);
}
}
else {
throw new Error('Must supply a cookie jar or true.');
}
};