Merge pull request #13144 from gitbutlerapp/push-yxrrsmornyko

Lite: add ability to delete (discard) commits

Author: OliverJAsh

apps/lite/electron/src/ipc.ts

@@ -16,6 +16,7 @@ import type {
 	TreeChange,
 	TreeChanges,
 	UICommitCreateResult,
+	UICommitDiscardResult,
 	UICommitInsertBlankResult,
 	UICommitMoveResult,
 	UICommitRewordResult,
@@ -84,6 +85,11 @@ export interface CommitCreateParams {
 	message: string;
 }
 
+export interface CommitDiscardParams {
+	projectId: string;
+	subjectCommitId: string;
+}
+
 export interface CommitMoveChangesBetweenParams {
 	projectId: string;
 	sourceCommitId: string;
@@ -166,6 +172,7 @@ export interface LiteElectronApi {
 	changesInWorktree: (projectId: string) => Promise<WorktreeChanges>;
 	commitAmend: (params: CommitAmendParams) => Promise<UICommitCreateResult>;
 	commitCreate: (params: CommitCreateParams) => Promise<UICommitCreateResult>;
+	commitDiscard: (params: CommitDiscardParams) => Promise<UICommitDiscardResult>;
 	commitDetailsWithLineStats: (params: CommitDetailsWithLineStatsParams) => Promise<CommitDetails>;
 	commitInsertBlank: (params: CommitInsertBlankParams) => Promise<UICommitInsertBlankResult>;
 	commitMove: (params: CommitMoveParams) => Promise<UICommitMoveResult>;
@@ -203,6 +210,7 @@ export const liteIpcChannels = {
 	changesInWorktree: "workspace:changes-in-worktree",
 	commitAmend: "workspace:commit-amend",
 	commitCreate: "workspace:commit-create",
+	commitDiscard: "workspace:commit-discard",
 	commitDetailsWithLineStats: "workspace:commit-details-with-line-stats",
 	commitInsertBlank: "workspace:commit-insert-blank",
 	commitMove: "workspace:commit-move",

apps/lite/electron/src/main.ts

@@ -8,6 +8,7 @@ import {
 	type BranchDiffParams,
 	type CommitAmendParams,
 	type CommitCreateParams,
+	type CommitDiscardParams,
 	type CommitDetailsWithLineStatsParams,
 	type CommitInsertBlankParams,
 	type CommitMoveParams,
@@ -34,6 +35,7 @@ import {
 	changesInWorktree,
 	commitAmend,
 	commitCreate,
+	commitDiscard,
 	commitInsertBlank,
 	commitReword,
 	commitUncommitChanges,
@@ -94,6 +96,11 @@ function registerIpcHandlers(): void {
 		(_e, { projectId, relativeTo, side, changes, message }: CommitCreateParams) =>
 			commitCreate(projectId, relativeTo, side, changes, message),
 	);
+	ipcMain.handle(
+		liteIpcChannels.commitDiscard,
+		(_e, { projectId, subjectCommitId }: CommitDiscardParams) =>
+			commitDiscard(projectId, subjectCommitId),
+	);
 	ipcMain.handle(
 		liteIpcChannels.commitDetailsWithLineStats,
 		(_e, { projectId, commitId }: CommitDetailsWithLineStatsParams) =>

apps/lite/electron/src/preload.cts

@@ -11,6 +11,7 @@ import type {
 	RefInfo,
 	TreeChanges,
 	UICommitCreateResult,
+	UICommitDiscardResult,
 	UICommitInsertBlankResult,
 	UICommitMoveResult,
 	UICommitRewordResult,
@@ -51,6 +52,8 @@ const api: LiteElectronApi = {
 		ipcRenderer.invoke("workspace:commit-amend", params) as Promise<UICommitCreateResult>,
 	commitCreate: (params) =>
 		ipcRenderer.invoke("workspace:commit-create", params) as Promise<UICommitCreateResult>,
+	commitDiscard: (params) =>
+		ipcRenderer.invoke("workspace:commit-discard", params) as Promise<UICommitDiscardResult>,
 	commitDetailsWithLineStats: (params) =>
 		ipcRenderer.invoke(
 			"workspace:commit-details-with-line-stats",

apps/lite/ui/src/api/mutations.ts

@@ -40,6 +40,13 @@ export const commitCreateMutationOptions = mutationOptions({
 	},
 });
 
+export const commitDiscardMutationOptions = mutationOptions({
+	mutationFn: window.lite.commitDiscard,
+	onSuccess: async (_data, _input, _ctx, { client }) => {
+		await client.invalidateQueries();
+	},
+});
+
 export const commitRewordMutationOptions = mutationOptions({
 	mutationFn: window.lite.commitReword,
 	onSuccess: async (_data, _input, _ctx, { client }) => {

apps/lite/ui/src/routes/project/$id/workspace/route.tsx

@@ -1,5 +1,6 @@
 import {
 	commitCreateMutationOptions,
+	commitDiscardMutationOptions,
 	commitInsertBlankMutationOptions,
 	commitRewordMutationOptions,
 	updateBranchNameMutationOptions,
@@ -780,6 +781,7 @@ const CommitMenuPopup: FC<{
 	parts: typeof Menu | typeof ContextMenu;
 }> = ({ projectId, commitId, canReword, onReword, parts }) => {
 	const commitInsertBlank = useMutation(commitInsertBlankMutationOptions);
+	const commitDiscard = useMutation(commitDiscardMutationOptions);
 	const { Popup, Item, SubmenuRoot, SubmenuTrigger, Positioner } = parts;
 
 	return (
@@ -818,6 +820,18 @@ const CommitMenuPopup: FC<{
 					</Popup>
 				</Positioner>
 			</SubmenuRoot>
+			<Item
+				className={uiStyles.menuItem}
+				disabled={commitDiscard.isPending}
+				onClick={() => {
+					commitDiscard.mutate({
+						projectId,
+						subjectCommitId: commitId,
+					});
+				}}
+			>
+				{commitDiscard.isPending ? "Deleting commit…" : "Delete commit"}
+			</Item>
 		</Popup>
 	);
 };

packages/but-sdk/src/generated/index.d.ts

@@ -1,28 +1,50 @@
 /* auto-generated by NAPI-RS */
 /* eslint-disable */
 /**
- * Absorb multiple changes into their target commits as per the provided absorption plan.
+ * Absorb the changes described by `absorption_plan` using the behavior documented by
+ * [`absorb_with_perm()`].
  *
- * Returns the total amount of rejected diff specs.
+ * This acquires exclusive worktree access from `ctx` before creating the
+ * snapshot and rewriting commits.
+ *
+ * Before applying the plan, this records an `Absorb` oplog snapshot and refreshes the
+ * synthetic workspace commit after the rewritten commits are in place.
  */
 export declare function absorb(projectId: string, absorptionPlan: Array<CommitAbsorption>): Promise<number>
 
-/** Generate an absorption plan based on the provided target, based on hunk dependencies, assignments and other heuristics */
+/**
+ * Build an absorption plan for `target` using the behavior documented by
+ * [`absorption_plan_with_perm()`].
+ */
 export declare function absorptionPlan(projectId: string, target: AbsorptionTarget): Promise<Array<CommitAbsorption>>
 
-/** Just like [apply_only()], but will create an oplog entry as well on success. */
+/**
+ * Applies `existing_branch` using the behavior described by
+ * [`apply_with_perm()`].
+ *
+ * This acquires exclusive worktree access from `ctx`, applies
+ * `existing_branch`, and records an oplog snapshot on success.
+ */
 export declare function apply(projectId: string, existingBranch: string): Promise<ApplyOutcome>
 
 /**
- * Persist hunk-to-commit assignments for the current workspace.
+ * Persists `assignments` for the current workspace.
  *
- * `assignments` is a list of hunk assignment requests produced by the UI.
+ * `assignments` is applied against the current workspace state and stored in
+ * the hunk-assignment database. For lower-level implementation details, see
+ * [`but_hunk_assignment::assign()`].
  */
 export declare function assignHunk(projectId: string, assignments: Array<HunkAssignmentRequest>): Promise<void>
 
 export declare function branchDetails(projectId: string, branchName: string, remote: string | null): Promise<BranchDetails>
 
-/** Gets the changes for a given branch. */
+/**
+ * Computes the worktree-visible diff for `branch` in the current workspace.
+ *
+ * `branch` is resolved by name in the repository referenced by `ctx`, and the
+ * diff is computed against the current workspace state. For lower-level
+ * implementation details, see [`but_workspace::ui::diff::changes_in_branch()`].
+ */
 export declare function branchDiff(projectId: string, branch: string): Promise<TreeChanges>
 
 /** See [`changes_in_worktree_with_perm()`]. */
@@ -38,58 +60,96 @@ export declare function changesInWorktree(projectId: string): Promise<WorktreeCh
  * * conflicts are ignored
  *
  * All ignored status changes are also provided so they can be displayed separately.
+ *
+ * For lower-level implementation details, see
+ * [`but_core::diff::worktree_changes()`],
+ * [`but_hunk_assignment::assignments_with_fallback()`], and
+ * [`but_hunk_dependency::ui::hunk_dependencies_for_workspace_changes_by_worktree_dir()`].
  */
 export declare function changesInWorktreeWithPerm(projectId: string): Promise<WorktreeChanges>
 
-/** Amends an existing commit with selected changes, with oplog support. */
+/**
+ * Amend the commit at `commit_id` with `changes` and record an oplog snapshot on success.
+ *
+ * This performs the rewrite under exclusive worktree access and creates a
+ * best-effort `AmendCommit` oplog entry if the operation succeeds. For
+ * lower-level implementation details, see
+ * [`but_workspace::commit::commit_amend()`].
+ */
 export declare function commitAmend(projectId: string, commitId: string, changes: Array<DiffSpec>): Promise<UICommitCreateResult>
 
-/** Creates and inserts a commit relative to either a commit or a reference, with oplog support. */
+/**
+ * Insert a new commit built from `changes` and record an oplog snapshot on
+ * success.
+ *
+ * `relative_to` and `side` choose where the commit is inserted. `message` is
+ * the entire commit message text, not just the title. On success, this commits
+ * a best-effort `CreateCommit` oplog snapshot using the same lock. For
+ * lower-level implementation details, see
+ * [`but_workspace::commit::commit_create()`].
+ */
 export declare function commitCreate(projectId: string, relativeTo: RelativeTo, side: InsertSide, changes: Array<DiffSpec>, message: string): Promise<UICommitCreateResult>
 
-/** This function just exists for the frontend to work without the need for line-stats to be enabled explicitly. */
+/**
+ * Computes commit details for `commit_id` with line statistics enabled.
+ *
+ * This exists for callers that always want line statistics without passing
+ * `line_stats` explicitly.
+ */
 export declare function commitDetailsWithLineStats(projectId: string, commitId: string): Promise<CommitDetails>
 
 /**
- * Discards a commit.
- *
- * Returns the replaced commits that resulted from the operation.
+ * Discard `subject_commit_id` using the behavior described by
+ * [`commit_discard_with_perm()`].
  */
 export declare function commitDiscard(projectId: string, subjectCommitId: string): Promise<UICommitDiscardResult>
 
 /**
- * Inserts a blank commit relative to either a commit or a reference, with oplog support.
+ * Inserts a blank commit on `side` of `relative_to` and records an oplog
+ * snapshot on success.
  *
- * Returns the result including the new commit ID and any replaced commits.
+ * For details, see [`commit_insert_blank_with_perm()`].
  */
 export declare function commitInsertBlank(projectId: string, relativeTo: RelativeTo, side: InsertSide): Promise<UICommitInsertBlankResult>
 
 /**
- * Moves a commit within or across stacks.
+ * Moves `subject_commit_id` to `side` of `relative_to` and records an oplog
+ * snapshot on success.
+ *
+ * This acquires exclusive worktree access from `ctx` before moving the
+ * commit.
  *
- * Returns the replaced that resulted from the operation.
+ * For details, see [`commit_move_with_perm()`].
  */
 export declare function commitMove(projectId: string, subjectCommitId: string, relativeTo: RelativeTo, side: InsertSide): Promise<UICommitMoveResult>
 
 /**
- * Moves changes between two commits.
+ * Moves `changes` from `source_commit_id` to `destination_commit_id` and
+ * records an oplog snapshot on success.
  *
- * Returns where the source and destination commits were mapped to.
+ * This acquires exclusive worktree access from `ctx` before moving the
+ * changes.
+ *
+ * For details, see [`commit_move_changes_between_with_perm()`].
  */
 export declare function commitMoveChangesBetween(projectId: string, sourceCommitId: string, destinationCommitId: string, changes: Array<DiffSpec>): Promise<UIMoveChangesResult>
 
 /**
- * Rewords a commit, with oplog support.
+ * Reword `commit_id` to `message` using the behavior described by
+ * [`commit_reword_with_perm()`].
  *
- * Returns the result including the new commit ID and any replaced commits.
+ * This acquires exclusive worktree access from `ctx` before rewriting the
+ * commit message and recording the oplog entry.
  */
 export declare function commitReword(projectId: string, commitId: string, message: string): Promise<UICommitRewordResult>
 
 /**
- * Uncommits changes from a commit, with oplog and optional assign_to support.
+ * Extract `changes` from `commit_id` and record the rewrite in the oplog.
+ *
+ * This acquires exclusive worktree access from `ctx` before extracting the
+ * changes.
  *
- * If `assign_to` is provided, the newly uncommitted changes will be assigned
- * to the specified stack.
+ * See [`commit_uncommit_changes_with_perm()`] for details.
  */
 export declare function commitUncommitChanges(projectId: string, commitId: string, changes: Array<DiffSpec>, assignTo: string | null): Promise<UIMoveChangesResult>
 
@@ -120,7 +180,12 @@ export declare function listReviewsForBranch(projectId: string, branch: string,
 /** Merge a review on the forge. */
 export declare function mergeReview(projectId: string, reviewId: number): Promise<void>
 
-/** Move a branch on top of another */
+/**
+ * Moves a branch using the behavior described by [`move_branch_with_perm()`].
+ *
+ * This acquires exclusive worktree access from `ctx`, moves `subject_branch`
+ * on top of `target_branch`, and records an oplog snapshot on success.
+ */
 export declare function moveBranch(projectId: string, subjectBranch: string, targetBranch: string): Promise<UIMoveBranchResult>
 
 export declare function publishReview(projectId: string, params: CreateForgeReviewParams): Promise<ForgeReview>
@@ -130,6 +195,9 @@ export declare function pushStackLegacy(projectId: string, stackId: string, with
 /**
  * Remove a branch from a stack.
  *
+ * This acquires exclusive worktree access from `ctx` before creating the
+ * removal snapshot and detaching the branch.
+ *
  * This can only be called on a branch that's inside of a stack of multiple branches and is not the top branch,
  * or on a branch that's empty.
  */
@@ -156,21 +224,41 @@ export declare function setReviewDraftiness(projectId: string, reviewId: number,
 export declare function setReviewTemplate(projectId: string, templatePath: string | null): Promise<void>
 
 /**
- * Take a branch out of a stack
+ * Tears off a branch using the behavior described by [`tear_off_branch_with_perm()`].
  *
- * `subject_branch` - The branch to take out of its stack, and create a new one out of.
+ * This acquires exclusive worktree access from `ctx`, tears `subject_branch`
+ * out of its current stack, and records an oplog snapshot on success.
  */
 export declare function tearOffBranch(projectId: string, subjectBranch: string): Promise<UIMoveBranchResult>
 
 /**
- * Provide a unified diff for `change`, but fail if `change` is a [type-change](but_core::ModeFlags::TypeChange)
- * or if it involves a change to a [submodule](gix::object::Kind::Commit).
+ * Produces a unified patch for `change`.
+ *
+ * `change` must not be a type change or a submodule change. For lower-level
+ * implementation details, see [`but_core::TreeChange::unified_patch()`].
  */
 export declare function treeChangeDiffs(projectId: string, change: TreeChange): Promise<UnifiedPatch | null>
 
+/**
+ * Take the stack identified by `stack_id` out of the workspace.
+ *
+ * This acquires exclusive worktree access from `ctx` before collecting the
+ * assigned changes and unapplying the stack.
+ *
+ * See [`unapply_stack_with_perm()`] for how assigned changes are collected before
+ * delegating to the underlying mutation.
+ */
 export declare function unapplyStack(projectId: string, stackId: string): Promise<void>
 
-/** Rename a branch */
+/**
+ * Change the branch name from `branch_name` to `new_name` in the stack
+ * identified by `stack_id`.
+ *
+ * This acquires exclusive worktree access from `ctx` before applying the
+ * rename.
+ *
+ * See [`update_branch_name_with_perm()`] for the underlying mutation.
+ */
 export declare function updateBranchName(projectId: string, stackId: string, branchName: string, newName: string): Promise<void>
 
 /** Update the stacked review descriptions to have the correct footers. */