Add short canonical lifecycle probes

Author: chubes4

packages/runtime-cloudflare/src/worker.ts

@@ -566,7 +566,7 @@ async function runBootProbe(phase: string, bucket: R2Bucket): Promise<Response>
     }
   }
 
-  if (["canonical-current-user", "canonical-init", "canonical-site-status", "canonical-wp-loaded", "canonical-wp-loaded-callbacks", "canonical-wp-loaded-exclude-rewrite-flush", "canonical-wp-loaded-exclude-core-template-header", "canonical-wp-loaded-exclude-playground", "canonical-wp-loaded-exclude-wp-cron", "canonical-wp-loaded-exclude-all"].includes(phase)) {
+  if (canonicalLifecyclePhaseAliases[phase] || ["canonical-current-user", "canonical-init", "canonical-site-status", "canonical-wp-loaded", "canonical-wp-loaded-callbacks", "canonical-wp-loaded-exclude-rewrite-flush", "canonical-wp-loaded-exclude-core-template-header", "canonical-wp-loaded-exclude-playground", "canonical-wp-loaded-exclude-wp-cron", "canonical-wp-loaded-exclude-all"].includes(phase)) {
     const runtime = await bootWordPressRuntime("do-not-attempt-installing", true, true, undefined, await packagedCanonicalMarkdownSeed(), new Uint8Array(markdownPrimaryBootstrapIndex), "https://canonical-probe.invalid", {}, bucket, true)
     try {
       const evidence = (await runtime.php.run({ code: canonicalLifecycleProbeCode(phase) })).text.trim()
@@ -1003,7 +1003,15 @@ file_put_contents($settings_path, str_replace($needle, $replacement, $settings))
 require '/wordpress/wp-load.php';`
 }
 
+const canonicalLifecyclePhaseAliases: Record<string, string> = {
+  "canon-wpl-no-rewrite": "canonical-wp-loaded-exclude-rewrite-flush",
+  "canon-wpl-no-core": "canonical-wp-loaded-exclude-core-template-header",
+  "canon-wpl-no-playground": "canonical-wp-loaded-exclude-playground",
+  "canon-wpl-no-cron": "canonical-wp-loaded-exclude-wp-cron",
+}
+
 function canonicalLifecycleProbeCode(phase: string): string {
+  const canonicalPhase = canonicalLifecyclePhaseAliases[phase] ?? phase
   const wpLoadedExclusions: Record<string, { identifiers: string[]; retain: boolean }> = {
     "canonical-wp-loaded-exclude-rewrite-flush": { identifiers: ["WP_Rewrite::flush_rules", "playground_maybe_flush_rewrite_rules"], retain: false },
     "canonical-wp-loaded-exclude-core-template-header": { identifiers: ["_add_template_loader_filters", "_custom_header_background_just_in_time", "_custom_logo_header_styles"], retain: false },
@@ -1020,11 +1028,11 @@ function canonicalLifecycleProbeCode(phase: string): string {
     "canonical-wp-loaded-callbacks": { needle: wpLoadedNeedle },
     ...Object.fromEntries(Object.keys(wpLoadedExclusions).map((name) => [name, { needle: wpLoadedNeedle }])),
   }
-  const stop = stops[phase]
+  const stop = stops[canonicalPhase]
   if (!stop) throw new Error(`Unknown canonical lifecycle probe phase: ${phase}`)
 
-  const wpLoadedProbe = phase === "canonical-wp-loaded-callbacks" || wpLoadedExclusions[phase]
-  const exclusion = wpLoadedExclusions[phase]
+  const wpLoadedProbe = canonicalPhase === "canonical-wp-loaded-callbacks" || wpLoadedExclusions[canonicalPhase]
+  const exclusion = wpLoadedExclusions[canonicalPhase]
   const wpLoadedStop = !wpLoadedProbe ? "" : `function wp_codebox_canonical_wp_loaded_callback_identifier($callback) {
     if (is_string($callback)) return $callback;
     if ($callback instanceof Closure) return 'Closure';
@@ -1073,7 +1081,7 @@ function wp_codebox_canonical_wp_loaded_remove_snapshot($identifiers, $retain) {
     return $removed;
 }
 $inventory = wp_codebox_canonical_wp_loaded_inventory();
-${phase === "canonical-wp-loaded-callbacks" ? `echo json_encode(array('wordpressVersion' => $wp_version, 'bootstrapPhase' => '${phase}', 'callbacks' => $inventory, 'memoryBytes' => memory_get_usage(true), 'peakMemoryBytes' => memory_get_peak_usage(true)));
+${canonicalPhase === "canonical-wp-loaded-callbacks" ? `echo json_encode(array('wordpressVersion' => $wp_version, 'bootstrapPhase' => '${phase}', 'callbacks' => $inventory, 'memoryBytes' => memory_get_usage(true), 'peakMemoryBytes' => memory_get_peak_usage(true)));
 return;` : `$removed = wp_codebox_canonical_wp_loaded_remove_snapshot(${JSON.stringify(exclusion?.identifiers ?? [])}, ${exclusion?.retain ? "true" : "false"});
 $memory_before = memory_get_usage(true);
 do_action('wp_loaded');

scripts/cloudflare-local-gate.mjs

@@ -171,12 +171,12 @@ async function assertHealthResponse() {
 async function assertCanonicalProbes() {
   const wordpress = await (await request(`${origin}/?phase=canonical-wordpress`)).json()
   const setup = await (await request(`${origin}/?phase=canonical-bootstrap-setup`)).json()
-  const lifecyclePhases = ["canonical-current-user", "canonical-init", "canonical-site-status", "canonical-wp-loaded-callbacks", "canonical-wp-loaded-exclude-rewrite-flush", "canonical-wp-loaded-exclude-core-template-header", "canonical-wp-loaded-exclude-playground", "canonical-wp-loaded-exclude-wp-cron", "canonical-wp-loaded-exclude-all"]
+  const lifecyclePhases = ["canonical-current-user", "canonical-init", "canonical-site-status", "canonical-wp-loaded-callbacks", "canon-wpl-no-rewrite", "canon-wpl-no-core", "canon-wpl-no-playground", "canon-wpl-no-cron", "canonical-wp-loaded-exclude-all"]
   const expectedRemovedCallbacks = {
-    "canonical-wp-loaded-exclude-rewrite-flush": ["WP_Rewrite::flush_rules"],
-    "canonical-wp-loaded-exclude-core-template-header": ["_add_template_loader_filters", "_custom_header_background_just_in_time"],
-    "canonical-wp-loaded-exclude-playground": ["playground_save_wp_env_info"],
-    "canonical-wp-loaded-exclude-wp-cron": [],
+    "canon-wpl-no-rewrite": ["WP_Rewrite::flush_rules"],
+    "canon-wpl-no-core": ["_add_template_loader_filters", "_custom_header_background_just_in_time"],
+    "canon-wpl-no-playground": ["playground_save_wp_env_info"],
+    "canon-wpl-no-cron": [],
     "canonical-wp-loaded-exclude-all": ["WP_Rewrite::flush_rules", "_add_template_loader_filters", "_custom_header_background_just_in_time", "playground_save_wp_env_info"],
   }
   const lifecycle = await Promise.all(lifecyclePhases.map(async (phase) => {
@@ -197,7 +197,7 @@ async function assertCanonicalProbes() {
   for (const probe of lifecycle) {
     const evidence = probe.evidence
     const schedulingAttached = probe.phase === "canonical-current-user"
-    const isWpLoadedProbe = probe.phase.startsWith("canonical-wp-loaded-")
+    const isWpLoadedProbe = probe.phase.startsWith("canonical-wp-loaded-") || probe.phase.startsWith("canon-wpl-no-")
     const lifecycleEvidenceIsValid = !isWpLoadedProbe && evidence?.wpCronInitAttached === schedulingAttached && evidence?.updateScheduleInitAttached === schedulingAttached && evidence?.privacyScheduleInitAttached === schedulingAttached
     const wpLoadedEvidenceIsValid = isWpLoadedProbe && typeof evidence?.callbacks === "object" && evidence.callbacks !== null && !Array.isArray(evidence.callbacks) && (probe.phase === "canonical-wp-loaded-callbacks" || (evidence?.completed === true && Array.isArray(evidence?.removedCallbacks) && Number.isInteger(evidence?.memoryBeforeBytes)))
     if (probe.completed !== true || !lifecyclePhases.includes(probe.phase) || evidence?.bootstrapPhase !== probe.phase || typeof evidence?.wordpressVersion !== "string" || !Number.isInteger(evidence?.memoryBytes) || !Number.isInteger(evidence?.peakMemoryBytes) || (!lifecycleEvidenceIsValid && !wpLoadedEvidenceIsValid)) {

tests/cloudflare-runtime.test.ts

@@ -317,12 +317,25 @@ test("Cloudflare canonical lifecycle diagnostics compose the disabled-cron patch
   const worker = await readFile(new URL("../packages/runtime-cloudflare/src/worker.ts", import.meta.url), "utf8")
   const probes = worker.slice(worker.indexOf("async function runBootProbe"), worker.indexOf("if (phase?.startsWith(\"seeded-\"))"))
   const lifecycle = worker.slice(worker.indexOf("function canonicalLifecycleProbeCode"), worker.indexOf("\nasync function bootWordPressRuntime"))
+  const aliases = {
+    "canon-wpl-no-rewrite": "canonical-wp-loaded-exclude-rewrite-flush",
+    "canon-wpl-no-core": "canonical-wp-loaded-exclude-core-template-header",
+    "canon-wpl-no-playground": "canonical-wp-loaded-exclude-playground",
+    "canon-wpl-no-cron": "canonical-wp-loaded-exclude-wp-cron",
+  }
 
   for (const phase of ["canonical-current-user", "canonical-init", "canonical-site-status", "canonical-wp-loaded", "canonical-wp-loaded-callbacks", "canonical-wp-loaded-exclude-rewrite-flush", "canonical-wp-loaded-exclude-core-template-header", "canonical-wp-loaded-exclude-playground", "canonical-wp-loaded-exclude-wp-cron", "canonical-wp-loaded-exclude-all"]) {
     assert.match(probes, new RegExp(`"${phase}"`))
     assert.match(lifecycle, new RegExp(`"${phase}"`))
     assert.deepEqual(routeWorkerRequest(new Request(`https://worker.example/?phase=${phase}`)), { kind: "probe", phase })
   }
+  for (const [alias, phase] of Object.entries(aliases)) {
+    assert.ok(alias.length <= 24)
+    assert.match(worker, new RegExp(`"${alias}"`))
+    assert.match(worker, new RegExp(`"${alias}": "${phase}"`))
+    assert.deepEqual(routeWorkerRequest(new Request(`https://worker.example/?phase=${alias}`)), { kind: "probe", phase: alias })
+  }
+  assert.match(lifecycle, /const canonicalPhase = canonicalLifecyclePhaseAliases\[phase\] \?\? phase/)
   assert.match(probes, /packagedCanonicalMarkdownSeed\(\), new Uint8Array\(markdownPrimaryBootstrapIndex\), "https:\/\/canonical-probe\.invalid", \{\}, bucket, true\)/)
   assert.match(lifecycle, /substr_count\(\$settings, \$needle\) !== 1/)
   assert.match(lifecycle, /WordPress canonical lifecycle probe needle was not uniquely found\./)