@usebruno/js 0.30.0 → 0.32.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usebruno/js",
-  "version": "0.30.0",
+  "version": "0.32.0",
   "license": "MIT",
   "main": "src/index.js",
   "files": [
@@ -15,7 +15,7 @@
     "sandbox:bundle-libraries": "node ./src/sandbox/bundle-libraries.js"
   },
   "dependencies": {
-    "@usebruno/common": "0.5.0",
+    "@usebruno/common": "0.7.0",
     "@usebruno/crypto-js": "^3.1.9",
     "@usebruno/query": "0.1.0",
     "ajv": "^8.12.0",

package/src/bru.js

@@ -1,12 +1,11 @@
 const { cloneDeep } = require('lodash');
 const { uuid } = require('./utils');
-const { interpolate } = require('@usebruno/common');
+const { interpolate: _interpolate } = require('@usebruno/common');
 
 const variableNameRegex = /^[\w-.]*$/;
 
 class Bru {
-  constructor(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, setVisualizations, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables, iterationDetails) {
-
+  constructor(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, setVisualizations, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables, iterationDetails, collectionName) {
     this.envVariables = envVariables || {};
     this.runtimeVariables = runtimeVariables || {};
     this.processEnvVars = cloneDeep(processEnvVars || {});
@@ -19,7 +18,7 @@ class Bru {
     this.collectionPath = collectionPath;
     this.historyLogger = historyLogger;
     this.setVisualizations = setVisualizations;
-
+    this.collectionName = collectionName;
     this.runner = {
       skipRequest: () => {
         this.skipRequest = true;
@@ -38,10 +37,10 @@ class Bru {
   }
  
 
-  _interpolate = (str) => {
-    if (!str || !str.length || typeof str !== 'string') {
-      return str;
-    }
+  interpolate = (strOrObj) => {
+    if (!strOrObj) return strOrObj;
+    const isObj = typeof strOrObj === 'object';
+    const strToInterpolate = isObj ? JSON.stringify(strOrObj) : strOrObj;
 
     const combinedVars = {
       ...this.globalEnvironmentVariables,
@@ -58,7 +57,8 @@ class Bru {
       }
     };
 
-    return interpolate(str, combinedVars);
+    const interpolatedStr = _interpolate(strToInterpolate, combinedVars);
+    return isObj ? JSON.parse(interpolatedStr) : interpolatedStr;
   };
 
   cwd() {
@@ -78,7 +78,7 @@ class Bru {
   }
 
   getEnvVar(key) {
-    return this._interpolate(this.envVariables[key]);
+    return this.interpolate(this.envVariables[key]);
   }
 
   setEnvVar(key, value) {
@@ -103,7 +103,7 @@ class Bru {
   }
 
   getGlobalEnvVar(key) {
-    return this._interpolate(this.globalEnvironmentVariables[key]);
+    return this.interpolate(this.globalEnvironmentVariables[key]);
   }
 
   setGlobalEnvVar(key, value) {
@@ -115,7 +115,7 @@ class Bru {
   }
 
   getOauth2CredentialVar(key) {
-    return this._interpolate(this.oauth2CredentialVariables[key]);
+    return this.interpolate(this.oauth2CredentialVariables[key]);
   }
 
   hasVar(key) {
@@ -130,7 +130,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, "-", "_", "."'
       );
     }
 
@@ -150,11 +150,11 @@ 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, "-", "_", "."'
       );
     }
 
-    return this._interpolate(this.runtimeVariables[key]);
+    return this.interpolate(this.runtimeVariables[key]);
   }
 
   deleteVar(key) {
@@ -170,15 +170,15 @@ class Bru {
   }
 
   getCollectionVar(key) {
-    return this._interpolate(this.collectionVariables[key]);
+    return this.interpolate(this.collectionVariables[key]);
   }
 
   getFolderVar(key) {
-    return this._interpolate(this.folderVariables[key]);
+    return this.interpolate(this.folderVariables[key]);
   }
 
   getRequestVar(key) {
-    return this._interpolate(this.requestVariables[key]);
+    return this.interpolate(this.requestVariables[key]);
   }
 
   setNextRequest(nextRequest) {
@@ -215,6 +215,10 @@ class Bru {
   sleep(ms) {
     return new Promise((resolve) => setTimeout(resolve, ms));
   }
+
+  getCollectionName() {
+    return this.collectionName;
+  }
 }
 
 class IterationDataManager {

package/src/bruno-request.js

@@ -21,7 +21,7 @@ class BrunoRequest {
     this.headers = req.headers;
     this.timeout = req.timeout;
     this.historyLogger = historyLogger;
-
+    this.name = req.name;
     /**
      * 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
@@ -198,6 +198,10 @@ class BrunoRequest {
   getExecutionMode() {
     return this.req.__bruno__executionMode;
   }
+
+  getName() {
+    return this.req.name;
+  }
 }
 
 module.exports = BrunoRequest;

package/src/runtime/script-runtime.js

@@ -12,7 +12,10 @@ const { get } = require('lodash');
 const Bru = require('../bru');
 const BrunoRequest = require('../bruno-request');
 const BrunoResponse = require('../bruno-response');
+const Test = require('../test');
+const TestResults = require('../test-results');
 const { cleanJson } = require('../utils');
+const { createBruTestResultMethods } = require('../utils/results');
 
 // Inbuilt Library Support
 const ajv = require('ajv');
@@ -51,7 +54,8 @@ class ScriptRuntime {
     scriptingConfig,
     historyLogger,
     secretVariables,
-    runRequestByItemPathname
+    runRequestByItemPathname,
+    collectionName
   ) {
     let visualizations = [];
     let setVisualizations = (data) => {
@@ -63,8 +67,9 @@ class ScriptRuntime {
     const folderVariables = request?.folderVariables || {};
     const requestVariables = request?.requestVariables || {};
     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);
+    const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, setVisualizations, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables, iterationDetails, collectionName);
     const req = new BrunoRequest(request);
     const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);
     const moduleWhitelist = get(scriptingConfig, 'moduleWhitelist', []);
@@ -85,9 +90,16 @@ class ScriptRuntime {
       }
     }
 
+    // extend bru with result getter methods
+    const { __brunoTestResults, test } = createBruTestResultMethods(bru, assertionResults, chai);
+
     const context = {
       bru,
-      req
+      req,
+      test,
+      expect: chai.expect,
+      assert: chai.assert,
+      __brunoTestResults: __brunoTestResults
     };
 
     if (onConsoleLog && typeof onConsoleLog === 'function') {
@@ -105,7 +117,7 @@ class ScriptRuntime {
       };
     }
 
-    if(runRequestByItemPathname) {
+    if (runRequestByItemPathname) {
       context.bru.runRequest = runRequestByItemPathname;
     }
 
@@ -122,6 +134,7 @@ class ScriptRuntime {
         runtimeVariables: cleanJson(runtimeVariables),
         visualizations,
         globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
+        results: cleanJson(__brunoTestResults.getResults()),
         nextRequestName: bru.nextRequest,
         skipRequest: bru.skipRequest,
         stopExecution: bru.stopExecution
@@ -159,7 +172,7 @@ class ScriptRuntime {
           chai,
           'node-fetch': fetch,
           'crypto-js': CryptoJS,
-          'xml2js': xml2js,
+          xml2js: xml2js,
           cheerio,
           tv4,
           ...whitelistedModules,
@@ -177,6 +190,7 @@ class ScriptRuntime {
       runtimeVariables: cleanJson(runtimeVariables),
       visualizations,
       globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
+      results: cleanJson(__brunoTestResults.getResults()),
       nextRequestName: bru.nextRequest,
       skipRequest: bru.skipRequest,
       stopExecution: bru.stopExecution
@@ -195,7 +209,8 @@ class ScriptRuntime {
     scriptingConfig,
     historyLogger,
     secretVariables,
-    runRequestByItemPathname
+    runRequestByItemPathname,
+    collectionName
   ) {
     let visualizations = [];
     let setVisualizations = (data) => {
@@ -207,7 +222,8 @@ class ScriptRuntime {
     const folderVariables = request?.folderVariables || {};
     const requestVariables = request?.requestVariables || {};
     const iterationDetails = request?.runnerIterationDetails || {};
-    const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, setVisualizations, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables, iterationDetails);
+    const assertionResults = request?.assertionResults || [];
+    const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, setVisualizations, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables, iterationDetails, collectionName);
     const req = new BrunoRequest(request);
     const res = new BrunoResponse(response);
     const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);
@@ -229,10 +245,17 @@ class ScriptRuntime {
       }
     }
 
+    // extend bru with result getter methods
+    const { __brunoTestResults, test } = createBruTestResultMethods(bru, assertionResults, chai);
+
     const context = {
       bru,
       req,
-      res
+      res,
+      test,
+      expect: chai.expect,
+      assert: chai.assert,
+      __brunoTestResults: __brunoTestResults
     };
 
     if (onConsoleLog && typeof onConsoleLog === 'function') {
@@ -250,7 +273,7 @@ class ScriptRuntime {
       };
     }
 
-    if(runRequestByItemPathname) {
+    if (runRequestByItemPathname) {
       context.bru.runRequest = runRequestByItemPathname;
     }
 
@@ -267,6 +290,7 @@ class ScriptRuntime {
         runtimeVariables: cleanJson(runtimeVariables),
         visualizations,
         globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
+        results: cleanJson(__brunoTestResults.getResults()),
         nextRequestName: bru.nextRequest,
         skipRequest: bru.skipRequest,
         stopExecution: bru.stopExecution
@@ -322,6 +346,7 @@ class ScriptRuntime {
       runtimeVariables: cleanJson(runtimeVariables),
       visualizations,
       globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
+      results: cleanJson(__brunoTestResults.getResults()),
       nextRequestName: bru.nextRequest,
       skipRequest: bru.skipRequest,
       stopExecution: bru.stopExecution

package/src/runtime/test-runtime.js

@@ -15,7 +15,8 @@ const BrunoRequest = require('../bruno-request');
 const BrunoResponse = require('../bruno-response');
 const Test = require('../test');
 const TestResults = require('../test-results');
-const { cleanJson, appendAwaitToTestFunc } = require('../utils');
+const { cleanJson } = require('../utils');
+const { createBruTestResultMethods } = require('../utils/results');
 
 // Inbuilt Library Support
 const ajv = require('ajv');
@@ -35,25 +36,6 @@ const cheerio = require('cheerio');
 const tv4 = require('tv4');
 const { executeQuickJsVmAsync } = require('../sandbox/quickjs');
 
-const getResultsSummary = (results) => {
-  const summary = {
-    total: results.length,
-    passed: 0,
-    failed: 0,
-    skipped: 0,
-  };
-
-  results.forEach((r) => {
-    const passed = r.status === "pass";
-    if (passed) summary.passed += 1;
-    else if (r.status === "fail") summary.failed += 1;
-    else summary.skipped += 1;
-  });
-
-  return summary;
-}
-
-
 class TestRuntime {
   constructor(props) {
     this.runtime = props?.runtime || 'vm2';
@@ -71,7 +53,8 @@ class TestRuntime {
     scriptingConfig,
     historyLogger,
     secretVariables,
-    runRequestByItemPathname
+    runRequestByItemPathname,
+    collectionName
   ) {
     const globalEnvironmentVariables = request?.globalEnvironmentVariables || {};
     const oauth2CredentialVariables = request?.oauth2CredentialVariables || {};
@@ -80,7 +63,7 @@ class TestRuntime {
     const requestVariables = request?.requestVariables || {};
     const iterationDetails = request?.runnerIterationDetails || {};
     const assertionResults = request?.assertionResults || [];
-    const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, undefined, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables, iterationDetails);
+    const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, undefined, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables, iterationDetails, collectionName);
     const req = new BrunoRequest(request, historyLogger);
     const res = new BrunoResponse(response);
     const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);
@@ -102,9 +85,8 @@ class TestRuntime {
       }
     }
 
-    const __brunoTestResults = new TestResults();
-    
-    const test = Test(__brunoTestResults, chai);
+    // extend bru with result getter methods
+    const { __brunoTestResults, test } = createBruTestResultMethods(bru, assertionResults, chai);
 
     if (!testsFile || !testsFile.length) {
       return {
@@ -117,36 +99,6 @@ class TestRuntime {
       };
     }
 
-    bru.getTestResults = async () => {
-      let results = await __brunoTestResults.getResults();
-      const summary = getResultsSummary(results);
-      return {
-        summary,
-        results: results?.map?.(r => ({
-          status: r?.status,
-          description: r?.description,
-          expected: r?.expected,
-          actual: r?.actual,
-          error: r?.error
-        }))
-      };
-    }
-    bru.getAssertionResults = async () => {
-      let results = assertionResults;
-      const summary = getResultsSummary(results);
-      return {
-        summary,
-        results: results?.map?.(r => ({
-          status: r?.status,
-          lhsExpr: r?.lhsExpr,
-          rhsExpr: r?.rhsExpr,
-          operator: r?.operator,
-          rhsOperand: r?.rhsOperand,
-          error: r?.error
-        }))
-      };
-    }
-
     const context = {
       test,
       bru,

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

@@ -18,12 +18,24 @@ const addBruShimToContext = (vm, bru) => {
   vm.setProp(bruObject, 'getEnvName', getEnvName);
   getEnvName.dispose();
 
+  let getCollectionName = vm.newFunction('getCollectionName', function () {
+    return marshallToVm(bru.getCollectionName(), vm);
+  });
+  vm.setProp(bruObject, 'getCollectionName', getCollectionName);
+  getCollectionName.dispose();
+
   let getProcessEnv = vm.newFunction('getProcessEnv', function (key) {
     return marshallToVm(bru.getProcessEnv(vm.dump(key)), vm);
   });
   vm.setProp(bruObject, 'getProcessEnv', getProcessEnv);
   getProcessEnv.dispose();
 
+  let interpolate = vm.newFunction('interpolate', function (str) {
+    return marshallToVm(bru.interpolate(vm.dump(str)), vm);
+  });
+  vm.setProp(bruObject, 'interpolate', interpolate);
+  interpolate.dispose();
+
   let hasEnvVar = vm.newFunction('hasEnvVar', function (key) {
     return marshallToVm(bru.hasEnvVar(vm.dump(key)), vm);
   });
@@ -193,7 +205,8 @@ const addBruShimToContext = (vm, bru) => {
 
   let getTestResults = vm.newFunction('getTestResults', () => {
     const promise = vm.newPromise();
-    bru.getTestResults()
+    bru
+      .getTestResults()
       .then((results) => {
         promise.resolve(marshallToVm(cleanJson(results), vm));
       })
@@ -214,7 +227,8 @@ const addBruShimToContext = (vm, bru) => {
 
   let getAssertionResults = vm.newFunction('getAssertionResults', () => {
     const promise = vm.newPromise();
-    bru.getAssertionResults()
+    bru
+      .getAssertionResults()
       .then((results) => {
         promise.resolve(marshallToVm(cleanJson(results), vm));
       })
@@ -235,7 +249,8 @@ const addBruShimToContext = (vm, bru) => {
 
   let runRequestHandle = vm.newFunction('runRequest', (args) => {
     const promise = vm.newPromise();
-    bru.runRequest(vm.dump(args))
+    bru
+      .runRequest(vm.dump(args))
       .then((response) => {
         const { status, headers, data, dataBuffer, size, statusText } = response || {};
         promise.resolve(marshallToVm(cleanJson({ status, statusText, headers, data, dataBuffer, size }), vm));

package/src/sandbox/quickjs/shims/bruno-request.js

@@ -8,18 +8,21 @@ const addBrunoRequestShimToContext = (vm, req) => {
   const headers = marshallToVm(req.getHeaders(), vm);
   const body = marshallToVm(req.getBody(), vm);
   const timeout = marshallToVm(req.getTimeout(), vm);
+  const name = marshallToVm(req.getName(), vm);
 
   vm.setProp(reqObject, 'url', url);
   vm.setProp(reqObject, 'method', method);
   vm.setProp(reqObject, 'headers', headers);
   vm.setProp(reqObject, 'body', body);
   vm.setProp(reqObject, 'timeout', timeout);
+  vm.setProp(reqObject, 'name', name);
 
   url.dispose();
   method.dispose();
   headers.dispose();
   body.dispose();
   timeout.dispose();
+  name.dispose();
 
   let getUrl = vm.newFunction('getUrl', function () {
     return marshallToVm(req.getUrl(), vm);
@@ -45,6 +48,12 @@ const addBrunoRequestShimToContext = (vm, req) => {
   vm.setProp(reqObject, 'getAuthMode', getAuthMode);
   getAuthMode.dispose();
 
+  let getName = vm.newFunction('getName', function () {
+    return marshallToVm(req.getName(), vm);
+  });
+  vm.setProp(reqObject, 'getName', getName);
+  getName.dispose();
+
   let setMethod = vm.newFunction('setMethod', function (method) {
     req.setMethod(vm.dump(method));
   });

package/src/utils/results.js

@@ -0,0 +1,80 @@
+const TestResults = require('../test-results');
+const Test = require('../test');
+
+// Calculate summary statistics for test results
+const getResultsSummary = (results) => {
+  const summary = {
+    total: results.length,
+    passed: 0,
+    failed: 0,
+    skipped: 0,
+  };
+
+  results.forEach((r) => {
+    const passed = r.status === 'pass';
+    if (passed) summary.passed += 1;
+    else if (r.status === 'fail') summary.failed += 1;
+    else summary.skipped += 1;
+  });
+
+  return summary;
+};
+
+const createBruTestResultMethods = (bru, assertionResults, chai) => {
+  const __brunoTestResults = new TestResults();
+  const test = Test(__brunoTestResults, chai);
+  setupBruTestMethods(bru, __brunoTestResults, assertionResults);
+
+  return { __brunoTestResults, test };
+};
+
+const setupBruTestMethods = (bru, __brunoTestResults, assertionResults) => {
+  const getTestResults = async () => {
+    let results = await __brunoTestResults.getResults();
+    const summary = getResultsSummary(results);
+    return {
+      summary,
+      results: results.map(r => ({
+        status: r.status,
+        description: r.description,
+        expected: r.expected,
+        actual: r.actual,
+        error: r.error
+      }))
+    };
+  };
+
+  const getAssertionResults = async () => {
+    let results = assertionResults;
+    const summary = getResultsSummary(results);
+    return {
+      summary,
+      results: results.map(r => ({
+        status: r.status,
+        lhsExpr: r.lhsExpr,
+        rhsExpr: r.rhsExpr,
+        operator: r.operator,
+        rhsOperand: r.rhsOperand,
+        error: r.error
+      }))
+    };
+  };
+
+  // Set methods on bru object if provided
+  if (bru) {
+    bru.getTestResults = getTestResults;
+    bru.getAssertionResults = getAssertionResults;
+  }
+
+  // Also return the methods for direct use
+  return {
+    getTestResults,
+    getAssertionResults
+  };
+};
+
+module.exports = {
+  getResultsSummary,
+  createBruTestResultMethods,
+  setupBruTestMethods
+};