better reporter

Author: yury-s

.github/workflows/tests_primary.yml

@@ -41,10 +41,19 @@ jobs:
       contents: read    # This is required for actions/checkout to succeed
     steps:
     - uses: actions/checkout@v4
-    - name: Upload blob report
-      # We only merge reports for PRs as per .github/workflows/create_test_report.yml.
-      if: ${{ !cancelled() && github.event_name == 'pull_request' }}
-      uses: ./.github/actions/upload-blob-report
+    - uses: ./.github/actions/run-test
       with:
-        report_dir: test-blob-report
-        job_name: ${{ inputs.bot-name }}
+        node-version: ${{ matrix.node-version }}
+        browsers-to-install: ${{ matrix.browser }} chromium
+        command: npm run test -- --project=${{ matrix.browser }}-* page-check:20
+        bot-name: "${{ matrix.browser }}-${{ matrix.os }}-node${{ matrix.node-version }}"
+        flakiness-client-id: ${{ secrets.AZURE_FLAKINESS_DASHBOARD_CLIENT_ID }}
+        flakiness-tenant-id: ${{ secrets.AZURE_FLAKINESS_DASHBOARD_TENANT_ID }}
+        flakiness-subscription-id: ${{ secrets.AZURE_FLAKINESS_DASHBOARD_SUBSCRIPTION_ID }}
+    # - name: Upload blob report
+    #   # We only merge reports for PRs as per .github/workflows/create_test_report.yml.
+    #   if: ${{ !cancelled() && github.event_name == 'pull_request' }}
+    #   uses: ./.github/actions/upload-blob-report
+    #   with:
+    #     report_dir: test-blob-report
+    #     job_name: ${{ inputs.bot-name }}

tests/config/ghaMarkdownReporter.ts

@@ -15,70 +15,82 @@
  */
 
 import { MarkdownReporter } from 'playwright/lib/internalsForTest';
-import * as github from '@actions/github';
+import { context, getOctokit } from '@actions/github';
 import * as core from '@actions/core';
 
 import type { MetadataWithCommitInfo } from 'playwright/src/isomorphic/types';
 
+function getGithubToken() {
+  const token = process.env.GITHUB_TOKEN || core.getInput('github-token');
+  if (!token) {
+    core.setFailed('Missing "github-token" input');
+    throw new Error('Missing "github-token" input');
+  }
+  return token;
+}
+
+const octokit = getOctokit(getGithubToken());
+
 const magicComment = '<!-- Generated by Playwright markdown reporter -->';
+
 class GHAMarkdownReporter extends MarkdownReporter {
   // declare config: FullConfig;
 
   async publishReport(report: string) {
     core.info('Publishing report to PR.');
-    const metadata = this.config.metadata as MetadataWithCommitInfo;
-    const prHref = metadata.ci?.prHref;
-    const prNumber = parseInt(prHref?.split('/').pop(), 10);
+    const { prNumber, prHref } = this.pullRequestFromMetadata();
     if (!prNumber) {
-      core.info(`No PR number found, skipping GHA comment. prHref: ${prHref}`);
+      core.info(`No PR number found, skipping GHA comment. PR href: ${prHref}`);
       return;
     }
     core.info(`Posting comment to PR ${prHref}`);
 
-    const token = process.env.GITHUB_TOKEN || core.getInput('github-token');
-    if (!token) {
-      core.setFailed('Missing "github-token" input');
-      return;
-    }
-    const octokit = github.getOctokit(token);
-    const context = github.context;
-
-    const reportUrl = process.env.HTML_REPORT_URL;
-    const mergeWorkflowUrl = `${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`;
+    await this.collapsePreviousComments(prNumber);
+    await this.addNewReportComment(prNumber, report);
+  }
 
-    {
-      // Mark previous comments as outdated by minimizing them.
-      const { data: comments } = await octokit.rest.issues.listComments({
-        ...context.repo,
-        issue_number: prNumber,
-      });
-      for (const comment of comments) {
-        if (comment.user.login === 'github-actions[bot]' && comment.body.includes(magicComment)) {
-          core.info(`Minimizing comment: ${comment.html_url}`);
-          await octokit.graphql(`
-            mutation {
-              minimizeComment(input: {subjectId: "${comment.node_id}", classifier: OUTDATED}) {
-                clientMutationId
-              }
+  private async collapsePreviousComments(prNumber: number) {
+    const { data: comments } = await octokit.rest.issues.listComments({
+      ...context.repo,
+      issue_number: prNumber,
+    });
+    for (const comment of comments) {
+      if (comment.user.login === 'github-actions[bot]' && comment.body.includes(magicComment)) {
+        core.info(`Minimizing comment: ${comment.html_url}`);
+        await octokit.graphql(`
+          mutation {
+            minimizeComment(input: {subjectId: "${comment.node_id}", classifier: OUTDATED}) {
+              clientMutationId
             }
-          `);
-        }
+          }
+        `);
       }
     }
+  }
+
+  private async addNewReportComment(prNumber: number, report: string) {
+    const reportUrl = process.env.HTML_REPORT_URL;
+    const mergeWorkflowUrl = `${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`;
 
     const { data: response } = await octokit.rest.issues.createComment({
       ...context.repo,
       issue_number: prNumber,
       body: formatComment([
         magicComment,
-        `### [Test results](${reportUrl}) for "${github.context.payload.workflow_run?.name}"`,
+        `### [Test results](${reportUrl}) for "${context.payload.workflow_run?.name}"`,
         report,
         '',
         `Merge [workflow run](${mergeWorkflowUrl}).`
       ]),
     });
     core.info(`Posted comment:  ${response.html_url}`);
   }
+
+  private pullRequestFromMetadata() {
+    const metadata = this.config.metadata as MetadataWithCommitInfo;
+    const prHref = metadata.ci?.prHref;
+    return { prNumber: parseInt(prHref?.split('/').pop(), 10), prHref };
+  }
 }
 
 function formatComment(lines) {