From bb6955c974dad31c9e071424b4305b2e30e6742e Mon Sep 17 00:00:00 2001
From: Alex Potsides <alex@achingbrain.net>
Date: Tue, 10 Sep 2024 13:04:53 +0100
Subject: [PATCH] fix: log playwright browser download progress on stderr
 (#682)

If a browser is downloaded during a test run, playwright will log
on stdout.

This can interfere with the calling code if it's trying to parse
the output of the program as, for example, JSON.

The fix is to temporarily replace `console.log` with `console.error`
as that's what the [logPolitely](https://github.com/microsoft/playwright/blob/718bd9b35fd206245401a9ecb320289f427592d9/packages/playwright-core/src/server/registry/browserFetcher.ts#L120)
function uses to give feedback to the user.

The intention of the playwright maintainers is [not for this
functionality to be used during a test run](https://github.com/microsoft/playwright/issues/32487#issuecomment-2337666079)
so it's unlikely to move to stderr otherwise.
---
 src/utils/index.js | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/src/utils/index.js b/src/utils/index.js
index 9c269d7..f96005b 100644
--- a/src/utils/index.js
+++ b/src/utils/index.js
@@ -304,7 +304,19 @@ export async function getPw(browserName) {
   const api = await import('playwright-core')
   const browser = registry.findExecutable(browserName)
 
-  await registry.install([browser])
+  // playwright will log browser download progress to stdout, temporarily
+  // redirect the output to stderr
+  const log = console.log
+  const info = console.info
+
+  try {
+    console.log = console.error
+    console.info = console.error
+    await registry.install([browser])
+  } finally {
+    console.log = log
+    console.info = info
+  }
 
   return api[browserName]
 }