Collection Variables Support (#2963) (#3018)

Support for Collection Variables
---------

Co-authored-by: lohit <lohit.jiddimani@gmail.com>
Co-authored-by: lohit <lohxt.space@gmail.com>

packages/bruno-js/src/bru.js

@@ -4,10 +4,12 @@ const { interpolate } = require('@usebruno/common');
 const variableNameRegex = /^[\w-.]*$/;
 
 class Bru {
-  constructor(envVariables, runtimeVariables, processEnvVars, collectionPath, requestVariables) {
+  constructor(envVariables, runtimeVariables, processEnvVars, collectionPath, collectionVariables, folderVariables, requestVariables) {
     this.envVariables = envVariables || {};
     this.runtimeVariables = runtimeVariables || {};
     this.processEnvVars = cloneDeep(processEnvVars || {});
+    this.collectionVariables = collectionVariables || {};
+    this.folderVariables = folderVariables || {};
     this.requestVariables = requestVariables || {};
     this.collectionPath = collectionPath;
   }
@@ -18,7 +20,9 @@ class Bru {
     }
 
     const combinedVars = {
+      ...this.collectionVariables,
       ...this.envVariables,
+      ...this.folderVariables,
       ...this.requestVariables,
       ...this.runtimeVariables,
       process: {
@@ -71,7 +75,7 @@ class Bru {
     if (variableNameRegex.test(key) === false) {
       throw new Error(
         `Variable name: "${key}" contains invalid characters!` +
-          ' Names must only contain alpha-numeric characters, "-", "_", "."'
+        ' Names must only contain alpha-numeric characters, "-", "_", "."'
       );
     }
 
@@ -82,7 +86,7 @@ class Bru {
     if (variableNameRegex.test(key) === false) {
       throw new Error(
         `Variable name: "${key}" contains invalid characters!` +
-          ' Names must only contain alpha-numeric characters, "-", "_", "."'
+        ' Names must only contain alpha-numeric characters, "-", "_", "."'
       );
     }
 
@@ -93,6 +97,14 @@ class Bru {
     delete this.runtimeVariables[key];
   }
 
+  getCollectionVar(key) {
+    return this._interpolate(this.collectionVariables[key]);
+  }
+
+  getFolderVar(key) {
+    return this._interpolate(this.folderVariables[key]);
+  }
+
   getRequestVar(key) {
     return this._interpolate(this.requestVariables[key]);
   }

packages/bruno-js/src/interpolate-string.js

@@ -2,14 +2,16 @@ const { interpolate } = require('@usebruno/common');
 
 const interpolateString = (
   str,
-  { envVariables = {}, runtimeVariables = {}, processEnvVars = {}, requestVariables = {} }
+  { envVariables = {}, runtimeVariables = {}, processEnvVars = {}, collectionVariables = {}, folderVariables = {}, requestVariables = {} }
 ) => {
   if (!str || !str.length || typeof str !== 'string') {
     return str;
   }
 
   const combinedVars = {
+    ...collectionVariables,
     ...envVariables,
+    ...folderVariables,
     ...requestVariables,
     ...runtimeVariables,
     process: {

packages/bruno-js/src/runtime/assert-runtime.js

@@ -192,6 +192,8 @@ const evaluateRhsOperand = (rhsOperand, operator, context, runtime) => {
   }
 
   const interpolationContext = {
+    collectionVariables: context.bru.collectionVariables,
+    folderVariables: context.bru.folderVariables,
     requestVariables: context.bru.requestVariables,
     runtimeVariables: context.bru.runtimeVariables,
     envVariables: context.bru.envVariables,
@@ -238,13 +240,23 @@ class AssertRuntime {
   }
 
   runAssertions(assertions, request, response, envVariables, runtimeVariables, processEnvVars) {
+    const collectionVariables = request?.collectionVariables || {};
+    const folderVariables = request?.folderVariables || {};
     const requestVariables = request?.requestVariables || {};
     const enabledAssertions = _.filter(assertions, (a) => a.enabled);
     if (!enabledAssertions.length) {
       return [];
     }
 
-    const bru = new Bru(envVariables, runtimeVariables, processEnvVars, undefined, requestVariables);
+    const bru = new Bru(
+      envVariables,
+      runtimeVariables,
+      processEnvVars,
+      undefined,
+      collectionVariables,
+      folderVariables,
+      requestVariables
+    );
     const req = new BrunoRequest(request);
     const res = createResponseParser(response);
 
@@ -255,7 +267,9 @@ class AssertRuntime {
     };
 
     const context = {
+      ...collectionVariables,
       ...envVariables,
+      ...folderVariables,
       ...requestVariables,
       ...runtimeVariables,
       ...processEnvVars,

packages/bruno-js/src/runtime/script-runtime.js

@@ -47,8 +47,10 @@ class ScriptRuntime {
     processEnvVars,
     scriptingConfig
   ) {
+    const collectionVariables = request?.collectionVariables || {};
+    const folderVariables = request?.folderVariables || {};
     const requestVariables = request?.requestVariables || {};
-    const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, requestVariables);
+    const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, collectionVariables, folderVariables, requestVariables);
     const req = new BrunoRequest(request);
     const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);
     const moduleWhitelist = get(scriptingConfig, 'moduleWhitelist', []);
@@ -162,8 +164,10 @@ class ScriptRuntime {
     processEnvVars,
     scriptingConfig
   ) {
+    const collectionVariables = request?.collectionVariables || {};
+    const folderVariables = request?.folderVariables || {};
     const requestVariables = request?.requestVariables || {};
-    const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, requestVariables);
+    const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, collectionVariables, folderVariables, requestVariables);
     const req = new BrunoRequest(request);
     const res = new BrunoResponse(response);
     const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);

packages/bruno-js/src/runtime/test-runtime.js

@@ -48,8 +48,10 @@ class TestRuntime {
     processEnvVars,
     scriptingConfig
   ) {
+    const collectionVariables = request?.collectionVariables || {};
+    const folderVariables = request?.folderVariables || {};
     const requestVariables = request?.requestVariables || {};
-    const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, requestVariables);
+    const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, collectionVariables, folderVariables, requestVariables);
     const req = new BrunoRequest(request);
     const res = new BrunoResponse(response);
     const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);

packages/bruno-js/src/runtime/vars-runtime.js

@@ -1,22 +1,10 @@
 const _ = require('lodash');
 const Bru = require('../bru');
 const BrunoRequest = require('../bruno-request');
-const { evaluateJsTemplateLiteral, evaluateJsExpression, createResponseParser } = require('../utils');
+const { evaluateJsExpression, createResponseParser } = require('../utils');
 
 const { executeQuickJsVm } = require('../sandbox/quickjs');
 
-const evaluateJsTemplateLiteralBasedOnRuntime = (literal, context, runtime) => {
-  if (runtime === 'quickjs') {
-    return executeQuickJsVm({
-      script: literal,
-      context,
-      scriptType: 'template-literal'
-    });
-  }
-
-  return evaluateJsTemplateLiteral(literal, context);
-};
-
 const evaluateJsExpressionBasedOnRuntime = (expr, context, runtime, mode) => {
   if (runtime === 'quickjs') {
     return executeQuickJsVm({
@@ -35,35 +23,6 @@ class VarsRuntime {
     this.mode = props?.mode || 'developer';
   }
 
-  runPreRequestVars(vars, request, envVariables, runtimeVariables, collectionPath, processEnvVars) {
-    if (!request?.requestVariables) {
-      request.requestVariables = {};
-    }
-    const enabledVars = _.filter(vars, (v) => v.enabled);
-    if (!enabledVars.length) {
-      return;
-    }
-
-    const bru = new Bru(envVariables, runtimeVariables, processEnvVars);
-    const req = new BrunoRequest(request);
-
-    const bruContext = {
-      bru,
-      req
-    };
-
-    const context = {
-      ...envVariables,
-      ...runtimeVariables,
-      ...bruContext
-    };
-
-    _.each(enabledVars, (v) => {
-      const value = evaluateJsTemplateLiteralBasedOnRuntime(v.value, context, this.runtime);
-      request?.requestVariables && (request.requestVariables[v.name] = value);
-    });
-  }
-
   runPostResponseVars(vars, request, response, envVariables, runtimeVariables, collectionPath, processEnvVars) {
     const requestVariables = request?.requestVariables || {};
     const enabledVars = _.filter(vars, (v) => v.enabled);

packages/bruno-js/src/sandbox/quickjs/shims/bru.js

@@ -69,6 +69,18 @@ const addBruShimToContext = (vm, bru) => {
   vm.setProp(bruObject, 'getRequestVar', getRequestVar);
   getRequestVar.dispose();
 
+  let getFolderVar = vm.newFunction('getFolderVar', function (key) {
+    return marshallToVm(bru.getFolderVar(vm.dump(key)), vm);
+  });
+  vm.setProp(bruObject, 'getFolderVar', getFolderVar);
+  getFolderVar.dispose();
+
+  let getCollectionVar = vm.newFunction('getCollectionVar', function (key) {
+    return marshallToVm(bru.getCollectionVar(vm.dump(key)), vm);
+  });
+  vm.setProp(bruObject, 'getCollectionVar', getCollectionVar);
+  getCollectionVar.dispose();
+
   const sleep = vm.newFunction('sleep', (timer) => {
     const t = vm.getString(timer);
     const promise = vm.newPromise();