@usebruno/js 0.26.0 → 0.28.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usebruno/js",
-  "version": "0.26.0",
+  "version": "0.28.0",
   "license": "MIT",
   "main": "src/index.js",
   "files": [

package/src/bru.js

@@ -5,7 +5,7 @@ const { interpolate } = require('@usebruno/common');
 const variableNameRegex = /^[\w-.]*$/;
 
 class Bru {
-  constructor(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, setVisualizations, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables) {
+  constructor(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, setVisualizations, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables) {
     this.envVariables = envVariables || {};
     this.runtimeVariables = runtimeVariables || {};
     this.processEnvVars = cloneDeep(processEnvVars || {});
@@ -14,6 +14,7 @@ class Bru {
     this.folderVariables = folderVariables || {};
     this.requestVariables = requestVariables || {};
     this.globalEnvironmentVariables = globalEnvironmentVariables || {};
+    this.oauth2CredentialVariables = oauth2CredentialVariables || {};
     this.collectionPath = collectionPath;
     this.historyLogger = historyLogger;
     this.setVisualizations = setVisualizations;
@@ -41,6 +42,7 @@ class Bru {
       ...this.envVariables,
       ...this.folderVariables,
       ...this.requestVariables,
+      ...this.oauth2CredentialVariables,
       ...this.runtimeVariables,
       process: {
         env: {
@@ -105,6 +107,10 @@ class Bru {
     this.globalEnvironmentVariables[key] = value;
   }
 
+  getOauth2CredentialVar(key) {
+    return this._interpolate(this.oauth2CredentialVariables[key]);
+  }
+
   hasVar(key) {
     return Object.hasOwn(this.runtimeVariables, key);
   }

package/src/bruno-request.js

@@ -13,6 +13,7 @@ class BrunoRequest {
    * It must be noted that the user cannot set these properties directly.
    * They should use the respective setter methods to set these properties.
    */
+  // todo: history logger needs to be properly refactored using the newer timeline implementation
   constructor(req, historyLogger) {
     this.req = req;
     this.url = req.url;

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

@@ -246,6 +246,7 @@ class AssertRuntime {
 
   runAssertions(assertions, request, response, envVariables, runtimeVariables, processEnvVars, historyLogger, secretVariables) {
     const globalEnvironmentVariables = request?.globalEnvironmentVariables || {};
+    const oauth2CredentialVariables = request?.oauth2CredentialVariables || {};
     const collectionVariables = request?.collectionVariables || {};
     const folderVariables = request?.folderVariables || {};
     const requestVariables = request?.requestVariables || {};
@@ -265,7 +266,8 @@ class AssertRuntime {
       collectionVariables,
       folderVariables,
       requestVariables,
-      globalEnvironmentVariables
+      globalEnvironmentVariables,
+      oauth2CredentialVariables
     );
     const req = new BrunoRequest(request, historyLogger);
     const res = createResponseParser(response);
@@ -282,6 +284,7 @@ class AssertRuntime {
       ...envVariables,
       ...folderVariables,
       ...requestVariables,
+      ...oauth2CredentialVariables,
       ...runtimeVariables,
       ...processEnvVars,
       ...bruContext

package/src/runtime/script-runtime.js

@@ -57,11 +57,12 @@ class ScriptRuntime {
       visualizations.push(data);
     }
     const globalEnvironmentVariables = request?.globalEnvironmentVariables || {};
+    const oauth2CredentialVariables = request?.oauth2CredentialVariables || {};
     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);
-    const req = new BrunoRequest(request, historyLogger);
+    const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, setVisualizations, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables);
+    const req = new BrunoRequest(request);
     const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);
     const moduleWhitelist = get(scriptingConfig, 'moduleWhitelist', []);
     const additionalContextRoots = get(scriptingConfig, 'additionalContextRoots', []);
@@ -129,6 +130,7 @@ class ScriptRuntime {
       sandbox: context,
       require: {
         context: 'sandbox',
+        builtin: [ "*" ],
         external: true,
         root: [collectionPath, ...additionalContextRootsAbsolute],
         mock: {
@@ -196,14 +198,20 @@ class ScriptRuntime {
       visualizations.push(data);
     }
     const globalEnvironmentVariables = request?.globalEnvironmentVariables || {};
+    const oauth2CredentialVariables = request?.oauth2CredentialVariables || {};
     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);
-    const req = new BrunoRequest(request, historyLogger);
+    const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, setVisualizations, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables);
+    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 = {};
 
@@ -265,8 +273,9 @@ class ScriptRuntime {
       sandbox: context,
       require: {
         context: 'sandbox',
+        builtin: [ "*" ],
         external: true,
-        root: [collectionPath],
+        root: [collectionPath, ...additionalContextRootsAbsolute],
         mock: {
           // node libs
           path,

package/src/runtime/test-runtime.js

@@ -73,11 +73,12 @@ class TestRuntime {
     runRequestByItemPathname
   ) {
     const globalEnvironmentVariables = request?.globalEnvironmentVariables || {};
+    const oauth2CredentialVariables = request?.oauth2CredentialVariables || {};
     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 bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, historyLogger, undefined, secretVariables, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables);
     const req = new BrunoRequest(request, historyLogger);
     const res = new BrunoResponse(response);
     const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);

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

@@ -53,6 +53,12 @@ const addBruShimToContext = (vm, bru) => {
   vm.setProp(bruObject, 'getGlobalEnvVar', getGlobalEnvVar);
   getGlobalEnvVar.dispose();
 
+  let getOauth2CredentialVar = vm.newFunction('getOauth2CredentialVar', function (key) {
+    return marshallToVm(bru.getOauth2CredentialVar(vm.dump(key)), vm);
+  });
+  vm.setProp(bruObject, 'getOauth2CredentialVar', getOauth2CredentialVar);
+  getOauth2CredentialVar.dispose();
+
   let setGlobalEnvVar = vm.newFunction('setGlobalEnvVar', function (key, value) {
     bru.setGlobalEnvVar(vm.dump(key), vm.dump(value));
   });