app/lib/admin/check-copy.mjs

Functions

Imports

It imports no other module of this repo. Imported by app/routes/admin._index.tsx.

Source

1/**
2 * @typedef {object} CheckCopy
3 * @property {string} name
4 * @property {(counts: { expected: number, present: number } | undefined) => string | null} failing
5 * @property {string} passing
6 * @property {{ action: string, intent: string, label: string } | null} repair
7 */
8
9/** @type {Record<string, CheckCopy>} */
10const CHECK_COPY = {
11  "content-drift": {
12    name: "Posts on the site",
13    failing: (counts) =>
14      counts
15        ? `${counts.expected - counts.present} of the ${counts.expected} posts are older on the site than in the repository. Syncing re-renders them.`
16        : "Some posts are older on the site than in the repository. Syncing re-renders them.",
17    passing: "Every post on the site matches the one in the repository.",
18    repair: { action: "/admin/posts", intent: "regenerate", label: "Re-render every post" },
19  },
20  "procedures-drift": {
21    name: "Procedures on the site",
22    failing: (counts) =>
23      counts
24        ? `${counts.expected - counts.present} of the ${counts.expected} procedures are older on the site than in the repository. The site's watcher re-compiles them on its next check.`
25        : "Some procedures are older on the site than in the repository. The site's watcher re-compiles them on its next check.",
26    passing: "Every procedure on the site matches the one in the repository.",
27    repair: null,
28  },
29  "dictionary-drift": {
30    name: "Dictionary entries on the site",
31    failing: (counts) =>
32      counts
33        ? `${counts.expected - counts.present} of the ${counts.expected} dictionary entries are older on the site than in the repository. The site's watcher re-compiles them on its next check.`
34        : "Some dictionary entries are older on the site than in the repository. The site's watcher re-compiles them on its next check.",
35    passing: "Every dictionary entry on the site matches the one in the repository.",
36    repair: null,
37  },
38  "registry-drift": {
39    name: "Lab registry on the site",
40    failing: (counts) =>
41      counts
42        ? `${counts.expected - counts.present} of the ${counts.expected} lab registry items are older on the site than in the repository. The site's watcher re-compiles them on its next check.`
43        : "Some lab registry items are older on the site than in the repository. The site's watcher re-compiles them on its next check.",
44    passing: "Every lab registry item on the site matches the one in the repository.",
45    repair: null,
46  },
47  "pages-drift": {
48    name: "Pages on the site",
49    failing: (counts) =>
50      counts
51        ? `${counts.expected - counts.present} of the ${counts.expected} pages are older on the site than in the repository. The site's watcher re-compiles them on its next check.`
52        : "Some pages are older on the site than in the repository. The site's watcher re-compiles them on its next check.",
53    passing: "Every page on the site matches the one in the repository.",
54    repair: null,
55  },
56  "publications-drift": {
57    name: "Publications on the site",
58    failing: (counts) =>
59      counts
60        ? `${counts.expected - counts.present} of the ${counts.expected} publications are older on the site than in the repository. The site's watcher re-compiles them on its next check.`
61        : "Some publications are older on the site than in the repository. The site's watcher re-compiles them on its next check.",
62    passing: "Every publication on the site matches the one in the repository.",
63    repair: null,
64  },
65  "roster-drift": {
66    name: "Roster on the site",
67    failing: (counts) =>
68      counts
69        ? `${counts.expected - counts.present} of the ${counts.expected} cohorts are older on the site than in the repository. The site's watcher re-compiles them on its next check.`
70        : "Some cohorts are older on the site than in the repository. The site's watcher re-compiles them on its next check.",
71    passing: "Every cohort on the site matches the one in the repository.",
72    repair: null,
73  },
74  "phage-drift": {
75    name: "Phage table on the site",
76    failing: (counts) =>
77      counts
78        ? `${counts.expected - counts.present} of the ${counts.expected} phages are older on the site than in the repository. The site's watcher re-compiles them on its next check.`
79        : "Some phages are older on the site than in the repository. The site's watcher re-compiles them on its next check.",
80    passing: "Every phage on the site matches the one in the repository.",
81    repair: null,
82  },
83  "llms-drift": {
84    name: "The llms.txt file on the site",
85    failing: () =>
86      "The llms.txt the site serves is older than the one in the repository. The site's watcher rewrites it on its next check.",
87    passing: "The llms.txt the site serves matches the one in the repository.",
88    repair: null,
89  },
90  "cv-drift": {
91    name: "The CV on the site",
92    failing: (counts) =>
93      counts
94        ? `${counts.expected - counts.present} of the ${counts.expected} CV files are older on the site than in the repository. The site's watcher re-compiles them on its next check.`
95        : "Some CV files are older on the site than in the repository. The site's watcher re-compiles them on its next check.",
96    passing: "The CV on the site matches the CV in the repository.",
97    repair: null,
98  },
99  "cv-pdf-drift": {
100    name: "The CV PDF",
101    failing: () =>
102      "The CV PDF is older than the CV on the site, or missing. The site's watcher re-renders it on its next check.",
103    passing: "The CV PDF was drawn from the CV the site shows.",
104    repair: null,
105  },
106  "ask-index-drift": {
107    name: "Search answers",
108    failing: (counts) =>
109      counts
110        ? `The answer index has ${counts.present} of ${counts.expected} posts, so an answer may quote text that has changed.`
111        : "The answer index is out of step with the posts, so an answer may quote text that has changed.",
112    passing: "The answer index has every post, and none it should not.",
113    repair: { action: "/admin/posts", intent: "sync-ask", label: "Rebuild the answer index" },
114  },
115  "media-index-drift": {
116    name: "Media library",
117    failing: (counts) =>
118      counts
119        ? `The library lists ${counts.present} files and ${counts.expected} are stored, so something is missing from one side.`
120        : "The library and the stored files disagree about what exists.",
121    passing: "Every stored file is listed, and nothing is listed that is not there.",
122    repair: { action: "/admin/media", intent: "rebuild", label: "Rebuild the library listing" },
123  },
124  "media-backup-drift": {
125    name: "Media backups",
126    // No counts: it compares key sets and etags, not totals, so the verdict's detail is used.
127    failing: () => null,
128    passing: "Every uploaded file has a second, byte-identical copy.",
129    repair: null,
130  },
131  "fts-equality": {
132    name: "Site search",
133    // Same: five subqueries compared pairwise, not a total against a total.
134    failing: () => null,
135    passing: "Search knows about every post and every page it should.",
136    repair: null,
137  },
138};
139
140/**
141 * @param {{ name: string, ok: boolean, detail: string, counts?: { expected: number, present: number } }} check
142 * @returns {{ name: string, finding: string, repair: { action: string, intent: string, label: string } | null }}
143 */
144export function humanCheck(check) {
145  const copy = CHECK_COPY[check.name];
146  if (!copy) {
147    // A check with no words yet still reads as words: "registry-drift" becomes "Registry drift".
148    const words = check.name.replace(/-/g, " ");
149    return { name: words.charAt(0).toUpperCase() + words.slice(1), finding: check.detail, repair: null };
150  }
151  if (check.ok) {
152    return { name: copy.name, finding: copy.passing, repair: null };
153  }
154  const finding = copy.failing(check.counts) ?? check.detail;
155  return { name: copy.name, finding, repair: copy.repair };
156}
157
158/**
159 * @param {Array<{ name: string, ok: boolean, detail: string, counts?: { expected: number, present: number } }>} checks
160 * @returns {string}
161 */
162export function statusSentence(checks) {
163  const failing = checks.filter((check) => !check.ok);
164  // Guard the value, not the length, so the compiler knows `worst` is defined.
165  const worst = failing[0];
166  if (!worst) {
167    return "Everything agrees: the site, the repository, the library and search are all in step.";
168  }
169  const first = humanCheck(worst);
170  if (failing.length === 1) {
171    return `One thing needs attention. ${first.finding}`;
172  }
173  return `${failing.length} things need attention. ${first.finding}`;
174}