feat: implement option for hook timeout and abort the commit

DaRacci · DaRacci · commit b932754b218b · 2025-03-16T18:41:14.000+11:00
diff --git a/src/app.rs b/src/app.rs
@@ -846,6 +846,7 @@ impl App {
 					| AppOption::DiffInterhunkLines => {
 						self.status_tab.update_diff()?;
 					}
+					AppOption::HookTimeout => {}
 				}
 
 				flags.insert(NeedsUpdate::ALL);
diff --git a/src/options.rs b/src/options.rs
@@ -14,6 +14,7 @@ use std::{
 	io::{Read, Write},
 	path::PathBuf,
 	rc::Rc,
+	time::Duration,
 };
 
 #[derive(Default, Clone, Serialize, Deserialize)]
@@ -22,6 +23,7 @@ struct OptionsData {
 	pub diff: DiffOptions,
 	pub status_show_untracked: Option<ShowUntrackedFilesConfig>,
 	pub commit_msgs: Vec<String>,
+	pub hook_timeout: Option<Duration>,
 }
 
 const COMMIT_MSG_HISTORY_LENGTH: usize = 20;
@@ -66,6 +68,11 @@ impl Options {
 		self.data.diff
 	}
 
+	#[allow(unused)]
+	pub const fn hook_timeout(&self) -> Option<Duration> {
+		self.data.hook_timeout
+	}
+
 	pub const fn status_show_untracked(
 		&self,
 	) -> Option<ShowUntrackedFilesConfig> {
@@ -137,6 +144,12 @@ impl Options {
 		}
 	}
 
+	#[allow(unused)]
+	pub fn set_hook_timeout(&mut self, timeout: Option<Duration>) {
+		self.data.hook_timeout = timeout;
+		self.save();
+	}
+
 	fn save(&self) {
 		if let Err(e) = self.save_failable() {
 			log::error!("options save error: {}", e);
diff --git a/src/popups/commit.rs b/src/popups/commit.rs
@@ -236,16 +236,28 @@ impl CommitPopup {
 
 		if verify {
 			// run pre commit hook - can reject commit
-			if let HookResult::NotOk(e) =
-				sync::hooks_pre_commit_with_timeout(
-					&self.repo.borrow(),
-					self.get_hook_timeout(),
-				)? {
-				log::error!("pre-commit hook error: {}", e);
-				self.queue.push(InternalEvent::ShowErrorMsg(
-					format!("pre-commit hook error:\n{e}"),
-				));
-				return Ok(CommitResult::Aborted);
+			match sync::hooks_pre_commit_with_timeout(
+				&self.repo.borrow(),
+				self.get_hook_timeout(),
+			)? {
+				HookResult::NotOk(e) => {
+					log::error!("pre-commit hook error: {}", e);
+					self.queue.push(InternalEvent::ShowErrorMsg(
+						format!("pre-commit hook error:\n{e}"),
+					));
+					return Ok(CommitResult::Aborted);
+				}
+				HookResult::TimedOut => {
+					log::error!("pre-commit hook timed out");
+					self.queue.push(InternalEvent::ShowErrorMsg(
+						format!(
+      						"pre-commit hook timed out after {} seconds",
+      						self.get_hook_timeout().as_secs()
+       					),
+					));
+					return Ok(CommitResult::Aborted);
+				}
+				HookResult::Ok => {}
 			}
 		}
 
@@ -254,30 +266,53 @@ impl CommitPopup {
 
 		if verify {
 			// run commit message check hook - can reject commit
-			if let HookResult::NotOk(e) =
-				sync::hooks_commit_msg_with_timeout(
-					&self.repo.borrow(),
-					&mut msg,
-					self.get_hook_timeout(),
-				)? {
-				log::error!("commit-msg hook error: {}", e);
-				self.queue.push(InternalEvent::ShowErrorMsg(
-					format!("commit-msg hook error:\n{e}"),
-				));
-				return Ok(CommitResult::Aborted);
+			match sync::hooks_commit_msg_with_timeout(
+				&self.repo.borrow(),
+				&mut msg,
+				self.get_hook_timeout(),
+			)? {
+				HookResult::NotOk(e) => {
+					log::error!("commit-msg hook error: {}", e);
+					self.queue.push(InternalEvent::ShowErrorMsg(
+						format!("commit-msg hook error:\n{e}"),
+					));
+					return Ok(CommitResult::Aborted);
+				}
+				HookResult::TimedOut => {
+					log::error!("commit-msg hook timed out");
+					self.queue.push(InternalEvent::ShowErrorMsg(
+						format!(
+      						"commit-msg hook timed out after {} seconds",
+      						self.get_hook_timeout().as_secs()
+       					),
+					));
+					return Ok(CommitResult::Aborted);
+				}
+				HookResult::Ok => {}
 			}
 		}
 		self.do_commit(&msg)?;
 
-		if let HookResult::NotOk(e) =
-			sync::hooks_post_commit_with_timeout(
-				&self.repo.borrow(),
-				self.get_hook_timeout(),
-			)? {
-			log::error!("post-commit hook error: {}", e);
-			self.queue.push(InternalEvent::ShowErrorMsg(format!(
-				"post-commit hook error:\n{e}"
-			)));
+		match sync::hooks_post_commit_with_timeout(
+			&self.repo.borrow(),
+			self.get_hook_timeout(),
+		)? {
+			HookResult::NotOk(e) => {
+				log::error!("post-commit hook error: {}", e);
+				self.queue.push(InternalEvent::ShowErrorMsg(
+					format!("post-commit hook error:\n{e}"),
+				));
+			}
+			HookResult::TimedOut => {
+				log::error!("post-commit hook timed out");
+				self.queue.push(InternalEvent::ShowErrorMsg(
+					format!(
+						"post-commit hook timed out after {} seconds",
+						self.get_hook_timeout().as_secs()
+					),
+				));
+			}
+			HookResult::Ok => {}
 		}
 
 		Ok(CommitResult::CommitDone)
@@ -488,10 +523,11 @@ impl CommitPopup {
 		Ok(msg)
 	}
 
-	// TODO - Configurable timeout
-	#[allow(clippy::unused_self, clippy::missing_const_for_fn)]
 	fn get_hook_timeout(&self) -> Duration {
-		Duration::from_secs(5)
+		self.options
+			.borrow()
+			.hook_timeout()
+			.unwrap_or(Duration::ZERO)
 	}
 }
 
diff --git a/src/popups/options.rs b/src/popups/options.rs
@@ -1,3 +1,5 @@
+use std::time::Duration;
+
 use crate::{
 	app::Environment,
 	components::{
@@ -27,6 +29,7 @@ pub enum AppOption {
 	DiffIgnoreWhitespaces,
 	DiffContextLines,
 	DiffInterhunkLines,
+	HookTimeout,
 }
 
 pub struct OptionsPopup {
@@ -99,6 +102,19 @@ impl OptionsPopup {
 			&diff.interhunk_lines.to_string(),
 			self.is_select(AppOption::DiffInterhunkLines),
 		);
+		Self::add_header(txt, "");
+
+		Self::add_header(txt, "Hooks");
+		self.add_entry(
+			txt,
+			width,
+			"Timeout",
+			&self.options.borrow().hook_timeout().map_or_else(
+				|| "None".to_string(),
+				|d| format!("{d:?}"),
+			),
+			self.is_select(AppOption::HookTimeout),
+		);
 	}
 
 	fn is_select(&self, kind: AppOption) -> bool {
@@ -138,7 +154,7 @@ impl OptionsPopup {
 		if up {
 			self.selection = match self.selection {
 				AppOption::StatusShowUntracked => {
-					AppOption::DiffInterhunkLines
+					AppOption::HookTimeout
 				}
 				AppOption::DiffIgnoreWhitespaces => {
 					AppOption::StatusShowUntracked
@@ -149,6 +165,9 @@ impl OptionsPopup {
 				AppOption::DiffInterhunkLines => {
 					AppOption::DiffContextLines
 				}
+				AppOption::HookTimeout => {
+					AppOption::DiffInterhunkLines
+				}
 			};
 		} else {
 			self.selection = match self.selection {
@@ -162,6 +181,9 @@ impl OptionsPopup {
 					AppOption::DiffInterhunkLines
 				}
 				AppOption::DiffInterhunkLines => {
+					AppOption::HookTimeout
+				}
+				AppOption::HookTimeout => {
 					AppOption::StatusShowUntracked
 				}
 			};
@@ -207,6 +229,14 @@ impl OptionsPopup {
 						.borrow_mut()
 						.diff_hunk_lines_change(true);
 				}
+				AppOption::HookTimeout => {
+					let current =
+						self.options.borrow().hook_timeout();
+					let inc = Duration::from_secs(1);
+					let new = current.map(|d| d + inc).or(Some(inc));
+
+					self.options.borrow_mut().set_hook_timeout(new);
+				}
 			};
 		} else {
 			match self.selection {
@@ -246,6 +276,21 @@ impl OptionsPopup {
 						.borrow_mut()
 						.diff_hunk_lines_change(false);
 				}
+				AppOption::HookTimeout => {
+					let current =
+						self.options.borrow().hook_timeout();
+					let dec = Duration::from_secs(1);
+
+					let new = current.and_then(|d| {
+						if d > dec {
+							Some(d - dec)
+						} else {
+							None
+						}
+					});
+
+					self.options.borrow_mut().set_hook_timeout(new);
+				}
 			};
 		}
 
@@ -257,7 +302,7 @@ impl OptionsPopup {
 impl DrawableComponent for OptionsPopup {
 	fn draw(&self, f: &mut Frame, area: Rect) -> Result<()> {
 		if self.is_visible() {
-			const SIZE: (u16, u16) = (50, 10);
+			const SIZE: (u16, u16) = (50, 12);
 			let area =
 				ui::centered_rect_absolute(SIZE.0, SIZE.1, area);
 

Original file line number	Diff line number	Diff line change
`@@ -846,6 +846,7 @@ impl App {`
`846`	`846`	`\| AppOption::DiffInterhunkLines => {`
`847`	`847`	`self.status_tab.update_diff()?;`
`848`	`848`	`}`
	`849`	`+ AppOption::HookTimeout => {}`
`849`	`850`	`}`
`850`	`851`
`851`	`852`	`flags.insert(NeedsUpdate::ALL);`