@usebruno/js 0.5.0 → 0.7.0

package/license.md

@@ -0,0 +1,22 @@
+
+MIT License
+
+Copyright (c) 2022 Anoop M D, Anusree P S and Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@usebruno/js",
-  "version": "0.5.0",
+  "version": "0.7.0",
+  "license": "MIT",
   "main": "src/index.js",
   "files": [
     "src",
@@ -18,7 +19,9 @@
     "atob": "^2.1.2",
     "axios": "^0.26.0",
     "btoa": "^1.2.1",
+    "chai": "^4.3.7",
     "crypto-js": "^4.1.1",
+    "handlebars": "^4.7.8",
     "json-query": "^2.2.2",
     "lodash": "^4.17.21",
     "moment": "^2.29.4",

package/src/bru.js

@@ -1,7 +1,32 @@
+const Handlebars = require('handlebars');
+const { cloneDeep } = require('lodash');
+
 class Bru {
-  constructor(envVariables, collectionVariables) {
+  constructor(envVariables, collectionVariables, processEnvVars, collectionPath) {
     this.envVariables = envVariables;
     this.collectionVariables = collectionVariables;
+    this.processEnvVars = cloneDeep(processEnvVars || {});
+    this.collectionPath = collectionPath;
+  }
+
+  _interpolateEnvVar = (str) => {
+    if (!str || !str.length || typeof str !== 'string') {
+      return str;
+    }
+
+    const template = Handlebars.compile(str, { noEscape: true });
+
+    return template({
+      process: {
+        env: {
+          ...this.processEnvVars
+        }
+      }
+    });
+  };
+
+  cwd() {
+    return this.collectionPath;
   }
 
   getEnvName() {
@@ -9,11 +34,11 @@ class Bru {
   }
 
   getProcessEnv(key) {
-    return process.env[key];
+    return this.processEnvVars[key];
   }
 
   getEnvVar(key) {
-    return this.envVariables[key];
+    return this._interpolateEnvVar(this.envVariables[key]);
   }
 
   setEnvVar(key, value) {

package/src/runtime/script-runtime.js

@@ -7,6 +7,7 @@ const util = require('util');
 const zlib = require('zlib');
 const url = require('url');
 const punycode = require('punycode');
+const fs = require('fs');
 const Bru = require('../bru');
 const BrunoRequest = require('../bruno-request');
 const BrunoResponse = require('../bruno-response');
@@ -21,13 +22,25 @@ const uuid = require('uuid');
 const nanoid = require('nanoid');
 const axios = require('axios');
 const fetch = require('node-fetch');
+const chai = require('chai');
 const CryptoJS = require('crypto-js');
 
 class ScriptRuntime {
   constructor() {}
 
-  async runRequestScript(script, request, envVariables, collectionVariables, collectionPath, onConsoleLog) {
-    const bru = new Bru(envVariables, collectionVariables);
+  // This approach is getting out of hand
+  // Need to refactor this to use a single arg (object) instead of 7
+  async runRequestScript(
+    script,
+    request,
+    envVariables,
+    collectionVariables,
+    collectionPath,
+    onConsoleLog,
+    processEnvVars,
+    allowScriptFilesystemAccess
+  ) {
+    const bru = new Bru(envVariables, collectionVariables, processEnvVars, collectionPath);
     const req = new BrunoRequest(request);
 
     const context = {
@@ -73,8 +86,10 @@ class ScriptRuntime {
           uuid,
           nanoid,
           axios,
+          chai,
           'node-fetch': fetch,
-          'crypto-js': CryptoJS
+          'crypto-js': CryptoJS,
+          fs: allowScriptFilesystemAccess ? fs : undefined
         }
       }
     });
@@ -87,8 +102,18 @@ class ScriptRuntime {
     };
   }
 
-  async runResponseScript(script, request, response, envVariables, collectionVariables, collectionPath, onConsoleLog) {
-    const bru = new Bru(envVariables, collectionVariables);
+  async runResponseScript(
+    script,
+    request,
+    response,
+    envVariables,
+    collectionVariables,
+    collectionPath,
+    onConsoleLog,
+    processEnvVars,
+    allowScriptFilesystemAccess
+  ) {
+    const bru = new Bru(envVariables, collectionVariables, processEnvVars, collectionPath);
     const req = new BrunoRequest(request);
     const res = new BrunoResponse(response);
 
@@ -119,6 +144,16 @@ class ScriptRuntime {
         external: true,
         root: [collectionPath],
         mock: {
+          // node libs
+          path,
+          stream,
+          util,
+          url,
+          http,
+          https,
+          punycode,
+          zlib,
+          // 3rd party libs
           atob,
           btoa,
           lodash,
@@ -127,7 +162,8 @@ class ScriptRuntime {
           nanoid,
           axios,
           'node-fetch': fetch,
-          'crypto-js': CryptoJS
+          'crypto-js': CryptoJS,
+          fs: allowScriptFilesystemAccess ? fs : undefined
         }
       }
     });

package/src/runtime/test-runtime.js

@@ -1,6 +1,14 @@
 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 Bru = require('../bru');
 const BrunoRequest = require('../bruno-request');
 const BrunoResponse = require('../bruno-response');
@@ -10,6 +18,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,8 +29,18 @@ const CryptoJS = require('crypto-js');
 class TestRuntime {
   constructor() {}
 
-  runTests(testsFile, request, response, envVariables, collectionVariables, collectionPath, onConsoleLog) {
-    const bru = new Bru(envVariables, collectionVariables);
+  async runTests(
+    testsFile,
+    request,
+    response,
+    envVariables,
+    collectionVariables,
+    collectionPath,
+    onConsoleLog,
+    processEnvVars,
+    allowScriptFilesystemAccess
+  ) {
+    const bru = new Bru(envVariables, collectionVariables, processEnvVars, collectionPath);
     const req = new BrunoRequest(request);
     const res = new BrunoResponse(response);
 
@@ -68,18 +87,32 @@ 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,
-          'crypto-js': CryptoJS
+          chai,
+          'crypto-js': CryptoJS,
+          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/runtime/vars-runtime.js

@@ -4,13 +4,13 @@ const BrunoRequest = require('../bruno-request');
 const { evaluateJsTemplateLiteral, evaluateJsExpression, createResponseParser } = require('../utils');
 
 class VarsRuntime {
-  runPreRequestVars(vars, request, envVariables, collectionVariables, collectionPath) {
+  runPreRequestVars(vars, request, envVariables, collectionVariables, collectionPath, processEnvVars) {
     const enabledVars = _.filter(vars, (v) => v.enabled);
     if (!enabledVars.length) {
       return;
     }
 
-    const bru = new Bru(envVariables, collectionVariables);
+    const bru = new Bru(envVariables, collectionVariables, processEnvVars);
     const req = new BrunoRequest(request);
 
     const bruContext = {
@@ -34,13 +34,13 @@ class VarsRuntime {
     };
   }
 
-  runPostResponseVars(vars, request, response, envVariables, collectionVariables, collectionPath) {
+  runPostResponseVars(vars, request, response, envVariables, collectionVariables, collectionPath, processEnvVars) {
     const enabledVars = _.filter(vars, (v) => v.enabled);
     if (!enabledVars.length) {
       return;
     }
 
-    const bru = new Bru(envVariables, collectionVariables);
+    const bru = new Bru(envVariables, collectionVariables, processEnvVars);
     const req = new BrunoRequest(request);
     const res = createResponseParser(response);
 

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)