playwright-slack-report-burak 1.7.0 → 2.0.1

package/dist/src/ResultsParser.js

@@ -6,38 +6,118 @@
 /* eslint-disable class-methods-use-this */
 /* eslint-disable no-param-reassign */
 Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require('fs');
+const path = require('path');
+const axios = require('axios');
+const { exec } = require('child_process');
+
 class ResultsParser {
     result;
     separateFlakyTests;
+    totalShardCount = process.env.CIRCLE_NODE_TOTAL || 1;
+    shardIndex = process.env.CIRCLE_NODE_INDEX || 0;
     constructor(options = { separateFlakyTests: false }) {
         this.result = [];
         this.separateFlakyTests = options.separateFlakyTests;
     }
     async getParsedResults() {
+      const summary = {
+          total: 0,
+          passed: 0,
+          failed: 0,
+          flaky: 0,
+          skipped: 0,
+          failures: [],
+          tests: [],
+      };
         const failures = await this.getFailures();
         const flakes = await this.getFlakes();
         let passes = await this.getPasses();
         /*if (this.separateFlakyTests) {
             passes = this.doSeparateFlakyTests(passes, flakes);
         }*/
-        const summary = {
-            passed: passes.length,
-            failed: failures.length,
-            flaky: (this.separateFlakyTests && flakes.length > 0) ?
-                flakes.length : 0,
+
+        // Define the directory to store node summaries
+        const summariesDir = path.join(process.env.CIRCLE_WORKING_DIRECTORY || './', 'playwright-report');
+        
+        if (!fs.existsSync(summariesDir)) {
+            fs.mkdirSync(summariesDir, { recursive: true });
+        }
+
+        // Determine the current node index
+        const currentNodeIndex = this.shardIndex;
+
+        // Define the file for the current node's summary
+        const nodeSummaryFile = path.join(summariesDir, `node_summary_${currentNodeIndex}.json`);
+
+        const totalTestCasesForNode = this.result.reduce((acc, suite) => acc + suite.testSuite.tests.length, 0);
+
+        // Initialize or read existing summary from file
+        let nodeSummary = {
+            total: totalTestCasesForNode,
+            passed: 0,
+            failed: 0,
+            flaky: 0,
             skipped: 0,
-            failures,
+            failures: [],
             tests: [],
         };
+
+        // Create the file if it doesn't exist
+        if (!fs.existsSync(nodeSummaryFile)) {
+            fs.writeFileSync(nodeSummaryFile, JSON.stringify(nodeSummary, null, 2));
+        } else {
+            nodeSummary = JSON.parse(fs.readFileSync(nodeSummaryFile, 'utf-8'));
+        }
+
+        // Update the node summary with new test results
         for (const suite of this.result) {
-            summary.tests = summary.tests.concat(suite.testSuite.tests);
+            nodeSummary.tests = nodeSummary.tests.concat(suite.testSuite.tests);
             for (const test of suite.testSuite.tests) {
                 if (test.status === 'skipped') {
-                    summary.skipped += 1;
+                    nodeSummary.skipped += 1;
+                }
+                if (test.status === 'failed' || test.status === 'timedOut') {
+                    nodeSummary.failed += 1;
+                }
+                if (this.separateFlakyTests && test.status === 'passed' && test.retry > 0) {
+                    nodeSummary.flaky += 1;
+                }
+                if (test.status === 'passed' && (!this.separateFlakyTests || test.retry === 0)) {
+                    nodeSummary.passed += 1;
+                }
+            }
+        }
+
+        // Write the updated summary back to the file for the current node
+        fs.writeFileSync(nodeSummaryFile, JSON.stringify(nodeSummary, null, 2));
+
+        if (this.shardIndex === 0 && this.totalShardCount > 1) {
+            await this.fetchAllArtifacts();
+        }
+
+        if (this.allNodeSummaryFilesExist() && this.allBlobZipsExist()) {
+            // Merge all node summaries into the final summary
+            for (let i = 0; i < this.totalShardCount; i++) {
+                const nodeSummaryFile = path.join(summariesDir, `node_summary_${i}.json`);
+                const fileToRead = nodeSummaryFile;
+
+                if (fs.existsSync(fileToRead)) {
+                    const nodeSummary = JSON.parse(fs.readFileSync(fileToRead, 'utf-8'));
+                    summary.total += nodeSummary.total;
+                    summary.passed += nodeSummary.passed;
+                    summary.failed += nodeSummary.failed;
+                    summary.flaky += nodeSummary.flaky;
+                    summary.skipped += nodeSummary.skipped;
+                    summary.failures = summary.failures.concat(nodeSummary.failures);
+                    summary.tests = summary.tests.concat(nodeSummary.tests);
                 }
             }
+            this.mergeReports();
+            return summary;
+        } else {
+            return { summary, sendResults: 'off' };
         }
-        return summary;
     }
     async getFailures() {
         const failures = [];
@@ -179,5 +259,81 @@ class ResultsParser {
         }
         return [..._passes.values()];
     }*/
+    allNodeSummaryFilesExist() {
+      const summariesDir = path.join(process.env.CIRCLE_WORKING_DIRECTORY || './', 'playwright-report');
+      
+      for (let i = 0; i < this.totalShardCount; i++) {
+          const nodeSummaryFile = path.join(summariesDir, `node_summary_${i}.json`);
+          if (!fs.existsSync(nodeSummaryFile)) {
+              return false;
+          }
+      }
+      return true;
+    }
+
+    allBlobZipsExist() {
+        const summariesDir = path.join(process.env.CIRCLE_WORKING_DIRECTORY || './', 'playwright-report');
+        
+        for (let i = 0; i < this.totalShardCount; i++) {
+            const blobZipFile = path.join(summariesDir, `blob-report-node-${i}.zip`);
+            if (!fs.existsSync(blobZipFile)) {
+                return false;
+            }
+        }
+        return true;
+    }
+
+    async fetchAllArtifacts() {
+        const summariesDir = path.join(process.env.CIRCLE_WORKING_DIRECTORY || './', 'playwright-report');
+        while (!this.allNodeSummaryFilesExist() || !this.allBlobZipsExist()) {
+          console.log('Waiting for all blob zips to exist...');
+          if (!fs.existsSync(summariesDir)) {
+              fs.mkdirSync(summariesDir, { recursive: true });
+          }
+          for (let i = 1; i < this.totalShardCount; i++) {            
+              await this.fetchArtifact(i, `node_summary_${i}.json`, summariesDir);
+              await this.fetchArtifact(i, `blob-report-node-${i}.zip`, summariesDir);
+          }
+        }
+    }
+
+    async fetchArtifact(i, file, summariesDir) {
+        const circleciToken = process.env.safetywingtest_CIRCLECI_API_TOKEN;
+        const circleciJobId = process.env.CIRCLE_WORKFLOW_JOB_ID || 'cb4e5f50-16cc-4dd1-a494-8c3094d91ceb';
+        const circleciApiUrl = `https://output.circle-artifacts.com/output/job/${circleciJobId}/artifacts/${i}/html-report/${file}`;
+        const filePath = path.join(summariesDir, file);
+
+        while (true) {
+            try {
+                const response = await axios.get(circleciApiUrl, {
+                    headers: {
+                        'Circle-Token': circleciToken,
+                    }
+                });
+
+                fs.writeFileSync(filePath, response.data);
+                console.log(`Successfully fetched file ${file} from shard ${i}`);
+                break; // Exit the loop if the file is fetched successfully
+            } catch (error) {
+                if (error.response && error.response.status === 404) {
+                    console.warn(`File ${file} not found at ${circleciApiUrl}. Retrying in 10 seconds...`);
+                    await new Promise(resolve => setTimeout(resolve, 10000)); // Wait for 10 seconds
+                } else {
+                    console.error(`Failed to fetch file ${file} from shard ${i}!`, error);
+                    break; // Exit the loop on other errors
+                }
+            }
+        }
+    }
+    mergeReports() {
+      try {
+        // Execute the command to merge reports
+        exec('npx playwright merge-reports --reporter html playwright-report', { stdio: 'inherit' });
+        console.log('Reports merged successfully.');
+      } catch (error) {
+          // Log a warning instead of throwing an error
+          console.warn('Warning: Failed to merge reports. This may not affect the overall process.', error.message);
+      }
+    }
 }
-exports.default = ResultsParser;
+exports.default = ResultsParser;

package/package.json

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

package/dist/src/cli.js

@@ -1,175 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable no-console */
-const commander_1 = require("commander");
-const web_api_1 = require("@slack/web-api");
-const https_proxy_agent_1 = require("https-proxy-agent");
-const webhook_1 = require("@slack/webhook");
-const path_1 = __importDefault(require("path"));
-const ResultsParser_1 = __importDefault(require("./src/ResultsParser"));
-const SlackClient_1 = __importDefault(require("./src/SlackClient"));
-const cli_pre_checks_1 = __importDefault(require("./src/cli/cli_pre_checks"));
-const SlackWebhookClient_1 = __importDefault(require("./src/SlackWebhookClient"));
-const program = new commander_1.Command();
-program
-    .name('playwright-slack-report - cli')
-    .version('1.0.0')
-    .description('📦 Send Playwright json results to directly Slack ')
-    .option('-c, --config <path>', 'Configuration file for the CLI app e.g ./config.json')
-    .option('-j, --json-results <path>', 'Generated Playwright json results file e.g. ./results.json')
-    .action(async (options) => {
-    const preCheckResult = await (0, cli_pre_checks_1.default)(options.jsonResults, options.config);
-    const config = preCheckResult.config;
-    if (preCheckResult.status === 'error') {
-        console.error(`❌ ${preCheckResult.message}`);
-        process.exit(1);
-    }
-    const agent = config.proxy ? new https_proxy_agent_1.HttpsProxyAgent(config.proxy) : undefined;
-    const resultsParser = new ResultsParser_1.default();
-    const resultSummary = await resultsParser.parseFromJsonFile(preCheckResult.jsonPath);
-    if (config.sendUsingBot) {
-        const slackClient = new SlackClient_1.default(new web_api_1.WebClient(process.env.SLACK_BOT_USER_OAUTH_TOKEN, {
-            logLevel: config.slackLogLevel,
-            agent,
-        }));
-        const success = await sendResultsUsingBot({
-            resultSummary,
-            slackClient,
-            config,
-        });
-        if (!success) {
-            console.error('❌ Failed to send results to Slack');
-            process.exit(1);
-        }
-        else {
-            console.log('✅ Results sent to Slack');
-            process.exit(0);
-        }
-    }
-});
-program.parse();
-
-async function sendResultsUsingBot({ resultSummary, slackClient, config, }) {
-    if (config.slackLogLevel === web_api_1.LogLevel.DEBUG) {
-        console.log({ config });
-    }
-    if (resultSummary.failures.length === 0
-        && config.sendResults === 'on-failure') {
-        console.log('⏩ Slack CLI reporter - no failures found');
-        return true;
-    }
-    let summaryResults = resultSummary;
-    const meta = replaceEnvVars(config.meta);
-    summaryResults = { ...resultSummary, meta };
-    if (config.sendUsingBot) {
-        const result = await slackClient.sendMessage({
-            options: {
-                channelIds: config.sendUsingBot.channels,
-                customLayout: await attemptToImportLayout(config.customLayout?.source, config.customLayout?.functionName),
-                customLayoutAsync: await attemptToImportLayout(config.customLayoutAsync?.source, config.customLayoutAsync?.functionName),
-                maxNumberOfFailures: config.maxNumberOfFailures,
-                disableUnfurl: config.disableUnfurl,
-                summaryResults,
-                showInThread: config.showInThread,
-            },
-        });
-        if (config.showInThread) {
-            for (let i = 0; i < result.length; i += 1) {
-                await slackClient.attachDetailsToThreadRuns({
-                    channelIds: [result[i].channel],
-                    ts: result[i].ts,
-                    summaryResults: resultSummary,
-                    maxNumberOfFailures: config.maxNumberOfFailures,
-                });
-            }
-            if (resultSummary.failures.length > 0 || resultSummary.skipped > 0 || resultSummary.flaky > 0) {
-                for (let i = 0; i < result.length; i += 1) {
-                    await slackClient.attachDetailsToThreadSuites({
-                        channelIds: [result[i].channel],
-                        ts: result[i].ts,
-                        summaryResults: resultSummary,
-                        maxNumberOfFailures: config.maxNumberOfFailures,
-                    });
-                }
-                for (let i = 0; i < result.length; i += 1) {
-                    await slackClient.attachDetailsToThreadCases({
-                        channelIds: [result[i].channel],
-                        ts: result[i].ts,
-                        summaryResults: resultSummary,
-                        maxNumberOfFailures: config.maxNumberOfFailures,
-                    });
-                }
-                if (resultSummary.failures.length > 0) {
-                    for (let i = 0; i < result.length; i += 1) {
-                        await slackClient.attachDetailsToThreadReasons({
-                            channelIds: [result[i].channel],
-                            ts: result[i].ts,
-                            summaryResults: resultSummary,
-                            maxNumberOfFailures: config.maxNumberOfFailures,
-                        });
-                    }
-                }
-            }
-        }
-        return true;
-    }
-    throw new Error('sendUsingBot config is not set');
-}
-
-async function attemptToImportLayout(source, functionName) {
-    if (source && functionName) {
-        try {
-            const importPath = path_1.default.resolve(source);
-            const layout = await Promise.resolve(`${importPath}`).then(s => __importStar(require(s)));
-            if (layout.default[functionName]) {
-                return layout.default[functionName];
-            }
-            console.error(`Function [${functionName}] was not found in [${source}]`);
-        }
-        catch (error) {
-            console.error(error);
-        }
-    }
-    return undefined;
-}
-
-function replaceEnvVars(originalMeta) {
-    const newMeta = [];
-    for (const m of originalMeta) {
-        let metaValue = m.value;
-        if (m.value.startsWith('__ENV')) {
-            const environmentVarName = m.value.replace('__ENV_', '');
-            metaValue = process.env[environmentVarName] || `❌ Environment variable [${environmentVarName}] was not set.`;
-        }
-        newMeta.push({ key: m.key, value: metaValue });
-    }
-    return newMeta;
-}
-//# sourceMappingURL=cli.js.map