@usebruno/js 0.27.0 → 0.29.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usebruno/js",
-  "version": "0.27.0",
+  "version": "0.29.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.3.0",
+    "@usebruno/common": "0.4.0",
     "@usebruno/crypto-js": "^3.1.9",
     "@usebruno/query": "0.1.0",
     "ajv": "^8.12.0",

package/src/bru.js

@@ -5,7 +5,8 @@ const { interpolate } = require('@usebruno/common');
 const variableNameRegex = /^[\w-.]*$/;
 
 class Bru {
-  constructor(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, setVisualizations, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables) {
+  constructor(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, setVisualizations, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables, iterationDetails) {
+
     this.envVariables = envVariables || {};
     this.runtimeVariables = runtimeVariables || {};
     this.processEnvVars = cloneDeep(processEnvVars || {});
@@ -18,6 +19,7 @@ class Bru {
     this.collectionPath = collectionPath;
     this.historyLogger = historyLogger;
     this.setVisualizations = setVisualizations;
+
     this.runner = {
       skipRequest: () => {
         this.skipRequest = true;
@@ -27,9 +29,14 @@ class Bru {
       },
       setNextRequest: (nextRequest) => {
         this.nextRequest = nextRequest;
-      }
-    };
+      },
+      iterationData: new IterationDataManager(iterationDetails?.iterationData),
+      iterationIndex: iterationDetails?.iterationIndex,
+      totalIterations: iterationDetails?.totalIterations
+    }; 
+
   }
+ 
 
   _interpolate = (str) => {
     if (!str || !str.length || typeof str !== 'string') {
@@ -210,4 +217,43 @@ class Bru {
   }
 }
 
+class IterationDataManager {
+  constructor(iterationData) {
+    this._data = iterationData;
+
+    if (!this._data) {
+      this._data = {};
+    }
+  }
+
+  set(key, value) {
+    if (!this._data) {
+      this._data = {};
+    }
+
+    this._data[key] = value;
+  }
+
+  get(key) {
+    if (!key) {
+      return this._data || {};
+    }
+    return this._data?.[key];
+  }
+
+  has(key) {
+    return this._data && key in this._data;
+  }
+
+  stringify() {
+    return JSON.stringify(this.get());
+  }
+
+  unset(key) {
+    if (this._data[key]) {
+      delete this._data[key];
+    }
+  }
+}
+
 module.exports = Bru;

package/src/bruno-response.js

@@ -1,4 +1,5 @@
 const { get } = require('@usebruno/query');
+const _ = require('lodash');
 
 class BrunoResponse {
   constructor(res) {
@@ -46,8 +47,9 @@ class BrunoResponse {
       return;
     }
 
-    this.body = data;
-    this.res.data = data;
+    const clonedData = _.cloneDeep(data);
+    this.res.data = clonedData;
+    this.body = clonedData;
   }
 }
 

package/src/runtime/assert-runtime.js

@@ -250,6 +250,7 @@ class AssertRuntime {
     const collectionVariables = request?.collectionVariables || {};
     const folderVariables = request?.folderVariables || {};
     const requestVariables = request?.requestVariables || {};
+    const iterationDetails = request?.runnerIterationDetails || {};
     const enabledAssertions = _.filter(assertions, (a) => a.enabled);
     if (!enabledAssertions.length) {
       return [];
@@ -267,7 +268,8 @@ class AssertRuntime {
       folderVariables,
       requestVariables,
       globalEnvironmentVariables,
-      oauth2CredentialVariables
+      oauth2CredentialVariables,
+      iterationDetails
     );
     const req = new BrunoRequest(request, historyLogger);
     const res = createResponseParser(response);

package/src/runtime/script-runtime.js

@@ -61,7 +61,9 @@ class ScriptRuntime {
     const collectionVariables = request?.collectionVariables || {};
     const folderVariables = request?.folderVariables || {};
     const requestVariables = request?.requestVariables || {};
-    const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, setVisualizations, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables);
+    const iterationDetails = request?.runnerIterationDetails || {};
+    // TODO please clean this up
+    const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, setVisualizations, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables, iterationDetails);
     const req = new BrunoRequest(request);
     const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);
     const moduleWhitelist = get(scriptingConfig, 'moduleWhitelist', []);
@@ -202,11 +204,17 @@ class ScriptRuntime {
     const collectionVariables = request?.collectionVariables || {};
     const folderVariables = request?.folderVariables || {};
     const requestVariables = request?.requestVariables || {};
-    const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, setVisualizations, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables);
+    const iterationDetails = request?.runnerIterationDetails || {};
+    const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, setVisualizations, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables, iterationDetails);
     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 = {};
 
@@ -270,7 +278,7 @@ class ScriptRuntime {
         context: 'sandbox',
         builtin: [ "*" ],
         external: true,
-        root: [collectionPath],
+        root: [collectionPath, ...additionalContextRootsAbsolute],
         mock: {
           // node libs
           path,
@@ -293,6 +301,8 @@ class ScriptRuntime {
           axios,
           'node-fetch': fetch,
           'crypto-js': CryptoJS,
+          'xml2js': xml2js,
+          cheerio,
           ...whitelistedModules,
           fs: allowScriptFilesystemAccess ? fs : undefined,
           'node-vault': NodeVault

package/src/runtime/test-runtime.js

@@ -77,8 +77,9 @@ class TestRuntime {
     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, oauth2CredentialVariables);
+    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 req = new BrunoRequest(request, historyLogger);
     const res = new BrunoResponse(response);
     const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);

package/src/runtime/vars-runtime.js

@@ -2,6 +2,7 @@ const _ = require('lodash');
 const Bru = require('../bru');
 const BrunoRequest = require('../bruno-request');
 const { evaluateJsExpression, createResponseParser } = require('../utils');
+const { cleanJson } = require('../utils');
 
 const { executeQuickJsVm } = require('../sandbox/quickjs');
 
@@ -25,21 +26,17 @@ class VarsRuntime {
 
   runPostResponseVars(vars, request, response, envVariables, runtimeVariables, collectionPath, processEnvVars, historyLogger, secretVars = {}) {
     const requestVariables = request?.requestVariables || {};
+    const globalEnvironmentVariables = request?.globalEnvironmentVariables || {};
+    const oauth2CredentialVariables = request?.oauth2CredentialVariables || {};
+    const collectionVariables = request?.collectionVariables || {};
+    const folderVariables = request?.folderVariables || {};
+    const iterationDetails = request?.runnerIterationDetails || {};
     const enabledVars = _.filter(vars, (v) => v.enabled);
     if (!enabledVars.length) {
       return;
     }
 
-    const bru = new Bru(
-      envVariables,
-      runtimeVariables,
-      processEnvVars,
-      null,
-      historyLogger,
-      undefined, // setVisualizations
-      secretVars,
-      requestVariables
-    );
+    const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, undefined, secretVars, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables, iterationDetails);
     const req = new BrunoRequest(request, historyLogger);
     const res = createResponseParser(response);
 
@@ -78,6 +75,7 @@ class VarsRuntime {
     return {
       envVariables,
       runtimeVariables,
+      globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
       error
     };
   }

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

@@ -4,6 +4,7 @@ const { marshallToVm } = require('../utils');
 const addBruShimToContext = (vm, bru) => {
   const bruObject = vm.newObject();
   const bruRunnerObject = vm.newObject();
+  const bruRunnerIterationDataObject = vm.newObject();
 
   let cwd = vm.newFunction('cwd', function () {
     return marshallToVm(bru.cwd(), vm);
@@ -119,6 +120,47 @@ const addBruShimToContext = (vm, bru) => {
   vm.setProp(bruRunnerObject, 'setNextRequest', runnerSetNextRequest);
   runnerSetNextRequest.dispose();
 
+  let runnerIterationIndex = marshallToVm(bru?.runner?.iterationIndex, vm);
+  vm.setProp(bruRunnerObject, 'iterationIndex', runnerIterationIndex);
+  runnerIterationIndex.dispose();
+
+  let runnerTotalIterations = marshallToVm(bru?.runner?.totalIterations, vm);
+  vm.setProp(bruRunnerObject, 'totalIterations', runnerTotalIterations);
+  runnerTotalIterations.dispose();
+
+  let runnerSetIterationData = vm.newFunction('set', function (key, value) {
+    bru?.runner?.iterationData?.set(vm.dump(key), vm.dump(value));
+  });
+  vm.setProp(bruRunnerIterationDataObject, 'set', runnerSetIterationData);
+  runnerSetIterationData.dispose();
+
+  let runnerUnsetIterationData = vm.newFunction('unset', function (key) {
+    bru?.runner?.iterationData?.unset(vm.dump(key));
+  });
+  vm.setProp(bruRunnerIterationDataObject, 'unset', runnerUnsetIterationData);
+  runnerUnsetIterationData.dispose();
+
+  let runnerGetIterationData = vm.newFunction('get', function (key) {
+    if (key) {
+      return marshallToVm(bru?.runner?.iterationData?.get(vm.dump(key)), vm);
+    }
+    return marshallToVm(bru?.runner?.iterationData?.get(), vm);
+  });
+  vm.setProp(bruRunnerIterationDataObject, 'get', runnerGetIterationData);
+  runnerGetIterationData.dispose();
+
+  let runnerHasIterationData = vm.newFunction('has', function (key) {
+    return marshallToVm(bru?.runner?.iterationData?.has(vm.dump(key)), vm);
+  });
+  vm.setProp(bruRunnerIterationDataObject, 'has', runnerHasIterationData);
+  runnerHasIterationData.dispose();
+
+  let runnerStringifyIterationData = vm.newFunction('stringify', function () {
+    return marshallToVm(bru?.runner?.iterationData?.stringify(), vm);
+  });
+  vm.setProp(bruRunnerIterationDataObject, 'stringify', runnerStringifyIterationData);
+  runnerStringifyIterationData.dispose();
+
   let visualize = vm.newFunction('visualize', function (type, data) {
     bru.visualize(vm.dump(type), vm.dump(data));
   });
@@ -224,6 +266,7 @@ const addBruShimToContext = (vm, bru) => {
   });
   sleep.consume((handle) => vm.setProp(bruObject, 'sleep', handle));
 
+  vm.setProp(bruRunnerObject, 'iterationData', bruRunnerIterationDataObject);
   vm.setProp(bruObject, 'runner', bruRunnerObject);
   vm.setProp(vm.global, 'bru', bruObject);
   bruObject.dispose();