@ralphralphai/playwright 2.3.0 → 2.5.0

package/README.md

@@ -93,6 +93,44 @@ CSS animations and transitions are frozen for the screenshot. For animations
 driven from JavaScript, set `reduceMotion` if your app honors
 `prefers-reduced-motion`.
 
+To hold timers and animations at the same position across the screenshot,
+tracked-element geometry, and ARIA snapshot, enable:
+
+```ts
+ralphOptions: {
+  freezeDuringCapture: true,
+},
+```
+
+Ralph installs Playwright's clock before the app loads. Before capture it
+finishes running finite CSS transitions, CSS animations, and Web Animations,
+and watches DOM changes in the page, its frames, and open shadow roots. Timers
+and animation frames keep running while it waits for 150 ms without changes,
+so JavaScript-driven animations can finish without adding callbacks or markers
+to your app. Animations started by completion callbacks are checked again.
+
+This extra settling wait is capped at 1.5 seconds, or half the remaining
+`recordTimeoutMs` budget, whichever is smaller. Looping browser animations are
+temporarily paused while settling. Then timers and all remaining browser
+animations pause during capture and resume afterward, including on failure.
+Animations already paused by the app stay paused; finished animations stay
+finished.
+
+The DOM quiet check is a heuristic, not a guarantee that every animation has
+ended. Long-running JavaScript animations can be captured midway when the
+budget expires. Future delayed work and drawing inside canvas or WebGL aren't
+detected by this check.
+
+This option defaults to `false`. The clock replaces the native timer APIs for
+the lifetime of the context, so don't combine it with manual `page.clock` or
+`context.clock` control. Playwright requires a future pause time: Ralph uses
+the page's current time plus 100 ms, which advances the clock and can fire due
+callbacks once before freezing. Time resumes from there without catching up
+through the capture duration. All tabs in a context share the clock, so their
+timers pause together and their captures run one at a time. Network responses,
+workers, and media playback are not frozen, so unrelated updates can still
+change the page.
+
 ### Explicitly, once the page is ready
 
 A capture taken when the URL or the declared conditions change can catch the
@@ -190,12 +228,16 @@ not record the current page.
 
 ```ts
 const context = await browser.newContext();
-ralph.observe(context);
+await ralph.observe(context);
 // ...
 await ralph.waitForCapture();
 await context.close();
 ```
 
+With `freezeDuringCapture`, await `ralph.observe(context)` before creating or
+navigating any pages, so no app scripts schedule native timers first. A context
+with an already navigated page cannot be enrolled with this option enabled.
+
 ### What happened between two nodes
 
 The Playwright actions a test takes on the way from one node to the next are
@@ -371,6 +413,7 @@ export default defineConfig<RalphFixtures>({
 | `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.          |
+| `freezeDuringCapture` | `false`                  | Finishes finite browser animations, allows JS-driven DOM changes to settle within a bounded wait, then freezes timers and animations across capture. |
 | `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. |
 

package/dist/index.cjs

@@ -1,5 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_upload = require("./upload-CRXt3vt1.cjs");
+const require_upload = require("./upload-D40MqSQa.cjs");
 let node_path = require("node:path");
 node_path = require_upload.__toESM(node_path, 1);
 let _playwright_test = require("@playwright/test");
@@ -108,7 +108,7 @@ const test = _playwright_test.test.extend({
 			visitAllLinks: (links, options) => require_upload.visitAllLinks(links, async () => {}, options),
 			pause: () => {},
 			resume: () => {},
-			observe: () => {
+			observe: async () => {
 				checkOptIn();
 			}
 		});
@@ -120,7 +120,7 @@ const test = _playwright_test.test.extend({
 		} : contextOptions);
 	},
 	context: async ({ context, _ralphRecorder }, use) => {
-		_ralphRecorder?.observe(context);
+		await _ralphRecorder?.observe(context);
 		try {
 			await use(context);
 		} finally {

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":["loadConfigSync","base","resolveMode","path","loadConfig","Recorder","visitAllLinks"],"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';\nimport { visitAllLinks } from './visit_links';\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  VisitAllLinksOptions,\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        visitAllLinks: (links, options) =>\n          visitAllLinks(links, async () => {}, options),\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;;;ACxBA,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,gBAAgB,OAAO,YACrBI,eAAAA,cAAc,OAAO,YAAY,CAAC,GAAG,OAAO;GAC9C,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,KAAKJ,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","visitAllLinks"],"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';\nimport { visitAllLinks } from './visit_links';\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  VisitAllLinksOptions,\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        visitAllLinks: (links, options) =>\n          visitAllLinks(links, async () => {}, options),\n        pause: () => {},\n        resume: () => {},\n        observe: async () => {\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    await _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;;;ACxBA,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,gBAAgB,OAAO,YACrBI,eAAAA,cAAc,OAAO,YAAY,CAAC,GAAG,OAAO;GAC9C,aAAa,CAAC;GACd,cAAc,CAAC;GACf,SAAS,YAAY;IACnB,WAAW;GACb;EACF,CACF;CACF;CAEA,gBAAgB,OAAO,EAAE,gBAAgB,gBAAgB,KAAK,aAAa;EAGzE,MAAM,IADJ,SAAS,KAAK,SAAS,QAAQ,KAAKJ,eAAAA,YAAY,YAAY,MAAM,SAErD,aAAa,eACtB;GAAE,GAAG;GAAgB,eAAe;EAAS,IAC7C,cACN;CACF;CACA,SAAS,OAAO,EAAE,SAAS,kBAAkB,QAAQ;EACnD,MAAM,gBAAgB,QAAQ,OAAO;EACrC,IAAI;GACF,MAAM,IAAI,OAAO;EACnB,UAAU;GAER,MAAM,gBAAgB,YAAY,OAAO;EAC3C;CACF;AACF,CAAC"}

package/dist/index.d.mts

@@ -10,6 +10,13 @@ type RalphOptions = {
   buildId?: string;
   settleMs?: number;
   reduceMotion?: boolean;
+  /**
+   * Install Playwright's clock before navigation. Before capture, finish finite
+   * browser animations and allow JS-driven DOM changes to settle within a
+   * bounded wait, then pause timers and remaining animations. Defaults to false.
+   * Owns the context's clock; do not combine with manual page.clock control.
+   */
+  freezeDuringCapture?: boolean;
   recordTimeoutMs?: number;
   ready?: (page: Page, signal: AbortSignal) => Promise<void>;
   /**
@@ -87,7 +94,8 @@ type Ralph = {
   visitAllLinks(links: Locator, options?: VisitAllLinksOptions): Promise<void>;
   pause(): void;
   resume(): void;
-  observe(context: BrowserContext): void;
+  /** With freezeDuringCapture, await this before any scripts run in a custom context. */
+  observe(context: BrowserContext): Promise<void>;
 };
 type TrackedElement = {
   trackId: string;

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { _ as resolveMode, a as prepareArtifactUpload, f as Recorder, g as loadConfigSync, h as loadConfig, i as createRawGraphBundle, l as uploadRawGraph, p as visitAllLinks, u as MANIFEST_ATTACHMENT } from "./upload-CEc_qo01.mjs";
+import { _ as resolveMode, a as prepareArtifactUpload, f as Recorder, g as loadConfigSync, h as loadConfig, i as createRawGraphBundle, l as uploadRawGraph, p as visitAllLinks, u as MANIFEST_ATTACHMENT } from "./upload-jup_jLlm.mjs";
 import path from "node:path";
 import { expect, mergeTests, test as test$1 } from "@playwright/test";
 //#region src/screens.ts
@@ -106,7 +106,7 @@ const test = test$1.extend({
 			visitAllLinks: (links, options) => visitAllLinks(links, async () => {}, options),
 			pause: () => {},
 			resume: () => {},
-			observe: () => {
+			observe: async () => {
 				checkOptIn();
 			}
 		});
@@ -118,7 +118,7 @@ const test = test$1.extend({
 		} : contextOptions);
 	},
 	context: async ({ context, _ralphRecorder }, use) => {
-		_ralphRecorder?.observe(context);
+		await _ralphRecorder?.observe(context);
 		try {
 			await use(context);
 		} 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';\nimport { visitAllLinks } from './visit_links';\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  VisitAllLinksOptions,\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        visitAllLinks: (links, options) =>\n          visitAllLinks(links, async () => {}, options),\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;;;ACxBA,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,gBAAgB,OAAO,YACrB,cAAc,OAAO,YAAY,CAAC,GAAG,OAAO;GAC9C,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';\nimport { visitAllLinks } from './visit_links';\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  VisitAllLinksOptions,\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        visitAllLinks: (links, options) =>\n          visitAllLinks(links, async () => {}, options),\n        pause: () => {},\n        resume: () => {},\n        observe: async () => {\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    await _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;;;ACxBA,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,gBAAgB,OAAO,YACrB,cAAc,OAAO,YAAY,CAAC,GAAG,OAAO;GAC9C,aAAa,CAAC;GACd,cAAc,CAAC;GACf,SAAS,YAAY;IACnB,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,MAAM,gBAAgB,QAAQ,OAAO;EACrC,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-CRXt3vt1.cjs");
+const require_upload = require("./upload-D40MqSQa.cjs");
 let node_path = require("node:path");
 node_path = require_upload.__toESM(node_path, 1);
 let node_fs_promises = require("node:fs/promises");

package/dist/reporter.mjs

@@ -1,4 +1,4 @@
-import { _ as resolveMode, a as prepareArtifactUpload, c as resultLink, d as REPORTER_ENV, l as uploadRawGraph, m as version, n as bundleImagePath, o as registerDeployment, r as bundleSnapshotPath, s as resolveUploadOptions, t as RAW_GRAPH_BUNDLE_INDEX, u as MANIFEST_ATTACHMENT } from "./upload-CEc_qo01.mjs";
+import { _ as resolveMode, a as prepareArtifactUpload, c as resultLink, d as REPORTER_ENV, l as uploadRawGraph, m as version, n as bundleImagePath, o as registerDeployment, r as bundleSnapshotPath, s as resolveUploadOptions, t as RAW_GRAPH_BUNDLE_INDEX, u as MANIFEST_ATTACHMENT } from "./upload-jup_jLlm.mjs";
 import path from "node:path";
 import { mkdir, readFile, rm, writeFile } from "node:fs/promises";
 import { randomUUID } from "node:crypto";