@artilleryio/int-core 2.27.0 → 2.28.0-670d2fa

package/lib/{engine_http.js → engine_http.ts}

@@ -2,32 +2,32 @@
  * 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/. */
 
-const async = require('async');
-const _ = require('lodash');
-const tough = require('tough-cookie');
-const debug = require('debug')('http');
-const debugRequests = require('debug')('http:request');
-const debugResponse = require('debug')('http:response');
+import crypto from 'node:crypto';
+import fs from 'node:fs';
+import path from 'node:path';
+import qs from 'node:querystring';
+import { parse as urlparse } from 'node:url';
+import { callbackify, promisify } from 'node:util';
+import { engine_util as engineUtil } from '@artilleryio/int-commons';
+import HttpAgent from 'agentkeepalive';
+import async from 'async';
+import createDebug from 'debug';
+import decompressResponse from 'decompress-response';
+import filtrex from 'filtrex';
+import FormData from 'form-data';
+import { HttpProxyAgent, HttpsProxyAgent } from 'hpagent';
+import _ from 'lodash';
+import * as tough from 'tough-cookie';
+
+const debug = createDebug('http');
+const debugRequests = createDebug('http:request');
+const debugResponse = createDebug('http:response');
 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('node:querystring');
-const filtrex = require('filtrex');
-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('node:fs');
-const path = require('node:path');
 
-const { promisify, callbackify } = require('node:util');
-
-const crypto = require('node:crypto');
-
-module.exports = HttpEngine;
+export default HttpEngine;
 
 const GOT_OPTION_NAMES = [
   'url',
@@ -140,7 +140,7 @@ function HttpEngine(script) {
   if (script.config.http?.pool) {
     this.maxSockets = Number(script.config.http.pool);
   }
-  const agentOpts = Object.assign(DEFAULT_AGENT_OPTIONS, {
+  const agentOpts: any = Object.assign(DEFAULT_AGENT_OPTIONS, {
     maxSockets: this.maxSockets,
     maxFreeSockets: this.maxSockets
   });
@@ -172,7 +172,7 @@ HttpEngine.prototype.init = async function () {
   this.request = (await import('got')).default;
 };
 
-HttpEngine.prototype._isDistributedTracingEnabled = function (config) {
+HttpEngine.prototype._isDistributedTracingEnabled = (config) => {
   const dtConfig = config.http?.distributedTracing;
   if (!dtConfig) {
     return false;
@@ -191,7 +191,7 @@ HttpEngine.prototype._isDistributedTracingEnabled = function (config) {
   return true;
 };
 
-HttpEngine.prototype._generateTraceparent = function (config) {
+HttpEngine.prototype._generateTraceparent = (config) => {
   // W3C Trace Context format: version-trace-id-parent-id-trace-flags
   const version = '00';
   
@@ -585,7 +585,7 @@ HttpEngine.prototype.step = function step(requestSpec, ee, opts) {
 
         function responseProcessor(isLast, res, body, done) {
           if (process.env.DEBUG) {
-            let requestInfo = {
+            let requestInfo: any = {
               url: requestParams.url,
               method: requestParams.method,
               headers: requestParams.headers
@@ -1018,7 +1018,7 @@ HttpEngine.prototype.setInitialContext = function (initialContext) {
     initialContext._httpsAgent = this._httpsAgent;
   } else {
     // Create agents just for this VU
-    const agentOpts = Object.assign(DEFAULT_AGENT_OPTIONS, {
+    const agentOpts: any = Object.assign(DEFAULT_AGENT_OPTIONS, {
       maxSockets: 1,
       maxFreeSockets: 1
     });
@@ -1078,9 +1078,9 @@ function maybePrependBase(uri, config) {
 /*
  * Given a dictionary, return a dictionary with all keys lowercased.
  */
-function lowcaseKeys(h) {
+function lowcaseKeys(h): any {
   return _.transform(h, (result, v, k) => {
-    result[k.toLowerCase()] = v;
+    result[String(k).toLowerCase()] = v;
   });
 }
 

package/lib/{engine_socketio.js → engine_socketio.ts}

@@ -2,19 +2,21 @@
  * 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/. */
 
-const async = require('async');
-const _ = require('lodash');
-
-const io = require('socket.io-client');
-const wildcardPatch = require('socketio-wildcard')(io.Manager);
-
-const deepEqual = require('fast-deep-equal');
-const debug = require('debug')('socketio');
-const engineUtil = require('@artilleryio/int-commons').engine_util;
-const EngineHttp = require('./engine_http');
+import { engine_util as engineUtil } from '@artilleryio/int-commons';
+import async from 'async';
+import createDebug from 'debug';
+import deepEqual from 'fast-deep-equal';
+import _ from 'lodash';
+import io from 'socket.io-client';
+import sioWildcard from 'socketio-wildcard';
+import EngineHttp from './engine_http.ts';
+
+const wildcardPatch = sioWildcard((io as any).Manager);
+
+const debug = createDebug('socketio');
 const template = engineUtil.template;
 
-module.exports = SocketIoEngine;
+export default SocketIoEngine;
 
 function SocketIoEngine(script) {
   this.config = script.config;

package/lib/{engine_ws.js → engine_ws.ts}

@@ -2,16 +2,22 @@
  * 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/. */
 
-const async = require('async');
-const _ = require('lodash');
-const WebSocket = require('ws');
-const HttpsProxyAgent = require('https-proxy-agent');
-const debug = require('debug')('ws');
-const url = require('node:url');
-const engineUtil = require('@artilleryio/int-commons').engine_util;
+import url from 'node:url';
+import { engine_util as engineUtil } from '@artilleryio/int-commons';
+import async from 'async';
+import createDebug from 'debug';
+import HttpsProxyAgent from 'https-proxy-agent';
+import _ from 'lodash';
+import WebSocket from 'ws';
+
+const debug = createDebug('ws');
 const template = engineUtil.template;
 
-module.exports = WSEngine;
+// Injectable dependencies - module namespaces are frozen, so tests
+// replace the WebSocket implementation through this mutable object
+export const _deps = { WebSocket };
+
+export default WSEngine;
 
 function WSEngine(script) {
   this.config = script.config;
@@ -306,7 +312,7 @@ WSEngine.prototype.compile = function (tasks, scenarioSpec, ee) {
 
     function one(context, cb) {
       const { wsArgs, ...contextWithoutWsArgs } = context;
-      const ws = new WebSocket(
+      const ws = new _deps.WebSocket(
         wsArgs.target,
         wsArgs.subprotocols,
         wsArgs.options
@@ -354,7 +360,7 @@ function getWsConfig(config) {
 
     debug('Set proxy: %s, options: %s', proxyUrl, proxyOptions);
 
-    const agent = new HttpsProxyAgent({
+    const agent = new (HttpsProxyAgent as any)({
       ...url.parse(proxyUrl),
       ...proxyOptions
     });

package/lib/{is-idle-phase.js → is-idle-phase.ts}

@@ -2,7 +2,7 @@
  * 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/. */
 
-function isIdlePhase(phase) {
+export default function isIdlePhase(phase) {
   return (
     (phase.arrivalRate === 0 && !phase.rampTo) ||
     phase.arrivalCount === 0 ||
@@ -10,5 +10,3 @@ function isIdlePhase(phase) {
     phase.pause > 0
   );
 }
-
-module.exports = isIdlePhase;

package/lib/{phases.js → phases.ts}

@@ -2,17 +2,19 @@
  * 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/. */
 
-const EventEmitter = require('eventemitter3');
-const async = require('async');
-const _ = require('lodash');
+import { randomUUID } from 'node:crypto';
+import arrivals from 'arrivals';
+import async from 'async';
+import createDebug from 'debug';
+import driftless from 'driftless';
+import { EventEmitter } from 'eventemitter3';
+import _ from 'lodash';
+import ms from 'ms';
+
+const debug = createDebug('phases');
 const isUndefined = _.isUndefined;
-const arrivals = require('arrivals');
-const debug = require('debug')('phases');
-const { randomUUID } = require('node:crypto');
-const driftless = require('driftless');
-const ms = require('ms');
 
-module.exports = phaser;
+export default phaser;
 
 async function sleep(ms) {
   return new Promise((resolve) => {
@@ -21,7 +23,7 @@ async function sleep(ms) {
 }
 
 function phaser(phaseSpecs) {
-  const ee = new EventEmitter();
+  const ee: any = new EventEmitter();
 
   const tasks = _.map(phaseSpecs, (spec, i) => {
     [

package/lib/{readers.js → readers.ts}

@@ -2,11 +2,9 @@
  * 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/. */
 
-const _ = require('lodash');
+import _ from 'lodash';
 
-module.exports = createReader;
-
-function createReader(order, spec) {
+export default function createReader(order, spec?) {
   if (order === 'sequence') {
     return createSequencedReader();
   } else if (

package/lib/{runner.js → runner.ts}

@@ -2,73 +2,87 @@
  * 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/. */
 
-const EventEmitter = require('eventemitter3');
-const path = require('node:path');
-const _ = require('lodash');
-const debug = require('debug')('runner');
-const debugPerf = require('debug')('perf');
-const uuidv4 = require('uuid').v4;
-const { SSMS } = require('./ssms');
-const createPhaser = require('./phases');
-const createReader = require('./readers');
-const engineUtil = require('@artilleryio/int-commons').engine_util;
-const wl = require('./weighted-pick');
-const { pathToFileURL } = require('node:url');
+import { createRequire } from 'node:module';
+import path from 'node:path';
+import { pathToFileURL } from 'node:url';
+import { engine_util as engineUtil } from '@artilleryio/int-commons';
+import createDebug from 'debug';
+import { EventEmitter } from 'eventemitter3';
+import _ from 'lodash';
+import { v4 as uuidv4 } from 'uuid';
+import HttpEngine from './engine_http.ts';
+import SocketIoEngine from './engine_socketio.ts';
+import WSEngine from './engine_ws.ts';
+import createPhaser from './phases.ts';
+import createReader from './readers.ts';
+import { SSMS } from './ssms.ts';
+import wl from './weighted-pick.ts';
+
+const debug = createDebug('runner');
+const debugPerf = createDebug('perf');
+
+const require = createRequire(import.meta.url);
 
 const Engines = {
-  http: require('./engine_http'),
-  ws: require('./engine_ws'),
-  socketio: require('./engine_socketio')
+  http: HttpEngine,
+  ws: WSEngine,
+  socketio: SocketIoEngine
 };
 
-module.exports = {
-  runner: runner,
-  contextFuncs: {
-    $randomString,
-    $randomNumber
-  },
-  runnerFuncs: {
-    handleScriptHook,
-    prepareScript,
-    loadProcessor
-  }
+const contextFuncs = {
+  $randomString,
+  $randomNumber
+};
+
+const runnerFuncs = {
+  handleScriptHook,
+  prepareScript,
+  loadProcessor
 };
 
-function loadEngines(
+export { runner, contextFuncs, runnerFuncs };
+
+async function loadEngines(
   script,
   ee,
   warnings = {
     engines: {}
   }
 ) {
-  const loadedEngines = _.map(
-    Object.assign({}, Engines, script.config.engines),
-    function loadEngine(_engineConfig, engineName) {
-      const moduleName = `artillery-engine-${engineName}`;
-      try {
-        let Engine;
-        if (typeof Engines[engineName] !== 'undefined') {
-          Engine = Engines[engineName];
-        } else {
-          Engine = require(moduleName);
-        }
-        const engine = new Engine(script, ee, engineUtil);
-        engine.__name = engineName;
-        return engine;
-      } catch (err) {
-        console.log(
-          'WARNING: engine %s specified but module %s could not be loaded',
-          engineName,
-          moduleName
-        );
-        console.log(err.stack);
-        warnings.engines[engineName] = {
-          message: 'Could not load',
-          error: err
-        };
+  const engineSpecs = Object.assign({}, Engines, script.config.engines);
+  const loadedEngines = [];
+
+  for (const engineName of Object.keys(engineSpecs)) {
+    const moduleName = `artillery-engine-${engineName}`;
+    try {
+      let Engine;
+      if (typeof Engines[engineName] !== 'undefined') {
+        Engine = Engines[engineName];
+      } else {
+        // Resolve with CJS semantics (bare specifiers, directories via
+        // package.json "main"), load with import() - handles both CJS
+        // and ESM engines, including ESM with top-level await
+        const enginePath = require.resolve(moduleName);
+        const ns = await import(pathToFileURL(enginePath).href);
+        Engine = ns.default ?? ns;
       }
+      const engine = new Engine(script, ee, engineUtil);
+      engine.__name = engineName;
+      loadedEngines.push(engine);
+    } catch (err) {
+      console.log(
+        'WARNING: engine %s specified but module %s could not be loaded',
+        engineName,
+        moduleName
+      );
+      console.log(err.stack);
+      warnings.engines[engineName] = {
+        message: 'Could not load',
+        error: err
+      };
+      loadedEngines.push(undefined);
     }
-  );
+  }
 
   return { loadedEngines, warnings };
 }
@@ -81,18 +95,19 @@ async function loadProcessor(script, options) {
       script.config.processor
     );
 
-    if (processorPath.endsWith('.mjs')) {
-      const fileUrl = pathToFileURL(processorPath);
-      const exports = await import(fileUrl.href);
-      script.config.processor = Object.assign(
-        {},
-        script.config.processor,
-        exports
-      );
-    } else {
-      // CJS (possibly transplied from TS)
-      script.config.processor = require(processorPath);
-    }
+    // Resolve with CJS semantics first (handles extensionless paths and
+    // directories); fall back to the path as-is
+    let resolvedPath = processorPath;
+    try {
+      resolvedPath = require.resolve(processorPath);
+    } catch (_err) {}
+
+    // import() loads both CJS and ESM (including ESM with top-level
+    // await). Normalize the result into a plain mutable object: module
+    // namespace objects are frozen, and engines/plugins may attach
+    // properties to the processor object later (e.g. $rewriteMetricName)
+    const ns = await import(pathToFileURL(resolvedPath).href);
+    script.config.processor = Object.assign({}, ns.default ?? {}, ns);
   }
 
   return script;
@@ -152,12 +167,12 @@ async function runner(script, payload, options, callback) {
 
   const runnableScript = prepareScript(script, payload);
 
-  const ee = new EventEmitter();
+  const ee: any = new EventEmitter();
 
   //
   // load engines:
   //
-  const { loadedEngines: runnerEngines } = loadEngines(
+  const { loadedEngines: runnerEngines } = await loadEngines(
     runnableScript,
     ee,
     warnings
@@ -456,7 +471,7 @@ function createContext(script, contextVars, additionalProperties = {}) {
     'funcs'
   ]);
 
-  const INITIAL_CONTEXT = {
+  const INITIAL_CONTEXT: any = {
     vars: Object.assign(
       {
         target: script.config.target,
@@ -521,7 +536,7 @@ async function handleScriptHook(hook, script, hookEvents, contextVars = {}) {
     return {};
   }
 
-  const { loadedEngines: engines } = loadEngines(script, hookEvents);
+  const { loadedEngines: engines } = await loadEngines(script, hookEvents);
 
   for (const e of engines) {
     if (

package/lib/{ssms.js → ssms.ts}

@@ -6,16 +6,20 @@
 
 // Use our own fork of DDSketch until this PR is merged into main:
 // https://github.com/DataDog/sketches-js/pull/13
-const { DDSketch } = require('@artilleryio/sketches-js');
-// const {DDSketch} = require('@datadog/sketches-js');
-const EventEmitter = require('node:events');
-const { setDriftlessInterval, clearDriftless } = require('driftless');
-const debug = require('debug')('ssms');
+import { EventEmitter } from 'node:events';
+import { DDSketch } from '@artilleryio/sketches-js';
+import createDebug from 'debug';
+import { clearDriftless, setDriftlessInterval } from 'driftless';
+
+const debug = createDebug('ssms');
 
 const MAX_METRIC_NAME_LENGTH = 1024;
 
 class SSMS extends EventEmitter {
-  constructor(_options) {
+  // Untyped JS class - properties assigned dynamically
+  [key: string]: any;
+
+  constructor(_options?) {
     super();
 
     this.opts = _options || {};
@@ -270,7 +274,7 @@ class SSMS extends EventEmitter {
   // Aggregate at lower resolution, i.e. combine three distinct periods of 10s into one of 30s
   // Note: does not check that periods are contiguous, everything is simply merged together
   static pack(periods) {
-    const result = {
+    const result: any = {
       counters: {},
       histograms: {},
       rates: {}
@@ -356,7 +360,7 @@ class SSMS extends EventEmitter {
   static deserializeMetrics(pd) {
     const object = parse(pd);
     for (const [name, buf] of Object.entries(object.histograms)) {
-      const h = DDSketch.fromProto(buf);
+      const h = DDSketch.fromProto(buf as any);
       object.histograms[name] = h;
     }
 
@@ -378,7 +382,7 @@ class SSMS extends EventEmitter {
     this.incr(name.slice(0, MAX_METRIC_NAME_LENGTH), value);
   }
 
-  incr(name, value, t) {
+  incr(name, value, t?) {
     this._counters.push(
       t || Date.now(),
       name.slice(0, MAX_METRIC_NAME_LENGTH),
@@ -391,7 +395,7 @@ class SSMS extends EventEmitter {
     this.histogram(name.slice(0, MAX_METRIC_NAME_LENGTH), value);
   }
 
-  histogram(name, value, t) {
+  histogram(name, value, t?) {
     this._histograms.push(
       t || Date.now(),
       name.slice(0, MAX_METRIC_NAME_LENGTH),
@@ -399,12 +403,12 @@ class SSMS extends EventEmitter {
     );
   }
 
-  rate(name, t) {
+  rate(name, t?) {
     this._rates.push(t || Date.now(), name.slice(0, MAX_METRIC_NAME_LENGTH));
   }
 
   getMetrics(period) {
-    const result = {};
+    const result: any = {};
 
     const counters = this._aggregatedCounters[period];
     const histograms = this._aggregatedHistograms[period];
@@ -644,7 +648,7 @@ function summarizeHistogram(h) {
 }
 
 /// ///////////////////////////////////////////
-function stringify(value, space) {
+function stringify(value, space?) {
   return JSON.stringify(value, replacer, space);
 }
 
@@ -715,8 +719,4 @@ function max(values) {
   return m === Number.NEGATIVE_INFINITY ? undefined : m;
 }
 
-module.exports = {
-  SSMS,
-  summarizeHistogram,
-  normalizeTs
-};
+export { SSMS, summarizeHistogram, normalizeTs };

package/{index.js → lib/update-global-object.ts}

@@ -1,8 +1,10 @@
-const EventEmitter = require('node:events');
-const chalk = require('chalk');
+import { EventEmitter } from 'node:events';
+import { engine_util } from '@artilleryio/int-commons';
+import chalk from 'chalk';
+import { SSMS } from './ssms.ts';
 
 // NOTE: This may be called more than once, and so should be non-destructive
-async function updateGlobalObject(opts = {}) {
+async function updateGlobalObject(opts: any = {}) {
   global.artillery = global.artillery || {};
 
   global.artillery.runtimeOptions = global.artillery.runtimeOptions || {};
@@ -12,7 +14,7 @@ async function updateGlobalObject(opts = {}) {
   global.artillery.metrics = global.artillery.metrics || {};
   global.artillery.metrics.event = async (msg, opts) => {
     if (opts.level === 'error') {
-      console.log(chalk.red(msg));
+      console.log((chalk as any).red(msg));
     } else {
       console.log(msg);
     }
@@ -20,8 +22,7 @@ async function updateGlobalObject(opts = {}) {
 
   global.artillery.util = global.artillery.util || {};
 
-  global.artillery.util.template =
-    require('@artilleryio/int-commons').engine_util.template;
+  global.artillery.util.template = engine_util.template;
 
   global.artillery.plugins = global.artillery.plugins || [];
 
@@ -40,7 +41,7 @@ async function updateGlobalObject(opts = {}) {
     });
   }
 
-  global.artillery.__SSMS = require('./lib/ssms').SSMS;
+  global.artillery.__SSMS = SSMS;
 
   if (!Object.hasOwn(global.artillery, 'suggestedExitCode')) {
     Object.defineProperty(global.artillery, 'suggestedExitCode', {
@@ -87,10 +88,4 @@ async function main() {
 
 main();
 
-module.exports = {
-  runner: require('./lib/runner'),
-  engine_http: require('./lib/engine_http'),
-  ssms: require('./lib/ssms'),
-  isIdlePhase: require('./lib/is-idle-phase'),
-  updateGlobalObject
-};
+export { updateGlobalObject };

package/lib/{weighted-pick.js → weighted-pick.ts}

@@ -2,9 +2,10 @@
  * 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/. */
 
-const l = require('lodash');
+import { pathToFileURL } from 'node:url';
+import l from 'lodash';
 
-module.exports = create;
+export default create;
 
 // naive implementation of selection with replacement
 function create(list) {
@@ -75,6 +76,9 @@ function bench() {
   });
 }
 
-if (require.main === module) {
+if (
+  process.argv[1] &&
+  import.meta.url === pathToFileURL(process.argv[1]).href
+) {
   bench();
 }