【架构优化】合并 gitwork/workbranch.go 中 push/pull 重复的非工作分支严格校验为 verifyOffWorkBranch

未關閉
#451 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

@fx-kurumi 已經在處理了。

開始於 2026年11月13日。

  • #452 來自 @fx-kurumi —— 未關閉

評估

難度
2/5
預估耗時
1-3 小時
新手友好度
15/100
Issue 類型
重構
描述清晰度
描述清楚
活躍度
停滯
技術堆疊
git, go
領域
tooling

研究方向

The duplicated block sits at the top of pushWorkBranch and pullWorkBranch in internal/gitwork/workbranch.go. Read how onWorkBranch and fetchExistingWorkBranch are used there, then check whether PR #452 already covers this refactor before starting. Done means a package-private verifyOffWorkBranch with unchanged error text and order, plus unit tests in internal/gitwork/ passing.

由索引模型根據 Issue 內容生成。

描述

现状问题

internal/gitwork/workbranch.go 中 pushWorkBranch 与 pullWorkBranch 开头有一段逐字相同的分支:

if !onWorkBranch(ctx, workspace, branch) {
    if requireExisting {
        if _, err := fetchExistingWorkBranch(ctx, workspace, branch); err != nil {
            return "", err
        }
        if current, _ := C(ctx, workspace, "branch", "--show-current"); strings.TrimSpace(current) != branch {
            return "", fmt.Errorf("工作区未检出已有工作分支 %s", branch)
        }
    }
    return "", nil
}

即“不在工作分支上(或有 merge/rebase 进行中)时跳过,但严格模式仍要校验远端分支存在且已检出”。两份副本必须同步维护,任何一边改动报错文字或校验顺序都会造成 push/pull 行为分叉。

重构方案

抽出包内私有函数:

// verifyOffWorkBranch 处理工作区不在工作分支上的情况:
// 非严格模式直接放行;严格模式仍校验远端分支存在且当前已检出它。
func verifyOffWorkBranch(ctx context.Context, workspace, branch string, requireExisting bool) error

pushWorkBranch / pullWorkBranch 改为:

if !onWorkBranch(ctx, workspace, branch) {
    // (push 侧保留原有注释)
    return "", verifyOffWorkBranch(ctx, workspace, branch, requireExisting)
}

报错文字、校验顺序、返回值完全不变。

影响范围

  • 仅 internal/gitwork/workbranch.go 内部两个私有函数;
  • 对外 PushWorkBranch / PushExistingWorkBranch / PullWorkBranch / PullExistingWorkBranch 签名与行为不变,调用方无需改动。

验证方式

  • 新增 verifyOffWorkBranch 单元测试:非严格模式放行;严格模式远端分支不存在报错;严格模式远端存在但未检出报「工作区未检出已有工作分支」;已检出时通过;
  • gofmt、go vet ./internal/gitwork/、go test ./internal/gitwork/ ./internal/runner/ 通过。
主要語言
Go
星號
141
分支
28
平均合併
1 天 15 小時
30 天內合併 PR
113

環境準備

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

Tencent/LoopForge 的其他 Issue

查看 Tencent/LoopForge 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。