@artilleryio/int-core 2.21.0 → 2.22.0-4c4f409

package/index.js

@@ -1,4 +1,4 @@
-const EventEmitter = require('events');
+const EventEmitter = require('node:events');
 const chalk = require('chalk');
 
 // NOTE: This may be called more than once, and so should be non-destructive
@@ -10,7 +10,7 @@ async function updateGlobalObject(opts = {}) {
     typeof process.env.ARTILLERY_EXTENDED_HTTP_METRICS !== 'undefined';
 
   global.artillery.metrics = global.artillery.metrics || {};
-  global.artillery.metrics.event = async function (msg, opts) {
+  global.artillery.metrics.event = async (msg, opts) => {
     if (opts.level === 'error') {
       console.log(chalk.red(msg));
     } else {
@@ -34,7 +34,7 @@ async function updateGlobalObject(opts = {}) {
       this.extensionEvents.push(event);
     };
 
-  if (!global.artillery.hasOwnProperty('globalEvents')) {
+  if (!Object.hasOwn(global.artillery, 'globalEvents')) {
     Object.defineProperty(global.artillery, 'globalEvents', {
       value: new EventEmitter()
     });
@@ -42,7 +42,7 @@ async function updateGlobalObject(opts = {}) {
 
   global.artillery.__SSMS = require('./lib/ssms').SSMS;
 
-  if (!global.artillery.hasOwnProperty('suggestedExitCode')) {
+  if (!Object.hasOwn(global.artillery, 'suggestedExitCode')) {
     Object.defineProperty(global.artillery, 'suggestedExitCode', {
       get() {
         return global.artillery._exitCode;
@@ -61,19 +61,17 @@ async function updateGlobalObject(opts = {}) {
 
   global.artillery.logger =
     global.artillery.logger ||
-    function (opts) {
-      return {
-        log: (...args) => {
-          global.artillery.globalEvents.emit('log', opts, ...args);
-        }
-      };
-    };
+    ((opts) => ({
+      log: (...args) => {
+        global.artillery.globalEvents.emit('log', opts, ...args);
+      }
+    }));
 
   global.artillery.log =
     global.artillery.log ||
-    function (...args) {
+    ((...args) => {
       global.artillery.globalEvents.emit('log', {}, ...args);
-    };
+    });
 
   if (opts.version) {
     global.artillery.version = opts.version;

package/lib/engine_http.js

@@ -2,8 +2,6 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-'use strict';
-
 const async = require('async');
 const _ = require('lodash');
 const request = require('got');
@@ -15,16 +13,16 @@ const USER_AGENT = 'Artillery (https://artillery.io)';
 const engineUtil = require('@artilleryio/int-commons').engine_util;
 const ensurePropertyIsAList = engineUtil.ensurePropertyIsAList;
 const template = engineUtil.template;
-const qs = require('querystring');
+const qs = require('node:querystring');
 const filtrex = require('filtrex');
-const urlparse = require('url').parse;
+const urlparse = require('node:url').parse;
 const FormData = require('form-data');
 const HttpAgent = require('agentkeepalive');
 const { HttpsAgent } = HttpAgent;
 const { HttpProxyAgent, HttpsProxyAgent } = require('hpagent');
 const decompressResponse = require('decompress-response');
-const fs = require('fs');
-const path = require('path');
+const fs = require('node:fs');
+const path = require('node:path');
 
 const { promisify, callbackify } = require('node:util');
 
@@ -101,7 +99,7 @@ function HttpEngine(script) {
   // That's done when the VU is initialized.
 
   this.maxSockets = Infinity;
-  if (script.config.http && script.config.http.pool) {
+  if (script.config.http?.pool) {
     this.maxSockets = Number(script.config.http.pool);
   }
   const agentOpts = Object.assign(DEFAULT_AGENT_OPTIONS, {
@@ -129,8 +127,6 @@ function HttpEngine(script) {
 }
 
 HttpEngine.prototype.createScenario = function (scenarioSpec, ee) {
-  var self = this;
-
   ensurePropertyIsAList(scenarioSpec, 'beforeRequest');
   ensurePropertyIsAList(scenarioSpec, 'afterResponse');
   ensurePropertyIsAList(scenarioSpec, 'beforeScenario');
@@ -144,15 +140,11 @@ HttpEngine.prototype.createScenario = function (scenarioSpec, ee) {
   // entire scenario spec rather than just the userContext.
   const beforeScenarioFns = _.map(
     scenarioSpec.beforeScenario,
-    function (hookFunctionName) {
-      return { function: hookFunctionName };
-    }
+    (hookFunctionName) => ({ function: hookFunctionName })
   );
   const afterScenarioFns = _.map(
     scenarioSpec.afterScenario,
-    function (hookFunctionName) {
-      return { function: hookFunctionName };
-    }
+    (hookFunctionName) => ({ function: hookFunctionName })
   );
 
   const newFlow = beforeScenarioFns.concat(
@@ -161,26 +153,24 @@ HttpEngine.prototype.createScenario = function (scenarioSpec, ee) {
 
   scenarioSpec.flow = newFlow;
 
-  let tasks = _.map(scenarioSpec.flow, function (rs) {
-    return self.step(rs, ee, {
+  const tasks = _.map(scenarioSpec.flow, (rs) =>
+    this.step(rs, ee, {
       beforeRequest: scenarioSpec.beforeRequest,
       afterResponse: scenarioSpec.afterResponse,
       onError: scenarioSpec.onError
-    });
-  });
+    })
+  );
 
-  return self.compile(tasks, scenarioSpec, ee);
+  return this.compile(tasks, scenarioSpec, ee);
 };
 
 HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
   opts = opts || {};
-  let self = this;
-  let config = this.config;
+  const self = this;
+  const config = this.config;
 
   if (requestSpec.loop) {
-    let steps = _.map(requestSpec.loop, function (rs) {
-      return self.step(rs, ee, opts);
-    });
+    const steps = _.map(requestSpec.loop, (rs) => self.step(rs, ee, opts));
 
     return engineUtil.createLoopWithCount(requestSpec.count || -1, steps, {
       loopValue: requestSpec.loopValue || '$loopCount',
@@ -193,9 +183,7 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
   }
 
   if (requestSpec.parallel) {
-    let steps = _.map(requestSpec.parallel, function (rs) {
-      return self.step(rs, ee, opts);
-    });
+    const steps = _.map(requestSpec.parallel, (rs) => self.step(rs, ee, opts));
 
     return engineUtil.createParallel(steps, {
       limitValue: requestSpec.limit
@@ -210,17 +198,17 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
   }
 
   if (typeof requestSpec.log !== 'undefined') {
-    return function (context, callback) {
+    return (context, callback) => {
       console.log(template(requestSpec.log, context));
-      return process.nextTick(function () {
+      return process.nextTick(() => {
         callback(null, context);
       });
     };
   }
 
   if (requestSpec.function) {
-    return function (context, callback) {
-      let processFunc = self.config.processor[requestSpec.function];
+    return (context, callback) => {
+      const processFunc = self.config.processor[requestSpec.function];
       if (processFunc) {
         let f;
         if (processFunc.constructor.name === 'Function') {
@@ -228,23 +216,21 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
         } else {
           f = callbackify(processFunc);
         }
-        return f(context, ee, function (hookErr) {
-          return callback(hookErr, context);
-        });
+        return f(context, ee, (hookErr) => callback(hookErr, context));
       } else {
         debug(`Function "${requestSpec.function}" not defined`);
         debug('processor: %o', self.config.processor);
         ee.emit('error', `Undefined function "${requestSpec.function}"`);
-        return process.nextTick(function () {
+        return process.nextTick(() => {
           callback(null, context);
         });
       }
     };
   }
 
-  let f = function (context, callback) {
-    let method = _.keys(requestSpec)[0].toUpperCase();
-    let params = requestSpec[method.toLowerCase()];
+  const f = (context, callback) => {
+    const method = _.keys(requestSpec)[0].toUpperCase();
+    const params = requestSpec[method.toLowerCase()];
 
     const onErrorHandlers = opts.onError; // only scenario-lever onError handlers are supported
 
@@ -253,15 +239,15 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
     // is missing.
     // This will be obsoleted by better script validation.
     if (!params.url && !params.uri) {
-      let err = new Error('an URL must be specified');
+      const err = new Error('an URL must be specified');
       return callback(err, context);
     }
 
-    let tls = config.tls || {};
-    let timeout = config.timeout || _.get(config, 'http.timeout') || 10;
+    const tls = config.tls || {};
+    const timeout = config.timeout || _.get(config, 'http.timeout') || 10;
 
     if (!engineUtil.isProbableEnough(params)) {
-      return process.nextTick(function () {
+      return process.nextTick(() => {
         callback(null, context);
       });
     }
@@ -278,7 +264,7 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
         result = 1; // if the expression is incorrect, just proceed
       }
       if (!result) {
-        return process.nextTick(function () {
+        return process.nextTick(() => {
           callback(null, context);
         });
       }
@@ -301,7 +287,7 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
       requestParams.https = _.extend(requestParams.https, tls);
     }
 
-    let functionNames = _.concat(
+    const functionNames = _.concat(
       opts.beforeRequest || [],
       params.beforeRequest || []
     );
@@ -309,17 +295,15 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
     async.eachSeries(
       functionNames,
       function iteratee(functionName, next) {
-        let fn = template(functionName, context);
+        const fn = template(functionName, context);
         let processFunc = config.processor[fn];
         if (!processFunc) {
-          processFunc = function (r, c, e, cb) {
-            return cb(null);
-          };
+          processFunc = (_r, _c, _e, cb) => cb(null);
           console.log(`WARNING: custom function ${fn} could not be found`); // TODO: a 'warning' event
         }
 
         if (processFunc.constructor.name === 'Function') {
-          processFunc(requestParams, context, ee, function (err) {
+          processFunc(requestParams, context, ee, (err) => {
             if (err) {
               return next(err);
             }
@@ -384,7 +368,7 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
         if (params.form) {
           requestParams.form = _.reduce(
             requestParams.form,
-            function (acc, v, k) {
+            (acc, v, k) => {
               acc[k] = template(v, context);
               return acc;
             },
@@ -397,7 +381,7 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
           const f = new FormData();
           requestParams.body = _.reduce(
             requestParams.formData,
-            function (acc, v, k) {
+            (acc, v, k) => {
               let V = template(v, context);
               let options;
               if (V && _.isPlainObject(V)) {
@@ -432,7 +416,7 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
         }
 
         // Assign default headers then overwrite as needed
-        let defaultHeaders = lowcaseKeys(
+        const defaultHeaders = lowcaseKeys(
           config.http.defaults.headers ||
             config.defaults.headers || { 'user-agent': USER_AGENT }
         );
@@ -441,16 +425,13 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
           lowcaseKeys(params.headers),
           lowcaseKeys(requestParams.headers)
         );
-        const templatedHeaders = _.mapValues(
-          combinedHeaders,
-          function (v, k, obj) {
-            return template(v, context);
-          }
+        const templatedHeaders = _.mapValues(combinedHeaders, (v, _k, _obj) =>
+          template(v, context)
         );
         requestParams.headers = templatedHeaders;
 
         // We compute the url here so that the cookies are set properly afterwards
-        let url = maybePrependBase(
+        const url = maybePrependBase(
           template(requestParams.uri || requestParams.url, context),
           config
         );
@@ -473,9 +454,9 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
             context._defaultCookie,
             requestParams.cookie
           );
-          Object.keys(cookie).forEach(function (k) {
+          Object.keys(cookie).forEach((k) => {
             context._jar.setCookieSync(
-              k + '=' + template(cookie[k], context),
+              `${k}=${template(cookie[k], context)}`,
               requestParams.url
             );
           });
@@ -496,7 +477,7 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
         requestParams.throwHttpErrors = false;
 
         if (!requestParams.url || !requestParams.url.startsWith('http')) {
-          let err = new Error(`Invalid URL - ${requestParams.url}`);
+          const err = new Error(`Invalid URL - ${requestParams.url}`);
           return callback(err, context);
         }
 
@@ -577,9 +558,7 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
                   requestParams,
                   context,
                   ee,
-                  function (asyncErr) {
-                    return done(err, context);
-                  }
+                  (_asyncErr) => done(err, context)
                 );
               }
 
@@ -598,18 +577,20 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
                 }
 
                 // match and capture are strict by default:
-                haveFailedMatches = _.some(result.matches, function (v, k) {
-                  return !v.success && v.strict !== false;
-                });
+                haveFailedMatches = _.some(
+                  result.matches,
+                  (v, _k) => !v.success && v.strict !== false
+                );
 
-                haveFailedCaptures = _.some(result.captures, function (v, k) {
-                  return v.failed;
-                });
+                haveFailedCaptures = _.some(
+                  result.captures,
+                  (v, _k) => v.failed
+                );
 
                 if (haveFailedMatches || haveFailedCaptures) {
                   // TODO: Emit the details of each failed capture/match
                 } else {
-                  _.each(result.matches, function (v, k) {
+                  _.each(result.matches, (v, _k) => {
                     ee.emit('match', v.success, {
                       expected: v.expected,
                       got: v.got,
@@ -618,27 +599,25 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
                     });
                   });
 
-                  _.each(result.captures, function (v, k) {
+                  _.each(result.captures, (v, k) => {
                     _.set(context.vars, k, v.value);
                   });
                 }
               }
 
               // Now run afterResponse processors
-              let functionNames = _.concat(
+              const functionNames = _.concat(
                 opts.afterResponse || [],
                 params.afterResponse || []
               );
               async.eachSeries(
                 functionNames,
                 function iteratee(functionName, next) {
-                  let fn = template(functionName, context);
+                  const fn = template(functionName, context);
                   let processFunc = config.processor[fn];
                   if (!processFunc) {
                     // TODO: DRY - #223
-                    processFunc = function (r, res, c, e, cb) {
-                      return cb(null);
-                    };
+                    processFunc = (_r, _res, _c, _e, cb) => cb(null);
                     console.log(
                       `WARNING: custom function ${fn} could not be found`
                     ); // TODO: a 'warning' event
@@ -648,25 +627,19 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
                   res.body = body;
 
                   if (processFunc.constructor.name === 'Function') {
-                    processFunc(
-                      requestParams,
-                      res,
-                      context,
-                      ee,
-                      function (err) {
-                        if (err) {
-                          return next(err);
-                        }
-                        return next(null);
+                    processFunc(requestParams, res, context, ee, (err) => {
+                      if (err) {
+                        return next(err);
                       }
-                    );
+                      return next(null);
+                    });
                   } else {
                     processFunc(requestParams, res, context, ee)
                       .then(next)
                       .catch(next);
                   }
                 },
-                function (err) {
+                (err) => {
                   if (err) {
                     debug(err);
                     return done(err, context);
@@ -696,7 +669,7 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
         }
 
         if (!requestParams.url) {
-          let err = new Error('an URL must be specified');
+          const err = new Error('an URL must be specified');
 
           // Run onError hooks and end the scenario
           runOnErrorHooks(
@@ -706,9 +679,7 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
             requestParams,
             context,
             ee,
-            function (asyncErr) {
-              return callback(err, context);
-            }
+            (_asyncErr) => callback(err, context)
           );
         }
 
@@ -716,13 +687,13 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
 
         let totalDownloaded = 0;
         request(_.omit(requestParams, ['uuid']))
-          .on('request', function (req) {
+          .on('request', (req) => {
             ee.emit('trace:http:request', requestParams, requestParams.uuid);
 
             debugRequests('request start: %s', req.path);
             ee.emit('counter', 'http.requests', 1);
             ee.emit('rate', 'http.request_rate');
-            req.on('response', function (res) {
+            req.on('response', (res) => {
               res.on('end', () => {
                 ee.emit('counter', 'http.downloaded_bytes', totalDownloaded);
               });
@@ -740,7 +711,7 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
           .on('downloadProgress', (progress) => {
             totalDownloaded = progress.total;
           })
-          .on('error', function (err, body, res) {
+          .on('error', (err, _body, _res) => {
             ee.emit('trace:http:error', err, requestParams.uuid);
             if (err.name === 'HTTPError') {
               return;
@@ -755,9 +726,7 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
               requestParams,
               context,
               ee,
-              function (asyncErr) {
-                return callback(err, context);
-              }
+              (_asyncErr) => callback(err, context)
             );
           })
           .catch((gotErr) => {
@@ -770,9 +739,7 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
               requestParams,
               context,
               ee,
-              function (asyncErr) {
-                return callback(gotErr, context);
-              }
+              (_asyncErr) => callback(gotErr, context)
             );
           });
       }
@@ -796,12 +763,12 @@ HttpEngine.prototype._handleResponse = function (
     res = decompressResponse(res);
   }
 
-  let code = res.statusCode;
+  const code = res.statusCode;
   if (!context._enableCookieJar) {
     const rawCookies = res.headers['set-cookie'];
     if (rawCookies) {
       context._enableCookieJar = true;
-      rawCookies.forEach(function (cookieString) {
+      rawCookies.forEach((cookieString) => {
         try {
           context._jar.setCookieSync(cookieString, url);
         } catch (err) {
@@ -815,7 +782,7 @@ HttpEngine.prototype._handleResponse = function (
     }
   }
 
-  ee.emit('counter', 'http.codes.' + code, 1);
+  ee.emit('counter', `http.codes.${code}`, 1);
   ee.emit('counter', 'http.responses', 1);
   // ee.emit('rate', 'http.response_rate');
   ee.emit('histogram', 'http.response_time', res.timings.phases.firstByte);
@@ -957,8 +924,8 @@ HttpEngine.prototype.setInitialContext = function (initialContext) {
   return initialContext;
 };
 
-HttpEngine.prototype.compile = function compile(tasks, scenarioSpec, ee) {
-  let self = this;
+HttpEngine.prototype.compile = function compile(tasks, _scenarioSpec, ee) {
+  const self = this;
 
   return async function scenario(initialContext, callback) {
     initialContext = self.setInitialContext(initialContext);
@@ -989,7 +956,7 @@ function maybePrependBase(uri, config) {
  * Given a dictionary, return a dictionary with all keys lowercased.
  */
 function lowcaseKeys(h) {
-  return _.transform(h, function (result, v, k) {
+  return _.transform(h, (result, v, k) => {
     result[k.toLowerCase()] = v;
   });
 }
@@ -1006,8 +973,8 @@ function runOnErrorHooks(
   async.eachSeries(
     functionNames,
     function iteratee(functionName, next) {
-      let processFunc = functions[functionName];
-      processFunc(err, requestParams, context, ee, function (asyncErr) {
+      const processFunc = functions[functionName];
+      processFunc(err, requestParams, context, ee, (asyncErr) => {
         if (asyncErr) {
           return next(asyncErr);
         }