diff --git a/packages/server/src/server/plugins/worktree-manager.e2e.test.ts b/packages/server/src/server/plugins/worktree-manager.e2e.test.ts index 5d3f7ce529..6d2b933d85 100644 --- a/packages/server/src/server/plugins/worktree-manager.e2e.test.ts +++ b/packages/server/src/server/plugins/worktree-manager.e2e.test.ts @@ -42,7 +42,7 @@ async function createFakeWorktrunkCli(dir: string, logFile: string): Promise; deps: Pick; -}): Promise { +}): Promise<{ worktree: CreatedWorktree | null; preparedBranchOff?: PreparedWorktreeBranchOff }> { const { repoRoot, transformed, intent, input, deps } = options; const untrusted = isUntrustedWorktreeCreationIntent(intent); - const createRequest: PluginWorktreeCreateInput = { ...transformed, untrusted }; - return runPluginWorktreeManagerCheckout({ + let preparedBranchOff: PreparedWorktreeBranchOff | undefined; + const worktree = await runPluginWorktreeManagerCheckout({ cwd: repoRoot, source: intent, operation: "create", @@ -211,8 +214,16 @@ async function tryCreateWithWorktreeManager(options: { paseoHome: input.paseoHome, worktreesBaseRoot: input.worktreesRoot, worktreeManagers: deps.worktreeManagers, - run: () => deps.worktreeManagers!.createWorktree(createRequest), + run: async () => { + let request: PluginWorktreeCreateInput = { ...transformed, untrusted }; + if (request.kind === "branch-off" && intent.kind === "branch-off") { + preparedBranchOff = await prepareWorktreeBranchOff(repoRoot, intent); + request = { ...request, baseRef: preparedBranchOff.baseRef }; + } + return deps.worktreeManagers!.createWorktree(request); + }, }); + return { worktree, preparedBranchOff }; } function describeCreationRequest( diff --git a/packages/server/src/utils/worktree.ts b/packages/server/src/utils/worktree.ts index 37a4df8a02..39d901d41f 100644 --- a/packages/server/src/utils/worktree.ts +++ b/packages/server/src/utils/worktree.ts @@ -231,10 +231,17 @@ export type WorktreeSource = trackOriginHead?: boolean; }; +export interface PreparedWorktreeBranchOff { + baseRef: string; + checkoutRef: string; + branchExists: boolean; +} + export interface CreateWorktreeOptions { cwd: string; worktreeSlug: string; source: WorktreeSource; + preparedBranchOff?: PreparedWorktreeBranchOff; paseoHome?: string; worktreesRoot?: string; worktreePath?: string; @@ -1589,6 +1596,7 @@ export function createWorktree( export async function createWorktree({ cwd, source, + preparedBranchOff, worktreeSlug, paseoHome, worktreesRoot, @@ -1602,7 +1610,12 @@ export async function createWorktree({ source.kind === "checkout-github-pr" ? await listLocalBranchNames(cwd) : new Set(); - const sourcePlan = await resolveWorktreeSourcePlan({ cwd, source, desiredSlug: worktreeSlug }); + const sourcePlan = await resolveWorktreeSourcePlan({ + cwd, + source, + desiredSlug: worktreeSlug, + preparedBranchOff, + }); const fetchedBranch = planCreatedLocalBranch(source, sourcePlan); const fetchedTip = fetchedBranch && !branchesBefore.has(fetchedBranch) @@ -2033,6 +2046,7 @@ interface ResolveWorktreeSourcePlanOptions { cwd: string; source: WorktreeSource; desiredSlug: string; + preparedBranchOff?: PreparedWorktreeBranchOff; } interface WorktreeSourcePlan { @@ -2105,30 +2119,46 @@ async function resolveRestoredWorktreeFromBasePlan( }; } +export async function prepareWorktreeBranchOff( + cwd: string, + source: Extract, + previous?: PreparedWorktreeBranchOff, +): Promise { + const baseRef = previous?.baseRef ?? (await resolveBaseBranchForWorktree(cwd, source.baseBranch)); + const branchExists = await localBranchExists(cwd, source.branchName); + const checkoutRef = branchExists ? source.branchName : (source.startPoint ?? baseRef); + if (checkoutRef !== previous?.checkoutRef) { + await refreshRemoteTrackingBaseRef(cwd, checkoutRef); + } + return { baseRef, branchExists, checkoutRef }; +} + async function resolveBranchOffWorktreeSourcePlan( cwd: string, source: Extract, desiredSlug: string, + preparedBranchOff?: PreparedWorktreeBranchOff, ): Promise { const branchName = source.branchName; await validateGitBranchName(cwd, branchName); - const resolvedBaseBranch = await resolveBaseBranchForWorktree(cwd, source.baseBranch); - const branchExists = await localBranchExists(cwd, branchName); - const base = branchExists ? branchName : (source.startPoint ?? resolvedBaseBranch); - await refreshRemoteTrackingBaseRef(cwd, base); + const { baseRef, branchExists, checkoutRef } = await prepareWorktreeBranchOff( + cwd, + source, + preparedBranchOff, + ); const candidateBranch = branchExists ? desiredSlug : branchName; const newBranchName = await resolveUniqueLocalBranchName(cwd, candidateBranch); const metadata = await resolveWorktreeMetadata({ cwd, source, branchName: newBranchName, - resolvedBaseRef: resolvedBaseBranch, + resolvedBaseRef: baseRef, }); return { branchName: newBranchName, ...metadata, - addArguments: ["-b", newBranchName, "--no-track", base], + addArguments: ["-b", newBranchName, "--no-track", checkoutRef], }; } @@ -2136,10 +2166,11 @@ async function resolveWorktreeSourcePlan({ cwd, source, desiredSlug, + preparedBranchOff, }: ResolveWorktreeSourcePlanOptions): Promise { switch (source.kind) { case "branch-off": - return resolveBranchOffWorktreeSourcePlan(cwd, source, desiredSlug); + return resolveBranchOffWorktreeSourcePlan(cwd, source, desiredSlug, preparedBranchOff); case "restore": return resolveRestoredWorktreeSourcePlan(cwd, source); case "restore-commit": diff --git a/plugin-examples/worktrunk/server/wt.ts b/plugin-examples/worktrunk/server/wt.ts index 3f76c39f3d..4be70d3e36 100644 --- a/plugin-examples/worktrunk/server/wt.ts +++ b/plugin-examples/worktrunk/server/wt.ts @@ -15,6 +15,8 @@ export const WAITING_MARKER = "💬"; interface SwitchJsonOutput { path: string; action?: string; + branch?: string; + createdBranch: boolean; } /** @@ -73,10 +75,17 @@ async function runWt( function tryParseSwitchOutput(stdout: string | undefined): SwitchJsonOutput | null { if (!stdout?.trim()) return null; try { - const parsed = JSON.parse(stdout) as { path?: unknown; action?: unknown }; + const parsed = JSON.parse(stdout) as { + path?: unknown; + action?: unknown; + branch?: unknown; + created_branch?: unknown; + }; if (typeof parsed.path !== "string" || parsed.path.length === 0) return null; return { path: parsed.path, + createdBranch: parsed.created_branch === true, + ...(typeof parsed.branch === "string" && parsed.branch ? { branch: parsed.branch } : {}), ...(typeof parsed.action === "string" ? { action: parsed.action } : {}), }; } catch { @@ -127,23 +136,30 @@ export function buildCreateArgs(request: PluginWorktreeCreateInput): string[] | } async function cleanupPartiallyCreatedWorktree(repoRoot: string, error: unknown): Promise { - // Worktrunk prints `{ path, action: "created" }` on stdout even when a later hook exits non-zero. + // Worktrunk reports the checkout and whether it created the branch even if a hook fails. const stdout = error instanceof Error && error.cause && typeof error.cause === "object" ? (error.cause as { stdout?: string }).stdout : undefined; const parsed = tryParseSwitchOutput(stdout); if (parsed?.action !== "created") return; - await runWt([ - "-C", - repoRoot, - "remove", - "--foreground", - "--no-delete-branch", - "--no-hooks", - "--force", - parsed.path, - ]).catch(() => {}); + try { + await runWt([ + "-C", + repoRoot, + "remove", + "--foreground", + "--no-delete-branch", + "--no-hooks", + "--force", + parsed.path, + ]); + if (parsed.createdBranch && parsed.branch) { + await execCommand("git", ["branch", "-D", "--", parsed.branch], { cwd: repoRoot }); + } + } catch { + // Keep the original setup error. + } } export async function createWithWorktrunk( diff --git a/public-docs/plugins/reference.md b/public-docs/plugins/reference.md index 15e8452364..ebec1d69bf 100644 --- a/public-docs/plugins/reference.md +++ b/public-docs/plugins/reference.md @@ -769,7 +769,9 @@ export default function contribute(server: PluginServerContext) { - **Create** runs after all `worktree.create.before` hooks and before `worktree.create.after`, with a 120-second timeout. Return `{ type: "created", path }` to claim creation, or `undefined` to decline - so the next manager or Paseo's built-in Git checkout runs. When `request.untrusted` is `true` (for + so the next manager or Paseo's built-in Git checkout runs. For branch-off, Paseo resolves + `baseRef` and refreshes a remote-tracking starting ref before calling the manager, using the + cached ref if the fetch fails. When `request.untrusted` is `true` (for example, a fork change request), skip repository-defined hooks. Paseo verifies that `path` is a safe, newly created Git worktree of the same repository on a named branch, then records the checked-out `HEAD` branch (managers may normalize or uniquely name the branch, and should create a diff --git a/public-docs/plugins/reference.zh-CN.md b/public-docs/plugins/reference.zh-CN.md index 8efb28a3ad..0c19526060 100644 --- a/public-docs/plugins/reference.zh-CN.md +++ b/public-docs/plugins/reference.zh-CN.md @@ -614,7 +614,7 @@ export default function contribute(server: PluginServerContext) { } ``` -- **Create**:在所有 `worktree.create.before` 钩子之后、`worktree.create.after` 之前运行,超时为 120 秒。返回 `{ type: "created", path }` 表示接管创建,返回 `undefined` 表示放弃并交由下一个管理器或 Paseo 内置 Git 检出处理。当 `request.untrusted` 为 `true`(例如来自 fork 变更请求)时,请跳过仓库内定义的钩子。Paseo 会验证 `path` 是同一仓库下新建且安全的命名分支 Git worktree,并记录实际检出的 `HEAD` 分支(管理器可自行规范或生成唯一分支名,但在 `branch-off` 时应创建新分支),随后写入基准元数据并生成 `paseo.json`。如果采纳或后续创建步骤失败,Paseo 会根据返回的路径回滚。回调在返回前抛出错误或收到中止信号时,由管理器清理自己创建的 worktree。由管理器创建的 worktree 会跳过首个 Agent 的分支自动重命名。 +- **Create**:在所有 `worktree.create.before` 钩子之后、`worktree.create.after` 之前运行,超时为 120 秒。返回 `{ type: "created", path }` 表示接管创建,返回 `undefined` 表示放弃并交由下一个管理器或 Paseo 内置 Git 检出处理。创建新分支时,Paseo 会在调用管理器前解析 `baseRef`,并刷新用作起点的远程跟踪引用。如果获取失败,则使用本地缓存的引用。当 `request.untrusted` 为 `true`(例如来自 fork 变更请求)时,请跳过仓库内定义的钩子。Paseo 会验证 `path` 是同一仓库下新建且安全的命名分支 Git worktree,并记录实际检出的 `HEAD` 分支(管理器可自行规范或生成唯一分支名,但在 `branch-off` 时应创建新分支),随后写入基准元数据并生成 `paseo.json`。如果采纳或后续创建步骤失败,Paseo 会根据返回的路径回滚。回调在返回前抛出错误或收到中止信号时,由管理器清理自己创建的 worktree。由管理器创建的 worktree 会跳过首个 Agent 的分支自动重命名。 - **Remove**:可选。在工作区归档和创建回滚时运行,位于 Paseo 执行 `paseo.json` 清理并保存 `refs/paseo/kept-commits/` 之后。删除目录后返回 `{ type: "removed" }`,或返回 `undefined` 回退到 Git。当 `untrusted` 为 `true`(例如来自 fork 变更请求)或 `repoRoot` 为 `null` 时,请跳过仓库内定义的钩子,并在可用时从 `repoRoot` 运行。Paseo 会将移除路由到创建该 worktree 的插件;若该插件已停用或移除,则回退到内置 Git。 - **Restore**:可选。在取消归档且 worktree 目录已被删除时运行,接收必须恢复到的原路径 `path`、目标 `target`(`branch`、`commit` 或 `from-base`)以及 `untrusted`。返回 `{ type: "restored", path }`,或返回 `undefined` 回退到 Git。Paseo 会验证检出结果是否为指定的分支、分离 HEAD 的提交,或位于指定基准提交的新分支。清理规则与 Create 相同。当 `restore` 回退到 Git 时,Paseo 会清除该工作区的管理器归属,后续归档也会使用 Git。