Merge pull request #4662 from sanjaikumar-bruno/fix/cli-not-following-redirects

feat: enhance axios instance with redirect handling and cookie management in CLI

Author: lohit-bruno

packages/bruno-cli/src/runner/run-single-request.js

@@ -314,6 +314,14 @@ const runSingleRequest = async function (
       }
     }
 
+    let requestMaxRedirects = request.maxRedirects
+    request.maxRedirects = 0
+    
+    // Set default value for requestMaxRedirects if not explicitly set
+    if (requestMaxRedirects === undefined) {
+      requestMaxRedirects = 5; // Default to 5 redirects
+    }
+
     // Handle OAuth2 authentication
     if (request.oauth2) {
       try {
@@ -344,7 +352,7 @@ const runSingleRequest = async function (
     let response, responseTime;
     try {
 
-      let axiosInstance = makeAxiosInstance();
+      let axiosInstance = makeAxiosInstance({ requestMaxRedirects: requestMaxRedirects, disableCookies: options.disableCookies });
       if (request.ntlmConfig) {
         axiosInstance=NtlmClient(request.ntlmConfig,axiosInstance.defaults)
         delete request.ntlmConfig;

packages/bruno-cli/src/utils/axios-instance.js

@@ -1,23 +1,77 @@
 const axios = require('axios');
 const { CLI_VERSION } = require('../constants');
+const { addCookieToJar, getCookieStringForUrl } = require('./cookies');
+
+const redirectResponseCodes = [301, 302, 303, 307, 308];
+const METHOD_CHANGING_REDIRECTS = [301, 302, 303];
+
+const saveCookies = (url, headers) => {
+  if (headers['set-cookie']) {
+    let setCookieHeaders = Array.isArray(headers['set-cookie'])
+      ? headers['set-cookie']
+      : [headers['set-cookie']];
+    for (let setCookieHeader of setCookieHeaders) {
+      if (typeof setCookieHeader === 'string' && setCookieHeader.length) {
+        addCookieToJar(setCookieHeader, url);
+      }
+    }
+  }
+};
+
+const createRedirectConfig = (error, redirectUrl) => {
+  const requestConfig = {
+    ...error.config,
+    url: redirectUrl,
+    headers: { ...error.config.headers }
+  };
+
+  const statusCode = error.response.status;
+  const originalMethod = (error.config.method || 'get').toLowerCase();
+
+  // For 301, 302, 303: change method to GET unless it was HEAD
+  if (METHOD_CHANGING_REDIRECTS.includes(statusCode) && originalMethod !== 'head') {
+    requestConfig.method = 'get';
+    requestConfig.data = undefined;
+    
+    // Clean up headers that are no longer relevant
+    delete requestConfig.headers['content-length'];
+    delete requestConfig.headers['Content-Length'];
+    delete requestConfig.headers['content-type']; 
+    delete requestConfig.headers['Content-Type'];
+  }
+
+  return requestConfig;
+};
 
 /**
  * Function that configures axios with timing interceptors
  * Important to note here that the timings are not completely accurate.
  * @see https://github.com/axios/axios/issues/695
  * @returns {axios.AxiosInstance}
  */
-function makeAxiosInstance() {
+function makeAxiosInstance({ requestMaxRedirects = 5, disableCookies } = {}) {
+  let redirectCount = 0;
+
   /** @type {axios.AxiosInstance} */
   const instance = axios.create({
     proxy: false,
+    maxRedirects: 0,
     headers: {
       "User-Agent": `bruno-runtime/${CLI_VERSION}`
     }
   });
 
   instance.interceptors.request.use((config) => {
     config.headers['request-start-time'] = Date.now();
+
+    // Add cookies to request if available and not disabled
+    if (!disableCookies) {
+      const cookieString = getCookieStringForUrl(config.url);
+      if (cookieString && typeof cookieString === 'string' && cookieString.length) {
+        config.headers['cookie'] = cookieString;
+      }
+    }
+
     return config;
   });
 
@@ -26,13 +80,51 @@ function makeAxiosInstance() {
       const end = Date.now();
       const start = response.config.headers['request-start-time'];
       response.headers['request-duration'] = end - start;
+      redirectCount = 0;
+
       return response;
     },
     (error) => {
       if (error.response) {
         const end = Date.now();
         const start = error.config.headers['request-start-time'];
         error.response.headers['request-duration'] = end - start;
+
+        if (redirectResponseCodes.includes(error.response.status)) {
+          if (redirectCount >= requestMaxRedirects) {
+            const err = new Error(`Maximum redirects (${requestMaxRedirects}) exceeded`);
+            err.originalError = error;
+            return Promise.reject(err);
+          }
+
+          const locationHeader = error.response.headers.location;
+          if (!locationHeader) {
+            return Promise.reject(new Error('Redirect location header missing'));
+          }
+
+          redirectCount++;
+          let redirectUrl = locationHeader;
+
+          if (!locationHeader.match(/^https?:\/\//i)) {
+            const URL = require('url');
+            redirectUrl = URL.resolve(error.config.url, locationHeader);
+          }
+
+          if (!disableCookies){
+            saveCookies(redirectUrl, error.response.headers);
+          }
+
+          const requestConfig = createRedirectConfig(error, redirectUrl);
+
+          if (!disableCookies) {
+            const cookieString = getCookieStringForUrl(redirectUrl);
+            if (cookieString && typeof cookieString === 'string' && cookieString.length) {
+              requestConfig.headers['cookie'] = cookieString;
+            }
+          }
+
+          return instance(requestConfig);
+        }
       }
       return Promise.reject(error);
     }