@dev.fast/whiteboard 0.3.4-preview.20261019.126 → 0.3.4

package/src/review-api/foreign-references.ts

@@ -1,328 +0,0 @@
-import path from "node:path";
-
-import { type JsonValue, isJsonObject, isStringValue } from "@dev.fast/json";
-import { parseAnchor } from "@review/lens-selection.js";
-import {
-  markdownNodes,
-  markdownText,
-  parseMarkdown,
-} from "@review/markdown.js";
-
-/** A file's text at a commit; undefined when it can't be read. */
-export type ReadAtCommit = (
-  repositoryId: string,
-  commit: string,
-  file: string,
-) => string | undefined;
-
-const LANGUAGES = new Map([
-  [".ts", "typescript"],
-  [".tsx", "tsx"],
-  [".js", "javascript"],
-  [".jsx", "jsx"],
-  [".mjs", "javascript"],
-  [".rs", "rust"],
-  [".go", "go"],
-  [".py", "python"],
-  [".rb", "ruby"],
-  [".java", "java"],
-  [".kt", "kotlin"],
-  [".swift", "swift"],
-  [".c", "c"],
-  [".h", "c"],
-  [".cc", "cpp"],
-  [".cpp", "cpp"],
-  [".css", "css"],
-  [".html", "html"],
-  [".json", "json"],
-  [".md", "markdown"],
-  [".sh", "bash"],
-  [".sql", "sql"],
-  [".toml", "toml"],
-  [".yaml", "yaml"],
-  [".yml", "yaml"],
-]);
-
-/** A source link in Markdown, in either spelling. */
-const SOURCE_LINK = /^(?:whiteboard:source\/|review-source:)/i;
-
-/**
- * Migrates the old global scratchpad, which quoted several repositories.
- * A board may only quote its own, so each quote of another repository is
- * replaced:
- * - a code peek becomes a `code` block of those lines;
- * - a source link becomes its text, then what it pointed at in code;
- * - a diagram attachment leaves the diagram and its lines follow it as
- *   a `code` block;
- * - a step keeps its label and takes the lines as its code;
- * - a call stack or database lens becomes a line saying what it was,
- *   then a `code` block for each range it quoted, in any repository; the
- *   first takes its id. A lens that quotes only its own repository is
- *   kept.
- * New blocks take ids from `allocate`.
- */
-export function snapshotForeignReferences(
-  document: JsonValue[],
-  own: string,
-  read: ReadAtCommit,
-  repositoryName: (repositoryId: string) => string,
-  allocate: (prefix: string) => string,
-): JsonValue[] {
-  const foreign = (pins: JsonValue | undefined) =>
-    isJsonObject(pins) &&
-    isStringValue(pins.repositoryId) &&
-    pins.repositoryId !== own
-      ? pins
-      : undefined;
-
-  const caption = (
-    pins: { repositoryId: string; head: string; base?: string },
-    anchor: string,
-  ) => {
-    const selection = parseAnchor(anchor);
-
-    const commit =
-      selection?.start.side === "base" ? (pins.base ?? pins.head) : pins.head;
-
-    const range = selection
-      ? `${selection.file}:${selection.start.line}-${selection.end.line}`
-      : anchor;
-
-    return `${repositoryName(pins.repositoryId)} · ${range} @ ${commit.slice(0, 7)}`;
-  };
-
-  const snapshot = (
-    id: JsonValue | undefined,
-    pins: { repositoryId: string; head: string; base?: string },
-    anchor: string,
-  ): JsonValue => {
-    const selection = parseAnchor(anchor);
-
-    const commit =
-      selection?.start.side === "base" ? (pins.base ?? pins.head) : pins.head;
-
-    const file = selection
-      ? read(pins.repositoryId, commit, selection.file)
-      : undefined;
-
-    const label = caption(pins, anchor);
-
-    const text =
-      file !== undefined && selection
-        ? file
-            .split("\n")
-            .slice(selection.start.line - 1, selection.end.line)
-            .join("\n")
-        : `${label}\n(source unavailable)`;
-
-    return {
-      type: "code",
-      ...(isStringValue(id) && { id }),
-      language: selection
-        ? (LANGUAGES.get(path.extname(selection.file).toLowerCase()) ?? "text")
-        : "text",
-      text,
-      caption: label,
-    };
-  };
-
-  const pinsIn = (pins: JsonValue | undefined) => {
-    return isJsonObject(pins) &&
-      isStringValue(pins.repositoryId) &&
-      isStringValue(pins.head)
-      ? {
-          repositoryId: pins.repositoryId,
-          head: pins.head,
-          ...(isStringValue(pins.base) && { base: pins.base }),
-        }
-      : undefined;
-  };
-
-  const pinsOf = (value: JsonValue | undefined) => pinsIn(foreign(value));
-
-  const peeks = (blocks: JsonValue[]): JsonValue[] =>
-    blocks.map((block) => {
-      if (!isJsonObject(block)) return block;
-
-      if (Array.isArray(block.children))
-        return { ...block, children: peeks(block.children) };
-
-      const pins = pinsOf(block.pins);
-
-      if (block.type === "code_peek" && pins && isStringValue(block.source))
-        return snapshot(block.id, pins, block.source);
-
-      return block;
-    });
-
-  const rest = (blocks: JsonValue[]): JsonValue[] =>
-    blocks.flatMap((block): JsonValue | JsonValue[] => {
-      if (!isJsonObject(block)) return block;
-
-      if (Array.isArray(block.children))
-        return { ...block, children: rest(block.children) };
-
-      const blockPins = pinsOf(block.pins);
-
-      if (
-        block.type === "markdown" &&
-        blockPins &&
-        isStringValue(block.markdown)
-      ) {
-        const { pins: _pins, ...kept } = block;
-
-        return {
-          ...kept,
-          markdown: unlinkSourceLinks(block.markdown, blockPins),
-        };
-      }
-
-      if (block.type === "sequence" && Array.isArray(block.steps))
-        return {
-          ...block,
-          steps: block.steps.map((step) => {
-            if (!isJsonObject(step) || !isStringValue(step.source)) return step;
-            const pins = pinsOf(step.pins ?? block.pins);
-
-            if (!pins) return step;
-            const { source, pins: _pins, ...kept } = step;
-            const quoted = snapshot(undefined, pins, source);
-
-            return isJsonObject(quoted)
-              ? {
-                  ...kept,
-                  code: { language: quoted.language, text: quoted.text },
-                }
-              : kept;
-          }),
-        };
-
-      if (block.type === "flow_diagram" && Array.isArray(block.nodes)) {
-        const moved: JsonValue[] = [];
-
-        const diagram = {
-          ...block,
-          nodes: block.nodes.map((node) =>
-            isJsonObject(node) && Array.isArray(node.attachments)
-              ? {
-                  ...node,
-                  attachments: node.attachments.filter((attachment) => {
-                    if (
-                      !isJsonObject(attachment) ||
-                      !pinsOf(attachment.pins ?? block.pins)
-                    )
-                      return true;
-
-                    // Its lines stay on the board, after the diagram.
-                    for (const [pins, anchor] of quotes(
-                      attachment,
-                      pinsIn,
-                      block.pins,
-                    ))
-                      moved.push(snapshot(allocate("block"), pins, anchor));
-
-                    return false;
-                  }),
-                }
-              : node,
-          ),
-        };
-
-        return [diagram, ...moved];
-      }
-
-      if (block.type === "call_stack_diff" || block.type === "database_lens") {
-        const foreignQuote = quotes(block, pinsOf)[0];
-
-        if (!foreignQuote) return block;
-
-        const what =
-          block.type === "call_stack_diff" ? "Call stack" : "Database lens";
-
-        const title = isStringValue(block.title) ? ` “${block.title}”` : "";
-
-        // Its own repository's ranges too, so none of it is lost.
-        return [
-          {
-            type: "markdown",
-            id: allocate("block"),
-            markdown: `${what}${title} (from ${repositoryName(foreignQuote[0].repositoryId)}), kept as snapshots below.`,
-          },
-          ...quotes(block, pinsIn).map(([pins, anchor], index) =>
-            snapshot(index === 0 ? block.id : allocate("block"), pins, anchor),
-          ),
-        ];
-      }
-
-      return block;
-    });
-
-  /** The ranges a block's frames or operations quote at the pins `read`
-   * accepts. */
-  function quotes(
-    block: JsonValue,
-    read: typeof pinsIn,
-    inherited?: JsonValue,
-  ): [{ repositoryId: string; head: string; base?: string }, string][] {
-    if (Array.isArray(block))
-      return block.flatMap((item) => quotes(item, read, inherited));
-
-    if (!isJsonObject(block)) return [];
-    const scope = block.pins ?? inherited;
-    const pins = read(scope);
-
-    const own: [
-      { repositoryId: string; head: string; base?: string },
-      string,
-    ][] = pins
-      ? [
-          block.source,
-          block.callSite,
-          ...(Array.isArray(block.contextSources) ? block.contextSources : []),
-          ...(Array.isArray(block.sources) ? block.sources : []),
-        ].flatMap((anchor): [typeof pins, string][] =>
-          isStringValue(anchor) ? [[pins, anchor]] : [],
-        )
-      : [];
-
-    return [
-      ...own,
-      ...Object.entries(block)
-        .filter(([key]) => key !== "pins")
-        .flatMap(([, value]) =>
-          Array.isArray(value) || isJsonObject(value)
-            ? quotes(value, read, scope)
-            : [],
-        ),
-    ];
-  }
-
-  function unlinkSourceLinks(
-    markdown: string,
-    pins: { repositoryId: string; head: string; base?: string },
-  ) {
-    let result = markdown;
-
-    // Rewrite from the end so earlier offsets stay valid.
-    const links = [...markdownNodes(parseMarkdown(markdown))]
-      .filter(
-        (node) =>
-          node.type === "link" &&
-          SOURCE_LINK.test(node.url ?? "") &&
-          node.position?.start.offset !== undefined &&
-          node.position.end.offset !== undefined,
-      )
-      .reverse();
-
-    // Its text, then where it pointed, so neither is lost.
-    for (const node of links)
-      result =
-        result.slice(0, node.position!.start.offset) +
-        `${markdownText(node)} (\`${caption(pins, node.url!.replace(SOURCE_LINK, ""))}\`)` +
-        result.slice(node.position!.end.offset);
-
-    return result;
-  }
-
-  return rest(peeks(document));
-}

package/src/review-api/link-preview.ts

@@ -1,113 +0,0 @@
-import type { Block } from "./blocks/index.js";
-
-/** What a board link's hover card shows of the board or block it links to. */
-export interface BoardLinkPreview {
-  /** A block link: the title of the section the block is in. */
-  section?: string;
-  /** Markdown paragraphs, opening the board or block. */
-  prose?: string[];
-  /** A block link to code: its language and first lines. */
-  code?: { language: string; lines: string[] };
-  /** A block link to a diagram or other figure: its kind and title. */
-  figure?: { type: string; title: string };
-}
-
-/** About what the card shows before it fades; more is cut, not sent. */
-const PROSE_CHARACTERS = 700;
-
-const CODE_LINES = 6;
-
-function childBlocks(block: Block): Block[] {
-  return "children" in block ? block.children : [];
-}
-
-/** Paragraphs of markdown, without headings. */
-function paragraphs(markdown: string): string[] {
-  return markdown
-    .split(/\n\s*\n/)
-    .map((paragraph) => paragraph.trim())
-    .filter((paragraph) => paragraph && !paragraph.startsWith("#"));
-}
-
-/** The prose from the first markdown block on, in reading order, until the
- * card has enough. Diagrams and code before it are skipped. */
-function openingProse(blocks: Block[]): string[] {
-  const prose: string[] = [];
-  let length = 0;
-
-  const walk = (list: Block[]): boolean => {
-    for (const block of list) {
-      if (block.type === "markdown")
-        for (const paragraph of paragraphs(block.markdown)) {
-          prose.push(paragraph);
-          length += paragraph.length;
-
-          if (length >= PROSE_CHARACTERS) return true;
-        }
-      else if (walk(childBlocks(block))) return true;
-    }
-
-    return false;
-  };
-
-  walk(blocks);
-
-  return prose;
-}
-
-/** The block and the title of the section it is in. */
-function find(
-  blocks: Block[],
-  id: string,
-  section?: string,
-): { block: Block; section?: string } | undefined {
-  for (const block of blocks) {
-    if (block.id === id) return { block, section };
-
-    const found = find(
-      childBlocks(block),
-      id,
-      block.type === "section" ? block.title : section,
-    );
-
-    if (found) return found;
-  }
-
-  return undefined;
-}
-
-/** The opening prose of a board, or one block of it. */
-export function boardLinkPreview(
-  document: Block[],
-  blockId?: string,
-): BoardLinkPreview {
-  if (blockId === undefined) return { prose: openingProse(document) };
-
-  const found = find(document, blockId);
-
-  if (!found) return {};
-
-  const { block } = found;
-  // A section link is about the section itself.
-  const section = block.type === "section" ? block.title : found.section;
-
-  if (block.type === "code")
-    return {
-      ...(section && { section }),
-      code: {
-        language: block.language,
-        lines: block.text.split("\n").slice(0, CODE_LINES),
-      },
-    };
-
-  const prose = openingProse([block]);
-
-  if (prose.length) return { ...(section && { section }), prose };
-
-  const title = "title" in block ? block.title : undefined;
-
-  return {
-    ...(section && { section }),
-    figure: { type: block.type, title: title ?? "" },
-  };
-}

package/src/review-api/scratchpad-plan-upgrade.ts

@@ -1,250 +0,0 @@
-import { randomUUID } from "node:crypto";
-import { existsSync } from "node:fs";
-
-import type { JsonValue } from "@dev.fast/json";
-import { migrateStoredDocument } from "@review/stored-document-migration.js";
-
-import { type Block, sourceReferences } from "./document.js";
-import { snapshotForeignReferences } from "./foreign-references.js";
-import type { StoreUpgradeContext } from "./store-migrations.js";
-import { BOARD_REPOSITORY_ID_SQL, columnsOf } from "./store-schema.js";
-
-// The old global scratchpad becomes a plan titled "Scratchpad", history
-// kept, in the project of the repository its blocks quote most, else of the
-// repository opened last. A board quotes only its own repository, so its
-// quotes of others become snapshots.
-
-const OLD_SCRATCHPAD_ID = "scratchpad";
-
-const hasScratchpadVersions = ({ db }: StoreUpgradeContext) =>
-  Boolean(
-    db
-      .prepare("SELECT 1 FROM versions WHERE review_id=? LIMIT 1")
-      .get(OLD_SCRATCHPAD_ID),
-  );
-
-type PadSnapshot = { document: JsonValue[]; [key: string]: JsonValue };
-
-/** A pad version's snapshot with its document in today's form (old pads
- * held anchors as objects); undefined for one that won't parse. */
-function parsePadVersion(text: string): PadSnapshot | undefined {
-  try {
-    // SAFETY: versions holds snapshots validated when they were saved.
-    const snapshot = JSON.parse(text) as PadSnapshot;
-    const document = migrateStoredDocument(snapshot.document);
-
-    snapshot.document = Array.isArray(document) ? document : [];
-
-    return snapshot;
-  } catch {
-    return undefined;
-  }
-}
-
-/** Each pad version as parsed, by version, for one open. The run, inside
- * the write lock, reads the rows again: it reuses a parse only of text that
- * hasn't changed since. */
-const parsedPads = new WeakMap<
-  StoreUpgradeContext,
-  Map<number, { text: string; snapshot: PadSnapshot | undefined }>
->();
-
-function padVersion(
-  context: StoreUpgradeContext,
-  version: number,
-  text: string,
-) {
-  let parsed = parsedPads.get(context);
-
-  if (!parsed) parsedPads.set(context, (parsed = new Map()));
-  const known = parsed.get(version);
-
-  if (known?.text === text) return known.snapshot;
-
-  const snapshot = parsePadVersion(text);
-
-  parsed.set(version, { text, snapshot });
-
-  return snapshot;
-}
-
-/** The pad's versions, oldest first, each parsed once per open. */
-const scratchpadVersions = (context: StoreUpgradeContext) =>
-  context.db
-    .prepare(
-      "SELECT version,snapshot FROM versions WHERE review_id=? ORDER BY version",
-    )
-    .all(OLD_SCRATCHPAD_ID)
-    .map((row) => ({
-      version: Number(row.version),
-      snapshot: padVersion(context, Number(row.version), String(row.snapshot)),
-    }));
-
-/** The pad's newest version that parses, reading no further back. */
-function latestScratchpadDocument(context: StoreUpgradeContext) {
-  for (const row of context.db
-    .prepare(
-      "SELECT version,snapshot FROM versions WHERE review_id=? ORDER BY version DESC",
-    )
-    .iterate(OLD_SCRATCHPAD_ID)) {
-    const snapshot = padVersion(
-      context,
-      Number(row.version),
-      String(row.snapshot),
-    );
-
-    if (snapshot) return snapshot.document;
-  }
-
-  return undefined;
-}
-
-/** The checkout the pad quotes most, else the one opened last. Only a
- * checkout that still exists: a plan opens on it. */
-function scratchpadRepository(context: StoreUpgradeContext) {
-  const exists = (repositoryId: string) => {
-    try {
-      return existsSync(context.repositoryPath(repositoryId));
-    } catch {
-      return false;
-    }
-  };
-
-  const counts = new Map<string, number>();
-
-  // SAFETY: a stored pad's blocks, in today's form.
-  const latest = latestScratchpadDocument(context) as Block[] | undefined;
-
-  for (const { source } of sourceReferences(latest ?? [], {
-    tolerant: true,
-  })) {
-    const repositoryId = source.pins?.repositoryId;
-
-    if (repositoryId && exists(repositoryId))
-      counts.set(repositoryId, (counts.get(repositoryId) ?? 0) + 1);
-  }
-
-  const [quoted] = [...counts].sort((a, b) => b[1] - a[1])[0] ?? [];
-
-  if (quoted) return quoted;
-
-  const viewed = context.db
-    .prepare(
-      `SELECT ${BOARD_REPOSITORY_ID_SQL} AS repository
-      FROM review_attention
-      JOIN reviews ON reviews.id=review_attention.review_id
-      JOIN versions ON versions.review_id=reviews.id AND versions.version=reviews.version
-      WHERE review_attention.viewed_at IS NOT NULL AND repository IS NOT NULL
-      ORDER BY review_attention.viewed_at DESC`,
-    )
-    .all()
-    .map(({ repository }) => String(repository));
-
-  return [...viewed, ...context.repositories().map(({ id }) => id)].find(
-    exists,
-  );
-}
-
-const snapshots = (
-  context: StoreUpgradeContext,
-  own: string,
-  document: JsonValue[],
-  allocate: (prefix: string) => string,
-) =>
-  snapshotForeignReferences(
-    document,
-    own,
-    context.fileAtCommit,
-    context.repositoryName,
-    allocate,
-  );
-
-/** Reads the files the pad quotes, which the context keeps, before the
- * write lock other hosts on this home wait on. */
-export function readScratchpadQuotes(context: StoreUpgradeContext) {
-  if (!hasScratchpadVersions(context)) return;
-
-  const quoting = scratchpadRepository(context);
-
-  if (quoting)
-    for (const { snapshot } of scratchpadVersions(context))
-      if (snapshot)
-        snapshots(context, quoting, snapshot.document, (prefix) => prefix);
-}
-
-export function planFromScratchpad(context: StoreUpgradeContext) {
-  const { db } = context;
-
-  // A pad row with no versions has nothing to keep; it stays as it is.
-  if (!hasScratchpadVersions(context)) return;
-
-  const own = scratchpadRepository(context);
-  const id = randomUUID();
-
-  db.prepare(
-    "INSERT INTO reviews(id,version,next_id,project_id) SELECT ?,version,next_id,? FROM reviews WHERE id=?",
-  ).run(
-    id,
-    own ? context.projectOfRepository(own) : context.fallbackProject(),
-    OLD_SCRATCHPAD_ID,
-  );
-
-  let nextId = Number(
-    db.prepare("SELECT next_id FROM reviews WHERE id=?").get(id)!.next_id,
-  );
-
-  const old = scratchpadVersions(context);
-
-  // The run changes the snapshots it took; nothing parses them again.
-  parsedPads.delete(context);
-
-  // Every version moves over; one that no longer parses, as it is.
-  db.prepare("UPDATE versions SET review_id=? WHERE review_id=?").run(
-    id,
-    OLD_SCRATCHPAD_ID,
-  );
-
-  for (const { version, snapshot } of old) {
-    if (!snapshot) continue;
-
-    delete snapshot.kind;
-
-    snapshot.reviewId = id;
-    snapshot.title = "Scratchpad";
-
-    if (own) {
-      snapshot.target = { kind: "project", repositoryId: own };
-      snapshot.document = snapshots(
-        context,
-        own,
-        snapshot.document,
-        (prefix) => `${prefix}-${++nextId}`,
-      );
-    }
-
-    context.rewriteVersion(id, version, snapshot);
-  }
-
-  db.prepare("UPDATE reviews SET next_id=? WHERE id=?").run(nextId, id);
-
-  // Tables a store makes after its upgrades may not exist yet. A thread's
-  // board is its review_id until ask-threads-by-project renames it, which
-  // a development build may have done already.
-  for (const [table, ...names] of [
-    ["ask_conversations", "review_id", "anchor_board"],
-    ["authoring_presences", "review_id"],
-    ["review_coverage", "review_id"],
-    ["review_attention", "review_id"],
-  ]) {
-    const columns = columnsOf(db, table!);
-    const column = names.find((name) => columns.has(name));
-
-    if (column)
-      db.prepare(`UPDATE ${table} SET ${column}=? WHERE ${column}=?`).run(
-        id,
-        OLD_SCRATCHPAD_ID,
-      );
-  }
-
-  db.prepare("DELETE FROM reviews WHERE id=?").run(OLD_SCRATCHPAD_ID);
-}