refactor: unify interrupt handling in Dropbox and Google Drive tools

Refactored the create and delete file functionalities in Dropbox and Google Drive tools to utilize a consistent InterruptResult interface with specific context types. This change enhances code clarity and maintains uniformity in handling user approvals by integrating the useHitlDecision hook for decision dispatching.

surfsense_web/components/tool-ui/dropbox/create-file.tsx

@@ -16,6 +16,8 @@ import {
 	SelectValue,
 } from "@/components/ui/select";
 import { useHitlPhase } from "@/hooks/use-hitl-phase";
+import { isInterruptResult, useHitlDecision } from "@/lib/hitl";
+import type { InterruptResult, HitlDecision } from "@/lib/hitl";
 
 interface DropboxAccount {
 	id: number;
@@ -29,21 +31,11 @@ interface SupportedType {
 	label: string;
 }
 
-interface InterruptResult {
+interface DropboxCreateFileContext {
-	__interrupt__: true;
+	accounts?: DropboxAccount[];
-	__decided__?: "approve" | "reject" | "edit";
+	parent_folders?: Record<number, Array<{ folder_path: string; name: string }>>;
-	__completed__?: boolean;
+	supported_types?: SupportedType[];
-	action_requests: Array<{ name: string; args: Record<string, unknown> }>;
+	error?: string;
-	review_configs: Array<{
-		action_name: string;
-		allowed_decisions: Array<"approve" | "edit" | "reject">;
-	}>;
-	context?: {
-		accounts?: DropboxAccount[];
-		parent_folders?: Record<number, Array<{ folder_path: string; name: string }>>;
-		supported_types?: SupportedType[];
-		error?: string;
-	};
 }
 
 interface SuccessResult {
@@ -65,16 +57,7 @@ interface AuthErrorResult {
 	connector_type?: string;
 }
 
-type CreateDropboxFileResult = InterruptResult | SuccessResult | ErrorResult | AuthErrorResult;
+type CreateDropboxFileResult = InterruptResult<DropboxCreateFileContext> | SuccessResult | ErrorResult | AuthErrorResult;
-
-function isInterruptResult(result: unknown): result is InterruptResult {
-	return (
-		typeof result === "object" &&
-		result !== null &&
-		"__interrupt__" in result &&
-		(result as InterruptResult).__interrupt__ === true
-	);
-}
 
 function isErrorResult(result: unknown): result is ErrorResult {
 	return (
@@ -100,12 +83,8 @@ function ApprovalCard({
 	onDecision,
 }: {
 	args: { name: string; file_type?: string; content?: string };
-	interruptData: InterruptResult;
+	interruptData: InterruptResult<DropboxCreateFileContext>;
-	onDecision: (decision: {
+	onDecision: (decision: HitlDecision) => void;
-		type: "approve" | "reject" | "edit";
-		message?: string;
-		edited_action?: { name: string; args: Record<string, unknown> };
-	}) => void;
 }) {
 	const { phase, setProcessing, setRejected } = useHitlPhase(interruptData);
 	const [isPanelOpen, setIsPanelOpen] = useState(false);
@@ -455,17 +434,14 @@ export const CreateDropboxFileToolUI = ({
 	{ name: string; file_type?: string; content?: string },
 	CreateDropboxFileResult
 >) => {
+	const { dispatch } = useHitlDecision();
 	if (!result) return null;
 	if (isInterruptResult(result)) {
 		return (
 			<ApprovalCard
 				args={args}
-				interruptData={result}
+				interruptData={result as InterruptResult<DropboxCreateFileContext>}
-				onDecision={(decision) => {
+				onDecision={(decision) => dispatch([decision])}
-					window.dispatchEvent(
-						new CustomEvent("hitl-decision", { detail: { decisions: [decision] } })
-					);
-				}}
 			/>
 		);
 	}

surfsense_web/components/tool-ui/dropbox/trash-file.tsx

@@ -7,6 +7,8 @@ import { TextShimmerLoader } from "@/components/prompt-kit/loader";
 import { Button } from "@/components/ui/button";
 import { Checkbox } from "@/components/ui/checkbox";
 import { useHitlPhase } from "@/hooks/use-hitl-phase";
+import { isInterruptResult, useHitlDecision } from "@/lib/hitl";
+import type { InterruptResult, HitlDecision } from "@/lib/hitl";
 
 interface DropboxAccount {
 	id: number;
@@ -22,13 +24,10 @@ interface DropboxFile {
 	document_id?: number;
 }
 
-interface InterruptResult {
+interface DropboxTrashFileContext {
-	__interrupt__: true;
+	account?: DropboxAccount;
-	__decided__?: "approve" | "reject";
+	file?: DropboxFile;
-	__completed__?: boolean;
+	error?: string;
-	action_requests: Array<{ name: string; args: Record<string, unknown> }>;
-	review_configs: Array<{ action_name: string; allowed_decisions: Array<"approve" | "reject"> }>;
-	context?: { account?: DropboxAccount; file?: DropboxFile; error?: string };
 }
 
 interface SuccessResult {
@@ -52,20 +51,12 @@ interface AuthErrorResult {
 }
 
 type DeleteDropboxFileResult =
-	| InterruptResult
+	| InterruptResult<DropboxTrashFileContext>
 	| SuccessResult
 	| ErrorResult
 	| NotFoundResult
 	| AuthErrorResult;
 
-function isInterruptResult(result: unknown): result is InterruptResult {
-	return (
-		typeof result === "object" &&
-		result !== null &&
-		"__interrupt__" in result &&
-		(result as InterruptResult).__interrupt__ === true
-	);
-}
 function isErrorResult(result: unknown): result is ErrorResult {
 	return (
 		typeof result === "object" &&
@@ -95,12 +86,8 @@ function ApprovalCard({
 	interruptData,
 	onDecision,
 }: {
-	interruptData: InterruptResult;
+	interruptData: InterruptResult<DropboxTrashFileContext>;
-	onDecision: (decision: {
+	onDecision: (decision: HitlDecision) => void;
-		type: "approve" | "reject";
-		message?: string;
-		edited_action?: { name: string; args: Record<string, unknown> };
-	}) => void;
 }) {
 	const { phase, setProcessing, setRejected } = useHitlPhase(interruptData);
 	const [deleteFromKb, setDeleteFromKb] = useState(false);
@@ -308,16 +295,13 @@ export const DeleteDropboxFileToolUI = ({
 	{ file_name: string; delete_from_kb?: boolean },
 	DeleteDropboxFileResult
 >) => {
+	const { dispatch } = useHitlDecision();
 	if (!result) return null;
 	if (isInterruptResult(result)) {
 		return (
 			<ApprovalCard
-				interruptData={result}
+				interruptData={result as InterruptResult<DropboxTrashFileContext>}
-				onDecision={(decision) => {
+				onDecision={(decision) => dispatch([decision])}
-					window.dispatchEvent(
-						new CustomEvent("hitl-decision", { detail: { decisions: [decision] } })
-					);
-				}}
 			/>
 		);
 	}

surfsense_web/components/tool-ui/google-drive/create-file.tsx

@@ -16,6 +16,8 @@ import {
 	SelectValue,
 } from "@/components/ui/select";
 import { useHitlPhase } from "@/hooks/use-hitl-phase";
+import { isInterruptResult, useHitlDecision } from "@/lib/hitl";
+import type { InterruptResult, HitlDecision } from "@/lib/hitl";
 
 interface GoogleDriveAccount {
 	id: number;
@@ -23,24 +25,11 @@ interface GoogleDriveAccount {
 	auth_expired?: boolean;
 }
 
-interface InterruptResult {
+interface DriveCreateFileContext {
-	__interrupt__: true;
+	accounts?: GoogleDriveAccount[];
-	__decided__?: "approve" | "reject" | "edit";
+	supported_types?: string[];
-	__completed__?: boolean;
+	parent_folders?: Record<number, Array<{ folder_id: string; name: string }>>;
-	action_requests: Array<{
+	error?: string;
-		name: string;
-		args: Record<string, unknown>;
-	}>;
-	review_configs: Array<{
-		action_name: string;
-		allowed_decisions: Array<"approve" | "edit" | "reject">;
-	}>;
-	context?: {
-		accounts?: GoogleDriveAccount[];
-		supported_types?: string[];
-		parent_folders?: Record<number, Array<{ folder_id: string; name: string }>>;
-		error?: string;
-	};
 }
 
 interface SuccessResult {
@@ -69,21 +58,12 @@ interface AuthErrorResult {
 }
 
 type CreateGoogleDriveFileResult =
-	| InterruptResult
+	| InterruptResult<DriveCreateFileContext>
 	| SuccessResult
 	| ErrorResult
 	| InsufficientPermissionsResult
 	| AuthErrorResult;
 
-function isInterruptResult(result: unknown): result is InterruptResult {
-	return (
-		typeof result === "object" &&
-		result !== null &&
-		"__interrupt__" in result &&
-		(result as InterruptResult).__interrupt__ === true
-	);
-}
-
 function isErrorResult(result: unknown): result is ErrorResult {
 	return (
 		typeof result === "object" &&
@@ -122,12 +102,8 @@ function ApprovalCard({
 	onDecision,
 }: {
 	args: { name: string; file_type: string; content?: string };
-	interruptData: InterruptResult;
+	interruptData: InterruptResult<DriveCreateFileContext>;
-	onDecision: (decision: {
+	onDecision: (decision: HitlDecision) => void;
-		type: "approve" | "reject" | "edit";
-		message?: string;
-		edited_action?: { name: string; args: Record<string, unknown> };
-	}) => void;
 }) {
 	const { phase, setProcessing, setRejected } = useHitlPhase(interruptData);
 	const [isPanelOpen, setIsPanelOpen] = useState(false);
@@ -499,18 +475,15 @@ export const CreateGoogleDriveFileToolUI = ({
 	{ name: string; file_type: string; content?: string },
 	CreateGoogleDriveFileResult
 >) => {
+	const { dispatch } = useHitlDecision();
 	if (!result) return null;
 
 	if (isInterruptResult(result)) {
 		return (
 			<ApprovalCard
 				args={args}
-				interruptData={result}
+				interruptData={result as InterruptResult<DriveCreateFileContext>}
-				onDecision={(decision) => {
+				onDecision={(decision) => dispatch([decision])}
-					window.dispatchEvent(
-						new CustomEvent("hitl-decision", { detail: { decisions: [decision] } })
-					);
-				}}
 			/>
 		);
 	}

surfsense_web/components/tool-ui/google-drive/trash-file.tsx

@@ -7,6 +7,8 @@ import { TextShimmerLoader } from "@/components/prompt-kit/loader";
 import { Button } from "@/components/ui/button";
 import { Checkbox } from "@/components/ui/checkbox";
 import { useHitlPhase } from "@/hooks/use-hitl-phase";
+import { isInterruptResult, useHitlDecision } from "@/lib/hitl";
+import type { InterruptResult, HitlDecision } from "@/lib/hitl";
 
 interface GoogleDriveAccount {
 	id: number;
@@ -21,23 +23,10 @@ interface GoogleDriveFile {
 	web_view_link: string;
 }
 
-interface InterruptResult {
+interface DriveTrashFileContext {
-	__interrupt__: true;
+	account?: GoogleDriveAccount;
-	__decided__?: "approve" | "reject";
+	file?: GoogleDriveFile;
-	__completed__?: boolean;
+	error?: string;
-	action_requests: Array<{
-		name: string;
-		args: Record<string, unknown>;
-	}>;
-	review_configs: Array<{
-		action_name: string;
-		allowed_decisions: Array<"approve" | "reject">;
-	}>;
-	context?: {
-		account?: GoogleDriveAccount;
-		file?: GoogleDriveFile;
-		error?: string;
-	};
 }
 
 interface SuccessResult {
@@ -77,7 +66,7 @@ interface AuthErrorResult {
 }
 
 type DeleteGoogleDriveFileResult =
-	| InterruptResult
+	| InterruptResult<DriveTrashFileContext>
 	| SuccessResult
 	| WarningResult
 	| ErrorResult
@@ -85,15 +74,6 @@ type DeleteGoogleDriveFileResult =
 	| InsufficientPermissionsResult
 	| AuthErrorResult;
 
-function isInterruptResult(result: unknown): result is InterruptResult {
-	return (
-		typeof result === "object" &&
-		result !== null &&
-		"__interrupt__" in result &&
-		(result as InterruptResult).__interrupt__ === true
-	);
-}
-
 function isErrorResult(result: unknown): result is ErrorResult {
 	return (
 		typeof result === "object" &&
@@ -151,12 +131,8 @@ function ApprovalCard({
 	interruptData,
 	onDecision,
 }: {
-	interruptData: InterruptResult;
+	interruptData: InterruptResult<DriveTrashFileContext>;
-	onDecision: (decision: {
+	onDecision: (decision: HitlDecision) => void;
-		type: "approve" | "reject";
-		message?: string;
-		edited_action?: { name: string; args: Record<string, unknown> };
-	}) => void;
 }) {
 	const { phase, setProcessing, setRejected } = useHitlPhase(interruptData);
 	const [deleteFromKb, setDeleteFromKb] = useState(false);
@@ -416,18 +392,14 @@ export const DeleteGoogleDriveFileToolUI = ({
 	{ file_name: string; delete_from_kb?: boolean },
 	DeleteGoogleDriveFileResult
 >) => {
+	const { dispatch } = useHitlDecision();
 	if (!result) return null;
 
 	if (isInterruptResult(result)) {
 		return (
 			<ApprovalCard
-				interruptData={result}
+				interruptData={result as InterruptResult<DriveTrashFileContext>}
-				onDecision={(decision) => {
+				onDecision={(decision) => dispatch([decision])}
-					const event = new CustomEvent("hitl-decision", {
-						detail: { decisions: [decision] },
-					});
-					window.dispatchEvent(event);
-				}}
 			/>
 		);
 	}