Refactor git commit hooks

- the typescript side drives the hook runs
- some very basic tests

Author: mtsgrd

Cargo.lock

@@ -1,10 +1,13 @@
 <script lang="ts">
 	import CommitMessageInput from './CommitMessageInput.svelte';
+	import { PostHogWrapper } from '$lib/analytics/posthog';
 	import ContextMenuItem from '$lib/components/contextmenu/ContextMenuItem.svelte';
 	import ContextMenuSection from '$lib/components/contextmenu/ContextMenuSection.svelte';
 	import { persistedCommitMessage } from '$lib/config/config';
 	import { cloudCommunicationFunctionality } from '$lib/config/uiFeatureFlags';
 	import { SyncedSnapshotService } from '$lib/history/syncedSnapshotService';
+	import { HooksService } from '$lib/hooks/hooksService';
+	import { showError } from '$lib/notifications/toasts';
 	import DropDownButton from '$lib/shared/DropDownButton.svelte';
 	import { intersectionObserver } from '$lib/utils/intersectionObserver';
 	import { BranchController } from '$lib/vbranches/branchController';
@@ -25,30 +28,63 @@
 	const { projectId, expanded, hasSectionsAfter }: Props = $props();
 
 	const branchController = getContext(BranchController);
+	const hooksService = getContext(HooksService);
+	const posthog = getContext(PostHogWrapper);
 	const syncedSnapshotService = getContext(SyncedSnapshotService);
 	const canTakeSnapshot = syncedSnapshotService.canTakeSnapshot;
 	const selectedOwnership = getContextStore(SelectedOwnership);
 	const stack = getContextStore(BranchStack);
 	const commitMessage = persistedCommitMessage(projectId, $stack.id);
+	const canShowCommitAndPublish = $derived($cloudCommunicationFunctionality && $canTakeSnapshot);
 
 	let commitMessageInput = $state<CommitMessageInput>();
 	let isCommitting = $state(false);
 	let commitMessageValid = $state(false);
 	let isInViewport = $state(false);
 
+	let commitAndPublish = $state(false);
+	let commitButton = $state<DropDownButton>();
+
 	async function commit() {
-		const message = $commitMessage;
 		isCommitting = true;
-		try {
-			await branchController.commitBranch($stack.id, message.trim(), $selectedOwnership.toString());
-			$commitMessage = '';
+		const message = $commitMessage;
+		const ownership = $selectedOwnership.toString();
 
-			if (commitAndPublish) {
-				syncedSnapshotService.takeSyncedSnapshot($stack.id);
+		try {
+			const preCommitHook = await hooksService.preCommit(projectId, ownership);
+			if (preCommitHook.status === 'failure') {
+				showError('Pre-commit hook failed', preCommitHook.error);
+				return; // Abort commit if hook failed.
 			}
+			await branchController.commit($stack.id, message.trim(), ownership);
+		} catch (err: unknown) {
+			showError('Failed to commit changes', err);
+			posthog.capture('Commit Failed', { error: err });
+			return;
 		} finally {
 			isCommitting = false;
 		}
+
+		// Run both without awaiting unless commit failed.
+		runPostCommitActions();
+		runPostCommitHook();
+	}
+
+	async function runPostCommitActions() {
+		// Clear the commit message editor.
+		commitMessage.set('');
+
+		// Publishing a snapshot seems to imply posting a bleep.
+		if (commitAndPublish) {
+			await syncedSnapshotService.takeSyncedSnapshot($stack.id);
+		}
+	}
+
+	async function runPostCommitHook() {
+		const postCommitHook = await hooksService.postCommit(projectId);
+		if (postCommitHook.status === 'failure') {
+			showError('Post-commit hook failed', postCommitHook.error);
+		}
 	}
 
 	function close() {
@@ -60,11 +96,6 @@
 		await tick();
 		commitMessageInput?.focus();
 	}
-
-	const canShowCommitAndPublish = $derived($cloudCommunicationFunctionality && $canTakeSnapshot);
-
-	let commitAndPublish = $state(false);
-	let commitButton = $state<DropDownButton>();
 </script>
 
 <div

apps/desktop/src/lib/commit/CommitDialog.svelte

@@ -9,6 +9,7 @@
 		projectCommitGenerationExtraConcise,
 		projectCommitGenerationUseEmojis
 	} from '$lib/config/config';
+	import { HooksService } from '$lib/hooks/hooksService';
 	import { showError } from '$lib/notifications/toasts';
 	import { isFailure } from '$lib/result';
 	import DropDownButton from '$lib/shared/DropDownButton.svelte';
@@ -19,6 +20,7 @@
 	import { BranchStack, DetailedCommit, Commit } from '$lib/vbranches/types';
 	import { getContext, getContextStore } from '@gitbutler/shared/context';
 	import Checkbox from '@gitbutler/ui/Checkbox.svelte';
+	import Icon from '@gitbutler/ui/Icon.svelte';
 	import Textarea from '@gitbutler/ui/Textarea.svelte';
 	import Tooltip from '@gitbutler/ui/Tooltip.svelte';
 	import { isWhiteSpaceString } from '@gitbutler/ui/utils/string';
@@ -47,12 +49,14 @@
 	const stack = getContextStore(BranchStack);
 	const project = getContext(Project);
 	const promptService = getContext(PromptService);
+	const hooksService = getContext(HooksService);
 
 	const aiGenEnabled = projectAiGenEnabled(project.id);
 	const commitGenerationExtraConcise = projectCommitGenerationExtraConcise(project.id);
 	const commitGenerationUseEmojis = projectCommitGenerationUseEmojis(project.id);
 
 	let aiLoading = $state(false);
+	let hookRunning = $state(false);
 	let aiConfigurationValid = $state(false);
 
 	let titleTextArea: HTMLTextAreaElement | undefined = $state();
@@ -134,6 +138,22 @@
 		aiLoading = false;
 	}
 
+	async function runMessageHook() {
+		hookRunning = true;
+		try {
+			const hook_result = await hooksService.message(project.id, commitMessage);
+			if (hook_result.status === 'message') {
+				commitMessage = hook_result.message;
+			} else if (hook_result.status === 'failure') {
+				showError('Message hook failed', hook_result.error);
+			}
+		} catch (err: unknown) {
+			showError('Message hook failed', err);
+		} finally {
+			hookRunning = false;
+		}
+	}
+
 	onMount(async () => {
 		aiConfigurationValid = await aiService.validateConfiguration();
 	});
@@ -237,6 +257,7 @@
 			}}
 			onblur={() => {
 				isTitleFocused = false;
+				runMessageHook();
 			}}
 			oninput={(e: Event & { currentTarget: EventTarget & HTMLTextAreaElement }) => {
 				const target = e.currentTarget;
@@ -263,6 +284,7 @@
 				}}
 				onblur={() => {
 					isDescriptionFocused = false;
+					runMessageHook();
 				}}
 				oninput={(e: Event & { currentTarget: EventTarget & HTMLTextAreaElement }) => {
 					const target = e.currentTarget;
@@ -288,6 +310,9 @@
 					: undefined}
 		>
 			<div class="commit-box__texarea-actions" class:commit-box-actions_expanded={isExpanded}>
+				{#if hookRunning}
+					<Icon name="spinner" opacity={0.4} />
+				{/if}
 				<DropDownButton
 					style="ghost"
 					outline
@@ -361,6 +386,9 @@
 	}
 
 	.commit-box__texarea-actions {
+		display: flex;
+		align-items: center;
+		gap: 10px;
 		position: absolute;
 		right: 12px;
 		bottom: 12px;

apps/desktop/src/lib/commit/CommitMessageInput.svelte

@@ -0,0 +1,41 @@
+import type { Tauri } from '$lib/backend/tauri';
+
+export type HookStatus =
+	| {
+			status: 'success';
+	  }
+	| {
+			status: 'message';
+			message: string;
+	  }
+	| {
+			status: 'notfound';
+	  }
+	| {
+			status: 'failure';
+			error: string;
+	  };
+
+export class HooksService {
+	constructor(private tauri: Tauri) {}
+
+	async preCommit(projectId: string, ownership: string | undefined = undefined) {
+		return await this.tauri.invoke<HookStatus>('pre_commit_hook', {
+			projectId,
+			ownership
+		});
+	}
+
+	async postCommit(projectId: string) {
+		return await this.tauri.invoke<HookStatus>('post_commit_hook', {
+			projectId
+		});
+	}
+
+	async message(projectId: string, message: string) {
+		return await this.tauri.invoke<HookStatus>('message_hook', {
+			projectId,
+			message
+		});
+	}
+}

apps/desktop/src/lib/hooks/hooksService.ts

@@ -52,32 +52,14 @@ export class BranchController {
 		}
 	}
 
-	async runHooks(stackId: string, ownership: string) {
-		await invoke<void>('run_hooks', {
+	async commit(branchId: string, message: string, ownership: string | undefined = undefined) {
+		await invoke<void>('commit_virtual_branch', {
 			projectId: this.projectId,
-			stackId,
+			branch: branchId,
+			message,
 			ownership
 		});
-	}
-
-	async commitBranch(branchId: string, message: string, ownership: string | undefined = undefined) {
-		try {
-			await invoke<void>('commit_virtual_branch', {
-				projectId: this.projectId,
-				branch: branchId,
-				message,
-				ownership
-			});
-			this.posthog.capture('Commit Successful');
-		} catch (err: any) {
-			if (err.code === 'errors.commit.signing_failed') {
-				showSignError(err);
-			} else {
-				showError('Failed to commit changes', err);
-				throw err;
-			}
-			this.posthog.capture('Commit Failed', err);
-		}
+		this.posthog.capture('Commit Successful');
 	}
 
 	async integrateUpstreamForSeries(

apps/desktop/src/lib/vbranches/branchController.ts

@@ -29,6 +29,7 @@
 		GitHubUserService
 	} from '$lib/forge/github/githubUserService';
 	import { octokitFromAccessToken } from '$lib/forge/github/octokit';
+	import { HooksService } from '$lib/hooks/hooksService';
 	import ToastController from '$lib/notifications/ToastController.svelte';
 	import { platformName } from '$lib/platform/platform';
 	import { DesktopDispatch, DesktopState } from '$lib/redux/store.svelte';
@@ -79,6 +80,7 @@
 	setContext(OrganizationService, organizationService);
 	setContext(CloudUserService, cloudUserService);
 	setContext(CloudProjectService, cloudProjectService);
+	setContext(HooksService, data.hooksService);
 
 	// Setters do not need to be reactive since `data` never updates
 	setSecretsService(data.secretsService);

apps/desktop/src/routes/+layout.svelte

@@ -11,6 +11,7 @@ import { Tauri } from '$lib/backend/tauri';
 import { UpdaterService } from '$lib/backend/updater';
 import { loadAppSettings } from '$lib/config/appSettings';
 import { FileService } from '$lib/files/fileService';
+import { HooksService } from '$lib/hooks/hooksService';
 import { RemotesService } from '$lib/remotes/service';
 import { RustSecretService } from '$lib/secrets/secretsService';
 import { TokenMemoryService } from '$lib/stores/tokenMemoryService';
@@ -62,6 +63,7 @@ export const load: LayoutLoad = async () => {
 	const lineManagerFactory = new LineManagerFactory();
 	const stackingLineManagerFactory = new StackingLineManagerFactory();
 	const fileService = new FileService(tauri);
+	const hooksService = new HooksService(tauri);
 
 	return {
 		commandService,
@@ -82,6 +84,7 @@ export const load: LayoutLoad = async () => {
 		secretsService,
 		posthog,
 		tauri,
-		fileService
+		fileService,
+		hooksService
 	};
 };

apps/desktop/src/routes/+layout.ts

@@ -16,6 +16,8 @@ pub type DiffByPathMap = HashMap<PathBuf, FileDiff>;
 pub enum ChangeType {
     /// Entry does not exist in old version
     Added,
+    /// Entry is untracked item in workdir
+    Untracked,
     /// Entry does not exist in new version
     Deleted,
     /// Entry content changed between old and new
@@ -26,7 +28,8 @@ impl From<git2::Delta> for ChangeType {
         use git2::Delta as D;
         use ChangeType as C;
         match v {
-            D::Untracked | D::Added => C::Added,
+            D::Added => C::Added,
+            D::Untracked => C::Untracked,
             D::Modified
             | D::Unmodified
             | D::Renamed
@@ -609,6 +612,7 @@ fn reverse_lines(
 pub fn reverse_hunk(hunk: &GitHunk) -> Option<GitHunk> {
     let new_change_type = match hunk.change_type {
         ChangeType::Added => ChangeType::Deleted,
+        ChangeType::Untracked => ChangeType::Deleted,
         ChangeType::Deleted => ChangeType::Added,
         ChangeType::Modified => ChangeType::Modified,
     };
@@ -635,6 +639,7 @@ pub fn reverse_hunk_lines(
     lines: Vec<(Option<u32>, Option<u32>)>,
 ) -> Option<GitHunk> {
     let new_change_type = match hunk.change_type {
+        ChangeType::Untracked => ChangeType::Deleted,
         ChangeType::Added => ChangeType::Deleted,
         ChangeType::Deleted => ChangeType::Added,
         ChangeType::Modified => ChangeType::Modified,

crates/gitbutler-diff/src/diff.rs

@@ -195,7 +195,10 @@ where
                 // upsert into the builder
                 builder.upsert(rel_path, new_blob_oid, filemode);
             } else if !full_path_exists
-                && discard_hunk.map_or(false, |hunk| hunk.change_type == crate::ChangeType::Added)
+                && discard_hunk.map_or(false, |hunk| {
+                    hunk.change_type == crate::ChangeType::Added
+                        || hunk.change_type == crate::ChangeType::Untracked
+                })
             {
                 // File was deleted but now that hunk is being discarded with an inversed hunk
                 let mut all_diffs = BString::default();

crates/gitbutler-diff/src/write.rs

@@ -131,7 +131,6 @@ pub enum Code {
     ProjectGitAuth,
     DefaultTargetNotFound,
     CommitSigningFailed,
-    CommitHookFailed,
     CommitMergeConflictFailure,
     ProjectMissing,
     AuthorMissing,
@@ -145,7 +144,6 @@ impl std::fmt::Display for Code {
             Code::ProjectGitAuth => "errors.projects.git.auth",
             Code::DefaultTargetNotFound => "errors.projects.default_target.not_found",
             Code::CommitSigningFailed => "errors.commit.signing_failed",
-            Code::CommitHookFailed => "errors.commit.hook_failed",
             Code::CommitMergeConflictFailure => "errors.commit.merge_conflict_failure",
             Code::AuthorMissing => "errors.git.author_missing",
             Code::ProjectMissing => "errors.projects.missing",