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

package/src/sharing/export.ts

@@ -14,11 +14,10 @@ import { lensSelections } from "@review/review-api/diff-lenses.js";
 import { ReviewInputError } from "@review/review-api/document.js";
 import {
   anchorPins,
-  boardRepositoryId,
   checkReferences,
   documentSchema,
   elements,
-  readsAtBoardPins,
+  hasCodeReferences,
   resourceReference,
   resourceReferences,
   sourceReferences,
@@ -47,33 +46,13 @@ export function digestBytes(bytes: Uint8Array): string {
 export function validateShareSources(
   snapshot: Pick<Snapshot, "pins" | "document" | "lenses">,
 ) {
-  if (!snapshot.pins && readsAtBoardPins(snapshot))
+  if (!snapshot.pins && hasCodeReferences(snapshot))
     throw new ReviewInputError(
       "Reviews with code references need source pins before sharing.",
       409,
     );
 }
 
-/** The commits a board's references read at besides its base and head. A
- * recipient fetches them too. A shared board names no repository of its
- * own, so one stands in for its commit links. */
-export function referenceCommits(
-  snapshot: Pick<Snapshot, "pins" | "document" | "target">,
-  repositoryId = boardRepositoryId(snapshot) ?? "shared",
-): string[] {
-  const own = new Set([snapshot.pins?.base, snapshot.pins?.head]);
-  const commits = new Set<string>();
-
-  for (const { source } of sourceReferences(snapshot.document, {
-    tolerant: true,
-    repositoryId,
-  }))
-    for (const commit of [source.pins?.base, source.pins?.head])
-      if (commit && !own.has(commit)) commits.add(commit);
-
-  return [...commits].sort();
-}
-
 /** Freeze one stored version before any asynchronous source reads. */
 export async function exportShare(input: {
   store: ShareExportStore;
@@ -82,24 +61,16 @@ export async function exportShare(input: {
   version?: number;
   repository?: ShareManifest["repository"];
 }): Promise<ShareBundle> {
-  const stored = structuredClone(
-    input.store.read(input.reviewId, input.version),
-  );
-
-  // Commit links read from the board's repository, which a plan names only
-  // in its target.
-  const repositoryId = boardRepositoryId(stored);
-
-  // Local-only fields stay home; the target names a local checkout.
+  // A share is the finished document: what edit last touched it stays home.
   const {
     target,
+    kind: _kind,
     staleSources: _staleSources,
     sourceUnavailable: _sourceUnavailable,
     lastEdit: _lastEdit,
     trashedAt: _trashedAt,
-    personEdit: _personEdit,
     ...snapshot
-  } = stored;
+  } = structuredClone(input.store.read(input.reviewId, input.version));
 
   if (target?.kind === "worktree")
     throw new ReviewInputError("Pin this review to commits before sharing it.");
@@ -131,7 +102,7 @@ export async function exportShare(input: {
 
   // Lens ranges travel with the snapshot and must resolve at its pins too.
   const sources = [
-    ...sourceReferences(snapshot.document, { repositoryId }),
+    ...sourceReferences(snapshot.document),
     ...lensSelections(snapshot.lenses ?? []).flatMap((selection) =>
       sourceAnchors(selection.source).map((source) => ({
         ...selection,
@@ -145,7 +116,7 @@ export async function exportShare(input: {
 
   validateShareSources(snapshot);
 
-  if ((pins || referenceCommits(stored).length) && !input.repository)
+  if (Boolean(pins) !== Boolean(input.repository))
     throw new ReviewInputError("Shared source pins require a repository.", 409);
 
   for (const block of elements(snapshot.document)) {

package/src/sharing/host.ts

@@ -5,7 +5,7 @@ import { parseShareLink, shareIdSchema } from "@dev.fast/review-share-protocol";
 import {
   DEFAULT_STORE_ORIGIN,
   clearStoreAuth,
-  type openUrlInBrowser,
+  openUrlInBrowser,
   readStoreAuth,
   runStoreLogin,
 } from "@dev.fast/trace-core";
@@ -18,18 +18,13 @@ import { z } from "zod";
 
 import { readSharingAuth } from "./auth.js";
 import { ShareAuthError, ShareClient, SharePreflightError } from "./client.js";
-import {
-  exportShare,
-  referenceCommits,
-  validateShareSources,
-} from "./export.js";
+import { exportShare, validateShareSources } from "./export.js";
 import { SharedReviewStore, sharedReviewId } from "./import.js";
 import { readShareRepository, verifyShareRepository } from "./repository.js";
 
 interface LoginState {
   pending: boolean;
   url?: string;
-  userCode?: string;
   error?: string;
 }
 
@@ -66,6 +61,7 @@ export function mountSharingHost(
   options: SharingHostOptions = {},
 ) {
   const startLogin = options.login ?? runStoreLogin;
+  const openUrl = options.openUrl ?? openUrlInBrowser;
 
   let login: LoginState = {
     pending: false,
@@ -96,9 +92,9 @@ export function mountSharingHost(
         traces: false,
         stdout: discard,
         stderr: discard,
-        openUrl: options.openUrl,
-        onDeviceCode: (device) => {
-          Object.assign(login, device);
+        openUrl: async (url) => {
+          login.url = url;
+          await openUrl(url);
         },
       })
         .then((code) => {
@@ -227,26 +223,13 @@ export function mountSharingPublisher(
         409,
       );
 
-    const repositoryId =
-      snapshot.pins?.repositoryId ?? snapshot.target?.repositoryId;
-
-    const root = repositoryId ? store.repositoryPath(repositoryId) : undefined;
+    const root = snapshot.pins
+      ? store.repositoryPath(snapshot.pins.repositoryId)
+      : undefined;
 
-    const readRepository = options.readRepository ?? readShareRepository;
-
-    // Unpinned boards name their repository when they can, so receivers can
-    // group them.
-    const repository = !root
-      ? undefined
-      : snapshot.pins
-        ? await readRepository(root)
-        : await (async () => {
-            try {
-              return await readRepository(root);
-            } catch {
-              return undefined;
-            }
-          })();
+    const repository = root
+      ? await (options.readRepository ?? readShareRepository)(root)
+      : undefined;
 
     const bundle = await exportShare({
       store,
@@ -256,12 +239,9 @@ export function mountSharingPublisher(
       repository,
     });
 
-    const commits = referenceCommits(snapshot);
-
-    // The commits must be on GitHub for a recipient to fetch them.
     const verification =
-      root && (snapshot.pins || commits.length) && repository
-        ? verifyRepository(root, snapshot.pins, repository, commits).then(
+      root && snapshot.pins && repository
+        ? verifyRepository(root, snapshot.pins, repository).then(
             () => ({ ok: true as const }),
             (error: Error) => ({ ok: false as const, error }),
           )

package/src/sharing/import.ts

@@ -28,9 +28,6 @@ import { textIncludesQuote } from "@review/evidence.js";
 import { lensSchema } from "@review/review-api/diff-lenses.js";
 import { ReviewInputError } from "@review/review-api/document.js";
 import {
-  type FileLineRange,
-  type Pins,
-  anchorPins,
   checkReferences,
   documentSchema,
   pinsSchema,
@@ -55,16 +52,10 @@ import { z } from "zod";
 import {
   type ShareBundle,
   digestBytes,
-  referenceCommits,
   validateShareSources,
 } from "./export.js";
 import {
-  COMMIT_ID,
-  assertCommitIds,
-  cloneSharedRepository,
   fetchPinnedRepository,
-  fetchSharedCommits,
-  forgetSharedCommits,
   repositoryReady,
   sharedGit,
 } from "./repository.js";
@@ -72,12 +63,11 @@ import {
 export const sharedSnapshotSchema = z.strictObject({
   reviewId: z.string().min(1),
   version: z.number().int().nonnegative(),
-  /** Empty for a board never named; it reads "Untitled". */
-  title: z.string(),
+  title: z.string().min(1),
   pins: pinsSchema
     .extend({
-      base: z.string().regex(COMMIT_ID),
-      head: z.string().regex(COMMIT_ID),
+      base: z.string().regex(/^(?:[a-f0-9]{40}|[a-f0-9]{64})$/),
+      head: z.string().regex(/^(?:[a-f0-9]{40}|[a-f0-9]{64})$/),
     })
     .optional(),
   document: documentSchema,
@@ -100,7 +90,7 @@ const count = z.number().int().nonnegative();
 const counts = z.strictObject({ additions: count, deletions: count });
 
 const mapSchema = z.strictObject({
-  commit: z.string().regex(COMMIT_ID),
+  commit: z.string(),
   side: z.enum(["base", "head"]),
   elements: z.array(normalizedSoftwareElementSchema),
   relationships: z.array(normalizedSoftwareRelationshipSchema),
@@ -176,10 +166,8 @@ export function validateShareBundle(bundle: ShareBundle) {
     throw new Error("Shared snapshot does not match its manifest.");
   checkReferences(snapshot.document);
   validateShareSources(snapshot);
-  // Every commit it quotes reaches git as an argument.
-  assertCommitIds(referenceCommits(snapshot));
 
-  if (snapshot.pins && !manifest.repository)
+  if (Boolean(snapshot.pins) !== Boolean(manifest.repository))
     throw new Error("Shared source pins require a repository.");
 
   const presentation = sharePresentationSchema.parse(
@@ -297,7 +285,6 @@ export class SharedReviewStore {
   constructor(
     readonly root: string,
     private readonly fetchRepository = fetchPinnedRepository,
-    private readonly cloneRepository = cloneSharedRepository,
   ) {
     this.purgeTimer = setInterval(() => {
       void this.purgeExpired().catch((error) =>
@@ -385,7 +372,7 @@ export class SharedReviewStore {
       throw new ReviewInputError("Shared review is not available.", 404);
 
     if (!saved.snapshot.pins) {
-      await this.prepareUnpinned(id, saved.manifest.repository?.cloneUrl);
+      this.setStatus(id, "ready");
 
       return;
     }
@@ -394,12 +381,10 @@ export class SharedReviewStore {
       throw new ReviewInputError("Repository service is unavailable.", 409);
     const root = this.repositoryRoot(id);
 
-    const commits = referenceCommits(saved.snapshot);
-
     try {
       this.setStatus(id, "fetching");
 
-      if (!(await repositoryReady(root, saved.snapshot.pins, commits))) {
+      if (!(await repositoryReady(root, saved.snapshot.pins))) {
         const prior = this.repositories.get(id);
         await local.data.workspaces.remove(id);
 
@@ -409,13 +394,11 @@ export class SharedReviewStore {
           root,
           saved.manifest.repository!.cloneUrl,
           saved.snapshot.pins,
-          false,
-          commits,
         );
         await sharedGit(root, [
           "checkout",
           "--detach",
-          { commit: saved.snapshot.pins.head },
+          saved.snapshot.pins.head,
         ]);
       }
 
@@ -430,7 +413,16 @@ export class SharedReviewStore {
       this.setStatus(id, "validating");
       await local.data.validatePins(pins);
 
-      await this.validateReferences(saved, repository.id, pins);
+      const references = sourceReferences(saved.snapshot.document).map(
+        (item) => item.source,
+      );
+
+      for (const map of Object.values(saved.presentation.maps))
+        for (const element of map.elements)
+          for (const range of element.sourceRanges ?? [])
+            references.push({ ...range, side: map.side });
+
+      await local.data.validateSources(pins, references);
       await local.data.workspaces.open(id, pins);
 
       if (
@@ -457,114 +449,13 @@ export class SharedReviewStore {
     }
   }
 
-  /** Reads each of a shared board's references at its own commits, in the
-   * checkout of its repository. */
-  private async validateReferences(
-    saved: ReturnType<typeof validateShareBundle>,
-    repositoryId: string,
-    pins?: Pins,
-  ) {
-    const references = new Map<
-      string,
-      { pins: Pins; ranges: FileLineRange[] }
-    >();
-
-    const add = (at: Pins, range: FileLineRange) => {
-      const key = JSON.stringify([at.base, at.head]);
-      const group = references.get(key) ?? { pins: at, ranges: [] };
-
-      group.ranges.push(range);
-      references.set(key, group);
-    };
-
-    for (const { source } of sourceReferences(saved.snapshot.document, {
-      repositoryId,
-    }))
-      add({ ...anchorPins(source, pins), repositoryId }, source);
-
-    if (pins)
-      for (const map of Object.values(saved.presentation.maps))
-        for (const element of map.elements)
-          for (const range of element.sourceRanges ?? [])
-            add(pins, { ...range, side: map.side });
-
-    for (const group of references.values())
-      await this.local!.data.validateSources(group.pins, group.ranges);
-  }
-
-  /** Files an unpinned board under a local checkout of its repository,
-   * else a managed clone. */
-  private async prepareUnpinned(id: string, cloneUrl: string | undefined) {
-    const local = this.local;
-    const saved = this.validated.get(id)!;
-
-    if (!cloneUrl || !local) {
-      this.setStatus(id, "ready");
-
-      return;
-    }
-
-    const root = this.repositoryRoot(id);
-
-    try {
-      this.setStatus(id, "fetching");
-      const managed = path.join(await realpath(this.root), ".repositories");
-
-      let repositoryId = local.store
-        .checkoutsOf(cloneUrl)
-        .find(
-          (checkout) =>
-            !local.store.repositoryPath(checkout).startsWith(managed),
-        );
-
-      if (!repositoryId) {
-        if (!existsSync(path.join(root, ".git"))) {
-          await rm(root, { recursive: true, force: true });
-          await this.cloneRepository(root, cloneUrl);
-        }
-
-        repositoryId = (await local.data.register(root)).id;
-      }
-
-      // A plan's commit links read at commits the checkout may not have.
-      const checkout = local.store.repositoryPath(repositoryId);
-
-      await fetchSharedCommits(
-        checkout,
-        referenceCommits(saved.snapshot, repositoryId),
-        id,
-      );
-      this.setStatus(id, "validating");
-      await this.validateReferences(saved, repositoryId);
-      this.repositories.set(id, repositoryId);
-      await writeFile(
-        path.join(this.root, id, "repository.json"),
-        JSON.stringify({ repositoryId, ready: true }),
-        { mode: 0o600 },
-      );
-      this.setStatus(id, "ready");
-    } catch (error) {
-      const message =
-        error instanceof ReviewInputError
-          ? error.message
-          : "Could not prepare the shared repository. Check Git credentials and retry.";
-
-      this.setStatus(id, "error", message);
-      throw new ReviewInputError(message, 409);
-    }
-  }
-
   async assertReady(id: string) {
     const saved = this.validated.get(id);
 
     if (
       !saved ||
       (saved.snapshot.pins &&
-        !(await repositoryReady(
-          this.repositoryRoot(id),
-          saved.snapshot.pins,
-          referenceCommits(saved.snapshot),
-        )))
+        !(await repositoryReady(this.repositoryRoot(id), saved.snapshot.pins)))
     ) {
       this.setStatus(
         id,
@@ -626,14 +517,9 @@ export class SharedReviewStore {
             ),
           );
 
-        // A board with no pins may use the receiver's own checkout.
         if (
           this.local?.store.repositoryPath(metadata.repositoryId) ===
-            path.join(await realpath(this.root), ".repositories", id) ||
-          (!validated.snapshot.pins &&
-            this.local?.store
-              .repositories()
-              .some((repository) => repository.id === metadata.repositoryId))
+          path.join(await realpath(this.root), ".repositories", id)
         ) {
           this.repositories.set(id, metadata.repositoryId);
           prepared = metadata.ready;
@@ -642,17 +528,13 @@ export class SharedReviewStore {
         /* A first or interrupted import has no local registration yet. */
       }
 
-      if (!validated.snapshot.pins) {
-        if (this.repositories.has(id) || !validated.manifest.repository)
-          this.setStatus(id, "ready");
-        else void this.prepare(id).catch(() => {});
-      } else if (
+      if (!validated.snapshot.pins) this.setStatus(id, "ready");
+      else if (
         prepared &&
         this.local &&
         (await repositoryReady(
           this.repositoryRoot(id),
           validated.snapshot.pins,
-          referenceCommits(validated.snapshot),
         ))
       ) {
         const repository = await this.local.data.register(
@@ -755,9 +637,7 @@ export class SharedReviewStore {
               ...validated.snapshot.pins,
               repositoryId: repositoryId!,
             }
-          : repositoryId
-            ? { kind: "project" as const, repositoryId }
-            : undefined,
+          : undefined,
         shared: {
           ...bundle.attribution,
           cloneUrl: bundle.manifest.repository?.cloneUrl,
@@ -778,16 +658,11 @@ export class SharedReviewStore {
       .map((id) => {
         const { document: _document, ...snapshot } = this.get(id).snapshot;
 
-        const project = snapshot.target
-          ? this.local?.store.checkoutProject(snapshot.target.repositoryId)
-          : undefined;
-
         return {
           ...snapshot,
           firstCreatedAt:
             snapshot.version === 0 ? snapshot.createdAt : undefined,
           repositoryName: "Shared review",
-          ...(project && { project }),
           viewedAt: this.attention.get(id)?.viewedAt ?? null,
           trashedAt: this.attention.get(id)?.trashedAt ?? null,
         };
@@ -825,15 +700,8 @@ export class SharedReviewStore {
     const repositoryId = this.repositories.get(id);
 
     if (repositoryId) {
-      const checkout = this.local?.store.repositoryPath(repositoryId);
-
-      // The commits kept for its links go with it.
-      if (checkout)
-        await forgetSharedCommits(checkout, id).catch((error) =>
-          console.error(`Could not drop the refs kept for share ${id}:`, error),
-        );
       await this.local?.data.forgetRepository(repositoryId);
-      await this.local?.store.unregisterRepository(repositoryId);
+      this.local?.store.unregisterRepository(repositoryId);
     }
 
     await rm(this.repositoryRoot(id), { recursive: true, force: true });