playwright-slack-report 1.1.23 → 1.1.25

package/dist/src/LayoutGenerator.d.ts

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

package/dist/src/LayoutGenerator.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateFailures = exports.generateBlocks = void 0;
+exports.generateFallbackText = exports.generateFailures = exports.generateBlocks = void 0;
 const generateBlocks = async (summaryResults, maxNumberOfFailures) => {
     const meta = [];
     const header = {
@@ -14,7 +14,9 @@ const generateBlocks = async (summaryResults, maxNumberOfFailures) => {
         type: 'section',
         text: {
             type: 'mrkdwn',
-            text: `✅ *${summaryResults.passed}* | ❌ *${summaryResults.failed}* | ⏩ *${summaryResults.skipped}*`,
+            text: `✅ *${summaryResults.passed}* | ❌ *${summaryResults.failed}* |${summaryResults.flaky !== undefined
+                ? ` 🟡 *${summaryResults.flaky}* | `
+                : ' '}⏩ *${summaryResults.skipped}*`,
         },
     };
     const fails = await generateFailures(summaryResults, maxNumberOfFailures);
@@ -30,12 +32,7 @@ const generateBlocks = async (summaryResults, maxNumberOfFailures) => {
             });
         }
     }
-    return [
-        header,
-        summary,
-        ...meta,
-        ...fails,
-    ];
+    return [header, summary, ...meta, ...fails];
 };
 exports.generateBlocks = generateBlocks;
 const generateFailures = async (summaryResults, maxNumberOfFailures) => {
@@ -75,3 +72,5 @@ const generateFailures = async (summaryResults, maxNumberOfFailures) => {
     ];
 };
 exports.generateFailures = generateFailures;
+const generateFallbackText = (summaryResults) => `✅ ${summaryResults.passed} ❌ ${summaryResults.failed} ${summaryResults.flaky !== undefined ? ` 🟡 ${summaryResults.flaky} ` : ' '}⏩ ${summaryResults.skipped}`;
+exports.generateFallbackText = generateFallbackText;

package/dist/src/ResultsParser.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+import { TestCase } from '@playwright/test/reporter';
 import { failure, SummaryResults } from '.';
 export declare type testResult = {
     suiteName: string;
@@ -28,7 +29,7 @@ export declare type testSuite = {
 export default class ResultsParser {
     private result;
     constructor();
-    getParsedResults(): Promise<SummaryResults>;
+    getParsedResults(allTests: Array<TestCase>): Promise<SummaryResults>;
     getFailures(): Promise<Array<failure>>;
     static getTestName(failedTest: any): any;
     updateResults(data: {

package/dist/src/ResultsParser.js

@@ -11,25 +11,26 @@ class ResultsParser {
     constructor() {
         this.result = [];
     }
-    async getParsedResults() {
+    async getParsedResults(allTests) {
         const failures = await this.getFailures();
+        // use Playwright recommended way of extracting test stats:
+        // https://github.com/microsoft/playwright/issues/27498#issuecomment-1766766335
+        const stats = {
+            expected: 0, skipped: 0, unexpected: 0, flaky: 0,
+        };
+        // eslint-disable-next-line no-plusplus
+        for (const test of allTests)
+            ++stats[test.outcome()];
         const summary = {
-            passed: 0,
-            failed: failures.length,
-            skipped: 0,
+            passed: stats.expected,
+            failed: stats.unexpected,
+            flaky: stats.flaky,
+            skipped: stats.skipped,
             failures,
             tests: [],
         };
         for (const suite of this.result) {
             summary.tests = summary.tests.concat(suite.testSuite.tests);
-            for (const test of suite.testSuite.tests) {
-                if (test.status === 'passed') {
-                    summary.passed += 1;
-                }
-                else if (test.status === 'skipped') {
-                    summary.skipped += 1;
-                }
-            }
         }
         return summary;
     }

package/dist/src/SlackClient.d.ts

@@ -33,5 +33,5 @@ export default class SlackClient {
         disableUnfurl?: boolean;
         fakeRequest?: Function;
     }): Promise<any[]>;
-    static doPostRequest(slackWebClient: WebClient, channel: string, blocks: Array<KnownBlock | Block>, unfurl: boolean, threadTimestamp?: string): Promise<ChatPostMessageResponse>;
+    static doPostRequest(slackWebClient: WebClient, channel: string, fallbackText: string, blocks: Array<KnownBlock | Block>, unfurl: boolean, threadTimestamp?: string): Promise<ChatPostMessageResponse>;
 }

package/dist/src/SlackClient.js

@@ -25,6 +25,7 @@ class SlackClient {
         if (!options.channelIds) {
             throw new Error(`Channel ids [${options.channelIds}] is not valid`);
         }
+        const fallbackText = (0, LayoutGenerator_1.generateFallbackText)(options.summaryResults);
         const result = [];
         const unfurl = !options.disableUnfurl;
         for (const channel of options.channelIds) {
@@ -36,7 +37,7 @@ class SlackClient {
                 }
                 else {
                     // send request for reals
-                    chatResponse = await SlackClient.doPostRequest(this.slackWebClient, channel, blocks, unfurl);
+                    chatResponse = await SlackClient.doPostRequest(this.slackWebClient, channel, fallbackText, blocks, unfurl);
                 }
                 if (chatResponse.ok) {
                     result.push({
@@ -66,6 +67,7 @@ class SlackClient {
     async attachDetailsToThread({ channelIds, ts, summaryResults, maxNumberOfFailures, disableUnfurl, fakeRequest, }) {
         const result = [];
         const blocks = await (0, LayoutGenerator_1.generateFailures)(summaryResults, maxNumberOfFailures);
+        const fallbackText = (0, LayoutGenerator_1.generateFallbackText)(summaryResults);
         for (const channel of channelIds) {
             // under test
             let chatResponse;
@@ -73,7 +75,7 @@ class SlackClient {
                 chatResponse = await fakeRequest();
             }
             else {
-                chatResponse = await SlackClient.doPostRequest(this.slackWebClient, channel, blocks, disableUnfurl, ts);
+                chatResponse = await SlackClient.doPostRequest(this.slackWebClient, channel, fallbackText, blocks, disableUnfurl, ts);
             }
             if (chatResponse.ok) {
                 // eslint-disable-next-line no-console
@@ -87,10 +89,10 @@ class SlackClient {
         }
         return result;
     }
-    static async doPostRequest(slackWebClient, channel, blocks, unfurl, threadTimestamp) {
+    static async doPostRequest(slackWebClient, channel, fallbackText, blocks, unfurl, threadTimestamp) {
         const chatResponse = await slackWebClient.chat.postMessage({
             channel,
-            text: ' ',
+            text: fallbackText,
             unfurl_link: unfurl,
             blocks,
             thread_ts: threadTimestamp,

package/dist/src/SlackReporter.js

@@ -66,7 +66,7 @@ class SlackReporter {
             this.log(message);
             return;
         }
-        const resultSummary = await this.resultsParser.getParsedResults();
+        const resultSummary = await this.resultsParser.getParsedResults(this.suite.allTests());
         resultSummary.meta = this.meta;
         const maxRetry = Math.max(...resultSummary.tests.map((o) => o.retry));
         if (this.sendResults === 'on-failure'

package/dist/src/index.d.ts

@@ -2,6 +2,7 @@
 export declare type SummaryResults = {
     passed: number;
     failed: number;
+    flaky: number | undefined;
     skipped: number;
     failures: Array<failure>;
     meta?: Array<{

package/package.json

@@ -1,7 +1,7 @@
 {
   "dependencies": {
-    "@slack/web-api": "^6.8.1",
-    "@slack/webhook": "^6.1.0",
+    "@slack/web-api": "^6.9.1",
+    "@slack/webhook": "^7.0.1",
     "https-proxy-agent": "^7.0.1"
   },
   "devDependencies": {
@@ -26,10 +26,11 @@
     "prettier": "prettier --write --loglevel warn \"**/**/*.ts\"",
     "pw": "nyc playwright test && nyc report --reporter=lcov",
     "build": "tsc -p ./tsconfig.json",
-    "lint": "npx eslint . --ext .ts"
+    "lint": "npx eslint . --ext .ts",
+    "lint-fix": "npx eslint . --ext .ts --fix"
   },
   "name": "playwright-slack-report",
-  "version": "1.1.23",
+  "version": "1.1.25",
   "main": "index.js",
   "types": "dist/index.d.ts",
   "repository": "git@github.com:ryanrosello-og/playwright-slack-report.git",
@@ -43,5 +44,14 @@
     "report",
     "playwright",
     "typescript"
-  ]
+  ],
+  "nyc": {
+    "all": true,
+    "include": [
+      "src/**/*.ts"
+    ],
+    "exclude": [
+      "./src/custom_block/my_block.ts"
+    ]
+  }
 }