playwright-slack-report-burak 1.3.7 → 1.5.0

package/dist/src/LayoutGenerator.js

@@ -1,119 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateFailures =
+//exports.generateBlocks =
+ //exports.generateFailures =
  exports.generateFailuresReasons =
  exports.generateProblemSuiteList =
  exports.generateProblemCaseList =
- exports.generateBlocks =
  exports.generateAllRunSuites = 
  void 0;
 
-const generateBlocks = async (summaryResults, maxNumberOfFailures) => {
-    const meta = [];
-    const header = {
-        type: 'section',
-        text: {
-            type: 'mrkdwn',
-            text: '🎭 *Playwright Results*',
-        },
-    };
-    const summary = {
-        type: 'section',
-        text: {
-            type: 'mrkdwn',
-            text: `✅ *${summaryResults.passed}* | ❌ *${summaryResults.failed}* |${summaryResults.flaky !== undefined
-                ? ` 🟡 *${summaryResults.flaky}* | `
-                : ' '}⏩ *${summaryResults.skipped}*`,
-        },
-    };
-    const fails = await generateFailures(summaryResults, maxNumberOfFailures);
-    if (summaryResults.meta) {
-        for (let i = 0; i < summaryResults.meta.length; i += 1) {
-            const { key, value } = summaryResults.meta[i];
-            meta.push({
-                type: 'section',
-                text: {
-                    type: 'mrkdwn',
-                    text: `\n*${key}* :\t${value}`,
-                },
-            });
-        }
-    }
-    return [header, summary, ...meta, ...fails];
-};
-exports.generateBlocks = generateBlocks;
-
-//  Became obsolete with the introdıction of generateProblemCaseList()
-const generateFailures = async (summaryResults) => {
-    const thread = [];
-    const failedNamesTitle = [];
-    const skippedNamesTitle = [];
-    const failsList = [];
-    const skipsList = [];
-    let previousTestName = undefined;
-    let previousSuiteName = undefined;
-
-    //  Create a list for names of failed test cases
-    for (const result of summaryResults.tests) {
-        if (result.status === 'failed' || result.status === 'timedOut') {
-            const testName = result.name;
-            const suiteName = result.suiteName;
-            const parts = result.suiteName.split('/')[result.suiteName.split('/').length-1].replace('.spec.ts', '');
-            const backSlashedParts = parts.split('\\')[parts.split('\\').length-1];
-            if (testName !== previousTestName || (testName === previousSuiteName && suiteName !== previousSuiteName) ) {
-                failsList.push(testName + ' (' + backSlashedParts + ')');
-                previousTestName = testName;
-                previousSuiteName = suiteName;
-            }
-        }
-    }
-    previousTestName = undefined;
-    previousSuiteName = undefined;
-
-    //  Create a list for names of skipped test cases
-    for (const result of summaryResults.tests) {
-        if (result.status === 'skipped') {
-            const testName = result.name;
-            const suiteName = result.suiteName;
-            const parts = result.suiteName.split('/')[result.suiteName.split('/').length-1].replace('.spec.ts', '');
-            const backSlashedParts = parts.split('\\')[parts.split('\\').length-1];
-            if (testName !== previousTestName || (testName === previousSuiteName && suiteName !== previousSuiteName) ) {
-                skipsList.push(testName + ' (' + backSlashedParts + ')');
-                previousTestName = testName;
-                previousSuiteName = suiteName;
-            }
-        }
-    }
-    previousTestName = undefined;
-    previousSuiteName = undefined;
-
-    //  Decide on Titles For Listing Failures & Skips
-    if (summaryResults.failed === 1) {
-        failedNamesTitle[0] = '\n*Failed Test Case:*\n';
-    }
-    if (summaryResults.failed > 1) {
-        failedNamesTitle[0] = '\n*Failed Test Cases:*\n';
-    }
-    if (summaryResults.skipped === 1) {
-        skippedNamesTitle[0] = '\n*Skipped Test Case:*\n';
-    }
-    if (summaryResults.skipped > 1) {
-        skippedNamesTitle[0] = '\n*Skipped Test Cases:*\n';
-    }
-
-    thread.push({
-        type: 'section',
-        text: {
-            type: 'mrkdwn',
-            text: `${failedNamesTitle}${failsList.map((value, index) => `*${index + 1}.* ${value}`).join('\n')}` +  // List of Failed Test Cases
-            `\n${skippedNamesTitle}${skipsList.map((value, index) => `*${index + 1}.* ${value}`).join('\n')} `, // List of Skipped Test Cases
-        },
-    })
-    return [
-        ...thread,
-    ];
-};
-
 const generateAllRunSuites = async (summaryResults) => {
     const suitesResults = [];
     const allSuites = [];
@@ -338,48 +232,80 @@ const generateProblemCaseList = async (summaryResults) => {
   
     //  Decide on Titles For Listing Failures, Skips & Flakies
     if (summaryResults.failed === 1) {
-      failedNamesTitle[0] = '\n*Failed Test Case:*\n';
+      failedNamesTitle[0] = '*Failed Test Case:*\n';
     }
     if (summaryResults.failed > 1) {
-      failedNamesTitle[0] = '\n*Failed Test Cases:*\n';
+      failedNamesTitle[0] = '*Failed Test Cases:*\n';
     }
     if (summaryResults.flaky === 1) {
-      flakyNamesTitle[0] = '\n*Flaky Test Case:*\n';
+      flakyNamesTitle[0] = '*Flaky Test Case:*\n';
     }
     if (summaryResults.flaky > 1) {
-      flakyNamesTitle[0] = '\n*Flaky Test Cases:*\n';
+      flakyNamesTitle[0] = '*Flaky Test Cases:*\n';
     }
     if (summaryResults.skipped === 1) {
-      skippedNamesTitle[0] = '\n*Skipped Test Case:*\n';
+      skippedNamesTitle[0] = '*Skipped Test Case:*\n';
     }
     if (summaryResults.skipped > 1) {
-      skippedNamesTitle[0] = '\n*Skipped Test Cases:*\n';
+      skippedNamesTitle[0] = '*Skipped Test Cases:*\n';
     }
   
-    //  Push data into array to create the "List of Problematic Test Suites"
-    if (summaryResults.tests.length !== summaryResults.passed){
-      casesResults.push(
-      {
-          type: 'section',
-          text: {
-              type: 'mrkdwn',
-              text:
-              `\n${failedNamesTitle}${failsList.map((value, index) => `*${index + 1}.* ${value}`).join('\n')}` +  // List of Failed Test Cases
-              `\n${flakyNamesTitle}${flakyList.map((value, index) => `*${index + 1}.* ${value}`).join('\n')}` +  // List of Flaky Test Cases
-              `\n${skippedNamesTitle}${skipsList.map((value, index) => `*${index + 1}.* ${value}`).join('\n')} `, // List of Skipped Test Cases
-          },
-      },
-      {
-        type: 'section',
-        text: {
-          type: 'mrkdwn',
-          text: ` `,
+    // Function to safely push text to casesResults
+    const safePush = (title, list, array) => {
+        let text = `${title}${list.map((value, index) => `*${index + 1}.* ${value}`).join('\n')}\n`;
+        if (text.length > 2700) {
+            text = text.substring(0, 2700) + '...';
+            array.push({
+                type: 'section',
+                text: {
+                    type: 'mrkdwn',
+                    text: text + '\n\n\n' + '⚠️ *There are too many items to display here. ' +
+                          'You can view more on CircleCI* ⚠️',
+                },
+            },
+            {
+                type: 'actions',
+                elements: [{
+                    type: 'button',
+                    text: {
+                        type: 'plain_text',
+                        text: 'Go to Build Details'
+                    },
+                    url: process.env.CIRCLE_BUILD_URL
+                }]
+            });
+        } else {
+            casesResults.push({
+                type: 'section',
+                text: {
+                    type: 'mrkdwn',
+                    text: text,
+                },
+            });
+        }
+    };
+
+    // Push each section with character limit check
+    if (summaryResults.tests.length !== summaryResults.passed) {
+        safePush(failedNamesTitle, failsList, casesResults);
+        safePush(flakyNamesTitle, flakyList, casesResults);
+        safePush(skippedNamesTitle, skipsList, casesResults);
+    }
+
+    // Add additional sections if needed
+    casesResults.push(
+        {
+            type: 'section',
+            text: {
+                type: 'mrkdwn',
+                text: ` `,
+            },
         },
-      },
-      {
-        type: 'divider',
-      },
-    )}
+        {
+            type: 'divider',
+        },
+    );
+
     return [
         ...casesResults,
     ];
@@ -504,7 +430,7 @@ const generateFailuresReasons = async (summaryResults) => {
         ...failsList,
     ];
 };
-exports.generateFailures = generateFailures;
+//exports.generateFailures = generateFailures;
 exports.generateFailuresReasons = generateFailuresReasons;
 exports.generateProblemSuiteList = generateProblemSuiteList;
 exports.generateProblemCaseList = generateProblemCaseList;

package/dist/src/SlackClient.d.ts

@@ -25,15 +25,7 @@ export default class SlackClient {
         outcome: string;
         ts: string;
     }>>;
-    attachDetailsToThread({ channelIds, ts, summaryResults, maxNumberOfFailures, disableUnfurl, fakeRequest, }: {
-        channelIds: Array<string>;
-        ts: string;
-        summaryResults: SummaryResults;
-        maxNumberOfFailures: number;
-        disableUnfurl?: boolean;
-        fakeRequest?: Function;
-    }): Promise<any[]>;
-attachDetailsToThreadReasons({ channelIds, ts, summaryResults, maxNumberOfFailures, disableUnfurl, fakeRequest, }: {
+    attachDetailsToThreadReasons({ channelIds, ts, summaryResults, maxNumberOfFailures, disableUnfurl, fakeRequest, }: {
         channelIds: Array<string>;
         ts: string;
         summaryResults: SummaryResults;

package/dist/src/SlackClient.js

@@ -45,7 +45,7 @@ class SlackClient {
                         ts: chatResponse.ts,
                     });
                     // eslint-disable-next-line no-console
-                    console.log(`✅ Message sent to ${channel}`);
+                    console.log(`✅ Test results posted to Slack channel ${channel}`);
                 }
                 else {
                     result.push({
@@ -63,30 +63,6 @@ class SlackClient {
         }
         return result;
     }
-    async attachDetailsToThread({ channelIds, ts, summaryResults, maxNumberOfFailures, disableUnfurl, fakeRequest, }) {
-      const result = [];
-      const blocks = await (0, LayoutGenerator_1.generateRuns)(summaryResults, maxNumberOfFailures);
-      for (const channel of channelIds) {
-          // under test
-          let chatResponse;
-          if (fakeRequest) {
-              chatResponse = await fakeRequest();
-          }
-          else {
-              chatResponse = await SlackClient.doPostRequest(this.slackWebClient, channel, blocks, disableUnfurl, ts);
-          }
-          if (chatResponse.ok) {
-              // eslint-disable-next-line no-console
-              console.log(`✅ Message sent to ${channel} within thread ${ts}`);
-              result.push({
-                  channel,
-                  outcome: `✅ Message sent to ${channel} within thread ${ts}`,
-                  ts: chatResponse.ts,
-              });
-          }
-      }
-      return result;
-    }
     async attachDetailsToThreadRuns({ channelIds, ts, summaryResults, maxNumberOfFailures, disableUnfurl, fakeRequest, }) {
       const result = [];
       const blocks = await (0, LayoutGenerator_1.generateAllRunSuites)(summaryResults, maxNumberOfFailures);
@@ -99,6 +75,15 @@ class SlackClient {
         else {
             chatResponse = await SlackClient.doPostRequest(this.slackWebClient, channel, blocks, disableUnfurl, ts);
         }
+        if (chatResponse.ok) {
+            // eslint-disable-next-line no-console
+            console.log(`✅ List of run suites sent within a thread.`);
+            result.push({
+                channel,
+                outcome: `✅ Message sent to ${channel} within thread ${ts}`,
+                ts: chatResponse.ts,
+            });
+        }
       }
       return result;
     }
@@ -116,7 +101,7 @@ class SlackClient {
         }
         if (chatResponse.ok) {
             // eslint-disable-next-line no-console
-            console.log(`✅ Message sent to ${channel} within thread ${ts}`);
+            console.log(`✅ List of problematical suites sent within a thread.`);
             result.push({
                 channel,
                 outcome: `✅ Message sent to ${channel} within thread ${ts}`,
@@ -140,7 +125,7 @@ class SlackClient {
         }
         if (chatResponse.ok) {
             // eslint-disable-next-line no-console
-            console.log(`✅ Message sent to ${channel} within thread ${ts}`);
+            console.log(`✅ List of problematical cases sent within a thread.`);
             result.push({
                 channel,
                 outcome: `✅ Message sent to ${channel} within thread ${ts}`,
@@ -164,7 +149,7 @@ class SlackClient {
           }
           if (chatResponse.ok) {
               // eslint-disable-next-line no-console
-              console.log(`✅ Message sent to ${channel} within thread ${ts}`);
+              console.log(`✅ List of failure reasons sent within a thread.`);
               result.push({
                   channel,
                   outcome: `✅ Message sent to ${channel} within thread ${ts}`,

package/dist/src/SlackReporter.js

@@ -110,17 +110,8 @@ class SlackReporter {
                 },
             });
             // eslint-disable-next-line no-console
-            console.log(JSON.stringify(result, null, 2));
+            //console.log(JSON.stringify(result, null, 2));
             if (this.showInThread) {
-                  /*for (let i = 0; i < result.length; i += 1) {
-                    // eslint-disable-next-line no-await-in-loop
-                    await slackClient.attachDetailsToThread({
-                        channelIds: [result[i].channel],
-                        ts: result[i].ts,
-                        summaryResults: resultSummary,
-                        maxNumberOfFailures: this.maxNumberOfFailuresToShow,
-                    });
-                  }*/
                 for (let i = 0; i < result.length; i += 1) {
                     // eslint-disable-next-line no-await-in-loop
                     await slackClient.attachDetailsToThreadRuns({
@@ -152,14 +143,16 @@ class SlackReporter {
                       });
                   }
                   
-                  for (let i = 0; i < result.length; i += 1) {
-                      // eslint-disable-next-line no-await-in-loop
-                      await slackClient.attachDetailsToThreadReasons({
-                          channelIds: [result[i].channel],
-                          ts: result[i].ts,
-                          summaryResults: resultSummary,
-                          maxNumberOfFailures: this.maxNumberOfFailuresToShow,
-                      });
+                  if ((resultSummary.failures.length > 0)) {
+                    for (let i = 0; i < result.length; i += 1) {
+                        // eslint-disable-next-line no-await-in-loop
+                        await slackClient.attachDetailsToThreadReasons({
+                            channelIds: [result[i].channel],
+                            ts: result[i].ts,
+                            summaryResults: resultSummary,
+                            maxNumberOfFailures: this.maxNumberOfFailuresToShow,
+                        });
+                    }
                   }
               }
             }

package/package.json

@@ -30,7 +30,7 @@
     "lint-fix": "npx eslint . --ext .ts --fix"
   },
   "name": "playwright-slack-report-burak",
-  "version": "1.3.7",
+  "version": "1.5.0",
   "main": "index.js",
   "types": "dist/index.d.ts",
   "repository": "git@github.com:ryanrosello-og/playwright-slack-report.git",