@usebruno/js 0.23.0 → 0.24.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usebruno/js",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "license": "MIT",
   "main": "src/index.js",
   "files": [
@@ -16,6 +16,7 @@
   },
   "dependencies": {
     "@usebruno/common": "0.3.0",
+    "@usebruno/crypto-js": "^3.1.9",
     "@usebruno/query": "0.1.0",
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
@@ -25,11 +26,10 @@
     "chai": "^4.3.7",
     "chai-string": "^1.5.0",
     "crypto-js": "^4.1.1",
-    "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",
+    "nanoid": "3.3.8",
     "node-fetch": "2.7.0",
     "node-vault": "^0.10.2",
     "path": "^0.12.7",

package/src/bru.js

@@ -17,6 +17,17 @@ class Bru {
     this.collectionPath = collectionPath;
     this.historyLogger = historyLogger;
     this.setVisualizations = setVisualizations;
+    this.runner = {
+      skipRequest: () => {
+        this.skipRequest = true;
+      },
+      stopExecution: () => {
+        this.stopExecution = true;
+      },
+      setNextRequest: (nextRequest) => {
+        this.nextRequest = nextRequest;
+      }
+    };
   }
 
   _interpolate = (str) => {

package/src/runtime/assert-runtime.js

@@ -58,6 +58,7 @@ chai.use(function (chai, utils) {
  * endsWith    : ends with
  * between     : between
  * isEmpty     : is empty
+ * isNotEmpty  : is not empty
  * isNull      : is null
  * isUndefined : is undefined
  * isDefined   : is defined
@@ -95,6 +96,7 @@ const parseAssertionOperator = (str = '') => {
     'endsWith',
     'between',
     'isEmpty',
+    'isNotEmpty',
     'isNull',
     'isUndefined',
     'isDefined',
@@ -109,6 +111,7 @@ const parseAssertionOperator = (str = '') => {
 
   const unaryOperators = [
     'isEmpty',
+    'isNotEmpty',
     'isNull',
     'isUndefined',
     'isDefined',
@@ -147,6 +150,7 @@ const parseAssertionOperator = (str = '') => {
 const isUnaryOperator = (operator) => {
   const unaryOperators = [
     'isEmpty',
+    'isNotEmpty',
     'isNull',
     'isUndefined',
     'isDefined',
@@ -348,6 +352,9 @@ class AssertRuntime {
           case 'isEmpty':
             expect(lhs).to.be.empty;
             break;
+          case 'isNotEmpty':
+            expect(lhs).to.not.be.empty;
+            break;
           case 'isNull':
             expect(lhs).to.be.null;
             break;
@@ -412,6 +419,7 @@ class AssertRuntime {
         createdAt: new Date().toISOString()
       });
     }
+    request.assertionResults = assertionResults;
 
     return assertionResults;
   }

package/src/runtime/script-runtime.js

@@ -47,7 +47,8 @@ class ScriptRuntime {
     processEnvVars,
     scriptingConfig,
     historyLogger,
-    secretVariables
+    secretVariables,
+    runRequestByItemPathname
   ) {
     let visualizations = [];
     let setVisualizations = (data) => {
@@ -98,6 +99,10 @@ class ScriptRuntime {
       };
     }
 
+    if(runRequestByItemPathname) {
+      context.bru.runRequest = runRequestByItemPathname;
+    }
+
     if (this.runtime === 'quickjs') {
       await executeQuickJsVmAsync({
         script: script,
@@ -111,7 +116,9 @@ class ScriptRuntime {
         runtimeVariables: cleanJson(runtimeVariables),
         visualizations,
         globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
-        nextRequestName: bru.nextRequest
+        nextRequestName: bru.nextRequest,
+        skipRequest: bru.skipRequest,
+        stopExecution: bru.stopExecution
       };
     }
 
@@ -160,7 +167,9 @@ class ScriptRuntime {
       runtimeVariables: cleanJson(runtimeVariables),
       visualizations,
       globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
-      nextRequestName: bru.nextRequest
+      nextRequestName: bru.nextRequest,
+      skipRequest: bru.skipRequest,
+      stopExecution: bru.stopExecution
     };
   }
 
@@ -175,7 +184,8 @@ class ScriptRuntime {
     processEnvVars,
     scriptingConfig,
     historyLogger,
-    secretVariables
+    secretVariables,
+    runRequestByItemPathname
   ) {
     let visualizations = [];
     let setVisualizations = (data) => {
@@ -223,6 +233,10 @@ class ScriptRuntime {
       };
     }
 
+    if(runRequestByItemPathname) {
+      context.bru.runRequest = runRequestByItemPathname;
+    }
+
     if (this.runtime === 'quickjs') {
       await executeQuickJsVmAsync({
         script: script,
@@ -236,7 +250,9 @@ class ScriptRuntime {
         runtimeVariables: cleanJson(runtimeVariables),
         visualizations,
         globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
-        nextRequestName: bru.nextRequest
+        nextRequestName: bru.nextRequest,
+        skipRequest: bru.skipRequest,
+        stopExecution: bru.stopExecution
       };
     }
 
@@ -285,7 +301,9 @@ class ScriptRuntime {
       runtimeVariables: cleanJson(runtimeVariables),
       visualizations,
       globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
-      nextRequestName: bru.nextRequest
+      nextRequestName: bru.nextRequest,
+      skipRequest: bru.skipRequest,
+      stopExecution: bru.stopExecution
     };
   }
 }

package/src/runtime/test-runtime.js

@@ -32,6 +32,25 @@ const CryptoJS = require('crypto-js');
 const NodeVault = require('node-vault');
 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';
@@ -48,12 +67,14 @@ class TestRuntime {
     processEnvVars,
     scriptingConfig,
     historyLogger,
-    secretVariables
+    secretVariables,
+    runRequestByItemPathname
   ) {
     const globalEnvironmentVariables = request?.globalEnvironmentVariables || {};
     const collectionVariables = request?.collectionVariables || {};
     const folderVariables = request?.folderVariables || {};
     const requestVariables = request?.requestVariables || {};
+    const assertionResults = request?.assertionResults || [];  
     const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, undefined, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables);
     const req = new BrunoRequest(request, historyLogger);
     const res = new BrunoResponse(response);
@@ -77,6 +98,7 @@ class TestRuntime {
     }
 
     const __brunoTestResults = new TestResults();
+    
     const test = Test(__brunoTestResults, chai);
 
     if (!testsFile || !testsFile.length) {
@@ -90,6 +112,36 @@ 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,
@@ -115,6 +167,10 @@ class TestRuntime {
       };
     }
 
+    if(runRequestByItemPathname) {
+      context.bru.runRequest = runRequestByItemPathname;
+    }
+
     if (this.runtime === 'quickjs') {
       await executeQuickJsVmAsync({
         script: testsFile,

package/src/sandbox/bundle-libraries.js

@@ -11,7 +11,7 @@ const bundleLibraries = async () => {
     import moment from "moment";
     import btoa from "btoa";
     import atob from "atob";
-    import * as CryptoJS from "crypto-js-3.1.9-1";
+    import * as CryptoJS from "@usebruno/crypto-js";
     globalThis.expect = expect;
     globalThis.assert = assert;
     globalThis.moment = moment;

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

@@ -1,7 +1,9 @@
+const { cleanJson } = require('../../../utils');
 const { marshallToVm } = require('../utils');
 
 const addBruShimToContext = (vm, bru) => {
   const bruObject = vm.newObject();
+  const bruRunnerObject = vm.newObject();
 
   let cwd = vm.newFunction('cwd', function () {
     return marshallToVm(bru.cwd(), vm);
@@ -93,6 +95,24 @@ const addBruShimToContext = (vm, bru) => {
   vm.setProp(bruObject, 'setNextRequest', setNextRequest);
   setNextRequest.dispose();
 
+  let runnerSkipRequest = vm.newFunction('skipRequest', function () {
+    bru?.runner?.skipRequest();
+  });
+  vm.setProp(bruRunnerObject, 'skipRequest', runnerSkipRequest);
+  runnerSkipRequest.dispose();
+
+  let runnerStopExecution = vm.newFunction('stopExecution', function () {
+    bru?.runner?.stopExecution();
+  });
+  vm.setProp(bruRunnerObject, 'stopExecution', runnerStopExecution);
+  runnerStopExecution.dispose();
+
+  let runnerSetNextRequest = vm.newFunction('setNextRequest', function (nextRequest) {
+    bru?.runner?.setNextRequest(vm.dump(nextRequest));
+  });
+  vm.setProp(bruRunnerObject, 'setNextRequest', runnerSetNextRequest);
+  runnerSetNextRequest.dispose();
+
   let visualize = vm.newFunction('visualize', function (type, data) {
     bru.visualize(vm.dump(type), vm.dump(data));
   });
@@ -123,6 +143,70 @@ const addBruShimToContext = (vm, bru) => {
   vm.setProp(bruObject, 'getCollectionVar', getCollectionVar);
   getCollectionVar.dispose();
 
+  let getTestResults = vm.newFunction('getTestResults', () => {
+    const promise = vm.newPromise();
+    bru.getTestResults()
+      .then((results) => {
+        promise.resolve(marshallToVm(cleanJson(results), vm));
+      })
+      .catch((err) => {
+        promise.resolve(
+          marshallToVm(
+            cleanJson({
+              message: err.message
+            }),
+            vm
+          )
+        );
+      });
+    promise.settled.then(vm.runtime.executePendingJobs);
+    return promise.handle;
+  });
+  getTestResults.consume((handle) => vm.setProp(bruObject, 'getTestResults', handle));
+
+  let getAssertionResults = vm.newFunction('getAssertionResults', () => {
+    const promise = vm.newPromise();
+    bru.getAssertionResults()
+      .then((results) => {
+        promise.resolve(marshallToVm(cleanJson(results), vm));
+      })
+      .catch((err) => {
+        promise.resolve(
+          marshallToVm(
+            cleanJson({
+              message: err.message
+            }),
+            vm
+          )
+        );
+      });
+    promise.settled.then(vm.runtime.executePendingJobs);
+    return promise.handle;
+  });
+  getAssertionResults.consume((handle) => vm.setProp(bruObject, 'getAssertionResults', handle));
+
+  let runRequestHandle = vm.newFunction('runRequest', (args) => {
+    const promise = vm.newPromise();
+    bru.runRequest(vm.dump(args))
+      .then((response) => {
+        const { status, headers, data, dataBuffer, size } = response || {};
+        promise.resolve(marshallToVm(cleanJson({ status, headers, data, dataBuffer, size }), vm));
+      })
+      .catch((err) => {
+        promise.resolve(
+          marshallToVm(
+            cleanJson({
+              message: err.message
+            }),
+            vm
+          )
+        );
+      });
+    promise.settled.then(vm.runtime.executePendingJobs);
+    return promise.handle;
+  });
+  runRequestHandle.consume((handle) => vm.setProp(bruObject, 'runRequest', handle));
+
   const sleep = vm.newFunction('sleep', (timer) => {
     const t = vm.getString(timer);
     const promise = vm.newPromise();
@@ -134,6 +218,7 @@ const addBruShimToContext = (vm, bru) => {
   });
   sleep.consume((handle) => vm.setProp(bruObject, 'sleep', handle));
 
+  vm.setProp(bruObject, 'runner', bruRunnerObject);
   vm.setProp(vm.global, 'bru', bruObject);
   bruObject.dispose();
 };

package/src/utils.js

@@ -19,8 +19,8 @@ const JS_KEYWORDS = `
  * ```js
  * res.data.pets.map(pet => pet.name.toUpperCase())
  *
- * function(context) {
- *   const { res, pet } = context;
+ * function(__bruno__functionInnerContext) {
+ *   const { res, pet } = __bruno__functionInnerContext;
  *   return res.data.pets.map(pet => pet.name.toUpperCase())
  * }
  * ```
@@ -46,9 +46,11 @@ const compileJsExpression = (expr) => {
     globals: globals.map((name) => ` ${name} = ${name} ?? globalThis.${name};`).join('')
   };
 
-  const body = `let { ${code.vars} } = context; ${code.globals}; return ${expr}`;
+  // param name that is unlikely to show up as a var in an expression
+  const param = `__bruno__functionInnerContext`;
+  const body = `let { ${code.vars} } = ${param}; ${code.globals}; return ${expr}`;
 
-  return new Function('context', body);
+  return new Function(param, body);
 };
 
 const internalExpressionCache = new Map();