src/unmapped-repos.ts

Functions

Imports

It imports src/env.ts, src/github/client.ts. Imported by src/watcher-detect.ts, src/watcher-gather.ts.

Source

1import type { Env } from "./env";
2import { listInstalledRepos, type InstalledRepo } from "./github/client";
3
4// Repos the GitHub App can see that no namespace maps. A repo is reachable through
5// Capsid's tools only if a namespace maps it, and the mapping is the authorization
6// boundary, so this module only finds the gap. It never
7// maps: the seat or Dustin does, through capsid_admin_manage_namespaces action update.
8
9// Repos that are unmapped on purpose (archived, frozen, or deleted soon), one owner/name
10// per line, `#` comments allowed. An unsigned document is enough: it can only silence a
11// finding, never map or reach a repo.
12const UNMAPPED_ON_PURPOSE_NS = "capsid";
13const UNMAPPED_ON_PURPOSE_PATH = "unmapped-repos.md";
14
15export interface RepoMapRead {
16  installed: InstalledRepo[];
17  installations: number;
18  // Lowercased owner/name of every repo any namespace maps.
19  mapped: Set<string>;
20  onPurpose: Set<string>;
21  namespaces: string[];
22}
23
24export interface UnmappedRepo extends InstalledRepo {
25  suggested: string | null;
26}
27
28/** The lines of the on-purpose document as lowercased owner/name. */
29export function parseOnPurpose(body: string | null): Set<string> {
30  const out = new Set<string>();
31  for (const raw of (body ?? "").split("\n")) {
32    const line = raw.replace(/#.*/, "").trim().toLowerCase();
33    if (/^[a-z0-9._-]+\/[a-z0-9._-]+$/.test(line) && line.split("/").every((part) => part !== "." && part !== "..")) out.add(line);
34  }
35  return out;
36}
37
38/** The namespace a repo most likely belongs in, from its name alone: the repo named
39 *  for a namespace, else the longest namespace the name starts with up to a dash. */
40export function suggestNamespace(fullName: string, namespaces: string[]): string | null {
41  const name = (fullName.split("/")[1] ?? "").toLowerCase();
42  if (namespaces.includes(name)) return name;
43  const prefixed = namespaces.filter((ns) => name.startsWith(`${ns}-`)).sort((a, b) => b.length - a.length);
44  return prefixed[0] ?? null;
45}
46
47/** Installed repos that no namespace maps and the on-purpose list does not name. */
48export function unmappedRepos(read: RepoMapRead): UnmappedRepo[] {
49  return read.installed
50    .filter((r) => !read.mapped.has(r.full_name.toLowerCase()) && !read.onPurpose.has(r.full_name.toLowerCase()))
51    .map((r) => ({ ...r, suggested: suggestNamespace(r.full_name, read.namespaces) }))
52    .sort((a, b) => a.full_name.localeCompare(b.full_name));
53}
54
55/** The App's repos against the namespace mapping. Throws, rather than returning a
56 *  partial answer, on anything it cannot read whole: an empty list from the App is not
57 *  believed either, because "0 unmapped" over "0 listed" says nothing. */
58export async function readRepoMap(env: Env): Promise<RepoMapRead> {
59  const { repos, installations } = await listInstalledRepos(env);
60  if (repos.length === 0) {
61    throw new Error(`the App's ${installations} installation(s) list no repositories at all, which is not believable`);
62  }
63  const { results } = await env.DB.prepare("SELECT namespace, repos FROM namespaces ORDER BY namespace").all<{ namespace: string; repos: string | null }>();
64  const mapped = new Set<string>();
65  const namespaces: string[] = [];
66  for (const row of results ?? []) {
67    namespaces.push(row.namespace);
68    let list: unknown;
69    try {
70      list = JSON.parse(row.repos || "[]");
71    } catch {
72      throw new Error(`namespace ${row.namespace} has a corrupt repos mapping, so what is unmapped cannot be judged`);
73    }
74    if (!Array.isArray(list)) throw new Error(`namespace ${row.namespace} has a corrupt repos mapping (not an array)`);
75    for (const entry of list as Array<{ repo?: unknown }>) {
76      if (typeof entry?.repo === "string") mapped.add(entry.repo.toLowerCase());
77    }
78  }
79  const doc = await env.DB.prepare("SELECT body FROM documents WHERE namespace = ?1 AND path = ?2")
80    .bind(UNMAPPED_ON_PURPOSE_NS, UNMAPPED_ON_PURPOSE_PATH)
81    .first<{ body: string | null }>();
82  return { installed: repos, installations, mapped, onPurpose: parseOnPurpose(doc?.body ?? null), namespaces };
83}