@usebruno/js 0.13.0 → 0.15.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usebruno/js",
-  "version": "0.13.0",
+  "version": "0.15.0",
   "license": "MIT",
   "main": "src/index.js",
   "files": [
@@ -8,12 +8,14 @@
     "package.json"
   ],
   "peerDependencies": {
-    "@n8n/vm2": "^3.9.23"
+    "@usebruno/vm2": "^3.9.13"
   },
   "scripts": {
-    "test": "jest --testPathIgnorePatterns test.js"
+    "test": "node --experimental-vm-modules $(npx which jest) --testPathIgnorePatterns test.js",
+    "sandbox:bundle-libraries": "node ./src/sandbox/bundle-libraries.js"
   },
   "dependencies": {
+    "@usebruno/common": "0.3.0",
     "@usebruno/query": "0.1.0",
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
@@ -23,13 +25,29 @@
     "chai": "^4.3.7",
     "chai-string": "^1.5.0",
     "crypto-js": "^4.1.1",
-    "handlebars": "^4.7.8",
+    "crypto-js-3.1.9-1": "npm:crypto-js@^3.1.9-1",
     "json-query": "^2.2.2",
     "lodash": "^4.17.21",
     "moment": "^2.29.4",
     "nanoid": "3.3.4",
-    "node-fetch": "2.*",
+    "node-fetch": "^2.7.0",
     "node-vault": "^0.10.2",
+    "path": "^0.12.7",
+    "quickjs-emscripten": "^0.29.2",
     "uuid": "^9.0.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^23.0.2",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^15.0.1",
+    "rollup": "3.2.5",
+    "rollup-plugin-node-builtins": "^2.1.2",
+    "rollup-plugin-node-globals": "^1.4.0",
+    "rollup-plugin-polyfill-node": "^0.13.0",
+    "rollup-plugin-terser": "^7.0.2",
+    "stream": "^0.0.2",
+    "terser": "^5.31.1",
+    "uglify-js": "^3.18.0",
+    "util": "^0.12.5"
   }
 }

package/src/bru.js

@@ -1,42 +1,47 @@
-const Handlebars = require('handlebars');
 const { cloneDeep } = require('lodash');
 const { uuid } = require('./utils');
+const { interpolate } = require('@usebruno/common');
 
 const variableNameRegex = /^[\w-.]*$/;
 
 class Bru {
   constructor(
     envVariables,
-    collectionVariables,
+    runtimeVariables,
     processEnvVars,
     collectionPath,
     historyLogger,
-    setHtmlVisualizationString,
-    secretVariables
+    setVisualizations,
+    secretVariables,
+    requestVariables
   ) {
-    this.envVariables = envVariables;
-    this.collectionVariables = collectionVariables;
+    this.envVariables = envVariables || {};
+    this.runtimeVariables = runtimeVariables || {};
     this.processEnvVars = cloneDeep(processEnvVars || {});
     this.secretVariables = cloneDeep(secretVariables || {});
+    this.requestVariables = requestVariables || {};
     this.collectionPath = collectionPath;
     this.historyLogger = historyLogger;
-    this.setHtmlVisualizationString = setHtmlVisualizationString;
+    this.setVisualizations = setVisualizations;
   }
 
-  _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.runtimeVariables,
       process: {
         env: {
           ...this.processEnvVars
         }
       }
-    });
+    };
+
+    return interpolate(str, combinedVars);
   };
 
   cwd() {
@@ -51,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) {
@@ -72,6 +81,10 @@ class Bru {
     this.envVariables[key] = value;
   }
 
+  hasVar(key) {
+    return Object.hasOwn(this.runtimeVariables, key);
+  }
+
   setVar(key, value) {
     if (!key) {
       throw new Error('Creating a variable without specifying a name is not allowed.');
@@ -93,7 +106,7 @@ class Bru {
       });
     }
 
-    this.collectionVariables[key] = value;
+    this.runtimeVariables[key] = value;
   }
 
   getVar(key) {
@@ -104,20 +117,51 @@ class Bru {
       );
     }
 
-    return this.collectionVariables[key];
+    return this._interpolate(this.runtimeVariables[key]);
+  }
+
+  deleteVar(key) {
+    delete this.runtimeVariables[key];
+  }
+
+  getRequestVar(key) {
+    return this._interpolate(this.requestVariables[key]);
   }
 
   setNextRequest(nextRequest) {
     this.nextRequest = nextRequest;
   }
 
-  visualize(htmlString) {
-    this.setHtmlVisualizationString(htmlString);
-  }
 
   getSecretVar(key) {
     return this.secretVariables?.[`$secrets.${key}`];
   }
+
+
+  visualize(type, data) {
+    if (type == 'table') {
+      if (data?.provider == 'ag-grid') {
+        if (!data?.props?.columnDefinitions) {
+          throw new Error(`columns definitions are required`);
+        }
+        if (!data?.props?.rowData) {
+          throw new Error(`row data is required`);
+        }
+        this.setVisualizations({ uid: uuid(), type, data });
+      } else if (data?.provider == 'react-table') {
+        this.setVisualizations({ uid: uuid(), type, data });
+      }
+    } else if (type == 'html') {
+      if (!data?.content) {
+        throw new Error(`html content is required`);
+      }
+      this.setVisualizations({ uid: uuid(), type, data });
+    }
+  }
+  
+  sleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+  }
 }
 
 module.exports = Bru;

package/src/interpolate-string.js

@@ -1,45 +1,17 @@
-const Handlebars = require('handlebars');
-const { forOwn, cloneDeep } = require('lodash');
+const { interpolate } = require('@usebruno/common');
 
-const interpolateEnvVars = (str, processEnvVars) => {
+const interpolateString = (
+  str,
+  { envVariables = {}, runtimeVariables = {}, 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,
-    ...collectionVariables,
+    ...requestVariables,
+    ...runtimeVariables,
     process: {
       env: {
         ...processEnvVars
@@ -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

@@ -5,6 +5,7 @@ const Bru = require('../bru');
 const BrunoRequest = require('../bruno-request');
 const { evaluateJsTemplateLiteral, evaluateJsExpression, createResponseParser, uuid } = require('../utils');
 const { interpolateString } = require('../interpolate-string');
+const { executeQuickJsVm } = require('../sandbox/quickjs');
 
 const { expect } = chai;
 chai.use(require('chai-string'));
@@ -66,6 +67,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 +103,8 @@ const parseAssertionOperator = (str = '') => {
     'isJson',
     'isNumber',
     'isString',
-    'isBoolean'
+    'isBoolean',
+    'isArray'
   ];
 
   const unaryOperators = [
@@ -114,7 +117,8 @@ const parseAssertionOperator = (str = '') => {
     'isJson',
     'isNumber',
     'isString',
-    'isBoolean'
+    'isBoolean',
+    'isArray'
   ];
 
   const [operator, ...rest] = str.trim().split(' ');
@@ -151,19 +155,45 @@ const isUnaryOperator = (operator) => {
     'isJson',
     'isNumber',
     'isString',
-    'isBoolean'
+    'isBoolean',
+    'isArray'
   ];
 
   return unaryOperators.includes(operator);
 };
 
-const evaluateRhsOperand = (rhsOperand, operator, context) => {
+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) => {
+  if (runtime === 'quickjs') {
+    return executeQuickJsVm({
+      script: expr,
+      context,
+      scriptType: 'expression'
+    });
+  }
+
+  return evaluateJsExpression(expr, context);
+};
+
+const evaluateRhsOperand = (rhsOperand, operator, context, runtime) => {
   if (isUnaryOperator(operator)) {
     return;
   }
 
   const interpolationContext = {
-    collectionVariables: context.bru.collectionVariables,
+    requestVariables: context.bru.requestVariables,
+    runtimeVariables: context.bru.runtimeVariables,
     envVariables: context.bru.envVariables,
     processEnvVars: context.bru.processEnvVars
   };
@@ -176,13 +206,17 @@ const evaluateRhsOperand = (rhsOperand, operator, context) => {
 
     return rhsOperand
       .split(',')
-      .map((v) => evaluateJsTemplateLiteral(interpolateString(v.trim(), interpolationContext), context));
+      .map((v) =>
+        evaluateJsTemplateLiteralBasedOnRuntime(interpolateString(v.trim(), interpolationContext), context, runtime)
+      );
   }
 
   if (operator === 'between') {
     const [lhs, rhs] = rhsOperand
       .split(',')
-      .map((v) => evaluateJsTemplateLiteral(interpolateString(v.trim(), interpolationContext), context));
+      .map((v) =>
+        evaluateJsTemplateLiteralBasedOnRuntime(interpolateString(v.trim(), interpolationContext), context, runtime)
+      );
     return [lhs, rhs];
   }
 
@@ -195,20 +229,16 @@ const evaluateRhsOperand = (rhsOperand, operator, context) => {
     return interpolateString(rhsOperand, interpolationContext);
   }
 
-  return evaluateJsTemplateLiteral(interpolateString(rhsOperand, interpolationContext), context);
+  return evaluateJsTemplateLiteralBasedOnRuntime(interpolateString(rhsOperand, interpolationContext), context, runtime);
 };
 
 class AssertRuntime {
-  runAssertions(
-    assertions,
-    request,
-    response,
-    envVariables,
-    collectionVariables,
-    collectionPath,
-    historyLogger,
-    secretVariables
-  ) {
+  constructor(props) {
+    this.runtime = props?.runtime || 'vm2';
+  }
+
+  runAssertions(assertions, request, response, envVariables, runtimeVariables, processEnvVars, historyLogger, secretVariables) {
+    const requestVariables = request?.requestVariables || {};
     const enabledAssertions = _.filter(assertions, (a) => a.enabled);
     if (!enabledAssertions.length) {
       return [];
@@ -216,12 +246,13 @@ class AssertRuntime {
 
     const bru = new Bru(
       envVariables,
-      collectionVariables,
-      undefined, // processEnvVars,
+      runtimeVariables,
+      processEnvVars,
       undefined, // collectionPath,
       undefined, // historyLogger,
-      undefined, // setHtmlVisualizationString,
-      secretVariables
+      undefined, // setVisualizations,
+      secretVariables,
+      requestVariables
     );
     const req = new BrunoRequest(request, historyLogger);
     const res = createResponseParser(response);
@@ -234,7 +265,9 @@ class AssertRuntime {
 
     const context = {
       ...envVariables,
-      ...collectionVariables,
+      ...requestVariables,
+      ...runtimeVariables,
+      ...processEnvVars,
       ...bruContext
     };
 
@@ -247,8 +280,8 @@ class AssertRuntime {
       const { operator, value: rhsOperand } = parseAssertionOperator(rhsExpr);
 
       try {
-        const lhs = evaluateJsExpression(lhsExpr, context);
-        const rhs = evaluateRhsOperand(rhsOperand, operator, context);
+        const lhs = evaluateJsExpressionBasedOnRuntime(lhsExpr, context, this.runtime);
+        const rhs = evaluateRhsOperand(rhsOperand, operator, context, this.runtime);
 
         switch (operator) {
           case 'eq':
@@ -330,6 +363,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,10 +27,13 @@ const axios = require('axios');
 const fetch = require('node-fetch');
 const chai = require('chai');
 const CryptoJS = require('crypto-js');
-const NodeSecrets = require('node-vault');
+const NodeVault = require('node-vault');
+const { executeQuickJsVmAsync } = require('../sandbox/quickjs');
 
 class ScriptRuntime {
-  constructor() {}
+  constructor(props) {
+    this.runtime = props?.runtime || 'vm2';
+  }
 
   // This approach is getting out of hand
   // Need to refactor this to use a single arg (object) instead of 7
@@ -38,7 +41,7 @@ class ScriptRuntime {
     script,
     request,
     envVariables,
-    collectionVariables,
+    runtimeVariables,
     collectionPath,
     onConsoleLog,
     processEnvVars,
@@ -46,18 +49,20 @@ class ScriptRuntime {
     historyLogger,
     secretVariables
   ) {
-    let htmlVisualizationString;
-    let setHtmlVisualizationString = (htmlString) => {
-      htmlVisualizationString = htmlString;
-    };
+    let visualizations = [];
+    let setVisualizations = (data) => {
+      visualizations.push(data);
+    }
+    const requestVariables = request?.requestVariables || {};
     const bru = new Bru(
       envVariables,
-      collectionVariables,
+      runtimeVariables,
       processEnvVars,
       collectionPath,
       historyLogger,
-      setHtmlVisualizationString,
-      secretVariables
+      setVisualizations,
+      secretVariables,
+      requestVariables
     );
     const req = new BrunoRequest(request, historyLogger);
     const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);
@@ -99,6 +104,23 @@ class ScriptRuntime {
       };
     }
 
+    if (this.runtime === 'quickjs') {
+      await executeQuickJsVmAsync({
+        script: script,
+        context: context,
+        collectionPath
+      });
+
+      return {
+        request,
+        envVariables: cleanJson(envVariables),
+        runtimeVariables: cleanJson(runtimeVariables),
+        visualizations,
+        nextRequestName: bru.nextRequest
+      };
+    }
+
+    // default runtime is vm2
     const vm = new NodeVM({
       sandbox: context,
       require: {
@@ -130,17 +152,18 @@ class ScriptRuntime {
           'crypto-js': CryptoJS,
           ...whitelistedModules,
           fs: allowScriptFilesystemAccess ? fs : undefined,
-          'node-vault': NodeSecrets
+          'node-vault': NodeVault
         }
       }
     });
     const asyncVM = vm.run(`module.exports = async () => { ${script} }`, path.join(collectionPath, 'vm.js'));
     await asyncVM();
+
     return {
       request,
       envVariables: cleanJson(envVariables),
-      collectionVariables: cleanJson(collectionVariables),
-      htmlVisualizationString,
+      runtimeVariables: cleanJson(runtimeVariables),
+      visualizations,
       nextRequestName: bru.nextRequest
     };
   }
@@ -150,7 +173,7 @@ class ScriptRuntime {
     request,
     response,
     envVariables,
-    collectionVariables,
+    runtimeVariables,
     collectionPath,
     onConsoleLog,
     processEnvVars,
@@ -158,18 +181,20 @@ class ScriptRuntime {
     historyLogger,
     secretVariables
   ) {
-    let htmlVisualizationString;
-    let setHtmlVisualizationString = (htmlString) => {
-      htmlVisualizationString = htmlString;
-    };
+    let visualizations = [];
+    let setVisualizations = (data) => {
+      visualizations.push(data);
+    }
+    const requestVariables = request?.requestVariables || {};
     const bru = new Bru(
       envVariables,
-      collectionVariables,
+      runtimeVariables,
       processEnvVars,
       collectionPath,
       historyLogger,
-      setHtmlVisualizationString,
-      secretVariables
+      setVisualizations,
+      secretVariables,
+      requestVariables
     );
     const req = new BrunoRequest(request, historyLogger);
     const res = new BrunoResponse(response);
@@ -203,10 +228,28 @@ class ScriptRuntime {
         log: customLogger('log'),
         info: customLogger('info'),
         warn: customLogger('warn'),
-        error: customLogger('error')
+        error: customLogger('error'),
+        debug: customLogger('debug')
+      };
+    }
+
+    if (this.runtime === 'quickjs') {
+      await executeQuickJsVmAsync({
+        script: script,
+        context: context,
+        collectionPath
+      });
+
+      return {
+        response,
+        envVariables: cleanJson(envVariables),
+        runtimeVariables: cleanJson(runtimeVariables),
+        visualizations,
+        nextRequestName: bru.nextRequest
       };
     }
 
+    // default runtime is vm2
     const vm = new NodeVM({
       sandbox: context,
       require: {
@@ -237,7 +280,7 @@ class ScriptRuntime {
           'crypto-js': CryptoJS,
           ...whitelistedModules,
           fs: allowScriptFilesystemAccess ? fs : undefined,
-          'node-vault': NodeSecrets
+          'node-vault': NodeVault
         }
       }
     });
@@ -248,8 +291,8 @@ class ScriptRuntime {
     return {
       response,
       envVariables: cleanJson(envVariables),
-      collectionVariables: cleanJson(collectionVariables),
-      htmlVisualizationString,
+      runtimeVariables: cleanJson(runtimeVariables),
+      visualizations,
       nextRequestName: bru.nextRequest
     };
   }