playwright-slack-report 1.0.16 → 1.0.18

package/README.md

@@ -104,6 +104,7 @@ An example advanced configuration is shown below:
         sendResults: "always", // "always" , "on-failure", "off"
       },
       layout: generateCustomLayout,
+      maxNumberOfFailuresToShow: 4,
       meta: [
         {
           key: 'BUILD_NUMBER',
@@ -113,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|📊>',
+        },
       ],      
     ],
   ],
@@ -128,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

@@ -30,7 +30,7 @@ export default class ResultsParser {
     constructor();
     getParsedResults(): Promise<SummaryResults>;
     getFailures(): Promise<Array<failure>>;
-    getTestName(failedTest: any): any;
+    static getTestName(failedTest: any): any;
     updateResults(data: {
         testSuite: any;
     }): void;

package/dist/src/ResultsParser.js

@@ -41,7 +41,7 @@ class ResultsParser {
                     // only flag as failed if the last attempt has failed
                     if (test.retries === test.retry) {
                         failures.push({
-                            test: this.getTestName(test),
+                            test: ResultsParser.getTestName(test),
                             failureReason: test.reason,
                         });
                     }
@@ -50,7 +50,7 @@ class ResultsParser {
         }
         return failures;
     }
-    getTestName(failedTest) {
+    static getTestName(failedTest) {
         const testName = failedTest.name;
         if (failedTest.browser && failedTest.projectName) {
             if (failedTest.browser === failedTest.projectName) {

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`);

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();
     }
@@ -49,6 +51,7 @@ class SlackReporter {
                 channelIds: this.slackChannels,
                 summaryResults: resultSummary,
                 customLayout: this.customLayout,
+                maxNumberOfFailures: this.maxNumberOfFailuresToShow,
             },
         });
         // eslint-disable-next-line no-console

package/package.json

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