session-orchestrator 5.0.0 → 5.2.0

package/scripts/lib/playwright-driver/runner.mjs

@@ -9,7 +9,8 @@
  * Exit codes:
  *   0 — all tests passed
  *   1 — at least one test failed (Playwright exit 1)
- *   2 — framework error, timeout, spawn failure, or invalid profile
+ *   2 — framework error, timeout, spawn failure, invalid profile, or the target
+ *       repo has no local Playwright install (preflight, #1359)
  *
  * CLI args (all also accepted via env vars as fallback):
  *   --run-dir <path>   absolute path to artifact dir  (env: RUN_DIR)
@@ -31,6 +32,7 @@ import path from 'node:path';
 import { parseArgs } from 'node:util';
 import { getProfile, loadProfiles, validateProfile } from '../profiles/registry.mjs';
 import { validatePathInsideProject } from '../path-utils.mjs';
+import { isMainModule } from '../is-main-module.mjs';
 
 // ---------------------------------------------------------------------------
 // Path resolution helper
@@ -79,6 +81,43 @@ function checkAxeCore(targetPath, fsImpl) {
   return { present, skipped: false };
 }
 
+// ---------------------------------------------------------------------------
+// Playwright local-install preflight (#1359)
+// ---------------------------------------------------------------------------
+
+/** Packages that provide the `playwright test` runner, in preference order. */
+const PLAYWRIGHT_PACKAGES = ['@playwright/test', 'playwright'];
+
+/**
+ * Check whether the target repo can resolve the Playwright test runner from its
+ * OWN node_modules (walking up, so a monorepo hoist counts).
+ *
+ * Why a resolution probe and not `npx --no-install`: `--no-install` would change
+ * the spawn for every user — including the majority whose target repo has the
+ * devDependency — and its failure surfaces as npm's own message on a generic
+ * non-zero exit, which this runner would then map to exit 2 with no indication
+ * of what is missing. The probe is explicit, runs before any process starts, and
+ * leaves the spawned command byte-identical.
+ *
+ * @param {string} targetPath absolute path to the target repo
+ * @param {{ existsSync: Function }} fsImpl
+ * @returns {boolean} true when the runner binary resolves from the target
+ */
+function checkPlaywrightInstalled(targetPath, fsImpl) {
+  let dir = targetPath;
+  // Bounded by the filesystem root: path.dirname('/') === '/'.
+  for (;;) {
+    for (const pkg of PLAYWRIGHT_PACKAGES) {
+      const manifest = path.join(dir, 'node_modules', ...pkg.split('/'), 'package.json');
+      if (fsImpl.existsSync(manifest)) return true;
+    }
+    const parent = path.dirname(dir);
+    if (parent === dir) break;
+    dir = parent;
+  }
+  return false;
+}
+
 // ---------------------------------------------------------------------------
 // Main run() function
 // ---------------------------------------------------------------------------
@@ -212,6 +251,28 @@ export default async function run(opts = {}) {
     process.exit(0);
   }
 
+  // -------------------------------------------------------------------------
+  // Preflight: Playwright must resolve locally in the target repo (#1359)
+  // -------------------------------------------------------------------------
+
+  // `npx` resolves against the TARGET repo. Without a local install it falls
+  // back to downloading the package from the registry mid-run — a silent,
+  // unpinned network install inside what is supposed to be a test run. Abort
+  // first with an actionable message instead. Runs AFTER the dry-run exit
+  // above, so `--dry-run` still prints the resolved command on any machine.
+  if (!checkPlaywrightInstalled(targetPath, fsImpl)) {
+    console.error(
+      `runner: Playwright is not installed in the target repo (${targetPath}).`,
+    );
+    console.error(
+      'runner: this driver runs the target repo\'s OWN Playwright — it never falls back to a global install.',
+    );
+    console.error(
+      `runner: install it there first — \`npm install --save-dev @playwright/test\` in ${targetPath}, then \`npx playwright install chromium\`.`,
+    );
+    process.exit(2);
+  }
+
   // -------------------------------------------------------------------------
   // Create artifact directories
   // -------------------------------------------------------------------------
@@ -289,7 +350,7 @@ export default async function run(opts = {}) {
 // CLI entry-point
 // ---------------------------------------------------------------------------
 
-if (import.meta.url === `file://${process.argv[1]}`) {
+if (isMainModule(import.meta.url)) {
   run().catch((err) => {
     console.error(`runner: unhandled error — ${err.message}`);
     process.exit(2);