@ralphralphai/playwright 1.7.0 → 1.9.0

package/README.md

@@ -23,7 +23,7 @@ pnpm exec playwright install chromium
 ```jsonc
 {
   "$schema": "./node_modules/@ralphralphai/config/schema/ralph.schema.json",
-  "screenSizes": [{ "width": 1280, "height": 720 }]
+  "screenSizes": [{ "width": 1280, "height": 720 }],
 }
 ```
 
@@ -33,11 +33,11 @@ for all fields.
 **2. Import `test` from this package and tag tests with `@ralph`:**
 
 ```ts
-import { test, expect } from '@ralphralphai/playwright';
+import { test, expect } from "@ralphralphai/playwright";
 
-test('checkout', { tag: '@ralph' }, async ({ page }) => {
-  await page.goto('https://example.com/cart');
-  await page.getByRole('link', { name: 'Checkout' }).click();
+test("checkout", { tag: "@ralph" }, async ({ page }) => {
+  await page.goto("https://example.com/cart");
+  await page.getByRole("link", { name: "Checkout" }).click();
   await expect(page).toHaveURL(/checkout/);
 });
 ```
@@ -46,7 +46,7 @@ test('checkout', { tag: '@ralph' }, async ({ page }) => {
 
 ```ts
 export default defineConfig({
-  reporter: [['list'], ['@ralphralphai/playwright/reporter']],
+  reporter: [["list"], ["@ralphralphai/playwright/reporter"]],
 });
 ```
 
@@ -100,9 +100,9 @@ page mid-transition. Call `ralph.recordNode` after your assertions to retake
 the screenshot of the node just recorded:
 
 ```ts
-test('cart', { tag: '@ralph' }, async ({ page, ralph }) => {
-  await page.goto('https://example.com/cart');
-  await expect(page.getByRole('list', { name: 'Items' })).toBeVisible();
+test("cart", { tag: "@ralph" }, async ({ page, ralph }) => {
+  await page.goto("https://example.com/cart");
+  await expect(page.getByRole("list", { name: "Items" })).toBeVisible();
 
   await ralph.recordNode(page);
 });
@@ -123,10 +123,10 @@ page state (an open dialog), declare what each screenshot stands for. The test i
 the only source of a node's conditions, including sets of values:
 
 ```ts
-await page.goto('https://example.com/checkout');
+await page.goto("https://example.com/checkout");
 const undo = await ralph.setNodeConditions(page, {
-  visitorTags: { plan: ['pro', 'enterprise'] },
-  pageTags: { dialog: [undefined, 'shipping'] }, // absent, or shipping
+  visitorTags: { plan: ["pro", "enterprise"] },
+  pageTags: { dialog: [undefined, "shipping"] }, // absent, or shipping
 });
 await undo();
 ```
@@ -145,9 +145,9 @@ screenshot is done, the page is `uncaptured`: it's in the graph without a
 screenshot. To make sure a page is captured before leaving it:
 
 ```ts
-await page.goto('https://example.com/pricing');
+await page.goto("https://example.com/pricing");
 await ralph.waitForCapture();
-await page.goto('https://example.com/signup');
+await page.goto("https://example.com/signup");
 ```
 
 ### Pausing capture
@@ -155,12 +155,12 @@ await page.goto('https://example.com/signup');
 To leave steps out of the graph:
 
 ```ts
-await page.goto('https://example.com/a');
+await page.goto("https://example.com/a");
 ralph.pause();
-await page.goto('https://example.com/b'); // not recorded
-await page.goto('https://example.com/c'); // not recorded
+await page.goto("https://example.com/b"); // not recorded
+await page.goto("https://example.com/c"); // not recorded
 ralph.resume();
-await page.goto('https://example.com/d'); // recorded, linked from /a
+await page.goto("https://example.com/d"); // recorded, linked from /a
 ```
 
 This works across tabs. While paused, `recordNode` does nothing. `resume` does
@@ -176,6 +176,22 @@ await ralph.waitForCapture();
 await context.close();
 ```
 
+### What happened between two nodes
+
+The Playwright actions a test takes on the way from one node to the next are
+recorded on the edge between them: clicks, hovers, fills, key presses,
+selects, uploads, drags, and `goto` / back / forward / reload. Each one keeps
+the element it landed on (its role, name, and `data-track-id`) and where that
+element was on the earlier node's screenshot, which Ralph shows as, e.g.,
+`Click button "Checkout"`.
+
+What was typed into a password or one-time-code field is never recorded.
+Actions taken while recording is paused are left out.
+
+Pass an `edgeLabel` to describe the step in your own words, e.g.
+`ralph.recordNode(page, { name: 'Done', edgeLabel: 'Sign in' })`. A later call
+without one keeps it.
+
 ### When recording fails
 
 - A failed `recordNode` call rejects.
@@ -187,9 +203,9 @@ await context.close();
 
 Set with `RALPH_MODE` or the `mode` option:
 
-| Mode     | What happens                                                                                    |
-| -------- | ----------------------------------------------------------------------------------------------- |
-| `off`    | Default. Nothing is recorded, and no config or credentials are needed.                          |
+| Mode     | What happens                                                                                           |
+| -------- | ------------------------------------------------------------------------------------------------------ |
+| `off`    | Default. Nothing is recorded, and no config or credentials are needed.                                 |
 | `upload` | `@ralph` tests are recorded, and the reporter uploads the run. Default when `RALPH_UPLOAD_KEY` is set. |
 
 Untagged tests are never recorded. In `upload` mode, calling
@@ -203,10 +219,10 @@ instead, for helpers shared between tagged and untagged tests.
 2. Set these as environment variables, or `appId` as
    [reporter options](#reporter-options):
 
-   | Variable           | Value                                              |
-   | ------------------ | -------------------------------------------------- |
-   | `RALPH_UPLOAD_KEY` | The upload key. Environment only.                  |
-   | `RALPH_APP_ID`     | The app the recordings belong to.                  |
+   | Variable           | Value                             |
+   | ------------------ | --------------------------------- |
+   | `RALPH_UPLOAD_KEY` | The upload key. Environment only. |
+   | `RALPH_APP_ID`     | The app the recordings belong to. |
 
 3. Run:
 
@@ -236,22 +252,53 @@ RALPH_MODE=upload RALPH_UPLOAD_KEY=… RALPH_APP_ID=… \
   pnpm exec playwright merge-reports --reporter @ralphralphai/playwright/reporter ./all-blob-reports
 ```
 
+### Deployments
+
+When you deploy, upload the run as the graph of the deployed build. Ralph then
+matches tracker events from that build to it.
+
+Set `RALPH_DEPLOY=1` and `RALPH_BUILD_ID` to the build's id, usually the commit
+SHA:
+
+```sh
+RALPH_MODE=upload RALPH_DEPLOY=1 RALPH_BUILD_ID="$COMMIT_SHA" \
+  RALPH_UPLOAD_KEY=… RALPH_APP_ID=… pnpm exec playwright test
+```
+
+If the build goes live before the test run finishes, register it first so the
+tracker picks up its config right away:
+
+```sh
+curl --fail-with-body -X POST https://api.ralphralph.ai/api/upload/deployment/register \
+  -H "Authorization: Bearer $RALPH_UPLOAD_KEY" -H 'content-type: application/json' \
+  -d "{\"externalAppId\":\"$RALPH_APP_ID\",\"buildId\":\"$COMMIT_SHA\",
+       \"reserveArtifact\":false,\"config\":$(cat ralph.json)}"
+```
+
+`ralph.json` here is your `ralph.jsonc` as plain JSON, without comments or
+trailing commas. The test run that follows registers the same build again and
+uploads into it.
+
 ## Screen sizes
 
 Use `ralphProjects` to create one project per entry in `screenSizes`:
 
 ```ts
-import { defineConfig, devices } from '@playwright/test';
-import { ralphProjects, type RalphFixtures } from '@ralphralphai/playwright';
+import { defineConfig, devices } from "@playwright/test";
+import { ralphProjects, type RalphFixtures } from "@ralphralphai/playwright";
 
 export default defineConfig<RalphFixtures>({
   projects: [
-    { name: 'chromium', grepInvert: /@ralph\b/, use: devices['Desktop Chrome'] },
+    {
+      name: "chromium",
+      grepInvert: /@ralph\b/,
+      use: devices["Desktop Chrome"],
+    },
     // Creates "chromium 375x812", "chromium 1280x720", …
     ...ralphProjects({
-      name: 'chromium',
+      name: "chromium",
       grep: /@ralph\b/,
-      use: devices['Desktop Chrome'],
+      use: devices["Desktop Chrome"],
     }),
   ],
 });
@@ -264,12 +311,16 @@ A test runs at every size. To run it only at some sizes, tag it or its
 `describe` block with `@ralph-screen:WIDTHxHEIGHT`, once per size:
 
 ```ts
-test('mobile navigation', { tag: ['@ralph', '@ralph-screen:375x812'] }, async ({ page }) => {
-  await page.getByRole('button', { name: 'Menu' }).click();
-});
+test(
+  "mobile navigation",
+  { tag: ["@ralph", "@ralph-screen:375x812"] },
+  async ({ page }) => {
+    await page.getByRole("button", { name: "Menu" }).click();
+  },
+);
 
-test.describe('desktop layouts', { tag: '@ralph-screen:1280x720' }, () => {
-  test('sidebar', { tag: '@ralph' }, async ({ page }) => {});
+test.describe("desktop layouts", { tag: "@ralph-screen:1280x720" }, () => {
+  test("sidebar", { tag: "@ralph" }, async ({ page }) => {});
 });
 ```
 
@@ -289,19 +340,19 @@ export default defineConfig<RalphFixtures>({
 });
 ```
 
-| Option            | Default                  | What it does                                                                                    |
-| ----------------- | ------------------------ | ----------------------------------------------------------------------------------------------- |
-| `mode`            | `RALPH_MODE`, else `off` | `off` or `upload`. See [Modes](#modes).                                                         |
-| `configPath`      | `ralph.jsonc`            | Path to the config, relative to the Playwright config.                                          |
-| `config`          |                          | An inline config instead of a file (type: `WebRalphConfig`).                                    |
-| `buildId`         | `RALPH_BUILD_ID`         | Your app's build, to line up recordings with its analytics.                                     |
-| `runId`           | `RALPH_RUN_ID`           | Identifies the CI run.                                                                          |
-| `settleMs`        | 150                      | Wait after the DOM loads before an automatic recording.                                         |
-| `recordTimeoutMs` | 5000                     | Budget for one recording, including `settleMs` and `ready`. Must exceed `settleMs`.             |
-| `ready`           |                          | `(page, signal) => Promise<void>`. Waits for your app before an automatic recording. Honor `signal`. |
-| `reduceMotion`    | `false`                  | Emulates `prefers-reduced-motion: reduce` and waits for finite animations before recording.     |
-| `strictNodeTags`  | `false`                  | Fails the test when the app reports a tag outside what `ralph.setNodeConditions` declared.      |
-| `ignoreUntaggedCalls` | `false`              | Makes `recordNode`, `setNodeConditions`, and `observe` no-ops in untagged tests instead of throwing. |
+| Option                | Default                  | What it does                                                                                         |
+| --------------------- | ------------------------ | ---------------------------------------------------------------------------------------------------- |
+| `mode`                | `RALPH_MODE`, else `off` | `off` or `upload`. See [Modes](#modes).                                                              |
+| `configPath`          | `ralph.jsonc`            | Path to the config, relative to the Playwright config.                                               |
+| `config`              |                          | An inline config instead of a file (type: `WebRalphConfig`).                                         |
+| `buildId`             | `RALPH_BUILD_ID`         | Your app's build, to line up recordings with its analytics.                                          |
+| `runId`               | `RALPH_RUN_ID`           | Identifies the CI run.                                                                               |
+| `settleMs`            | 150                      | Wait after the DOM loads before an automatic recording.                                              |
+| `recordTimeoutMs`     | 5000                     | Budget for one recording, including `settleMs` and `ready`. Must exceed `settleMs`.                  |
+| `ready`               |                          | `(page, signal) => Promise<void>`. Waits for your app before an automatic recording. Honor `signal`. |
+| `reduceMotion`        | `false`                  | Emulates `prefers-reduced-motion: reduce` and waits for finite animations before recording.          |
+| `strictNodeTags`      | `false`                  | Fails the test when the app reports a tag outside what `ralph.setNodeConditions` declared.           |
+| `ignoreUntaggedCalls` | `false`                  | Makes `recordNode`, `setNodeConditions`, and `observe` no-ops in untagged tests instead of throwing. |
 
 ## Reporter options
 
@@ -309,12 +360,13 @@ export default defineConfig<RalphFixtures>({
 reporter: [['list'], ['@ralphralphai/playwright/reporter', { appId: 'my-app' }]],
 ```
 
-| Option            | Default                                           | What it does                                    |
-| ----------------- | ------------------------------------------------- | ----------------------------------------------- |
-| `mode`            | `RALPH_MODE`, else `upload` if `RALPH_UPLOAD_KEY` | `upload` uploads the run.                       |
-| `appId`           | `RALPH_APP_ID`                                    | The app the recordings belong to.               |
-| `uploadTimeoutMs` | 120000                                            | Upload timeout.                                 |
-| `outputDir`       | `ralph/` in the first project's output directory  | Where the merged graph is written.              |
+| Option            | Default                                           | What it does                                                     |
+| ----------------- | ------------------------------------------------- | ---------------------------------------------------------------- |
+| `mode`            | `RALPH_MODE`, else `upload` if `RALPH_UPLOAD_KEY` | `upload` uploads the run.                                        |
+| `appId`           | `RALPH_APP_ID`                                    | The app the recordings belong to.                                |
+| `uploadTimeoutMs` | 120000                                            | Upload timeout.                                                  |
+| `deploy`          | `RALPH_DEPLOY` is `1`                             | Uploads the run as its build's. See [Deployments](#deployments). |
+| `outputDir`       | `ralph/` in the first project's output directory  | Where the merged graph is written.                               |
 
 The run is also uploaded when any test ran in `upload` mode.
 

package/dist/index.cjs

@@ -1,5 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_upload = require("./upload-ZMnTCjs2.cjs");
+const require_upload = require("./upload-BQSCs8By.cjs");
 let node_path = require("node:path");
 node_path = require_upload.__toESM(node_path, 1);
 let _playwright_test = require("@playwright/test");
@@ -63,7 +63,7 @@ const test = _playwright_test.test.extend({
 		applyScreenSelection(testInfo);
 		await use();
 	}, { auto: true }],
-	_ralphRecorder: [async ({ ralphOptions, _ralphConfigs, _ralphScreen }, use, testInfo) => {
+	_ralphRecorder: [async ({ ralphOptions, _ralphConfigs, _ralphScreen, playwright }, use, testInfo) => {
 		const mode = require_upload.resolveMode(ralphOptions);
 		if (!testInfo.tags.includes("@ralph") || mode === "off") {
 			await use(null);
@@ -82,7 +82,7 @@ const test = _playwright_test.test.extend({
 			pending = require_upload.loadConfig(ralphOptions, root);
 			_ralphConfigs.set(key, pending);
 		}
-		const recorder = new require_upload.Recorder(ralphOptions, await pending, testInfo, mode);
+		const recorder = new require_upload.Recorder(ralphOptions, await pending, testInfo, mode, playwright);
 		try {
 			await use(recorder);
 		} finally {

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":["loadConfigSync","base","resolveMode","path","loadConfig","Recorder"],"sources":["../src/screens.ts","../src/index.ts"],"sourcesContent":["import type {\n  PlaywrightTestOptions,\n  PlaywrightWorkerOptions,\n  Project,\n  TestInfo,\n} from '@playwright/test';\nimport type { ScreenSize } from '@ralphralphai/config';\n\nimport { loadConfigSync } from './config';\nimport type { RalphOptions } from './types';\n\ntype RalphProject = Project<\n  PlaywrightTestOptions & { ralphOptions: RalphOptions },\n  PlaywrightWorkerOptions\n>;\n\nexport const SCREEN_TAG_PREFIX = '@ralph-screen:';\n\nexport type RalphProjectOptions = Pick<\n  RalphOptions,\n  'config' | 'configPath'\n> & {\n  /** Resolves a relative `configPath`; defaults to the current directory. */\n  root?: string;\n};\n\ntype ScreenMetadata = { screenSize: ScreenSize; screenSizes: ScreenSize[] };\n\nexport function screenLabel(size: ScreenSize): string {\n  return size.width + 'x' + size.height;\n}\n\n/**\n * Expands `base` into one project per `screenSizes` entry of the Ralph config.\n * Each project's viewport is that screen size.\n */\nexport function ralphProjects(\n  base: RalphProject = {},\n  options: RalphProjectOptions = {},\n): RalphProject[] {\n  const { screenSizes } = loadConfigSync(\n    options,\n    options.root ?? process.cwd(),\n  ).config;\n  if (!screenSizes.length) {\n    throw new Error('The Ralph config declares no screenSizes.');\n  }\n  return screenSizes.map((screenSize) => {\n    const label = screenLabel(screenSize);\n    const ralph: ScreenMetadata = { screenSize, screenSizes };\n    return {\n      ...base,\n      name: base.name ? base.name + ' ' + label : label,\n      use: {\n        ...base.use,\n        viewport: { width: screenSize.width, height: screenSize.height },\n      },\n      metadata: { ...base.metadata, ralph },\n    };\n  });\n}\n\n/**\n * Skips a test whose `@ralph-screen:WxH` tags exclude the current project's\n * screen size. Untagged tests run at every size; other projects are untouched.\n */\nexport function applyScreenSelection(testInfo: TestInfo): void {\n  const selected = testInfo.tags\n    .filter((tag) => tag.startsWith(SCREEN_TAG_PREFIX))\n    .map((tag) => tag.slice(SCREEN_TAG_PREFIX.length));\n  const metadata = (testInfo.project.metadata as { ralph?: ScreenMetadata })\n    .ralph;\n  if (!selected.length || !metadata) {\n    return;\n  }\n  const known = metadata.screenSizes.map(screenLabel);\n  const unknown = selected.filter((label) => !known.includes(label));\n  if (unknown.length) {\n    throw new Error(\n      'Unknown Ralph screen size ' +\n        unknown.join(', ') +\n        '; the config declares ' +\n        known.join(', ') +\n        '.',\n    );\n  }\n  const current = screenLabel(metadata.screenSize);\n  testInfo.skip(\n    !selected.includes(current),\n    'Not selected for Ralph screen size ' + current + '.',\n  );\n}\n","import path from 'node:path';\n\nimport { test as base } from '@playwright/test';\nimport type {\n  PlaywrightTestArgs,\n  PlaywrightTestOptions,\n  PlaywrightWorkerArgs,\n  PlaywrightWorkerOptions,\n  TestType,\n} from '@playwright/test';\n\nimport { loadConfig, resolveMode } from './config';\nimport { Recorder, REPORTER_ENV } from './recorder';\nimport { applyScreenSelection } from './screens';\nimport type { ConfigSnapshot, Ralph, RalphOptions } from './types';\n\nexport { expect, mergeTests } from '@playwright/test';\nexport type { WebRalphConfig } from '@ralphralphai/config';\nexport {\n  createRawGraphBundle,\n  prepareArtifactUpload,\n  uploadRawGraph,\n} from './upload';\nexport type {\n  PreparedUpload,\n  UploadOptions,\n  UploadReceipt,\n  RawGraphScreenshot,\n  RawGraphBundleIndex,\n} from './upload';\nexport { MANIFEST_ATTACHMENT } from './recorder';\nexport { ralphProjects, SCREEN_TAG_PREFIX } from './screens';\nexport type { RalphProjectOptions } from './screens';\nexport type { RalphReporterOptions } from './reporter';\nexport type {\n  RawGraphManifest,\n  RawGraph,\n  RawGraphFile,\n  RawPage,\n  RawNode,\n  ConditionsDeclaration,\n  NodeConditions,\n  RecordedTags,\n  RecordNodeOptions,\n  TagConditions,\n  TagDeclaration,\n  TagValue,\n  ConfigSnapshot,\n  PageLayout,\n  Ralph,\n  RalphOptions,\n  TrackedElement,\n} from './types';\n\nexport type RalphFixtures = { ralph: Ralph; ralphOptions: RalphOptions };\n\ntype InternalFixtures = {\n  _ralphScreen: void;\n  _ralphRecorder: Recorder | null;\n};\ntype WorkerFixtures = { _ralphConfigs: Map<string, Promise<ConfigSnapshot>> };\n\nexport const test: TestType<\n  PlaywrightTestArgs & PlaywrightTestOptions & RalphFixtures,\n  PlaywrightWorkerArgs & PlaywrightWorkerOptions\n> = base.extend<RalphFixtures & InternalFixtures, WorkerFixtures>({\n  ralphOptions: [{}, { option: true }],\n  _ralphConfigs: [\n    // Playwright requires destructuring here to discover fixture dependencies.\n    // oxlint-disable-next-line no-empty-pattern\n    async ({}, use) => {\n      await use(new Map());\n    },\n    { scope: 'worker' },\n  ],\n  _ralphScreen: [\n    // Playwright requires destructuring here to discover fixture dependencies.\n    // oxlint-disable-next-line no-empty-pattern\n    async ({}, use, testInfo) => {\n      // Screen selection chooses which flows run, so it applies in every mode.\n      applyScreenSelection(testInfo);\n      await use();\n    },\n    { auto: true },\n  ],\n  _ralphRecorder: [\n    // _ralphScreen is specified here so that the playwright treat that it is\n    // a dependency of this fixture.\n    async ({ ralphOptions, _ralphConfigs, _ralphScreen }, use, testInfo) => {\n      const mode = resolveMode(ralphOptions);\n      if (!testInfo.tags.includes('@ralph') || mode === 'off') {\n        await use(null);\n        return;\n      }\n\n      // A sharded run's blob reports are merged, and uploaded by the Ralph\n      // reporter, in `playwright merge-reports`.\n      const reported =\n        process.env[REPORTER_ENV] ||\n        testInfo.config.reporter.some(([name]) => name === 'blob');\n      if (mode === 'upload' && !reported) {\n        throw new Error(\n          \"Ralph uploads one merged graph per run from its reporter. Add ['@ralphralphai/playwright/reporter'] to `reporter` in playwright.config, or use the blob reporter and merge-reports when sharding.\",\n        );\n      }\n\n      const root = testInfo.config.configFile\n        ? path.dirname(testInfo.config.configFile)\n        : process.cwd();\n\n      const key = JSON.stringify({\n        root,\n        config: ralphOptions.config,\n        configPath: ralphOptions.configPath,\n      });\n\n      let pending = _ralphConfigs.get(key);\n      if (!pending) {\n        pending = loadConfig(ralphOptions, root);\n        _ralphConfigs.set(key, pending);\n      }\n\n      const recorder = new Recorder(\n        ralphOptions,\n        await pending,\n        testInfo,\n        mode,\n      );\n\n      try {\n        await use(recorder);\n      } finally {\n        await recorder.finish();\n      }\n    },\n    { auto: true, timeout: 30_000 },\n  ],\n  ralph: async ({ _ralphRecorder, ralphOptions }, use) => {\n    const checkOptIn = () => {\n      if (\n        resolveMode(ralphOptions) !== 'off' &&\n        !ralphOptions.ignoreUntaggedCalls\n      ) {\n        throw new Error('Opt this test into Ralph with the @ralph tag.');\n      }\n    };\n\n    await use(\n      _ralphRecorder ?? {\n        recordNode: async () => {\n          checkOptIn();\n        },\n        setNodeConditions: async () => {\n          checkOptIn();\n          return async () => {};\n        },\n        waitForCapture: async () => {},\n        pause: () => {},\n        resume: () => {},\n        observe: () => {\n          checkOptIn();\n        },\n      },\n    );\n  },\n  // On the context rather than per page, so popups start out reduced too.\n  contextOptions: async ({ contextOptions, ralphOptions }, use, testInfo) => {\n    const recording =\n      testInfo.tags.includes('@ralph') && resolveMode(ralphOptions) !== 'off';\n    await use(\n      recording && ralphOptions.reduceMotion\n        ? { ...contextOptions, reducedMotion: 'reduce' }\n        : contextOptions,\n    );\n  },\n  context: async ({ context, _ralphRecorder }, use) => {\n    _ralphRecorder?.observe(context);\n    try {\n      await use(context);\n    } finally {\n      // The base context fixture closes its pages next; pending recordings still need them alive.\n      await _ralphRecorder?.stopContext(context);\n    }\n  },\n});\n"],"mappings":";;;;;;AAgBA,MAAa,oBAAoB;AAYjC,SAAgB,YAAY,MAA0B;CACpD,OAAO,KAAK,QAAQ,MAAM,KAAK;AACjC;;;;;AAMA,SAAgB,cACd,OAAqB,CAAC,GACtB,UAA+B,CAAC,GAChB;CAChB,MAAM,EAAE,gBAAgBA,eAAAA,eACtB,SACA,QAAQ,QAAQ,QAAQ,IAAI,CAC9B,CAAC,CAAC;CACF,IAAI,CAAC,YAAY,QACf,MAAM,IAAI,MAAM,2CAA2C;CAE7D,OAAO,YAAY,KAAK,eAAe;EACrC,MAAM,QAAQ,YAAY,UAAU;EACpC,MAAM,QAAwB;GAAE;GAAY;EAAY;EACxD,OAAO;GACL,GAAG;GACH,MAAM,KAAK,OAAO,KAAK,OAAO,MAAM,QAAQ;GAC5C,KAAK;IACH,GAAG,KAAK;IACR,UAAU;KAAE,OAAO,WAAW;KAAO,QAAQ,WAAW;IAAO;GACjE;GACA,UAAU;IAAE,GAAG,KAAK;IAAU;GAAM;EACtC;CACF,CAAC;AACH;;;;;AAMA,SAAgB,qBAAqB,UAA0B;CAC7D,MAAM,WAAW,SAAS,KACvB,QAAQ,QAAQ,IAAI,WAAW,iBAAiB,CAAC,CAAC,CAClD,KAAK,QAAQ,IAAI,MAAM,EAAwB,CAAC;CACnD,MAAM,WAAY,SAAS,QAAQ,SAChC;CACH,IAAI,CAAC,SAAS,UAAU,CAAC,UACvB;CAEF,MAAM,QAAQ,SAAS,YAAY,IAAI,WAAW;CAClD,MAAM,UAAU,SAAS,QAAQ,UAAU,CAAC,MAAM,SAAS,KAAK,CAAC;CACjE,IAAI,QAAQ,QACV,MAAM,IAAI,MACR,+BACE,QAAQ,KAAK,IAAI,IACjB,2BACA,MAAM,KAAK,IAAI,IACf,GACJ;CAEF,MAAM,UAAU,YAAY,SAAS,UAAU;CAC/C,SAAS,KACP,CAAC,SAAS,SAAS,OAAO,GAC1B,wCAAwC,UAAU,GACpD;AACF;;;AC7BA,MAAa,OAGTC,iBAAAA,KAAK,OAAyD;CAChE,cAAc,CAAC,CAAC,GAAG,EAAE,QAAQ,KAAK,CAAC;CACnC,eAAe,CAGb,OAAO,IAAI,QAAQ;EACjB,MAAM,oBAAI,IAAI,IAAI,CAAC;CACrB,GACA,EAAE,OAAO,SAAS,CACpB;CACA,cAAc,CAGZ,OAAO,IAAI,KAAK,aAAa;EAE3B,qBAAqB,QAAQ;EAC7B,MAAM,IAAI;CACZ,GACA,EAAE,MAAM,KAAK,CACf;CACA,gBAAgB,CAGd,OAAO,EAAE,cAAc,eAAe,gBAAgB,KAAK,aAAa;EACtE,MAAM,OAAOC,eAAAA,YAAY,YAAY;EACrC,IAAI,CAAC,SAAS,KAAK,SAAS,QAAQ,KAAK,SAAS,OAAO;GACvD,MAAM,IAAI,IAAI;GACd;EACF;EAIA,MAAM,WACJ,QAAQ,IAAA,gCACR,SAAS,OAAO,SAAS,MAAM,CAAC,UAAU,SAAS,MAAM;EAC3D,IAAI,SAAS,YAAY,CAAC,UACxB,MAAM,IAAI,MACR,mMACF;EAGF,MAAM,OAAO,SAAS,OAAO,aACzBC,UAAAA,QAAK,QAAQ,SAAS,OAAO,UAAU,IACvC,QAAQ,IAAI;EAEhB,MAAM,MAAM,KAAK,UAAU;GACzB;GACA,QAAQ,aAAa;GACrB,YAAY,aAAa;EAC3B,CAAC;EAED,IAAI,UAAU,cAAc,IAAI,GAAG;EACnC,IAAI,CAAC,SAAS;GACZ,UAAUC,eAAAA,WAAW,cAAc,IAAI;GACvC,cAAc,IAAI,KAAK,OAAO;EAChC;EAEA,MAAM,WAAW,IAAIC,eAAAA,SACnB,cACA,MAAM,SACN,UACA,IACF;EAEA,IAAI;GACF,MAAM,IAAI,QAAQ;EACpB,UAAU;GACR,MAAM,SAAS,OAAO;EACxB;CACF,GACA;EAAE,MAAM;EAAM,SAAS;CAAO,CAChC;CACA,OAAO,OAAO,EAAE,gBAAgB,gBAAgB,QAAQ;EACtD,MAAM,mBAAmB;GACvB,IACEH,eAAAA,YAAY,YAAY,MAAM,SAC9B,CAAC,aAAa,qBAEd,MAAM,IAAI,MAAM,+CAA+C;EAEnE;EAEA,MAAM,IACJ,kBAAkB;GAChB,YAAY,YAAY;IACtB,WAAW;GACb;GACA,mBAAmB,YAAY;IAC7B,WAAW;IACX,OAAO,YAAY,CAAC;GACtB;GACA,gBAAgB,YAAY,CAAC;GAC7B,aAAa,CAAC;GACd,cAAc,CAAC;GACf,eAAe;IACb,WAAW;GACb;EACF,CACF;CACF;CAEA,gBAAgB,OAAO,EAAE,gBAAgB,gBAAgB,KAAK,aAAa;EAGzE,MAAM,IADJ,SAAS,KAAK,SAAS,QAAQ,KAAKA,eAAAA,YAAY,YAAY,MAAM,SAErD,aAAa,eACtB;GAAE,GAAG;GAAgB,eAAe;EAAS,IAC7C,cACN;CACF;CACA,SAAS,OAAO,EAAE,SAAS,kBAAkB,QAAQ;EACnD,gBAAgB,QAAQ,OAAO;EAC/B,IAAI;GACF,MAAM,IAAI,OAAO;EACnB,UAAU;GAER,MAAM,gBAAgB,YAAY,OAAO;EAC3C;CACF;AACF,CAAC"}
+{"version":3,"file":"index.cjs","names":["loadConfigSync","base","resolveMode","path","loadConfig","Recorder"],"sources":["../src/screens.ts","../src/index.ts"],"sourcesContent":["import type {\n  PlaywrightTestOptions,\n  PlaywrightWorkerOptions,\n  Project,\n  TestInfo,\n} from '@playwright/test';\nimport type { ScreenSize } from '@ralphralphai/config';\n\nimport { loadConfigSync } from './config';\nimport type { RalphOptions } from './types';\n\ntype RalphProject = Project<\n  PlaywrightTestOptions & { ralphOptions: RalphOptions },\n  PlaywrightWorkerOptions\n>;\n\nexport const SCREEN_TAG_PREFIX = '@ralph-screen:';\n\nexport type RalphProjectOptions = Pick<\n  RalphOptions,\n  'config' | 'configPath'\n> & {\n  /** Resolves a relative `configPath`; defaults to the current directory. */\n  root?: string;\n};\n\ntype ScreenMetadata = { screenSize: ScreenSize; screenSizes: ScreenSize[] };\n\nexport function screenLabel(size: ScreenSize): string {\n  return size.width + 'x' + size.height;\n}\n\n/**\n * Expands `base` into one project per `screenSizes` entry of the Ralph config.\n * Each project's viewport is that screen size.\n */\nexport function ralphProjects(\n  base: RalphProject = {},\n  options: RalphProjectOptions = {},\n): RalphProject[] {\n  const { screenSizes } = loadConfigSync(\n    options,\n    options.root ?? process.cwd(),\n  ).config;\n  if (!screenSizes.length) {\n    throw new Error('The Ralph config declares no screenSizes.');\n  }\n  return screenSizes.map((screenSize) => {\n    const label = screenLabel(screenSize);\n    const ralph: ScreenMetadata = { screenSize, screenSizes };\n    return {\n      ...base,\n      name: base.name ? base.name + ' ' + label : label,\n      use: {\n        ...base.use,\n        viewport: { width: screenSize.width, height: screenSize.height },\n      },\n      metadata: { ...base.metadata, ralph },\n    };\n  });\n}\n\n/**\n * Skips a test whose `@ralph-screen:WxH` tags exclude the current project's\n * screen size. Untagged tests run at every size; other projects are untouched.\n */\nexport function applyScreenSelection(testInfo: TestInfo): void {\n  const selected = testInfo.tags\n    .filter((tag) => tag.startsWith(SCREEN_TAG_PREFIX))\n    .map((tag) => tag.slice(SCREEN_TAG_PREFIX.length));\n  const metadata = (testInfo.project.metadata as { ralph?: ScreenMetadata })\n    .ralph;\n  if (!selected.length || !metadata) {\n    return;\n  }\n  const known = metadata.screenSizes.map(screenLabel);\n  const unknown = selected.filter((label) => !known.includes(label));\n  if (unknown.length) {\n    throw new Error(\n      'Unknown Ralph screen size ' +\n        unknown.join(', ') +\n        '; the config declares ' +\n        known.join(', ') +\n        '.',\n    );\n  }\n  const current = screenLabel(metadata.screenSize);\n  testInfo.skip(\n    !selected.includes(current),\n    'Not selected for Ralph screen size ' + current + '.',\n  );\n}\n","import path from 'node:path';\n\nimport { test as base } from '@playwright/test';\nimport type {\n  PlaywrightTestArgs,\n  PlaywrightTestOptions,\n  PlaywrightWorkerArgs,\n  PlaywrightWorkerOptions,\n  TestType,\n} from '@playwright/test';\n\nimport { loadConfig, resolveMode } from './config';\nimport { Recorder, REPORTER_ENV } from './recorder';\nimport { applyScreenSelection } from './screens';\nimport type { ConfigSnapshot, Ralph, RalphOptions } from './types';\n\nexport { expect, mergeTests } from '@playwright/test';\nexport type { WebRalphConfig } from '@ralphralphai/config';\nexport {\n  createRawGraphBundle,\n  prepareArtifactUpload,\n  uploadRawGraph,\n} from './upload';\nexport type {\n  PreparedUpload,\n  UploadOptions,\n  UploadReceipt,\n  RawGraphScreenshot,\n  RawGraphBundleIndex,\n} from './upload';\nexport { MANIFEST_ATTACHMENT } from './recorder';\nexport { ralphProjects, SCREEN_TAG_PREFIX } from './screens';\nexport type { RalphProjectOptions } from './screens';\nexport type { RalphReporterOptions } from './reporter';\nexport type {\n  RawGraphManifest,\n  RawGraph,\n  RawGraphFile,\n  RawPage,\n  RawNode,\n  RawAction,\n  ActionKind,\n  ActionTarget,\n  ConditionsDeclaration,\n  NodeConditions,\n  RecordedTags,\n  RecordNodeOptions,\n  TagConditions,\n  TagDeclaration,\n  TagValue,\n  ConfigSnapshot,\n  PageLayout,\n  Ralph,\n  RalphOptions,\n  TrackedElement,\n} from './types';\n\nexport type RalphFixtures = { ralph: Ralph; ralphOptions: RalphOptions };\n\ntype InternalFixtures = {\n  _ralphScreen: void;\n  _ralphRecorder: Recorder | null;\n};\ntype WorkerFixtures = { _ralphConfigs: Map<string, Promise<ConfigSnapshot>> };\n\nexport const test: TestType<\n  PlaywrightTestArgs & PlaywrightTestOptions & RalphFixtures,\n  PlaywrightWorkerArgs & PlaywrightWorkerOptions\n> = base.extend<RalphFixtures & InternalFixtures, WorkerFixtures>({\n  ralphOptions: [{}, { option: true }],\n  _ralphConfigs: [\n    // Playwright requires destructuring here to discover fixture dependencies.\n    // oxlint-disable-next-line no-empty-pattern\n    async ({}, use) => {\n      await use(new Map());\n    },\n    { scope: 'worker' },\n  ],\n  _ralphScreen: [\n    // Playwright requires destructuring here to discover fixture dependencies.\n    // oxlint-disable-next-line no-empty-pattern\n    async ({}, use, testInfo) => {\n      // Screen selection chooses which flows run, so it applies in every mode.\n      applyScreenSelection(testInfo);\n      await use();\n    },\n    { auto: true },\n  ],\n  _ralphRecorder: [\n    // _ralphScreen is specified here so that the playwright treat that it is\n    // a dependency of this fixture.\n    async (\n      { ralphOptions, _ralphConfigs, _ralphScreen, playwright },\n      use,\n      testInfo,\n    ) => {\n      const mode = resolveMode(ralphOptions);\n      if (!testInfo.tags.includes('@ralph') || mode === 'off') {\n        await use(null);\n        return;\n      }\n\n      // A sharded run's blob reports are merged, and uploaded by the Ralph\n      // reporter, in `playwright merge-reports`.\n      const reported =\n        process.env[REPORTER_ENV] ||\n        testInfo.config.reporter.some(([name]) => name === 'blob');\n      if (mode === 'upload' && !reported) {\n        throw new Error(\n          \"Ralph uploads one merged graph per run from its reporter. Add ['@ralphralphai/playwright/reporter'] to `reporter` in playwright.config, or use the blob reporter and merge-reports when sharding.\",\n        );\n      }\n\n      const root = testInfo.config.configFile\n        ? path.dirname(testInfo.config.configFile)\n        : process.cwd();\n\n      const key = JSON.stringify({\n        root,\n        config: ralphOptions.config,\n        configPath: ralphOptions.configPath,\n      });\n\n      let pending = _ralphConfigs.get(key);\n      if (!pending) {\n        pending = loadConfig(ralphOptions, root);\n        _ralphConfigs.set(key, pending);\n      }\n\n      const recorder = new Recorder(\n        ralphOptions,\n        await pending,\n        testInfo,\n        mode,\n        playwright,\n      );\n\n      try {\n        await use(recorder);\n      } finally {\n        await recorder.finish();\n      }\n    },\n    { auto: true, timeout: 30_000 },\n  ],\n  ralph: async ({ _ralphRecorder, ralphOptions }, use) => {\n    const checkOptIn = () => {\n      if (\n        resolveMode(ralphOptions) !== 'off' &&\n        !ralphOptions.ignoreUntaggedCalls\n      ) {\n        throw new Error('Opt this test into Ralph with the @ralph tag.');\n      }\n    };\n\n    await use(\n      _ralphRecorder ?? {\n        recordNode: async () => {\n          checkOptIn();\n        },\n        setNodeConditions: async () => {\n          checkOptIn();\n          return async () => {};\n        },\n        waitForCapture: async () => {},\n        pause: () => {},\n        resume: () => {},\n        observe: () => {\n          checkOptIn();\n        },\n      },\n    );\n  },\n  // On the context rather than per page, so popups start out reduced too.\n  contextOptions: async ({ contextOptions, ralphOptions }, use, testInfo) => {\n    const recording =\n      testInfo.tags.includes('@ralph') && resolveMode(ralphOptions) !== 'off';\n    await use(\n      recording && ralphOptions.reduceMotion\n        ? { ...contextOptions, reducedMotion: 'reduce' }\n        : contextOptions,\n    );\n  },\n  context: async ({ context, _ralphRecorder }, use) => {\n    _ralphRecorder?.observe(context);\n    try {\n      await use(context);\n    } finally {\n      // The base context fixture closes its pages next; pending recordings still need them alive.\n      await _ralphRecorder?.stopContext(context);\n    }\n  },\n});\n"],"mappings":";;;;;;AAgBA,MAAa,oBAAoB;AAYjC,SAAgB,YAAY,MAA0B;CACpD,OAAO,KAAK,QAAQ,MAAM,KAAK;AACjC;;;;;AAMA,SAAgB,cACd,OAAqB,CAAC,GACtB,UAA+B,CAAC,GAChB;CAChB,MAAM,EAAE,gBAAgBA,eAAAA,eACtB,SACA,QAAQ,QAAQ,QAAQ,IAAI,CAC9B,CAAC,CAAC;CACF,IAAI,CAAC,YAAY,QACf,MAAM,IAAI,MAAM,2CAA2C;CAE7D,OAAO,YAAY,KAAK,eAAe;EACrC,MAAM,QAAQ,YAAY,UAAU;EACpC,MAAM,QAAwB;GAAE;GAAY;EAAY;EACxD,OAAO;GACL,GAAG;GACH,MAAM,KAAK,OAAO,KAAK,OAAO,MAAM,QAAQ;GAC5C,KAAK;IACH,GAAG,KAAK;IACR,UAAU;KAAE,OAAO,WAAW;KAAO,QAAQ,WAAW;IAAO;GACjE;GACA,UAAU;IAAE,GAAG,KAAK;IAAU;GAAM;EACtC;CACF,CAAC;AACH;;;;;AAMA,SAAgB,qBAAqB,UAA0B;CAC7D,MAAM,WAAW,SAAS,KACvB,QAAQ,QAAQ,IAAI,WAAW,iBAAiB,CAAC,CAAC,CAClD,KAAK,QAAQ,IAAI,MAAM,EAAwB,CAAC;CACnD,MAAM,WAAY,SAAS,QAAQ,SAChC;CACH,IAAI,CAAC,SAAS,UAAU,CAAC,UACvB;CAEF,MAAM,QAAQ,SAAS,YAAY,IAAI,WAAW;CAClD,MAAM,UAAU,SAAS,QAAQ,UAAU,CAAC,MAAM,SAAS,KAAK,CAAC;CACjE,IAAI,QAAQ,QACV,MAAM,IAAI,MACR,+BACE,QAAQ,KAAK,IAAI,IACjB,2BACA,MAAM,KAAK,IAAI,IACf,GACJ;CAEF,MAAM,UAAU,YAAY,SAAS,UAAU;CAC/C,SAAS,KACP,CAAC,SAAS,SAAS,OAAO,GAC1B,wCAAwC,UAAU,GACpD;AACF;;;AC1BA,MAAa,OAGTC,iBAAAA,KAAK,OAAyD;CAChE,cAAc,CAAC,CAAC,GAAG,EAAE,QAAQ,KAAK,CAAC;CACnC,eAAe,CAGb,OAAO,IAAI,QAAQ;EACjB,MAAM,oBAAI,IAAI,IAAI,CAAC;CACrB,GACA,EAAE,OAAO,SAAS,CACpB;CACA,cAAc,CAGZ,OAAO,IAAI,KAAK,aAAa;EAE3B,qBAAqB,QAAQ;EAC7B,MAAM,IAAI;CACZ,GACA,EAAE,MAAM,KAAK,CACf;CACA,gBAAgB,CAGd,OACE,EAAE,cAAc,eAAe,cAAc,cAC7C,KACA,aACG;EACH,MAAM,OAAOC,eAAAA,YAAY,YAAY;EACrC,IAAI,CAAC,SAAS,KAAK,SAAS,QAAQ,KAAK,SAAS,OAAO;GACvD,MAAM,IAAI,IAAI;GACd;EACF;EAIA,MAAM,WACJ,QAAQ,IAAA,gCACR,SAAS,OAAO,SAAS,MAAM,CAAC,UAAU,SAAS,MAAM;EAC3D,IAAI,SAAS,YAAY,CAAC,UACxB,MAAM,IAAI,MACR,mMACF;EAGF,MAAM,OAAO,SAAS,OAAO,aACzBC,UAAAA,QAAK,QAAQ,SAAS,OAAO,UAAU,IACvC,QAAQ,IAAI;EAEhB,MAAM,MAAM,KAAK,UAAU;GACzB;GACA,QAAQ,aAAa;GACrB,YAAY,aAAa;EAC3B,CAAC;EAED,IAAI,UAAU,cAAc,IAAI,GAAG;EACnC,IAAI,CAAC,SAAS;GACZ,UAAUC,eAAAA,WAAW,cAAc,IAAI;GACvC,cAAc,IAAI,KAAK,OAAO;EAChC;EAEA,MAAM,WAAW,IAAIC,eAAAA,SACnB,cACA,MAAM,SACN,UACA,MACA,UACF;EAEA,IAAI;GACF,MAAM,IAAI,QAAQ;EACpB,UAAU;GACR,MAAM,SAAS,OAAO;EACxB;CACF,GACA;EAAE,MAAM;EAAM,SAAS;CAAO,CAChC;CACA,OAAO,OAAO,EAAE,gBAAgB,gBAAgB,QAAQ;EACtD,MAAM,mBAAmB;GACvB,IACEH,eAAAA,YAAY,YAAY,MAAM,SAC9B,CAAC,aAAa,qBAEd,MAAM,IAAI,MAAM,+CAA+C;EAEnE;EAEA,MAAM,IACJ,kBAAkB;GAChB,YAAY,YAAY;IACtB,WAAW;GACb;GACA,mBAAmB,YAAY;IAC7B,WAAW;IACX,OAAO,YAAY,CAAC;GACtB;GACA,gBAAgB,YAAY,CAAC;GAC7B,aAAa,CAAC;GACd,cAAc,CAAC;GACf,eAAe;IACb,WAAW;GACb;EACF,CACF;CACF;CAEA,gBAAgB,OAAO,EAAE,gBAAgB,gBAAgB,KAAK,aAAa;EAGzE,MAAM,IADJ,SAAS,KAAK,SAAS,QAAQ,KAAKA,eAAAA,YAAY,YAAY,MAAM,SAErD,aAAa,eACtB;GAAE,GAAG;GAAgB,eAAe;EAAS,IAC7C,cACN;CACF;CACA,SAAS,OAAO,EAAE,SAAS,kBAAkB,QAAQ;EACnD,gBAAgB,QAAQ,OAAO;EAC/B,IAAI;GACF,MAAM,IAAI,OAAO;EACnB,UAAU;GAER,MAAM,gBAAgB,YAAY,OAAO;EAC3C;CACF;AACF,CAAC"}

package/dist/index.d.mts

@@ -49,6 +49,12 @@ type RecordNodeOptions = {
    * graph. A retake without one keeps the name already given.
    */
   name?: string;
+  /**
+   * How the test got here from the node before, such as `Add to cart`, shown
+   * on the edge into this node beside the actions recorded on it. A retake
+   * without one keeps the label already given.
+   */
+  edgeLabel?: string;
 };
 type Ralph = {
   /**
@@ -76,6 +82,39 @@ type TrackedElement = {
   width: number;
   height: number;
 };
+type ActionKind = 'click' | 'dblclick' | 'tap' | 'hover' | 'check' | 'uncheck' | 'fill' | 'type' | 'press' | 'selectOption' | 'setInputFiles' | 'dragTo' | 'goto' | 'goBack' | 'goForward' | 'reload';
+/** The element an action landed on, as the page showed it at that moment. */
+type ActionTarget = {
+  tag: string;
+  role?: string;
+  /** What a reader would call it: its label, its text, or its alt text. */
+  name?: string;
+  trackId?: string;
+  /** In CSS pixels from the document's top-left, the space of the screenshot of the node the action was taken on. */
+  box: {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+  };
+};
+type RawAction = {
+  kind: ActionKind;
+  startedAt: string;
+  /** The tab it happened in, known when it reached an element. */
+  pageId?: string;
+  /** What the test acted on, in Playwright's selector syntax. */
+  selector?: string;
+  /**
+   * The text, key, URL, option, or file names, or for `dragTo`, the
+   * selector it was dropped on. Left out for what was typed
+   * into a password or one-time-code field, or into a field the page did not
+   * report.
+   */
+  value?: string;
+  /** Absent when the page reported no element for it, e.g. `goto`. */
+  target?: ActionTarget;
+};
 type PageLayout = {
   viewport: {
     width: number;
@@ -113,6 +152,13 @@ type RawNode = {
    * failed nodes are included; the server walks past the ones it doesn't show.
    */
   previousNodeId?: string;
+  /** The test's words for how it got here from `previousNodeId`. */
+  edgeLabel?: string;
+  /**
+   * What the test did between requesting `previousNodeId` and this node, in
+   * order. Actions taken while recording was paused are left out.
+   */
+  actions?: RawAction[];
 } & ({
   status: 'recorded';
   recordedAt: string;
@@ -287,5 +333,5 @@ type RalphFixtures = {
 };
 declare const test: TestType<PlaywrightTestArgs & PlaywrightTestOptions & RalphFixtures, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
 //#endregion
-export { type ConditionsDeclaration, type ConfigSnapshot, MANIFEST_ATTACHMENT, type NodeConditions, type PageLayout, type PreparedUpload, type Ralph, RalphFixtures, type RalphOptions, type RalphProjectOptions, type RalphReporterOptions, type RawGraph, type RawGraphBundleIndex, type RawGraphFile, type RawGraphManifest, type RawGraphScreenshot, type RawNode, type RawPage, type RecordNodeOptions, type RecordedTags, SCREEN_TAG_PREFIX, type TagConditions, type TagDeclaration, type TagValue, type TrackedElement, type UploadOptions, type UploadReceipt, type WebRalphConfig, createRawGraphBundle, expect, mergeTests, prepareArtifactUpload, ralphProjects, test, uploadRawGraph };
+export { type ActionKind, type ActionTarget, type ConditionsDeclaration, type ConfigSnapshot, MANIFEST_ATTACHMENT, type NodeConditions, type PageLayout, type PreparedUpload, type Ralph, RalphFixtures, type RalphOptions, type RalphProjectOptions, type RalphReporterOptions, type RawAction, type RawGraph, type RawGraphBundleIndex, type RawGraphFile, type RawGraphManifest, type RawGraphScreenshot, type RawNode, type RawPage, type RecordNodeOptions, type RecordedTags, SCREEN_TAG_PREFIX, type TagConditions, type TagDeclaration, type TagValue, type TrackedElement, type UploadOptions, type UploadReceipt, type WebRalphConfig, createRawGraphBundle, expect, mergeTests, prepareArtifactUpload, ralphProjects, test, uploadRawGraph };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { c as MANIFEST_ATTACHMENT, f as loadConfig, i as prepareArtifactUpload, m as resolveMode, p as loadConfigSync, r as createRawGraphBundle, s as uploadRawGraph, u as Recorder } from "./upload-DQn3CLvx.mjs";
+import { c as uploadRawGraph, d as Recorder, h as resolveMode, i as prepareArtifactUpload, l as MANIFEST_ATTACHMENT, m as loadConfigSync, p as loadConfig, r as createRawGraphBundle } from "./upload-BZs6Vqix.mjs";
 import path from "node:path";
 import { expect, mergeTests, test as test$1 } from "@playwright/test";
 //#region src/screens.ts
@@ -61,7 +61,7 @@ const test = test$1.extend({
 		applyScreenSelection(testInfo);
 		await use();
 	}, { auto: true }],
-	_ralphRecorder: [async ({ ralphOptions, _ralphConfigs, _ralphScreen }, use, testInfo) => {
+	_ralphRecorder: [async ({ ralphOptions, _ralphConfigs, _ralphScreen, playwright }, use, testInfo) => {
 		const mode = resolveMode(ralphOptions);
 		if (!testInfo.tags.includes("@ralph") || mode === "off") {
 			await use(null);
@@ -80,7 +80,7 @@ const test = test$1.extend({
 			pending = loadConfig(ralphOptions, root);
 			_ralphConfigs.set(key, pending);
 		}
-		const recorder = new Recorder(ralphOptions, await pending, testInfo, mode);
+		const recorder = new Recorder(ralphOptions, await pending, testInfo, mode, playwright);
 		try {
 			await use(recorder);
 		} finally {

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":["base"],"sources":["../src/screens.ts","../src/index.ts"],"sourcesContent":["import type {\n  PlaywrightTestOptions,\n  PlaywrightWorkerOptions,\n  Project,\n  TestInfo,\n} from '@playwright/test';\nimport type { ScreenSize } from '@ralphralphai/config';\n\nimport { loadConfigSync } from './config';\nimport type { RalphOptions } from './types';\n\ntype RalphProject = Project<\n  PlaywrightTestOptions & { ralphOptions: RalphOptions },\n  PlaywrightWorkerOptions\n>;\n\nexport const SCREEN_TAG_PREFIX = '@ralph-screen:';\n\nexport type RalphProjectOptions = Pick<\n  RalphOptions,\n  'config' | 'configPath'\n> & {\n  /** Resolves a relative `configPath`; defaults to the current directory. */\n  root?: string;\n};\n\ntype ScreenMetadata = { screenSize: ScreenSize; screenSizes: ScreenSize[] };\n\nexport function screenLabel(size: ScreenSize): string {\n  return size.width + 'x' + size.height;\n}\n\n/**\n * Expands `base` into one project per `screenSizes` entry of the Ralph config.\n * Each project's viewport is that screen size.\n */\nexport function ralphProjects(\n  base: RalphProject = {},\n  options: RalphProjectOptions = {},\n): RalphProject[] {\n  const { screenSizes } = loadConfigSync(\n    options,\n    options.root ?? process.cwd(),\n  ).config;\n  if (!screenSizes.length) {\n    throw new Error('The Ralph config declares no screenSizes.');\n  }\n  return screenSizes.map((screenSize) => {\n    const label = screenLabel(screenSize);\n    const ralph: ScreenMetadata = { screenSize, screenSizes };\n    return {\n      ...base,\n      name: base.name ? base.name + ' ' + label : label,\n      use: {\n        ...base.use,\n        viewport: { width: screenSize.width, height: screenSize.height },\n      },\n      metadata: { ...base.metadata, ralph },\n    };\n  });\n}\n\n/**\n * Skips a test whose `@ralph-screen:WxH` tags exclude the current project's\n * screen size. Untagged tests run at every size; other projects are untouched.\n */\nexport function applyScreenSelection(testInfo: TestInfo): void {\n  const selected = testInfo.tags\n    .filter((tag) => tag.startsWith(SCREEN_TAG_PREFIX))\n    .map((tag) => tag.slice(SCREEN_TAG_PREFIX.length));\n  const metadata = (testInfo.project.metadata as { ralph?: ScreenMetadata })\n    .ralph;\n  if (!selected.length || !metadata) {\n    return;\n  }\n  const known = metadata.screenSizes.map(screenLabel);\n  const unknown = selected.filter((label) => !known.includes(label));\n  if (unknown.length) {\n    throw new Error(\n      'Unknown Ralph screen size ' +\n        unknown.join(', ') +\n        '; the config declares ' +\n        known.join(', ') +\n        '.',\n    );\n  }\n  const current = screenLabel(metadata.screenSize);\n  testInfo.skip(\n    !selected.includes(current),\n    'Not selected for Ralph screen size ' + current + '.',\n  );\n}\n","import path from 'node:path';\n\nimport { test as base } from '@playwright/test';\nimport type {\n  PlaywrightTestArgs,\n  PlaywrightTestOptions,\n  PlaywrightWorkerArgs,\n  PlaywrightWorkerOptions,\n  TestType,\n} from '@playwright/test';\n\nimport { loadConfig, resolveMode } from './config';\nimport { Recorder, REPORTER_ENV } from './recorder';\nimport { applyScreenSelection } from './screens';\nimport type { ConfigSnapshot, Ralph, RalphOptions } from './types';\n\nexport { expect, mergeTests } from '@playwright/test';\nexport type { WebRalphConfig } from '@ralphralphai/config';\nexport {\n  createRawGraphBundle,\n  prepareArtifactUpload,\n  uploadRawGraph,\n} from './upload';\nexport type {\n  PreparedUpload,\n  UploadOptions,\n  UploadReceipt,\n  RawGraphScreenshot,\n  RawGraphBundleIndex,\n} from './upload';\nexport { MANIFEST_ATTACHMENT } from './recorder';\nexport { ralphProjects, SCREEN_TAG_PREFIX } from './screens';\nexport type { RalphProjectOptions } from './screens';\nexport type { RalphReporterOptions } from './reporter';\nexport type {\n  RawGraphManifest,\n  RawGraph,\n  RawGraphFile,\n  RawPage,\n  RawNode,\n  ConditionsDeclaration,\n  NodeConditions,\n  RecordedTags,\n  RecordNodeOptions,\n  TagConditions,\n  TagDeclaration,\n  TagValue,\n  ConfigSnapshot,\n  PageLayout,\n  Ralph,\n  RalphOptions,\n  TrackedElement,\n} from './types';\n\nexport type RalphFixtures = { ralph: Ralph; ralphOptions: RalphOptions };\n\ntype InternalFixtures = {\n  _ralphScreen: void;\n  _ralphRecorder: Recorder | null;\n};\ntype WorkerFixtures = { _ralphConfigs: Map<string, Promise<ConfigSnapshot>> };\n\nexport const test: TestType<\n  PlaywrightTestArgs & PlaywrightTestOptions & RalphFixtures,\n  PlaywrightWorkerArgs & PlaywrightWorkerOptions\n> = base.extend<RalphFixtures & InternalFixtures, WorkerFixtures>({\n  ralphOptions: [{}, { option: true }],\n  _ralphConfigs: [\n    // Playwright requires destructuring here to discover fixture dependencies.\n    // oxlint-disable-next-line no-empty-pattern\n    async ({}, use) => {\n      await use(new Map());\n    },\n    { scope: 'worker' },\n  ],\n  _ralphScreen: [\n    // Playwright requires destructuring here to discover fixture dependencies.\n    // oxlint-disable-next-line no-empty-pattern\n    async ({}, use, testInfo) => {\n      // Screen selection chooses which flows run, so it applies in every mode.\n      applyScreenSelection(testInfo);\n      await use();\n    },\n    { auto: true },\n  ],\n  _ralphRecorder: [\n    // _ralphScreen is specified here so that the playwright treat that it is\n    // a dependency of this fixture.\n    async ({ ralphOptions, _ralphConfigs, _ralphScreen }, use, testInfo) => {\n      const mode = resolveMode(ralphOptions);\n      if (!testInfo.tags.includes('@ralph') || mode === 'off') {\n        await use(null);\n        return;\n      }\n\n      // A sharded run's blob reports are merged, and uploaded by the Ralph\n      // reporter, in `playwright merge-reports`.\n      const reported =\n        process.env[REPORTER_ENV] ||\n        testInfo.config.reporter.some(([name]) => name === 'blob');\n      if (mode === 'upload' && !reported) {\n        throw new Error(\n          \"Ralph uploads one merged graph per run from its reporter. Add ['@ralphralphai/playwright/reporter'] to `reporter` in playwright.config, or use the blob reporter and merge-reports when sharding.\",\n        );\n      }\n\n      const root = testInfo.config.configFile\n        ? path.dirname(testInfo.config.configFile)\n        : process.cwd();\n\n      const key = JSON.stringify({\n        root,\n        config: ralphOptions.config,\n        configPath: ralphOptions.configPath,\n      });\n\n      let pending = _ralphConfigs.get(key);\n      if (!pending) {\n        pending = loadConfig(ralphOptions, root);\n        _ralphConfigs.set(key, pending);\n      }\n\n      const recorder = new Recorder(\n        ralphOptions,\n        await pending,\n        testInfo,\n        mode,\n      );\n\n      try {\n        await use(recorder);\n      } finally {\n        await recorder.finish();\n      }\n    },\n    { auto: true, timeout: 30_000 },\n  ],\n  ralph: async ({ _ralphRecorder, ralphOptions }, use) => {\n    const checkOptIn = () => {\n      if (\n        resolveMode(ralphOptions) !== 'off' &&\n        !ralphOptions.ignoreUntaggedCalls\n      ) {\n        throw new Error('Opt this test into Ralph with the @ralph tag.');\n      }\n    };\n\n    await use(\n      _ralphRecorder ?? {\n        recordNode: async () => {\n          checkOptIn();\n        },\n        setNodeConditions: async () => {\n          checkOptIn();\n          return async () => {};\n        },\n        waitForCapture: async () => {},\n        pause: () => {},\n        resume: () => {},\n        observe: () => {\n          checkOptIn();\n        },\n      },\n    );\n  },\n  // On the context rather than per page, so popups start out reduced too.\n  contextOptions: async ({ contextOptions, ralphOptions }, use, testInfo) => {\n    const recording =\n      testInfo.tags.includes('@ralph') && resolveMode(ralphOptions) !== 'off';\n    await use(\n      recording && ralphOptions.reduceMotion\n        ? { ...contextOptions, reducedMotion: 'reduce' }\n        : contextOptions,\n    );\n  },\n  context: async ({ context, _ralphRecorder }, use) => {\n    _ralphRecorder?.observe(context);\n    try {\n      await use(context);\n    } finally {\n      // The base context fixture closes its pages next; pending recordings still need them alive.\n      await _ralphRecorder?.stopContext(context);\n    }\n  },\n});\n"],"mappings":";;;;AAgBA,MAAa,oBAAoB;AAYjC,SAAgB,YAAY,MAA0B;CACpD,OAAO,KAAK,QAAQ,MAAM,KAAK;AACjC;;;;;AAMA,SAAgB,cACd,OAAqB,CAAC,GACtB,UAA+B,CAAC,GAChB;CAChB,MAAM,EAAE,gBAAgB,eACtB,SACA,QAAQ,QAAQ,QAAQ,IAAI,CAC9B,CAAC,CAAC;CACF,IAAI,CAAC,YAAY,QACf,MAAM,IAAI,MAAM,2CAA2C;CAE7D,OAAO,YAAY,KAAK,eAAe;EACrC,MAAM,QAAQ,YAAY,UAAU;EACpC,MAAM,QAAwB;GAAE;GAAY;EAAY;EACxD,OAAO;GACL,GAAG;GACH,MAAM,KAAK,OAAO,KAAK,OAAO,MAAM,QAAQ;GAC5C,KAAK;IACH,GAAG,KAAK;IACR,UAAU;KAAE,OAAO,WAAW;KAAO,QAAQ,WAAW;IAAO;GACjE;GACA,UAAU;IAAE,GAAG,KAAK;IAAU;GAAM;EACtC;CACF,CAAC;AACH;;;;;AAMA,SAAgB,qBAAqB,UAA0B;CAC7D,MAAM,WAAW,SAAS,KACvB,QAAQ,QAAQ,IAAI,WAAW,iBAAiB,CAAC,CAAC,CAClD,KAAK,QAAQ,IAAI,MAAM,EAAwB,CAAC;CACnD,MAAM,WAAY,SAAS,QAAQ,SAChC;CACH,IAAI,CAAC,SAAS,UAAU,CAAC,UACvB;CAEF,MAAM,QAAQ,SAAS,YAAY,IAAI,WAAW;CAClD,MAAM,UAAU,SAAS,QAAQ,UAAU,CAAC,MAAM,SAAS,KAAK,CAAC;CACjE,IAAI,QAAQ,QACV,MAAM,IAAI,MACR,+BACE,QAAQ,KAAK,IAAI,IACjB,2BACA,MAAM,KAAK,IAAI,IACf,GACJ;CAEF,MAAM,UAAU,YAAY,SAAS,UAAU;CAC/C,SAAS,KACP,CAAC,SAAS,SAAS,OAAO,GAC1B,wCAAwC,UAAU,GACpD;AACF;;;AC7BA,MAAa,OAGTA,OAAK,OAAyD;CAChE,cAAc,CAAC,CAAC,GAAG,EAAE,QAAQ,KAAK,CAAC;CACnC,eAAe,CAGb,OAAO,IAAI,QAAQ;EACjB,MAAM,oBAAI,IAAI,IAAI,CAAC;CACrB,GACA,EAAE,OAAO,SAAS,CACpB;CACA,cAAc,CAGZ,OAAO,IAAI,KAAK,aAAa;EAE3B,qBAAqB,QAAQ;EAC7B,MAAM,IAAI;CACZ,GACA,EAAE,MAAM,KAAK,CACf;CACA,gBAAgB,CAGd,OAAO,EAAE,cAAc,eAAe,gBAAgB,KAAK,aAAa;EACtE,MAAM,OAAO,YAAY,YAAY;EACrC,IAAI,CAAC,SAAS,KAAK,SAAS,QAAQ,KAAK,SAAS,OAAO;GACvD,MAAM,IAAI,IAAI;GACd;EACF;EAIA,MAAM,WACJ,QAAQ,IAAA,gCACR,SAAS,OAAO,SAAS,MAAM,CAAC,UAAU,SAAS,MAAM;EAC3D,IAAI,SAAS,YAAY,CAAC,UACxB,MAAM,IAAI,MACR,mMACF;EAGF,MAAM,OAAO,SAAS,OAAO,aACzB,KAAK,QAAQ,SAAS,OAAO,UAAU,IACvC,QAAQ,IAAI;EAEhB,MAAM,MAAM,KAAK,UAAU;GACzB;GACA,QAAQ,aAAa;GACrB,YAAY,aAAa;EAC3B,CAAC;EAED,IAAI,UAAU,cAAc,IAAI,GAAG;EACnC,IAAI,CAAC,SAAS;GACZ,UAAU,WAAW,cAAc,IAAI;GACvC,cAAc,IAAI,KAAK,OAAO;EAChC;EAEA,MAAM,WAAW,IAAI,SACnB,cACA,MAAM,SACN,UACA,IACF;EAEA,IAAI;GACF,MAAM,IAAI,QAAQ;EACpB,UAAU;GACR,MAAM,SAAS,OAAO;EACxB;CACF,GACA;EAAE,MAAM;EAAM,SAAS;CAAO,CAChC;CACA,OAAO,OAAO,EAAE,gBAAgB,gBAAgB,QAAQ;EACtD,MAAM,mBAAmB;GACvB,IACE,YAAY,YAAY,MAAM,SAC9B,CAAC,aAAa,qBAEd,MAAM,IAAI,MAAM,+CAA+C;EAEnE;EAEA,MAAM,IACJ,kBAAkB;GAChB,YAAY,YAAY;IACtB,WAAW;GACb;GACA,mBAAmB,YAAY;IAC7B,WAAW;IACX,OAAO,YAAY,CAAC;GACtB;GACA,gBAAgB,YAAY,CAAC;GAC7B,aAAa,CAAC;GACd,cAAc,CAAC;GACf,eAAe;IACb,WAAW;GACb;EACF,CACF;CACF;CAEA,gBAAgB,OAAO,EAAE,gBAAgB,gBAAgB,KAAK,aAAa;EAGzE,MAAM,IADJ,SAAS,KAAK,SAAS,QAAQ,KAAK,YAAY,YAAY,MAAM,SAErD,aAAa,eACtB;GAAE,GAAG;GAAgB,eAAe;EAAS,IAC7C,cACN;CACF;CACA,SAAS,OAAO,EAAE,SAAS,kBAAkB,QAAQ;EACnD,gBAAgB,QAAQ,OAAO;EAC/B,IAAI;GACF,MAAM,IAAI,OAAO;EACnB,UAAU;GAER,MAAM,gBAAgB,YAAY,OAAO;EAC3C;CACF;AACF,CAAC"}
+{"version":3,"file":"index.mjs","names":["base"],"sources":["../src/screens.ts","../src/index.ts"],"sourcesContent":["import type {\n  PlaywrightTestOptions,\n  PlaywrightWorkerOptions,\n  Project,\n  TestInfo,\n} from '@playwright/test';\nimport type { ScreenSize } from '@ralphralphai/config';\n\nimport { loadConfigSync } from './config';\nimport type { RalphOptions } from './types';\n\ntype RalphProject = Project<\n  PlaywrightTestOptions & { ralphOptions: RalphOptions },\n  PlaywrightWorkerOptions\n>;\n\nexport const SCREEN_TAG_PREFIX = '@ralph-screen:';\n\nexport type RalphProjectOptions = Pick<\n  RalphOptions,\n  'config' | 'configPath'\n> & {\n  /** Resolves a relative `configPath`; defaults to the current directory. */\n  root?: string;\n};\n\ntype ScreenMetadata = { screenSize: ScreenSize; screenSizes: ScreenSize[] };\n\nexport function screenLabel(size: ScreenSize): string {\n  return size.width + 'x' + size.height;\n}\n\n/**\n * Expands `base` into one project per `screenSizes` entry of the Ralph config.\n * Each project's viewport is that screen size.\n */\nexport function ralphProjects(\n  base: RalphProject = {},\n  options: RalphProjectOptions = {},\n): RalphProject[] {\n  const { screenSizes } = loadConfigSync(\n    options,\n    options.root ?? process.cwd(),\n  ).config;\n  if (!screenSizes.length) {\n    throw new Error('The Ralph config declares no screenSizes.');\n  }\n  return screenSizes.map((screenSize) => {\n    const label = screenLabel(screenSize);\n    const ralph: ScreenMetadata = { screenSize, screenSizes };\n    return {\n      ...base,\n      name: base.name ? base.name + ' ' + label : label,\n      use: {\n        ...base.use,\n        viewport: { width: screenSize.width, height: screenSize.height },\n      },\n      metadata: { ...base.metadata, ralph },\n    };\n  });\n}\n\n/**\n * Skips a test whose `@ralph-screen:WxH` tags exclude the current project's\n * screen size. Untagged tests run at every size; other projects are untouched.\n */\nexport function applyScreenSelection(testInfo: TestInfo): void {\n  const selected = testInfo.tags\n    .filter((tag) => tag.startsWith(SCREEN_TAG_PREFIX))\n    .map((tag) => tag.slice(SCREEN_TAG_PREFIX.length));\n  const metadata = (testInfo.project.metadata as { ralph?: ScreenMetadata })\n    .ralph;\n  if (!selected.length || !metadata) {\n    return;\n  }\n  const known = metadata.screenSizes.map(screenLabel);\n  const unknown = selected.filter((label) => !known.includes(label));\n  if (unknown.length) {\n    throw new Error(\n      'Unknown Ralph screen size ' +\n        unknown.join(', ') +\n        '; the config declares ' +\n        known.join(', ') +\n        '.',\n    );\n  }\n  const current = screenLabel(metadata.screenSize);\n  testInfo.skip(\n    !selected.includes(current),\n    'Not selected for Ralph screen size ' + current + '.',\n  );\n}\n","import path from 'node:path';\n\nimport { test as base } from '@playwright/test';\nimport type {\n  PlaywrightTestArgs,\n  PlaywrightTestOptions,\n  PlaywrightWorkerArgs,\n  PlaywrightWorkerOptions,\n  TestType,\n} from '@playwright/test';\n\nimport { loadConfig, resolveMode } from './config';\nimport { Recorder, REPORTER_ENV } from './recorder';\nimport { applyScreenSelection } from './screens';\nimport type { ConfigSnapshot, Ralph, RalphOptions } from './types';\n\nexport { expect, mergeTests } from '@playwright/test';\nexport type { WebRalphConfig } from '@ralphralphai/config';\nexport {\n  createRawGraphBundle,\n  prepareArtifactUpload,\n  uploadRawGraph,\n} from './upload';\nexport type {\n  PreparedUpload,\n  UploadOptions,\n  UploadReceipt,\n  RawGraphScreenshot,\n  RawGraphBundleIndex,\n} from './upload';\nexport { MANIFEST_ATTACHMENT } from './recorder';\nexport { ralphProjects, SCREEN_TAG_PREFIX } from './screens';\nexport type { RalphProjectOptions } from './screens';\nexport type { RalphReporterOptions } from './reporter';\nexport type {\n  RawGraphManifest,\n  RawGraph,\n  RawGraphFile,\n  RawPage,\n  RawNode,\n  RawAction,\n  ActionKind,\n  ActionTarget,\n  ConditionsDeclaration,\n  NodeConditions,\n  RecordedTags,\n  RecordNodeOptions,\n  TagConditions,\n  TagDeclaration,\n  TagValue,\n  ConfigSnapshot,\n  PageLayout,\n  Ralph,\n  RalphOptions,\n  TrackedElement,\n} from './types';\n\nexport type RalphFixtures = { ralph: Ralph; ralphOptions: RalphOptions };\n\ntype InternalFixtures = {\n  _ralphScreen: void;\n  _ralphRecorder: Recorder | null;\n};\ntype WorkerFixtures = { _ralphConfigs: Map<string, Promise<ConfigSnapshot>> };\n\nexport const test: TestType<\n  PlaywrightTestArgs & PlaywrightTestOptions & RalphFixtures,\n  PlaywrightWorkerArgs & PlaywrightWorkerOptions\n> = base.extend<RalphFixtures & InternalFixtures, WorkerFixtures>({\n  ralphOptions: [{}, { option: true }],\n  _ralphConfigs: [\n    // Playwright requires destructuring here to discover fixture dependencies.\n    // oxlint-disable-next-line no-empty-pattern\n    async ({}, use) => {\n      await use(new Map());\n    },\n    { scope: 'worker' },\n  ],\n  _ralphScreen: [\n    // Playwright requires destructuring here to discover fixture dependencies.\n    // oxlint-disable-next-line no-empty-pattern\n    async ({}, use, testInfo) => {\n      // Screen selection chooses which flows run, so it applies in every mode.\n      applyScreenSelection(testInfo);\n      await use();\n    },\n    { auto: true },\n  ],\n  _ralphRecorder: [\n    // _ralphScreen is specified here so that the playwright treat that it is\n    // a dependency of this fixture.\n    async (\n      { ralphOptions, _ralphConfigs, _ralphScreen, playwright },\n      use,\n      testInfo,\n    ) => {\n      const mode = resolveMode(ralphOptions);\n      if (!testInfo.tags.includes('@ralph') || mode === 'off') {\n        await use(null);\n        return;\n      }\n\n      // A sharded run's blob reports are merged, and uploaded by the Ralph\n      // reporter, in `playwright merge-reports`.\n      const reported =\n        process.env[REPORTER_ENV] ||\n        testInfo.config.reporter.some(([name]) => name === 'blob');\n      if (mode === 'upload' && !reported) {\n        throw new Error(\n          \"Ralph uploads one merged graph per run from its reporter. Add ['@ralphralphai/playwright/reporter'] to `reporter` in playwright.config, or use the blob reporter and merge-reports when sharding.\",\n        );\n      }\n\n      const root = testInfo.config.configFile\n        ? path.dirname(testInfo.config.configFile)\n        : process.cwd();\n\n      const key = JSON.stringify({\n        root,\n        config: ralphOptions.config,\n        configPath: ralphOptions.configPath,\n      });\n\n      let pending = _ralphConfigs.get(key);\n      if (!pending) {\n        pending = loadConfig(ralphOptions, root);\n        _ralphConfigs.set(key, pending);\n      }\n\n      const recorder = new Recorder(\n        ralphOptions,\n        await pending,\n        testInfo,\n        mode,\n        playwright,\n      );\n\n      try {\n        await use(recorder);\n      } finally {\n        await recorder.finish();\n      }\n    },\n    { auto: true, timeout: 30_000 },\n  ],\n  ralph: async ({ _ralphRecorder, ralphOptions }, use) => {\n    const checkOptIn = () => {\n      if (\n        resolveMode(ralphOptions) !== 'off' &&\n        !ralphOptions.ignoreUntaggedCalls\n      ) {\n        throw new Error('Opt this test into Ralph with the @ralph tag.');\n      }\n    };\n\n    await use(\n      _ralphRecorder ?? {\n        recordNode: async () => {\n          checkOptIn();\n        },\n        setNodeConditions: async () => {\n          checkOptIn();\n          return async () => {};\n        },\n        waitForCapture: async () => {},\n        pause: () => {},\n        resume: () => {},\n        observe: () => {\n          checkOptIn();\n        },\n      },\n    );\n  },\n  // On the context rather than per page, so popups start out reduced too.\n  contextOptions: async ({ contextOptions, ralphOptions }, use, testInfo) => {\n    const recording =\n      testInfo.tags.includes('@ralph') && resolveMode(ralphOptions) !== 'off';\n    await use(\n      recording && ralphOptions.reduceMotion\n        ? { ...contextOptions, reducedMotion: 'reduce' }\n        : contextOptions,\n    );\n  },\n  context: async ({ context, _ralphRecorder }, use) => {\n    _ralphRecorder?.observe(context);\n    try {\n      await use(context);\n    } finally {\n      // The base context fixture closes its pages next; pending recordings still need them alive.\n      await _ralphRecorder?.stopContext(context);\n    }\n  },\n});\n"],"mappings":";;;;AAgBA,MAAa,oBAAoB;AAYjC,SAAgB,YAAY,MAA0B;CACpD,OAAO,KAAK,QAAQ,MAAM,KAAK;AACjC;;;;;AAMA,SAAgB,cACd,OAAqB,CAAC,GACtB,UAA+B,CAAC,GAChB;CAChB,MAAM,EAAE,gBAAgB,eACtB,SACA,QAAQ,QAAQ,QAAQ,IAAI,CAC9B,CAAC,CAAC;CACF,IAAI,CAAC,YAAY,QACf,MAAM,IAAI,MAAM,2CAA2C;CAE7D,OAAO,YAAY,KAAK,eAAe;EACrC,MAAM,QAAQ,YAAY,UAAU;EACpC,MAAM,QAAwB;GAAE;GAAY;EAAY;EACxD,OAAO;GACL,GAAG;GACH,MAAM,KAAK,OAAO,KAAK,OAAO,MAAM,QAAQ;GAC5C,KAAK;IACH,GAAG,KAAK;IACR,UAAU;KAAE,OAAO,WAAW;KAAO,QAAQ,WAAW;IAAO;GACjE;GACA,UAAU;IAAE,GAAG,KAAK;IAAU;GAAM;EACtC;CACF,CAAC;AACH;;;;;AAMA,SAAgB,qBAAqB,UAA0B;CAC7D,MAAM,WAAW,SAAS,KACvB,QAAQ,QAAQ,IAAI,WAAW,iBAAiB,CAAC,CAAC,CAClD,KAAK,QAAQ,IAAI,MAAM,EAAwB,CAAC;CACnD,MAAM,WAAY,SAAS,QAAQ,SAChC;CACH,IAAI,CAAC,SAAS,UAAU,CAAC,UACvB;CAEF,MAAM,QAAQ,SAAS,YAAY,IAAI,WAAW;CAClD,MAAM,UAAU,SAAS,QAAQ,UAAU,CAAC,MAAM,SAAS,KAAK,CAAC;CACjE,IAAI,QAAQ,QACV,MAAM,IAAI,MACR,+BACE,QAAQ,KAAK,IAAI,IACjB,2BACA,MAAM,KAAK,IAAI,IACf,GACJ;CAEF,MAAM,UAAU,YAAY,SAAS,UAAU;CAC/C,SAAS,KACP,CAAC,SAAS,SAAS,OAAO,GAC1B,wCAAwC,UAAU,GACpD;AACF;;;AC1BA,MAAa,OAGTA,OAAK,OAAyD;CAChE,cAAc,CAAC,CAAC,GAAG,EAAE,QAAQ,KAAK,CAAC;CACnC,eAAe,CAGb,OAAO,IAAI,QAAQ;EACjB,MAAM,oBAAI,IAAI,IAAI,CAAC;CACrB,GACA,EAAE,OAAO,SAAS,CACpB;CACA,cAAc,CAGZ,OAAO,IAAI,KAAK,aAAa;EAE3B,qBAAqB,QAAQ;EAC7B,MAAM,IAAI;CACZ,GACA,EAAE,MAAM,KAAK,CACf;CACA,gBAAgB,CAGd,OACE,EAAE,cAAc,eAAe,cAAc,cAC7C,KACA,aACG;EACH,MAAM,OAAO,YAAY,YAAY;EACrC,IAAI,CAAC,SAAS,KAAK,SAAS,QAAQ,KAAK,SAAS,OAAO;GACvD,MAAM,IAAI,IAAI;GACd;EACF;EAIA,MAAM,WACJ,QAAQ,IAAA,gCACR,SAAS,OAAO,SAAS,MAAM,CAAC,UAAU,SAAS,MAAM;EAC3D,IAAI,SAAS,YAAY,CAAC,UACxB,MAAM,IAAI,MACR,mMACF;EAGF,MAAM,OAAO,SAAS,OAAO,aACzB,KAAK,QAAQ,SAAS,OAAO,UAAU,IACvC,QAAQ,IAAI;EAEhB,MAAM,MAAM,KAAK,UAAU;GACzB;GACA,QAAQ,aAAa;GACrB,YAAY,aAAa;EAC3B,CAAC;EAED,IAAI,UAAU,cAAc,IAAI,GAAG;EACnC,IAAI,CAAC,SAAS;GACZ,UAAU,WAAW,cAAc,IAAI;GACvC,cAAc,IAAI,KAAK,OAAO;EAChC;EAEA,MAAM,WAAW,IAAI,SACnB,cACA,MAAM,SACN,UACA,MACA,UACF;EAEA,IAAI;GACF,MAAM,IAAI,QAAQ;EACpB,UAAU;GACR,MAAM,SAAS,OAAO;EACxB;CACF,GACA;EAAE,MAAM;EAAM,SAAS;CAAO,CAChC;CACA,OAAO,OAAO,EAAE,gBAAgB,gBAAgB,QAAQ;EACtD,MAAM,mBAAmB;GACvB,IACE,YAAY,YAAY,MAAM,SAC9B,CAAC,aAAa,qBAEd,MAAM,IAAI,MAAM,+CAA+C;EAEnE;EAEA,MAAM,IACJ,kBAAkB;GAChB,YAAY,YAAY;IACtB,WAAW;GACb;GACA,mBAAmB,YAAY;IAC7B,WAAW;IACX,OAAO,YAAY,CAAC;GACtB;GACA,gBAAgB,YAAY,CAAC;GAC7B,aAAa,CAAC;GACd,cAAc,CAAC;GACf,eAAe;IACb,WAAW;GACb;EACF,CACF;CACF;CAEA,gBAAgB,OAAO,EAAE,gBAAgB,gBAAgB,KAAK,aAAa;EAGzE,MAAM,IADJ,SAAS,KAAK,SAAS,QAAQ,KAAK,YAAY,YAAY,MAAM,SAErD,aAAa,eACtB;GAAE,GAAG;GAAgB,eAAe;EAAS,IAC7C,cACN;CACF;CACA,SAAS,OAAO,EAAE,SAAS,kBAAkB,QAAQ;EACnD,gBAAgB,QAAQ,OAAO;EAC/B,IAAI;GACF,MAAM,IAAI,OAAO;EACnB,UAAU;GAER,MAAM,gBAAgB,YAAY,OAAO;EAC3C;CACF;AACF,CAAC"}

package/dist/reporter.cjs

@@ -1,4 +1,4 @@
-const require_upload = require("./upload-ZMnTCjs2.cjs");
+const require_upload = require("./upload-BQSCs8By.cjs");
 let node_path = require("node:path");
 node_path = require_upload.__toESM(node_path, 1);
 let node_fs_promises = require("node:fs/promises");
@@ -49,7 +49,7 @@ var RalphReporter = class {
 			let prepared;
 			if (uploading) {
 				try {
-					prepared = await require_upload.prepareArtifactUpload(require_upload.resolveUploadOptions(this.options));
+					prepared = await this.reserve(merged.manifest);
 				} catch (error) {
 					const outputDir = await this.write(merged.manifest, screenshots);
 					throw new Error(`${error instanceof Error ? error.message : String(error)} The recording was saved to ${outputDir}.`, { cause: error });
@@ -76,6 +76,15 @@ var RalphReporter = class {
 			return { status: "failed" };
 		}
 	}
+	reserve(manifest) {
+		const options = require_upload.resolveUploadOptions(this.options);
+		if (!(this.options.deploy ?? process.env["RALPH_DEPLOY"] === "1")) return require_upload.prepareArtifactUpload(options);
+		if (manifest.buildId === void 0) throw new Error("A deployment run uploads into its build, so set RALPH_BUILD_ID (or the buildId option) to the deployed build.");
+		return require_upload.registerDeployment(options, {
+			buildId: manifest.buildId,
+			config: manifest.config.config
+		});
+	}
 	printsToStdio() {
 		return false;
 	}