项目迁移已提交,回调才报错:after-commit 失败为何不该回写旧仓库路径
GitLab 合并请求 !271664 处理 commit_transfer 内 run_after_commit 块抛错的问题:该回调在 WithLockRetries 事务提交后运行,此时迁移已落库,若仍执行 rollback_side_effects 会把旧仓库路径写回,导致 TransferWorker 取消迁移并重试进死路。修复用 transaction.state.committed? 区分提交前后,提交后失败跳过回滚、上报错误跟踪,并继续执行 post-commit 步骤与 refresh_permissions。
直接回答标题:因为 run_after_commit 块运行时,项目迁移对应的数据库事务已经提交。此时“回滚副作用”并不能撤销已落库的迁移记录,却会把旧仓库路径重新写回,制造出数据库说已迁移、仓库却指向旧路径的不一致状态。正确做法是:提交后失败不回滚,只上报错误,并让迁移按完成处理。
本文依据 GitLab 合并请求 !271664 “Keep a project transfer when an after-commit callback raises” 的说明整理。该 MR 是 !262788 的后续:前者已停止在 commit_transfer 之后的步骤失败时回滚迁移,本次处理的是发生在 commit_transfer 内部的 run_after_commit 块失败。
失败路径长什么样#
按 MR 说明,迁移提交后,回调抛出的异常仍会被 Projects::TransferService#commit_transfer 里的 rescue Exception 捕获。修复前的链路是:
run_after_commit块在Gitlab::Database::WithLockRetries事务提交时运行,异常被commit_transfer的 rescue 捕获。- 代码执行
rollback_side_effects,把旧仓库路径写回。 Projects::TransferWorker据此取消迁移,创建一条 “transfer failed” 待办,然后重试。- 重试时撞上 “Project is already in this namespace”,因为迁移记录本身早已提交,取消并未真正撤销它。
问题核心不是“要不要吞掉异常”,而是“回滚动作是否还有意义”。事务已提交,回滚副作用只会制造新的不一致。
为什么不能用“块末尾设标志”判断#
一个直觉方案是在 Project.transaction 块末尾设置标志,表示“已经走完”。MR 说明指出这不可行:提交发生在最外层 WithLockRetries 事务结束时,而不是 Project.transaction 块末尾,所以块末尾的标志无法区分提交是否真的发生。
事务级 after_commit 回调同样不行——它们在记录级回调之后才运行,来不及为记录级回调设置判断依据。
修复采用的判断条件#
MR 使用的依据是:Rails 在运行记录的 after_commit 回调之前,已把事务标记为已提交,因此 transaction.state.committed? 只在“提交之后发生的失败”上为真。据此把失败分成两类:
| 失败时点 | 判断结果 | 处理方式 |
|---|---|---|
| 事务提交之前 | committed? 为假 | 仍然回滚,行为不变 |
事务提交之后(含 run_after_commit 抛错) | committed? 为真 | 跳过回滚,把错误送入错误跟踪(track_post_commit_failure,与其它 post-commit 步骤一致) |
修复后,这类失败下迁移被报告为完成,后续 post-commit 步骤和 refresh_permissions 仍会运行。换言之,异常不再阻断迁移结果,而是作为提交后故障被记录和追踪。
本地复现与验证步骤#
MR 给出了在 Rails 控制台手动触发该路径的做法。以下代码按 MR 描述转写,本次未实际执行,仅作为复现思路;具体方法名与可用性需以你所用 GitLab 版本为准(待核实):
service.define_singleton_method(:execute_system_hooks) {
super()
project.run_after_commit { raise 'boom' }
}
service.execute(group)
说明中提示,开发环境会通过 track_and_raise_for_dev_exception 把错误抛出,因此需要观察异常之后的状态,而不是期待调用静默返回。验证要点有两项:
project.reload.namespace应为目标组,说明迁移记录确实生效;project.project_repository.disk_path应等于project.disk_path,说明旧仓库路径没有被写回。
这两项检查正好对应修复目标:迁移结果保留,仓库路径与迁移后的记录一致。
适用条件与边界#
- 该修复针对
commit_transfer内部、事务提交后触发的回调失败;提交前的失败仍按原逻辑回滚,不应把“跳过回滚”推广到所有异常。 - 判断依赖 Rails 事务状态语义(
transaction.state.committed?)以及WithLockRetries的提交时机,升级 Rails 或改动事务封装时需重新确认这一前提。 - 跳过回滚不等于忽略错误:错误进入错误跟踪,只是不再改变已提交的迁移结果。
- 该 MR 无界面变更。合并状态、目标版本与最终发布版本本次材料未完整提供,需以 MR 页面与对应发布说明为准(待核实)。
给开发者的实践提示#
在事务封装中区分“提交前失败”和“提交后失败”,比笼统 rescue 后统一回滚更可靠。提交后回调应视为“结果已定,只能记录与补救”的阶段:可以重试幂等的外部动作、上报错误,但不要执行试图撤销已提交数据的补偿逻辑。判断提交状态时,优先使用框架提供的事务状态,而不是自行在块末尾埋标志——后者在嵌套事务与锁重试封装下很容易失效。
本文事实均来自上述 MR 说明;复现代码未执行,输出与行为以实际环境为准。
参考来源
以上为本文写作时的参考资料,引用观点以原文为准。