src/watcher-checks.ts

Functions

Imports

It imports no other module of this repo. Imported by src/watcher-digest.ts, src/watcher-gather.ts, src/watcher.ts.

Source

1// The watcher's checks (src/watcher.ts runs the pass): which check owns each
2// fingerprint, and which class of finding it is.
3
4// Which check produces each fingerprint. An open job is cleared only when the check
5// that would find it again actually ran: a failed read is not evidence the problem
6// went away. A fingerprint no check owns is cleared.
7export const WATCHER_CHECKS = [
8  "health",
9  "master head",
10  "migrations",
11  "status",
12  "mirror dumps",
13  "mirror runs",
14  "ci",
15  "site map",
16  "repo map",
17  "site probes",
18  "cloudflare",
19  "live checks",
20  "site repairs",
21  "agent anomalies",
22  "tool anomalies",
23  "domains",
24  "deploys",
25  "stale canon",
26] as const;
27export type WatcherCheck = (typeof WATCHER_CHECKS)[number];
28
29const OWNERS: ReadonlyArray<readonly [RegExp, WatcherCheck]> = [
30  [/^(health-degraded|backup-stale|backup-never)$/, "health"],
31  [/^deploy-drift-/, "master head"],
32  [/^schema-behind-/, "migrations"],
33  [/^schema-ahead-/, "migrations"],
34  [/^breaker-open-/, "status"],
35  [/^mirror-no-dump$/, "mirror dumps"],
36  [/^(mirror-not-running$|mirror-run-failed-|mirror-green-no-dump$)/, "mirror runs"],
37  [/^ci-red-/, "ci"],
38  [/^site-map-drift-/, "site map"],
39  [/^unmapped-repo/, "repo map"],
40  [/^site-down-/, "site probes"],
41  [/^site-errors-/, "cloudflare"],
42  [/^live-config-/, "live checks"],
43  [/^live-/, "live checks"],
44  [/^site-health-/, "site repairs"],
45  [/^site-weekly-/, "site repairs"],
46  // Before the audit rule's prefix, which would otherwise claim these too.
47  [/^anomaly-tool-/, "tool anomalies"],
48  [/^anomaly-/, "agent anomalies"],
49  [/^domain-expiry-/, "domains"],
50  [/^deploy-(rolled-back|rollback-failed)-/, "deploys"],
51  [/^stale-canon-/, "stale canon"],
52];
53
54export function owningCheck(fingerprint: string): WatcherCheck | null {
55  return OWNERS.find(([pattern]) => pattern.test(fingerprint))?.[1] ?? null;
56}
57
58// WHAT A FINDING IS FOR (job_2c92174d5bff item 5; every alert actionable, the rest to a
59// digest). One class per OWNERS pattern, the same patterns in the same order:
60//   job        a person must act now: it posts a job.
61//   digest     a hygiene or drift finding: kept in finding memory and shown on the Portal's
62//              weekly digest per site and in the Monday email; posts no job.
63//   attention  shown on the Portal's attention list only; posts no job.
64// test/watcher-classes.test.ts fails when OWNERS and this table disagree in either
65// direction. A fingerprint no pattern names is a job, so an unclassed finding is loud.
66export type FindingClass = "job" | "digest" | "attention";
67const CLASSES: ReadonlyArray<readonly [RegExp, FindingClass]> = [
68  [/^(health-degraded|backup-stale|backup-never)$/, "job"],
69  [/^deploy-drift-/, "job"],
70  [/^schema-behind-/, "job"],
71  [/^schema-ahead-/, "digest"],
72  [/^breaker-open-/, "attention"],
73  [/^mirror-no-dump$/, "job"],
74  [/^(mirror-not-running$|mirror-run-failed-|mirror-green-no-dump$)/, "job"],
75  [/^ci-red-/, "job"],
76  [/^site-map-drift-/, "job"],
77  [/^unmapped-repo/, "job"],
78  [/^site-down-/, "job"],
79  [/^site-errors-/, "job"],
80  [/^live-config-/, "job"],
81  [/^live-/, "digest"],
82  [/^site-health-/, "job"],
83  [/^site-weekly-/, "digest"],
84  [/^anomaly-tool-/, "attention"],
85  [/^anomaly-/, "attention"],
86  [/^domain-expiry-/, "job"],
87  [/^deploy-(rolled-back|rollback-failed)-/, "job"],
88  [/^stale-canon-/, "digest"],
89];
90
91export function findingClass(fingerprint: string): FindingClass {
92  return CLASSES.find(([pattern]) => pattern.test(fingerprint))?.[1] ?? "job";
93}
94
95/** The patterns each table names, for the coverage test. */
96export const OWNER_PATTERNS: readonly string[] = OWNERS.map(([p]) => p.source);
97export const CLASS_PATTERNS: readonly string[] = CLASSES.map(([p]) => p.source);