@usebruno/js 0.1.1 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usebruno/js",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "main": "src/index.js",
   "files": [
     "src",
@@ -9,9 +9,13 @@
   "peerDependencies": {
     "vm2": "^3.9.13"
   },
+  "scripts": {
+    "test": "jest --testPathIgnorePatterns test.js"
+  },
   "dependencies": {
-    "atob": "^2.1.2",
+    "@usebruno/query": "0.1.0",
     "ajv": "^8.12.0",
+    "atob": "^2.1.2",
     "btoa": "^1.2.1",
     "crypto-js": "^4.1.1",
     "json-query": "^2.2.2",

package/src/runtime/assert-runtime.js

@@ -1,17 +1,49 @@
 const _ = require('lodash');
-const chai = require('chai');  
+const chai = require('chai');
+const { nanoid } = require('nanoid');
 const Bru = require('../bru');
 const BrunoRequest = require('../bruno-request');
-const { evaluateJsExpression, createResponseParser } = require('../utils');
+const { evaluateJsTemplateLiteral, evaluateJsExpression, createResponseParser } = require('../utils');
 
 const { expect } = chai;
+chai.use(function (chai, utils) {
+  // Custom assertion for checking if a variable is JSON
+  chai.Assertion.addProperty('json', function () {
+    const obj = this._obj;
+    const isJson = typeof obj === 'object' && obj !== null && !Array.isArray(obj) && obj.constructor === Object;
+
+    this.assert(
+      isJson,
+      `expected ${utils.inspect(obj)} to be JSON`,
+      `expected ${utils.inspect(obj)} not to be JSON`
+    );
+  });
+});
+
+// Custom assertion for matching regex
+chai.use(function (chai, utils) {
+  chai.Assertion.addMethod('match', function (regex) {
+    const obj = this._obj;
+    let match = false;
+    if(obj === undefined) {
+      match = false;
+    } else {
+      match = regex.test(obj);
+    }
+
+    this.assert(
+      match,
+      `expected ${utils.inspect(obj)} to match ${regex}`,
+      `expected ${utils.inspect(obj)} not to match ${regex}`
+    );
+  });
+});
 
 /**
  * Assertion operators
  * 
  * eq          : equal to
  * neq         : not equal to
- * like        : like
  * gt          : greater than
  * gte         : greater than or equal to
  * lt          : less than
@@ -20,7 +52,6 @@ const { expect } = chai;
  * notIn       : not in
  * contains    : contains
  * notContains : not contains
- * count       : count
  * length      : length
  * matches     : matches
  * notMatches  : not matches
@@ -47,15 +78,26 @@ const parseAssertionOperator = (str = '') => {
   }
 
   const operators = [
-    'eq', 'neq', 'like', 'gt', 'gte', 'lt', 'lte', 'in', 'notIn',
-    'contains', 'notContains', 'count', 'length', 'matches', 'notMatches',
+    'eq', 'neq', 'gt', 'gte', 'lt', 'lte', 'in', 'notIn',
+    'contains', 'notContains', 'length', 'matches', 'notMatches',
     'startsWith', 'endsWith', 'between', 'isEmpty', 'isNull', 'isUndefined',
     'isDefined', 'isTruthy', 'isFalsy', 'isJson', 'isNumber', 'isString', 'isBoolean'
   ];
 
+  const unaryOperators = [
+    'isEmpty', 'isNull', 'isUndefined', 'isDefined', 'isTruthy', 'isFalsy', 'isJson', 'isNumber', 'isString', 'isBoolean'
+  ];
+
   const [operator, ...rest] = str.trim().split(' ');
   const value = rest.join(' ');
 
+  if(unaryOperators.includes(operator)) {
+    return {
+      operator,
+      value: ''
+    };
+  }
+
   if(operators.includes(operator)) {
     return {
       operator,
@@ -69,6 +111,45 @@ const parseAssertionOperator = (str = '') => {
   };
 };
 
+const isUnaryOperator = (operator) => {
+  const unaryOperators = [
+    'isEmpty', 'isNull', 'isUndefined', 'isDefined', 'isTruthy', 'isFalsy', 'isJson', 'isNumber', 'isString', 'isBoolean'
+  ];
+
+  return unaryOperators.includes(operator);
+};
+
+const evaluateRhsOperand = (rhsOperand, operator, context) => {
+  if(isUnaryOperator(operator)) {
+    return;
+  }
+
+  // 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));
+  }
+
+  if(operator === 'between') {
+    const [lhs, rhs] = rhsOperand.split(',').map((v) => evaluateJsTemplateLiteral(v.trim(), context));
+    return [lhs, rhs];
+  }
+
+  // gracefully allow both ^[a-Z] as well as /^[a-Z]/
+  if(operator === 'matches' || operator === 'notMatches') {
+    if(rhsOperand.startsWith('/') && rhsOperand.endsWith('/')) {
+      rhsOperand = rhsOperand.substring(1, rhsOperand.length - 1);
+    }
+
+    return rhsOperand;
+  }
+
+  return evaluateJsTemplateLiteral(rhsOperand, context);
+};
+
 class AssertRuntime {
   runAssertions(assertions, request, response, envVariables, collectionVariables, collectionPath) {
     const enabledAssertions = _.filter(assertions, (a) => a.enabled);
@@ -105,7 +186,7 @@ class AssertRuntime {
 
       try {
         const lhs = evaluateJsExpression(lhsExpr, context);
-        const rhs = evaluateJsExpression(rhsOperand, context);
+        const rhs = evaluateRhsOperand(rhsOperand, operator, context);
 
         switch(operator) {
           case 'eq':
@@ -114,9 +195,6 @@ class AssertRuntime {
           case 'neq':
             expect(lhs).to.not.equal(rhs);
             break;
-          case 'like':
-            expect(lhs).to.match(new RegExp(rhs));
-            break;
           case 'gt':
             expect(lhs).to.be.greaterThan(rhs);
             break;
@@ -141,9 +219,6 @@ class AssertRuntime {
           case 'notContains':
             expect(lhs).to.not.include(rhs);
             break;
-          case 'count':
-            expect(lhs).to.have.lengthOf(rhs);
-            break;
           case 'length':
             expect(lhs).to.have.lengthOf(rhs);
             break;
@@ -160,7 +235,7 @@ class AssertRuntime {
             expect(lhs).to.endWith(rhs);
             break;
           case 'between':
-            const [min, max] = value.split(' ');
+            const [min, max] = value.split(',');
             expect(lhs).to.be.within(min, max);
             break;
           case 'isEmpty':
@@ -199,6 +274,7 @@ class AssertRuntime {
         }
 
         assertionResults.push({
+          uid: nanoid(),
           lhsExpr,
           rhsExpr,
           rhsOperand,
@@ -208,6 +284,7 @@ class AssertRuntime {
       }
       catch (err) {
         assertionResults.push({
+          uid: nanoid(),
           lhsExpr,
           rhsExpr,
           rhsOperand,
@@ -222,4 +299,4 @@ class AssertRuntime {
   }
 }
 
-module.exports = AssertRuntime;
+module.exports = AssertRuntime;

package/src/runtime/script-runtime.js

@@ -17,8 +17,8 @@ class ScriptRuntime {
   constructor() {
   }
 
-  runRequestScript(script, request, environment, collectionVariables, collectionPath) {
-    const bru = new Bru(environment, collectionVariables);
+  runRequestScript(script, request, envVariables, collectionVariables, collectionPath) {
+    const bru = new Bru(envVariables, collectionVariables);
     const req = new BrunoRequest(request);
 
     const context = {
@@ -47,13 +47,13 @@ class ScriptRuntime {
 
     return {
       request,
-      environment,
+      envVariables,
       collectionVariables
     };
   }
 
-  runResponseScript(script, request, response, environment, collectionVariables, collectionPath) {
-    const bru = new Bru(environment, collectionVariables);
+  runResponseScript(script, request, response, envVariables, collectionVariables, collectionPath) {
+    const bru = new Bru(envVariables, collectionVariables);
     const req = new BrunoRequest(request);
     const res = new BrunoResponse(response);
 
@@ -84,7 +84,7 @@ class ScriptRuntime {
 
     return {
       response,
-      environment,
+      envVariables,
       collectionVariables
     };
   }

package/src/runtime/test-runtime.js

@@ -20,14 +20,23 @@ class TestRuntime {
   constructor() {
   }
 
-  runTests(testsFile, request, response, environment, collectionVariables, collectionPath) {
-    const bru = new Bru(environment, collectionVariables);
+  runTests(testsFile, request, response, envVariables, collectionVariables, collectionPath) {
+    const bru = new Bru(envVariables, collectionVariables);
     const req = new BrunoRequest(request);
     const res = new BrunoResponse(response);
 
     const __brunoTestResults = new TestResults();
     const test = Test(__brunoTestResults, chai);
 
+    if(!testsFile || !testsFile.length) {
+      return {
+        request,
+        envVariables,
+        collectionVariables,
+        results: __brunoTestResults.getResults()
+      };
+    }
+
     const context = {
       test,
       bru,
@@ -60,7 +69,7 @@ class TestRuntime {
 
     return {
       request,
-      environment,
+      envVariables,
       collectionVariables,
       results: __brunoTestResults.getResults()
     };

package/src/runtime/vars-runtime.js

@@ -1,7 +1,7 @@
 const _ = require('lodash');
 const Bru = require('../bru');
 const BrunoRequest = require('../bruno-request');
-const { evaluateJsExpression, createResponseParser } = require('../utils');
+const { evaluateJsTemplateLiteral, evaluateJsExpression, createResponseParser } = require('../utils');
 
 class VarsRuntime {
   runPreRequestVars(vars, request, envVariables, collectionVariables, collectionPath) {
@@ -25,9 +25,13 @@ class VarsRuntime {
     }
 
     _.each(enabledVars, (v) => {
-      const value = evaluateJsExpression(v.value, context);
+      const value = evaluateJsTemplateLiteral(v.value, context);
       bru.setVar(v.name, value);
     });
+
+    return {
+      collectionVariables
+    };
   }
 
   runPostResponseVars(vars, request, response, envVariables, collectionVariables, collectionPath) {
@@ -56,6 +60,11 @@ class VarsRuntime {
       const value = evaluateJsExpression(v.value, context);
       bru.setVar(v.name, value);
     });
+
+    return {
+      envVariables,
+      collectionVariables
+    };
   }
 }
 

package/src/utils.js

@@ -1,25 +1,126 @@
 const jsonQuery = require('json-query');
+const { get } = require("@usebruno/query");
+
+const JS_KEYWORDS = `
+  break case catch class const continue debugger default delete do
+  else export extends false finally for function if import in instanceof
+  new null return super switch this throw true try typeof var void while with
+  undefined let static yield arguments of
+`.split(/\s+/).filter(word => word.length > 0);
+
+/**
+ * Creates a function from a Javascript expression
+ * 
+ * When the function is called, the variables used in this expression are picked up from the context
+ * 
+ * ```js
+ * res.data.pets.map(pet => pet.name.toUpperCase())
+ * 
+ * function(context) {
+ *   const { res, pet } = context;
+ *   return res.data.pets.map(pet => pet.name.toUpperCase())
+ * }
+ * ```
+ */
+const compileJsExpression = (expr) => {
+  // get all dotted identifiers (foo, bar.baz, .baz)
+  const matches = expr.match(/([\w\.$]+)/g) ?? [];
+
+  // get valid js identifiers (foo, bar)
+  const vars = new Set(
+    matches
+      .filter(match => /^[a-zA-Z$_]/.test(match))   // starts with valid js identifier (foo.bar)
+      .map(match => match.split('.')[0])            // top level identifier (foo)
+      .filter(name => !JS_KEYWORDS.includes(name))  // exclude js keywords
+  );
+
+  // globals such as Math
+  const globals = [...vars].filter(name => name in globalThis);
+
+  const code = {
+    vars: [...vars].join(", "),
+    // pick global from context or globalThis
+    globals: globals
+      .map(name => ` ${name} = ${name} ?? globalThis.${name};`)
+      .join('')
+  };
+
+  const body = `let { ${code.vars} } = context; ${code.globals}; return ${expr}`;
+
+  return new Function("context", body);
+};
+
+const internalExpressionCache = new Map();
 
 const evaluateJsExpression = (expression, context) => {
-  const fn = new Function(...Object.keys(context), `return ${expression}`);
-  return fn(...Object.values(context));
+  let fn = internalExpressionCache.get(expression);
+  if (fn == null) {
+    internalExpressionCache.set(expression, fn = compileJsExpression(expression));
+  }
+  return fn(context);
 };
 
-const createResponseParser = (response = {}) => {
-  const res = (expr)  => {
-    const output = jsonQuery(expr, { data: response.data });
-    return output ? output.value : null;
+const evaluateJsTemplateLiteral = (templateLiteral, context) => {
+  if(!templateLiteral || !templateLiteral.length || typeof templateLiteral !== 'string') {
+    return templateLiteral;
+  }
+
+  templateLiteral = templateLiteral.trim();
+
+  if(templateLiteral === 'true') {
+    return true;
+  }
+
+  if(templateLiteral === 'false') {
+    return false;
   }
 
+  if(templateLiteral === 'null') {
+    return null;
+  }
+
+  if(templateLiteral === 'undefined') {
+    return undefined;
+  }
+
+  if(templateLiteral.startsWith('"') && templateLiteral.endsWith('"')) {
+    return templateLiteral.slice(1, -1);
+  }
+
+  if(templateLiteral.startsWith("'") && templateLiteral.endsWith("'")) {
+    return templateLiteral.slice(1, -1);
+  }
+
+  if(!isNaN(templateLiteral)) {
+    return Number(templateLiteral);
+  }
+
+  templateLiteral = "`" + templateLiteral + "`";
+
+  return evaluateJsExpression(templateLiteral, context);
+};
+
+const createResponseParser = (response = {}) => {
+  const res = (expr, ...fns) => {
+    return get(response.data, expr, ...fns);
+  };
+
   res.status = response.status;
   res.statusText = response.statusText;
   res.headers = response.headers;
   res.body = response.data;
 
+  res.jq = (expr) => {
+    const output = jsonQuery(expr, { data: response.data });
+    return output ? output.value : null;
+  };
+
   return res;
 };
 
 module.exports = {
   evaluateJsExpression,
-  createResponseParser
+  evaluateJsTemplateLiteral,
+  createResponseParser,
+  internalExpressionCache
 };