@r_masseater/web-vitals-flow 0.0.0-stage → 0.0.0

package/LICENSE

@@ -0,0 +1,87 @@
+MIT License
+
+Copyright (c) 2026 masseater
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+@tanstack/eslint-plugin-start
+
+MIT License
+
+Copyright (c) 2021-present Tanner Linsley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+@typescript-eslint/utils
+
+MIT License
+
+Copyright (c) 2019 typescript-eslint and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+globals
+
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,3 +1,37 @@
-# Temporary Holding Version
+# @r_masseater/web-vitals-flow
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Measures Web Vitals of page loads and same-origin link transitions with
+[Lighthouse user
+flows](https://github.com/GoogleChrome/lighthouse/blob/main/docs/user-flows.md).
+It reports LCP, INP and CLS. It also reports FCP, TTFB and TBT. It fails when
+LCP, INP or CLS of
+any step misses the passing score of Lighthouse.
+
+It requires Node.js 26 or later and Chrome.
+
+```sh
+vp dlx @r_masseater/web-vitals-flow https://example.com/
+```
+
+For each URL it records a navigation. Then it records a timespan for a click on
+each same-origin link of that page. INP comes from these transitions.
+
+The flow runs 5 times, and each step is judged by its median. This follows the
+[variability
+guidance](https://github.com/GoogleChrome/lighthouse/blob/main/docs/variability.md)
+of Lighthouse. `--runs` changes the count. A step fails when the median score
+of LCP, INP or CLS is below 0.9.
+
+Each run writes `flow-<run>.html` and `flow-<run>.json` to `--report-dir`. The
+default is `report`.
+
+`--chrome-flags` passes space-separated flags to Chrome. In a container, pass
+`--chrome-flags="--no-sandbox"`. Set `CHROME_PATH` when Chrome is not found.
+
+When `OTEL_TRACES_EXPORTER=otlp` and `OTEL_EXPORTER_OTLP_ENDPOINT` are set, it
+exports spans. They are `web-vitals.flow`, `web-vitals.load`,
+`web-vitals.transition` and `web-vitals.audit`.
+
+## License
+
+MIT

package/dist/main.mjs

@@ -0,0 +1,198 @@
+#!/usr/bin/env node
+import { NodeRuntime, NodeServices } from "@effect/platform-node";
+import { Array, Console, Effect, FileSystem, Layer, Number, Option, Path, Schema, String, pipe } from "effect";
+import { Argument, Command, Flag } from "effect/cli";
+import { FetchHttpClient } from "effect/http";
+import { OtlpSerialization, OtlpTracer } from "effect/observability";
+import { Launcher } from "chrome-launcher";
+import { startFlow } from "lighthouse";
+import { launch } from "puppeteer-core";
+// src/flow.ts
+const taggedError$1 = Schema.TaggedError;
+var BrowserError = class extends taggedError$1()("BrowserError", { cause: Schema.Unknown }) {};
+const attempt = (evaluate) => Effect.tryPromise({
+	try: evaluate,
+	catch: (cause) => BrowserError.make({ cause })
+});
+const openBrowser = (chromeFlags) => Effect.gen(function* open() {
+	const installation = yield* Effect.try({
+		try: () => Launcher.getFirstInstallation(),
+		catch: (cause) => BrowserError.make({ cause })
+	});
+	const executablePath = yield* Option.fromNullishOr(installation).pipe(Effect.fromOption, Effect.mapError(() => BrowserError.make({ cause: "Chrome was not found. Set CHROME_PATH to its executable." })));
+	return yield* attempt(() => launch({
+		executablePath,
+		args: [...chromeFlags]
+	}));
+});
+const missingLink = (target) => BrowserError.make({ cause: `No link to ${target} was found` });
+const withoutHash = (url) => {
+	const parsed = new URL(url);
+	parsed.hash = "";
+	return parsed.href;
+};
+const hrefsOn = (page) => attempt(() => page.$$eval("a[href]", (anchors) => {
+	const hrefs = [];
+	for (const anchor of anchors) if (anchor.origin === location.origin) hrefs.push(anchor.href);
+	return hrefs;
+}));
+const linksOn = (page) => Effect.map(hrefsOn(page), (hrefs) => pipe(hrefs, Array.map((href) => withoutHash(href)), Array.dedupe, Array.filter((href) => href !== withoutHash(page.url()))));
+const clickLink = (page, target) => Effect.gen(function* click() {
+	const anchors = yield* attempt(() => page.$$("a[href]"));
+	const reads = pipe(anchors, Array.map((anchor) => anchor.evaluate((element) => element.href)));
+	const hrefs = yield* attempt(() => Promise.all(reads));
+	const index = yield* Array.findFirstIndex(hrefs, (href) => withoutHash(href) === target).pipe(Effect.fromOption, Effect.mapError(() => missingLink(target)));
+	const anchor = yield* Array.get(anchors, index).pipe(Effect.fromOption, Effect.mapError(() => missingLink(target)));
+	yield* attempt(() => Promise.all([page.waitForFunction((href) => {
+		const here = new URL(location.href);
+		here.hash = "";
+		return here.href === href && document.readyState === "complete";
+	}, {}, target), anchor.click()]));
+});
+const measureFlow = Effect.fn("web-vitals.flow")(function* measureFlow(urls, chromeFlags) {
+	const browser = yield* Effect.acquireRelease(openBrowser(chromeFlags), (opened) => Effect.promise(() => opened.close()));
+	const page = yield* attempt(() => browser.newPage());
+	const flow = yield* attempt(() => startFlow(page, { name: "web-vitals" }));
+	for (const url of urls) {
+		yield* attempt(() => flow.navigate(url, { name: `load ${url}` })).pipe(Effect.withSpan("web-vitals.load", { attributes: { url } }));
+		for (const link of yield* linksOn(page)) yield* Effect.gen(function* transition() {
+			yield* attempt(() => page.goto(url, { waitUntil: "load" }));
+			yield* attempt(() => flow.startTimespan({ name: `${url} -> ${link}` }));
+			yield* clickLink(page, link);
+			yield* attempt(() => flow.endTimespan());
+		}).pipe(Effect.withSpan("web-vitals.transition", { attributes: {
+			from: url,
+			to: link
+		} }));
+	}
+	return {
+		result: yield* attempt(() => flow.createFlowResult()).pipe(Effect.withSpan("web-vitals.audit")),
+		html: yield* attempt(() => flow.generateReport())
+	};
+}, Effect.scoped);
+// src/metrics.ts
+const PASSING_SCORE = .9;
+const SCORE_DIGITS = 2;
+const SHIFT_DIGITS = 3;
+const LABEL_WIDTH = 4;
+const VALUE_WIDTH = 9;
+const HALVES = 2;
+const milliseconds = (value) => `${Math.round(value).toString()}ms`;
+const unitless = (value) => value.toFixed(SHIFT_DIGITS);
+const METRICS = [
+	{
+		audit: "largest-contentful-paint",
+		label: "LCP",
+		core: true,
+		format: milliseconds
+	},
+	{
+		audit: "interaction-to-next-paint",
+		label: "INP",
+		core: true,
+		format: milliseconds
+	},
+	{
+		audit: "cumulative-layout-shift",
+		label: "CLS",
+		core: true,
+		format: unitless
+	},
+	{
+		audit: "first-contentful-paint",
+		label: "FCP",
+		core: false,
+		format: milliseconds
+	},
+	{
+		audit: "server-response-time",
+		label: "TTFB",
+		core: false,
+		format: milliseconds
+	},
+	{
+		audit: "total-blocking-time",
+		label: "TBT",
+		core: false,
+		format: milliseconds
+	}
+];
+const measurementOf = (step, metric) => Option.fromNullishOr(step.lhr.audits[metric.audit]).pipe(Option.flatMap((result) => Option.all({
+	value: Option.fromNullishOr(result.numericValue),
+	score: Option.fromNullishOr(result.score)
+})), Option.map(({ value, score }) => ({
+	metric,
+	value,
+	score
+})));
+const vitalsOf = (flow) => pipe(flow.steps, Array.map((step) => ({
+	name: step.name,
+	measurements: pipe(METRICS, Array.map((metric) => measurementOf(step, metric)), Array.getSomes)
+})));
+const medianOf = (measurements) => pipe(measurements, Array.sortWith((measurement) => measurement.value, Number.Order), (sorted) => pipe(sorted, Array.get(Math.floor(sorted.length / HALVES))));
+const medianStepOf = (runs, step) => ({
+	name: step.name,
+	measurements: pipe(step.measurements, Array.map(({ metric }) => pipe(runs, Array.flatMap((steps) => pipe(steps, Array.findFirst((candidate) => candidate.name === step.name), Option.flatMap((candidate) => pipe(candidate.measurements, Array.findFirst((measured) => measured.metric === metric))), Option.toArray)), medianOf)), Array.getSomes)
+});
+const medianVitalsOf = (flows) => {
+	const runs = pipe(flows, Array.map((flow) => vitalsOf(flow)));
+	return pipe(Array.head(runs), Option.match({
+		onNone: () => [],
+		onSome: (first) => pipe(first, Array.map((step) => medianStepOf(runs, step)))
+	}));
+};
+const isPoor = (measurement) => measurement.metric.core && measurement.score < PASSING_SCORE;
+const failuresOf = (steps) => pipe(steps, Array.flatMap((step) => pipe(step.measurements, Array.filter(isPoor), Array.map((measurement) => `${step.name}: ${measurement.metric.label}`))));
+const lineOf = (measurement) => {
+	const label = pipe(measurement.metric.label, String.padEnd(LABEL_WIDTH));
+	const value = pipe(measurement.metric.format(measurement.value), String.padStart(VALUE_WIDTH));
+	return pipe([
+		`  ${label}`,
+		value,
+		`  score ${measurement.score.toFixed(SCORE_DIGITS)}`
+	], Array.join(" "));
+};
+const tableOf = (steps) => pipe(steps, Array.flatMap((step) => [step.name, ...pipe(step.measurements, Array.map(lineOf))]), Array.join("\n"));
+const summarize = (flows) => {
+	const steps = medianVitalsOf(flows);
+	return {
+		table: tableOf(steps),
+		failures: failuresOf(steps)
+	};
+};
+// src/main.ts
+const MINIMUM_URLS = 1;
+const FIRST_RUN = 1;
+const DEFAULT_RUNS = 5;
+const taggedError = Schema.TaggedError;
+var PoorVitals = class extends taggedError()("PoorVitals", { failures: Schema.Array(Schema.String) }) {};
+const tracing = OtlpTracer.layerFromConfig({ resource: { serviceName: "web-vitals-flow" } }).pipe(Layer.provide(OtlpSerialization.layerJson), Layer.provide(FetchHttpClient.layer));
+const services = Layer.mergeAll(tracing, NodeServices.layer);
+const encodeJson = Schema.encodeUnknownEffect(Schema.fromJsonString(Schema.Unknown));
+const command = Command.make("web-vitals-flow", {
+	urls: Argument.String("url").pipe(Argument.atLeast(MINIMUM_URLS), Argument.withDescription("Pages to load; each same-origin link on them is also clicked")),
+	chromeFlags: Flag.String("chrome-flags").pipe(Flag.withDefault(""), Flag.withDescription("Space-separated flags passed to Chrome")),
+	runs: Flag.Int("runs").pipe(Flag.withDefault(DEFAULT_RUNS), Flag.withDescription("How many times the flow runs; each step is judged by its median")),
+	reportDirectory: Flag.String("report-dir").pipe(Flag.withDefault("report"), Flag.withDescription("Where flow-<run>.html and flow-<run>.json are written"))
+}, ({ urls, chromeFlags, runs, reportDirectory }) => Effect.gen(function* measure() {
+	const flags = pipe(chromeFlags, String.split(" "), Array.filter(Boolean));
+	const fileSystem = yield* FileSystem.FileSystem;
+	const path = yield* Path.Path;
+	yield* fileSystem.makeDirectory(reportDirectory, { recursive: true });
+	const results = yield* Effect.forEach(Array.range(FIRST_RUN, runs), (run) => Effect.gen(function* measureRun() {
+		const { result, html } = yield* measureFlow(urls, flags);
+		yield* fileSystem.writeFileString(path.join(reportDirectory, `flow-${run.toString()}.html`), html);
+		yield* fileSystem.writeFileString(path.join(reportDirectory, `flow-${run.toString()}.json`), yield* encodeJson(result));
+		return result;
+	}));
+	const { table, failures } = summarize(results);
+	yield* Console.log(table);
+	return yield* Array.match(failures, {
+		onEmpty: () => Effect.void,
+		onNonEmpty: (poor) => Effect.fail(PoorVitals.make({ failures: poor }))
+	});
+}));
+NodeRuntime.runMain(Layer.build(services).pipe(Effect.flatMap((context) => Effect.provideContext(Command.run(command, { version: "0.0.0" }), context)), Effect.scoped));
+export {};
+
+//# sourceMappingURL=main.mjs.map

package/dist/main.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.mjs","names":["taggedError"],"sources":["../src/flow.ts","../src/metrics.ts","../src/main.ts"],"sourcesContent":["import { Launcher } from \"chrome-launcher\";\nimport { Array, Effect, Option, Schema, pipe } from \"effect\";\nimport { startFlow } from \"lighthouse\";\nimport { launch } from \"puppeteer-core\";\nimport type { Browser, Page } from \"puppeteer-core\";\n\nconst taggedError = Schema.TaggedError;\n\nclass BrowserError extends taggedError<BrowserError, { readonly brand: unique symbol }>()(\n  \"BrowserError\",\n  { cause: Schema.Unknown },\n) {}\n\nconst attempt = <Value>(evaluate: () => Promise<Value>): Effect.Effect<Value, BrowserError> =>\n  Effect.tryPromise({ try: evaluate, catch: (cause) => BrowserError.make({ cause }) });\n\nconst openBrowser = (chromeFlags: readonly string[]): Effect.Effect<Browser, BrowserError> =>\n  Effect.gen(function* open() {\n    const installation = yield* Effect.try({\n      try: () => Launcher.getFirstInstallation(),\n      catch: (cause) => BrowserError.make({ cause }),\n    });\n    const executablePath = yield* Option.fromNullishOr(installation).pipe(\n      Effect.fromOption,\n      Effect.mapError(() =>\n        BrowserError.make({\n          cause: \"Chrome was not found. Set CHROME_PATH to its executable.\",\n        }),\n      ),\n    );\n    return yield* attempt(() => launch({ executablePath, args: [...chromeFlags] }));\n  });\n\nconst missingLink = (target: string): BrowserError =>\n  BrowserError.make({ cause: `No link to ${target} was found` });\n\nconst withoutHash = (url: string): string => {\n  const parsed = new URL(url);\n  parsed.hash = \"\";\n  return parsed.href;\n};\n\nconst hrefsOn = (page: Page): Effect.Effect<readonly string[], BrowserError> =>\n  attempt(() =>\n    page.$$eval(\"a[href]\", (anchors) => {\n      const hrefs: string[] = [];\n      for (const anchor of anchors) {\n        if (anchor.origin === location.origin) {\n          hrefs.push(anchor.href);\n        }\n      }\n      return hrefs;\n    }),\n  );\n\nconst linksOn = (page: Page): Effect.Effect<readonly string[], BrowserError> =>\n  Effect.map(hrefsOn(page), (hrefs) =>\n    pipe(\n      hrefs,\n      Array.map((href) => withoutHash(href)),\n      Array.dedupe,\n      Array.filter((href) => href !== withoutHash(page.url())),\n    ),\n  );\n\nconst clickLink = (page: Page, target: string): Effect.Effect<void, BrowserError> =>\n  Effect.gen(function* click() {\n    const anchors = yield* attempt(() => page.$$(\"a[href]\"));\n    const reads = pipe(\n      anchors,\n      Array.map((anchor) => anchor.evaluate((element) => element.href)),\n    );\n    const hrefs = yield* attempt(() => Promise.all(reads));\n    const index = yield* Array.findFirstIndex(hrefs, (href) => withoutHash(href) === target).pipe(\n      Effect.fromOption,\n      Effect.mapError(() => missingLink(target)),\n    );\n    const anchor = yield* Array.get(anchors, index).pipe(\n      Effect.fromOption,\n      Effect.mapError(() => missingLink(target)),\n    );\n    yield* attempt(() =>\n      Promise.all([\n        page.waitForFunction(\n          (href) => {\n            const here = new URL(location.href);\n            here.hash = \"\";\n            return here.href === href && document.readyState === \"complete\";\n          },\n          {},\n          target,\n        ),\n        anchor.click(),\n      ]),\n    );\n  });\n\nconst measureFlow = Effect.fn(\"web-vitals.flow\")(function* measureFlow(\n  urls: readonly string[],\n  chromeFlags: readonly string[],\n) {\n  const browser = yield* Effect.acquireRelease(openBrowser(chromeFlags), (opened) =>\n    Effect.promise(() => opened.close()),\n  );\n  const page = yield* attempt(() => browser.newPage());\n  const flow = yield* attempt(() => startFlow(page, { name: \"web-vitals\" }));\n  for (const url of urls) {\n    yield* attempt(() => flow.navigate(url, { name: `load ${url}` })).pipe(\n      Effect.withSpan(\"web-vitals.load\", { attributes: { url } }),\n    );\n    for (const link of yield* linksOn(page)) {\n      yield* Effect.gen(function* transition() {\n        yield* attempt(() => page.goto(url, { waitUntil: \"load\" }));\n        yield* attempt(() => flow.startTimespan({ name: `${url} -> ${link}` }));\n        yield* clickLink(page, link);\n        yield* attempt(() => flow.endTimespan());\n      }).pipe(Effect.withSpan(\"web-vitals.transition\", { attributes: { from: url, to: link } }));\n    }\n  }\n  const result = yield* attempt(() => flow.createFlowResult()).pipe(\n    Effect.withSpan(\"web-vitals.audit\"),\n  );\n  const html = yield* attempt(() => flow.generateReport());\n  return { result, html };\n}, Effect.scoped);\n\nexport { measureFlow };\n","import { Array, Number, Option, String, pipe } from \"effect\";\nimport type { FlowResult } from \"lighthouse\";\n\nconst PASSING_SCORE = 0.9;\nconst SCORE_DIGITS = 2;\nconst SHIFT_DIGITS = 3;\nconst LABEL_WIDTH = 4;\nconst VALUE_WIDTH = 9;\nconst HALVES = 2;\n\nconst milliseconds = (value: number): string => `${Math.round(value).toString()}ms`;\n\nconst unitless = (value: number): string => value.toFixed(SHIFT_DIGITS);\n\nconst METRICS = [\n  { audit: \"largest-contentful-paint\", label: \"LCP\", core: true, format: milliseconds },\n  { audit: \"interaction-to-next-paint\", label: \"INP\", core: true, format: milliseconds },\n  { audit: \"cumulative-layout-shift\", label: \"CLS\", core: true, format: unitless },\n  { audit: \"first-contentful-paint\", label: \"FCP\", core: false, format: milliseconds },\n  { audit: \"server-response-time\", label: \"TTFB\", core: false, format: milliseconds },\n  { audit: \"total-blocking-time\", label: \"TBT\", core: false, format: milliseconds },\n] as const;\n\ntype Metric = (typeof METRICS)[number];\n\ninterface Measurement {\n  readonly metric: Metric;\n  readonly value: number;\n  readonly score: number;\n}\n\ninterface StepVitals {\n  readonly name: string;\n  readonly measurements: readonly Measurement[];\n}\n\nconst measurementOf = (step: FlowResult.Step, metric: Metric): Option.Option<Measurement> =>\n  Option.fromNullishOr(step.lhr.audits[metric.audit]).pipe(\n    Option.flatMap((result) =>\n      Option.all({\n        value: Option.fromNullishOr(result.numericValue),\n        score: Option.fromNullishOr(result.score),\n      }),\n    ),\n    Option.map(({ value, score }) => ({ metric, value, score })),\n  );\n\nconst vitalsOf = (flow: FlowResult): readonly StepVitals[] =>\n  pipe(\n    flow.steps,\n    Array.map((step) => ({\n      name: step.name,\n      measurements: pipe(\n        METRICS,\n        Array.map((metric) => measurementOf(step, metric)),\n        Array.getSomes,\n      ),\n    })),\n  );\n\nconst medianOf = (measurements: readonly Measurement[]): Option.Option<Measurement> =>\n  pipe(\n    measurements,\n    Array.sortWith((measurement) => measurement.value, Number.Order),\n    (sorted) => pipe(sorted, Array.get(Math.floor(sorted.length / HALVES))),\n  );\n\nconst medianStepOf = (runs: readonly (readonly StepVitals[])[], step: StepVitals): StepVitals => ({\n  name: step.name,\n  measurements: pipe(\n    step.measurements,\n    Array.map(({ metric }) =>\n      pipe(\n        runs,\n        Array.flatMap((steps) =>\n          pipe(\n            steps,\n            Array.findFirst((candidate) => candidate.name === step.name),\n            Option.flatMap((candidate) =>\n              pipe(\n                candidate.measurements,\n                Array.findFirst((measured) => measured.metric === metric),\n              ),\n            ),\n            Option.toArray,\n          ),\n        ),\n        medianOf,\n      ),\n    ),\n    Array.getSomes,\n  ),\n});\n\nconst medianVitalsOf = (flows: readonly FlowResult[]): readonly StepVitals[] => {\n  const runs = pipe(\n    flows,\n    Array.map((flow) => vitalsOf(flow)),\n  );\n  return pipe(\n    Array.head(runs),\n    Option.match({\n      onNone: () => [],\n      onSome: (first) =>\n        pipe(\n          first,\n          Array.map((step) => medianStepOf(runs, step)),\n        ),\n    }),\n  );\n};\n\nconst isPoor = (measurement: Measurement): boolean =>\n  measurement.metric.core && measurement.score < PASSING_SCORE;\n\nconst failuresOf = (steps: readonly StepVitals[]): readonly string[] =>\n  pipe(\n    steps,\n    Array.flatMap((step) =>\n      pipe(\n        step.measurements,\n        Array.filter(isPoor),\n        Array.map((measurement) => `${step.name}: ${measurement.metric.label}`),\n      ),\n    ),\n  );\n\nconst lineOf = (measurement: Measurement): string => {\n  const label = pipe(measurement.metric.label, String.padEnd(LABEL_WIDTH));\n  const value = pipe(measurement.metric.format(measurement.value), String.padStart(VALUE_WIDTH));\n  return pipe(\n    [`  ${label}`, value, `  score ${measurement.score.toFixed(SCORE_DIGITS)}`],\n    Array.join(\" \"),\n  );\n};\n\nconst tableOf = (steps: readonly StepVitals[]): string =>\n  pipe(\n    steps,\n    Array.flatMap((step) => [step.name, ...pipe(step.measurements, Array.map(lineOf))]),\n    Array.join(\"\\n\"),\n  );\n\nconst summarize = (\n  flows: readonly FlowResult[],\n): { readonly table: string; readonly failures: readonly string[] } => {\n  const steps = medianVitalsOf(flows);\n  return { table: tableOf(steps), failures: failuresOf(steps) };\n};\n\nexport { summarize };\n","import { NodeRuntime, NodeServices } from \"@effect/platform-node\";\nimport { Array, Console, Effect, FileSystem, Layer, Path, Schema, String, pipe } from \"effect\";\nimport { Argument, Command, Flag } from \"effect/cli\";\nimport { FetchHttpClient } from \"effect/http\";\nimport { OtlpSerialization, OtlpTracer } from \"effect/observability\";\n\nimport { measureFlow } from \"./flow.ts\";\nimport { summarize } from \"./metrics.ts\";\n\nconst MINIMUM_URLS = 1;\nconst FIRST_RUN = 1;\nconst DEFAULT_RUNS = 5;\n\nconst taggedError = Schema.TaggedError;\n\nclass PoorVitals extends taggedError<PoorVitals, { readonly brand: unique symbol }>()(\n  \"PoorVitals\",\n  { failures: Schema.Array(Schema.String) },\n) {}\n\nconst tracing = OtlpTracer.layerFromConfig({\n  resource: { serviceName: \"web-vitals-flow\" },\n}).pipe(Layer.provide(OtlpSerialization.layerJson), Layer.provide(FetchHttpClient.layer));\n\nconst services = Layer.mergeAll(tracing, NodeServices.layer);\n\nconst encodeJson = Schema.encodeUnknownEffect(Schema.fromJsonString(Schema.Unknown));\n\nconst command = Command.make(\n  \"web-vitals-flow\",\n  {\n    urls: Argument.String(\"url\").pipe(\n      Argument.atLeast(MINIMUM_URLS),\n      Argument.withDescription(\"Pages to load; each same-origin link on them is also clicked\"),\n    ),\n    chromeFlags: Flag.String(\"chrome-flags\").pipe(\n      Flag.withDefault(\"\"),\n      Flag.withDescription(\"Space-separated flags passed to Chrome\"),\n    ),\n    runs: Flag.Int(\"runs\").pipe(\n      Flag.withDefault(DEFAULT_RUNS),\n      Flag.withDescription(\"How many times the flow runs; each step is judged by its median\"),\n    ),\n    reportDirectory: Flag.String(\"report-dir\").pipe(\n      Flag.withDefault(\"report\"),\n      Flag.withDescription(\"Where flow-<run>.html and flow-<run>.json are written\"),\n    ),\n  },\n  ({ urls, chromeFlags, runs, reportDirectory }) =>\n    Effect.gen(function* measure() {\n      const flags = pipe(chromeFlags, String.split(\" \"), Array.filter(Boolean));\n      const fileSystem = yield* FileSystem.FileSystem;\n      const path = yield* Path.Path;\n      yield* fileSystem.makeDirectory(reportDirectory, { recursive: true });\n      const results = yield* Effect.forEach(Array.range(FIRST_RUN, runs), (run) =>\n        Effect.gen(function* measureRun() {\n          const { result, html } = yield* measureFlow(urls, flags);\n          yield* fileSystem.writeFileString(\n            path.join(reportDirectory, `flow-${run.toString()}.html`),\n            html,\n          );\n          yield* fileSystem.writeFileString(\n            path.join(reportDirectory, `flow-${run.toString()}.json`),\n            yield* encodeJson(result),\n          );\n          return result;\n        }),\n      );\n      const { table, failures } = summarize(results);\n      yield* Console.log(table);\n      return yield* Array.match(failures, {\n        onEmpty: () => Effect.void,\n        onNonEmpty: (poor) => Effect.fail(PoorVitals.make({ failures: poor })),\n      });\n    }),\n);\n\nNodeRuntime.runMain(\n  Layer.build(services).pipe(\n    Effect.flatMap((context) =>\n      Effect.provideContext(Command.run(command, { version: \"0.0.0\" }), context),\n    ),\n    Effect.scoped,\n  ),\n);\n"],"mappings":";;;;;;;;;;AAMA,MAAMA,gBAAc,OAAO;AAE3B,IAAM,eAAN,cAA2BA,cAA6D,CAAC,CACvF,gBACA,EAAE,OAAO,OAAO,QAAQ,CAC1B,CAAC,CAAC,CAAC;AAEH,MAAM,WAAkB,aACtB,OAAO,WAAW;CAAE,KAAK;CAAU,QAAQ,UAAU,aAAa,KAAK,EAAE,MAAM,CAAC;AAAE,CAAC;AAErF,MAAM,eAAe,gBACnB,OAAO,IAAI,UAAU,OAAO;CAC1B,MAAM,eAAe,OAAO,OAAO,IAAI;EACrC,WAAW,SAAS,qBAAqB;EACzC,QAAQ,UAAU,aAAa,KAAK,EAAE,MAAM,CAAC;CAC/C,CAAC;CACD,MAAM,iBAAiB,OAAO,OAAO,cAAc,YAAY,CAAC,CAAC,KAC/D,OAAO,YACP,OAAO,eACL,aAAa,KAAK,EAChB,OAAO,2DACT,CAAC,CACH,CACF;CACA,OAAO,OAAO,cAAc,OAAO;EAAE;EAAgB,MAAM,CAAC,GAAG,WAAW;CAAE,CAAC,CAAC;AAChF,CAAC;AAEH,MAAM,eAAe,WACnB,aAAa,KAAK,EAAE,OAAO,cAAc,OAAO,YAAY,CAAC;AAE/D,MAAM,eAAe,QAAwB;CAC3C,MAAM,SAAS,IAAI,IAAI,GAAG;CAC1B,OAAO,OAAO;CACd,OAAO,OAAO;AAChB;AAEA,MAAM,WAAW,SACf,cACE,KAAK,OAAO,YAAY,YAAY;CAClC,MAAM,QAAkB,CAAC;CACzB,KAAK,MAAM,UAAU,SACnB,IAAI,OAAO,WAAW,SAAS,QAC7B,MAAM,KAAK,OAAO,IAAI;CAG1B,OAAO;AACT,CAAC,CACH;AAEF,MAAM,WAAW,SACf,OAAO,IAAI,QAAQ,IAAI,IAAI,UACzB,KACE,OACA,MAAM,KAAK,SAAS,YAAY,IAAI,CAAC,GACrC,MAAM,QACN,MAAM,QAAQ,SAAS,SAAS,YAAY,KAAK,IAAI,CAAC,CAAC,CACzD,CACF;AAEF,MAAM,aAAa,MAAY,WAC7B,OAAO,IAAI,UAAU,QAAQ;CAC3B,MAAM,UAAU,OAAO,cAAc,KAAK,GAAG,SAAS,CAAC;CACvD,MAAM,QAAQ,KACZ,SACA,MAAM,KAAK,WAAW,OAAO,UAAU,YAAY,QAAQ,IAAI,CAAC,CAClE;CACA,MAAM,QAAQ,OAAO,cAAc,QAAQ,IAAI,KAAK,CAAC;CACrD,MAAM,QAAQ,OAAO,MAAM,eAAe,QAAQ,SAAS,YAAY,IAAI,MAAM,MAAM,CAAC,CAAC,KACvF,OAAO,YACP,OAAO,eAAe,YAAY,MAAM,CAAC,CAC3C;CACA,MAAM,SAAS,OAAO,MAAM,IAAI,SAAS,KAAK,CAAC,CAAC,KAC9C,OAAO,YACP,OAAO,eAAe,YAAY,MAAM,CAAC,CAC3C;CACA,OAAO,cACL,QAAQ,IAAI,CACV,KAAK,iBACF,SAAS;EACR,MAAM,OAAO,IAAI,IAAI,SAAS,IAAI;EAClC,KAAK,OAAO;EACZ,OAAO,KAAK,SAAS,QAAQ,SAAS,eAAe;CACvD,GACA,CAAC,GACD,MACF,GACA,OAAO,MAAM,CACf,CAAC,CACH;AACF,CAAC;AAEH,MAAM,cAAc,OAAO,GAAG,iBAAiB,CAAC,CAAC,UAAU,YACzD,MACA,aACA;CACA,MAAM,UAAU,OAAO,OAAO,eAAe,YAAY,WAAW,IAAI,WACtE,OAAO,cAAc,OAAO,MAAM,CAAC,CACrC;CACA,MAAM,OAAO,OAAO,cAAc,QAAQ,QAAQ,CAAC;CACnD,MAAM,OAAO,OAAO,cAAc,UAAU,MAAM,EAAE,MAAM,aAAa,CAAC,CAAC;CACzE,KAAK,MAAM,OAAO,MAAM;EACtB,OAAO,cAAc,KAAK,SAAS,KAAK,EAAE,MAAM,QAAQ,MAAM,CAAC,CAAC,CAAC,CAAC,KAChE,OAAO,SAAS,mBAAmB,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAC5D;EACA,KAAK,MAAM,QAAQ,OAAO,QAAQ,IAAI,GACpC,OAAO,OAAO,IAAI,UAAU,aAAa;GACvC,OAAO,cAAc,KAAK,KAAK,KAAK,EAAE,WAAW,OAAO,CAAC,CAAC;GAC1D,OAAO,cAAc,KAAK,cAAc,EAAE,MAAM,GAAG,IAAI,MAAM,OAAO,CAAC,CAAC;GACtE,OAAO,UAAU,MAAM,IAAI;GAC3B,OAAO,cAAc,KAAK,YAAY,CAAC;EACzC,CAAC,CAAC,CAAC,KAAK,OAAO,SAAS,yBAAyB,EAAE,YAAY;GAAE,MAAM;GAAK,IAAI;EAAK,EAAE,CAAC,CAAC;CAE7F;CAKA,OAAO;EAAE,QAAA,OAJa,cAAc,KAAK,iBAAiB,CAAC,CAAC,CAAC,KAC3D,OAAO,SAAS,kBAAkB,CACpC;EAEiB,MAAA,OADG,cAAc,KAAK,eAAe,CAAC;CACjC;AACxB,GAAG,OAAO,MAAM;;ACzHhB,MAAM,gBAAgB;AACtB,MAAM,eAAe;AACrB,MAAM,eAAe;AACrB,MAAM,cAAc;AACpB,MAAM,cAAc;AACpB,MAAM,SAAS;AAEf,MAAM,gBAAgB,UAA0B,GAAG,KAAK,MAAM,KAAK,CAAC,CAAC,SAAS,EAAE;AAEhF,MAAM,YAAY,UAA0B,MAAM,QAAQ,YAAY;AAEtE,MAAM,UAAU;CACd;EAAE,OAAO;EAA4B,OAAO;EAAO,MAAM;EAAM,QAAQ;CAAa;CACpF;EAAE,OAAO;EAA6B,OAAO;EAAO,MAAM;EAAM,QAAQ;CAAa;CACrF;EAAE,OAAO;EAA2B,OAAO;EAAO,MAAM;EAAM,QAAQ;CAAS;CAC/E;EAAE,OAAO;EAA0B,OAAO;EAAO,MAAM;EAAO,QAAQ;CAAa;CACnF;EAAE,OAAO;EAAwB,OAAO;EAAQ,MAAM;EAAO,QAAQ;CAAa;CAClF;EAAE,OAAO;EAAuB,OAAO;EAAO,MAAM;EAAO,QAAQ;CAAa;AAClF;AAeA,MAAM,iBAAiB,MAAuB,WAC5C,OAAO,cAAc,KAAK,IAAI,OAAO,OAAO,MAAM,CAAC,CAAC,KAClD,OAAO,SAAS,WACd,OAAO,IAAI;CACT,OAAO,OAAO,cAAc,OAAO,YAAY;CAC/C,OAAO,OAAO,cAAc,OAAO,KAAK;AAC1C,CAAC,CACH,GACA,OAAO,KAAK,EAAE,OAAO,aAAa;CAAE;CAAQ;CAAO;AAAM,EAAE,CAC7D;AAEF,MAAM,YAAY,SAChB,KACE,KAAK,OACL,MAAM,KAAK,UAAU;CACnB,MAAM,KAAK;CACX,cAAc,KACZ,SACA,MAAM,KAAK,WAAW,cAAc,MAAM,MAAM,CAAC,GACjD,MAAM,QACR;AACF,EAAE,CACJ;AAEF,MAAM,YAAY,iBAChB,KACE,cACA,MAAM,UAAU,gBAAgB,YAAY,OAAO,OAAO,KAAK,IAC9D,WAAW,KAAK,QAAQ,MAAM,IAAI,KAAK,MAAM,OAAO,SAAS,MAAM,CAAC,CAAC,CACxE;AAEF,MAAM,gBAAgB,MAA0C,UAAkC;CAChG,MAAM,KAAK;CACX,cAAc,KACZ,KAAK,cACL,MAAM,KAAK,EAAE,aACX,KACE,MACA,MAAM,SAAS,UACb,KACE,OACA,MAAM,WAAW,cAAc,UAAU,SAAS,KAAK,IAAI,GAC3D,OAAO,SAAS,cACd,KACE,UAAU,cACV,MAAM,WAAW,aAAa,SAAS,WAAW,MAAM,CAC1D,CACF,GACA,OAAO,OACT,CACF,GACA,QACF,CACF,GACA,MAAM,QACR;AACF;AAEA,MAAM,kBAAkB,UAAwD;CAC9E,MAAM,OAAO,KACX,OACA,MAAM,KAAK,SAAS,SAAS,IAAI,CAAC,CACpC;CACA,OAAO,KACL,MAAM,KAAK,IAAI,GACf,OAAO,MAAM;EACX,cAAc,CAAC;EACf,SAAS,UACP,KACE,OACA,MAAM,KAAK,SAAS,aAAa,MAAM,IAAI,CAAC,CAC9C;CACJ,CAAC,CACH;AACF;AAEA,MAAM,UAAU,gBACd,YAAY,OAAO,QAAQ,YAAY,QAAQ;AAEjD,MAAM,cAAc,UAClB,KACE,OACA,MAAM,SAAS,SACb,KACE,KAAK,cACL,MAAM,OAAO,MAAM,GACnB,MAAM,KAAK,gBAAgB,GAAG,KAAK,KAAK,IAAI,YAAY,OAAO,OAAO,CACxE,CACF,CACF;AAEF,MAAM,UAAU,gBAAqC;CACnD,MAAM,QAAQ,KAAK,YAAY,OAAO,OAAO,OAAO,OAAO,WAAW,CAAC;CACvE,MAAM,QAAQ,KAAK,YAAY,OAAO,OAAO,YAAY,KAAK,GAAG,OAAO,SAAS,WAAW,CAAC;CAC7F,OAAO,KACL;EAAC,KAAK;EAAS;EAAO,WAAW,YAAY,MAAM,QAAQ,YAAY;CAAG,GAC1E,MAAM,KAAK,GAAG,CAChB;AACF;AAEA,MAAM,WAAW,UACf,KACE,OACA,MAAM,SAAS,SAAS,CAAC,KAAK,MAAM,GAAG,KAAK,KAAK,cAAc,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,GAClF,MAAM,KAAK,IAAI,CACjB;AAEF,MAAM,aACJ,UACqE;CACrE,MAAM,QAAQ,eAAe,KAAK;CAClC,OAAO;EAAE,OAAO,QAAQ,KAAK;EAAG,UAAU,WAAW,KAAK;CAAE;AAC9D;;AC3IA,MAAM,eAAe;AACrB,MAAM,YAAY;AAClB,MAAM,eAAe;AAErB,MAAM,cAAc,OAAO;AAE3B,IAAM,aAAN,cAAyB,YAA2D,CAAC,CACnF,cACA,EAAE,UAAU,OAAO,MAAM,OAAO,MAAM,EAAE,CAC1C,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,WAAW,gBAAgB,EACzC,UAAU,EAAE,aAAa,kBAAkB,EAC7C,CAAC,CAAC,CAAC,KAAK,MAAM,QAAQ,kBAAkB,SAAS,GAAG,MAAM,QAAQ,gBAAgB,KAAK,CAAC;AAExF,MAAM,WAAW,MAAM,SAAS,SAAS,aAAa,KAAK;AAE3D,MAAM,aAAa,OAAO,oBAAoB,OAAO,eAAe,OAAO,OAAO,CAAC;AAEnF,MAAM,UAAU,QAAQ,KACtB,mBACA;CACE,MAAM,SAAS,OAAO,KAAK,CAAC,CAAC,KAC3B,SAAS,QAAQ,YAAY,GAC7B,SAAS,gBAAgB,8DAA8D,CACzF;CACA,aAAa,KAAK,OAAO,cAAc,CAAC,CAAC,KACvC,KAAK,YAAY,EAAE,GACnB,KAAK,gBAAgB,wCAAwC,CAC/D;CACA,MAAM,KAAK,IAAI,MAAM,CAAC,CAAC,KACrB,KAAK,YAAY,YAAY,GAC7B,KAAK,gBAAgB,iEAAiE,CACxF;CACA,iBAAiB,KAAK,OAAO,YAAY,CAAC,CAAC,KACzC,KAAK,YAAY,QAAQ,GACzB,KAAK,gBAAgB,uDAAuD,CAC9E;AACF,IACC,EAAE,MAAM,aAAa,MAAM,sBAC1B,OAAO,IAAI,UAAU,UAAU;CAC7B,MAAM,QAAQ,KAAK,aAAa,OAAO,MAAM,GAAG,GAAG,MAAM,OAAO,OAAO,CAAC;CACxE,MAAM,aAAa,OAAO,WAAW;CACrC,MAAM,OAAO,OAAO,KAAK;CACzB,OAAO,WAAW,cAAc,iBAAiB,EAAE,WAAW,KAAK,CAAC;CACpE,MAAM,UAAU,OAAO,OAAO,QAAQ,MAAM,MAAM,WAAW,IAAI,IAAI,QACnE,OAAO,IAAI,UAAU,aAAa;EAChC,MAAM,EAAE,QAAQ,SAAS,OAAO,YAAY,MAAM,KAAK;EACvD,OAAO,WAAW,gBAChB,KAAK,KAAK,iBAAiB,QAAQ,IAAI,SAAS,EAAE,MAAM,GACxD,IACF;EACA,OAAO,WAAW,gBAChB,KAAK,KAAK,iBAAiB,QAAQ,IAAI,SAAS,EAAE,MAAM,GACxD,OAAO,WAAW,MAAM,CAC1B;EACA,OAAO;CACT,CAAC,CACH;CACA,MAAM,EAAE,OAAO,aAAa,UAAU,OAAO;CAC7C,OAAO,QAAQ,IAAI,KAAK;CACxB,OAAO,OAAO,MAAM,MAAM,UAAU;EAClC,eAAe,OAAO;EACtB,aAAa,SAAS,OAAO,KAAK,WAAW,KAAK,EAAE,UAAU,KAAK,CAAC,CAAC;CACvE,CAAC;AACH,CAAC,CACL;AAEA,YAAY,QACV,MAAM,MAAM,QAAQ,CAAC,CAAC,KACpB,OAAO,SAAS,YACd,OAAO,eAAe,QAAQ,IAAI,SAAS,EAAE,SAAS,QAAQ,CAAC,GAAG,OAAO,CAC3E,GACA,OAAO,MACT,CACF"}

package/package.json

@@ -1,6 +1,56 @@
 {
   "name": "@r_masseater/web-vitals-flow",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.0.0",
+  "description": "Measure Core Web Vitals of page loads and same-origin link transitions with Lighthouse user flows, take the median of several runs, and fail when LCP, INP or CLS misses Lighthouse's passing score.",
+  "keywords": [
+    "cls",
+    "core-web-vitals",
+    "inp",
+    "lcp",
+    "lighthouse",
+    "opentelemetry",
+    "user-flow",
+    "web-vitals"
+  ],
+  "homepage": "https://github.com/masseater/measure-everything/tree/main/libs/web-vitals-flow#readme",
+  "bugs": {
+    "url": "https://github.com/masseater/measure-everything/issues"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/masseater/measure-everything.git",
+    "directory": "libs/web-vitals-flow"
+  },
+  "bin": {
+    "web-vitals-flow": "./dist/main.mjs"
+  },
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "type": "module",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "dependencies": {
+    "@effect/platform-node": "4.0.7",
+    "chrome-launcher": "1.2.2",
+    "effect": "4.0.7",
+    "lighthouse": "13.6.0",
+    "puppeteer-core": "25.16.0"
+  },
+  "devDependencies": {
+    "@r_masseater/vitest-otlp": "0.0.0",
+    "@types/node": "26.6.6",
+    "vite-plus": "1.4.0"
+  },
+  "engines": {
+    "node": ">=26"
+  },
+  "scripts": {
+    "build": "vp pack",
+    "test": "vp test run"
+  }
 }