fix(host-service,cli): repair workspaces whose worktree moved (#6791)

apps/docs/content/docs/cli/cli-reference.mdx

@@ -708,6 +708,7 @@ superset workspaces get --field branch   # inside a workspace
 		{ flag: "--name <name>", description: "New workspace name." },
 		{ flag: "--task-id <id>", description: "Link the workspace to a task by id." },
 		{ flag: "--clear-task", description: "Unlink the workspace from its current task. Mutually exclusive with --task-id." },
+		{ flag: "--worktree-path <path>", description: "Re-point the workspace at a worktree that was moved on disk. The path must be a worktree of the project on the workspace's branch." },
 	]}
 	output="Workspace"
 >
@@ -717,7 +718,12 @@ Update a workspace on its host (default: this machine).
 superset workspaces update ws_… --name "better-name"
 superset workspaces update ws_… --task-id tsk_…
 superset workspaces update ws_… --clear-task
+superset workspaces update ws_… --worktree-path ~/repo/.worktrees/feature
 ```
+
+A workspace whose worktree was relocated with `git worktree move` is also repaired
+automatically the next time it is opened or fetched with `workspaces get`, as long as
+the branch still appears in `git worktree list` for the project.
 </Command>
 
 <Command

packages/cli/src/commands/workspaces/update/command.ts

@@ -1,3 +1,4 @@
+import { resolve } from "node:path";
 import { boolean, CLIError, positional, string } from "@superset/cli-framework";
 import { getHostId } from "@superset/shared/host-info";
 import { command } from "../../../lib/command";
@@ -11,6 +12,9 @@ export default command({
 		name: string().desc("Workspace name"),
 		taskId: string().desc("Link the workspace to a task by id"),
 		clearTask: boolean().desc("Unlink the workspace from its current task"),
+		worktreePath: string().desc(
+			"Re-point the workspace at a worktree that was moved on disk",
+		),
 	},
 	run: async ({ ctx, args, options }) => {
 		const id = args.id as string;
@@ -32,10 +36,14 @@ export default command({
 				? options.taskId
 				: undefined;
 
-		if (options.name === undefined && taskId === undefined) {
+		if (
+			options.name === undefined &&
+			taskId === undefined &&
+			options.worktreePath === undefined
+		) {
 			throw new CLIError(
 				"No fields to update",
-				"Pass --name, --task-id, or --clear-task",
+				"Pass --name, --task-id, --clear-task, or --worktree-path",
 			);
 		}
 
@@ -49,6 +57,9 @@ export default command({
 			id,
 			...(options.name !== undefined ? { name: options.name } : {}),
 			...(taskId !== undefined ? { taskId } : {}),
+			...(options.worktreePath !== undefined
+				? { worktreePath: resolve(options.worktreePath) }
+				: {}),
 		});
 
 		return {

packages/host-service/src/trpc/router/workspace/workspace.ts

@@ -8,25 +8,30 @@ import {
 	toCloudShape,
 	updateLocalWorkspace,
 } from "../../../workspaces/local-workspace-store";
+import {
+	repairMovedWorktree,
+	validateWorktreePathUpdate,
+} from "../../../workspaces/moved-worktree";
 import { protectedProcedure, router } from "../../index";
 import { resolveWorktreePath } from "../git/utils/resolve-worktree";
 import { destroyWorkspace } from "../workspace-cleanup";
 
 export const workspaceRouter = router({
 	get: protectedProcedure
 		.input(z.object({ id: z.string() }))
-		.query(({ ctx, input }) => {
-			const localWorkspace = ctx.db.query.workspaces
+		.query(async ({ ctx, input }) => {
+			const stored = ctx.db.query.workspaces
 				.findFirst({ where: eq(workspaces.id, input.id) })
 				.sync();
 
-			if (!localWorkspace) {
+			if (!stored) {
 				throw new TRPCError({
 					code: "NOT_FOUND",
 					message: "Workspace not found",
 				});
 			}
 
+			const localWorkspace = await repairMovedWorktree(ctx, stored);
 			return {
 				...localWorkspace,
 				worktreeExists: existsSync(localWorkspace.worktreePath),
@@ -84,6 +89,8 @@ export const workspaceRouter = router({
 	 * row commits and broadcasts immediately; the cloud mirror push is
 	 * best-effort (the reconciler retries when unreachable). `branch` only
 	 * re-points the record — callers rename the git branch themselves.
+	 * `worktreePath` re-points a workspace whose worktree was moved on disk;
+	 * the path must be a worktree of the project on the workspace's branch.
 	 */
 	update: protectedProcedure
 		.input(
@@ -92,6 +99,7 @@ export const workspaceRouter = router({
 				name: z.string().min(1).optional(),
 				branch: z.string().min(1).optional(),
 				taskId: z.string().uuid().nullable().optional(),
+				worktreePath: z.string().min(1).optional(),
 			}),
 		)
 		.mutation(async ({ ctx, input }) => {
@@ -111,11 +119,29 @@ export const workspaceRouter = router({
 						'The local workspace cannot be renamed — it always displays as "local".',
 				});
 			}
-			const patch: { name?: string; branch?: string; taskId?: string | null } =
-				{};
+			const patch: {
+				name?: string;
+				branch?: string;
+				taskId?: string | null;
+				worktreePath?: string;
+			} = {};
 			if (input.name !== undefined) patch.name = input.name;
 			if (input.branch !== undefined) patch.branch = input.branch;
 			if (input.taskId !== undefined) patch.taskId = input.taskId;
+			if (input.worktreePath !== undefined) {
+				const validated = await validateWorktreePathUpdate(
+					ctx,
+					current,
+					input.worktreePath,
+				);
+				if (!validated.ok) {
+					throw new TRPCError({
+						code: "BAD_REQUEST",
+						message: validated.message,
+					});
+				}
+				patch.worktreePath = validated.worktreePath;
+			}
 			if (Object.keys(patch).length === 0) {
 				return toCloudShape(current, ctx.organizationId);
 			}

packages/host-service/src/workers/tasks/git.ts

@@ -26,6 +26,7 @@ import { getGitStatusSnapshot } from "../../trpc/router/git/utils/git-status.ts"
 import {
 	normalizeWorktreePath,
 	parseWorktreeList,
+	type WorktreeRecord,
 } from "../../trpc/router/workspace-creation/shared/worktree-list.ts";
 import { defineWorkerTask } from "../define-worker-task.ts";
 
@@ -224,6 +225,19 @@ export const gitWorktreeRemoveTask = defineWorkerTask<
 	},
 });
 
+export const gitWorktreeListTask = defineWorkerTask<
+	{ repoPath: string; gitEnv: GitTaskEnv },
+	WorktreeRecord[]
+>({
+	type: "git/listWorktrees",
+	handler: async ({ repoPath, gitEnv }) => {
+		const git = createUserSimpleGit(repoPath).env(gitEnv);
+		return parseWorktreeList(
+			await git.raw(["worktree", "list", "--porcelain"]),
+		);
+	},
+});
+
 export const gitDeleteBranchTask = defineWorkerTask<
 	{ repoPath: string; branch: string; gitEnv: GitTaskEnv },
 	{ deleted: boolean }
@@ -251,5 +265,6 @@ export const gitTasks = [
 	gitIdentityTask,
 	gitWorktreeStateTask,
 	gitWorktreeRemoveTask,
+	gitWorktreeListTask,
 	gitDeleteBranchTask,
 ];