artillery-plugin-apdex 1.23.0 → 1.24.0-670d2fa

package/.turbo/turbo-build.log

@@ -0,0 +1,4 @@
+
+> artillery-plugin-apdex@1.24.0-670d2fa build
+> tsc -p tsconfig.build.json
+

package/dist/index.js

@@ -0,0 +1,93 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * 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/. */
+import createDebug from 'debug';
+const _debug = createDebug('plugin:apdex');
+const METRICS = {
+    satisfied: 'apdex.satisfied',
+    tolerated: 'apdex.tolerated',
+    frustrated: 'apdex.frustrated'
+};
+class ApdexPlugin {
+    constructor(script, _events) {
+        this.script = script;
+        if (global.artillery &&
+            Number(global.artillery.version.slice(0, 1)) > 1 &&
+            typeof process.env.LOCAL_WORKER_ID !== 'undefined') {
+            const t = script.config.apdex?.threshold ??
+                script.config.plugins?.apdex?.threshold ??
+                500;
+            if (!script.config.processor) {
+                script.config.processor = {};
+            }
+            // In the main thread config.processor may still be an unresolved
+            // path (a string). Attaching functions to it was a silent no-op
+            // under sloppy mode; ES modules are strict, so guard explicitly.
+            // Workers load the processor into an object before plugins run.
+            const canAttach = typeof script.config.processor === 'object';
+            script.scenarios.forEach((scenario) => {
+                scenario.afterResponse = [].concat(scenario.afterResponse || []);
+                scenario.afterResponse.push('apdexAfterResponse');
+            });
+            function apdexAfterResponse(_req, res, _userContext, events, done) {
+                const total = res.timings.phases.total;
+                events.emit('counter', METRICS.satisfied, 0);
+                events.emit('counter', METRICS.tolerated, 0);
+                events.emit('counter', METRICS.frustrated, 0);
+                if (total <= t) {
+                    events.emit('counter', METRICS.satisfied, 1);
+                }
+                else if (total <= 4 * t) {
+                    events.emit('counter', METRICS.tolerated, 1);
+                }
+                else {
+                    events.emit('counter', METRICS.frustrated, 1);
+                }
+                return done();
+            }
+            if (canAttach) {
+                script.config.processor.apdexAfterResponse = apdexAfterResponse;
+            }
+            return;
+        }
+        global.artillery.ext({
+            ext: 'beforeExit',
+            method: async (testInfo) => {
+                const hasApdexConfig = this.script?.config?.apdex !== undefined ||
+                    this.script?.config?.plugins?.apdex !== undefined;
+                if (!hasApdexConfig) {
+                    return;
+                }
+                const s = testInfo.report.counters[METRICS.satisfied] || 0;
+                const t = testInfo.report.counters[METRICS.tolerated] || 0;
+                const f = testInfo.report.counters[METRICS.frustrated] || 0;
+                const total = s + t + f;
+                if (total > 0) {
+                    const apdexScore = (s + t / 2) / total;
+                    let ranking = '';
+                    if (apdexScore >= 0.94) {
+                        ranking = 'excellent';
+                    }
+                    else if (apdexScore >= 0.85) {
+                        ranking = 'good';
+                    }
+                    else if (apdexScore >= 0.7) {
+                        ranking = 'fair';
+                    }
+                    else if (apdexScore >= 0.49) {
+                        ranking = 'poor';
+                    }
+                    else {
+                        ranking = 'unacceptable';
+                    }
+                    global.artillery.apdexPlugin = {
+                        apdex: apdexScore,
+                        ranking
+                    };
+                    console.log(`\nApdex score: ${apdexScore} (${ranking})`);
+                }
+            }
+        });
+    }
+}
+export { ApdexPlugin as Plugin };

package/{index.js → index.ts}

@@ -2,7 +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 _debug = require('debug')('plugin:apdex');
+import createDebug from 'debug';
+
+const _debug = createDebug('plugin:apdex');
 
 const METRICS = {
   satisfied: 'apdex.satisfied',
@@ -11,6 +13,9 @@ const METRICS = {
 };
 
 class ApdexPlugin {
+  // Untyped JS class - properties assigned dynamically
+  [key: string]: any;
+
   constructor(script, _events) {
     this.script = script;
 
@@ -27,6 +32,11 @@ class ApdexPlugin {
       if (!script.config.processor) {
         script.config.processor = {};
       }
+      // In the main thread config.processor may still be an unresolved
+      // path (a string). Attaching functions to it was a silent no-op
+      // under sloppy mode; ES modules are strict, so guard explicitly.
+      // Workers load the processor into an object before plugins run.
+      const canAttach = typeof script.config.processor === 'object';
 
       script.scenarios.forEach((scenario) => {
         scenario.afterResponse = [].concat(scenario.afterResponse || []);
@@ -50,7 +60,9 @@ class ApdexPlugin {
         return done();
       }
 
-      script.config.processor.apdexAfterResponse = apdexAfterResponse;
+      if (canAttach) {
+        script.config.processor.apdexAfterResponse = apdexAfterResponse;
+      }
 
       return;
     }
@@ -97,6 +109,4 @@ class ApdexPlugin {
   }
 }
 
-module.exports = {
-  Plugin: ApdexPlugin
-};
+export { ApdexPlugin as Plugin };

package/package.json

@@ -1,23 +1,15 @@
 {
   "name": "artillery-plugin-apdex",
-  "version": "1.23.0",
+  "version": "1.24.0-670d2fa",
   "description": "Calculate and report Apdex scores",
-  "main": "index.js",
+  "main": "./dist/index.js",
   "scripts": {
-    "test": "tap ./test/*.spec.js --timeout 300"
-  },
-  "tap": {
-    "disable-coverage": true,
-    "allow-empty-coverage": true,
-    "color": true,
-    "test-env": [
-      "ARTILLERY_TELEMETRY_DEFAULTS={\"source\":\"test-suite\"}"
-    ]
+    "test": "node --test --test-timeout=300000 --require ./test/setup-env.cjs \"test/*.spec.js\"",
+    "build": "tsc -p tsconfig.build.json"
   },
   "keywords": [],
   "author": "",
   "license": "MPL-2.0",
-  "devDependencies": {
-    "tap": "^19.2.5"
-  }
+  "devDependencies": {},
+  "type": "module"
 }

package/tsconfig.build.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.build-base.json",
+  "compilerOptions": {
+    "rootDir": ".",
+    "outDir": "./dist"
+  },
+  "include": ["./**/*.ts", "../../globals.d.ts"],
+  "exclude": ["node_modules", "dist", "test", "examples", "**/*.d.ts"]
+}