@usebruno/js 0.36.0 → 0.38.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usebruno/js",
-  "version": "0.36.0",
+  "version": "0.38.0",
   "license": "MIT",
   "main": "src/index.js",
   "files": [
@@ -16,7 +16,7 @@
     "prepack": "npm run test"
   },
   "dependencies": {
-    "@usebruno/common": "0.10.0",
+    "@usebruno/common": "0.12.1",
     "@usebruno/crypto-js": "^3.1.9",
     "@usebruno/query": "0.1.0",
     "ajv": "^8.12.0",
@@ -44,8 +44,6 @@
     "@rollup/plugin-commonjs": "^23.0.2",
     "@rollup/plugin-node-resolve": "^15.0.1",
     "rollup": "3.29.5",
-    "rollup-plugin-terser": "^7.0.2",
-    "stream": "^0.0.2",
-    "util": "^0.12.5"
+    "rollup-plugin-terser": "^7.0.2"
   }
-}
+}

package/src/bru.js

@@ -2,7 +2,7 @@ const { cloneDeep } = require('lodash');
 const { uuid } = require('./utils');
 const { interpolate: _interpolate } = require('@usebruno/common');
 const { sendRequest } = require('@usebruno/requests').scripting;
-const { jar: createCookieJar } = require('@usebruno/common').cookies;
+const { jar: createCookieJar } = require('@usebruno/requests').cookies;
 
 const variableNameRegex = /^[\w-.]*$/;
 
@@ -22,7 +22,6 @@ class Bru {
     this.setVisualizations = setVisualizations;
     this.collectionName = collectionName;
     this.sendRequest = sendRequest;
-
     this.cookies = {
       jar: () => {
         const cookieJar = createCookieJar();
@@ -66,6 +65,8 @@ class Bru {
         };
       }
     };
+    // Holds variables that are marked as persistent by scripts
+    this.persistentEnvVariables = {};
     this.runner = {
       skipRequest: () => {
         this.skipRequest = true;
@@ -128,10 +129,21 @@ class Bru {
     return this.interpolate(this.envVariables[key]);
   }
 
-  setEnvVar(key, value) {
+  setEnvVar(key, value, options = {}) {
     if (!key) {
       throw new Error('Creating a env variable without specifying a name is not allowed.');
     }
+    
+    if (variableNameRegex.test(key) === false) {
+      throw new Error(
+        `Variable name: "${key}" contains invalid characters! Names must only contain alpha-numeric characters, "-", "_", "."`
+      );
+    }
+
+    // When persist is true, only string values are allowed
+    if (options?.persist && typeof value !== 'string') {
+      throw new Error(`Persistent environment variables must be strings. Received ${typeof value} for key "${key}".`);
+    }
 
     if (this.historyLogger) {
       this.historyLogger({
@@ -143,6 +155,14 @@ class Bru {
     }
 
     this.envVariables[key] = value;
+
+    if (options?.persist) {
+      this.persistentEnvVariables[key] = value;
+    } else {
+      if (this.persistentEnvVariables[key]) {
+        delete this.persistentEnvVariables[key];
+      }
+    }
   }
 
   deleteEnvVar(key) {

package/src/index.js

@@ -2,10 +2,12 @@ const ScriptRuntime = require('./runtime/script-runtime');
 const TestRuntime = require('./runtime/test-runtime');
 const VarsRuntime = require('./runtime/vars-runtime');
 const AssertRuntime = require('./runtime/assert-runtime');
+const { runScriptInNodeVm } = require('./sandbox/node-vm');
 
 module.exports = {
   ScriptRuntime,
   TestRuntime,
   VarsRuntime,
-  AssertRuntime
+  AssertRuntime,
+  runScriptInNodeVm
 };

package/src/runtime/script-runtime.js

@@ -14,6 +14,7 @@ const BrunoRequest = require('../bruno-request');
 const BrunoResponse = require('../bruno-response');
 const { cleanJson } = require('../utils');
 const { createBruTestResultMethods } = require('../utils/results');
+const { runScriptInNodeVm } = require('../sandbox/node-vm');
 
 // Inbuilt Library Support
 const ajv = require('ajv');
@@ -119,6 +120,28 @@ class ScriptRuntime {
       context.bru.runRequest = runRequestByItemPathname;
     }
 
+    if (this.runtime === 'nodevm') {
+      await runScriptInNodeVm({
+        script,
+        context,
+        collectionPath,
+        scriptingConfig
+      });
+
+      return {
+        request,
+        envVariables: cleanJson(envVariables),
+        runtimeVariables: cleanJson(runtimeVariables),
+        visualizations,
+        persistentEnvVariables: bru.persistentEnvVariables,
+        globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
+        results: cleanJson(__brunoTestResults.getResults()),
+        nextRequestName: bru.nextRequest,
+        skipRequest: bru.skipRequest,
+        stopExecution: bru.stopExecution
+      };
+    }
+
     if (this.runtime === 'quickjs') {
       await executeQuickJsVmAsync({
         script: script,
@@ -131,6 +154,7 @@ class ScriptRuntime {
         envVariables: cleanJson(envVariables),
         runtimeVariables: cleanJson(runtimeVariables),
         visualizations,
+        persistentEnvVariables: bru.persistentEnvVariables,
         globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
         results: cleanJson(__brunoTestResults.getResults()),
         nextRequestName: bru.nextRequest,
@@ -187,6 +211,7 @@ class ScriptRuntime {
       envVariables: cleanJson(envVariables),
       runtimeVariables: cleanJson(runtimeVariables),
       visualizations,
+      persistentEnvVariables: bru.persistentEnvVariables,
       globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
       results: cleanJson(__brunoTestResults.getResults()),
       nextRequestName: bru.nextRequest,
@@ -275,6 +300,28 @@ class ScriptRuntime {
       context.bru.runRequest = runRequestByItemPathname;
     }
 
+    if (this.runtime === 'nodevm') {
+      await runScriptInNodeVm({
+        script,
+        context,
+        collectionPath,
+        scriptingConfig
+      });
+
+      return {
+        response,
+        envVariables: cleanJson(envVariables),
+        persistentEnvVariables: cleanJson(bru.persistentEnvVariables),
+        runtimeVariables: cleanJson(runtimeVariables),
+        visualizations,
+        globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
+        results: cleanJson(__brunoTestResults.getResults()),
+        nextRequestName: bru.nextRequest,
+        skipRequest: bru.skipRequest,
+        stopExecution: bru.stopExecution
+      };
+    }
+
     if (this.runtime === 'quickjs') {
       await executeQuickJsVmAsync({
         script: script,
@@ -285,6 +332,7 @@ class ScriptRuntime {
       return {
         response,
         envVariables: cleanJson(envVariables),
+        persistentEnvVariables: cleanJson(bru.persistentEnvVariables),
         runtimeVariables: cleanJson(runtimeVariables),
         visualizations,
         globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
@@ -341,6 +389,7 @@ class ScriptRuntime {
     return {
       response,
       envVariables: cleanJson(envVariables),
+      persistentEnvVariables: cleanJson(bru.persistentEnvVariables),
       runtimeVariables: cleanJson(runtimeVariables),
       visualizations,
       globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),

package/src/runtime/test-runtime.js

@@ -1,4 +1,5 @@
 const { NodeVM } = require('@usebruno/vm2');
+const { runScriptInNodeVm } = require('../sandbox/node-vm');
 const chai = require('chai');
 const path = require('path');
 const http = require('http');
@@ -136,6 +137,13 @@ class TestRuntime {
           script: testsFile,
           context: context
         });
+      } else if (this.runtime === 'nodevm') {
+        await runScriptInNodeVm({
+          script: testsFile,
+          context,
+          collectionPath,
+          scriptingConfig
+        });
       } else {
         // default runtime is vm2
         const vm = new NodeVM({
@@ -197,6 +205,7 @@ class TestRuntime {
       envVariables: cleanJson(envVariables),
       runtimeVariables: cleanJson(runtimeVariables),
       globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
+      persistentEnvVariables: cleanJson(bru.persistentEnvVariables),
       results: cleanJson(__brunoTestResults.getResults()),
       nextRequestName: bru.nextRequest
     };

package/src/runtime/vars-runtime.js

@@ -76,6 +76,7 @@ class VarsRuntime {
       envVariables,
       runtimeVariables,
       globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
+      persistentEnvVariables: cleanJson(bru.persistentEnvVariables),
       error
     };
   }

package/src/sandbox/node-vm/index.js

@@ -0,0 +1,223 @@
+const vm = require('node:vm');
+const fs = require('node:fs');
+const path = require('node:path');
+const { get } = require('lodash');
+const lodash = require('lodash');
+const { cleanJson } = require('../../utils');
+
+class ScriptError extends Error {
+  constructor(error, script) {
+    super(error.message);
+    this.name = 'ScriptError';
+    this.originalError = error;
+    this.script = script;
+    this.stack = error.stack;
+  }
+}
+
+/**
+ * Executes a script in a Node.js VM context with enhanced security and module loading
+ * @param {Object} options - Configuration options
+ * @param {string} options.script - The script code to execute
+ * @param {Object} options.context - The execution context with Bruno objects
+ * @param {string} options.collectionPath - Path to the collection directory
+ * @param {Object} options.scriptingConfig - Scripting configuration options
+ * @returns {Promise<Object>} Execution results including variables and test results
+ * @throws {ScriptError} When script execution fails
+ */
+async function runScriptInNodeVm({
+  script,
+  context,
+  collectionPath,
+  scriptingConfig
+}) {
+  if (script.trim().length === 0) {
+    return;
+  }
+
+  try {
+    // Create script context with all necessary variables
+    const scriptContext = {
+      // Bruno context
+      console: context.console,
+      req: context.req,
+      res: context.res,
+      bru: context.bru,
+      expect: context.expect,
+      assert: context.assert,
+      __brunoTestResults: context.__brunoTestResults,
+      test: context.test,
+      // Configuration for nested module loading
+      scriptingConfig: scriptingConfig,
+      // Global objects
+      Buffer: global.Buffer,
+      process: global.process,
+      setTimeout: global.setTimeout,
+      setInterval: global.setInterval,
+      clearTimeout: global.clearTimeout,
+      clearInterval: global.clearInterval,
+      setImmediate: global.setImmediate,
+      clearImmediate: global.clearImmediate
+    };
+
+    // Create shared cache for local modules
+    const localModuleCache = new Map();
+
+    // Create a custom require function and add it to the context
+    scriptContext.require = createCustomRequire({
+      scriptingConfig,
+      collectionPath,
+      scriptContext,
+      currentModuleDir: collectionPath,
+      localModuleCache
+    });
+
+    // Execute the script in an isolated VM context
+    await vm.runInNewContext(`
+        (async function(){
+          ${script}
+        })();
+      `, scriptContext, {
+      filename: path.join(collectionPath, 'script.js'),
+      displayErrors: true
+    });
+  } catch (error) {
+    throw new ScriptError(error, script);
+  }
+
+  return;
+}
+
+
+/**
+ * Creates a custom require function with enhanced security and local module support
+ * @param {Object} options - Configuration options
+ * @param {Object} options.scriptingConfig - Scripting configuration with additional context roots
+ * @param {string} options.collectionPath - Base collection path for security checks
+ * @param {Object} options.scriptContext - Script execution context
+ * @param {string} options.currentModuleDir - Current module directory for relative imports
+ * @param {Map} options.localModuleCache - Cache for loaded local modules
+ * @returns {Function} Custom require function
+ */
+function createCustomRequire({
+  scriptingConfig,
+  collectionPath,
+  scriptContext,
+  currentModuleDir = collectionPath,
+  localModuleCache = new Map()
+}) {
+  const additionalContextRoots = get(scriptingConfig, 'additionalContextRoots', []);
+  const additionalContextRootsAbsolute = lodash
+    .chain(additionalContextRoots)
+    .map((acr) => (acr.startsWith('/') ? acr : path.join(collectionPath, acr)))
+    .value();
+  additionalContextRootsAbsolute.push(collectionPath);
+
+  return (moduleName) => {
+    // Check if it's a local module (starts with ./ or ../)
+    if (moduleName.startsWith('./') || moduleName.startsWith('../')) {
+      return loadLocalModule({ moduleName, collectionPath, scriptContext, localModuleCache, currentModuleDir });
+    }
+
+    // First try to require as a native/npm module
+    try {
+      return require(moduleName);
+    } catch {
+      // If that fails, try to resolve from additionalContextRoots
+      try {
+        const modulePath = require.resolve(moduleName, { paths: additionalContextRootsAbsolute });
+        return require(modulePath);
+      } catch (error) {
+        throw new Error(`Could not resolve module "${moduleName}": ${error.message}\n\nThis most likely means you did not install the module under "additionalContextRoots" using a package manager like npm.\n\nThese are your current "additionalContextRoots":\n${additionalContextRootsAbsolute.map(root => `  - ${root}`).join('\n') || '  - No "additionalContextRoots" defined'}`);
+      }
+    }
+  };
+}
+
+/**
+ * Loads a local module from the filesystem with security checks and caching
+ * @param {Object} options - Configuration options
+ * @param {string} options.moduleName - Name/path of the module to load
+ * @param {string} options.collectionPath - Base collection path for security validation
+ * @param {Object} options.scriptContext - Script execution context to inherit
+ * @param {Map} options.localModuleCache - Cache for loaded modules
+ * @param {string} options.currentModuleDir - Directory of the current module for relative resolution
+ * @returns {*} The exported content of the loaded module
+ * @throws {Error} When module is outside collection path or cannot be loaded
+ */
+function loadLocalModule({
+  moduleName,
+  collectionPath,
+  scriptContext,
+  localModuleCache,
+  currentModuleDir
+}) {
+  // Check if the filename has an extension
+  const hasExtension = path.extname(moduleName) !== '';
+  const resolvedFilename = hasExtension ? moduleName : `${moduleName}.js`;
+
+  // Resolve the file path relative to the current module's directory
+  const filePath = path.resolve(currentModuleDir, resolvedFilename);
+  const normalizedFilePath = path.normalize(filePath);
+  const normalizedCollectionPath = path.normalize(collectionPath);
+
+  // Cross-platform security check: ensure the resolved file is within collectionPath
+  const relativePath = path.relative(normalizedCollectionPath, normalizedFilePath);
+  if (relativePath.startsWith('..') || path.isAbsolute(relativePath)) {
+    throw new Error(`Access to files outside of the collectionPath is not allowed: ${moduleName}`);
+  }
+
+  // Check cache first (use normalized path as key)
+  if (localModuleCache.has(normalizedFilePath)) {
+    return localModuleCache.get(normalizedFilePath);
+  }
+
+  if (!fs.existsSync(normalizedFilePath)) {
+    throw new Error(`Cannot find module ${moduleName}`);
+  }
+
+  // Read and execute the local module
+  const moduleCode = fs.readFileSync(normalizedFilePath, 'utf8');
+
+  // Create module object
+  const moduleObj = { exports: {} };
+
+  // Get the directory of this module for nested imports
+  const moduleDir = path.dirname(normalizedFilePath);
+
+  // Create a new context that inherits from the script context
+  const moduleContext = {
+    ...scriptContext,
+    module: moduleObj,
+    exports: moduleObj.exports,
+    __filename: normalizedFilePath,
+    __dirname: moduleDir,
+    // Create a custom require function for this module that resolves relative to its directory
+    require: createCustomRequire({
+      scriptingConfig: scriptContext.scriptingConfig || {}, 
+      collectionPath, 
+      scriptContext, 
+      currentModuleDir: moduleDir, 
+      localModuleCache
+    })
+  };
+
+  try {
+    // Execute the module code in the shared context
+    vm.runInNewContext(moduleCode, moduleContext, {
+      filename: normalizedFilePath,
+      displayErrors: true
+    });
+
+    // Cache the result using normalized path
+    localModuleCache.set(normalizedFilePath, moduleObj.exports);
+
+    return moduleObj.exports;
+  } catch (error) {
+    throw new Error(`Error loading local module ${moduleName}: ${error.message}`);
+  }
+}
+
+module.exports = {
+  runScriptInNodeVm
+};

package/src/sandbox/quickjs/shims/bru.js

@@ -48,8 +48,8 @@ const addBruShimToContext = (vm, bru) => {
   vm.setProp(bruObject, 'getEnvVar', getEnvVar);
   getEnvVar.dispose();
 
-  let setEnvVar = vm.newFunction('setEnvVar', function (key, value) {
-    bru.setEnvVar(vm.dump(key), vm.dump(value));
+  let setEnvVar = vm.newFunction('setEnvVar', function (key, value, options = {}) {
+    bru.setEnvVar(vm.dump(key), vm.dump(value), vm.dump(options));
   });
   vm.setProp(bruObject, 'setEnvVar', setEnvVar);
   setEnvVar.dispose();