Handle correctly the initialization of a repository on adding a non-git directory

Author: estib-vega

apps/desktop/src/components/ChromeHeader.svelte

@@ -8,8 +8,8 @@
 	import { ircEnabled } from '$lib/config/uiFeatureFlags';
 	import { IRC_SERVICE } from '$lib/irc/ircService.svelte';
 	import { MODE_SERVICE } from '$lib/mode/modeService';
-	import { handleAddProjectOutcome } from '$lib/project/project';
 	import { PROJECTS_SERVICE } from '$lib/project/projectsService';
+	import { useAddProject } from '$lib/project/useProjects.svelte';
 	import { ircPath, projectPath, isWorkspacePath } from '$lib/routes/routes.svelte';
 	import { UI_STATE } from '$lib/state/uiState.svelte';
 	import { inject } from '@gitbutler/core/context';
@@ -47,6 +47,8 @@
 	const singleBranchMode = $derived($settingsStore?.featureFlags.singleBranch ?? false);
 	const backend = inject(BACKEND);
 
+	const { addProject } = useAddProject();
+
 	const mode = $derived(modeService.mode({ projectId }));
 	const currentMode = $derived(mode.response);
 	const currentBranchName = $derived.by(() => {
@@ -188,14 +190,7 @@
 						onClick={async () => {
 							newProjectLoading = true;
 							try {
-								const outcome = await projectsService.addProject();
-								if (!outcome) {
-									// User cancelled the project creation
-									newProjectLoading = false;
-									return;
-								}
-
-								handleAddProjectOutcome(outcome, (project) => goto(projectPath(project.id)));
+								await addProject();
 							} finally {
 								newProjectLoading = false;
 							}

apps/desktop/src/components/CloneForm.svelte

@@ -5,9 +5,7 @@
 	import { OnboardingEvent, POSTHOG_WRAPPER } from '$lib/analytics/posthog';
 	import { BACKEND } from '$lib/backend';
 	import { GIT_SERVICE } from '$lib/git/gitService';
-	import { handleAddProjectOutcome } from '$lib/project/project';
-	import { PROJECTS_SERVICE } from '$lib/project/projectsService';
-	import { projectPath } from '$lib/routes/routes.svelte';
+	import { useAddProject } from '$lib/project/useProjects.svelte';
 	import { parseRemoteUrl } from '$lib/url/gitUrl';
 	import { inject } from '@gitbutler/core/context';
 	import { persisted } from '@gitbutler/shared/persisted';
@@ -16,7 +14,6 @@
 	import * as Sentry from '@sentry/sveltekit';
 	import { onMount } from 'svelte';
 
-	const projectsService = inject(PROJECTS_SERVICE);
 	const gitService = inject(GIT_SERVICE);
 	const posthog = inject(POSTHOG_WRAPPER);
 	const backend = inject(BACKEND);
@@ -62,6 +59,14 @@
 		return String(error);
 	}
 
+	const { addProject } = useAddProject(() => {
+		posthog.captureOnboarding(
+			OnboardingEvent.ClonedProjectFailed,
+			'Failed to add project after cloning'
+		);
+		throw new Error('Failed to add project after cloning.');
+	});
+
 	async function cloneRepository() {
 		loading = true;
 		savedTargetDirPath.set(targetDirPath);
@@ -88,16 +93,7 @@
 			await gitService.cloneRepo(repositoryUrl, targetDir);
 
 			posthog.captureOnboarding(OnboardingEvent.ClonedProject);
-			const outcome = await projectsService.addProject(targetDir);
-			if (!outcome) {
-				posthog.captureOnboarding(
-					OnboardingEvent.ClonedProjectFailed,
-					'Failed to add project after cloning'
-				);
-				throw new Error('Failed to add project after cloning.');
-			}
-
-			handleAddProjectOutcome(outcome, (project) => goto(projectPath(project.id)));
+			await addProject(targetDir);
 		} catch (e) {
 			Sentry.captureException(e);
 			const errorMessage = getErrorMessage(e);

apps/desktop/src/components/FileMenuAction.svelte

@@ -1,24 +1,19 @@
 <script lang="ts">
 	import { goto } from '$app/navigation';
-	import { handleAddProjectOutcome } from '$lib/project/project';
-	import { PROJECTS_SERVICE } from '$lib/project/projectsService';
-	import { clonePath, projectPath } from '$lib/routes/routes.svelte';
+	import { useAddProject } from '$lib/project/useProjects.svelte';
+	import { clonePath } from '$lib/routes/routes.svelte';
 	import { SHORTCUT_SERVICE } from '$lib/shortcuts/shortcutService';
 	import { inject } from '@gitbutler/core/context';
 	import { mergeUnlisten } from '@gitbutler/ui/utils/mergeUnlisten';
 
-	const projectsService = inject(PROJECTS_SERVICE);
 	const shortcutService = inject(SHORTCUT_SERVICE);
 
+	const { addProject } = useAddProject();
+
 	$effect(() =>
 		mergeUnlisten(
 			shortcutService.on('add-local-repo', async () => {
-				const outcome = await projectsService.addProject();
-				if (!outcome) {
-					// User cancelled the project creation
-					return;
-				}
-				handleAddProjectOutcome(outcome, (project) => goto(projectPath(project.id)));
+				await addProject();
 			}),
 			shortcutService.on('clone-repo', async () => {
 				goto(clonePath());

apps/desktop/src/components/ProjectSwitcher.svelte

@@ -1,7 +1,7 @@
 <script lang="ts">
 	import { goto } from '$app/navigation';
-	import { handleAddProjectOutcome } from '$lib/project/project';
 	import { PROJECTS_SERVICE } from '$lib/project/projectsService';
+	import { useAddProject } from '$lib/project/useProjects.svelte';
 	import { projectPath } from '$lib/routes/routes.svelte';
 	import { inject } from '@gitbutler/core/context';
 	import { Button, OptionsGroup, Select, SelectItem } from '@gitbutler/ui';
@@ -22,6 +22,8 @@
 
 	let newProjectLoading = $state(false);
 	let cloneProjectLoading = $state(false);
+
+	const { addProject } = useAddProject();
 </script>
 
 <div class="project-switcher">
@@ -48,13 +50,7 @@
 				onClick={async () => {
 					newProjectLoading = true;
 					try {
-						const outcome = await projectsService.addProject();
-						if (!outcome) {
-							// User cancelled the project creation
-							newProjectLoading = false;
-							return;
-						}
-						handleAddProjectOutcome(outcome, (project) => goto(projectPath(project.id)));
+						await addProject();
 					} finally {
 						newProjectLoading = false;
 					}

apps/desktop/src/components/Welcome.svelte

@@ -6,6 +6,7 @@
 	import { OnboardingEvent, POSTHOG_WRAPPER } from '$lib/analytics/posthog';
 	import cloneRepoSvg from '$lib/assets/welcome/clone-repo.svg?raw';
 	import newProjectSvg from '$lib/assets/welcome/new-local-project.svg?raw';
+	import { showToast } from '$lib/notifications/toasts';
 	import { handleAddProjectOutcome } from '$lib/project/project';
 	import { PROJECTS_SERVICE } from '$lib/project/projectsService';
 	import { inject } from '@gitbutler/core/context';
@@ -17,23 +18,33 @@
 	let newProjectLoading = $state(false);
 	let directoryInputElement = $state<HTMLInputElement | undefined>();
 
-	async function onNewProject() {
-		newProjectLoading = true;
+	async function addProject(path: string) {
 		try {
-			const testDirectoryPath = directoryInputElement?.value;
-			const outcome = await projectsService.addProject(testDirectoryPath ?? '');
-
+			const outcome = await projectsService.addProject(path);
 			posthog.captureOnboarding(OnboardingEvent.AddLocalProject);
+
 			if (outcome) {
-				handleAddProjectOutcome(outcome);
+				handleAddProjectOutcome(outcome, async (path: string) => {
+					await projectsService.initGitRepository(path);
+					showToast({
+						title: 'Repository Initialized',
+						message: `Git repository has been successfully initialized at ${path}. Loading project...`,
+						style: 'info'
+					});
+					await addProject(path);
+				});
 			}
 		} catch (e: unknown) {
 			posthog.captureOnboarding(OnboardingEvent.AddLocalProjectFailed, e);
-		} finally {
-			newProjectLoading = false;
 		}
 	}
 
+	async function onNewProject() {
+		newProjectLoading = true;
+		await addProject(directoryInputElement?.value ?? '');
+		newProjectLoading = false;
+	}
+
 	async function onCloneProject() {
 		goto('/onboarding/clone');
 	}

apps/desktop/src/lib/project/project.ts

@@ -1,5 +1,5 @@
 import { goto } from '$app/navigation';
-import { showError, showToast } from '$lib/notifications/toasts';
+import { showToast } from '$lib/notifications/toasts';
 import { projectPath } from '$lib/routes/routes.svelte';
 import { TestId } from '@gitbutler/ui';
 import type { ForgeName } from '$lib/forge/interface/forge';
@@ -85,15 +85,19 @@ export type AddProjectOutcome =
 			/**
 			 * The error message received
 			 */
-			subject: string;
+			subject: {
+				path: string;
+				message: string;
+			};
 	  };
 
 /**
  * Correctly handle the outcome of an addProject operation by passing the project to the callback or
- * showing toasts as necessary.
+ * showing toasts as necessary.'get this - needs a refactor probably';
  */
 export function handleAddProjectOutcome(
 	outcome: AddProjectOutcome,
+	onInitialize: (path: string) => Promise<void>,
 	onAdded?: (project: Project) => void
 ): true {
 	switch (outcome.type) {
@@ -169,23 +173,9 @@ export function handleAddProjectOutcome(
 				extraAction: {
 					label: 'Initialize Repository',
 					onClick: async (dismiss) => {
-						try {
-							const projectPath = 'get this - needs a refactor probably';
-							await projectsService.initGitRepository(projectPath);
-							dismiss();
-							showToast({
-								title: 'Repository Initialized',
-								message: `Git repository has been successfully initialized at ${projectPath}. Loading project...`,
-								style: 'info'
-							});
-							const projectId = 'TODO: get this from somewhere';
-							// Retry setting the project active
-							await setActiveProjectOrRedirect(projectId);
-						} catch (initError) {
-							console.error('Failed to initialize repository:', initError);
-							dismiss();
-							showError('Failed to initialize repository', initError);
-						}
+						const projectPath = outcome.subject.path;
+						await onInitialize(projectPath);
+						dismiss();
 					}
 				}
 			});

apps/desktop/src/lib/project/useProjects.svelte.ts

@@ -0,0 +1,34 @@
+import { goto } from '$app/navigation';
+import { showToast } from '$lib/notifications/toasts';
+import { handleAddProjectOutcome } from '$lib/project/project';
+import { PROJECTS_SERVICE } from '$lib/project/projectsService';
+import { projectPath } from '$lib/routes/routes.svelte';
+import { inject } from '@gitbutler/core/context';
+
+export function useAddProject(onMissingOutcome?: () => void) {
+	const projectsService = inject(PROJECTS_SERVICE);
+
+	async function addProject(path?: string) {
+		const outcome = await projectsService.addProject(path);
+
+		if (outcome) {
+			handleAddProjectOutcome(
+				outcome,
+				async (path: string) => {
+					await projectsService.initGitRepository(path);
+					showToast({
+						title: 'Repository Initialized',
+						message: `Git repository has been successfully initialized at ${path}. Loading project...`,
+						style: 'info'
+					});
+					await addProject(path);
+				},
+				(project) => goto(projectPath(project.id))
+			);
+		} else {
+			onMissingOutcome?.();
+		}
+	}
+
+	return { addProject };
+}

crates/gitbutler-project/src/controller.rs

@@ -4,7 +4,10 @@ use anyhow::{anyhow, bail, Context, Result};
 use gitbutler_error::error;
 
 use super::{storage, storage::UpdateRequest, Project, ProjectId};
-use crate::{project::AddProjectOutcome, AuthKey};
+use crate::{
+    project::{AddProjectOutcome, NotAGitRepositoryOutcome},
+    AuthKey,
+};
 
 #[derive(Clone, Debug)]
 pub(crate) struct Controller {
@@ -97,7 +100,12 @@ impl Controller {
                 }
             },
             Err(err) => {
-                return Ok(AddProjectOutcome::NotAGitRepository(err.to_string()));
+                return Ok(AddProjectOutcome::NotAGitRepository(
+                    NotAGitRepositoryOutcome {
+                        path: path.to_path_buf(),
+                        message: err.to_string(),
+                    },
+                ));
             }
         }
 

crates/gitbutler-project/src/project.rs

@@ -183,6 +183,12 @@ impl Project {
     }
 }
 
+#[derive(Debug, Serialize, Deserialize, Clone)]
+pub struct NotAGitRepositoryOutcome {
+    pub path: PathBuf,
+    pub message: String,
+}
+
 #[derive(Debug, Serialize, Deserialize, Clone, strum::Display)]
 #[serde(rename_all = "camelCase", tag = "type", content = "subject")]
 pub enum AddProjectOutcome {
@@ -194,7 +200,7 @@ pub enum AddProjectOutcome {
     NonMainWorktree,
     NoWorkdir,
     NoDotGitDirectory,
-    NotAGitRepository(String),
+    NotAGitRepository(NotAGitRepositoryOutcome),
 }
 
 impl AddProjectOutcome {
@@ -229,7 +235,7 @@ impl AddProjectOutcome {
                 Err(anyhow::anyhow!("no .git directory found in repository"))
             }
             AddProjectOutcome::NotAGitRepository(msg) => {
-                Err(anyhow::anyhow!("not a git repository: {}", msg))
+                Err(anyhow::anyhow!("not a git repository: {}", msg.message))
             }
         }
     }