app/lib/editor/write-path.server.ts

Functions

Imports

It imports app/lib/editor/github.server.ts. Imported by app/kb/procedures/save.server.ts, app/kb/registry/save.server.ts, app/lib/cv/save.server.ts, app/lib/dictionary/save.server.ts, app/lib/editor/publish.server.ts, app/lib/llms/save.server.ts, app/lib/operator/api.server.ts, app/lib/pages/save.server.ts, app/lib/phages/save.server.ts, app/lib/publications/save.server.ts, app/lib/roster/save.server.ts.

Source

1// The one place a content save decides whether it commits. Every content kind's save (posts, procedures,
2// and the kinds Carrel writes through the site API) calls this, so "an unchanged save does nothing"
3// is one rule and not one copy per kind.
4
5import { commitFiles, getHead } from "./github.server";
6
7/** What a save answers when its file is byte-identical to the committed one. */
8export const UNCHANGED_NOTE =
9  "The file is identical to the committed one, so nothing was committed or rewritten. commitSha is the current head.";
10
11type Committed = Awaited<ReturnType<typeof commitFiles>>;
12
13export type WriteDecision =
14  /** Identical file and D1 already holds its row: nothing to do. */
15  | { action: "noop"; commitSha: string }
16  /** Identical file, but D1's row is missing or stale: no commit, the caller repairs the row. */
17  | { action: "repair"; commitSha: string; blobShas: Record<string, string | null> }
18  /** A changed file: committed. */
19  | { action: "commit"; commitSha: string; blobShas: Record<string, string | null> };
20
21/**
22 * A file byte-identical to the committed one is never committed (the commit would be empty and still start
23 * CI and a deploy). If D1 already holds this file's row the save stops there; if not, the caller rewrites
24 * the row from the file without a commit.
25 *
26 * @param existing the committed file, or null when the path is new
27 * @param rowIsCurrent whether D1's row was derived from exactly these bytes; read only for an identical file
28 * @param commit the commit to make for a changed file
29 */
30export async function commitUnlessUnchanged(
31  env: Parameters<typeof getHead>[0],
32  options: {
33    existing: { content: string } | null;
34    raw: string;
35    rowIsCurrent: () => Promise<boolean>;
36    commit: () => Promise<Committed>;
37  },
38): Promise<WriteDecision> {
39  const { existing, raw } = options;
40  if (existing !== null && existing.content === raw) {
41    const commitSha = (await getHead(env)).commitSha;
42    return (await options.rowIsCurrent())
43      ? { action: "noop", commitSha }
44      : { action: "repair", commitSha, blobShas: {} };
45  }
46  const { commitSha, blobShas } = await options.commit();
47  return { action: "commit", commitSha, blobShas };
48}