playwright-slack-report 1.1.24 → 1.1.25

package/README.md

@@ -179,8 +179,6 @@ A function that returns a layout object, this configuration is optional.  See se
 Same as **layout** above, but asynchronous in that it returns a promise.
 ### **maxNumberOfFailuresToShow**
 Limits the number of failures shown in the Slack message, defaults to 10.
-### **separateFlaky**
-Don't consider flaky tests as passed, instead output them separately. Flaky tests are tests that passed but not on the first try.  This defaults to `false` but it is highly recommended that you switch this on.
 ### **slackOAuthToken**
 Instead of providing an environment variable `SLACK_BOT_USER_OAUTH_TOKEN` you can specify the token in the config in the `slackOAuthToken` field.
 ### **slackLogLevel** (default LogLevel.DEBUG)

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 = {
@@ -72,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,5 +1,6 @@
 /// <reference types="node" />
-import { failure, flaky, pass, SummaryResults } from '.';
+import { TestCase } from '@playwright/test/reporter';
+import { failure, SummaryResults } from '.';
 export declare type testResult = {
     suiteName: string;
     name: string;
@@ -27,14 +28,9 @@ export declare type testSuite = {
 };
 export default class ResultsParser {
     private result;
-    private separateFlakyTests;
-    constructor(options?: {
-        separateFlakyTests: boolean;
-    });
-    getParsedResults(): Promise<SummaryResults>;
+    constructor();
+    getParsedResults(allTests: Array<TestCase>): Promise<SummaryResults>;
     getFailures(): Promise<Array<failure>>;
-    getFlakes(): Promise<Array<flaky>>;
-    getPasses(): Promise<Array<pass>>;
     static getTestName(failedTest: any): any;
     updateResults(data: {
         testSuite: any;
@@ -55,7 +51,4 @@ export default class ResultsParser {
         projectName: string;
         browser: string;
     };
-    /** removes tests from the passed array that only passed on a retry (flaky).
-     * Does not modify param passed, returns a new passed array. */
-    doSeparateFlakyTests(passes: Array<pass>, flakes: Array<flaky>): pass[];
 }

package/dist/src/ResultsParser.js

@@ -8,33 +8,29 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 class ResultsParser {
     result;
-    separateFlakyTests;
-    constructor(options = { separateFlakyTests: false }) {
+    constructor() {
         this.result = [];
-        this.separateFlakyTests = options.separateFlakyTests;
     }
-    async getParsedResults() {
+    async getParsedResults(allTests) {
         const failures = await this.getFailures();
-        const flakes = await this.getFlakes();
-        let passes = await this.getPasses();
-        if (this.separateFlakyTests) {
-            passes = this.doSeparateFlakyTests(passes, flakes);
-        }
+        // 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: passes.length,
-            failed: failures.length,
-            flaky: this.separateFlakyTests ? flakes.length : undefined,
-            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 === 'skipped') {
-                    summary.skipped += 1;
-                }
-            }
         }
         return summary;
     }
@@ -55,33 +51,6 @@ class ResultsParser {
         }
         return failures;
     }
-    async getFlakes() {
-        const flaky = [];
-        for (const suite of this.result) {
-            for (const test of suite.testSuite.tests) {
-                if (test.status === 'passed' && test.retry > 0) {
-                    flaky.push({
-                        test: ResultsParser.getTestName(test),
-                        retry: test.retry,
-                    });
-                }
-            }
-        }
-        return flaky;
-    }
-    async getPasses() {
-        const passes = [];
-        for (const suite of this.result) {
-            for (const test of suite.testSuite.tests) {
-                if (test.status === 'passed') {
-                    passes.push({
-                        test: ResultsParser.getTestName(test),
-                    });
-                }
-            }
-        }
-        return passes;
-    }
     static getTestName(failedTest) {
         const testName = failedTest.name;
         if (failedTest.browser && failedTest.projectName) {
@@ -154,17 +123,5 @@ class ResultsParser {
             browser: '',
         };
     }
-    /** removes tests from the passed array that only passed on a retry (flaky).
-     * Does not modify param passed, returns a new passed array. */
-    doSeparateFlakyTests(passes, flakes) {
-        const _passes = new Map();
-        for (const pass of passes) {
-            _passes.set(pass.test, pass);
-        }
-        for (const flake of flakes) {
-            _passes.delete(flake.test);
-        }
-        return [..._passes.values()];
-    }
 }
 exports.default = ResultsParser;

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.d.ts

@@ -15,7 +15,6 @@ declare class SlackReporter implements Reporter {
     private proxy;
     private browsers;
     private suite;
-    private separateFlaky;
     logs: string[];
     onBegin(fullConfig: FullConfig, suite: Suite): void;
     onTestEnd(test: TestCase, result: TestResult): void;

package/dist/src/SlackReporter.js

@@ -22,7 +22,6 @@ class SlackReporter {
     proxy;
     browsers = [];
     suite;
-    separateFlaky = false;
     logs = [];
     onBegin(fullConfig, suite) {
         this.suite = suite;
@@ -54,11 +53,8 @@ class SlackReporter {
             this.showInThread = slackReporterConfig.showInThread || false;
             this.slackLogLevel = slackReporterConfig.slackLogLevel || web_api_1.LogLevel.DEBUG;
             this.proxy = slackReporterConfig.proxy || undefined;
-            this.separateFlaky = slackReporterConfig.separateFlaky || false;
         }
-        this.resultsParser = new ResultsParser_1.default({
-            separateFlakyTests: this.separateFlaky,
-        });
+        this.resultsParser = new ResultsParser_1.default();
     }
     // eslint-disable-next-line class-methods-use-this, no-unused-vars
     onTestEnd(test, result) {
@@ -70,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

@@ -31,10 +31,3 @@ export declare type failure = {
     test: string;
     failureReason: string;
 };
-export declare type flaky = {
-    test: string;
-    retry: number;
-};
-export declare type pass = {
-    test: string;
-};

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": {
@@ -30,7 +30,7 @@
     "lint-fix": "npx eslint . --ext .ts --fix"
   },
   "name": "playwright-slack-report",
-  "version": "1.1.24",
+  "version": "1.1.25",
   "main": "index.js",
   "types": "dist/index.d.ts",
   "repository": "git@github.com:ryanrosello-og/playwright-slack-report.git",
@@ -44,5 +44,14 @@
     "report",
     "playwright",
     "typescript"
-  ]
+  ],
+  "nyc": {
+    "all": true,
+    "include": [
+      "src/**/*.ts"
+    ],
+    "exclude": [
+      "./src/custom_block/my_block.ts"
+    ]
+  }
 }