ci: more install retries for desktop, shared between global and worker

mshanemc · mshanemc · commit 8c2d661227c5 · 2026-03-23T19:11:56.000-05:00
diff --git a/packages/playwright-vscode-ext/src/config/downloadVSCode.ts b/packages/playwright-vscode-ext/src/config/downloadVSCode.ts
@@ -5,11 +5,9 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { downloadAndUnzipVSCode } from '@vscode/test-electron';
-import * as Duration from 'effect/Duration';
 import * as Effect from 'effect/Effect';
-import * as Schedule from 'effect/Schedule';
 import * as path from 'node:path';
+import { downloadVSCodeWithRetry } from '../utils/downloadUtils';
 import { resolveRepoRoot } from '../utils/repoRoot';
 
 /**
@@ -21,21 +19,5 @@ export default async (): Promise<void> => {
   const cachePath = path.join(repoRoot, '.vscode-test');
   const version = process.env.PLAYWRIGHT_DESKTOP_VSCODE_VERSION ?? undefined;
 
-  const download = Effect.fn('downloadVSCode')(function* () {
-    return yield* Effect.tryPromise({
-      try: () => downloadAndUnzipVSCode({ version, cachePath }),
-      catch: error => (error instanceof Error ? error : new Error(String(error)))
-    }).pipe(
-      Effect.retry(
-        Schedule.exponential(Duration.seconds(5)).pipe(
-          Schedule.compose(Schedule.recurs(2)),
-          Schedule.tapOutput(attempt =>
-            Effect.logWarning(`⚠️ VS Code download attempt ${attempt + 1} failed, retrying...`)
-          )
-        )
-      )
-    );
-  });
-
-  await Effect.runPromise(download());
+  await Effect.runPromise(downloadVSCodeWithRetry(version, cachePath));
 };
diff --git a/packages/playwright-vscode-ext/src/fixtures/createDesktopTest.ts b/packages/playwright-vscode-ext/src/fixtures/createDesktopTest.ts
@@ -8,11 +8,13 @@
 // This is Node.js test infrastructure, not extension code
 import type { WorkerFixtures, TestFixtures } from './desktopFixtureTypes';
 import { test as base, _electron as electron } from '@playwright/test';
-import { downloadAndUnzipVSCode } from '@vscode/test-electron';
+import * as Duration from 'effect/Duration';
+import * as Effect from 'effect/Effect';
 import type { ChildProcess } from 'node:child_process';
 import * as fs from 'node:fs/promises';
 import * as path from 'node:path';
 
+import { downloadVSCodeWithRetry } from '../utils/downloadUtils';
 import { filterErrors } from '../utils/helpers';
 import { resolveRepoRoot } from '../utils/repoRoot';
 import { createEmptyTestWorkspace, createTestWorkspace } from './desktopWorkspace';
@@ -30,7 +32,12 @@ const CLOSE_TIMEOUT_MS = 5000;
 const forceKillProcessGroup = (proc: ChildProcess): void => {
   const { pid } = proc;
   if (typeof pid !== 'number') return;
-  try { process.kill(-pid, 'SIGKILL'); } catch {}
+
+  try {
+    process.kill(-pid, 'SIGKILL');
+  } catch {
+    // ignore
+  }
   proc.stdin?.destroy();
   proc.stdout?.destroy();
   proc.stderr?.destroy();
@@ -69,7 +76,8 @@ export const createDesktopTest = (options: CreateDesktopTestOptions) => {
         const repoRoot = resolveRepoRoot(fixturesDir);
         const cachePath = path.join(repoRoot, '.vscode-test');
         const version = process.env.PLAYWRIGHT_DESKTOP_VSCODE_VERSION ?? undefined;
-        const executablePath = await downloadAndUnzipVSCode({ version, cachePath });
+
+        const executablePath = await Effect.runPromise(downloadVSCodeWithRetry(version, cachePath));
         await use(executablePath);
       },
       { scope: 'worker' }
@@ -93,10 +101,7 @@ export const createDesktopTest = (options: CreateDesktopTestOptions) => {
       if (Object.keys(effectiveUserSettings).length > 0) {
         const userSettingsDir = path.join(userDataDir, 'User');
         await fs.mkdir(userSettingsDir, { recursive: true });
-        await fs.writeFile(
-          path.join(userSettingsDir, 'settings.json'),
-          JSON.stringify(effectiveUserSettings, null, 2)
-        );
+        await fs.writeFile(path.join(userSettingsDir, 'settings.json'), JSON.stringify(effectiveUserSettings, null, 2));
       }
       const extensionsDir = path.join(workspaceDir, '.vscode-test-extensions');
       await fs.mkdir(extensionsDir, { recursive: true });
@@ -151,22 +156,29 @@ export const createDesktopTest = (options: CreateDesktopTestOptions) => {
             forceKillProcessGroup(proc);
             // Wait for Node.js to register the exit (pipes closed → 'close' event → 'exit' event)
             await new Promise<void>(resolve => {
-              if (proc.exitCode !== null) { resolve(); return; }
+              if (proc.exitCode !== null) {
+                resolve();
+                return;
+              }
               proc.on('close', () => resolve());
               setTimeout(resolve, 10_000);
             });
           }
           console.log(`[teardown] exitCode=${proc?.exitCode} killed=${proc?.killed}`);
         } else {
-          try {
-            await Promise.race([
-              electronApp.close(),
-              new Promise<false>(resolve => setTimeout(() => resolve(false), CLOSE_TIMEOUT_MS))
-            ]);
-          } catch {}
+          await Effect.runPromise(
+            Effect.tryPromise(() => electronApp.close()).pipe(
+              Effect.timeout(Duration.millis(CLOSE_TIMEOUT_MS)),
+              Effect.catchAll(() => Effect.void)
+            )
+          );
           // Force-kill if close didn't work (Windows timeout fallback)
           if (proc?.exitCode === null && process.platform === 'win32') {
-            try { process.kill(proc.pid!, 'SIGKILL'); } catch {}
+            try {
+              process.kill(proc.pid!, 'SIGKILL');
+            } catch {
+              // ignore
+            }
           }
         }
         console.log('[teardown] done');
diff --git a/packages/playwright-vscode-ext/src/utils/downloadUtils.ts b/packages/playwright-vscode-ext/src/utils/downloadUtils.ts
@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2025, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import { downloadAndUnzipVSCode } from '@vscode/test-electron';
+import * as Duration from 'effect/Duration';
+import * as Effect from 'effect/Effect';
+import * as Schedule from 'effect/Schedule';
+
+/**
+ * Downloads and unzips VS Code with retries.
+ * @param version VS Code version to download
+ * @param cachePath Path to cache the download
+ * @returns Effect that resolves to the executable path
+ */
+export const downloadVSCodeWithRetry = (
+  version: string | undefined,
+  cachePath: string
+): Effect.Effect<string, Error, never> => {
+  const downloadTask = Effect.fn('downloadVSCode')(function* () {
+    return yield* Effect.tryPromise({
+      try: () => downloadAndUnzipVSCode({ version, cachePath }),
+      catch: error => (error instanceof Error ? error : new Error(String(error)))
+    });
+  });
+
+  return downloadTask().pipe(
+    Effect.retry(
+      Schedule.exponential(Duration.seconds(5)).pipe(
+        Schedule.compose(Schedule.recurs(4)),
+        Schedule.tapOutput(attempt =>
+          Effect.logWarning(`⚠️ VS Code download attempt ${attempt + 1} failed, retrying...`)
+        )
+      )
+    ),
+    Effect.flatMap(executablePath =>
+      executablePath
+        ? Effect.succeed(executablePath)
+        : Effect.fail(new Error('VS Code download returned undefined executable path'))
+    )
+  );
+};
diff --git a/packages/playwright-vscode-ext/src/web/createHeadlessServer.ts b/packages/playwright-vscode-ext/src/web/createHeadlessServer.ts
@@ -34,7 +34,7 @@ export const createHeadlessServer = async (options: HeadlessServerOptions): Prom
   const repoRoot = resolveRepoRoot(options.callerDirname);
   const testRunnerDataDir = path.join(repoRoot, '.vscode-test-web');
 
-  const openTask = Effect.fn('createHeadlessServer.open')(function* () {
+  const openTask = Effect.fn('openHeadlessServer')(function* () {
     yield* Effect.log(`🌐 Starting VS Code Web (headless) for ${options.extensionName} tests...`, {
       extensionDevelopmentPath,
       extensionPaths,
@@ -68,11 +68,11 @@ export const createHeadlessServer = async (options: HeadlessServerOptions): Prom
               : [])
           ]
         }),
-      catch: error => error instanceof Error ? error : new Error(String(error))
+      catch: error => (error instanceof Error ? error : new Error(String(error)))
     });
   });
 
-  const program = openTask().pipe(
+  await openTask().pipe(
     Effect.retry(
       Schedule.exponential(Duration.seconds(5)).pipe(
         Schedule.compose(Schedule.recurs(2)),
@@ -83,15 +83,11 @@ export const createHeadlessServer = async (options: HeadlessServerOptions): Prom
     ),
     Effect.catchAll(error =>
       Effect.logError('❌ Failed to start headless server after 3 attempts', {
-        error: error.message
-      }).pipe(
-        Effect.andThen(() => process.exit(1)),
-        Effect.asVoid
-      )
-    )
+        error: error instanceof Error ? error.message : String(error)
+      })
+    ),
+    Effect.runPromiseExit
   );
-
-  await Effect.runPromise(program as Effect.Effect<void, Error, never>);
 };
 
 /** Sets up signal handlers for graceful shutdown */
