gstack/browse/test/playwright-core-patch.test.ts

/**
 * #2160/#1989: playwright-core is bun-patched to pass windowsHide at its two
 * Windows-visible child_process sites — the browser launch spawn (Node
 * defaults windowsHide to FALSE for spawn, so browser children could flash a
 * console window) and the force-kill taskkill spawnSync. This is the repo's
 * first patchedDependencies entry; these static checks pin the three-legged
 * coherence (patch file ↔ package.json ↔ installed tree) so a playwright
 * bump that forgets to re-target the patch fails CI instead of silently
 * dropping it. NOTE: bumping playwright (c25-style) REQUIRES regenerating
 * this patch against the new version — see the revert pairing in the wave
 * plan (reverting the bump means dropping the patch too).
 */

import { describe, expect, test } from 'bun:test';
import * as fs from 'fs';
import * as path from 'path';

const ROOT = path.resolve(import.meta.dir, '..', '..');

function installedPlaywrightCoreVersion(): string {
  const pkg = JSON.parse(fs.readFileSync(
    path.join(ROOT, 'node_modules', 'playwright-core', 'package.json'), 'utf-8',
  ));
  return pkg.version as string;
}

describe('playwright-core windowsHide patch (#2160, #1989)', () => {
  test('package.json declares the patch for the installed version', () => {
    const pkg = JSON.parse(fs.readFileSync(path.join(ROOT, 'package.json'), 'utf-8'));
    const version = installedPlaywrightCoreVersion();
    const key = `playwright-core@${version}`;
    expect(pkg.patchedDependencies).toBeDefined();
    // Version-keyed on purpose: if playwright is bumped without re-targeting
    // the patch, this fails with the exact key that needs regenerating.
    expect(pkg.patchedDependencies[key]).toBe(`patches/playwright-core@${version}.patch`);
  });

  test('the patch file exists and carries both windowsHide sites', () => {
    const version = installedPlaywrightCoreVersion();
    const patchPath = path.join(ROOT, 'patches', `playwright-core@${version}.patch`);
    expect(fs.existsSync(patchPath)).toBe(true);
    const patch = fs.readFileSync(patchPath, 'utf-8');
    // Launch spawnOptions site.
    expect(patch).toContain('+    windowsHide: true,');
    // taskkill force-kill site.
    expect(patch).toContain('shell: true, windowsHide: true');
  });

  test('bun.lock is coherent: the lockfile records the patched dependency', () => {
    const lock = fs.readFileSync(path.join(ROOT, 'bun.lock'), 'utf-8');
    const version = installedPlaywrightCoreVersion();
    expect(lock).toContain(`patches/playwright-core@${version}.patch`);
  });

  test('the INSTALLED tree actually has the patch applied (bun install ran it)', () => {
    const bundle = fs.readFileSync(
      path.join(ROOT, 'node_modules', 'playwright-core', 'lib', 'coreBundle.js'), 'utf-8',
    );
    expect(bundle).toContain('gstack patch (#2160/#1989)');
    expect(bundle).toContain('shell: true, windowsHide: true');
  });
});

// Windows Free Tests 40656299153 and 41056150287 (cookie-picker-ui, serial retry passed): goto failed with
// net::ERR_NO_BUFFER_SPACE on 127.0.0.1. Chromium's TcpPortRandomizationWin raises WSAENOBUFS with ports free;
// microsoft/playwright#43605 disables it in 1.65, and the patch backports that to the pinned version.
describe('playwright-core TcpPortRandomizationWin backport (microsoft/playwright#43605)', () => {
  test('the patch and the installed tree disable the feature in the --disable-features list', () => {
    const version = installedPlaywrightCoreVersion();
    expect(fs.readFileSync(path.join(ROOT, 'patches', `playwright-core@${version}.patch`), 'utf-8')).toContain('+      "TcpPortRandomizationWin"');
    const bundle = fs.readFileSync(path.join(ROOT, 'node_modules', 'playwright-core', 'lib', 'coreBundle.js'), 'utf-8');
    const list = bundle.slice(bundle.indexOf('disabledFeatures = ['), bundle.indexOf('].filter(Boolean);', bundle.indexOf('disabledFeatures = [')));
    expect(list).toContain('"TcpPortRandomizationWin"');
    expect(bundle).toContain('"--disable-features=" + disabledFeatures.join(",")');
  });
});