@usebruno/js 0.7.0 → 0.9.0

package/package.json

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

package/src/bruno-request.js

@@ -5,6 +5,7 @@ class BrunoRequest {
     this.method = req.method;
     this.headers = req.headers;
     this.body = req.data;
+    this.timeout = req.timeout;
   }
 
   getUrl() {
@@ -50,6 +51,14 @@ class BrunoRequest {
   setMaxRedirects(maxRedirects) {
     this.req.maxRedirects = maxRedirects;
   }
+
+  getTimeout() {
+    return this.req.timeout;
+  }
+
+  setTimeout(timeout) {
+    this.req.timeout = timeout;
+  }
 }
 
 module.exports = BrunoRequest;

package/src/interpolate-string.js

@@ -0,0 +1,55 @@
+const Handlebars = require('handlebars');
+const { forOwn, cloneDeep } = require('lodash');
+
+const interpolateEnvVars = (str, processEnvVars) => {
+  if (!str || !str.length || typeof str !== 'string') {
+    return str;
+  }
+
+  const template = Handlebars.compile(str, { noEscape: true });
+
+  return template({
+    process: {
+      env: {
+        ...processEnvVars
+      }
+    }
+  });
+};
+
+const interpolateString = (str, { envVariables, collectionVariables, processEnvVars }) => {
+  if (!str || !str.length || typeof str !== 'string') {
+    return str;
+  }
+
+  processEnvVars = processEnvVars || {};
+  collectionVariables = collectionVariables || {};
+
+  // we clone envVariables because we don't want to modify the original object
+  envVariables = envVariables ? cloneDeep(envVariables) : {};
+
+  // envVariables can inturn have values as {{process.env.VAR_NAME}}
+  // so we need to interpolate envVariables first with processEnvVars
+  forOwn(envVariables, (value, key) => {
+    envVariables[key] = interpolateEnvVars(value, processEnvVars);
+  });
+
+  const template = Handlebars.compile(str, { noEscape: true });
+
+  // collectionVariables take precedence over envVariables
+  const combinedVars = {
+    ...envVariables,
+    ...collectionVariables,
+    process: {
+      env: {
+        ...processEnvVars
+      }
+    }
+  };
+
+  return template(combinedVars);
+};
+
+module.exports = {
+  interpolateString
+};

package/src/runtime/assert-runtime.js

@@ -4,8 +4,10 @@ const { nanoid } = require('nanoid');
 const Bru = require('../bru');
 const BrunoRequest = require('../bruno-request');
 const { evaluateJsTemplateLiteral, evaluateJsExpression, createResponseParser } = require('../utils');
+const { interpolateString } = require('../interpolate-string');
 
 const { expect } = chai;
+chai.use(require('chai-string'));
 chai.use(function (chai, utils) {
   // Custom assertion for checking if a variable is JSON
   chai.Assertion.addProperty('json', function () {
@@ -160,17 +162,27 @@ const evaluateRhsOperand = (rhsOperand, operator, context) => {
     return;
   }
 
+  const interpolationContext = {
+    collectionVariables: context.bru.collectionVariables,
+    envVariables: context.bru.envVariables,
+    processEnvVars: context.bru.processEnvVars
+  };
+
   // gracefully allow both a,b as well as [a, b]
   if (operator === 'in' || operator === 'notIn') {
     if (rhsOperand.startsWith('[') && rhsOperand.endsWith(']')) {
       rhsOperand = rhsOperand.substring(1, rhsOperand.length - 1);
     }
 
-    return rhsOperand.split(',').map((v) => evaluateJsTemplateLiteral(v.trim(), context));
+    return rhsOperand
+      .split(',')
+      .map((v) => evaluateJsTemplateLiteral(interpolateString(v.trim(), interpolationContext), context));
   }
 
   if (operator === 'between') {
-    const [lhs, rhs] = rhsOperand.split(',').map((v) => evaluateJsTemplateLiteral(v.trim(), context));
+    const [lhs, rhs] = rhsOperand
+      .split(',')
+      .map((v) => evaluateJsTemplateLiteral(interpolateString(v.trim(), interpolationContext), context));
     return [lhs, rhs];
   }
 
@@ -180,10 +192,10 @@ const evaluateRhsOperand = (rhsOperand, operator, context) => {
       rhsOperand = rhsOperand.substring(1, rhsOperand.length - 1);
     }
 
-    return rhsOperand;
+    return interpolateString(rhsOperand, interpolationContext);
   }
 
-  return evaluateJsTemplateLiteral(rhsOperand, context);
+  return evaluateJsTemplateLiteral(interpolateString(rhsOperand, interpolationContext), context);
 };
 
 class AssertRuntime {
@@ -268,7 +280,7 @@ class AssertRuntime {
             expect(lhs).to.endWith(rhs);
             break;
           case 'between':
-            const [min, max] = value.split(',');
+            const [min, max] = rhs;
             expect(lhs).to.be.within(min, max);
             break;
           case 'isEmpty':

package/src/runtime/script-runtime.js

@@ -8,12 +8,14 @@ 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');
 const { cleanJson } = require('../utils');
 
 // Inbuilt Library Support
+const ajv = require('ajv');
 const atob = require('atob');
 const btoa = require('btoa');
 const lodash = require('lodash');
@@ -38,10 +40,23 @@ class ScriptRuntime {
     collectionPath,
     onConsoleLog,
     processEnvVars,
-    allowScriptFilesystemAccess
+    scriptingConfig
   ) {
     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,
@@ -56,6 +71,7 @@ class ScriptRuntime {
       };
       context.console = {
         log: customLogger('log'),
+        debug: customLogger('debug'),
         info: customLogger('info'),
         warn: customLogger('warn'),
         error: customLogger('error')
@@ -79,6 +95,7 @@ class ScriptRuntime {
           punycode,
           zlib,
           // 3rd party libs
+          ajv,
           atob,
           btoa,
           lodash,
@@ -89,6 +106,7 @@ class ScriptRuntime {
           chai,
           'node-fetch': fetch,
           'crypto-js': CryptoJS,
+          ...whitelistedModules,
           fs: allowScriptFilesystemAccess ? fs : undefined
         }
       }
@@ -111,11 +129,24 @@ class ScriptRuntime {
     collectionPath,
     onConsoleLog,
     processEnvVars,
-    allowScriptFilesystemAccess
+    scriptingConfig
   ) {
     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,
@@ -154,6 +185,7 @@ class ScriptRuntime {
           punycode,
           zlib,
           // 3rd party libs
+          ajv,
           atob,
           btoa,
           lodash,
@@ -163,6 +195,7 @@ class ScriptRuntime {
           axios,
           'node-fetch': fetch,
           'crypto-js': CryptoJS,
+          ...whitelistedModules,
           fs: allowScriptFilesystemAccess ? fs : undefined
         }
       }

package/src/runtime/test-runtime.js

@@ -9,6 +9,7 @@ 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');
@@ -17,13 +18,15 @@ const TestResults = require('../test-results');
 const { cleanJson } = require('../utils');
 
 // Inbuilt Library Support
+const ajv = require('ajv');
 const atob = require('atob');
-const axios = require('axios');
 const btoa = require('btoa');
 const lodash = require('lodash');
 const moment = require('moment');
 const uuid = require('uuid');
 const nanoid = require('nanoid');
+const axios = require('axios');
+const fetch = require('node-fetch');
 const CryptoJS = require('crypto-js');
 
 class TestRuntime {
@@ -38,11 +41,24 @@ class TestRuntime {
     collectionPath,
     onConsoleLog,
     processEnvVars,
-    allowScriptFilesystemAccess
+    scriptingConfig
   ) {
     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);
@@ -97,15 +113,18 @@ class TestRuntime {
           punycode,
           zlib,
           // 3rd party libs
-          atob,
-          axios,
+          ajv,
           btoa,
+          atob,
           lodash,
           moment,
           uuid,
           nanoid,
+          axios,
           chai,
+          'node-fetch': fetch,
           'crypto-js': CryptoJS,
+          ...whitelistedModules,
           fs: allowScriptFilesystemAccess ? fs : undefined
         }
       }