bstack 0.0.0 → 0.1.0

package/src/identity.ts

@@ -1,88 +0,0 @@
-import { randomUUID } from "node:crypto";
-import type { Commit } from "./model";
-
-const trailerPattern = /^Bstack-Id:\s*(\S+)\s*$/gim;
-
-export function readChangeId(message: string): string | undefined {
-  const matches = [...message.matchAll(trailerPattern)];
-  if (matches.length > 1) {
-    throw new Error("A commit contains more than one Bstack-Id trailer");
-  }
-  return matches[0]?.[1];
-}
-
-export function addChangeId(message: string, changeId: string): string {
-  const trimmed = message.trimEnd();
-  return `${trimmed}\n\nBstack-Id: ${changeId}\n`;
-}
-
-export function newChangeId(): string {
-  return randomUUID().replaceAll("-", "");
-}
-
-export function parseRawCommit(oid: string, raw: string): Commit {
-  const boundary = raw.indexOf("\n\n");
-  if (boundary === -1) {
-    throw new Error(`Commit ${oid} has an invalid object format`);
-  }
-
-  const headers = raw.slice(0, boundary).split("\n");
-  const treeLine = headers.find((line) => line.startsWith("tree "));
-  const parents = headers.filter((line) => line.startsWith("parent "));
-  if (!treeLine || parents.length !== 1) {
-    throw new Error(
-      `Commit ${oid} must have exactly one parent; merge and root commits are not supported`,
-    );
-  }
-  if (headers.some((line) => line.startsWith("gpgsig "))) {
-    throw new Error(
-      `Commit ${oid} is signed. bstack cannot add an identity trailer without replacing its signature`,
-    );
-  }
-
-  const message = raw.slice(boundary + 2);
-  return {
-    oid,
-    tree: treeLine.slice("tree ".length),
-    parent: parents[0]!.slice("parent ".length),
-    message,
-    headers,
-    changeId: readChangeId(message),
-  };
-}
-
-export function rewriteCommit(
-  commit: Commit,
-  parent: string,
-  message: string,
-): string {
-  const rewrittenHeaders: string[] = [];
-  let replacedParent = false;
-
-  for (const header of commit.headers) {
-    if (header.startsWith("parent ")) {
-      if (!replacedParent) {
-        rewrittenHeaders.push(`parent ${parent}`);
-        replacedParent = true;
-      }
-      continue;
-    }
-    rewrittenHeaders.push(header);
-  }
-
-  return `${rewrittenHeaders.join("\n")}\n\n${message}`;
-}
-
-export function splitCommitMessage(message: string): {
-  subject: string;
-  body: string;
-} {
-  const withoutIdentity = message
-    .split("\n")
-    .filter((line) => !/^Bstack-Id:\s*\S+\s*$/i.test(line))
-    .join("\n")
-    .trim();
-  const [subject = "Untitled change", ...bodyLines] =
-    withoutIdentity.split("\n");
-  return { subject, body: bodyLines.join("\n").trim() };
-}

package/src/model.ts

@@ -1,44 +0,0 @@
-export type Commit = {
-  oid: string;
-  tree: string;
-  parent: string;
-  message: string;
-  headers: readonly string[];
-  changeId: string | undefined;
-};
-
-export type Change = {
-  id: string;
-  oid: string;
-  subject: string;
-  body: string;
-  remoteBranch: string;
-};
-
-export type PullRequest = {
-  number: number;
-  url: string;
-  state: "OPEN" | "CLOSED" | "MERGED";
-  title: string;
-  body: string;
-  isDraft: boolean;
-};
-
-export type StoredChange = {
-  id: string;
-  remoteBranch: string;
-  pullRequest: number;
-  url: string;
-};
-
-export type StoredStack = {
-  remote: string;
-  base: string;
-  stackNumber?: number;
-  changes: StoredChange[];
-};
-
-export type BstackState = {
-  schemaVersion: 1;
-  stacks: StoredStack[];
-};

package/src/reporter.ts

@@ -1,11 +0,0 @@
-export interface Reporter {
-  progress(message: string): void;
-}
-
-export class ConsoleReporter implements Reporter {
-  constructor(private readonly enabled = true) {}
-
-  progress(message: string): void {
-    if (this.enabled) process.stderr.write(`[bstack] ${message}\n`);
-  }
-}

package/src/state.ts

@@ -1,52 +0,0 @@
-import { mkdirSync, readFileSync, renameSync, writeFileSync } from "node:fs";
-import { dirname } from "node:path";
-import type { BstackState, StoredStack } from "./model";
-
-const emptyState = (): BstackState => ({ schemaVersion: 1, stacks: [] });
-
-export class StateStore {
-  constructor(private readonly path: string) {}
-
-  read(): BstackState {
-    try {
-      const parsed = JSON.parse(readFileSync(this.path, "utf8")) as unknown;
-      if (!isState(parsed))
-        throw new Error(`Unsupported bstack state in ${this.path}`);
-      return parsed;
-    } catch (error) {
-      if (isMissingFile(error)) return emptyState();
-      throw error;
-    }
-  }
-
-  write(state: BstackState): void {
-    mkdirSync(dirname(this.path), { recursive: true });
-    const temporary = `${this.path}.tmp`;
-    writeFileSync(temporary, `${JSON.stringify(state, null, 2)}\n`);
-    renameSync(temporary, this.path);
-  }
-
-  findByChangeIds(
-    state: BstackState,
-    ids: ReadonlySet<string>,
-  ): StoredStack | undefined {
-    const matches = state.stacks.filter((stack) =>
-      stack.changes.some((change) => ids.has(change.id)),
-    );
-    if (matches.length > 1)
-      throw new Error(
-        "The current commits match more than one stored bstack stack",
-      );
-    return matches[0];
-  }
-}
-
-function isMissingFile(error: unknown): boolean {
-  return error instanceof Error && "code" in error && error.code === "ENOENT";
-}
-
-function isState(value: unknown): value is BstackState {
-  if (typeof value !== "object" || value === null) return false;
-  const candidate = value as { schemaVersion?: unknown; stacks?: unknown };
-  return candidate.schemaVersion === 1 && Array.isArray(candidate.stacks);
-}

package/src/sync.ts

@@ -1,251 +0,0 @@
-import type { GitRepository } from "./git";
-import type { GitHubPlatform } from "./github";
-import type { BstackState, Change, PullRequest, StoredStack } from "./model";
-import type { Reporter } from "./reporter";
-import { StateStore } from "./state";
-
-export type SyncOptions = {
-  base: string | undefined;
-  remote: string | undefined;
-  open: boolean;
-  dryRun: boolean;
-  reporter: Reporter;
-};
-
-export type SyncResult = {
-  base: string;
-  remote: string;
-  rewritten: boolean;
-  changes: Array<Change & { pullRequest?: PullRequest }>;
-};
-
-export function syncStack(
-  repository: GitRepository,
-  github: GitHubPlatform,
-  options: SyncOptions,
-): SyncResult {
-  const { reporter } = options;
-  reporter.progress("Checking the repository and GitHub prerequisites");
-  repository.assertReady();
-  github.assertReady();
-  const remote = repository.resolveRemote(options.remote);
-  const base = options.base ?? github.defaultBranch();
-  reporter.progress(
-    `Using ${remote} as the remote and ${base} as the stack base`,
-  );
-  reporter.progress(`Fetching ${remote}/${base}`);
-  const remoteBase = repository.fetchBase(remote, base);
-  const baseOid = repository.mergeBase("HEAD", remoteBase);
-  const commits = repository.commitsSince(baseOid);
-  if (commits.length === 0)
-    throw new Error(`No commits found between ${base} and HEAD`);
-  reporter.progress(
-    `Found ${commits.length} local change${commits.length === 1 ? "" : "s"}`,
-  );
-
-  const rewritten = commits.some((commit) => commit.changeId === undefined);
-  if (rewritten) {
-    reporter.progress(
-      options.dryRun
-        ? "Stable change IDs would be added to the commits"
-        : "Adding stable change IDs to the commits",
-    );
-  } else {
-    reporter.progress("All commits already have stable change IDs");
-  }
-  const changes = repository.ensureChangeIds(commits, options.dryRun);
-  if (options.dryRun) {
-    reporter.progress(
-      "Dry run complete; no commits or remote branches were changed",
-    );
-    return { base, remote, rewritten, changes };
-  }
-
-  reporter.progress("Reading the previous stack state");
-  const store = new StateStore(repository.statePath());
-  const state = store.read();
-  const previous = store.findByChangeIds(
-    state,
-    new Set(changes.map((change) => change.id)),
-  );
-  const evolution = analyzeEvolution(previous, changes, github);
-
-  reporter.progress(
-    `Publishing ${changes.length} protected remote ref${changes.length === 1 ? "" : "s"}`,
-  );
-  repository.pushChanges(remote, changes);
-
-  reporter.progress("Looking up existing pull requests");
-  const existing = changes.map((change) =>
-    github.pullRequestForBranch(change.remoteBranch),
-  );
-  let pullRequests: PullRequest[];
-  if (changes.length === 1) {
-    if (evolution.kind === "partial") {
-      reporter.progress(
-        "Updating this down-stack prefix while preserving higher pull requests",
-      );
-    }
-    reporter.progress(
-      existing[0]
-        ? "Using the existing pull request"
-        : "Creating a pull request",
-    );
-    pullRequests = [
-      existing[0] ?? github.createPullRequest(changes[0]!, base, options.open),
-    ];
-  } else {
-    if (evolution.kind === "full") {
-      reporter.progress(
-        `Linking ${changes.length} pull requests as a native GitHub stack`,
-      );
-      github.linkStack(
-        changes.map((change) => change.remoteBranch),
-        base,
-        remote,
-        options.open,
-      );
-    } else if (evolution.kind === "append") {
-      reporter.progress(
-        `Appending ${evolution.branches.length} pull request${evolution.branches.length === 1 ? "" : "s"} to stack #${evolution.stackNumber}`,
-      );
-      github.appendToStack(
-        evolution.stackNumber,
-        evolution.branches,
-        remote,
-        options.open,
-      );
-    } else if (evolution.kind === "partial") {
-      reporter.progress(
-        "Updating this down-stack prefix while preserving higher pull requests",
-      );
-    } else {
-      reporter.progress(
-        "The native GitHub stack already has the correct members",
-      );
-    }
-    pullRequests = changes.map((change, index) => {
-      const pr =
-        existing[index] ?? github.pullRequestForBranch(change.remoteBranch);
-      if (!pr)
-        throw new Error(
-          `GitHub did not return a PR for ${change.remoteBranch}`,
-        );
-      return pr;
-    });
-  }
-
-  reporter.progress("Synchronizing pull request titles and descriptions");
-  for (const [index, pr] of pullRequests.entries()) {
-    github.editPullRequest(pr, changes[index]!);
-    reporter.progress(`PR #${pr.number}: ${changes[index]!.subject}`);
-  }
-
-  const stackNumber =
-    previous?.stackNumber ??
-    (pullRequests.length > 1
-      ? github.stackNumberForPullRequest(pullRequests[0]!.number)
-      : undefined);
-  const synchronizedChanges = changes.map((change, index) => ({
-    id: change.id,
-    remoteBranch: change.remoteBranch,
-    pullRequest: pullRequests[index]!.number,
-    url: pullRequests[index]!.url,
-  }));
-  const storedChanges =
-    evolution.kind === "partial" && previous
-      ? [
-          ...synchronizedChanges,
-          ...previous.changes.slice(evolution.previousOffset + changes.length),
-        ]
-      : synchronizedChanges;
-  const stored: StoredStack = {
-    remote,
-    base,
-    ...(stackNumber === undefined ? {} : { stackNumber }),
-    changes: storedChanges,
-  };
-  writeUpdatedState(store, state, previous, stored);
-  reporter.progress("Saved the local stack state");
-
-  return {
-    base,
-    remote,
-    rewritten,
-    changes: changes.map((change, index) => ({
-      ...change,
-      pullRequest: pullRequests[index]!,
-    })),
-  };
-}
-
-type Evolution =
-  | { kind: "full" }
-  | { kind: "skip" }
-  | { kind: "partial"; previousOffset: number }
-  | { kind: "append"; stackNumber: number; branches: string[] };
-
-function analyzeEvolution(
-  previous: StoredStack | undefined,
-  changes: readonly Change[],
-  github: GitHubPlatform,
-): Evolution {
-  if (!previous) return { kind: "full" };
-  const previousIds = previous.changes.map((change) => change.id);
-  const currentIds = changes.map((change) => change.id);
-
-  const firstCurrentIndex = previousIds.indexOf(currentIds[0]!);
-  if (firstCurrentIndex === -1) {
-    throw new Error(
-      "The current commits do not continue the previously submitted stack",
-    );
-  }
-
-  const removedPrefix = previous.changes.slice(0, firstCurrentIndex);
-  for (const removed of removedPrefix) {
-    if (github.pullRequest(removed.pullRequest).state !== "MERGED") {
-      throw new Error(
-        "Submitted commits may only disappear from the bottom after their pull requests are merged",
-      );
-    }
-  }
-
-  const surviving = previousIds.slice(firstCurrentIndex);
-  const sharedLength = Math.min(surviving.length, currentIds.length);
-  for (let index = 0; index < sharedLength; index++) {
-    if (surviving[index] !== currentIds[index]) {
-      throw new Error(
-        "Reordering or removing submitted commits is not supported yet. Restore the original order before syncing",
-      );
-    }
-  }
-  if (currentIds.length < surviving.length) {
-    return { kind: "partial", previousOffset: firstCurrentIndex };
-  }
-
-  const appended = changes.slice(surviving.length);
-  if (removedPrefix.length === 0) return { kind: "full" };
-  if (appended.length === 0) return { kind: "skip" };
-  if (previous.stackNumber === undefined) {
-    throw new Error(
-      "Cannot append after a merge because the native GitHub stack number is missing from local state",
-    );
-  }
-  return {
-    kind: "append",
-    stackNumber: previous.stackNumber,
-    branches: appended.map((change) => change.remoteBranch),
-  };
-}
-
-function writeUpdatedState(
-  store: StateStore,
-  state: BstackState,
-  previous: StoredStack | undefined,
-  updated: StoredStack,
-): void {
-  const stacks = previous
-    ? state.stacks.map((stack) => (stack === previous ? updated : stack))
-    : [...state.stacks, updated];
-  store.write({ schemaVersion: 1, stacks });
-}