artillery-plugin-slack 1.11.0 → 1.12.0

package/index.js

@@ -52,20 +52,29 @@ class SlackPlugin {
                 this.exitCode = 1;
               }
               this.ensureChecks.failed += 1;
-              this.ensureChecks.checkList.push(
-                `:x: \`${check.original}\`${check.strict ? '' : ' (optional) '}`
-              );
+              this.ensureChecks.checkList.push({
+                text: check.original,
+                passed: false,
+                optional: !check.strict
+              });
             } else {
               this.ensureChecks.passed += 1;
-              this.ensureChecks.checkList.push(
-                `:white_check_mark: \`${check.original}\``
-              );
+              this.ensureChecks.checkList.push({
+                text: check.original,
+                passed: true,
+                optional: false
+              });
             }
           });
 
         // 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.report && !this.reportSent) {
+        if (
+          this.exitCode !== undefined &&
+          this.exitCode !== null &&
+          this.report &&
+          !this.reportSent
+        ) {
           debug('Sending report from checks event');
           await this.sendReport(this.report, this.ensureChecks);
           this.reportSent = true;
@@ -92,10 +101,10 @@ class SlackPlugin {
 
   getErrors(report) {
     const errorList = [];
-    for (const [key, value] of Object.entries(report.counters).filter(
-      ([key, value]) => key.startsWith('errors.')
+    for (const [key, value] of Object.entries(report.counters).filter(([key]) =>
+      key.startsWith('errors.')
     )) {
-      errorList.push(` ◌ ${key.replace('errors.', '')}:  ${value}`);
+      errorList.push(`❌ ${key.replace('errors.', '')} (${value})`);
     }
     return errorList;
   }
@@ -103,98 +112,122 @@ class SlackPlugin {
   assembleSlackPayload(report, ensureChecks) {
     const errorList = this.getErrors(report);
     const duration = report.lastMetricAt - report.firstMetricAt;
-    const introText =
+    const headerText =
       this.exitCode === 0
         ? '🟢 Artillery test run finished'
         : '🔴 Artillery test run failed';
 
     const payloadTemplate = {
-      text: introText,
+      text: headerText,
       blocks: [
         {
-          type: 'rich_text',
-          elements: [
-            {
-              type: 'rich_text_section',
-              elements: [
-                {
-                  type: 'text',
-                  text: introText,
-                  style: {
-                    bold: true
-                  }
-                }
-              ]
-            }
-          ]
-        },
-        {
-          type: 'section',
+          type: 'header',
           text: {
-            type: 'mrkdwn',
-            text: `Duration: ${this.formatDuration(duration)}`
+            type: 'plain_text',
+            text: headerText,
+            emoji: true
           }
         }
       ]
     };
 
-    if (this.cloudEnabled) {
-      payloadTemplate.blocks.push({
-        type: 'section',
-        text: {
-          type: 'mrkdwn',
-          text: `<${this.cloudTestRunUrl}>`
-        }
-      });
+    let errorsText = '*Errors*\nNone';
+
+    if (errorList.length > 0) {
+      // Only show first 10 errors to avoid Slack message length limit
+      const maxErrors = 10;
+      const trimmedList = errorList.slice(0, maxErrors);
+
+      if (errorList.length > maxErrors) {
+        trimmedList.push(`➕ ${errorList.length - maxErrors} more…`);
+      }
+
+      errorsText = `*Errors (${errorList.length})*\n\`\`\`\n${trimmedList.join(
+        '\n'
+      )}\n\`\`\``;
     }
 
     const metricBlocks = [
-      {
-        type: 'divider'
-      },
       {
         type: 'section',
         fields: [
           {
             type: 'mrkdwn',
-            text: `*${report.counters['vusers.completed']} / ${report.counters['vusers.created']}*\nVUs completed / created`
+            text: `*VUs*\n${report.counters['vusers.completed']} completed / ${report.counters['vusers.created']} created`
           },
           {
             type: 'mrkdwn',
-            text: `*Errors*\n${
-              errorList.length !== 0 ? errorList.join('\n') : '0'
-            }`
+            text: `*Duration*\n${this.formatDuration(duration)}`
           }
         ]
-      },
-      {
-        type: 'divider'
       }
     ];
 
+    let checksText = '*Checks*\nNone defined';
+
     if (this.ensureChecks) {
-      metricBlocks.push(
-        ...[
-          {
-            type: 'section',
-            fields: [
-              {
-                type: 'mrkdwn',
-                text: `*Checks (${ensureChecks.passed} / ${
-                  ensureChecks.total
-                })*\n${this.ensureChecks.checkList.join('\n')}`
-              }
-            ]
-          },
+      // Show summary if more than 10 checks to avoid Slack message length limit
+      if (this.ensureChecks.total > 10) {
+        let summaryText = '';
+
+        if (ensureChecks.passed > 0) {
+          summaryText += `🟢 ${ensureChecks.passed} checks passed\n`;
+        }
+
+        if (ensureChecks.failed > 0) {
+          summaryText += `🔴 ${ensureChecks.failed} checks failed`;
+        }
+
+        summaryText = summaryText.trim();
+        checksText = `*Checks (${ensureChecks.passed}/${ensureChecks.total})*\n\`\`\`\n${summaryText}\n\`\`\``;
+      } else {
+        const formattedChecks = this.ensureChecks.checkList.map(
+          (check) =>
+            `${check.passed ? '🟢' : '🔴'} ${check.text}${
+              check.optional ? ' (optional)' : ''
+            }`
+        );
+
+        checksText = `*Checks (${ensureChecks.passed} / ${
+          ensureChecks.total
+        })*\n\`\`\`\n${formattedChecks.join('\n')}\n\`\`\``;
+      }
+    }
+
+    metricBlocks.push({
+      type: 'section',
+      fields: [
+        {
+          type: 'mrkdwn',
+          text: checksText
+        },
+        {
+          type: 'mrkdwn',
+          text: errorsText
+        }
+      ]
+    });
+
+    payloadTemplate.blocks = payloadTemplate.blocks.concat(metricBlocks);
+
+    if (this.cloudEnabled) {
+      payloadTemplate.blocks.push({
+        type: 'actions',
+        elements: [
           {
-            type: 'divider'
+            type: 'button',
+            text: {
+              type: 'plain_text',
+              text: 'See report on Artillery Cloud',
+              emoji: true
+            },
+            url: this.cloudTestRunUrl,
+            style: 'primary'
           }
         ]
-      );
+      });
     }
 
-    payloadTemplate.blocks = payloadTemplate.blocks.concat(metricBlocks);
-
     return JSON.stringify(payloadTemplate);
   }
 

package/package.json

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