Something went wrong. Try again.
Monorepo for Tangled forked from tangled.org/core
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277import { MAX_INLINE_SIZE } from "./blob";import { blob } from "./gitclient";import { diffFileKind, diffFileStat, diffSideExists, getDiff, getInterdiff, listLog, type MirrorFileDiff, type MirrorFileKind} from "./gitmirror";import type { FileContents } from "@pierre/diffs";import type * as ShTangledGitDefs from "./lexicons/types/sh/tangled/git/defs";import type { Did } from "@atcute/lexicons/syntax";import type { BobbinContext } from "./client";import type { GitTarget } from "./gitclient";import type { DiffStat } from "./diff";import type { Revspec } from "./pullRoute";import type { CommitSummary } from "./repo";
type DiffSrc = ShTangledGitDefs.DiffSrc;
// a sanity ceiling, not a render budget: contents are fetched per card on demand,// so this only stops a pathological diff from queueing unbounded workconst FILE_LIMIT = 300;
// pierre renders roughly one row per line pair, plus a little chrome per hunk. only// used to reserve height under a pending card, so an estimate is enoughconst HUNK_CHROME_LINES = 2;
// what the page asks for: one version's diff, or the interdiff between two of// them. `repo` is the source repo -- gitmirror unions both dids' object dirs// into one scratch repo, so a fork's head and its base share one did hereexport interface DiffSpec { kind: "diff"; repo: Did; version: Revspec;}
export interface InterdiffSpec { kind: "interdiff"; repo: Did; oldVersion: Revspec; version: Revspec; // narrows the interdiff to the one commit carrying this change id changeId?: string;}
export type PullDiffSpec = DiffSpec | InterdiffSpec;
export interface PullDiffDeps { ctx: BobbinContext; // where the blob text comes from; the diff payload carries line numbers only git: GitTarget;}
export interface PullDiffFile { // stable across sides, used for anchors key: string; name: string; oldName?: string; kind: MirrorFileKind; stat: { insertions: number; deletions: number }; // rough rendered height, so a card can reserve space before its text lands lines: number; // set when there is nothing to render: binary, submodule, too large, or past // the ceiling. a file with a note has no `sides` to fetch note?: string; sides?: { lhs: DiffSrc; rhs: DiffSrc };}
// where the two sides' text comes from. an interdiff's lhs is a tree gitmirror// rebased in memory for that one request, reachable by no ref, so its text can// only arrive inlined on the payloadexport type ContentsSource = | { inlineOld?: false; oldRef: string; newRef: string } | { inlineOld: true; newRef: string };
export interface PullDiff { files: PullDiffFile[]; stat: DiffStat; // how many files were listed but left unrendered by the ceiling truncated: number; contents: ContentsSource;}
// one file's two sides, ready for pierre to diffexport interface FilePair { oldFile: FileContents; newFile: FileContents;}
export type FileContentsResult = FilePair | { note: string };
export const loadDiff = (deps: PullDiffDeps, spec: PullDiffSpec): Promise<PullDiff> => { if (spec.kind === "diff") return plainDiff(deps, spec.repo, spec.version); if (!spec.changeId) return interdiff(deps, spec.repo, spec.oldVersion, spec.version); return oneChange(deps, spec);};
const plainDiff = async (deps: PullDiffDeps, repo: Did, version: Revspec): Promise<PullDiff> => { const { diffs } = await getDiff(deps.ctx, { baseRepo: repo, baseCommit: version.base, headRepo: repo, headCommit: version.head }); // the left side is read at `base`, while gitmirror diffs from // merge_base(base, head). identical when base is the merge base, which is // what a pull version stores return buildDiff(diffs, { oldRef: version.base, newRef: version.head });};
// an interdiff's right side is the new version's head tree, so it reads like any// other diff -- its left side comes inlined, see `ContentsSource`const interdiff = async ( deps: PullDiffDeps, repo: Did, oldVersion: Revspec, version: Revspec): Promise<PullDiff> => { const { diffs } = await getInterdiff(deps.ctx, { baseRepo: repo, baseCommit1: oldVersion.base, baseCommit2: oldVersion.head, headRepo: repo, headCommit1: version.base, headCommit2: version.head }); return buildDiff(diffs, { inlineOld: true, newRef: version.head });};
// a change id names the same logical commit in both versions, so narrowing to it// means interdiffing that one commit's span on each sideconst oneChange = async (deps: PullDiffDeps, spec: InterdiffSpec): Promise<PullDiff> => { const [oldCommits, newCommits] = await Promise.all([ listLog(deps.ctx, spec.repo, spec.oldVersion), listLog(deps.ctx, spec.repo, spec.version) ]);
const target = resolveChange(spec.changeId ?? "", oldCommits, newCommits, spec); switch (target.kind) { case "missing": throw new Error("Can't find a commit with that change-id in this version."); case "diff": return plainDiff(deps, spec.repo, target.version); case "interdiff": return interdiff(deps, spec.repo, target.oldVersion, target.version); }};
export type ChangeTarget = // the change is missing in the newer version, so there is nothing to interdiff | { kind: "missing" } // the change is new in the newer version, so we just diff since its parent | { kind: "diff"; version: Revspec } | { kind: "interdiff"; oldVersion: Revspec; version: Revspec };
// a root commit has no parent to diff against, so it falls back to the base of// the version it belongs toconst single = (commit: CommitSummary, fallbackBase: string): Revspec => ({ base: commit.parent ?? fallbackBase, head: commit.hash});
export const resolveChange = ( changeId: string, oldCommits: readonly CommitSummary[], newCommits: readonly CommitSummary[], bases: { oldVersion: Revspec; version: Revspec }): ChangeTarget => { const find = (commits: readonly CommitSummary[]) => commits.find((commit) => commit.changeId === changeId);
const to = find(newCommits); if (!to) return { kind: "missing" };
const from = find(oldCommits); if (!from) return { kind: "diff", version: single(to, bases.version.base) };
return { kind: "interdiff", oldVersion: single(from, bases.oldVersion.base), version: single(to, bases.version.base) };};
// the diff endpoint answers metadata only -- `diffSrc` is path/oid/size/flags and// a hunk is aligned line numbers -- so the text comes from the blob endpoint and// pierre diffs the two sides itselfconst buildDiff = (diffs: MirrorFileDiff[], contents: ContentsSource): PullDiff => { const stat: DiffStat = { insertions: 0, deletions: 0, files_changed: diffs.length }; const files = diffs.map((file, index): PullDiffFile => { const fileStat = diffFileStat(file); stat.insertions += fileStat.insertions; stat.deletions += fileStat.deletions;
const kind = diffFileKind(file); const name = file.rhsSrc.path || file.lhsSrc.path; const base: PullDiffFile = { key: `${file.lhsSrc.path}→${file.rhsSrc.path}`, name, oldName: kind === "renamed" ? file.lhsSrc.path : undefined, kind, stat: fileStat, lines: renderedLines(file) };
if (file.lhsSrc.isSubmodule || file.rhsSrc.isSubmodule) { return { ...base, note: "Submodule pointer, not shown." }; } if (file.lhsSrc.isBinary || file.rhsSrc.isBinary) { return { ...base, note: "This is a binary file and will not be displayed." }; } // the payload carries each side's size, so a file the blob endpoint would // refuse never costs a request if (tooLarge(file.lhsSrc) || tooLarge(file.rhsSrc)) { return { ...base, note: "This file is too large to display." }; } if (index >= FILE_LIMIT) { return { ...base, note: "Not rendered: too many files in this diff." }; }
return { ...base, sides: { lhs: file.lhsSrc, rhs: file.rhsSrc } }; });
return { files, stat, truncated: Math.max(diffs.length - FILE_LIMIT, 0), contents };};
const tooLarge = (src: DiffSrc): boolean => src.size > MAX_INLINE_SIZE;
const renderedLines = (file: MirrorFileDiff): number => file.hunks.reduce((total, hunk) => total + hunk.lines.length + HUNK_CHROME_LINES, 0);
// one side's text: inlined when gitmirror already sent it, otherwise a blob read.// `null` is a side that could not be read, which is not the same as an empty sideconst sideContents = async ( git: GitTarget, ref: string | undefined, src: DiffSrc): Promise<string | null> => { // a side that doesn't exist at this ref is an empty side, not a failed fetch if (!diffSideExists(src)) return ""; if (src.content !== undefined) return src.content; // the rebased tree an interdiff diffs against is reachable by no ref, so a // missing inline side there can never be recovered if (ref === undefined) return null; const output = await blob(git, { ref, path: src.path }, MAX_INLINE_SIZE).catch(() => null); if (!output || output.encoding !== "utf-8") return null; return output.content ?? "";};
// phase two: one file's text, fetched when its card asks for itexport const fetchSides = async ( deps: PullDiffDeps, contents: ContentsSource, file: PullDiffFile): Promise<FileContentsResult> => { const sides = file.sides; if (!sides) return { note: file.note ?? "Contents could not be loaded." };
const [oldContents, newContents] = await Promise.all([ sideContents(deps.git, contents.inlineOld ? undefined : contents.oldRef, sides.lhs), sideContents(deps.git, contents.newRef, sides.rhs) ]); if (oldContents === null || newContents === null) { return { note: "Contents could not be loaded." }; }
return { // pierre infers the language from the name, same as the blob page oldFile: { name: sides.lhs.path || file.name, contents: oldContents }, newFile: { name: file.name, contents: newContents } };};