artillery-plugin-slack 1.12.0 → 1.13.0

package/index.js

@@ -15,7 +15,6 @@ class SlackPlugin {
     }
 
     this.config = script.config.plugins.slack || {};
-    this.webhook = this.config.webhookUrl;
 
     if (!this.config.webhookUrl) {
       throw new SlackPluginError('Slack webhook URL not provided');
@@ -69,12 +68,14 @@ class SlackPlugin {
 
         // When ensure is enabled, whether the beforeExit or the checks event will be triggered first will depend on the order of plugins in the test script
         // Since we need data from both events, first event triggered will store the data and the second event will send the report
-        if (
-          this.exitCode !== undefined &&
-          this.exitCode !== null &&
-          this.report &&
-          !this.reportSent
-        ) {
+
+        // Make sure exitCode is properly set before potentially sending the report
+        if (this.exitCode === undefined || this.exitCode === null) {
+          this.exitCode = global.artillery.suggestedExitCode ?? 0;
+          debug('Setting initial exitCode in checks event:', this.exitCode);
+        }
+
+        if (this.report && !this.reportSent) {
           debug('Sending report from checks event');
           await this.sendReport(this.report, this.ensureChecks);
           this.reportSent = true;
@@ -85,7 +86,8 @@ class SlackPlugin {
     global.artillery.ext({
       ext: 'beforeExit',
       method: async (opts) => {
-        this.exitCode = global.artillery.suggestedExitCode || opts.exitCode;
+        this.exitCode =
+          global.artillery.suggestedExitCode ?? opts.exitCode ?? 0;
         if (this.ensureEnabled && !this.ensureChecks && !this.reportSent) {
           this.report = opts.report;
         } else {
@@ -111,9 +113,17 @@ class SlackPlugin {
 
   assembleSlackPayload(report, ensureChecks) {
     const errorList = this.getErrors(report);
-    const duration = report.lastMetricAt - report.firstMetricAt;
+    const duration =
+      report.lastMetricAt != null && report.firstMetricAt != null
+        ? report.lastMetricAt - report.firstMetricAt
+        : undefined;
+
+    // Ensure exitCode has a value before using it
+    const exitCode =
+      this.exitCode !== undefined && this.exitCode !== null ? this.exitCode : 0;
+
     const headerText =
-      this.exitCode === 0
+      exitCode === 0
         ? '🟢 Artillery test run finished'
         : '🔴 Artillery test run failed';
 
@@ -155,10 +165,14 @@ class SlackPlugin {
             type: 'mrkdwn',
             text: `*VUs*\n${report.counters['vusers.completed']} completed / ${report.counters['vusers.created']} created`
           },
-          {
-            type: 'mrkdwn',
-            text: `*Duration*\n${this.formatDuration(duration)}`
-          }
+          ...(duration != null
+            ? [
+                {
+                  type: 'mrkdwn',
+                  text: `*Duration*\n${formatDuration(duration)}`
+                }
+              ]
+            : [])
         ]
       }
     ];
@@ -248,31 +262,6 @@ class SlackPlugin {
     }
   }
 
-  formatDuration(durationInMs) {
-    const duration = moment.duration(durationInMs);
-    if (durationInMs < 1000) {
-      return `${durationInMs} miliseconds`;
-    }
-    const miliseconds = duration.get('millisecond');
-    const timeComponents = ['day', 'hour', 'minute', 'second'];
-    const formatedTimeComponents = timeComponents
-      .map((component) => {
-        let value = duration.get(component);
-        if (component === 'second' && miliseconds) {
-          value += 1;
-        }
-        return value
-          ? `${value} ${value === 1 ? component : component + 's'}`
-          : '';
-      })
-      .filter((component) => !!component);
-
-    const lastComponent = formatedTimeComponents.pop();
-    return formatedTimeComponents.length
-      ? formatedTimeComponents.join(', ') + ' and ' + lastComponent
-      : lastComponent;
-  }
-
   async cleanup(done) {
     debug('Cleaning up');
     done();
@@ -286,6 +275,38 @@ class SlackPluginError extends Error {
   }
 }
 
+// from artillery/lib/util.js
+function formatDuration(durationInMs) {
+  const duration = moment.duration(durationInMs);
+
+  const days = duration.days();
+  const hours = duration.hours();
+  const minutes = duration.minutes();
+  const seconds = duration.seconds();
+
+  const timeComponents = [];
+  if (days) {
+    timeComponents.push(`${days} ${maybePluralize(days, 'day')}`);
+  }
+
+  if (hours || days) {
+    timeComponents.push(`${hours} ${maybePluralize(hours, 'hour')}`);
+  }
+
+  if (minutes || hours || days) {
+    timeComponents.push(`${minutes} ${maybePluralize(minutes, 'minute')}`);
+  }
+
+  timeComponents.push(`${seconds} ${maybePluralize(seconds, 'second')}`);
+
+  return timeComponents.join(', ');
+}
+
+// from artillery/lib/util.js
+function maybePluralize(amount, singular, plural = `${singular}s`) {
+  return amount === 1 ? singular : plural;
+}
+
 module.exports = {
   Plugin: SlackPlugin,
   LEGACY_METRICS_FORMAT: false

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "artillery-plugin-slack",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "Send Artillery.io test notifications to Slack",
   "main": "index.js",
   "publishConfig": {