@artilleryio/int-core 2.1.0 → 2.2.0-18ad4ac

package/lib/engine_http.js

@@ -167,7 +167,7 @@ HttpEngine.prototype.createScenario = function (scenarioSpec, ee) {
     });
   });
 
-  return self.compile(tasks, scenarioSpec.flow, ee);
+  return self.compile(tasks, scenarioSpec, ee);
 };
 
 HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
@@ -712,6 +712,7 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
           })
           .catch((gotErr) => {
             // TODO: Handle the error properly with run hooks
+            debug(gotErr);
             return callback(gotErr, context);
           });
       }
@@ -868,6 +869,7 @@ HttpEngine.prototype.compile = function compile(tasks, scenarioSpec, ee) {
 
   return async function scenario(initialContext, callback) {
     initialContext = self.setInitialContext(initialContext);
+
     ee.emit('started');
     let context = initialContext;
     for (const task of tasks) {

package/lib/engine_socketio.js

@@ -52,7 +52,9 @@ function markEndTime(ee, _, startedAt) {
 }
 
 function isResponseRequired(spec) {
-  return spec.emit && spec.response && spec.response.channel;
+  return (
+    spec.emit && spec.response && (spec.response.channel || spec.response.on)
+  );
 }
 
 function isAcknowledgeRequired(spec) {
@@ -60,8 +62,20 @@ function isAcknowledgeRequired(spec) {
 }
 
 function processResponse(ee, data, response, context, callback) {
+  function isValid(data, response) {
+    if (!Array.isArray(response.data)) {
+      //`json` key is added at some point to the response.data object, to use with `captureOrMatch` function
+      //we should omit it when comparing the response to the data
+      const responseDataWithoutJson = _.isObject(response.data)
+        ? _.omit(response.data, 'json')
+        : response.data;
+      return deepEqual(data[0], responseDataWithoutJson);
+    }
+
+    return deepEqual(data, response.data);
+  }
   // Do we have supplied data to validate?
-  if (response.data && !deepEqual(data, response.data)) {
+  if (response.data && !isValid(data, response)) {
     debug('data is not valid:');
     debug(data);
     debug(response);
@@ -186,9 +200,12 @@ SocketIoEngine.prototype.step = function (requestSpec, ee) {
       }
 
       if (isAcknowledgeRequired(requestSpec)) {
-        const ackCallback = function () {
+        const ackCallback = function (...args) {
           const response = {
-            data: template(requestSpec.acknowledge.data, context),
+            data: template(
+              requestSpec.acknowledge.data || requestSpec.acknowledge.args,
+              context
+            ),
             capture: template(requestSpec.acknowledge.capture, context),
             match: template(requestSpec.acknowledge.match, context)
           };
@@ -198,8 +215,9 @@ SocketIoEngine.prototype.step = function (requestSpec, ee) {
               r.json = '$.0'; // Default to the first callback argument
             }
           });
+
           // Acknowledge data can take up multiple arguments of the emit callback
-          processResponse(ee, arguments, response, context, function (err) {
+          processResponse(ee, args, response, context, function (err) {
             if (!err) {
               markEndTime(ee, context, startedAt);
             }
@@ -225,8 +243,14 @@ SocketIoEngine.prototype.step = function (requestSpec, ee) {
 
     if (isResponseRequired(requestSpec)) {
       const response = {
-        channel: template(requestSpec.response.channel, context),
-        data: template(requestSpec.response.data, context),
+        channel: template(
+          requestSpec.response.channel || requestSpec.response.on,
+          context
+        ),
+        data: template(
+          requestSpec.response.data || requestSpec.response.args,
+          context
+        ),
         capture: template(requestSpec.response.capture, context),
         match: template(requestSpec.response.match, context)
       };
@@ -234,9 +258,9 @@ SocketIoEngine.prototype.step = function (requestSpec, ee) {
       // Listen for the socket.io response on the specified channel
       let done = false;
 
-      socketio.on(response.channel, function receive(data) {
+      socketio.on(response.channel, function receive(...args) {
         done = true;
-        processResponse(ee, data, response, context, function (err) {
+        processResponse(ee, args, response, context, function (err) {
           if (!err) {
             markEndTime(ee, context, startedAt);
           }

package/lib/runner.js

@@ -200,7 +200,13 @@ function run(script, ee, options, runState, contextVars) {
     if (runState.pendingScenarios >= spec.maxVusers) {
       metrics.counter('vusers.skipped', 1);
     } else {
-      scenarioContext = runScenario(script, metrics, runState, contextVars);
+      scenarioContext = runScenario(
+        script,
+        metrics,
+        runState,
+        contextVars,
+        options
+      );
     }
   });
   phaser.on('phaseStarted', function (spec) {
@@ -242,7 +248,7 @@ function run(script, ee, options, runState, contextVars) {
   phaser.run();
 }
 
-function runScenario(script, metrics, runState, contextVars) {
+function runScenario(script, metrics, runState, contextVars, options) {
   const start = process.hrtime();
 
   //
@@ -263,7 +269,7 @@ function runScenario(script, metrics, runState, contextVars) {
         const w = engineUtil.template(scenario.weight, {
           vars: variableValues
         });
-        scenario.weight = isNaN(parseInt(w)) ? 0 : parseInt(w);
+        scenario.weight = isNaN(parseInt(w)) ? 0 : parseInt(w); //eslint-disable-line radix
         debug(
           `scenario ${scenario.name} weight has been set to ${scenario.weight}`
         );
@@ -299,16 +305,45 @@ function runScenario(script, metrics, runState, contextVars) {
 
     runState.compiledScenarios = _.map(
       script.scenarios,
-      function (scenarioSpec) {
+      function (scenarioSpec, scenarioIndex) {
         const name = scenarioSpec.engine || script.config.engine || 'http';
         const engine = runState.engines.find((e) => e.__name === name);
+
+        if (typeof engine === 'undefined') {
+          const scenarioNameOrIndex = scenarioSpec.name || scenarioIndex;
+          throw new Error(
+            `Failed to run scenario "${scenarioNameOrIndex}": unknown engine "${name}". Did you forget to include it in "config.engines.${name}"?`
+          );
+        }
+
         return engine.createScenario(scenarioSpec, runState.scenarioEvents);
       }
     );
   }
 
+  //default to weighted picked scenario
   let i = runState.picker()[0];
 
+  if (options.scenarioName) {
+    let foundIndex;
+    const foundScenario = script.scenarios.filter((scenario, index) => {
+      foundIndex = index;
+      return new RegExp(options.scenarioName).test(scenario.name);
+    });
+
+    if (foundScenario?.length === 0) {
+      throw new Error(
+        `Scenario ${options.scenarioName} not found in script. Make sure your chosen scenario matches the one in your script exactly.`
+      );
+    } else if (foundScenario.length > 1) {
+      throw new Error(
+        `Multiple scenarios for ${options.scenarioName} found in script. Make sure you give unique names to your scenarios in your script.`
+      );
+    } else {
+      debug(`Scenario ${options.scenarioName} found in script. running it!`);
+      i = foundIndex;
+    }
+  }
   debug(
     'picking scenario %s (%s) weight = %s',
     i,
@@ -320,7 +355,9 @@ function runScenario(script, metrics, runState, contextVars) {
   metrics.counter('vusers.created', 1);
 
   const scenarioStartedAt = process.hrtime();
-  const scenarioContext = createContext(script, contextVars);
+  const scenarioContext = createContext(script, contextVars, {
+    scenario: script.scenarios[i]
+  });
 
   const finish = process.hrtime(start);
   const runScenarioDelta = finish[0] * 1e9 + finish[1];
@@ -383,7 +420,13 @@ function inlineVariables(script) {
 /**
  * Create initial context for a scenario.
  */
-function createContext(script, contextVars) {
+function createContext(script, contextVars, additionalProperties = {}) {
+  //allow for additional properties to be passed in, but not override vars and funcs
+  const additionalPropertiesWithoutOverride = _.omit(additionalProperties, [
+    'vars',
+    'funcs'
+  ]);
+
   const INITIAL_CONTEXT = {
     vars: Object.assign(
       {
@@ -398,7 +441,8 @@ function createContext(script, contextVars) {
       $randomNumber: $randomNumber,
       $randomString: $randomString,
       $template: (input) => engineUtil.template(input, { vars: result.vars })
-    }
+    },
+    ...additionalPropertiesWithoutOverride
   };
 
   let result = INITIAL_CONTEXT;
@@ -445,7 +489,10 @@ function handleScriptHook(hook, script, hookEvents, contextVars = {}) {
     const name = script[hook].engine || 'http';
     const engine = engines.find((e) => e.__name === name);
     const hookScenario = engine.createScenario(script[hook], ee);
-    const hookContext = createContext(script, contextVars);
+    const hookContext = createContext(script, contextVars, {
+      scenario: script[hook]
+    });
+
     hookScenario(hookContext, function (err, context) {
       if (err) {
         debug(err);

package/lib/ssms.js

@@ -626,6 +626,7 @@ function summarizeHistogram(h) {
     min: round(h.min, 1),
     max: round(h.max, 1),
     count: h.count,
+    mean: round(h.sum/h.count, 1),
     p50: round(h.getValueAtQuantile(0.5), 1),
     median: round(h.getValueAtQuantile(0.5), 1), // Here for compatibility
     p75: round(h.getValueAtQuantile(0.75), 1),

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@artilleryio/int-core",
-  "version": "2.1.0",
+  "version": "2.2.0-18ad4ac",
   "main": "./index.js",
+  "license": "MPL-2.0",
   "dependencies": {
-    "@artilleryio/int-commons": "latest",
+    "@artilleryio/int-commons": "2.0.2-18ad4ac",
     "@artilleryio/sketches-js": "^2.1.1",
     "agentkeepalive": "^4.1.0",
     "arrivals": "^2.1.2",