@gate-forge/pack-playwright 0.7.0 → 0.8.0

package/dist/discovery/playwright-runner-adapter.js

@@ -0,0 +1,185 @@
+/**
+ * The Playwright runner adapter behind the runner-neutral
+ * `RunnerAdapter` contract (plan 2026-09-25 phase 0).
+ *
+ * This is NOT a rewrite of the Playwright path: every call lands on the
+ * code the supervised run already used (`discoverTestCatalog`,
+ * `executeSupervisedPlaywright`, `parseOutcomesText`). Its job is to
+ * state the four jobs — enumerate, tag, execute, parse — in the shape
+ * every other runner will use, so the contract suite has something
+ * honest to grade (phase 0 acceptance: "the contract suite runs against
+ * the current Playwright path and passes").
+ *
+ * Compatibility: nothing here is on the supervised-run path. The
+ * existing `PlaywrightAdapter` (discovery/adapters.ts) keeps serving the
+ * CLI unchanged; this adapter is the contract-shaped view of the same
+ * machinery.
+ */
+import { loadConfig } from '@gate-forge/core';
+import { ENV_APP_BASE_URL, ENV_RUN_TOKEN, ENV_WITNESS_URL } from '../constants.js';
+import { discoverTestCatalog } from './discover.js';
+import { executeSupervisedPlaywright, parseOutcomesText } from './supervised-run.js';
+/**
+ * Per-test session variables a runner adapter publishes to the test.
+ *
+ * These are the values the trusted CLI resolves for ONE supervisor-
+ * opened session and hands to that test alone. They are new env NAMES
+ * (additive — the frozen Playwright child allowlist is untouched, so an
+ * existing Playwright user's run env is byte-identical); the Playwright
+ * fixture itself receives the same values through the supervisor's
+ * session-resolve response rather than through the environment.
+ */
+export const ENV_SESSION_ID = 'GATEFORGE_SESSION_ID';
+export const ENV_SESSION_TOKEN = 'GATEFORGE_SESSION_TOKEN';
+export const ENV_SESSION_PROXY_URL = 'GATEFORGE_SESSION_PROXY_URL';
+/** The variables that carry ONE test's identity to its traffic. */
+export const PLAYWRIGHT_IDENTITY_ENV = [
+    ENV_SESSION_ID,
+    ENV_SESSION_TOKEN,
+    ENV_SESSION_PROXY_URL,
+];
+/** Playwright behind the runner-neutral contract. */
+export class PlaywrightRunnerAdapter {
+    options;
+    runner = 'playwright';
+    capabilities = {
+        inventory: 'available',
+        resolveInstances: 'available',
+        execute: 'available',
+    };
+    constructor(options = {}) {
+        this.options = options;
+    }
+    /**
+     * Job 1: the expected set, fixed BEFORE the run (static scan
+     * reconciled against the native list).
+     *
+     * Args:
+     *   cwd: absolute repo root the playwright configuration lives under.
+     *
+     * Returns:
+     *   Promise<RunnerEnumeration>: the enumerated tests, or an
+     *   `unavailable` verdict. A project with no configured tests is
+     *   `unavailable`, never an empty `discovered` list: nothing executed
+     *   proves nothing.
+     */
+    async enumerate(cwd) {
+        let config;
+        try {
+            config = this.options.config ?? loadConfig(`${cwd}/.gateforge.yml`);
+        }
+        catch (error) {
+            return {
+                status: 'unavailable',
+                detail: `playwright enumeration could not load the gateforge config: ${describeError(error)}`,
+                tests: [],
+            };
+        }
+        let catalog;
+        try {
+            const discovered = await discoverTestCatalog({ cwd, config, ...this.options.discover });
+            catalog = discovered.catalog;
+        }
+        catch (error) {
+            return {
+                status: 'unavailable',
+                detail: `playwright enumeration failed: ${describeError(error)}`,
+                tests: [],
+            };
+        }
+        const tests = catalog.entries
+            .filter((entry) => entry.runner === 'playwright')
+            .map((entry) => ({
+            logicalKey: entry.logicalKey,
+            project: entry.project,
+            file: entry.file,
+            titlePath: entry.titlePath,
+            blockingAnnotations: [
+                ...new Set(entry.suppressionSignals
+                    .filter((signal) => signal.kind === 'only' || signal.kind === 'skip' || signal.kind === 'fixme')
+                    .map((signal) => signal.kind)),
+            ].sort(),
+            // The native reporter's own instance id (the same value the
+            // supervised registration path uses).
+            frameworkId: entry.parameterIdentity ?? undefined,
+        }))
+            .sort((a, b) => (a.logicalKey < b.logicalKey ? -1 : a.logicalKey > b.logicalKey ? 1 : 0));
+        if (tests.length === 0) {
+            return {
+                status: 'unavailable',
+                detail: `playwright enumeration found no tests under ${cwd} — a zero-test run never proves coverage`,
+                tests: [],
+            };
+        }
+        return { status: 'discovered', detail: `enumerated ${String(tests.length)} playwright test(s)`, tests };
+    }
+    /**
+     * Job 2: the per-test tag. Playwright's channel is the session proxy
+     * origin: the fixture resolves the supervisor-opened session for the
+     * current test and routes the page through that origin, so every
+     * exchange — absolute paths included — is attributed to THAT session.
+     *
+     * Args:
+     *   session: the test being tagged.
+     *   context: run-scoped, non-secret witness wiring.
+     *
+     * Returns:
+     *   RunnerChildEnv: the run identity plus the session-scoped tag.
+     */
+    childEnv(_session, context) {
+        return {
+            vars: {
+                [ENV_WITNESS_URL]: context.witnessUrl,
+                [ENV_RUN_TOKEN]: context.runToken,
+                [ENV_APP_BASE_URL]: context.appBaseUrl,
+                [ENV_SESSION_ID]: context.sessionId,
+                [ENV_SESSION_TOKEN]: context.sessionToken,
+                [ENV_SESSION_PROXY_URL]: context.sessionProxyUrl,
+            },
+            tagChannel: 'session-proxy',
+            identityVars: PLAYWRIGHT_IDENTITY_ENV,
+            mechanism: 'gateforge playwright fixture resolves the supervisor session for the running test and routes its page through the per-test session proxy origin',
+        };
+    }
+    /**
+     * Job 3: the supervised run (unchanged machinery, contract shape).
+     *
+     * Args:
+     *   request: the exact selection, run identity, and wall-clock bound.
+     *
+     * Returns:
+     *   Promise<RunnerExecutionEnvelope>: the structured outcome envelope.
+     */
+    async execute(request) {
+        return executeSupervisedPlaywright({ logicalKeys: request.logicalKeys }, { stateDir: request.stateDir, runId: request.runId, vars: {} }, {
+            cwd: request.cwd,
+            timeoutMs: request.timeoutMs,
+            // The project selection is part of the identity join key: a run
+            // that does not select the enumerated projects reports outcomes
+            // under different identities than the expected set was fixed
+            // with, and supervision (correctly) calls them unplanned.
+            ...(request.testLocations !== undefined ? { testLocations: request.testLocations } : {}),
+            ...(request.projects !== undefined ? { projects: request.projects } : {}),
+            ...this.options.run,
+        });
+    }
+    /**
+     * Job 4: the gateforge reporter's runner-outcomes document, through
+     * the SAME validation and mapping the supervised run uses.
+     *
+     * Args:
+     *   raw: the outcomes document JSON text plus the runner exit status.
+     *
+     * Returns:
+     *   RunnerExecutionEnvelope: reporter input, never a verdict. An
+     *   unreadable or malformed document is `complete: false`.
+     */
+    parseResults(raw) {
+        return parseOutcomesText(raw.report, raw.processExit);
+    }
+}
+/** Single-line message of an unknown thrown value. */
+function describeError(error) {
+    return error instanceof Error ? error.message : String(error);
+}
+//# sourceMappingURL=playwright-runner-adapter.js.map

package/dist/discovery/playwright-runner-adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright-runner-adapter.js","sourceRoot":"","sources":["../../src/discovery/playwright-runner-adapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,EAAE,UAAU,EAAwB,MAAM,kBAAkB,CAAC;AAYpE,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACnF,OAAO,EAAE,mBAAmB,EAAwB,MAAM,eAAe,CAAC;AAC1E,OAAO,EAAE,2BAA2B,EAAE,iBAAiB,EAA6B,MAAM,qBAAqB,CAAC;AAEhH;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,sBAAsB,CAAC;AACrD,MAAM,CAAC,MAAM,iBAAiB,GAAG,yBAAyB,CAAC;AAC3D,MAAM,CAAC,MAAM,qBAAqB,GAAG,6BAA6B,CAAC;AAEnE,mEAAmE;AACnE,MAAM,CAAC,MAAM,uBAAuB,GAAsB;IACxD,cAAc;IACd,iBAAiB;IACjB,qBAAqB;CACtB,CAAC;AAYF,qDAAqD;AACrD,MAAM,OAAO,uBAAuB;IASL;IARpB,MAAM,GAAG,YAAY,CAAC;IAEtB,YAAY,GAAG;QACtB,SAAS,EAAE,WAAW;QACtB,gBAAgB,EAAE,WAAW;QAC7B,OAAO,EAAE,WAAW;KACZ,CAAC;IAEX,YAA6B,UAA0C,EAAE;QAA5C,YAAO,GAAP,OAAO,CAAqC;IAAG,CAAC;IAE7E;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,SAAS,CAAC,GAAW;QACzB,IAAI,MAAM,CAAC;QACX,IAAI,CAAC;YACH,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,UAAU,CAAC,GAAG,GAAG,iBAAiB,CAAC,CAAC;QACtE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO;gBACL,MAAM,EAAE,aAAa;gBACrB,MAAM,EAAE,+DAA+D,aAAa,CAAC,KAAK,CAAC,EAAE;gBAC7F,KAAK,EAAE,EAAE;aACV,CAAC;QACJ,CAAC;QACD,IAAI,OAAO,CAAC;QACZ,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,MAAM,mBAAmB,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;YACxF,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;QAC/B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO;gBACL,MAAM,EAAE,aAAa;gBACrB,MAAM,EAAE,kCAAkC,aAAa,CAAC,KAAK,CAAC,EAAE;gBAChE,KAAK,EAAE,EAAE;aACV,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,GAAyB,OAAO,CAAC,OAAO;aAChD,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,YAAY,CAAC;aAChD,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YACf,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,mBAAmB,EAAE;gBACnB,GAAG,IAAI,GAAG,CACR,KAAK,CAAC,kBAAkB;qBACrB,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,MAAM,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC;qBAC/F,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAChC;aACF,CAAC,IAAI,EAAE;YACR,4DAA4D;YAC5D,sCAAsC;YACtC,WAAW,EAAE,KAAK,CAAC,iBAAiB,IAAI,SAAS;SAClD,CAAC,CAAC;aACF,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5F,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,OAAO;gBACL,MAAM,EAAE,aAAa;gBACrB,MAAM,EAAE,+CAA+C,GAAG,0CAA0C;gBACpG,KAAK,EAAE,EAAE;aACV,CAAC;QACJ,CAAC;QACD,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,cAAc,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,qBAAqB,EAAE,KAAK,EAAE,CAAC;IAC1G,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,QAA0B,EAAE,OAA8B;QACjE,OAAO;YACL,IAAI,EAAE;gBACJ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC,UAAU;gBACrC,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC,QAAQ;gBACjC,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC,UAAU;gBACtC,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC,SAAS;gBACnC,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC,YAAY;gBACzC,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC,eAAe;aACjD;YACD,UAAU,EAAE,eAAe;YAC3B,YAAY,EAAE,uBAAuB;YACrC,SAAS,EACP,iJAAiJ;SACpJ,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,OAAO,CAAC,OAA6B;QACzC,OAAO,2BAA2B,CAChC,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,EACpC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,EAC9D;YACE,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,gEAAgE;YAChE,gEAAgE;YAChE,6DAA6D;YAC7D,0DAA0D;YAC1D,GAAG,CAAC,OAAO,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACxF,GAAG,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACzE,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG;SACpB,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CAAC,GAAqB;QAChC,OAAO,iBAAiB,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC;IACxD,CAAC;CACF;AAED,sDAAsD;AACtD,SAAS,aAAa,CAAC,KAAc;IACnC,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChE,CAAC"}