@usebruno/js 0.31.0 → 0.33.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usebruno/js",
-  "version": "0.31.0",
+  "version": "0.33.0",
   "license": "MIT",
   "main": "src/index.js",
   "files": [
@@ -12,10 +12,11 @@
   },
   "scripts": {
     "test": "node --experimental-vm-modules $(npx which jest) --testPathIgnorePatterns test.js",
-    "sandbox:bundle-libraries": "node ./src/sandbox/bundle-libraries.js"
+    "sandbox:bundle-libraries": "node ./src/sandbox/bundle-libraries.js",
+    "prepack": "npm run test"
   },
   "dependencies": {
-    "@usebruno/common": "0.6.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,6 +1,7 @@
 const { cloneDeep } = require('lodash');
 const { uuid } = require('./utils');
 const { interpolate: _interpolate } = require('@usebruno/common');
+const { sendRequest } = require('@usebruno/requests').scripting;
 
 const variableNameRegex = /^[\w-.]*$/;
 
@@ -19,6 +20,7 @@ class Bru {
     this.historyLogger = historyLogger;
     this.setVisualizations = setVisualizations;
     this.collectionName = collectionName;
+    this.sendRequest = sendRequest;
     this.runner = {
       skipRequest: () => {
         this.skipRequest = true;

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');
@@ -64,6 +67,7 @@ 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, collectionName);
     const req = new BrunoRequest(request);
@@ -86,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') {
@@ -123,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
@@ -178,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
@@ -209,6 +222,7 @@ class ScriptRuntime {
     const folderVariables = request?.folderVariables || {};
     const requestVariables = request?.requestVariables || {};
     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);
     const req = new BrunoRequest(request);
     const res = new BrunoResponse(response);
@@ -231,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') {
@@ -269,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
@@ -324,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';
@@ -103,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 {
@@ -118,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,
@@ -177,53 +128,60 @@ class TestRuntime {
       context.bru.runRequest = runRequestByItemPathname;
     }
 
-    if (this.runtime === 'quickjs') {
-      await executeQuickJsVmAsync({
-        script: testsFile,
-        context: context
-      });
-    } else {
-      // default runtime is vm2
-      const vm = new NodeVM({
-        sandbox: context,
-        require: {
-          context: 'sandbox',
-          external: true,
-          root: [collectionPath, ...additionalContextRootsAbsolute],
-          mock: {
-            // node libs
-            path,
-            stream,
-            util,
-            url,
-            http,
-            https,
-            punycode,
-            zlib,
-            // 3rd party libs
-            ajv,
-            'ajv-formats': addFormats,
-            btoa,
-            atob,
-            lodash,
-            moment,
-            uuid,
-            nanoid,
-            axios,
-            chai,
-            'node-fetch': fetch,
-            'crypto-js': CryptoJS,
-            'xml2js': xml2js,
-            cheerio,
-            tv4,
-            ...whitelistedModules,
-            fs: allowScriptFilesystemAccess ? fs : undefined,
-            'node-vault': NodeVault
+    let scriptError = null;
+
+    try {
+      if (this.runtime === 'quickjs') {
+        await executeQuickJsVmAsync({
+          script: testsFile,
+          context: context
+        });
+      } else {
+        // default runtime is vm2
+        const vm = new NodeVM({
+          sandbox: context,
+          require: {
+            context: 'sandbox',
+            external: true,
+            root: [collectionPath, ...additionalContextRootsAbsolute],
+            mock: {
+              // node libs
+              path,
+              stream,
+              util,
+              url,
+              http,
+              https,
+              punycode,
+              zlib,
+              // 3rd party libs
+              ajv,
+              'ajv-formats': addFormats,
+              btoa,
+              atob,
+              lodash,
+              moment,
+              uuid,
+              nanoid,
+              axios,
+              chai,
+              'node-fetch': fetch,
+              'crypto-js': CryptoJS,
+              'xml2js': xml2js,
+              cheerio,
+              tv4,
+              ...whitelistedModules,
+              fs: allowScriptFilesystemAccess ? fs : undefined,
+              'node-vault': NodeVault
+            }
           }
-        }
-      });
-      const asyncVM = vm.run(`module.exports = async () => { ${testsFile}}`, path.join(collectionPath, 'vm.js'));
-      await asyncVM();
+        });
+        const asyncVM = vm.run(`module.exports = async () => { ${testsFile}}`, path.join(collectionPath, 'vm.js'));
+        await asyncVM();
+      }
+    } catch (error) {
+      scriptError = error;
+      console.error('Test script execution error:', error);
     }
 
     if (historyLogger) {
@@ -235,7 +193,7 @@ class TestRuntime {
       });
     }
 
-    return {
+    const result = {
       request,
       envVariables: cleanJson(envVariables),
       runtimeVariables: cleanJson(runtimeVariables),
@@ -243,6 +201,13 @@ class TestRuntime {
       results: cleanJson(__brunoTestResults.getResults()),
       nextRequestName: bru.nextRequest
     };
+
+    if (scriptError) {
+      scriptError.partialResults = result;
+      throw scriptError;
+    }
+
+    return result;
   }
 }
 

package/src/sandbox/quickjs/index.js

@@ -142,10 +142,10 @@ const executeQuickJsVmAsync = async ({ script: externalScript, context: external
 
     const { bru, req, res, test, __brunoTestResults, console: consoleFn } = externalContext;
 
+    consoleFn && addConsoleShimToContext(vm, consoleFn);
     bru && addBruShimToContext(vm, bru);
     req && addBrunoRequestShimToContext(vm, req);
     res && addBrunoResponseShimToContext(vm, res);
-    consoleFn && addConsoleShimToContext(vm, consoleFn);
     addLocalModuleLoaderShimToContext(vm, collectionPath);
     addPathShimToContext(vm);
 

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

@@ -1,4 +1,4 @@
-const { cleanJson } = require('../../../utils');
+const { cleanJson, cleanCircularJson } = require('../../../utils');
 const { marshallToVm } = require('../utils');
 
 const addBruShimToContext = (vm, bru) => {
@@ -252,8 +252,7 @@ const addBruShimToContext = (vm, bru) => {
     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));
+        promise.resolve(marshallToVm(cleanCircularJson(response), vm));
       })
       .catch((err) => {
         promise.resolve(
@@ -270,6 +269,26 @@ const addBruShimToContext = (vm, bru) => {
   });
   runRequestHandle.consume((handle) => vm.setProp(bruObject, 'runRequest', handle));
 
+  let sendRequestHandle = vm.newFunction('_sendRequest', (args) => {
+    const promise = vm.newPromise();
+    bru
+      .sendRequest(vm.dump(args))
+      .then((response) => {
+        promise.resolve(marshallToVm(cleanCircularJson(response), vm));
+      })
+      .catch((err) => {
+        promise.reject(
+          marshallToVm(
+            cleanJson(err),
+            vm
+          )
+        );
+      });
+    promise.settled.then(vm.runtime.executePendingJobs);
+    return promise.handle;
+  });
+  sendRequestHandle.consume((handle) => vm.setProp(bruObject, '_sendRequest', handle));
+
   const sleep = vm.newFunction('sleep', (timer) => {
     const t = vm.getString(timer);
     const promise = vm.newPromise();
@@ -285,6 +304,29 @@ const addBruShimToContext = (vm, bru) => {
   vm.setProp(bruObject, 'runner', bruRunnerObject);
   vm.setProp(vm.global, 'bru', bruObject);
   bruObject.dispose();
+
+  vm.evalCode(`
+    globalThis.bru.sendRequest = async (requestConfig, callback) => {
+      if (!callback) return await globalThis.bru._sendRequest(requestConfig);
+      try {
+        const response = await globalThis.bru._sendRequest(requestConfig);
+        try {
+          await callback(null, response);
+        }
+        catch(error) {
+          return Promise.reject(error);
+        }
+      }
+      catch(error) {
+        try {
+          await callback(JSON.parse(JSON.stringify(error)), null);
+        }
+        catch(err) {
+          return Promise.reject(err);
+        }
+      }
+    }
+  `);
 };
 
 module.exports = addBruShimToContext;

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
+};

package/src/utils.js

@@ -158,6 +158,32 @@ const appendAwaitToTestFunc = (str) => {
   return str.replace(/(?<!\.\s*)(?<!await\s)(test\()/g, 'await $1');
 };
 
+const cleanCircularJson = (data) => {
+  try {
+    // Handle circular references by keeping track of seen objects
+    const seen = new WeakSet();
+    
+    const replacer = (key, value) => {
+      // Skip non-objects and null
+      if (typeof value !== 'object' || value === null) {
+        return value;
+      }
+      
+      // Detect circular reference
+      if (seen.has(value)) {
+        return '[Circular Reference]';
+      }
+      
+      seen.add(value);
+      return value;
+    };
+
+    return JSON.parse(JSON.stringify(data, replacer));
+  } catch (e) {
+    return data;
+  }
+};
+
 module.exports = {
   evaluateJsExpression,
   evaluateJsTemplateLiteral,
@@ -165,5 +191,6 @@ module.exports = {
   internalExpressionCache,
   cleanJson,
   uuid,
-  appendAwaitToTestFunc
+  appendAwaitToTestFunc,
+  cleanCircularJson
 };