@usebruno/js 0.43.0 → 0.45.0

package/package.json

@@ -1,23 +1,20 @@
 {
   "name": "@usebruno/js",
-  "version": "0.43.0",
+  "version": "0.45.0",
   "license": "MIT",
   "main": "src/index.js",
   "files": [
     "src",
     "package.json"
   ],
-  "peerDependencies": {
-    "@usebruno/vm2": "^3.9.13"
-  },
   "scripts": {
     "test": "node --experimental-vm-modules $(npx which jest) --testPathIgnorePatterns test.js",
     "sandbox:bundle-libraries": "node ./src/sandbox/bundle-libraries.js",
     "prepack": "npm run test"
   },
   "dependencies": {
-    "@usebruno/common": "0.16.0",
-    "@usebruno/query": "0.1.0",
+    "@usebruno/common": "0.18.0",
+    "@usebruno/query": "0.2.0",
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
     "atob": "^2.1.2",
@@ -28,12 +25,11 @@
     "cheerio": "^1.0.0",
     "crypto-js": "^4.2.0",
     "json-query": "^2.2.2",
-    "jsonwebtoken": "^9.0.2",
+    "jsonwebtoken": "^9.0.3",
     "lodash": "^4.17.21",
     "moment": "^2.29.4",
     "nanoid": "3.3.8",
-    "node-fetch": "2.7.0",
-    "node-vault": "^0.10.2",
+    "node-fetch": "^2.7.0",
     "path": "^0.12.7",
     "quickjs-emscripten": "^0.29.2",
     "tv4": "^1.3.0",
@@ -46,8 +42,5 @@
     "@rollup/plugin-node-resolve": "^15.0.1",
     "rollup": "3.29.5",
     "rollup-plugin-terser": "^7.0.2"
-  },
-  "overrides": {
-    "@postman/tunnel-agent":"0.6.4"
   }
 }

package/src/bru.js

@@ -2,13 +2,32 @@ const { cloneDeep } = require('lodash');
 const { uuid } = require('./utils');
 const xmlFormat = require('xml-formatter');
 const { interpolate: _interpolate } = require('@usebruno/common');
-const { sendRequest } = require('@usebruno/requests').scripting;
+const { sendRequest, createSendRequest } = require('@usebruno/requests').scripting;
 const { jar: createCookieJar } = require('@usebruno/requests').cookies;
 
 const variableNameRegex = /^[\w-.]*$/;
 
 class Bru {
-  constructor(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, setVisualizations, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables, iterationDetails, collectionName, promptVariables) {
+  /**
+   * @param {string} runtime - The runtime environment ('quickjs' or 'nodevm')
+   * @param {object} envVariables - Environment variables
+   * @param {object} runtimeVariables - Runtime variables
+   * @param {object} processEnvVars - Process environment variables
+   * @param {string} collectionPath - Path to the collection
+   * @param {function} historyLogger - History logger function
+   * @param {function} setVisualizations - Visualizations setter function
+   * @param {object} secretVariables - Secret variables
+   * @param {object} collectionVariables - Collection-level variables
+   * @param {object} folderVariables - Folder-level variables
+   * @param {object} requestVariables - Request-level variables
+   * @param {object} globalEnvironmentVariables - Global environment variables
+   * @param {object} oauth2CredentialVariables - OAuth2 credential variables
+   * @param {object} iterationDetails - Iteration details for runner
+   * @param {string} collectionName - Name of the collection
+   * @param {object} promptVariables - Prompt variables
+   * @param {object} certsAndProxyConfig - Configuration for bru.sendRequest (proxy, certs, TLS)
+   */
+  constructor(runtime, envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, setVisualizations, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables, iterationDetails, collectionName, promptVariables, certsAndProxyConfig) {
     this.envVariables = envVariables || {};
     this.runtimeVariables = runtimeVariables || {};
     this.promptVariables = promptVariables || {};
@@ -23,11 +42,13 @@ class Bru {
     this.historyLogger = historyLogger;
     this.setVisualizations = setVisualizations;
     this.collectionName = collectionName;
-    this.sendRequest = sendRequest;
+    // Use createSendRequest with config if provided, otherwise use default sendRequest
+    this.sendRequest = certsAndProxyConfig ? createSendRequest(certsAndProxyConfig) : sendRequest;
+    this.runtime = runtime;
     this.cookies = {
       jar: () => {
         const cookieJar = createCookieJar();
-                
+
         return {
           getCookie: (url, cookieName, callback) => {
             const interpolatedUrl = this.interpolate(url);
@@ -82,7 +103,7 @@ class Bru {
       iterationData: new IterationDataManager(iterationDetails?.iterationData),
       iterationIndex: iterationDetails?.iterationIndex,
       totalIterations: iterationDetails?.totalIterations
-    }; 
+    };
 
     this.utils = {
       minifyJson: (json) => {
@@ -128,7 +149,6 @@ class Bru {
       }
     };
   }
- 
 
   interpolate = (strOrObj) => {
     if (!strOrObj) return strOrObj;
@@ -179,7 +199,7 @@ class Bru {
     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, "-", "_", "."`
@@ -242,8 +262,8 @@ class Bru {
 
     if (variableNameRegex.test(key) === false) {
       throw new Error(
-        `Variable name: "${key}" contains invalid characters!` +
-          ' Names must only contain alpha-numeric characters, "-", "_", "."'
+        `Variable name: "${key}" contains invalid characters!`
+        + ' Names must only contain alpha-numeric characters, "-", "_", "."'
       );
     }
 
@@ -251,19 +271,19 @@ class Bru {
       this.historyLogger({
         uid: uuid(),
         type: 'setVar()',
-        data: { key, value: this.interpolate(value) },
+        data: { key, value: value },
         createdAt: new Date().toISOString()
       });
     }
 
-    this.runtimeVariables[key] = this.interpolate(value);
+    this.runtimeVariables[key] = value;
   }
 
   getVar(key) {
     if (variableNameRegex.test(key) === false) {
       throw new Error(
-        `Variable name: "${key}" contains invalid characters!` +
-          ' Names must only contain alpha-numeric characters, "-", "_", "."'
+        `Variable name: "${key}" contains invalid characters!`
+        + ' Names must only contain alpha-numeric characters, "-", "_", "."'
       );
     }
 
@@ -298,12 +318,10 @@ class Bru {
     this.nextRequest = nextRequest;
   }
 
-
   getSecretVar(key) {
     return this.secretVariables?.[`$secrets.${key}`];
   }
 
-
   visualize(type, data) {
     if (type == 'table') {
       if (data?.provider == 'ag-grid') {
@@ -332,6 +350,10 @@ class Bru {
   getCollectionName() {
     return this.collectionName;
   }
+
+  isSafeMode() {
+    return this.runtime === 'quickjs';
+  }
 }
 
 class IterationDataManager {

package/src/bruno-request.js

@@ -8,7 +8,7 @@ class BrunoRequest {
    * - req.headers
    * - req.timeout
    * - req.body
-   * 
+   *
    * Above shorthands are useful for accessing the request properties directly in the scripts
    * It must be noted that the user cannot set these properties directly.
    * They should use the respective setter methods to set these properties.
@@ -22,13 +22,14 @@ class BrunoRequest {
     this.timeout = req.timeout;
     this.historyLogger = historyLogger;
     this.name = req.name;
+    this.pathParams = req.pathParams;
     this.tags = req.tags || [];
     /**
      * We automatically parse the JSON body if the content type is JSON
      * This is to make it easier for the user to access the body directly
-     * 
+     *
      * It must be noted that the request data is always a string and is what gets sent over the network
-     * If the user wants to access the raw data, they can use getBody({raw: true}) method 
+     * If the user wants to access the raw data, they can use getBody({raw: true}) method
      */
     const isJson = this.hasJSONContentType(this.req.headers);
     if (isJson) {
@@ -45,9 +46,57 @@ class BrunoRequest {
     this.req.url = url;
   }
 
+  getHost() {
+    try {
+      const url = new URL(this.req.url);
+      return url.host;
+    } catch (e) {
+      return '';
+    }
+  }
+
+  getPath() {
+    try {
+      const url = new URL(this.req.url);
+      let pathname = url.pathname;
+
+      // If path params exist, interpolate them into the pathname
+      if (this.req.pathParams && Array.isArray(this.req.pathParams)) {
+        pathname = pathname
+          .split('/')
+          .map((segment) => {
+            if (segment.startsWith(':')) {
+              const paramName = segment.slice(1);
+              const pathParam = this.req.pathParams.find((param) => param.name === paramName);
+              if (pathParam && pathParam.value) {
+                return pathParam.value;
+              }
+            }
+            return segment;
+          })
+          .join('/');
+      }
+
+      return pathname;
+    } catch (e) {
+      return '';
+    }
+  }
+
+  getQueryString() {
+    try {
+      const url = new URL(this.req.url);
+      // Return query string without the leading '?'
+      return url.search ? url.search.substring(1) : '';
+    } catch (e) {
+      return '';
+    }
+  }
+
   getMethod() {
     return this.req.method;
   }
+
   getAuthMode() {
     if (this.req?.oauth2) {
       return 'oauth2';
@@ -104,7 +153,7 @@ class BrunoRequest {
 
   /**
    * Get the body of the request
-   * 
+   *
    * We automatically parse and return the JSON body if the content type is JSON
    * If the user wants the raw body, they can pass the raw option as true
    */
@@ -128,7 +177,7 @@ class BrunoRequest {
    * Otherwise
    *  - We set the request data as the data itself
    *  - We set the body property as the data itself
-   * 
+   *
    * If the user wants to override this behavior, they can pass the raw option as true
    */
   setBody(data, options = {}) {
@@ -140,7 +189,7 @@ class BrunoRequest {
         createdAt: new Date().toISOString()
       });
     }
-    
+
     if (options.raw) {
       this.req.data = data;
       this.body = data;
@@ -170,7 +219,7 @@ class BrunoRequest {
     this.timeout = timeout;
     this.req.timeout = timeout;
   }
-  
+
   onFail(callback) {
     if (typeof callback === 'function') {
       this.req.onFailHandler = callback;
@@ -198,7 +247,6 @@ class BrunoRequest {
   __isObject(obj) {
     return obj !== null && typeof obj === 'object';
   }
-  
 
   disableParsingResponseJson() {
     this.req.__brunoDisableParsingResponseJson = true;
@@ -212,6 +260,16 @@ class BrunoRequest {
     return this.req.name;
   }
 
+  getPathParams() {
+    const params = Array.isArray(this.req.pathParams) ? this.req.pathParams : [];
+
+    return params.map((param) => ({
+      name: param.name,
+      value: param.value,
+      type: param.type
+    }));
+  }
+
   /**
    * Get the tags associated with this request
    * @returns {Array<string>} Array of tag strings

package/src/bruno-response.js

@@ -55,6 +55,20 @@ class BrunoResponse {
     const clonedData = _.cloneDeep(data);
     this.res.data = clonedData;
     this.body = clonedData;
+
+    // Update dataBuffer to match the modified body
+    if (clonedData === null || clonedData === undefined) {
+      this.res.dataBuffer = Buffer.from('');
+    } else if (typeof clonedData === 'string') {
+      this.res.dataBuffer = Buffer.from(clonedData);
+    } else {
+      // For objects, stringify them
+      try {
+        this.res.dataBuffer = Buffer.from(JSON.stringify(clonedData));
+      } catch (e) {
+        this.res.dataBuffer = Buffer.from('');
+      }
+    }
   }
 
   // TODO: Refactor: dataBuffer size calculation should be handled in a shared utility so it can be passed and reused across the application
@@ -65,7 +79,7 @@ class BrunoResponse {
 
     const { data, dataBuffer, headers } = this.res;
     let bodySize = 0;
-    
+
     // Use raw received bytes
     if (Buffer.isBuffer(dataBuffer)) {
       bodySize = dataBuffer.length;
@@ -94,7 +108,6 @@ class BrunoResponse {
     const headerSize = Buffer.byteLength(headerLines.join('\r\n'));
 
     return { header: headerSize, body: bodySize, total: headerSize + bodySize };
-    
   }
 
   getDataBuffer() {

package/src/runtime/assert-runtime.js

@@ -241,7 +241,7 @@ const evaluateRhsOperand = (rhsOperand, operator, context, runtime) => {
 
 class AssertRuntime {
   constructor(props) {
-    this.runtime = props?.runtime || 'vm2';
+    this.runtime = props?.runtime || 'quickjs';
   }
 
   runAssertions(assertions, request, response, envVariables, runtimeVariables, processEnvVars, historyLogger, secretVariables) {
@@ -257,7 +257,9 @@ class AssertRuntime {
       return [];
     }
 
+    const certsAndProxyConfig = request?.certsAndProxyConfig;
     const bru = new Bru(
+      this.runtime,
       envVariables,
       runtimeVariables,
       processEnvVars,
@@ -272,7 +274,8 @@ class AssertRuntime {
       oauth2CredentialVariables,
       iterationDetails,
       undefined,
-      promptVariables
+      promptVariables,
+      certsAndProxyConfig
     );
     const req = new BrunoRequest(request, historyLogger);
     const res = createResponseParser(response);

package/src/runtime/script-runtime.js

@@ -1,45 +1,15 @@
-const { NodeVM } = require('@usebruno/vm2');
-const path = require('path');
-const http = require('http');
-const https = require('https');
-const stream = require('stream');
-const util = require('util');
-const zlib = require('zlib');
-const url = require('url');
-const punycode = require('punycode');
-const fs = require('fs');
-const { get } = require('lodash');
+const chai = require('chai');
 const Bru = require('../bru');
 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');
-const addFormats = require('ajv-formats');
-const atob = require('atob');
-const btoa = require('btoa');
-const lodash = require('lodash');
-const moment = require('moment');
-const uuid = require('uuid');
-const nanoid = require('nanoid');
-const axios = require('axios');
-const fetch = require('node-fetch');
-const chai = require('chai');
-const CryptoJS = require('crypto-js');
-const NodeVault = require('node-vault');
-const xml2js = require('xml2js');
-const cheerio = require('cheerio');
-const tv4 = require('tv4');
-const jsonwebtoken = require('jsonwebtoken');
 const { executeQuickJsVmAsync } = require('../sandbox/quickjs');
-const { mixinTypedArrays } = require('../sandbox/mixins/typed-arrays');
 
 class ScriptRuntime {
   constructor(props) {
-    this.runtime = props?.runtime || 'vm2';
+    this.runtime = props?.runtime || 'quickjs';
   }
 
   // This approach is getting out of hand
@@ -61,7 +31,7 @@ class ScriptRuntime {
     let visualizations = [];
     let setVisualizations = (data) => {
       visualizations.push(data);
-    }
+    };
     const globalEnvironmentVariables = request?.globalEnvironmentVariables || {};
     const oauth2CredentialVariables = request?.oauth2CredentialVariables || {};
     const collectionVariables = request?.collectionVariables || {};
@@ -70,27 +40,9 @@ class ScriptRuntime {
     const promptVariables = request?.promptVariables || {};
     const iterationDetails = request?.runnerIterationDetails || {};
     const assertionResults = request?.assertionResults || [];
-    // TODO please clean this up
-    const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, setVisualizations, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables, iterationDetails, collectionName, promptVariables);
+    const certsAndProxyConfig = request?.certsAndProxyConfig;
+    const bru = new Bru(this.runtime, envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, setVisualizations, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables, iterationDetails, collectionName, promptVariables, certsAndProxyConfig);
     const req = new BrunoRequest(request);
-    const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);
-    const moduleWhitelist = get(scriptingConfig, 'moduleWhitelist', []);
-    const additionalContextRoots = get(scriptingConfig, 'additionalContextRoots', []);
-    const additionalContextRootsAbsolute = lodash
-      .chain(additionalContextRoots)
-      .map((acr) => (acr.startsWith('/') ? acr : path.join(collectionPath, acr)))
-      .value();
-
-    const whitelistedModules = {};
-
-    for (let module of moduleWhitelist) {
-      try {
-        whitelistedModules[module] = require(module);
-      } catch (e) {
-        // Ignore
-        console.warn(e);
-      }
-    }
 
     // extend bru with result getter methods
     const { __brunoTestResults, test } = createBruTestResultMethods(bru, assertionResults, chai);
@@ -104,10 +56,6 @@ class ScriptRuntime {
       __brunoTestResults: __brunoTestResults
     };
 
-    if (this.runtime === 'vm2') {
-      mixinTypedArrays(context);
-    }
-
     if (onConsoleLog && typeof onConsoleLog === 'function') {
       const customLogger = (type) => {
         return (...args) => {
@@ -149,70 +97,12 @@ class ScriptRuntime {
       };
     }
 
-    if (this.runtime === 'quickjs') {
-      await executeQuickJsVmAsync({
-        script: script,
-        context: context,
-        collectionPath
-      });
-
-      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
-      };
-    }
-
-    // default runtime is vm2
-    const vm = new NodeVM({
-      sandbox: context,
-      require: {
-        context: 'sandbox',
-        builtin: [ "*" ],
-        external: true,
-        root: [collectionPath, ...additionalContextRootsAbsolute],
-        mock: {
-          // node libs
-          path,
-          stream,
-          util,
-          url,
-          http,
-          https,
-          punycode,
-          zlib,
-          // 3rd party libs
-          ajv,
-          'ajv-formats': addFormats,
-          atob,
-          btoa,
-          lodash,
-          moment,
-          uuid,
-          nanoid,
-          axios,
-          chai,
-          'node-fetch': fetch,
-          'crypto-js': CryptoJS,
-          xml2js: xml2js,
-          jsonwebtoken,
-          cheerio,
-          tv4,
-          ...whitelistedModules,
-          fs: allowScriptFilesystemAccess ? fs : undefined,
-          'node-vault': NodeVault
-        }
-      }
+    // default runtime is `quickjs`
+    await executeQuickJsVmAsync({
+      script: script,
+      context: context,
+      collectionPath
     });
-    const asyncVM = vm.run(`module.exports = async () => { ${script} }`, path.join(collectionPath, 'vm.js'));
-    await asyncVM();
 
     return {
       request,
@@ -246,7 +136,7 @@ class ScriptRuntime {
     let visualizations = [];
     let setVisualizations = (data) => {
       visualizations.push(data);
-    }
+    };
     const globalEnvironmentVariables = request?.globalEnvironmentVariables || {};
     const oauth2CredentialVariables = request?.oauth2CredentialVariables || {};
     const collectionVariables = request?.collectionVariables || {};
@@ -255,27 +145,10 @@ class ScriptRuntime {
     const promptVariables = request?.promptVariables || {};
     const iterationDetails = request?.runnerIterationDetails || {};
     const assertionResults = request?.assertionResults || [];
-    const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, setVisualizations, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables, iterationDetails, collectionName, promptVariables);
+    const certsAndProxyConfig = request?.certsAndProxyConfig;
+    const bru = new Bru(this.runtime, envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, setVisualizations, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables, iterationDetails, collectionName, promptVariables, certsAndProxyConfig);
     const req = new BrunoRequest(request);
     const res = new BrunoResponse(response);
-    const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);
-    const moduleWhitelist = get(scriptingConfig, 'moduleWhitelist', []);
-    const additionalContextRoots = get(scriptingConfig, 'additionalContextRoots', []);
-    const additionalContextRootsAbsolute = lodash
-      .chain(additionalContextRoots)
-      .map((acr) => (acr.startsWith('/') ? acr : path.join(collectionPath, acr)))
-      .value();
-
-    const whitelistedModules = {};
-
-    for (let module of moduleWhitelist) {
-      try {
-        whitelistedModules[module] = require(module);
-      } catch (e) {
-        // Ignore
-        console.warn(e);
-      }
-    }
 
     // extend bru with result getter methods
     const { __brunoTestResults, test } = createBruTestResultMethods(bru, assertionResults, chai);
@@ -290,10 +163,6 @@ class ScriptRuntime {
       __brunoTestResults: __brunoTestResults
     };
 
-    if (this.runtime === 'vm2') {
-      mixinTypedArrays(context);
-    }
-
     if (onConsoleLog && typeof onConsoleLog === 'function') {
       const customLogger = (type) => {
         return (...args) => {
@@ -335,71 +204,13 @@ class ScriptRuntime {
       };
     }
 
-    if (this.runtime === 'quickjs') {
-      await executeQuickJsVmAsync({
-        script: script,
-        context: context,
-        collectionPath
-      });
-
-      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
-      };
-    }
-
-    // default runtime is vm2
-    const vm = new NodeVM({
-      sandbox: context,
-      require: {
-        context: 'sandbox',
-        builtin: [ "*" ],
-        external: true,
-        root: [collectionPath, ...additionalContextRootsAbsolute],
-        mock: {
-          // node libs
-          path,
-          stream,
-          util,
-          url,
-          http,
-          https,
-          punycode,
-          zlib,
-          // 3rd party libs
-          ajv,
-          'ajv-formats': addFormats,
-          atob,
-          btoa,
-          lodash,
-          moment,
-          uuid,
-          nanoid,
-          axios,
-          'node-fetch': fetch,
-          'crypto-js': CryptoJS,
-          'xml2js': xml2js,
-          jsonwebtoken,
-          cheerio,
-          tv4,
-          ...whitelistedModules,
-          fs: allowScriptFilesystemAccess ? fs : undefined,
-          'node-vault': NodeVault
-        }
-      }
+    // default runtime is `quickjs`
+    await executeQuickJsVmAsync({
+      script: script,
+      context: context,
+      collectionPath
     });
 
-    const asyncVM = vm.run(`module.exports = async () => { ${script} }`, path.join(collectionPath, 'vm.js'));
-    await asyncVM();
-
     return {
       response,
       envVariables: cleanJson(envVariables),