Include resolved oauth2 authorization details in req object to be usa…

…ble by scripts The new variable 'credentials' is now available in 'req' object. It is added automatically during request preparation if oauth2 method is used and is value is either evaluated or retrieved from collection oauth2 cache. usebruno#1999 usebruno#1003
pietrygamat · Apr 14, 2024 · 6043b9a · 6043b9a
1 parent 857c459
commit 6043b9a
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 33 deletions.
diff --git a/packages/bruno-electron/src/ipc/network/index.js b/packages/bruno-electron/src/ipc/network/index.js
@@ -35,7 +35,8 @@ const {
   getOAuth2DataAuthorizationCode,
   getOAuth2DataClientCredentials,
   getOAuth2DataPasswordCredentials,
-  getOAuth2DataImplicit
+  getOAuth2DataImplicit,
+  getCachedCredentials
 } = require('./oauth2-helper');
 const Oauth2Store = require('../../store/oauth2');
 
@@ -208,24 +209,28 @@ const configureRequest = async (
       case 'authorization_code': {
         interpolateVars(requestCopy, envVars, collectionVariables, processEnvVars);
         const { oauth2Data } = await getOAuth2DataAuthorizationCode(requestCopy, collectionUid);
+        request.credentials = oauth2Data;
         request.headers['Authorization'] = `Bearer ${oauth2Data.access_token}`;
         break;
       }
       case 'client_credentials': {
         interpolateVars(requestCopy, envVars, collectionVariables, processEnvVars);
         const { oauth2Data } = await getOAuth2DataClientCredentials(requestCopy, collectionUid);
+        request.credentials = oauth2Data;
         request.headers['Authorization'] = `Bearer ${oauth2Data.access_token}`;
         break;
       }
       case 'password': {
         interpolateVars(requestCopy, envVars, collectionVariables, processEnvVars);
         const { oauth2Data } = await getOAuth2DataPasswordCredentials(requestCopy, collectionUid);
+        request.credentials = oauth2Data;
         request.headers['Authorization'] = `Bearer ${oauth2Data.access_token}`;
         break;
       }
       case 'implicit': {
         interpolateVars(requestCopy, envVars, collectionVariables, processEnvVars);
         const { oauth2Data } = await getOAuth2DataImplicit(requestCopy, collectionUid);
+        request.credentials = oauth2Data;
         request.headers['Authorization'] = `Bearer ${oauth2Data.access_token}`;
         break;
       }

diff --git a/packages/bruno-electron/src/ipc/network/oauth2-helper.js b/packages/bruno-electron/src/ipc/network/oauth2-helper.js
@@ -17,11 +17,10 @@ const generateCodeChallenge = (codeVerifier) => {
   return base64Hash.replace(/\+/g, '-').replace(/\//g, '_').replace(/=/g, '');
 };
 
-const checkPersistedOauth2Data = (collectionUid) => {
+const getCachedCredentials = (collectionUid) => {
   const collectionOauthStore = oauth2Store.getOauth2DataOfCollection(collectionUid);
   const lastOauth2Data = collectionOauthStore.oauth2;
-  const lastAccessToken = collectionOauthStore.oauth2?.access_token;
-  return { lastOauth2Data, lastAccessToken };
+  return { lastOauth2Data };
 };
 
 const persistOauth2Data = (oauth2Data, collectionUid) => {
@@ -33,12 +32,6 @@ const persistOauth2Data = (oauth2Data, collectionUid) => {
 // AUTHORIZATION CODE
 
 const getOAuth2DataAuthorizationCode = async (request, collectionUid) => {
-  const { lastOauth2Data, lastAccessToken } = checkPersistedOauth2Data(collectionUid);
-  if (lastAccessToken) {
-    console.log('Reusing Stored access token');
-    return { oauth2Data: lastOauth2Data };
-  }
-
   let codeVerifier = generateCodeVerifier();
   let codeChallenge = generateCodeChallenge(codeVerifier);
 
@@ -104,14 +97,7 @@ const getOAuth2AuthorizationCode = (request, codeChallenge, collectionUid) => {
 // CLIENT CREDENTIALS
 
 const getOAuth2DataClientCredentials = async (request, collectionUid) => {
-  const { lastOauth2Data, lastAccessToken } = checkPersistedOauth2Data(collectionUid);
-  if (lastAccessToken) {
-    console.log('Reusing Stored access token');
-    return { oauth2Data: lastOauth2Data };
-  }
-
-  let requestCopy = cloneDeep(request);
-  const oAuth = get(requestCopy, 'oauth2', {});
+  const oAuth = get(request, 'oauth2', {});
   const { clientId, clientSecret, scope } = oAuth;
   const data = {
     grant_type: 'client_credentials',
@@ -122,7 +108,7 @@ const getOAuth2DataClientCredentials = async (request, collectionUid) => {
   request.method = 'POST';
   request.headers['content-type'] = 'application/x-www-form-urlencoded';
   request.data = data;
-  request.url = requestCopy?.oauth2?.accessTokenUrl;
+  request.url = request?.oauth2?.accessTokenUrl;
 
   const axiosInstance = makeAxiosInstance();
   let response = await axiosInstance(request);
@@ -134,12 +120,6 @@ const getOAuth2DataClientCredentials = async (request, collectionUid) => {
 // PASSWORD CREDENTIALS
 
 const getOAuth2DataPasswordCredentials = async (request, collectionUid) => {
-  const { lastOauth2Data, lastAccessToken } = checkPersistedOauth2Data(collectionUid);
-  if (lastAccessToken) {
-    console.log('Reusing Stored access token');
-    return { oauth2Data: lastOauth2Data };
-  }
-
   const oAuth = get(request, 'oauth2', {});
   const { username, password, clientId, clientSecret, scope } = oAuth;
   const data = {
@@ -165,12 +145,6 @@ const getOAuth2DataPasswordCredentials = async (request, collectionUid) => {
 // IMPLICIT
 
 const getOAuth2DataImplicit = async (request, collectionUid) => {
-  const { lastOauth2Data, lastAccessToken } = checkPersistedOauth2Data(collectionUid);
-  if (lastAccessToken) {
-    console.log('Reusing Stored access token');
-    return { oauth2Data: lastOauth2Data };
-  }
-
   return new Promise(async (resolve, reject) => {
     const { oauth2 } = request;
     const { callbackUrl, authorizationUrl, clientId, scope } = oauth2;
@@ -190,7 +164,6 @@ const getOAuth2DataImplicit = async (request, collectionUid) => {
       });
       resolve({ oauth2Data });
       persistOauth2Data(oauth2Data, collectionUid);
-      request.auth.oauth2.oauth2Data = oauth2Data;
     } catch (err) {
       reject(err);
     }
@@ -201,5 +174,6 @@ module.exports = {
   getOAuth2DataAuthorizationCode,
   getOAuth2DataClientCredentials,
   getOAuth2DataPasswordCredentials,
-  getOAuth2DataImplicit
+  getOAuth2DataImplicit,
+  getCachedCredentials
 };
diff --git a/packages/bruno-js/src/bruno-request.js b/packages/bruno-js/src/bruno-request.js
@@ -6,6 +6,7 @@ class BrunoRequest {
     this.headers = req.headers;
     this.body = req.data;
     this.timeout = req.timeout;
+    this.credentials = req.credentials;
   }
 
   getUrl() {