@usebruno/js 0.12.0 → 0.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usebruno/js",
-  "version": "0.12.0",
+  "version": "0.14.0",
   "license": "MIT",
   "main": "src/index.js",
   "files": [
@@ -8,12 +8,13 @@
     "package.json"
   ],
   "peerDependencies": {
-    "@n8n/vm2": "^3.9.23"
+    "@usebruno/vm2": "^3.9.13"
   },
   "scripts": {
     "test": "jest --testPathIgnorePatterns test.js"
   },
   "dependencies": {
+    "@usebruno/common": "0.2.0",
     "@usebruno/query": "0.1.0",
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
@@ -23,7 +24,6 @@
     "chai": "^4.3.7",
     "chai-string": "^1.5.0",
     "crypto-js": "^4.1.1",
-    "handlebars": "^4.7.8",
     "json-query": "^2.2.2",
     "lodash": "^4.17.21",
     "moment": "^2.29.4",

package/src/bru.js

@@ -1,6 +1,6 @@
-const Handlebars = require('handlebars');
 const { cloneDeep } = require('lodash');
 const { uuid } = require('./utils');
+const { interpolate } = require('@usebruno/common');
 
 const variableNameRegex = /^[\w-.]*$/;
 
@@ -11,30 +11,37 @@ class Bru {
     processEnvVars,
     collectionPath,
     historyLogger,
-    setHtmlVisualizationString
+    setHtmlVisualizationString,
+    secretVariables,
+    requestVariables
   ) {
-    this.envVariables = envVariables;
-    this.collectionVariables = collectionVariables;
+    this.envVariables = envVariables || {};
+    this.collectionVariables = collectionVariables || {};
     this.processEnvVars = cloneDeep(processEnvVars || {});
+    this.secretVariables = cloneDeep(secretVariables || {});
+    this.requestVariables = requestVariables || {};
     this.collectionPath = collectionPath;
     this.historyLogger = historyLogger;
     this.setHtmlVisualizationString = setHtmlVisualizationString;
   }
 
-  _interpolateEnvVar = (str) => {
+  _interpolate = (str) => {
     if (!str || !str.length || typeof str !== 'string') {
       return str;
     }
 
-    const template = Handlebars.compile(str, { noEscape: true });
-
-    return template({
+    const combinedVars = {
+      ...this.envVariables,
+      ...this.requestVariables,
+      ...this.collectionVariables,
       process: {
         env: {
           ...this.processEnvVars
         }
       }
-    });
+    };
+
+    return interpolate(str, combinedVars);
   };
 
   cwd() {
@@ -49,8 +56,12 @@ class Bru {
     return this.processEnvVars[key];
   }
 
+  hasEnvVar(key) {
+    return Object.hasOwn(this.envVariables, key);
+  }
+
   getEnvVar(key) {
-    return this._interpolateEnvVar(this.envVariables[key]);
+    return this._interpolate(this.envVariables[key]);
   }
 
   setEnvVar(key, value) {
@@ -70,6 +81,10 @@ class Bru {
     this.envVariables[key] = value;
   }
 
+  hasVar(key) {
+    return Object.hasOwn(this.collectionVariables, key);
+  }
+
   setVar(key, value) {
     if (!key) {
       throw new Error('Creating a variable without specifying a name is not allowed.');
@@ -102,7 +117,15 @@ class Bru {
       );
     }
 
-    return this.collectionVariables[key];
+    return this._interpolate(this.collectionVariables[key]);
+  }
+
+  deleteVar(key) {
+    delete this.collectionVariables[key];
+  }
+
+  getRequestVar(key) {
+    return this._interpolate(this.requestVariables[key]);
   }
 
   setNextRequest(nextRequest) {
@@ -112,6 +135,10 @@ class Bru {
   visualize(htmlString) {
     this.setHtmlVisualizationString(htmlString);
   }
+
+  getSecretVar(key) {
+    return this.secretVariables?.[`$secrets.${key}`];
+  }
 }
 
 module.exports = Bru;

package/src/interpolate-string.js

@@ -1,44 +1,16 @@
-const Handlebars = require('handlebars');
-const { forOwn, cloneDeep } = require('lodash');
+const { interpolate } = require('@usebruno/common');
 
-const interpolateEnvVars = (str, processEnvVars) => {
+const interpolateString = (
+  str,
+  { envVariables = {}, collectionVariables = {}, processEnvVars = {}, requestVariables = {} }
+) => {
   if (!str || !str.length || typeof str !== 'string') {
     return str;
   }
 
-  const template = Handlebars.compile(str, { noEscape: true });
-
-  return template({
-    process: {
-      env: {
-        ...processEnvVars
-      }
-    }
-  });
-};
-
-const interpolateString = (str, { envVariables, collectionVariables, processEnvVars }) => {
-  if (!str || !str.length || typeof str !== 'string') {
-    return str;
-  }
-
-  processEnvVars = processEnvVars || {};
-  collectionVariables = collectionVariables || {};
-
-  // we clone envVariables because we don't want to modify the original object
-  envVariables = envVariables ? cloneDeep(envVariables) : {};
-
-  // envVariables can inturn have values as {{process.env.VAR_NAME}}
-  // so we need to interpolate envVariables first with processEnvVars
-  forOwn(envVariables, (value, key) => {
-    envVariables[key] = interpolateEnvVars(value, processEnvVars);
-  });
-
-  const template = Handlebars.compile(str, { noEscape: true });
-
-  // collectionVariables take precedence over envVariables
   const combinedVars = {
     ...envVariables,
+    ...requestVariables,
     ...collectionVariables,
     process: {
       env: {
@@ -47,7 +19,7 @@ const interpolateString = (str, { envVariables, collectionVariables, processEnvV
     }
   };
 
-  return template(combinedVars);
+  return interpolate(str, combinedVars);
 };
 
 module.exports = {

package/src/runtime/assert-runtime.js

@@ -66,6 +66,7 @@ chai.use(function (chai, utils) {
  * isNumber    : is number
  * isString    : is string
  * isBoolean   : is boolean
+ * isArray     : is array
  */
 const parseAssertionOperator = (str = '') => {
   if (!str || typeof str !== 'string' || !str.length) {
@@ -101,7 +102,8 @@ const parseAssertionOperator = (str = '') => {
     'isJson',
     'isNumber',
     'isString',
-    'isBoolean'
+    'isBoolean',
+    'isArray'
   ];
 
   const unaryOperators = [
@@ -114,7 +116,8 @@ const parseAssertionOperator = (str = '') => {
     'isJson',
     'isNumber',
     'isString',
-    'isBoolean'
+    'isBoolean',
+    'isArray'
   ];
 
   const [operator, ...rest] = str.trim().split(' ');
@@ -151,7 +154,8 @@ const isUnaryOperator = (operator) => {
     'isJson',
     'isNumber',
     'isString',
-    'isBoolean'
+    'isBoolean',
+    'isArray'
   ];
 
   return unaryOperators.includes(operator);
@@ -163,6 +167,7 @@ const evaluateRhsOperand = (rhsOperand, operator, context) => {
   }
 
   const interpolationContext = {
+    requestVariables: context.bru.requestVariables,
     collectionVariables: context.bru.collectionVariables,
     envVariables: context.bru.envVariables,
     processEnvVars: context.bru.processEnvVars
@@ -199,13 +204,32 @@ const evaluateRhsOperand = (rhsOperand, operator, context) => {
 };
 
 class AssertRuntime {
-  runAssertions(assertions, request, response, envVariables, collectionVariables, collectionPath, historyLogger) {
+  runAssertions(
+    assertions,
+    request,
+    response,
+    envVariables,
+    collectionVariables,
+    processEnvVars,
+    historyLogger,
+    secretVariables
+  ) {
+    const requestVariables = request?.requestVariables || {};
     const enabledAssertions = _.filter(assertions, (a) => a.enabled);
     if (!enabledAssertions.length) {
       return [];
     }
 
-    const bru = new Bru(envVariables, collectionVariables);
+    const bru = new Bru(
+      envVariables,
+      collectionVariables,
+      processEnvVars,
+      undefined, // collectionPath,
+      undefined, // historyLogger,
+      undefined, // setHtmlVisualizationString,
+      secretVariables,
+      requestVariables
+    );
     const req = new BrunoRequest(request, historyLogger);
     const res = createResponseParser(response);
 
@@ -217,7 +241,9 @@ class AssertRuntime {
 
     const context = {
       ...envVariables,
+      ...requestVariables,
       ...collectionVariables,
+      ...processEnvVars,
       ...bruContext
     };
 
@@ -313,6 +339,9 @@ class AssertRuntime {
           case 'isBoolean':
             expect(lhs).to.be.a('boolean');
             break;
+          case 'isArray':
+            expect(lhs).to.be.a('array');
+            break;
           default:
             expect(lhs).to.equal(rhs);
             break;

package/src/runtime/script-runtime.js

@@ -1,4 +1,4 @@
-const { NodeVM } = require('vm2');
+const { NodeVM } = require('@usebruno/vm2');
 const path = require('path');
 const http = require('http');
 const https = require('https');
@@ -27,7 +27,7 @@ const axios = require('axios');
 const fetch = require('node-fetch');
 const chai = require('chai');
 const CryptoJS = require('crypto-js');
-const NodeVault = require('node-vault');
+const NodeSecrets = require('node-vault');
 
 class ScriptRuntime {
   constructor() {}
@@ -43,19 +43,23 @@ class ScriptRuntime {
     onConsoleLog,
     processEnvVars,
     scriptingConfig,
-    historyLogger
+    historyLogger,
+    secretVariables
   ) {
     let htmlVisualizationString;
     let setHtmlVisualizationString = (htmlString) => {
       htmlVisualizationString = htmlString;
     };
+    const requestVariables = request?.requestVariables || {};
     const bru = new Bru(
       envVariables,
       collectionVariables,
       processEnvVars,
       collectionPath,
       historyLogger,
-      setHtmlVisualizationString
+      setHtmlVisualizationString,
+      secretVariables,
+      requestVariables
     );
     const req = new BrunoRequest(request, historyLogger);
     const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);
@@ -128,7 +132,7 @@ class ScriptRuntime {
           'crypto-js': CryptoJS,
           ...whitelistedModules,
           fs: allowScriptFilesystemAccess ? fs : undefined,
-          'node-vault': NodeVault
+          'node-vault': NodeSecrets
         }
       }
     });
@@ -153,19 +157,23 @@ class ScriptRuntime {
     onConsoleLog,
     processEnvVars,
     scriptingConfig,
-    historyLogger
+    historyLogger,
+    secretVariables
   ) {
     let htmlVisualizationString;
     let setHtmlVisualizationString = (htmlString) => {
       htmlVisualizationString = htmlString;
     };
+    const requestVariables = request?.requestVariables || {};
     const bru = new Bru(
       envVariables,
       collectionVariables,
       processEnvVars,
       collectionPath,
       historyLogger,
-      setHtmlVisualizationString
+      setHtmlVisualizationString,
+      secretVariables,
+      requestVariables
     );
     const req = new BrunoRequest(request, historyLogger);
     const res = new BrunoResponse(response);
@@ -233,7 +241,7 @@ class ScriptRuntime {
           'crypto-js': CryptoJS,
           ...whitelistedModules,
           fs: allowScriptFilesystemAccess ? fs : undefined,
-          'node-vault': NodeVault
+          'node-vault': NodeSecrets
         }
       }
     });

package/src/runtime/test-runtime.js

@@ -1,4 +1,4 @@
-const { NodeVM } = require('vm2');
+const { NodeVM } = require('@usebruno/vm2');
 const chai = require('chai');
 const path = require('path');
 const http = require('http');
@@ -29,7 +29,7 @@ const nanoid = require('nanoid');
 const axios = require('axios');
 const fetch = require('node-fetch');
 const CryptoJS = require('crypto-js');
-const NodeVault = require('node-vault');
+const NodeSecrets = require('node-vault');
 
 class TestRuntime {
   constructor() {}
@@ -44,9 +44,20 @@ class TestRuntime {
     onConsoleLog,
     processEnvVars,
     scriptingConfig,
-    historyLogger
+    historyLogger,
+    secretVariables
   ) {
-    const bru = new Bru(envVariables, collectionVariables, processEnvVars, collectionPath, historyLogger);
+    const requestVariables = request?.requestVariables || {};
+    const bru = new Bru(
+      envVariables,
+      collectionVariables,
+      processEnvVars,
+      collectionPath,
+      historyLogger,
+      undefined, // setHtmlVisualizationString
+      secretVariables,
+      requestVariables
+    );
     const req = new BrunoRequest(request, historyLogger);
     const res = new BrunoResponse(response);
     const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);
@@ -135,7 +146,7 @@ class TestRuntime {
           'crypto-js': CryptoJS,
           ...whitelistedModules,
           fs: allowScriptFilesystemAccess ? fs : undefined,
-          'node-vault': NodeVault
+          'node-vault': NodeSecrets
         }
       }
     });

package/src/runtime/vars-runtime.js

@@ -4,13 +4,33 @@ const BrunoRequest = require('../bruno-request');
 const { evaluateJsTemplateLiteral, evaluateJsExpression, createResponseParser } = require('../utils');
 
 class VarsRuntime {
-  runPreRequestVars(vars, request, envVariables, collectionVariables, collectionPath, processEnvVars, historyLogger) {
+  runPreRequestVars(
+    vars,
+    request,
+    envVariables,
+    collectionVariables,
+    collectionPath,
+    processEnvVars,
+    historyLogger,
+    secretVars = {}
+  ) {
+    if (!request?.requestVariables) {
+      request.requestVariables = {};
+    }
     const enabledVars = _.filter(vars, (v) => v.enabled);
     if (!enabledVars.length) {
       return;
     }
 
-    const bru = new Bru(envVariables, collectionVariables, processEnvVars, null, historyLogger);
+    const bru = new Bru(
+      envVariables,
+      collectionVariables,
+      processEnvVars,
+      null,
+      historyLogger,
+      undefined, // setHtmlVisualizationString
+      secretVars
+    );
     const req = new BrunoRequest(request, historyLogger);
 
     const bruContext = {
@@ -21,17 +41,14 @@ class VarsRuntime {
     const context = {
       ...envVariables,
       ...collectionVariables,
+      ...secretVars,
       ...bruContext
     };
 
     _.each(enabledVars, (v) => {
       const value = evaluateJsTemplateLiteral(v.value, context);
-      bru.setVar(v.name, value);
+      request?.requestVariables && (request.requestVariables[v.name] = value);
     });
-
-    return {
-      collectionVariables
-    };
   }
 
   runPostResponseVars(
@@ -42,14 +59,25 @@ class VarsRuntime {
     collectionVariables,
     collectionPath,
     processEnvVars,
-    historyLogger
+    historyLogger,
+    secretVars = {}
   ) {
+    const requestVariables = request?.requestVariables || {};
     const enabledVars = _.filter(vars, (v) => v.enabled);
     if (!enabledVars.length) {
       return;
     }
 
-    const bru = new Bru(envVariables, collectionVariables, processEnvVars, null, historyLogger);
+    const bru = new Bru(
+      envVariables,
+      collectionVariables,
+      processEnvVars,
+      null,
+      historyLogger,
+      undefined, // setHtmlVisualizationString
+      secretVars,
+      requestVariables
+    );
     const req = new BrunoRequest(request, historyLogger);
     const res = createResponseParser(response);
 
@@ -62,17 +90,31 @@ class VarsRuntime {
     const context = {
       ...envVariables,
       ...collectionVariables,
+      ...secretVars,
       ...bruContext
     };
 
+    const errors = new Map();
     _.each(enabledVars, (v) => {
-      const value = evaluateJsExpression(v.value, context);
-      bru.setVar(v.name, value);
+      try {
+        const value = evaluateJsExpression(v.value, context);
+        bru.setVar(v.name, value);
+      } catch (error) {
+        errors.set(v.name, error);
+      }
     });
 
+    let error = null;
+    if (errors.size > 0) {
+      // Format all errors as a single string to be displayed in a toast
+      const errorMessage = [...errors.entries()].map(([name, err]) => `${name}: ${err.message ?? err}`).join('\n');
+      error = `${errors.size} error${errors.size === 1 ? '' : 's'} in post response variables: \n${errorMessage}`;
+    }
+
     return {
       envVariables,
-      collectionVariables
+      collectionVariables,
+      error
     };
   }
 }