@tokenoftrust/storefront-runner 3.4.0 → 3.4.1

package/apps/storefront/src/lib/observability/diag/serverResponseTime.ts

@@ -1,18 +1,20 @@
 /**
- * The document's server response time for the evidence panel: the `total` the Worker stamps in
- * `Server-Timing` (`lib/observability/shared/serverTiming.ts`) next to the time this self-fetch
- * waited for the response headers (TTFB as seen from the Worker). Advisory — never gates promotion.
+ * The document's server response time for the evidence panel, measured in the viewer's browser
+ * (a Worker fetching its own zone is answered by the origin, never by this Worker, so a
+ * server-side self-fetch cannot see the render). The panel script fetches the home document
+ * same-origin with the viewer's credentials and `__preview` grant, then reports the `total` the
+ * Worker stamps in `Server-Timing` (`lib/observability/shared/serverTiming.ts`) beside the time to
+ * first byte. Advisory — never gates promotion.
  *
- * The self-fetch carries the viewer's preview grant so it measures the render a reviewer gets. A
- * gate page or any non-200 answer is not that render, so it is reported as not measured rather
- * than as a number.
+ * A gate page or any non-200 answer is not the render a reviewer gets, so it is reported as not
+ * measured rather than as a number.
  */
 
 export interface ServerResponseTime {
   measured: true;
   /** `total;dur` from the document's `Server-Timing`, or null when the header is absent. */
   serverTotalMs: number | null;
-  /** Wall time until the response headers arrived. */
+  /** Time to first byte. */
   ttfbMs: number;
   /** The isolate was serving its first request (`isolate;desc="cold"`). */
   cold: boolean;
@@ -23,6 +25,8 @@ export interface ServerResponseTimeUnmeasured {
   reason: string;
 }
 
+export type ServerResponseTimeResult = ServerResponseTime | ServerResponseTimeUnmeasured;
+
 /** Pull `total;dur` and the cold marker out of a `Server-Timing` header value. */
 export function parseServerTiming(header: string | null | undefined): Pick<ServerResponseTime, "serverTotalMs" | "cold"> {
   if (!header) return { serverTotalMs: null, cold: false };
@@ -34,35 +38,54 @@ export function parseServerTiming(header: string | null | undefined): Pick<Serve
   };
 }
 
-/**
- * The URL and headers that make a self-fetch of `path` the viewer's own render: the request's
- * `__preview` grant (query) and cookies are forwarded.
- */
-export function viewerRenderRequest(requestUrl: string, path: string, cookie: string | null): { url: URL; headers: Headers } {
-  const source = new URL(requestUrl);
-  const url = new URL(path, source.origin);
-  const grant = source.searchParams.get("__preview");
-  if (grant) url.searchParams.set("__preview", grant);
-  const headers = new Headers();
-  if (cookie) headers.set("cookie", cookie);
-  return { url, headers };
+/** Turn the home document's response into a measurement, or the reason it is not one. */
+export function classifyHomeResponse(
+  res: { status: number; headers: { get(name: string): string | null } },
+  ttfbMs: number,
+): ServerResponseTimeResult {
+  const gate = res.headers.get("x-tot-gate");
+  if (gate) return { measured: false, reason: `the fetch was answered by the access gate (${gate}), not the store render` };
+  if (res.status !== 200) return { measured: false, reason: `the home document answered ${res.status}, not a render` };
+  return { measured: true, ...parseServerTiming(res.headers.get("server-timing")), ttfbMs: Math.round(ttfbMs) };
 }
 
-/** Self-fetch and report the server response time, or why it could not be measured. */
-export async function measureServerResponseTime(
-  request: { url: URL; headers: Headers },
-  now: () => number = () => performance.now(),
-): Promise<ServerResponseTime | ServerResponseTimeUnmeasured> {
+/** The sentence the panel shows for a result. */
+export function describeServerResponseTime(result: ServerResponseTimeResult): string {
+  if (!result.measured) return `Not measured: ${result.reason}.`;
+  const server = result.serverTotalMs !== null ? `${result.serverTotalMs} ms server total (Server-Timing)` : "no Server-Timing header";
+  return `Home document: ${server} · ${result.ttfbMs} ms to first byte${result.cold ? " · cold isolate" : ""}. A hosted preview is a Worker render; a published static site is served from the CDN and is faster.`;
+}
+
+export interface BrowserDeps {
+  fetch: typeof fetch;
+  /** Resource-timing entries for a URL (`performance.getEntriesByName`). */
+  entries: (url: string) => PerformanceEntry[];
+  now: () => number;
+}
+
+/**
+ * Fetch the home document as the viewer and measure it. TTFB is the resource-timing
+ * `responseStart - requestStart` for that request, falling back to the wall time to headers.
+ */
+export async function measureHomeDocument(homeUrl: URL, deps: BrowserDeps): Promise<ServerResponseTimeResult> {
   try {
-    const started = now();
-    const res = await fetch(request.url, { headers: request.headers, redirect: "manual" });
-    const ttfbMs = now() - started;
-    await res.body?.cancel();
-    const gate = res.headers.get("x-tot-gate");
-    if (gate) return { measured: false, reason: `the fetch was answered by the access gate (${gate}), not the store render` };
-    if (res.status !== 200) return { measured: false, reason: `the home document answered ${res.status}, not a render` };
-    return { measured: true, ...parseServerTiming(res.headers.get("server-timing")), ttfbMs: Math.round(ttfbMs) };
+    const started = deps.now();
+    const res = await deps.fetch(homeUrl.href, { credentials: "include", redirect: "manual", cache: "no-store" });
+    const wallMs = deps.now() - started;
+    await res.arrayBuffer();
+    const timing = deps.entries(homeUrl.href).at(-1) as PerformanceResourceTiming | undefined;
+    const ttfbMs = timing && timing.responseStart > 0 && timing.requestStart > 0 ? timing.responseStart - timing.requestStart : wallMs;
+    return classifyHomeResponse(res, ttfbMs);
   } catch {
     return { measured: false, reason: "the home document could not be fetched" };
   }
 }
+
+/** Measure the home document and write the sentence into `target`. */
+export async function mountServerResponseTime(target: Element, pageUrl: string, deps: BrowserDeps): Promise<void> {
+  const page = new URL(pageUrl);
+  const homeUrl = new URL(target.getAttribute("data-home-path") ?? "/", page.origin);
+  const grant = page.searchParams.get("__preview");
+  if (grant) homeUrl.searchParams.set("__preview", grant);
+  target.textContent = describeServerResponseTime(await measureHomeDocument(homeUrl, deps));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tokenoftrust/storefront-runner",
-  "version": "3.4.0",
+  "version": "3.4.1",
   "license": "SEE LICENSE IN LICENSE",
   "description": "World-shareable storefront runner: multi-tenant renderer on Astro/Cloudflare. No control plane.",
   "packageManager": "pnpm@11.9.0",