fix: keep GitHub annotations parseable with dot reporter (microsoft#41292)

Signed-off-by: Simon Knott <info@simonknott.de>
Co-authored-by: Simon Knott <info@simonknott.de>

Author: mturac

packages/playwright/src/reporters/github.ts

@@ -36,6 +36,11 @@ type GitHubLogOptions = Partial<{
 }>;
 
 class GitHubLogger {
+  newLine() {
+    // eslint-disable-next-line no-restricted-properties
+    process.stdout.write('\n');
+  }
+
   private _log(message: string, type: GitHubLogType = 'notice', options: GitHubLogOptions = {}) {
     message = message.replace(/\n/g, '%0A');
     const configs = Object.entries(options)
@@ -82,6 +87,7 @@ export class GitHubReporter extends TerminalReporter {
     if (!this._shouldPrintFailureAnnotations(test))
       return;
     this._failedTestCount++;
+    this.githubLogger.newLine();
     for (const r of test.results)
       this._printFailureAnnotation(test, r, this._failedTestCount);
   }

tests/playwright-test/reporter-github.spec.ts

@@ -115,5 +115,18 @@ for (const useIntermediateMergeReport of [false, true] as const) {
       expect(summaryIndex).toBeGreaterThan(errorIndex);
       expect(result.exitCode).toBe(1);
     });
+
+    test('starts GitHub failure annotation on a new line with dot reporter', async ({ runInlineTest }) => {
+      const result = await runInlineTest({
+        'a.test.js': `
+          const { test, expect } = require('@playwright/test');
+          test('failing', async ({}) => {
+            expect(1 + 1).toBe(3);
+          });
+        `
+      }, { workers: 1, reporter: 'dot,github' }, { GITHUB_WORKSPACE: process.cwd() });
+      expect(result.output).toContain('F\n::error file=');
+      expect(result.exitCode).toBe(1);
+    });
   });
 }