From 33a505b1e5df022c1966eac3a91b133935c08b7a Mon Sep 17 00:00:00 2001
From: Andrey Lushnikov <aslushnikov@gmail.com>
Date: Tue, 18 May 2021 17:38:02 -0700
Subject: [PATCH] chore: add logging for installation steps (#6565)

This patch:
- adds debug logging
- sets up our workflows to use `DEBUG=pw:install` on CI
---
 .github/workflows/tests_secondary.yml |  6 +++---
 src/install/browserFetcher.ts         | 21 +++++++++++++++++++--
 src/utils/debugLogger.ts              |  1 +
 3 files changed, 23 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/tests_secondary.yml b/.github/workflows/tests_secondary.yml
index 870cddfe1b..d4e88d53a9 100644
--- a/.github/workflows/tests_secondary.yml
+++ b/.github/workflows/tests_secondary.yml
@@ -62,7 +62,7 @@ jobs:
         node-version: 12
     - run: npm ci
       env:
-        DEBUG: extract-zip
+        DEBUG: pw:install
     - run: npm run build
     - run: node lib/cli/cli install-deps ${{ matrix.browser }} chromium
     - run: npm run test -- --project=${{ matrix.browser }}
@@ -91,7 +91,7 @@ jobs:
         node-version: 12
     - run: npm ci
       env:
-        DEBUG: extract-zip
+        DEBUG: pw:install
     - run: npm run build
     - run: node lib/cli/cli install-deps
     - run: npm run test -- --project=${{ matrix.browser }}
@@ -122,7 +122,7 @@ jobs:
         node-version: ${{ matrix.node_version }}
     - run: npm ci
       env:
-        DEBUG: extract-zip
+        DEBUG: pw:install
     - run: npm run build
     - run: node lib/cli/cli install-deps
     - run: xvfb-run --auto-servernum --server-args="-screen 0 1280x960x24" -- bash packages/installation-tests/installation-tests.sh
diff --git a/src/install/browserFetcher.ts b/src/install/browserFetcher.ts
index 696cf9a0ba..04d7df50b4 100644
--- a/src/install/browserFetcher.ts
+++ b/src/install/browserFetcher.ts
@@ -24,6 +24,7 @@ import { getProxyForUrl } from 'proxy-from-env';
 import * as URL from 'url';
 import * as util from 'util';
 import { BrowserName, Registry, hostPlatform } from '../utils/registry';
+import { debugLogger } from '../utils/debugLogger';
 
 // `https-proxy-agent` v5 is written in TypeScript and exposes generated types.
 // However, as of June 2020, its types are generated with tsconfig that enables
@@ -45,6 +46,7 @@ export async function downloadBrowserWithProgressBar(registry: Registry, browser
   const progressBarName = `${browserName} v${registry.revision(browserName)}`;
   if (await existsAsync(browserDirectory)) {
     // Already downloaded.
+    debugLogger.log('install', `browser ${browserName} is already downloaded.`);
     return false;
   }
 
@@ -69,21 +71,32 @@ export async function downloadBrowserWithProgressBar(registry: Registry, browser
   const zipPath = path.join(os.tmpdir(), `playwright-download-${browserName}-${hostPlatform}-${registry.revision(browserName)}.zip`);
   try {
     for (let attempt = 1, N = 3; attempt <= N; ++attempt) {
+      debugLogger.log('install', `downloading ${progressBarName} - attempt #${attempt}`);
       const {error} = await downloadFile(url, zipPath, progress);
-      if (!error)
+      if (!error) {
+        debugLogger.log('install', `SUCCESS downloading ${progressBarName}`);
         break;
+      }
       const errorMessage = typeof error === 'object' && typeof error.message === 'string' ? error.message : '';
+      debugLogger.log('install', `attempt #${attempt} - ERROR: ${errorMessage}`);
       if (attempt < N && (errorMessage.includes('ECONNRESET') || errorMessage.includes('ETIMEDOUT'))) {
         // Maximum delay is 3rd retry: 1337.5ms
         const millis = (Math.random() * 200) + (250 * Math.pow(1.5, attempt));
+        debugLogger.log('install', `sleeping ${millis}ms before retry...`);
         await new Promise(c => setTimeout(c, millis));
       } else {
         throw error;
       }
     }
+    debugLogger.log('install', `extracting archive`);
+    debugLogger.log('install', `-- zip: ${zipPath}`);
+    debugLogger.log('install', `-- location: ${browserDirectory}`);
     await extract(zipPath, { dir: browserDirectory});
-    await chmodAsync(registry.executablePath(browserName)!, 0o755);
+    const executablePath = registry.executablePath(browserName)!;
+    debugLogger.log('install', `fixing permissions at ${executablePath}`);
+    await chmodAsync(executablePath, 0o755);
   } catch (e) {
+    debugLogger.log('install', `FAILED installation ${progressBarName} with error: ${e}`);
     process.exitCode = 1;
     throw e;
   } finally {
@@ -100,6 +113,9 @@ function toMegabytes(bytes: number) {
 }
 
 function downloadFile(url: string, destinationPath: string, progressCallback: OnProgressCallback | undefined): Promise<{error: any}> {
+  debugLogger.log('install', `running download:`);
+  debugLogger.log('install', `-- from url: ${url}`);
+  debugLogger.log('install', `-- to location: ${destinationPath}`);
   let fulfill: ({error}: {error: any}) => void = ({error}) => {};
   let downloadedBytes = 0;
   let totalBytes = 0;
@@ -119,6 +135,7 @@ function downloadFile(url: string, destinationPath: string, progressCallback: On
     file.on('error', error => fulfill({error}));
     response.pipe(file);
     totalBytes = parseInt(response.headers['content-length'], 10);
+    debugLogger.log('install', `-- total bytes: ${totalBytes}`);
     if (progressCallback)
       response.on('data', onData);
   });
diff --git a/src/utils/debugLogger.ts b/src/utils/debugLogger.ts
index a2485c982a..da69d74a3c 100644
--- a/src/utils/debugLogger.ts
+++ b/src/utils/debugLogger.ts
@@ -20,6 +20,7 @@ import fs from 'fs';
 const debugLoggerColorMap = {
   'api': 45, // cyan
   'protocol': 34, // green
+  'install': 34, // green
   'browser': 0, // reset
   'error': 160, // red,
   'channel:command': 33, // blue