@usebruno/js 0.6.0 → 0.8.0

package/package.json

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

package/src/bru.js

@@ -2,10 +2,11 @@ const Handlebars = require('handlebars');
 const { cloneDeep } = require('lodash');
 
 class Bru {
-  constructor(envVariables, collectionVariables, processEnvVars) {
+  constructor(envVariables, collectionVariables, processEnvVars, collectionPath) {
     this.envVariables = envVariables;
     this.collectionVariables = collectionVariables;
     this.processEnvVars = cloneDeep(processEnvVars || {});
+    this.collectionPath = collectionPath;
   }
 
   _interpolateEnvVar = (str) => {
@@ -24,6 +25,10 @@ class Bru {
     });
   };
 
+  cwd() {
+    return this.collectionPath;
+  }
+
   getEnvName() {
     return this.envVariables.__name__;
   }

package/src/runtime/script-runtime.js

@@ -7,6 +7,8 @@ const util = require('util');
 const zlib = require('zlib');
 const url = require('url');
 const punycode = require('punycode');
+const fs = require('fs');
+const { get } = require('lodash');
 const Bru = require('../bru');
 const BrunoRequest = require('../bruno-request');
 const BrunoResponse = require('../bruno-response');
@@ -27,6 +29,8 @@ const CryptoJS = require('crypto-js');
 class ScriptRuntime {
   constructor() {}
 
+  // This approach is getting out of hand
+  // Need to refactor this to use a single arg (object) instead of 7
   async runRequestScript(
     script,
     request,
@@ -34,10 +38,24 @@ class ScriptRuntime {
     collectionVariables,
     collectionPath,
     onConsoleLog,
-    processEnvVars
+    processEnvVars,
+    scriptingConfig,
   ) {
-    const bru = new Bru(envVariables, collectionVariables, processEnvVars);
+    const bru = new Bru(envVariables, collectionVariables, processEnvVars, collectionPath);
     const req = new BrunoRequest(request);
+    const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);
+    const moduleWhitelist = get(scriptingConfig, 'moduleWhitelist', []);
+
+    const whitelistedModules = {};
+
+    for(let module of moduleWhitelist) {
+      try {
+        whitelistedModules[module] = require(module);
+      } catch (e) {
+        // Ignore
+        console.warn(e);
+      }
+    }
 
     const context = {
       bru,
@@ -84,7 +102,9 @@ class ScriptRuntime {
           axios,
           chai,
           'node-fetch': fetch,
-          'crypto-js': CryptoJS
+          'crypto-js': CryptoJS,
+          ...whitelistedModules,
+          fs: allowScriptFilesystemAccess ? fs : undefined
         }
       }
     });
@@ -105,11 +125,25 @@ class ScriptRuntime {
     collectionVariables,
     collectionPath,
     onConsoleLog,
-    processEnvVars
+    processEnvVars,
+    scriptingConfig
   ) {
-    const bru = new Bru(envVariables, collectionVariables, processEnvVars);
+    const bru = new Bru(envVariables, collectionVariables, processEnvVars, collectionPath);
     const req = new BrunoRequest(request);
     const res = new BrunoResponse(response);
+    const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);
+    const moduleWhitelist = get(scriptingConfig, 'moduleWhitelist', []);
+
+    const whitelistedModules = {};
+
+    for(let module of moduleWhitelist) {
+      try {
+        whitelistedModules[module] = require(module);
+      } catch (e) {
+        // Ignore
+        console.warn(e);
+      }
+    }
 
     const context = {
       bru,
@@ -138,6 +172,16 @@ class ScriptRuntime {
         external: true,
         root: [collectionPath],
         mock: {
+          // node libs
+          path,
+          stream,
+          util,
+          url,
+          http,
+          https,
+          punycode,
+          zlib,
+          // 3rd party libs
           atob,
           btoa,
           lodash,
@@ -146,7 +190,9 @@ class ScriptRuntime {
           nanoid,
           axios,
           'node-fetch': fetch,
-          'crypto-js': CryptoJS
+          'crypto-js': CryptoJS,
+          ...whitelistedModules,
+          fs: allowScriptFilesystemAccess ? fs : undefined,
         }
       }
     });

package/src/runtime/test-runtime.js

@@ -1,6 +1,15 @@
 const { NodeVM } = require('vm2');
 const chai = require('chai');
 const path = require('path');
+const http = require('http');
+const https = require('https');
+const stream = require('stream');
+const util = require('util');
+const zlib = require('zlib');
+const url = require('url');
+const punycode = require('punycode');
+const fs = require('fs');
+const { get } = require('lodash');
 const Bru = require('../bru');
 const BrunoRequest = require('../bruno-request');
 const BrunoResponse = require('../bruno-response');
@@ -10,6 +19,7 @@ const { cleanJson } = require('../utils');
 
 // Inbuilt Library Support
 const atob = require('atob');
+const axios = require('axios');
 const btoa = require('btoa');
 const lodash = require('lodash');
 const moment = require('moment');
@@ -20,7 +30,7 @@ const CryptoJS = require('crypto-js');
 class TestRuntime {
   constructor() {}
 
-  runTests(
+  async runTests(
     testsFile,
     request,
     response,
@@ -28,11 +38,25 @@ class TestRuntime {
     collectionVariables,
     collectionPath,
     onConsoleLog,
-    processEnvVars
+    processEnvVars,
+    scriptingConfig
   ) {
-    const bru = new Bru(envVariables, collectionVariables, processEnvVars);
+    const bru = new Bru(envVariables, collectionVariables, processEnvVars, collectionPath);
     const req = new BrunoRequest(request);
     const res = new BrunoResponse(response);
+    const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);
+    const moduleWhitelist = get(scriptingConfig, 'moduleWhitelist', []);
+
+    const whitelistedModules = {};
+
+    for(let module of moduleWhitelist) {
+      try {
+        whitelistedModules[module] = require(module);
+      } catch (e) {
+        // Ignore
+        console.warn(e);
+      }
+    }
 
     const __brunoTestResults = new TestResults();
     const test = Test(__brunoTestResults, chai);
@@ -77,19 +101,33 @@ class TestRuntime {
         external: true,
         root: [collectionPath],
         mock: {
+          // node libs
+          path,
+          stream,
+          util,
+          url,
+          http,
+          https,
+          punycode,
+          zlib,
+          // 3rd party libs
           atob,
+          axios,
           btoa,
           lodash,
           moment,
           uuid,
           nanoid,
           chai,
-          'crypto-js': CryptoJS
+          'crypto-js': CryptoJS,
+          ...whitelistedModules,
+          fs: allowScriptFilesystemAccess ? fs : undefined
         }
       }
     });
 
-    vm.run(testsFile, path.join(collectionPath, 'vm.js'));
+    const asyncVM = vm.run(`module.exports = async () => { ${testsFile}}`, path.join(collectionPath, 'vm.js'));
+    await asyncVM();
 
     return {
       request,

package/src/test.js

@@ -1,6 +1,6 @@
-const Test = (__brunoTestResults, chai) => (description, callback) => {
+const Test = (__brunoTestResults, chai) => async (description, callback) => {
   try {
-    callback();
+    await callback();
     __brunoTestResults.addResult({ description, status: 'pass' });
   } catch (error) {
     console.log(chai.AssertionError);

package/src/utils.js

@@ -11,7 +11,7 @@ const JS_KEYWORDS = `
   .filter((word) => word.length > 0);
 
 /**
- * Creates a function from a Javascript expression
+ * Creates a function from a JavaScript expression
  *
  * When the function is called, the variables used in this expression are picked up from the context
  *
@@ -119,7 +119,7 @@ const createResponseParser = (response = {}) => {
 };
 
 /**
- * Objects that are created inside vm2 execution context result in an serilaization error when sent to the renderer process
+ * Objects that are created inside vm2 execution context result in an serialization error when sent to the renderer process
  * Error sending from webFrameMain:  Error: Failed to serialize arguments
  *    at s.send (node:electron/js2c/browser_init:169:631)
  *    at g.send (node:electron/js2c/browser_init:165:2156)