playwright-slack-report 1.0.13 → 1.0.18

package/README.md

@@ -2,6 +2,8 @@
 
 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ryanrosello-og/playwright-slack-report)
 
+![Main Logo](https://github.com/ryanrosello-og/playwright-slack-report/blob/main/assets/_logo.png?raw=true)
+
 Publish your Playwright test results to your favorite Slack channel(s).
 
 ![Gif](https://github.com/ryanrosello-og/playwright-slack-report/blob/main/assets/2022-08-15_20-22-59.png?raw=true)
@@ -102,6 +104,7 @@ An example advanced configuration is shown below:
         sendResults: "always", // "always" , "on-failure", "off"
       },
       layout: generateCustomLayout,
+      maxNumberOfFailuresToShow: 4,
       meta: [
         {
           key: 'BUILD_NUMBER',
@@ -111,6 +114,10 @@ An example advanced configuration is shown below:
           key: 'WHATEVER_ENV_VARIABLE',
           value: process.env.SOME_ENV_VARIABLE, // depending on your CI environment, this can be the branch name, build id, etc
         },
+        {
+          key: 'HTML Results',
+          value: '<https://your-build-artifacts.my.company.dev/pw/23887/playwright-report/index.html|📊>',
+        },
       ],      
     ],
   ],
@@ -126,6 +133,8 @@ Can either be *"always"*, *"on-failure"* or *"off"*, this configuration is requi
 ### **layout**
 A function that returns a layout object, this configuration is optional.  See section below for more details.
 * meta - an array of meta data to be sent to Slack, this configuration is optional.
+### **maxNumberOfFailuresToShow**
+Limits the number of failures shown in the Slack message, defaults to 10.
 
 **Examples:**
 ```typescript

package/dist/src/LayoutGenerator.d.ts

@@ -1,4 +1,4 @@
 import { KnownBlock, Block } from '@slack/types';
 import { SummaryResults } from '.';
-declare const generateBlocks: (summaryResults: SummaryResults) => Promise<Array<KnownBlock | Block>>;
+declare const generateBlocks: (summaryResults: SummaryResults, maxNumberOfFailures: number) => Promise<Array<KnownBlock | Block>>;
 export default generateBlocks;

package/dist/src/LayoutGenerator.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const generateBlocks = async (summaryResults) => {
-    const maxNumberOfFailures = 10;
+const generateBlocks = async (summaryResults, maxNumberOfFailures) => {
     const maxNumberOfFailureLength = 650;
     const fails = [];
     const meta = [];
@@ -39,7 +38,7 @@ const generateBlocks = async (summaryResults) => {
                 type: 'section',
                 text: {
                     type: 'mrkdwn',
-                    text: '*There are too many failures to display*',
+                    text: `*There are too many failures to display - ${fails.length} out of ${summaryResults.failures.length} failures shown*`,
                 },
             });
             break;

package/dist/src/ResultsParser.d.ts

@@ -4,9 +4,11 @@ export declare type testResult = {
     suiteName: string;
     name: string;
     browser?: string;
+    projectName: string;
     endedAt: string;
     reason: string;
     retry: number;
+    retries: number;
     startedAt: string;
     status: 'passed' | 'failed' | 'timedOut' | 'skipped';
     attachments?: {
@@ -28,10 +30,11 @@ export default class ResultsParser {
     constructor();
     getParsedResults(): Promise<SummaryResults>;
     getFailures(): Promise<Array<failure>>;
+    static getTestName(failedTest: any): any;
     updateResults(data: {
         testSuite: any;
     }): void;
-    addTestResult(suiteName: any, test: any): void;
+    addTestResult(suiteName: any, testCase: any): void;
     safelyDetermineFailure(result: {
         errors: any[];
         error: {

package/dist/src/ResultsParser.js

@@ -1,4 +1,6 @@
 "use strict";
+/* eslint-disable no-shadow */
+/* eslint-disable no-underscore-dangle */
 /* eslint-disable import/extensions */
 /* eslint-disable no-control-regex */
 /* eslint-disable class-methods-use-this */
@@ -36,12 +38,10 @@ class ResultsParser {
         for (const suite of this.result) {
             for (const test of suite.testSuite.tests) {
                 if (test.status === 'failed' || test.status === 'timedOut') {
-                    // dont add duplicate results (retries)
-                    const failureExists = failures.find((f) => f.test === test.name
-                        && f.failureReason === test.reason);
-                    if (!failureExists) {
+                    // only flag as failed if the last attempt has failed
+                    if (test.retries === test.retry) {
                         failures.push({
-                            test: test.name,
+                            test: ResultsParser.getTestName(test),
                             failureReason: test.reason,
                         });
                     }
@@ -50,19 +50,38 @@ class ResultsParser {
         }
         return failures;
     }
+    static getTestName(failedTest) {
+        const testName = failedTest.name;
+        if (failedTest.browser && failedTest.projectName) {
+            if (failedTest.browser === failedTest.projectName) {
+                return `${testName} [${failedTest.browser}]`;
+            }
+            return `${testName} [Project Name: ${failedTest.projectName}] using ${failedTest.browser}`;
+        }
+        return testName;
+    }
     updateResults(data) {
         if (data.testSuite.tests.length > 0) {
             this.result.push(data);
         }
     }
-    addTestResult(suiteName, test) {
+    addTestResult(suiteName, testCase) {
         const testResults = [];
-        for (const result of test.results) {
+        for (const result of testCase.results) {
             testResults.push({
                 suiteName,
-                name: test.title,
+                name: testCase.title,
                 status: result.status,
+                // eslint-disable-next-line no-underscore-dangle
+                browser: testCase.parent?.parent?._projectConfig?.use?.defaultBrowserType
+                    ? testCase.parent.parent._projectConfig.use.defaultBrowserType
+                    : '',
+                // eslint-disable-next-line no-underscore-dangle
+                projectName: testCase.parent?.parent?._projectConfig?.name
+                    ? testCase.parent.parent._projectConfig.name
+                    : '',
                 retry: result.retry,
+                retries: testCase.retries,
                 startedAt: new Date(result.startTime).toISOString(),
                 endedAt: new Date(new Date(result.startTime).getTime() + result.duration).toISOString(),
                 reason: this.safelyDetermineFailure(result),
@@ -78,7 +97,9 @@ class ResultsParser {
     }
     safelyDetermineFailure(result) {
         if (result.errors.length > 0) {
-            const fullError = result.errors.map((e) => `${e.message}\r\n${e.stack ? e.stack : ''}\r\n`).join();
+            const fullError = result.errors
+                .map((e) => `${e.message}\r\n${e.stack ? e.stack : ''}\r\n`)
+                .join();
             return this.cleanseReason(fullError);
         }
         return `${this.cleanseReason(result.error?.message)} \n ${this.cleanseReason(result.error?.stack)}`;
@@ -86,7 +107,12 @@ class ResultsParser {
     cleanseReason(rawReaseon) {
         // eslint-disable-next-line prefer-regex-literals
         const ansiRegex = new RegExp('([\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)|(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~])))', 'g');
-        return rawReaseon ? rawReaseon.replace(ansiRegex, '') : '';
+        const ansiCleansed = rawReaseon ? rawReaseon.replace(ansiRegex, '') : '';
+        const logsStripped = ansiCleansed
+            .replace(/============================================================\n/g, '')
+            .replace(/============================================================\r\n/g, '')
+            .replace(/=========================== logs ===========================\n/g, '');
+        return logsStripped;
     }
 }
 exports.default = ResultsParser;

package/dist/src/SlackClient.d.ts

@@ -13,6 +13,7 @@ export default class SlackClient {
             summaryResults: SummaryResults;
             customLayout: Function | undefined;
             fakeRequest?: Function;
+            maxNumberOfFailures: number;
         };
     }): Promise<Array<{
         channel: string;

package/dist/src/SlackClient.js

@@ -12,7 +12,7 @@ class SlackClient {
             blocks = options.customLayout(options.summaryResults);
         }
         else {
-            blocks = await (0, LayoutGenerator_1.default)(options.summaryResults);
+            blocks = await (0, LayoutGenerator_1.default)(options.summaryResults, options.maxNumberOfFailures);
         }
         if (!options.channelIds) {
             throw new Error(`Channel ids [${options.channelIds}] is not valid`);
@@ -34,6 +34,9 @@ class SlackClient {
                     // eslint-disable-next-line no-console
                     console.log(`✅ Message sent to ${channel}`);
                 }
+                else {
+                    result.push({ channel, outcome: `❌ Message not sent to ${channel} \r\n ${JSON.stringify(chatResponse, null, 2)}` });
+                }
             }
             catch (error) {
                 result.push({

package/dist/src/SlackReporter.d.ts

@@ -5,6 +5,7 @@ declare class SlackReporter implements Reporter {
     private slackChannels;
     private meta;
     private customLayout;
+    private maxNumberOfFailuresToShow;
     private resultsParser;
     logs: string[];
     onBegin(fullConfig: FullConfig, suite: Suite): void;

package/dist/src/SlackReporter.js

@@ -9,6 +9,7 @@ class SlackReporter {
     slackChannels = [];
     meta = [];
     customLayout;
+    maxNumberOfFailuresToShow;
     resultsParser;
     logs = [];
     onBegin(fullConfig, suite) {
@@ -20,6 +21,7 @@ class SlackReporter {
             this.sendResults = slackReporterConfig.sendResults || 'always';
             this.customLayout = slackReporterConfig.layout;
             this.slackChannels = slackReporterConfig.channels;
+            this.maxNumberOfFailuresToShow = slackReporterConfig.maxNumberOfFailuresToShow || 10;
         }
         this.resultsParser = new ResultsParser_1.default();
     }
@@ -37,20 +39,23 @@ class SlackReporter {
         resultSummary.meta = this.meta;
         const maxRetry = Math.max(...resultSummary.tests.map((o) => o.retry));
         if (this.sendResults === 'on-failure'
-            && resultSummary.tests.filter((z) => z.status === 'failed' && z.retry === maxRetry).length === 0) {
+            && resultSummary.tests.filter((z) => (z.status === 'failed' || z.status === 'timedOut') && z.retry === maxRetry).length === 0) {
             this.log('⏩ Slack reporter - no failures found');
             return;
         }
         const slackClient = new SlackClient_1.default(new web_api_1.WebClient(process.env.SLACK_BOT_USER_OAUTH_TOKEN, {
             logLevel: web_api_1.LogLevel.DEBUG,
         }));
-        await slackClient.sendMessage({
+        const result = await slackClient.sendMessage({
             options: {
                 channelIds: this.slackChannels,
                 summaryResults: resultSummary,
                 customLayout: this.customLayout,
+                maxNumberOfFailures: this.maxNumberOfFailuresToShow,
             },
         });
+        // eslint-disable-next-line no-console
+        console.log(JSON.stringify(result, null, 2));
     }
     preChecks() {
         if (this.sendResults === 'off') {

package/dist/src/index.d.ts

@@ -12,6 +12,7 @@ export declare type SummaryResults = {
         suiteName: string;
         name: string;
         browser?: string;
+        projectName?: string;
         endedAt: string;
         reason: string;
         retry: number;

package/package.json

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