Skip to content

fix(host-service): adopt existing worktree at any path on workspace.create #4096

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Kitenite merged 4 commits into from
May 5, 2026
Merged

fix(host-service): adopt existing worktree at any path on workspace.create #4096

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cbf2dd8
fix(host-service): adopt existing worktree at any path on workspace.c…
Kitenite May 5, 2026
a768e82
refactor(host-service): unify workspace adoption behind one shared he…
Kitenite May 5, 2026
3049ee2
fix(host-service): handle prunable worktrees in workspaces.create
Kitenite May 5, 2026
af2cd5a
chore(host-service): tighten comments in worktree-adoption code
Kitenite May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion bun.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

34 changes: 18 additions & 16 deletions packages/host-service/src/trpc/router/workspaces/workspaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import type { HostServiceContext } from "../../../types";
import { protectedProcedure, router } from "../../index";
import { type AgentRunResult, runAgentInWorkspace } from "../agents";
import { ensureMainWorkspace } from "../project/utils/ensure-main-workspace";
import { getWorktreeBranchAtPath } from "../workspace-creation/shared/branch-search";
import { listWorktreeBranches } from "../workspace-creation/shared/branch-search";
import { enablePushAutoSetupRemote } from "../workspace-creation/shared/git-config";
import { requireLocalProject } from "../workspace-creation/shared/local-project";
import { startSetupTerminalIfPresent } from "../workspace-creation/shared/setup-terminal";
Expand Down Expand Up @@ -708,21 +708,23 @@ export const workspacesRouter = router({
workspaceRow = existing;
alreadyExists = true;
} else {
worktreePath = safeResolveWorktreePath(
localProject.id,
resolvedBranch,
);

// Adopt: a worktree already exists at the standard path with the
// matching branch checked out (e.g. left behind by a prior session
// or registered outside Superset). Skip `git worktree add` and
// proceed straight to register. Only meaningful when the user
// supplied the branch — auto-gen names are deduped and can't
// collide with anything pre-existing.
const adopted =
!!typedBranch &&
(await getWorktreeBranchAtPath(git, worktreePath)) ===
resolvedBranch;
// Adopt: a worktree already exists for this branch (at the
// standard path, or anywhere else git has registered it — e.g.
// left behind by a prior session, created outside Superset, or
// renamed in place). Skip `git worktree add`; git refuses to
// check out a branch into a second worktree, so failing here
// would block the user from re-entering their own work. Only
// meaningful when the user supplied the branch — auto-gen
// names are deduped and can't collide with anything pre-existing.
const existingWorktreePath = typedBranch
? (await listWorktreeBranches(git)).worktreeMap.get(
resolvedBranch,
)
: undefined;
const adopted = !!existingWorktreePath;
worktreePath =
existingWorktreePath ??
safeResolveWorktreePath(localProject.id, resolvedBranch);

@greptile-apps greptile-apps Bot May 5, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Stale/prunable worktrees can be adopted as worktreePath

listWorktreeBranches iterates all worktrees — including ones marked prunable (directory deleted without git worktree remove). When such a stale entry exists for resolvedBranch, existingWorktreePath is set to the now-missing path, adopted = true skips git worktree add, and the subsequent enablePushAutoSetupRemote(git, worktreePath, …) runs against a directory that no longer exists, likely throwing. Before this PR the same risk existed only at the canonical path; now it applies to any registered path. Filtering wt.prunable != null entries in listWorktreeBranches (or inline here) would prevent this.

Prompt To Fix With AI 
This is a comment left during a code review.
Path: packages/host-service/src/trpc/router/workspaces/workspaces.ts
Line: 719-727

Comment:
**Stale/prunable worktrees can be adopted as `worktreePath`**

`listWorktreeBranches` iterates all worktrees — including ones marked `prunable` (directory deleted without `git worktree remove`). When such a stale entry exists for `resolvedBranch`, `existingWorktreePath` is set to the now-missing path, `adopted = true` skips `git worktree add`, and the subsequent `enablePushAutoSetupRemote(git, worktreePath, …)` runs against a directory that no longer exists, likely throwing. Before this PR the same risk existed only at the canonical path; now it applies to any registered path. Filtering `wt.prunable != null` entries in `listWorktreeBranches` (or inline here) would prevent this.

How can I resolve this? If you propose a fix, please make it concise.


mkdirSync(dirname(worktreePath), { recursive: true });

Expand Down
42 changes: 42 additions & 0 deletions packages/host-service/test/integration/workspace-create-delete.integration.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { afterEach, describe, expect, test } from "bun:test";
import { randomUUID } from "node:crypto";
import { existsSync } from "node:fs";
import { join } from "node:path";
import { TRPCClientError } from "@trpc/client";
import { eq } from "drizzle-orm";
import { workspaces } from "../../src/db/schema";
Expand Down Expand Up @@ -49,6 +50,47 @@ describe("workspace.create + workspace.delete integration", () => {
expect(existsSync(persisted?.worktreePath ?? "")).toBe(true);
});

test("create() adopts an existing worktree at a non-canonical path instead of failing on `git worktree add`", async () => {
// Regress: when the user typed a branch that already has a worktree
// somewhere outside `~/.superset/worktrees/<projectId>/<branch>`,
// `workspaces.create` used to call `git worktree add` and crash with
// `fatal: '<branch>' is already used by worktree at ...`. Adopt the
// existing path instead.
const scenario = await createProjectScenario({
hostOptions: { apiOverrides: cloudFlows.workspaceCreateOk() },
});
dispose = scenario.dispose;

const branch = "new-workspace-9";
const nonCanonicalPath = join(
scenario.repo.repoPath,
".worktrees",
"glorious-ground",
);
await scenario.repo.git.raw([
"worktree",
"add",
"-b",
branch,
nonCanonicalPath,
]);

const result = await scenario.host.trpc.workspaces.create.mutate({
projectId: scenario.projectId,
name: "adopted",
branch,
});

expect(result?.workspace?.branch).toBe(branch);
const persisted = scenario.host.db
.select()
.from(workspaces)
.where(eq(workspaces.id, result?.workspace?.id ?? ""))
.get();
expect(persisted?.worktreePath).toBe(nonCanonicalPath);
expect(existsSync(nonCanonicalPath)).toBe(true);
});

test("create() rolls back the worktree if cloud v2Workspace.create fails", async () => {
const scenario = await createProjectScenario({
hostOptions: {
Expand Down
Loading