@usebruno/js 0.11.0 → 0.13.0

package/package.json

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

package/src/bru.js

@@ -1,14 +1,26 @@
 const Handlebars = require('handlebars');
 const { cloneDeep } = require('lodash');
+const { uuid } = require('./utils');
 
 const variableNameRegex = /^[\w-.]*$/;
 
 class Bru {
-  constructor(envVariables, collectionVariables, processEnvVars, collectionPath) {
+  constructor(
+    envVariables,
+    collectionVariables,
+    processEnvVars,
+    collectionPath,
+    historyLogger,
+    setHtmlVisualizationString,
+    secretVariables
+  ) {
     this.envVariables = envVariables;
     this.collectionVariables = collectionVariables;
     this.processEnvVars = cloneDeep(processEnvVars || {});
+    this.secretVariables = cloneDeep(secretVariables || {});
     this.collectionPath = collectionPath;
+    this.historyLogger = historyLogger;
+    this.setHtmlVisualizationString = setHtmlVisualizationString;
   }
 
   _interpolateEnvVar = (str) => {
@@ -48,6 +60,15 @@ class Bru {
       throw new Error('Creating a env variable without specifying a name is not allowed.');
     }
 
+    if (this.historyLogger) {
+      this.historyLogger({
+        uid: uuid(),
+        type: 'setEnvVar()',
+        data: { key, value },
+        createdAt: new Date().toISOString()
+      });
+    }
+
     this.envVariables[key] = value;
   }
 
@@ -63,6 +84,15 @@ class Bru {
       );
     }
 
+    if (this.historyLogger) {
+      this.historyLogger({
+        uid: uuid(),
+        type: 'setVar()',
+        data: { key, value },
+        createdAt: new Date().toISOString()
+      });
+    }
+
     this.collectionVariables[key] = value;
   }
 
@@ -80,6 +110,14 @@ class Bru {
   setNextRequest(nextRequest) {
     this.nextRequest = nextRequest;
   }
+
+  visualize(htmlString) {
+    this.setHtmlVisualizationString(htmlString);
+  }
+
+  getSecretVar(key) {
+    return this.secretVariables?.[`$secrets.${key}`];
+  }
 }
 
 module.exports = Bru;

package/src/bruno-request.js

@@ -1,11 +1,14 @@
+const { uuid } = require('./utils');
+
 class BrunoRequest {
-  constructor(req) {
+  constructor(req, historyLogger) {
     this.req = req;
     this.url = req.url;
     this.method = req.method;
     this.headers = req.headers;
     this.body = req.data;
     this.timeout = req.timeout;
+    this.historyLogger = historyLogger;
   }
 
   getUrl() {
@@ -53,6 +56,14 @@ class BrunoRequest {
   }
 
   setHeader(name, value) {
+    if (this.historyLogger) {
+      this.historyLogger({
+        uid: uuid(),
+        type: 'setHeader()',
+        data: { name, value },
+        createdAt: new Date().toISOString()
+      });
+    }
     this.req.headers[name] = value;
   }
 
@@ -61,6 +72,14 @@ class BrunoRequest {
   }
 
   setBody(data) {
+    if (this.historyLogger) {
+      this.historyLogger({
+        uid: uuid(),
+        type: 'setBody()',
+        data: { body: data },
+        createdAt: new Date().toISOString()
+      });
+    }
     this.req.data = data;
   }
 

package/src/runtime/assert-runtime.js

@@ -3,7 +3,7 @@ const chai = require('chai');
 const { nanoid } = require('nanoid');
 const Bru = require('../bru');
 const BrunoRequest = require('../bruno-request');
-const { evaluateJsTemplateLiteral, evaluateJsExpression, createResponseParser } = require('../utils');
+const { evaluateJsTemplateLiteral, evaluateJsExpression, createResponseParser, uuid } = require('../utils');
 const { interpolateString } = require('../interpolate-string');
 
 const { expect } = chai;
@@ -199,14 +199,31 @@ const evaluateRhsOperand = (rhsOperand, operator, context) => {
 };
 
 class AssertRuntime {
-  runAssertions(assertions, request, response, envVariables, collectionVariables, collectionPath) {
+  runAssertions(
+    assertions,
+    request,
+    response,
+    envVariables,
+    collectionVariables,
+    collectionPath,
+    historyLogger,
+    secretVariables
+  ) {
     const enabledAssertions = _.filter(assertions, (a) => a.enabled);
     if (!enabledAssertions.length) {
       return [];
     }
 
-    const bru = new Bru(envVariables, collectionVariables);
-    const req = new BrunoRequest(request);
+    const bru = new Bru(
+      envVariables,
+      collectionVariables,
+      undefined, // processEnvVars,
+      undefined, // collectionPath,
+      undefined, // historyLogger,
+      undefined, // setHtmlVisualizationString,
+      secretVariables
+    );
+    const req = new BrunoRequest(request, historyLogger);
     const res = createResponseParser(response);
 
     const bruContext = {
@@ -339,6 +356,15 @@ class AssertRuntime {
       }
     }
 
+    if (historyLogger) {
+      historyLogger({
+        uid: uuid(),
+        type: 'network',
+        assertions: assertionResults,
+        createdAt: new Date().toISOString()
+      });
+    }
+
     return assertionResults;
   }
 }

package/src/runtime/script-runtime.js

@@ -27,7 +27,7 @@ const axios = require('axios');
 const fetch = require('node-fetch');
 const chai = require('chai');
 const CryptoJS = require('crypto-js');
-const NodeVault = require('node-vault');
+const NodeSecrets = require('node-vault');
 
 class ScriptRuntime {
   constructor() {}
@@ -42,10 +42,24 @@ class ScriptRuntime {
     collectionPath,
     onConsoleLog,
     processEnvVars,
-    scriptingConfig
+    scriptingConfig,
+    historyLogger,
+    secretVariables
   ) {
-    const bru = new Bru(envVariables, collectionVariables, processEnvVars, collectionPath);
-    const req = new BrunoRequest(request);
+    let htmlVisualizationString;
+    let setHtmlVisualizationString = (htmlString) => {
+      htmlVisualizationString = htmlString;
+    };
+    const bru = new Bru(
+      envVariables,
+      collectionVariables,
+      processEnvVars,
+      collectionPath,
+      historyLogger,
+      setHtmlVisualizationString,
+      secretVariables
+    );
+    const req = new BrunoRequest(request, historyLogger);
     const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);
     const moduleWhitelist = get(scriptingConfig, 'moduleWhitelist', []);
     const additionalContextRoots = get(scriptingConfig, 'additionalContextRoots', []);
@@ -116,7 +130,7 @@ class ScriptRuntime {
           'crypto-js': CryptoJS,
           ...whitelistedModules,
           fs: allowScriptFilesystemAccess ? fs : undefined,
-          'node-vault': NodeVault
+          'node-vault': NodeSecrets
         }
       }
     });
@@ -126,6 +140,7 @@ class ScriptRuntime {
       request,
       envVariables: cleanJson(envVariables),
       collectionVariables: cleanJson(collectionVariables),
+      htmlVisualizationString,
       nextRequestName: bru.nextRequest
     };
   }
@@ -139,10 +154,24 @@ class ScriptRuntime {
     collectionPath,
     onConsoleLog,
     processEnvVars,
-    scriptingConfig
+    scriptingConfig,
+    historyLogger,
+    secretVariables
   ) {
-    const bru = new Bru(envVariables, collectionVariables, processEnvVars, collectionPath);
-    const req = new BrunoRequest(request);
+    let htmlVisualizationString;
+    let setHtmlVisualizationString = (htmlString) => {
+      htmlVisualizationString = htmlString;
+    };
+    const bru = new Bru(
+      envVariables,
+      collectionVariables,
+      processEnvVars,
+      collectionPath,
+      historyLogger,
+      setHtmlVisualizationString,
+      secretVariables
+    );
+    const req = new BrunoRequest(request, historyLogger);
     const res = new BrunoResponse(response);
     const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);
     const moduleWhitelist = get(scriptingConfig, 'moduleWhitelist', []);
@@ -208,7 +237,7 @@ class ScriptRuntime {
           'crypto-js': CryptoJS,
           ...whitelistedModules,
           fs: allowScriptFilesystemAccess ? fs : undefined,
-          'node-vault': NodeVault
+          'node-vault': NodeSecrets
         }
       }
     });
@@ -220,6 +249,7 @@ class ScriptRuntime {
       response,
       envVariables: cleanJson(envVariables),
       collectionVariables: cleanJson(collectionVariables),
+      htmlVisualizationString,
       nextRequestName: bru.nextRequest
     };
   }

package/src/runtime/test-runtime.js

@@ -29,7 +29,7 @@ const nanoid = require('nanoid');
 const axios = require('axios');
 const fetch = require('node-fetch');
 const CryptoJS = require('crypto-js');
-const NodeVault = require('node-vault');
+const NodeSecrets = require('node-vault');
 
 class TestRuntime {
   constructor() {}
@@ -43,10 +43,20 @@ class TestRuntime {
     collectionPath,
     onConsoleLog,
     processEnvVars,
-    scriptingConfig
+    scriptingConfig,
+    historyLogger,
+    secretVariables
   ) {
-    const bru = new Bru(envVariables, collectionVariables, processEnvVars, collectionPath);
-    const req = new BrunoRequest(request);
+    const bru = new Bru(
+      envVariables,
+      collectionVariables,
+      processEnvVars,
+      collectionPath,
+      historyLogger,
+      undefined, // setHtmlVisualizationString
+      secretVariables
+    );
+    const req = new BrunoRequest(request, historyLogger);
     const res = new BrunoResponse(response);
     const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);
     const moduleWhitelist = get(scriptingConfig, 'moduleWhitelist', []);
@@ -134,7 +144,7 @@ class TestRuntime {
           'crypto-js': CryptoJS,
           ...whitelistedModules,
           fs: allowScriptFilesystemAccess ? fs : undefined,
-          'node-vault': NodeVault
+          'node-vault': NodeSecrets
         }
       }
     });
@@ -142,6 +152,15 @@ class TestRuntime {
     const asyncVM = vm.run(`module.exports = async () => { ${testsFile}}`, path.join(collectionPath, 'vm.js'));
     await asyncVM();
 
+    if (historyLogger) {
+      historyLogger({
+        uid: uuid.v4(),
+        type: 'network',
+        tests: cleanJson(__brunoTestResults.getResults()),
+        createdAt: new Date().toISOString()
+      });
+    }
+
     return {
       request,
       envVariables: cleanJson(envVariables),

package/src/runtime/vars-runtime.js

@@ -4,14 +4,31 @@ const BrunoRequest = require('../bruno-request');
 const { evaluateJsTemplateLiteral, evaluateJsExpression, createResponseParser } = require('../utils');
 
 class VarsRuntime {
-  runPreRequestVars(vars, request, envVariables, collectionVariables, collectionPath, processEnvVars) {
+  runPreRequestVars(
+    vars,
+    request,
+    envVariables,
+    collectionVariables,
+    collectionPath,
+    processEnvVars,
+    historyLogger,
+    secretVars = {}
+  ) {
     const enabledVars = _.filter(vars, (v) => v.enabled);
     if (!enabledVars.length) {
       return;
     }
 
-    const bru = new Bru(envVariables, collectionVariables, processEnvVars);
-    const req = new BrunoRequest(request);
+    const bru = new Bru(
+      envVariables,
+      collectionVariables,
+      processEnvVars,
+      null,
+      historyLogger,
+      undefined, // setHtmlVisualizationString
+      secretVars
+    );
+    const req = new BrunoRequest(request, historyLogger);
 
     const bruContext = {
       bru,
@@ -21,6 +38,7 @@ class VarsRuntime {
     const context = {
       ...envVariables,
       ...collectionVariables,
+      ...secretVars,
       ...bruContext
     };
 
@@ -34,14 +52,32 @@ class VarsRuntime {
     };
   }
 
-  runPostResponseVars(vars, request, response, envVariables, collectionVariables, collectionPath, processEnvVars) {
+  runPostResponseVars(
+    vars,
+    request,
+    response,
+    envVariables,
+    collectionVariables,
+    collectionPath,
+    processEnvVars,
+    historyLogger,
+    secretVars = {}
+  ) {
     const enabledVars = _.filter(vars, (v) => v.enabled);
     if (!enabledVars.length) {
       return;
     }
 
-    const bru = new Bru(envVariables, collectionVariables, processEnvVars);
-    const req = new BrunoRequest(request);
+    const bru = new Bru(
+      envVariables,
+      collectionVariables,
+      processEnvVars,
+      null,
+      historyLogger,
+      undefined, // setHtmlVisualizationString
+      secretVars
+    );
+    const req = new BrunoRequest(request, historyLogger);
     const res = createResponseParser(response);
 
     const bruContext = {
@@ -53,6 +89,7 @@ class VarsRuntime {
     const context = {
       ...envVariables,
       ...collectionVariables,
+      ...secretVars,
       ...bruContext
     };
 

package/src/utils.js

@@ -1,5 +1,6 @@
 const jsonQuery = require('json-query');
 const { get } = require('@usebruno/query');
+const { customAlphabet } = require('nanoid');
 
 const JS_KEYWORDS = `
   break case catch class const continue debugger default delete do
@@ -142,10 +143,20 @@ const cleanJson = (data) => {
   }
 };
 
+// a customized version of nanoid without using _ and -
+const uuid = () => {
+  // https://github.com/ai/nanoid/blob/main/url-alphabet/index.js
+  const urlAlphabet = 'useandom26T198340PX75pxJACKVERYMINDBUSHWOLFGQZbfghjklqvwyzrict';
+  const customNanoId = customAlphabet(urlAlphabet, 21);
+
+  return customNanoId();
+};
+
 module.exports = {
   evaluateJsExpression,
   evaluateJsTemplateLiteral,
   createResponseParser,
   internalExpressionCache,
-  cleanJson
+  cleanJson,
+  uuid
 };