@ralphralphai/playwright 1.8.0 → 2.0.0

package/dist/reporter.mjs

@@ -1,4 +1,4 @@
-import { a as resolveUploadOptions, c as MANIFEST_ATTACHMENT, d as version, i as prepareArtifactUpload, l as REPORTER_ENV, m as resolveMode, n as bundleImagePath, o as resultLink, s as uploadRawGraph, t as RAW_GRAPH_BUNDLE_INDEX } from "./upload-D5hePvmA.mjs";
+import { a as prepareArtifactUpload, c as resultLink, d as REPORTER_ENV, g as resolveMode, l as uploadRawGraph, n as bundleImagePath, o as registerDeployment, p as version, r as bundleSnapshotPath, s as resolveUploadOptions, t as RAW_GRAPH_BUNDLE_INDEX, u as MANIFEST_ATTACHMENT } from "./upload--pBJ67uZ.mjs";
 import path from "node:path";
 import { mkdir, readFile, rm, writeFile } from "node:fs/promises";
 import { randomUUID } from "node:crypto";
@@ -43,13 +43,17 @@ var RalphReporter = class {
 				...image,
 				bytes: typeof source === "string" ? await readFile(source) : source
 			})));
+			const snapshots = await Promise.all(merged.snapshots.map(async ({ nodeId, source }) => ({
+				nodeId,
+				bytes: typeof source === "string" ? await readFile(source) : source
+			})));
 			const uploading = resolveMode(this.options) === "upload" || collected.some(({ file }) => file.mode === "upload");
 			let prepared;
 			if (uploading) {
 				try {
-					prepared = await prepareArtifactUpload(resolveUploadOptions(this.options));
+					prepared = await this.reserve(merged.manifest);
 				} catch (error) {
-					const outputDir = await this.write(merged.manifest, screenshots);
+					const outputDir = await this.write(merged.manifest, screenshots, snapshots);
 					throw new Error(`${error instanceof Error ? error.message : String(error)} The recording was saved to ${outputDir}.`, { cause: error });
 				}
 				log(`Ralph: uploading the run. Follow the upload and processing at ${resultLink(prepared)}`);
@@ -59,10 +63,10 @@ var RalphReporter = class {
 				artifactId: prepared.artifactId
 			};
 			const nodeCount = manifest.rawGraphs.reduce((total, graph) => total + graph.nodes.length, 0);
-			const outputDir = await this.write(manifest, screenshots);
+			const outputDir = await this.write(manifest, screenshots, snapshots);
 			log(`Ralph: merged ${manifest.rawGraphs.length} test(s), ${nodeCount} node(s) into ${outputDir}`);
 			if (prepared !== void 0) {
-				const receipt = await uploadRawGraph(manifest, screenshots, resolveUploadOptions(this.options)).catch((error) => {
+				const receipt = await uploadRawGraph(manifest, screenshots, resolveUploadOptions(this.options), snapshots).catch((error) => {
 					throw new Error(`${error instanceof Error ? error.message : String(error)} The recording was saved to ${outputDir}.`, { cause: error });
 				});
 				await writeFile(path.join(outputDir, "upload_receipt.json"), JSON.stringify(receipt, null, 2) + "\n");
@@ -74,10 +78,19 @@ var RalphReporter = class {
 			return { status: "failed" };
 		}
 	}
+	reserve(manifest) {
+		const options = resolveUploadOptions(this.options);
+		if (!(this.options.deploy ?? process.env["RALPH_DEPLOY"] === "1")) return 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 registerDeployment(options, {
+			buildId: manifest.buildId,
+			config: manifest.config.config
+		});
+	}
 	printsToStdio() {
 		return false;
 	}
-	/** Merges the tests into one manifest, with where to read their screenshots. */
+	/** Merges the tests into one manifest, with where to read their screenshots and snapshots. */
 	merge(collected) {
 		const [first] = collected;
 		const same = (pick, what) => {
@@ -87,6 +100,7 @@ var RalphReporter = class {
 		same((file) => file.config, "Ralph config");
 		same((file) => [file.runId, file.buildId], "runId and buildId");
 		const images = [];
+		const snapshots = [];
 		const rawGraphs = collected.map(({ file, status, attachments }) => {
 			const nodes = file.rawGraph.nodes.map((node) => {
 				if (node.status !== "recorded") return node;
@@ -97,12 +111,22 @@ var RalphReporter = class {
 					contentType: node.screenshot.contentType,
 					source
 				});
+				const snapshot = node.ariaSnapshot && attachments.get(node.ariaSnapshot.attachmentName);
+				if (snapshot !== void 0) snapshots.push({
+					nodeId: node.nodeId,
+					source: snapshot
+				});
+				const { ariaSnapshot, ...rest } = node;
 				return {
-					...node,
+					...rest,
 					screenshot: {
 						...node.screenshot,
 						path: bundleImagePath(node.nodeId, node.screenshot.contentType)
-					}
+					},
+					...ariaSnapshot && snapshot !== void 0 && { ariaSnapshot: {
+						...ariaSnapshot,
+						path: bundleSnapshotPath(node.nodeId)
+					} }
 				};
 			});
 			return {
@@ -130,11 +154,12 @@ var RalphReporter = class {
 				rawGraphs,
 				complete: rawGraphs.every((graph) => graph.complete)
 			},
-			images
+			images,
+			snapshots
 		};
 	}
-	/** Writes the manifest and screenshots in the bundle's layout. */
-	async write(manifest, screenshots) {
+	/** Writes the manifest, screenshots and snapshots in the bundle's layout. */
+	async write(manifest, screenshots, snapshots) {
 		const outputDir = path.resolve(this.options.outputDir ?? path.join(this.config?.projects[0]?.outputDir ?? path.join(this.config?.rootDir ?? process.cwd(), "test-results"), "ralph"));
 		await rm(outputDir, {
 			recursive: true,
@@ -142,7 +167,8 @@ var RalphReporter = class {
 		});
 		const index = {
 			manifest,
-			screenshots: []
+			screenshots: [],
+			snapshots: []
 		};
 		for (const { nodeId, contentType, bytes } of screenshots) {
 			const imagePath = bundleImagePath(nodeId, contentType);
@@ -153,6 +179,15 @@ var RalphReporter = class {
 			await mkdir(path.dirname(path.join(outputDir, imagePath)), { recursive: true });
 			await writeFile(path.join(outputDir, imagePath), bytes);
 		}
+		for (const { nodeId, bytes } of snapshots) {
+			const snapshotPath = bundleSnapshotPath(nodeId);
+			index.snapshots.push({
+				nodeId,
+				path: snapshotPath
+			});
+			await mkdir(path.dirname(path.join(outputDir, snapshotPath)), { recursive: true });
+			await writeFile(path.join(outputDir, snapshotPath), bytes);
+		}
 		await mkdir(outputDir, { recursive: true });
 		await writeFile(path.join(outputDir, RAW_GRAPH_BUNDLE_INDEX), JSON.stringify(index, null, 2) + "\n");
 		return outputDir;

package/dist/reporter.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"reporter.mjs","names":["packageInfo.version"],"sources":["../src/reporter.ts"],"sourcesContent":["import { randomUUID } from 'node:crypto';\nimport { mkdir, readFile, rm, writeFile } from 'node:fs/promises';\nimport path from 'node:path';\n\nimport playwrightPackage from '@playwright/test/package.json' with { type: 'json' };\nimport type {\n  FullConfig,\n  FullResult,\n  Reporter,\n  TestCase,\n  TestResult,\n} from '@playwright/test/reporter';\n\nimport packageInfo from '../package.json';\nimport { resolveMode } from './config';\nimport { MANIFEST_ATTACHMENT, REPORTER_ENV } from './recorder';\nimport type { RawGraphManifest, RawGraph, RawGraphFile } from './types';\nimport {\n  RAW_GRAPH_BUNDLE_INDEX,\n  prepareArtifactUpload,\n  resolveUploadOptions,\n  resultLink,\n  bundleImagePath,\n  uploadRawGraph,\n  type PreparedUpload,\n  type RawGraphBundleIndex,\n  type RawGraphScreenshot,\n} from './upload';\n\nexport type RalphReporterOptions = {\n  /**\n   * `upload` uploads the merged raw graph. Defaults to `RALPH_MODE`, else\n   * `upload` when `RALPH_UPLOAD_KEY` is set. The run is also uploaded when any\n   * test ran in `upload` mode.\n   */\n  mode?: 'off' | 'local' | 'upload';\n  /** Your Ralph server. Defaults to `RALPH_API_URL`, else `https://api.ralphralph.ai`. */\n  apiUrl?: string;\n  /** The app the recordings belong to. Defaults to `RALPH_APP_ID`. */\n  appId?: string;\n  /** How long the upload may take, in milliseconds. Defaults to 120000. */\n  uploadTimeoutMs?: number;\n  /**\n   * Where the merged raw graph is written, laid out like the uploaded bundle.\n   * Defaults to `ralph` inside the first project's output directory.\n   */\n  outputDir?: string;\n};\n\n/** One test's final attempt, as the reporter collected it. */\ntype Collected = {\n  file: RawGraphFile;\n  status: TestResult['status'];\n  /** Screenshot attachment paths or preserved bodies, by attachment name. */\n  attachments: Map<string, string | Buffer>;\n};\n\n/**\n * Merges every recorded test's raw graph into one for the whole run, writes it\n * locally, and uploads it once when the mode is `upload`.\n *\n * Tests run in worker processes, so only a reporter, in the main process,\n * sees them all. For a sharded run, it runs in `playwright merge-reports` over\n * the shards' blob reports.\n */\nexport default class RalphReporter implements Reporter {\n  private readonly startedAt = new Date().toISOString();\n  private config?: FullConfig;\n\n  /**\n   * By test id, so a retry replaces the attempt before it. Read as each test\n   * ends, and awaited in `onEnd`.\n   */\n  private readonly tests = new Map<string, Promise<Collected | undefined>>();\n\n  constructor(private readonly options: RalphReporterOptions = {}) {\n    // Before any worker starts, so the fixtures can tell the reporter is on.\n    process.env[REPORTER_ENV] = '1';\n    if (resolveMode(options) === 'upload') {\n      // Throws, so missing credentials stop the run before any test.\n      resolveUploadOptions(options);\n    }\n  }\n\n  onBegin(config: FullConfig): void {\n    this.config = config;\n  }\n\n  onTestEnd(test: TestCase, result: TestResult): void {\n    const collected = collect(result);\n    // Rejections are reported in `onEnd`; this only stops Node from calling\n    // them unhandled in the meantime.\n    collected.catch(() => undefined);\n    this.tests.set(test.id, collected);\n  }\n\n  async onEnd(): Promise<{ status?: FullResult['status'] } | undefined> {\n    try {\n      const collected = (await Promise.all(this.tests.values())).filter(\n        (item) => item !== undefined,\n      );\n      if (collected.length === 0) {\n        return undefined;\n      }\n\n      const merged = this.merge(collected);\n      const screenshots = await Promise.all(\n        merged.images.map(\n          async ({ source, ...image }): Promise<RawGraphScreenshot> => ({\n            ...image,\n            bytes: typeof source === 'string' ? await readFile(source) : source,\n          }),\n        ),\n      );\n      const uploading =\n        resolveMode(this.options) === 'upload' ||\n        collected.some(({ file }) => file.mode === 'upload');\n\n      // Before the local copy is written, so it names the same artifact as the\n      // upload, and the link is printed as soon as it works.\n      let prepared: PreparedUpload | undefined;\n      if (uploading) {\n        try {\n          prepared = await prepareArtifactUpload(\n            resolveUploadOptions(this.options),\n          );\n        } catch (error) {\n          const outputDir = await this.write(merged.manifest, screenshots);\n          throw new Error(\n            `${error instanceof Error ? error.message : String(error)} The recording was saved to ${outputDir}.`,\n            { cause: error },\n          );\n        }\n        log(\n          `Ralph: uploading the run. Follow the upload and processing at ${resultLink(prepared)}`,\n        );\n      }\n      const manifest =\n        prepared === undefined\n          ? merged.manifest\n          : { ...merged.manifest, artifactId: prepared.artifactId };\n      const nodeCount = manifest.rawGraphs.reduce(\n        (total, graph) => total + graph.nodes.length,\n        0,\n      );\n      const outputDir = await this.write(manifest, screenshots);\n      log(\n        `Ralph: merged ${manifest.rawGraphs.length} test(s), ${nodeCount} node(s) into ${outputDir}`,\n      );\n\n      if (prepared !== undefined) {\n        const receipt = await uploadRawGraph(\n          manifest,\n          screenshots,\n          resolveUploadOptions(this.options),\n        ).catch((error: unknown) => {\n          throw new Error(\n            `${error instanceof Error ? error.message : String(error)} The recording was saved to ${outputDir}.`,\n            { cause: error },\n          );\n        });\n        await writeFile(\n          path.join(outputDir, 'upload_receipt.json'),\n          JSON.stringify(receipt, null, 2) + '\\n',\n        );\n        log(\n          `Ralph: uploaded the run. Ralph is processing it at ${resultLink(receipt)}`,\n        );\n      }\n      return undefined;\n    } catch (error) {\n      console.error(\n        'Ralph: ' + (error instanceof Error ? error.message : String(error)),\n      );\n      return { status: 'failed' };\n    }\n  }\n\n  printsToStdio(): boolean {\n    return false;\n  }\n\n  /** Merges the tests into one manifest, with where to read their screenshots. */\n  private merge(collected: Collected[]): {\n    manifest: RawGraphManifest;\n    images: (Omit<RawGraphScreenshot, 'bytes'> & { source: string | Buffer })[];\n  } {\n    const [first] = collected;\n    const same = (pick: (file: RawGraphFile) => unknown, what: string) => {\n      const expected = JSON.stringify(pick(first!.file));\n      if (\n        collected.some(({ file }) => JSON.stringify(pick(file)) !== expected)\n      ) {\n        throw new Error(\n          `Every recorded test in a run must share one ${what}; merge them per run.`,\n        );\n      }\n    };\n    same((file) => file.config, 'Ralph config');\n    same((file) => [file.runId, file.buildId], 'runId and buildId');\n\n    const images: (Omit<RawGraphScreenshot, 'bytes'> & {\n      source: string | Buffer;\n    })[] = [];\n    const rawGraphs = collected\n      .map(({ file, status, attachments }): RawGraph => {\n        const nodes = file.rawGraph.nodes.map((node) => {\n          if (node.status !== 'recorded') {\n            return node;\n          }\n          const source = attachments.get(node.screenshot.attachmentName);\n          if (source === undefined) {\n            throw new Error(\n              `The screenshot of node ${node.nodeId} is missing from the test results.`,\n            );\n          }\n          images.push({\n            nodeId: node.nodeId,\n            contentType: node.screenshot.contentType,\n            source,\n          });\n          return {\n            ...node,\n            screenshot: {\n              ...node.screenshot,\n              path: bundleImagePath(node.nodeId, node.screenshot.contentType),\n            },\n          };\n        });\n        return {\n          ...file.rawGraph,\n          // The final status, which includes failures after the recorder\n          // finished, such as a later fixture's teardown.\n          status,\n          nodes,\n          complete: file.rawGraph.complete && status === 'passed',\n        };\n      })\n      .sort(\n        (a, b) =>\n          a.project.localeCompare(b.project) ||\n          a.titlePath.join('\\0').localeCompare(b.titlePath.join('\\0')) ||\n          a.repeatEachIndex - b.repeatEachIndex,\n      );\n\n    const manifest: RawGraphManifest = {\n      formatVersion: 1,\n      producer: {\n        name: '@ralphralphai/playwright',\n        version: packageInfo.version,\n        playwrightVersion: playwrightPackage.version,\n      },\n      runId: first!.file.runId,\n      buildId: first!.file.buildId,\n      // Replaced by the prepared artifact's id when the run is uploaded.\n      artifactId: randomUUID(),\n      shard: this.config?.shard ?? null,\n      startedAt: this.startedAt,\n      finishedAt: new Date().toISOString(),\n      config: first!.file.config,\n      rawGraphs,\n      complete: rawGraphs.every((graph) => graph.complete),\n    };\n\n    return {\n      manifest,\n      images,\n    };\n  }\n\n  /** Writes the manifest and screenshots in the bundle's layout. */\n  private async write(\n    manifest: RawGraphManifest,\n    screenshots: RawGraphScreenshot[],\n  ): Promise<string> {\n    const outputDir = path.resolve(\n      this.options.outputDir ??\n        path.join(\n          this.config?.projects[0]?.outputDir ??\n            path.join(this.config?.rootDir ?? process.cwd(), 'test-results'),\n          'ralph',\n        ),\n    );\n    await rm(outputDir, { recursive: true, force: true });\n\n    const index: RawGraphBundleIndex = { manifest, screenshots: [] };\n    for (const { nodeId, contentType, bytes } of screenshots) {\n      const imagePath = bundleImagePath(nodeId, contentType);\n      index.screenshots.push({ nodeId, path: imagePath });\n      await mkdir(path.dirname(path.join(outputDir, imagePath)), {\n        recursive: true,\n      });\n      await writeFile(path.join(outputDir, imagePath), bytes);\n    }\n    await mkdir(outputDir, { recursive: true });\n    await writeFile(\n      path.join(outputDir, RAW_GRAPH_BUNDLE_INDEX),\n      JSON.stringify(index, null, 2) + '\\n',\n    );\n    return outputDir;\n  }\n}\n\n/** Reads a test's raw graph from its attachments; undefined if it recorded nothing. */\nasync function collect(result: TestResult): Promise<Collected | undefined> {\n  const manifest = result.attachments.find(\n    (item) => item.name === MANIFEST_ATTACHMENT,\n  );\n  if (!manifest || (!manifest.body && !manifest.path)) {\n    return undefined;\n  }\n  const file = JSON.parse(\n    manifest.body?.toString('utf8') ?? (await readFile(manifest.path!, 'utf8')),\n  ) as RawGraphFile;\n  const attachments = new Map<string, string | Buffer>();\n  for (const { name, path: attachmentPath, body } of result.attachments) {\n    const source = body ?? attachmentPath;\n    if (source !== undefined) {\n      attachments.set(name, source);\n    }\n  }\n  return { file, status: result.status, attachments };\n}\n\nfunction log(message: string): void {\n  process.stdout.write(message + '\\n');\n}\n"],"mappings":";;;;;;;;;;;;;;AAiEA,IAAqB,gBAArB,MAAuD;CAUxB;CAT7B,6BAA6B,IAAI,KAAK,EAAA,CAAE,YAAY;CACpD;;;;;CAMA,wBAAyB,IAAI,IAA4C;CAEzE,YAAY,UAAiD,CAAC,GAAG;EAApC,KAAA,UAAA;EAE3B,QAAQ,IAAI,gBAAgB;EAC5B,IAAI,YAAY,OAAO,MAAM,UAE3B,qBAAqB,OAAO;CAEhC;CAEA,QAAQ,QAA0B;EAChC,KAAK,SAAS;CAChB;CAEA,UAAU,MAAgB,QAA0B;EAClD,MAAM,YAAY,QAAQ,MAAM;EAGhC,UAAU,YAAY,KAAA,CAAS;EAC/B,KAAK,MAAM,IAAI,KAAK,IAAI,SAAS;CACnC;CAEA,MAAM,QAAgE;EACpE,IAAI;GACF,MAAM,aAAa,MAAM,QAAQ,IAAI,KAAK,MAAM,OAAO,CAAC,EAAA,CAAG,QACxD,SAAS,SAAS,KAAA,CACrB;GACA,IAAI,UAAU,WAAW,GACvB;GAGF,MAAM,SAAS,KAAK,MAAM,SAAS;GACnC,MAAM,cAAc,MAAM,QAAQ,IAChC,OAAO,OAAO,IACZ,OAAO,EAAE,QAAQ,GAAG,aAA0C;IAC5D,GAAG;IACH,OAAO,OAAO,WAAW,WAAW,MAAM,SAAS,MAAM,IAAI;GAC/D,EACF,CACF;GACA,MAAM,YACJ,YAAY,KAAK,OAAO,MAAM,YAC9B,UAAU,MAAM,EAAE,WAAW,KAAK,SAAS,QAAQ;GAIrD,IAAI;GACJ,IAAI,WAAW;IACb,IAAI;KACF,WAAW,MAAM,sBACf,qBAAqB,KAAK,OAAO,CACnC;IACF,SAAS,OAAO;KACd,MAAM,YAAY,MAAM,KAAK,MAAM,OAAO,UAAU,WAAW;KAC/D,MAAM,IAAI,MACR,GAAG,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK,EAAE,8BAA8B,UAAU,IAClG,EAAE,OAAO,MAAM,CACjB;IACF;IACA,IACE,iEAAiE,WAAW,QAAQ,GACtF;GACF;GACA,MAAM,WACJ,aAAa,KAAA,IACT,OAAO,WACP;IAAE,GAAG,OAAO;IAAU,YAAY,SAAS;GAAW;GAC5D,MAAM,YAAY,SAAS,UAAU,QAClC,OAAO,UAAU,QAAQ,MAAM,MAAM,QACtC,CACF;GACA,MAAM,YAAY,MAAM,KAAK,MAAM,UAAU,WAAW;GACxD,IACE,iBAAiB,SAAS,UAAU,OAAO,YAAY,UAAU,gBAAgB,WACnF;GAEA,IAAI,aAAa,KAAA,GAAW;IAC1B,MAAM,UAAU,MAAM,eACpB,UACA,aACA,qBAAqB,KAAK,OAAO,CACnC,CAAC,CAAC,OAAO,UAAmB;KAC1B,MAAM,IAAI,MACR,GAAG,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK,EAAE,8BAA8B,UAAU,IAClG,EAAE,OAAO,MAAM,CACjB;IACF,CAAC;IACD,MAAM,UACJ,KAAK,KAAK,WAAW,qBAAqB,GAC1C,KAAK,UAAU,SAAS,MAAM,CAAC,IAAI,IACrC;IACA,IACE,sDAAsD,WAAW,OAAO,GAC1E;GACF;GACA;EACF,SAAS,OAAO;GACd,QAAQ,MACN,aAAa,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK,EACpE;GACA,OAAO,EAAE,QAAQ,SAAS;EAC5B;CACF;CAEA,gBAAyB;EACvB,OAAO;CACT;;CAGA,MAAc,WAGZ;EACA,MAAM,CAAC,SAAS;EAChB,MAAM,QAAQ,MAAuC,SAAiB;GACpE,MAAM,WAAW,KAAK,UAAU,KAAK,MAAO,IAAI,CAAC;GACjD,IACE,UAAU,MAAM,EAAE,WAAW,KAAK,UAAU,KAAK,IAAI,CAAC,MAAM,QAAQ,GAEpE,MAAM,IAAI,MACR,+CAA+C,KAAK,sBACtD;EAEJ;EACA,MAAM,SAAS,KAAK,QAAQ,cAAc;EAC1C,MAAM,SAAS,CAAC,KAAK,OAAO,KAAK,OAAO,GAAG,mBAAmB;EAE9D,MAAM,SAEC,CAAC;EACR,MAAM,YAAY,UACf,KAAK,EAAE,MAAM,QAAQ,kBAA4B;GAChD,MAAM,QAAQ,KAAK,SAAS,MAAM,KAAK,SAAS;IAC9C,IAAI,KAAK,WAAW,YAClB,OAAO;IAET,MAAM,SAAS,YAAY,IAAI,KAAK,WAAW,cAAc;IAC7D,IAAI,WAAW,KAAA,GACb,MAAM,IAAI,MACR,0BAA0B,KAAK,OAAO,mCACxC;IAEF,OAAO,KAAK;KACV,QAAQ,KAAK;KACb,aAAa,KAAK,WAAW;KAC7B;IACF,CAAC;IACD,OAAO;KACL,GAAG;KACH,YAAY;MACV,GAAG,KAAK;MACR,MAAM,gBAAgB,KAAK,QAAQ,KAAK,WAAW,WAAW;KAChE;IACF;GACF,CAAC;GACD,OAAO;IACL,GAAG,KAAK;IAGR;IACA;IACA,UAAU,KAAK,SAAS,YAAY,WAAW;GACjD;EACF,CAAC,CAAC,CACD,MACE,GAAG,MACF,EAAE,QAAQ,cAAc,EAAE,OAAO,KACjC,EAAE,UAAU,KAAK,IAAI,CAAC,CAAC,cAAc,EAAE,UAAU,KAAK,IAAI,CAAC,KAC3D,EAAE,kBAAkB,EAAE,eAC1B;EAqBF,OAAO;GACL,UAAA;IAnBA,eAAe;IACf,UAAU;KACR,MAAM;KACGA;KACT,mBAAmB,kBAAkB;IACvC;IACA,OAAO,MAAO,KAAK;IACnB,SAAS,MAAO,KAAK;IAErB,YAAY,WAAW;IACvB,OAAO,KAAK,QAAQ,SAAS;IAC7B,WAAW,KAAK;IAChB,6BAAY,IAAI,KAAK,EAAA,CAAE,YAAY;IACnC,QAAQ,MAAO,KAAK;IACpB;IACA,UAAU,UAAU,OAAO,UAAU,MAAM,QAAQ;GAI5C;GACP;EACF;CACF;;CAGA,MAAc,MACZ,UACA,aACiB;EACjB,MAAM,YAAY,KAAK,QACrB,KAAK,QAAQ,aACX,KAAK,KACH,KAAK,QAAQ,SAAS,EAAE,EAAE,aACxB,KAAK,KAAK,KAAK,QAAQ,WAAW,QAAQ,IAAI,GAAG,cAAc,GACjE,OACF,CACJ;EACA,MAAM,GAAG,WAAW;GAAE,WAAW;GAAM,OAAO;EAAK,CAAC;EAEpD,MAAM,QAA6B;GAAE;GAAU,aAAa,CAAC;EAAE;EAC/D,KAAK,MAAM,EAAE,QAAQ,aAAa,WAAW,aAAa;GACxD,MAAM,YAAY,gBAAgB,QAAQ,WAAW;GACrD,MAAM,YAAY,KAAK;IAAE;IAAQ,MAAM;GAAU,CAAC;GAClD,MAAM,MAAM,KAAK,QAAQ,KAAK,KAAK,WAAW,SAAS,CAAC,GAAG,EACzD,WAAW,KACb,CAAC;GACD,MAAM,UAAU,KAAK,KAAK,WAAW,SAAS,GAAG,KAAK;EACxD;EACA,MAAM,MAAM,WAAW,EAAE,WAAW,KAAK,CAAC;EAC1C,MAAM,UACJ,KAAK,KAAK,WAAW,sBAAsB,GAC3C,KAAK,UAAU,OAAO,MAAM,CAAC,IAAI,IACnC;EACA,OAAO;CACT;AACF;;AAGA,eAAe,QAAQ,QAAoD;CACzE,MAAM,WAAW,OAAO,YAAY,MACjC,SAAS,KAAK,SAAS,mBAC1B;CACA,IAAI,CAAC,YAAa,CAAC,SAAS,QAAQ,CAAC,SAAS,MAC5C;CAEF,MAAM,OAAO,KAAK,MAChB,SAAS,MAAM,SAAS,MAAM,KAAM,MAAM,SAAS,SAAS,MAAO,MAAM,CAC3E;CACA,MAAM,8BAAc,IAAI,IAA6B;CACrD,KAAK,MAAM,EAAE,MAAM,MAAM,gBAAgB,UAAU,OAAO,aAAa;EACrE,MAAM,SAAS,QAAQ;EACvB,IAAI,WAAW,KAAA,GACb,YAAY,IAAI,MAAM,MAAM;CAEhC;CACA,OAAO;EAAE;EAAM,QAAQ,OAAO;EAAQ;CAAY;AACpD;AAEA,SAAS,IAAI,SAAuB;CAClC,QAAQ,OAAO,MAAM,UAAU,IAAI;AACrC"}
+{"version":3,"file":"reporter.mjs","names":["packageInfo.version"],"sources":["../src/reporter.ts"],"sourcesContent":["import { randomUUID } from 'node:crypto';\nimport { mkdir, readFile, rm, writeFile } from 'node:fs/promises';\nimport path from 'node:path';\n\nimport playwrightPackage from '@playwright/test/package.json' with { type: 'json' };\nimport type {\n  FullConfig,\n  FullResult,\n  Reporter,\n  TestCase,\n  TestResult,\n} from '@playwright/test/reporter';\n\nimport packageInfo from '../package.json';\nimport { resolveMode } from './config';\nimport { MANIFEST_ATTACHMENT, REPORTER_ENV } from './recorder';\nimport type { RawGraphManifest, RawGraph, RawGraphFile } from './types';\nimport {\n  RAW_GRAPH_BUNDLE_INDEX,\n  prepareArtifactUpload,\n  registerDeployment,\n  resolveUploadOptions,\n  resultLink,\n  bundleImagePath,\n  bundleSnapshotPath,\n  uploadRawGraph,\n  type PreparedUpload,\n  type RawGraphAriaSnapshot,\n  type RawGraphBundleIndex,\n  type RawGraphScreenshot,\n} from './upload';\n\nexport type RalphReporterOptions = {\n  /**\n   * `upload` uploads the merged raw graph. Defaults to `RALPH_MODE`, else\n   * `upload` when `RALPH_UPLOAD_KEY` is set. The run is also uploaded when any\n   * test ran in `upload` mode.\n   */\n  mode?: 'off' | 'local' | 'upload';\n  /** Your Ralph server. Defaults to `RALPH_API_URL`, else `https://api.ralphralph.ai`. */\n  apiUrl?: string;\n  /** The app the recordings belong to. Defaults to `RALPH_APP_ID`. */\n  appId?: string;\n  /** How long the upload may take, in milliseconds. Defaults to 120000. */\n  uploadTimeoutMs?: number;\n  /**\n   * Upload the run as the graph of the deployed build `RALPH_BUILD_ID` names,\n   * rather than as a standalone result. See `registerDeployment`. Defaults to\n   * `RALPH_DEPLOY` being `1`.\n   */\n  deploy?: boolean;\n  /**\n   * Where the merged raw graph is written, laid out like the uploaded bundle.\n   * Defaults to `ralph` inside the first project's output directory.\n   */\n  outputDir?: string;\n};\n\n/** One test's final attempt, as the reporter collected it. */\ntype Collected = {\n  file: RawGraphFile;\n  status: TestResult['status'];\n  /** Screenshot and snapshot attachment paths or preserved bodies, by attachment name. */\n  attachments: Map<string, string | Buffer>;\n};\n\n/**\n * Merges every recorded test's raw graph into one for the whole run, writes it\n * locally, and uploads it once when the mode is `upload`.\n *\n * Tests run in worker processes, so only a reporter, in the main process,\n * sees them all. For a sharded run, it runs in `playwright merge-reports` over\n * the shards' blob reports.\n */\nexport default class RalphReporter implements Reporter {\n  private readonly startedAt = new Date().toISOString();\n  private config?: FullConfig;\n\n  /**\n   * By test id, so a retry replaces the attempt before it. Read as each test\n   * ends, and awaited in `onEnd`.\n   */\n  private readonly tests = new Map<string, Promise<Collected | undefined>>();\n\n  constructor(private readonly options: RalphReporterOptions = {}) {\n    // Before any worker starts, so the fixtures can tell the reporter is on.\n    process.env[REPORTER_ENV] = '1';\n    if (resolveMode(options) === 'upload') {\n      // Throws, so missing credentials stop the run before any test.\n      resolveUploadOptions(options);\n    }\n  }\n\n  onBegin(config: FullConfig): void {\n    this.config = config;\n  }\n\n  onTestEnd(test: TestCase, result: TestResult): void {\n    const collected = collect(result);\n    // Rejections are reported in `onEnd`; this only stops Node from calling\n    // them unhandled in the meantime.\n    collected.catch(() => undefined);\n    this.tests.set(test.id, collected);\n  }\n\n  async onEnd(): Promise<{ status?: FullResult['status'] } | undefined> {\n    try {\n      const collected = (await Promise.all(this.tests.values())).filter(\n        (item) => item !== undefined,\n      );\n      if (collected.length === 0) {\n        return undefined;\n      }\n\n      const merged = this.merge(collected);\n      const screenshots = await Promise.all(\n        merged.images.map(\n          async ({ source, ...image }): Promise<RawGraphScreenshot> => ({\n            ...image,\n            bytes: typeof source === 'string' ? await readFile(source) : source,\n          }),\n        ),\n      );\n      const snapshots = await Promise.all(\n        merged.snapshots.map(\n          async ({ nodeId, source }): Promise<RawGraphAriaSnapshot> => ({\n            nodeId,\n            bytes: typeof source === 'string' ? await readFile(source) : source,\n          }),\n        ),\n      );\n      const uploading =\n        resolveMode(this.options) === 'upload' ||\n        collected.some(({ file }) => file.mode === 'upload');\n\n      // Before the local copy is written, so it names the same artifact as the\n      // upload, and the link is printed as soon as it works.\n      let prepared: PreparedUpload | undefined;\n      if (uploading) {\n        try {\n          prepared = await this.reserve(merged.manifest);\n        } catch (error) {\n          const outputDir = await this.write(\n            merged.manifest,\n            screenshots,\n            snapshots,\n          );\n          throw new Error(\n            `${error instanceof Error ? error.message : String(error)} The recording was saved to ${outputDir}.`,\n            { cause: error },\n          );\n        }\n        log(\n          `Ralph: uploading the run. Follow the upload and processing at ${resultLink(prepared)}`,\n        );\n      }\n      const manifest =\n        prepared === undefined\n          ? merged.manifest\n          : { ...merged.manifest, artifactId: prepared.artifactId };\n      const nodeCount = manifest.rawGraphs.reduce(\n        (total, graph) => total + graph.nodes.length,\n        0,\n      );\n      const outputDir = await this.write(manifest, screenshots, snapshots);\n      log(\n        `Ralph: merged ${manifest.rawGraphs.length} test(s), ${nodeCount} node(s) into ${outputDir}`,\n      );\n\n      if (prepared !== undefined) {\n        const receipt = await uploadRawGraph(\n          manifest,\n          screenshots,\n          resolveUploadOptions(this.options),\n          snapshots,\n        ).catch((error: unknown) => {\n          throw new Error(\n            `${error instanceof Error ? error.message : String(error)} The recording was saved to ${outputDir}.`,\n            { cause: error },\n          );\n        });\n        await writeFile(\n          path.join(outputDir, 'upload_receipt.json'),\n          JSON.stringify(receipt, null, 2) + '\\n',\n        );\n        log(\n          `Ralph: uploaded the run. Ralph is processing it at ${resultLink(receipt)}`,\n        );\n      }\n      return undefined;\n    } catch (error) {\n      console.error(\n        'Ralph: ' + (error instanceof Error ? error.message : String(error)),\n      );\n      return { status: 'failed' };\n    }\n  }\n\n  private reserve(manifest: RawGraphManifest): Promise<PreparedUpload> {\n    const options = resolveUploadOptions(this.options);\n    const deploy = this.options.deploy ?? process.env['RALPH_DEPLOY'] === '1';\n    if (!deploy) {\n      return prepareArtifactUpload(options);\n    }\n\n    if (manifest.buildId === undefined) {\n      throw new Error(\n        'A deployment run uploads into its build, so set RALPH_BUILD_ID (or the buildId option) to the deployed build.',\n      );\n    }\n    return registerDeployment(options, {\n      buildId: manifest.buildId,\n      config: manifest.config.config,\n    });\n  }\n\n  printsToStdio(): boolean {\n    return false;\n  }\n\n  /** Merges the tests into one manifest, with where to read their screenshots and snapshots. */\n  private merge(collected: Collected[]): {\n    manifest: RawGraphManifest;\n    images: (Omit<RawGraphScreenshot, 'bytes'> & { source: string | Buffer })[];\n    snapshots: { nodeId: string; source: string | Buffer }[];\n  } {\n    const [first] = collected;\n    const same = (pick: (file: RawGraphFile) => unknown, what: string) => {\n      const expected = JSON.stringify(pick(first!.file));\n      if (\n        collected.some(({ file }) => JSON.stringify(pick(file)) !== expected)\n      ) {\n        throw new Error(\n          `Every recorded test in a run must share one ${what}; merge them per run.`,\n        );\n      }\n    };\n    same((file) => file.config, 'Ralph config');\n    same((file) => [file.runId, file.buildId], 'runId and buildId');\n\n    const images: (Omit<RawGraphScreenshot, 'bytes'> & {\n      source: string | Buffer;\n    })[] = [];\n    const snapshots: { nodeId: string; source: string | Buffer }[] = [];\n    const rawGraphs = collected\n      .map(({ file, status, attachments }): RawGraph => {\n        const nodes = file.rawGraph.nodes.map((node) => {\n          if (node.status !== 'recorded') {\n            return node;\n          }\n          const source = attachments.get(node.screenshot.attachmentName);\n          if (source === undefined) {\n            throw new Error(\n              `The screenshot of node ${node.nodeId} is missing from the test results.`,\n            );\n          }\n          images.push({\n            nodeId: node.nodeId,\n            contentType: node.screenshot.contentType,\n            source,\n          });\n          // A snapshot is optional, so one missing from the results drops\n          // from the node rather than failing the run.\n          const snapshot =\n            node.ariaSnapshot &&\n            attachments.get(node.ariaSnapshot.attachmentName);\n          if (snapshot !== undefined) {\n            snapshots.push({ nodeId: node.nodeId, source: snapshot });\n          }\n          const { ariaSnapshot, ...rest } = node;\n          return {\n            ...rest,\n            screenshot: {\n              ...node.screenshot,\n              path: bundleImagePath(node.nodeId, node.screenshot.contentType),\n            },\n            ...(ariaSnapshot &&\n              snapshot !== undefined && {\n                ariaSnapshot: {\n                  ...ariaSnapshot,\n                  path: bundleSnapshotPath(node.nodeId),\n                },\n              }),\n          };\n        });\n        return {\n          ...file.rawGraph,\n          // The final status, which includes failures after the recorder\n          // finished, such as a later fixture's teardown.\n          status,\n          nodes,\n          complete: file.rawGraph.complete && status === 'passed',\n        };\n      })\n      .sort(\n        (a, b) =>\n          a.project.localeCompare(b.project) ||\n          a.titlePath.join('\\0').localeCompare(b.titlePath.join('\\0')) ||\n          a.repeatEachIndex - b.repeatEachIndex,\n      );\n\n    const manifest: RawGraphManifest = {\n      formatVersion: 1,\n      producer: {\n        name: '@ralphralphai/playwright',\n        version: packageInfo.version,\n        playwrightVersion: playwrightPackage.version,\n      },\n      runId: first!.file.runId,\n      buildId: first!.file.buildId,\n      // Replaced by the prepared artifact's id when the run is uploaded.\n      artifactId: randomUUID(),\n      shard: this.config?.shard ?? null,\n      startedAt: this.startedAt,\n      finishedAt: new Date().toISOString(),\n      config: first!.file.config,\n      rawGraphs,\n      complete: rawGraphs.every((graph) => graph.complete),\n    };\n\n    return {\n      manifest,\n      images,\n      snapshots,\n    };\n  }\n\n  /** Writes the manifest, screenshots and snapshots in the bundle's layout. */\n  private async write(\n    manifest: RawGraphManifest,\n    screenshots: RawGraphScreenshot[],\n    snapshots: RawGraphAriaSnapshot[],\n  ): Promise<string> {\n    const outputDir = path.resolve(\n      this.options.outputDir ??\n        path.join(\n          this.config?.projects[0]?.outputDir ??\n            path.join(this.config?.rootDir ?? process.cwd(), 'test-results'),\n          'ralph',\n        ),\n    );\n    await rm(outputDir, { recursive: true, force: true });\n\n    const index: RawGraphBundleIndex = {\n      manifest,\n      screenshots: [],\n      snapshots: [],\n    };\n    for (const { nodeId, contentType, bytes } of screenshots) {\n      const imagePath = bundleImagePath(nodeId, contentType);\n      index.screenshots.push({ nodeId, path: imagePath });\n      await mkdir(path.dirname(path.join(outputDir, imagePath)), {\n        recursive: true,\n      });\n      await writeFile(path.join(outputDir, imagePath), bytes);\n    }\n    for (const { nodeId, bytes } of snapshots) {\n      const snapshotPath = bundleSnapshotPath(nodeId);\n      index.snapshots.push({ nodeId, path: snapshotPath });\n      await mkdir(path.dirname(path.join(outputDir, snapshotPath)), {\n        recursive: true,\n      });\n      await writeFile(path.join(outputDir, snapshotPath), bytes);\n    }\n    await mkdir(outputDir, { recursive: true });\n    await writeFile(\n      path.join(outputDir, RAW_GRAPH_BUNDLE_INDEX),\n      JSON.stringify(index, null, 2) + '\\n',\n    );\n    return outputDir;\n  }\n}\n\n/** Reads a test's raw graph from its attachments; undefined if it recorded nothing. */\nasync function collect(result: TestResult): Promise<Collected | undefined> {\n  const manifest = result.attachments.find(\n    (item) => item.name === MANIFEST_ATTACHMENT,\n  );\n  if (!manifest || (!manifest.body && !manifest.path)) {\n    return undefined;\n  }\n  const file = JSON.parse(\n    manifest.body?.toString('utf8') ?? (await readFile(manifest.path!, 'utf8')),\n  ) as RawGraphFile;\n  const attachments = new Map<string, string | Buffer>();\n  for (const { name, path: attachmentPath, body } of result.attachments) {\n    const source = body ?? attachmentPath;\n    if (source !== undefined) {\n      attachments.set(name, source);\n    }\n  }\n  return { file, status: result.status, attachments };\n}\n\nfunction log(message: string): void {\n  process.stdout.write(message + '\\n');\n}\n"],"mappings":";;;;;;;;;;;;;;AA0EA,IAAqB,gBAArB,MAAuD;CAUxB;CAT7B,6BAA6B,IAAI,KAAK,EAAA,CAAE,YAAY;CACpD;;;;;CAMA,wBAAyB,IAAI,IAA4C;CAEzE,YAAY,UAAiD,CAAC,GAAG;EAApC,KAAA,UAAA;EAE3B,QAAQ,IAAI,gBAAgB;EAC5B,IAAI,YAAY,OAAO,MAAM,UAE3B,qBAAqB,OAAO;CAEhC;CAEA,QAAQ,QAA0B;EAChC,KAAK,SAAS;CAChB;CAEA,UAAU,MAAgB,QAA0B;EAClD,MAAM,YAAY,QAAQ,MAAM;EAGhC,UAAU,YAAY,KAAA,CAAS;EAC/B,KAAK,MAAM,IAAI,KAAK,IAAI,SAAS;CACnC;CAEA,MAAM,QAAgE;EACpE,IAAI;GACF,MAAM,aAAa,MAAM,QAAQ,IAAI,KAAK,MAAM,OAAO,CAAC,EAAA,CAAG,QACxD,SAAS,SAAS,KAAA,CACrB;GACA,IAAI,UAAU,WAAW,GACvB;GAGF,MAAM,SAAS,KAAK,MAAM,SAAS;GACnC,MAAM,cAAc,MAAM,QAAQ,IAChC,OAAO,OAAO,IACZ,OAAO,EAAE,QAAQ,GAAG,aAA0C;IAC5D,GAAG;IACH,OAAO,OAAO,WAAW,WAAW,MAAM,SAAS,MAAM,IAAI;GAC/D,EACF,CACF;GACA,MAAM,YAAY,MAAM,QAAQ,IAC9B,OAAO,UAAU,IACf,OAAO,EAAE,QAAQ,cAA6C;IAC5D;IACA,OAAO,OAAO,WAAW,WAAW,MAAM,SAAS,MAAM,IAAI;GAC/D,EACF,CACF;GACA,MAAM,YACJ,YAAY,KAAK,OAAO,MAAM,YAC9B,UAAU,MAAM,EAAE,WAAW,KAAK,SAAS,QAAQ;GAIrD,IAAI;GACJ,IAAI,WAAW;IACb,IAAI;KACF,WAAW,MAAM,KAAK,QAAQ,OAAO,QAAQ;IAC/C,SAAS,OAAO;KACd,MAAM,YAAY,MAAM,KAAK,MAC3B,OAAO,UACP,aACA,SACF;KACA,MAAM,IAAI,MACR,GAAG,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK,EAAE,8BAA8B,UAAU,IAClG,EAAE,OAAO,MAAM,CACjB;IACF;IACA,IACE,iEAAiE,WAAW,QAAQ,GACtF;GACF;GACA,MAAM,WACJ,aAAa,KAAA,IACT,OAAO,WACP;IAAE,GAAG,OAAO;IAAU,YAAY,SAAS;GAAW;GAC5D,MAAM,YAAY,SAAS,UAAU,QAClC,OAAO,UAAU,QAAQ,MAAM,MAAM,QACtC,CACF;GACA,MAAM,YAAY,MAAM,KAAK,MAAM,UAAU,aAAa,SAAS;GACnE,IACE,iBAAiB,SAAS,UAAU,OAAO,YAAY,UAAU,gBAAgB,WACnF;GAEA,IAAI,aAAa,KAAA,GAAW;IAC1B,MAAM,UAAU,MAAM,eACpB,UACA,aACA,qBAAqB,KAAK,OAAO,GACjC,SACF,CAAC,CAAC,OAAO,UAAmB;KAC1B,MAAM,IAAI,MACR,GAAG,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK,EAAE,8BAA8B,UAAU,IAClG,EAAE,OAAO,MAAM,CACjB;IACF,CAAC;IACD,MAAM,UACJ,KAAK,KAAK,WAAW,qBAAqB,GAC1C,KAAK,UAAU,SAAS,MAAM,CAAC,IAAI,IACrC;IACA,IACE,sDAAsD,WAAW,OAAO,GAC1E;GACF;GACA;EACF,SAAS,OAAO;GACd,QAAQ,MACN,aAAa,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK,EACpE;GACA,OAAO,EAAE,QAAQ,SAAS;EAC5B;CACF;CAEA,QAAgB,UAAqD;EACnE,MAAM,UAAU,qBAAqB,KAAK,OAAO;EAEjD,IAAI,EADW,KAAK,QAAQ,UAAU,QAAQ,IAAI,oBAAoB,MAEpE,OAAO,sBAAsB,OAAO;EAGtC,IAAI,SAAS,YAAY,KAAA,GACvB,MAAM,IAAI,MACR,+GACF;EAEF,OAAO,mBAAmB,SAAS;GACjC,SAAS,SAAS;GAClB,QAAQ,SAAS,OAAO;EAC1B,CAAC;CACH;CAEA,gBAAyB;EACvB,OAAO;CACT;;CAGA,MAAc,WAIZ;EACA,MAAM,CAAC,SAAS;EAChB,MAAM,QAAQ,MAAuC,SAAiB;GACpE,MAAM,WAAW,KAAK,UAAU,KAAK,MAAO,IAAI,CAAC;GACjD,IACE,UAAU,MAAM,EAAE,WAAW,KAAK,UAAU,KAAK,IAAI,CAAC,MAAM,QAAQ,GAEpE,MAAM,IAAI,MACR,+CAA+C,KAAK,sBACtD;EAEJ;EACA,MAAM,SAAS,KAAK,QAAQ,cAAc;EAC1C,MAAM,SAAS,CAAC,KAAK,OAAO,KAAK,OAAO,GAAG,mBAAmB;EAE9D,MAAM,SAEC,CAAC;EACR,MAAM,YAA2D,CAAC;EAClE,MAAM,YAAY,UACf,KAAK,EAAE,MAAM,QAAQ,kBAA4B;GAChD,MAAM,QAAQ,KAAK,SAAS,MAAM,KAAK,SAAS;IAC9C,IAAI,KAAK,WAAW,YAClB,OAAO;IAET,MAAM,SAAS,YAAY,IAAI,KAAK,WAAW,cAAc;IAC7D,IAAI,WAAW,KAAA,GACb,MAAM,IAAI,MACR,0BAA0B,KAAK,OAAO,mCACxC;IAEF,OAAO,KAAK;KACV,QAAQ,KAAK;KACb,aAAa,KAAK,WAAW;KAC7B;IACF,CAAC;IAGD,MAAM,WACJ,KAAK,gBACL,YAAY,IAAI,KAAK,aAAa,cAAc;IAClD,IAAI,aAAa,KAAA,GACf,UAAU,KAAK;KAAE,QAAQ,KAAK;KAAQ,QAAQ;IAAS,CAAC;IAE1D,MAAM,EAAE,cAAc,GAAG,SAAS;IAClC,OAAO;KACL,GAAG;KACH,YAAY;MACV,GAAG,KAAK;MACR,MAAM,gBAAgB,KAAK,QAAQ,KAAK,WAAW,WAAW;KAChE;KACA,GAAI,gBACF,aAAa,KAAA,KAAa,EACxB,cAAc;MACZ,GAAG;MACH,MAAM,mBAAmB,KAAK,MAAM;KACtC,EACF;IACJ;GACF,CAAC;GACD,OAAO;IACL,GAAG,KAAK;IAGR;IACA;IACA,UAAU,KAAK,SAAS,YAAY,WAAW;GACjD;EACF,CAAC,CAAC,CACD,MACE,GAAG,MACF,EAAE,QAAQ,cAAc,EAAE,OAAO,KACjC,EAAE,UAAU,KAAK,IAAI,CAAC,CAAC,cAAc,EAAE,UAAU,KAAK,IAAI,CAAC,KAC3D,EAAE,kBAAkB,EAAE,eAC1B;EAqBF,OAAO;GACL,UAAA;IAnBA,eAAe;IACf,UAAU;KACR,MAAM;KACGA;KACT,mBAAmB,kBAAkB;IACvC;IACA,OAAO,MAAO,KAAK;IACnB,SAAS,MAAO,KAAK;IAErB,YAAY,WAAW;IACvB,OAAO,KAAK,QAAQ,SAAS;IAC7B,WAAW,KAAK;IAChB,6BAAY,IAAI,KAAK,EAAA,CAAE,YAAY;IACnC,QAAQ,MAAO,KAAK;IACpB;IACA,UAAU,UAAU,OAAO,UAAU,MAAM,QAAQ;GAI5C;GACP;GACA;EACF;CACF;;CAGA,MAAc,MACZ,UACA,aACA,WACiB;EACjB,MAAM,YAAY,KAAK,QACrB,KAAK,QAAQ,aACX,KAAK,KACH,KAAK,QAAQ,SAAS,EAAE,EAAE,aACxB,KAAK,KAAK,KAAK,QAAQ,WAAW,QAAQ,IAAI,GAAG,cAAc,GACjE,OACF,CACJ;EACA,MAAM,GAAG,WAAW;GAAE,WAAW;GAAM,OAAO;EAAK,CAAC;EAEpD,MAAM,QAA6B;GACjC;GACA,aAAa,CAAC;GACd,WAAW,CAAC;EACd;EACA,KAAK,MAAM,EAAE,QAAQ,aAAa,WAAW,aAAa;GACxD,MAAM,YAAY,gBAAgB,QAAQ,WAAW;GACrD,MAAM,YAAY,KAAK;IAAE;IAAQ,MAAM;GAAU,CAAC;GAClD,MAAM,MAAM,KAAK,QAAQ,KAAK,KAAK,WAAW,SAAS,CAAC,GAAG,EACzD,WAAW,KACb,CAAC;GACD,MAAM,UAAU,KAAK,KAAK,WAAW,SAAS,GAAG,KAAK;EACxD;EACA,KAAK,MAAM,EAAE,QAAQ,WAAW,WAAW;GACzC,MAAM,eAAe,mBAAmB,MAAM;GAC9C,MAAM,UAAU,KAAK;IAAE;IAAQ,MAAM;GAAa,CAAC;GACnD,MAAM,MAAM,KAAK,QAAQ,KAAK,KAAK,WAAW,YAAY,CAAC,GAAG,EAC5D,WAAW,KACb,CAAC;GACD,MAAM,UAAU,KAAK,KAAK,WAAW,YAAY,GAAG,KAAK;EAC3D;EACA,MAAM,MAAM,WAAW,EAAE,WAAW,KAAK,CAAC;EAC1C,MAAM,UACJ,KAAK,KAAK,WAAW,sBAAsB,GAC3C,KAAK,UAAU,OAAO,MAAM,CAAC,IAAI,IACnC;EACA,OAAO;CACT;AACF;;AAGA,eAAe,QAAQ,QAAoD;CACzE,MAAM,WAAW,OAAO,YAAY,MACjC,SAAS,KAAK,SAAS,mBAC1B;CACA,IAAI,CAAC,YAAa,CAAC,SAAS,QAAQ,CAAC,SAAS,MAC5C;CAEF,MAAM,OAAO,KAAK,MAChB,SAAS,MAAM,SAAS,MAAM,KAAM,MAAM,SAAS,SAAS,MAAO,MAAM,CAC3E;CACA,MAAM,8BAAc,IAAI,IAA6B;CACrD,KAAK,MAAM,EAAE,MAAM,MAAM,gBAAgB,UAAU,OAAO,aAAa;EACrE,MAAM,SAAS,QAAQ;EACvB,IAAI,WAAW,KAAA,GACb,YAAY,IAAI,MAAM,MAAM;CAEhC;CACA,OAAO;EAAE;EAAM,QAAQ,OAAO;EAAQ;CAAY;AACpD;AAEA,SAAS,IAAI,SAAuB;CAClC,QAAQ,OAAO,MAAM,UAAU,IAAI;AACrC"}

package/dist/{upload-D5hePvmA.mjs → upload--pBJ67uZ.mjs}

@@ -5,7 +5,7 @@ import { mkdir, readFile, writeFile } from "node:fs/promises";
 import configPackage from "@ralphralphai/config/package.json" with { type: "json" };
 import { WebRalphConfigSchema } from "@ralphralphai/config/zod";
 import { parse, printParseErrorCode } from "jsonc-parser";
-import { randomUUID } from "node:crypto";
+import { createHash, randomUUID } from "node:crypto";
 import { setTimeout as setTimeout$1 } from "node:timers/promises";
 import playwrightPackage from "@playwright/test/package.json" with { type: "json" };
 import { Readable } from "node:stream";
@@ -45,7 +45,7 @@ function snapshot(value) {
 }
 //#endregion
 //#region package.json
-var version = "1.8.0";
+var version = "2.0.0";
 //#endregion
 //#region src/actions.ts
 const BINDING = "__ralphAction";
@@ -522,6 +522,192 @@ async function waitForAnimations(page, timeoutMs) {
 		if (!(error instanceof errors.TimeoutError)) throw error;
 	}
 }
+const MAX_ARIA_DEPTH = Math.floor(128 / 2) - 2;
+const STYLE_PROPERTIES = [
+	"font-family",
+	"font-size",
+	"font-weight",
+	"font-style",
+	"color",
+	"background-color"
+];
+const TRANSPARENT = "rgba(0, 0, 0, 0)";
+const ELEMENT_LOOKUP_TIMEOUT_MS = 2e3;
+/**
+* The page's aria tree as JSON, with each element's box in document
+* coordinates, its distinctive styles, and a hash of its image. Undefined when
+* the snapshot is past the server's limits.
+*
+* The page is not scrolled first, because scrolling changes the page the
+* screenshot just showed: sticky headers, lazy loading, scroll-triggered
+* animation.
+*/
+async function captureAriaSnapshot(page, { viewport, scroll }) {
+	const snapshot = await page.locator("body").ariaSnapshotJSON({
+		mode: "ai",
+		boxes: true,
+		depth: MAX_ARIA_DEPTH
+	});
+	const visible = (await Promise.all(snapshot.map((node) => toDocument(page, node, scroll)))).flatMap((node) => {
+		const kept = keepShown(node, viewport.width);
+		return kept === void 0 ? [] : [kept];
+	});
+	const described = await Promise.all(visible.map((node) => describe(page, node, {})));
+	const json = Buffer.from(JSON.stringify(fillMissingRefs(described)));
+	return json.byteLength > 4194304 ? void 0 : json;
+}
+/**
+* Moves the viewport boxes Playwright reports into the full-page screenshot's
+* space. This has to happen before `keepShown`, which in viewport space would
+* drop everything scrolled above the viewport, and no later move brings those
+* back.
+*
+* An iframe's descendants are boxed in its own viewport, so they move by
+* where that viewport sits: the iframe's box plus its border and padding.
+*/
+async function toDocument(page, node, offset) {
+	const box = node.box && {
+		...node.box,
+		x: node.box.x + offset.x,
+		y: node.box.y + offset.y
+	};
+	let childOffset = offset;
+	if (node.role === "iframe" && box !== void 0) {
+		const inset = (node.ref === void 0 ? void 0 : await readContentInset(page, node.ref)) ?? {
+			x: 0,
+			y: 0
+		};
+		childOffset = {
+			x: box.x + inset.x,
+			y: box.y + inset.y
+		};
+	}
+	return {
+		...node,
+		...box && { box },
+		...node.children && { children: await Promise.all(node.children.map((child) => typeof child === "string" ? child : toDocument(page, child, childOffset))) }
+	};
+}
+async function readContentInset(page, ref) {
+	try {
+		return await page.locator(`aria-ref=${ref}`).evaluate((element) => {
+			const computed = getComputedStyle(element);
+			return {
+				x: element.clientLeft + parseFloat(computed.paddingLeft),
+				y: element.clientTop + parseFloat(computed.paddingTop)
+			};
+		}, void 0, { timeout: ELEMENT_LOOKUP_TIMEOUT_MS });
+	} catch {
+		return;
+	}
+}
+/**
+* In document space, the only boxes no scroll reveals are those past the left
+* or right of the viewport's width (a collapsed sidebar, an off-canvas menu)
+* or above the top of the document.
+*/
+function isReachable(box, viewportWidth) {
+	if (box === void 0) return false;
+	return box.x < viewportWidth && box.x + box.width > 0 && box.y + box.height > 0;
+}
+function isShown(node, viewportWidth) {
+	return node.ref !== void 0 && isReachable(node.box, viewportWidth);
+}
+function keepShown(node, viewportWidth) {
+	const shown = isShown(node, viewportWidth);
+	const children = (node.children ?? []).flatMap((child) => {
+		if (typeof child === "string") return shown ? [child] : [];
+		const kept = keepShown(child, viewportWidth);
+		return kept === void 0 ? [] : [kept];
+	});
+	if (!shown && children.length === 0) return;
+	return node.children === void 0 ? node : {
+		...node,
+		children
+	};
+}
+function fillMissingRefs(nodes) {
+	let generated = 0;
+	const fill = (child) => {
+		if (typeof child === "string") return child;
+		generated += 1;
+		const ref = child.ref ?? `n${generated}`;
+		return child.children === void 0 ? {
+			...child,
+			ref
+		} : {
+			...child,
+			ref,
+			children: child.children.map(fill)
+		};
+	};
+	return nodes.map(fill);
+}
+async function readElement(page, ref, isImage) {
+	try {
+		return await page.locator(`aria-ref=${ref}`).evaluate((element, { properties, isImage }) => {
+			const computed = getComputedStyle(element);
+			const style = Object.fromEntries(properties.map((property) => [property, computed.getPropertyValue(property)]));
+			if (!isImage) return { style };
+			if (element instanceof HTMLImageElement) return {
+				style,
+				image: { src: element.currentSrc || element.src }
+			};
+			if (element instanceof SVGElement) return {
+				style,
+				image: { markup: element.outerHTML }
+			};
+			const backgroundUrl = /url\("(.+)"\)/.exec(computed.backgroundImage)?.[1];
+			return backgroundUrl === void 0 ? { style } : {
+				style,
+				image: { src: new URL(backgroundUrl, document.baseURI).href }
+			};
+		}, {
+			properties: STYLE_PROPERTIES,
+			isImage
+		}, { timeout: ELEMENT_LOOKUP_TIMEOUT_MS });
+	} catch {
+		return;
+	}
+}
+function sha256(data) {
+	return createHash("sha256").update(data).digest("hex");
+}
+async function hashImage(page, image) {
+	if ("markup" in image) return sha256(image.markup);
+	if (image.src === "") return;
+	if (image.src.startsWith("data:")) return sha256(image.src);
+	try {
+		const response = await page.request.get(image.src);
+		try {
+			return response.ok() ? sha256(await response.body()) : void 0;
+		} finally {
+			await response.dispose();
+		}
+	} catch {
+		return;
+	}
+}
+function distinctStyle(style, inherited) {
+	const distinct = Object.entries(style).filter(([property, value]) => {
+		if (property === "background-color" && value === TRANSPARENT) return false;
+		return inherited[property] !== value;
+	});
+	return distinct.length === 0 ? void 0 : Object.fromEntries(distinct);
+}
+async function describe(page, child, inherited) {
+	if (typeof child === "string") return child;
+	const facts = child.ref === void 0 ? void 0 : await readElement(page, child.ref, child.role === "img");
+	const style = facts === void 0 ? void 0 : distinctStyle(facts.style, inherited);
+	const imageHash = facts?.image === void 0 ? void 0 : await hashImage(page, facts.image);
+	const children = child.children === void 0 ? void 0 : await Promise.all(child.children.map((grandchild) => describe(page, grandchild, facts?.style ?? inherited)));
+	return {
+		...child,
+		...style && { style },
+		...imageHash && { imageHash },
+		...children && { children }
+	};
+}
 //#endregion
 //#region src/conditions.ts
 const declared = (declaration = {}) => {
@@ -701,6 +887,8 @@ const MANIFEST_ATTACHMENT = "ralph-raw-graph";
 const REPORTER_ENV = "RALPH_PLAYWRIGHT_REPORTER";
 /** Prefix of the attachment holding each recorded node's screenshot; the node id follows. */
 const SCREENSHOT_ATTACHMENT_PREFIX = "ralph-screenshot-";
+/** Prefix of the attachment holding each recorded node's aria snapshot; the node id follows. */
+const ARIA_SNAPSHOT_ATTACHMENT_PREFIX = "ralph-aria-snapshot-";
 /** Once per worker: a run without the tracker says so once, not per node. */
 let warnedNoTracker = false;
 const DEFAULT_SETTLE_MS = 150;
@@ -918,11 +1106,14 @@ var Recorder = class {
 		const deadline = startDeadline(this.recordTimeoutMs, "Ralph recording timed out.");
 		const { wait } = deadline;
 		const navigatedAway = () => state.generation !== generation || page.url() !== request.actualUrl;
-		const check = () => {
-			deadline.signal.throwIfAborted();
+		const checkPage = () => {
 			if (navigatedAway()) throw new Error("The page navigated before its recording completed.");
 			if (page.isClosed()) throw new Error("The page closed before its recording completed.");
 		};
+		const check = () => {
+			deadline.signal.throwIfAborted();
+			checkPage();
+		};
 		try {
 			check();
 			if (request.trigger !== "explicit") await this.waitForPageToSettle(page, deadline, check);
@@ -948,6 +1139,8 @@ var Recorder = class {
 			check();
 			const after = await wait(readLayout(page));
 			check();
+			const snapshot = await Promise.race([captureAriaSnapshot(page, after).catch(() => void 0), setTimeout$1(Math.max(0, deadline.endsAt - Date.now()), void 0, { ref: false })]);
+			checkPage();
 			const recorded = {
 				...request,
 				...withConditions(conditions),
@@ -957,7 +1150,8 @@ var Recorder = class {
 				recordedAt: (/* @__PURE__ */ new Date()).toISOString(),
 				layout: before,
 				geometryStable: JSON.stringify(before) === JSON.stringify(after),
-				screenshot: await this.saveScreenshot(request.nodeId, image)
+				screenshot: await this.saveScreenshot(request.nodeId, image),
+				...snapshot && { ariaSnapshot: await this.saveAriaSnapshot(request.nodeId, snapshot) }
 			};
 			const retaken = sameNode ? this.nodes.findIndex(({ nodeId }) => nodeId === state.lastRecorded?.nodeId) : -1;
 			if (retaken === -1) {
@@ -1017,6 +1211,21 @@ var Recorder = class {
 			contentType: image.contentType
 		};
 	}
+	/** Writes the snapshot to the test output and attaches it to the report. */
+	async saveAriaSnapshot(nodeId, snapshot) {
+		const path = "ralph/" + nodeId + ".aria.json";
+		const attachmentName = ARIA_SNAPSHOT_ATTACHMENT_PREFIX + nodeId;
+		await mkdir(this.testInfo.outputPath(OUTPUT_DIR), { recursive: true });
+		await writeFile(this.testInfo.outputPath(path), snapshot);
+		await this.testInfo.attach(attachmentName, {
+			...this.testInfo.config.preserveOutput === "always" ? { path: this.testInfo.outputPath(path) } : { body: snapshot },
+			contentType: "application/json"
+		});
+		return {
+			path,
+			attachmentName
+		};
+	}
 	/** Gives each node the actions taken since the node it was reached from was requested. */
 	attachActions(nodes) {
 		const byId = new Map(nodes.map((item) => [item.nodeId, item]));
@@ -1151,11 +1360,17 @@ function resolveUploadOptions(options) {
 }
 const RAW_GRAPH_BUNDLE_INDEX = "raw_graph.json";
 const RAW_GRAPH_BUNDLE_IMAGE_DIR = "assets/images";
+const RAW_GRAPH_BUNDLE_SNAPSHOT_DIR = "assets/snapshots";
 /** Where a node's screenshot sits inside the bundle. */
 function bundleImagePath(nodeId, contentType) {
 	if (!/^[A-Za-z0-9-]{1,64}$/.test(nodeId)) throw new Error(`Ralph node id is not path-safe: ${nodeId}`);
 	return `${RAW_GRAPH_BUNDLE_IMAGE_DIR}/${nodeId}${imageExtension(contentType)}`;
 }
+/** Where a node's aria snapshot sits inside the bundle. */
+function bundleSnapshotPath(nodeId) {
+	if (!/^[A-Za-z0-9-]{1,64}$/.test(nodeId)) throw new Error(`Ralph node id is not path-safe: ${nodeId}`);
+	return `${RAW_GRAPH_BUNDLE_SNAPSHOT_DIR}/${nodeId}.json`;
+}
 const TOO_BIG = "This run is too big to upload to Ralph. Record fewer pages or screen sizes, or split the tests across runs.";
 var TooBigError = class extends Error {
 	constructor() {
@@ -1166,23 +1381,33 @@ var TooBigError = class extends Error {
 * Packs the manifest and screenshots into a gzipped tar archive, produced as it
 * is read so the compressed bundle is never held whole:
 *
-*   raw_graph.json               { manifest, screenshots: [{ nodeId, path }] }
+*   raw_graph.json             { manifest, screenshots: [{ nodeId, path }], snapshots: [...] }
 *   assets/images/<id>.webp    raw screenshot bytes (.png when too large for WebP)
+*   assets/snapshots/<id>.json the node's aria snapshot, when it has one
 *
 * Fails with a `TooBigError` once the compressed bytes pass the limit.
 */
-function rawGraphBundleStream(manifest, screenshots) {
+function rawGraphBundleStream(manifest, screenshots, snapshots) {
 	if (Buffer.byteLength(JSON.stringify(manifest)) > 16777216 || screenshots.length > 5e3 || screenshots.reduce((total, screenshot) => total + screenshot.bytes.byteLength, 0) > 268435456) throw new TooBigError();
 	const images = screenshots.map(({ nodeId, contentType, bytes }) => ({
 		nodeId,
 		path: bundleImagePath(nodeId, contentType),
 		bytes
 	}));
+	const files = [...images, ...snapshots.map(({ nodeId, bytes }) => ({
+		nodeId,
+		path: bundleSnapshotPath(nodeId),
+		bytes
+	}))];
 	const index = {
 		manifest,
 		screenshots: images.map(({ nodeId, path }) => ({
 			nodeId,
 			path
+		})),
+		snapshots: snapshots.map(({ nodeId }) => ({
+			nodeId,
+			path: bundleSnapshotPath(nodeId)
 		}))
 	};
 	const attrs = {
@@ -1196,7 +1421,7 @@ function rawGraphBundleStream(manifest, screenshots) {
 		name: RAW_GRAPH_BUNDLE_INDEX,
 		...attrs
 	}, JSON.stringify(index)).on("error", onEntryError);
-	for (const { path, bytes } of images) tar.entry({
+	for (const { path, bytes } of files) tar.entry({
 		name: path,
 		...attrs
 	}, Buffer.from(bytes)).on("error", onEntryError);
@@ -1213,9 +1438,9 @@ function rawGraphBundleStream(manifest, screenshots) {
 	})());
 }
 /** The bundle `uploadRawGraph` streams, whole, for saving or inspecting it. */
-async function createRawGraphBundle(manifest, screenshots) {
+async function createRawGraphBundle(manifest, screenshots, snapshots = []) {
 	const chunks = [];
-	for await (const chunk of rawGraphBundleStream(manifest, screenshots)) chunks.push(chunk);
+	for await (const chunk of rawGraphBundleStream(manifest, screenshots, snapshots)) chunks.push(chunk);
 	return Buffer.concat(chunks);
 }
 function isLoopback(url) {
@@ -1260,10 +1485,24 @@ const PREPARE_TIMEOUT_MS = 3e4;
 * run can be followed while it uploads and while Ralph processes it.
 */
 async function prepareArtifactUpload(options) {
-	const url = checkedApiUrl(options, "/api/upload/artifact/prepare");
+	return reserve(options, "/api/upload/artifact/prepare", { externalAppId: options.appId });
+}
+/**
+* Records that `buildId` went live under `config`, and reserves the artifact
+* its run uploads into. The run then becomes that build's graph in Ralph,
+* where an artifact from `prepareArtifactUpload` stays a standalone result.
+*/
+async function registerDeployment(options, deployment) {
+	return reserve(options, "/api/upload/deployment/register", {
+		externalAppId: options.appId,
+		...deployment
+	});
+}
+async function reserve(options, route, body) {
+	const url = checkedApiUrl(options, route);
 	const reply = await request(url, {
 		headers: { "content-type": "application/json" },
-		body: JSON.stringify({ externalAppId: options.appId })
+		body: JSON.stringify(body)
 	}, options, PREPARE_TIMEOUT_MS);
 	if (reply["result"] !== "ok" || typeof reply["artifactId"] !== "string" || reply["resultUrl"] !== void 0 && typeof reply["resultUrl"] !== "string") throw unreadableReply(url);
 	return {
@@ -1276,7 +1515,7 @@ async function prepareArtifactUpload(options) {
 * `prepareArtifactUpload` has to have reserved. Ralph processes it after this
 * returns; the result page shows when it is ready.
 */
-async function uploadRawGraph(manifest, screenshots, options) {
+async function uploadRawGraph(manifest, screenshots, options, snapshots = []) {
 	const url = checkedApiUrl(options, `/api/upload/web/apps/${options.appId}/artifact/${encodeURIComponent(manifest.artifactId)}`);
 	const storage = process.env["RALPH_UPLOAD_STORAGE"] || "gcs";
 	if (storage !== "gcs" && storage !== "local") throw new Error(`RALPH_UPLOAD_STORAGE must be gcs or local, not ${storage}.`);
@@ -1285,7 +1524,7 @@ async function uploadRawGraph(manifest, screenshots, options) {
 	if (!Number.isFinite(timeoutMs) || timeoutMs <= 0) throw new Error("uploadTimeoutMs in the Ralph reporter options must be a positive number of milliseconds.");
 	const receipt = await request(url, {
 		headers: { "content-type": "application/gzip" },
-		body: Readable.toWeb(rawGraphBundleStream(manifest, screenshots)),
+		body: Readable.toWeb(rawGraphBundleStream(manifest, screenshots, snapshots)),
 		duplex: "half"
 	}, options, timeoutMs);
 	if (receipt["result"] !== "ok" || receipt["status"] !== "queued" || receipt["artifactId"] !== manifest.artifactId || receipt["resultUrl"] !== void 0 && typeof receipt["resultUrl"] !== "string" || typeof receipt["replayed"] !== "boolean") throw unreadableReply(url);
@@ -1329,6 +1568,6 @@ async function responseDetail(response) {
 	return text.length > 200 ? text.slice(0, 200) + "…" : text || void 0;
 }
 //#endregion
-export { resolveUploadOptions as a, MANIFEST_ATTACHMENT as c, version as d, loadConfig as f, prepareArtifactUpload as i, REPORTER_ENV as l, resolveMode as m, bundleImagePath as n, resultLink as o, loadConfigSync as p, createRawGraphBundle as r, uploadRawGraph as s, RAW_GRAPH_BUNDLE_INDEX as t, Recorder as u };
+export { prepareArtifactUpload as a, resultLink as c, REPORTER_ENV as d, Recorder as f, resolveMode as g, loadConfigSync as h, createRawGraphBundle as i, uploadRawGraph as l, loadConfig as m, bundleImagePath as n, registerDeployment as o, version as p, bundleSnapshotPath as r, resolveUploadOptions as s, RAW_GRAPH_BUNDLE_INDEX as t, MANIFEST_ATTACHMENT as u };
 
-//# sourceMappingURL=upload-D5hePvmA.mjs.map
+//# sourceMappingURL=upload--pBJ67uZ.mjs.map