feat/rename collectionVariables variable name to runtimeVariables (us…

…ebruno#2638) * pr review changes * collection root object in export json * import environment updates * tests run execution order fix for collection runs * updated validations * collectionVariables -> runtimeVariables * removed husky, adjusted indentation --------- Co-authored-by: Anoop M D <[email protected]>
lohxt1 · Jul 17, 2024 · ab9bcbe · ab9bcbe
1 parent e60aaf2
commit ab9bcbe
Show file tree

Hide file tree

Showing 24 changed files with 128 additions and 132 deletions.
diff --git a/.husky/pre-commit b/.husky/pre-commit
diff --git a/...pp/src/components/Sidebar/Collections/Collection/CollectionItem/GenerateCodeItem/index.js b/...pp/src/components/Sidebar/Collections/Collection/CollectionItem/GenerateCodeItem/index.js
@@ -73,7 +73,7 @@ const GenerateCodeItem = ({ collection, item, onClose }) => {
   const interpolatedUrl = interpolateUrl({
     url: requestUrl,
     envVars,
-    collectionVariables: collection.collectionVariables,
+    runtimeVariables: collection.runtimeVariables,
     processEnvVars: collection.processEnvVariables
   });
 

diff --git a/packages/bruno-app/src/components/VariablesEditor/index.js b/packages/bruno-app/src/components/VariablesEditor/index.js
@@ -62,22 +62,22 @@ const EnvVariables = ({ collection, theme }) => {
   );
 };
 
-const CollectionVariables = ({ collection, theme }) => {
-  const collectionVariablesFound = Object.keys(collection.collectionVariables).length > 0;
+const RuntimeVariables = ({ collection, theme }) => {
+  const runtimeVariablesFound = Object.keys(collection.runtimeVariables).length > 0;
 
-  const collectionVariableArray = Object.entries(collection.collectionVariables).map(([name, value]) => ({
+  const runtimeVariableArray = Object.entries(collection.runtimeVariables).map(([name, value]) => ({
     name,
     value,
     secret: false
   }));
 
   return (
     <>
-      <h1 className="font-semibold mb-2">Collection Variables</h1>
-      {collectionVariablesFound ? (
-        <KeyValueExplorer data={collectionVariableArray} theme={theme} />
+      <h1 className="font-semibold mb-2">Runtime Variables</h1>
+      {runtimeVariablesFound ? (
+        <KeyValueExplorer data={runtimeVariableArray} theme={theme} />
       ) : (
-        <div className="muted text-xs">No collection variables found</div>
+        <div className="muted text-xs">No runtime variables found</div>
       )}
     </>
   );
@@ -90,13 +90,13 @@ const VariablesEditor = ({ collection }) => {
 
   return (
     <StyledWrapper className="px-4 py-4">
-      <CollectionVariables collection={collection} theme={reactInspectorTheme} />
+      <RuntimeVariables collection={collection} theme={reactInspectorTheme} />
       <EnvVariables collection={collection} theme={reactInspectorTheme} />
 
       <div className="mt-8 muted text-xs">
-        Note: As of today, collection variables can only be set via the API -{' '}
-        <span className="font-medium">getVar()</span> and <span className="font-medium">setVar()</span>. <br />
-        In the next release, we will add a UI to set and modify collection variables.
+        Note: As of today, runtime variables can only be set via the API - <span className="font-medium">getVar()</span>{' '}
+        and <span className="font-medium">setVar()</span>. <br />
+        In the next release, we will add a UI to set and modify runtime variables.
       </div>
     </StyledWrapper>
   );

diff --git a/packages/bruno-app/src/providers/ReduxStore/slices/collections/actions.js b/packages/bruno-app/src/providers/ReduxStore/slices/collections/actions.js
@@ -195,7 +195,7 @@ export const sendCollectionOauth2Request = (collectionUid, itemUid) => (dispatch
     const externalSecrets = getExternalCollectionSecretsForActiveEnvironment({ collection });
     const secretVariables = getFormattedCollectionSecretVariables({ externalSecrets });
 
-    _sendCollectionOauth2Request(collection, environment, collectionCopy.collectionVariables, itemUid, secretVariables)
+    _sendCollectionOauth2Request(collection, environment, collectionCopy.runtimeVariables, itemUid, secretVariables)
       .then((response) => {
         if (response?.data?.error) {
           toast.error(response?.data?.error);
@@ -224,7 +224,7 @@ export const sendRequest = (item, collectionUid) => (dispatch, getState) => {
     const collectionCopy = cloneDeep(collection);
 
     const environment = findEnvironmentInCollection(collectionCopy, collectionCopy.activeEnvironmentUid);
-    sendNetworkRequest(itemCopy, collectionCopy, environment, collectionCopy.collectionVariables)
+    sendNetworkRequest(itemCopy, collectionCopy, environment, collectionCopy.runtimeVariables)
       .then((response) => {
         return dispatch(
           responseReceived({
@@ -314,7 +314,7 @@ export const runCollectionFolder = (collectionUid, folderUid, recursive) => (dis
         folder,
         collectionCopy,
         environment,
-        collectionCopy.collectionVariables,
+        collectionCopy.runtimeVariables,
         recursive
       )
       .then(resolve)
@@ -1036,7 +1036,7 @@ export const openCollectionEvent = (uid, pathname, brunoConfig) => (dispatch, ge
     name: brunoConfig.name,
     pathname: pathname,
     items: [],
-    collectionVariables: {},
+    runtimeVariables: {},
     brunoConfig: brunoConfig
   };
 

diff --git a/packages/bruno-app/src/providers/ReduxStore/slices/collections/index.js b/packages/bruno-app/src/providers/ReduxStore/slices/collections/index.js
@@ -200,7 +200,7 @@ export const collectionsSlice = createSlice({
       }
     },
     scriptEnvironmentUpdateEvent: (state, action) => {
-      const { collectionUid, envVariables, collectionVariables } = action.payload;
+      const { collectionUid, envVariables, runtimeVariables } = action.payload;
       const collection = findCollectionByUid(state.collections, collectionUid);
 
       if (collection) {
@@ -230,7 +230,7 @@ export const collectionsSlice = createSlice({
           });
         }
 
-        collection.collectionVariables = collectionVariables;
+        collection.runtimeVariables = runtimeVariables;
       }
     },
     processEnvUpdateEvent: (state, action) => {

diff --git a/packages/bruno-app/src/utils/collections/index.js b/packages/bruno-app/src/utils/collections/index.js
@@ -798,7 +798,7 @@ export const getAllVariables = (collection, item) => {
   return {
     ...environmentVariables,
     ...requestVariables,
-    ...collection.collectionVariables,
+    ...collection.runtimeVariables,
     pathParams: {
       ...pathParams
     },

diff --git a/packages/bruno-app/src/utils/network/index.js b/packages/bruno-app/src/utils/network/index.js
@@ -1,9 +1,9 @@
 import { safeStringifyJSON } from 'utils/common';
 
-export const sendNetworkRequest = async (item, collection, environment, collectionVariables) => {
+export const sendNetworkRequest = async (item, collection, environment, runtimeVariables) => {
   return new Promise((resolve, reject) => {
     if (['http-request', 'graphql-request'].includes(item.type)) {
-      sendHttpRequest(item, collection, environment, collectionVariables)
+      sendHttpRequest(item, collection, environment, runtimeVariables)
         .then((response) => {
           resolve({
             state: 'success',
@@ -22,22 +22,22 @@ export const sendNetworkRequest = async (item, collection, environment, collecti
   });
 };
 
-const sendHttpRequest = async (item, collection, environment, collectionVariables) => {
+const sendHttpRequest = async (item, collection, environment, runtimeVariables) => {
   return new Promise((resolve, reject) => {
     const { ipcRenderer } = window;
 
     ipcRenderer
-      .invoke('send-http-request', item, collection, environment, collectionVariables)
+      .invoke('send-http-request', item, collection, environment, runtimeVariables)
       .then(resolve)
       .catch(reject);
   });
 };
 
-export const sendCollectionOauth2Request = async (collection, environment, collectionVariables) => {
+export const sendCollectionOauth2Request = async (collection, environment, runtimeVariables) => {
   return new Promise((resolve, reject) => {
     const { ipcRenderer } = window;
     ipcRenderer
-      .invoke('send-collection-oauth2-request', collection, environment, collectionVariables)
+      .invoke('send-collection-oauth2-request', collection, environment, runtimeVariables)
       .then(resolve)
       .catch(reject);
   });

diff --git a/packages/bruno-app/src/utils/url/index.js b/packages/bruno-app/src/utils/url/index.js
@@ -107,14 +107,14 @@ export const isValidUrl = (url) => {
   }
 };
 
-export const interpolateUrl = ({ url, envVars, collectionVariables, processEnvVars }) => {
+export const interpolateUrl = ({ url, envVars, runtimeVariables, processEnvVars }) => {
   if (!url || !url.length || typeof url !== 'string') {
     return;
   }
 
   return interpolate(url, {
     ...envVars,
-    ...collectionVariables,
+    ...runtimeVariables,
     process: {
       env: {
         ...processEnvVars

diff --git a/packages/bruno-app/src/utils/url/index.spec.js b/packages/bruno-app/src/utils/url/index.spec.js
@@ -129,10 +129,10 @@ describe('Url Utils - interpolateUrl, interpolateUrlPathParams', () => {
     const expectedUrl = 'https://example.com/api/:id/path?foo=foo_value&bar=bar_value&baz=baz_value';
 
     const envVars = { host: 'https://example.com', foo: 'foo_value' };
-    const collectionVariables = { bar: 'bar_value' };
+    const runtimeVariables = { bar: 'bar_value' };
     const processEnvVars = { baz: 'baz_value' };
 
-    const result = interpolateUrl({ url, envVars, collectionVariables, processEnvVars });
+    const result = interpolateUrl({ url, envVars, runtimeVariables, processEnvVars });
 
     expect(result).toEqual(expectedUrl);
   });
@@ -153,10 +153,10 @@ describe('Url Utils - interpolateUrl, interpolateUrlPathParams', () => {
     const expectedUrl = 'https://example.com/api/123/path?foo=foo_value&bar=bar_value&baz=baz_value';
 
     const envVars = { host: 'https://example.com', foo: 'foo_value' };
-    const collectionVariables = { bar: 'bar_value' };
+    const runtimeVariables = { bar: 'bar_value' };
     const processEnvVars = { baz: 'baz_value' };
 
-    const intermediateResult = interpolateUrl({ url, envVars, collectionVariables, processEnvVars });
+    const intermediateResult = interpolateUrl({ url, envVars, runtimeVariables, processEnvVars });
     const result = interpolateUrlPathParams(intermediateResult, params);
 
     expect(result).toEqual(expectedUrl);

diff --git a/packages/bruno-cli/src/commands/run.js b/packages/bruno-cli/src/commands/run.js
@@ -312,7 +312,7 @@ const handler = async function (argv) {
       recursive = true;
     }
 
-    const collectionVariables = {};
+    const runtimeVariables = {};
     let envVars = {};
 
     if (env) {
@@ -462,7 +462,7 @@ const handler = async function (argv) {
         bruFilepath,
         bruJson,
         collectionPath,
-        collectionVariables,
+        runtimeVariables,
         envVars,
         processEnvVars,
         brunoConfig,

diff --git a/packages/bruno-cli/src/runner/interpolate-string.js b/packages/bruno-cli/src/runner/interpolate-string.js
@@ -1,13 +1,13 @@
 const { forOwn, cloneDeep } = require('lodash');
 const { interpolate } = require('@usebruno/common');
 
-const interpolateString = (str, { envVars, collectionVariables, processEnvVars }) => {
+const interpolateString = (str, { envVars, runtimeVariables, processEnvVars }) => {
   if (!str || !str.length || typeof str !== 'string') {
     return str;
   }
 
   processEnvVars = processEnvVars || {};
-  collectionVariables = collectionVariables || {};
+  runtimeVariables = runtimeVariables || {};
 
   // we clone envVars because we don't want to modify the original object
   envVars = envVars ? cloneDeep(envVars) : {};
@@ -24,10 +24,10 @@ const interpolateString = (str, { envVars, collectionVariables, processEnvVars }
     });
   });
 
-  // collectionVariables take precedence over envVars
+  // runtimeVariables take precedence over envVars
   const combinedVars = {
     ...envVars,
-    ...collectionVariables,
+    ...runtimeVariables,
     process: {
       env: {
         ...processEnvVars

diff --git a/packages/bruno-cli/src/runner/interpolate-vars.js b/packages/bruno-cli/src/runner/interpolate-vars.js
@@ -12,7 +12,7 @@ const getContentType = (headers = {}) => {
   return contentType;
 };
 
-const interpolateVars = (request, envVars = {}, collectionVariables = {}, processEnvVars = {}) => {
+const interpolateVars = (request, envVars = {}, runtimeVariables = {}, processEnvVars = {}) => {
   // we clone envVars because we don't want to modify the original object
   envVars = cloneDeep(envVars);
 
@@ -33,10 +33,10 @@ const interpolateVars = (request, envVars = {}, collectionVariables = {}, proces
       return str;
     }
 
-    // collectionVariables take precedence over envVars
+    // runtimeVariables take precedence over envVars
     const combinedVars = {
       ...envVars,
-      ...collectionVariables,
+      ...runtimeVariables,
       process: {
         env: {
           ...processEnvVars

diff --git a/packages/bruno-cli/src/runner/run-single-request.js b/packages/bruno-cli/src/runner/run-single-request.js
@@ -25,7 +25,7 @@ const runSingleRequest = async function (
   filename,
   bruJson,
   collectionPath,
-  collectionVariables,
+  runtimeVariables,
   envVariables,
   processEnvVars,
   brunoConfig,
@@ -62,7 +62,7 @@ const runSingleRequest = async function (
         preRequestVars,
         request,
         envVariables,
-        collectionVariables,
+        runtimeVariables,
         collectionPath,
         processEnvVars
       );
@@ -79,7 +79,7 @@ const runSingleRequest = async function (
         decomment(requestScriptFile),
         request,
         envVariables,
-        collectionVariables,
+        runtimeVariables,
         collectionPath,
         null,
         processEnvVars,
@@ -91,7 +91,7 @@ const runSingleRequest = async function (
     }
 
     // interpolate variables inside request
-    interpolateVars(request, envVariables, collectionVariables, processEnvVars);
+    interpolateVars(request, envVariables, runtimeVariables, processEnvVars);
 
     if (!protocolRegex.test(request.url)) {
       request.url = `http://${request.url}`;
@@ -120,7 +120,7 @@ const runSingleRequest = async function (
 
     const interpolationOptions = {
       envVars: envVariables,
-      collectionVariables,
+      runtimeVariables,
       processEnvVars
     };
 
@@ -282,7 +282,7 @@ const runSingleRequest = async function (
         request,
         response,
         envVariables,
-        collectionVariables,
+        runtimeVariables,
         collectionPath,
         processEnvVars
       );
@@ -300,7 +300,7 @@ const runSingleRequest = async function (
         request,
         response,
         envVariables,
-        collectionVariables,
+        runtimeVariables,
         collectionPath,
         null,
         processEnvVars,
@@ -321,7 +321,7 @@ const runSingleRequest = async function (
         request,
         response,
         envVariables,
-        collectionVariables,
+        runtimeVariables,
         processEnvVars
       );
 
@@ -345,7 +345,7 @@ const runSingleRequest = async function (
         request,
         response,
         envVariables,
-        collectionVariables,
+        runtimeVariables,
         collectionPath,
         null,
         processEnvVars,