技术文章

外部链接将在新标签页打开。

事务提交后的回调抛错,为什么仍会回滚项目转移:GitLab after-commit 回调的失败边界

一句话回答

GitLab 项目转移在 WithLockRetries 事务提交时运行 run_after_commit 回调,此时仍位于 commit_transfer 的 rescue Exception 内。回调抛错会让 rescue 分支执行 rollback_side_effects,把已提交的转移写回旧仓库路径。修复依据 transaction.state.committed? 区分提交前后:提交后失败跳过回滚并送入 error tracking,提交前失败仍回滚。

核心要点 TL;DR
  • 回调抛错本身不会撤销已提交的数据库事务,问题出在 rescue 分支仍执行了回滚副作用。
  • 判断依据是事务对象的 state.committed?,不是 Project.transaction 块末尾设置的标志。
  • 事务级 after_commit 回调晚于记录回调运行,不能用来设置这个标志。

标题问题的简短回答是:回调抛错并没有撤销已经提交的数据库事务;真正把项目转移“回滚”的,是 commit_transfer 的 rescue Exception 分支在提交之后仍然执行了 rollback_side_effects。回调运行在事务提交的那一刻,却仍处于这个 rescue 的作用范围内,于是错误看起来像“转移失败”,系统按失败路径处理了一个其实已经落库的转移。

本文依据 GitLab 合并请求 !271664 的说明整理。该 MR 是 !262788 的后续:前者已经处理了 commit_transfer 之后步骤失败时不再回滚转移,本 MR 补上的是 commit_transfer 内部 run_after_commit 块的失败。来源:GitLab MR !271664。材料未给出该 MR 的合并状态与目标版本,相关版本信息待核实。

失败链路:提交已完成,回滚却照样执行#

材料把触发条件说得很具体:run_after_commit 块在 Gitlab::Database::WithLockRetries 事务提交时运行,而这个时点仍在 Projects::TransferService#commit_transfer 的 rescue Exception 内。于是回调一旦抛错,代码走的是失败分支,而不是“已完成”分支。

后果分三步,材料均有说明:

  • 转移其实已经提交;
  • rollback_side_effects 把旧仓库路径写了回去;
  • Projects::TransferWorker 取消转移、创建“transfer failed”待办,并在重试时撞上“Project is already in this namespace”。

这三步叠加,比单纯的报错更难排查:数据库层面的命名空间已经变了,仓库路径却被写回旧值,重试又因为命名空间已是目标组而失败。表面上像一次可重试的转移失败,实际是一个部分完成的转移状态。

修复思路:用事务状态而不是位置标志判断提交与否#

修复后的 commit_transfer 会记录自己所在的事务。当被 rescue 的错误发生在这个事务提交之后时,跳过回滚,并把错误送到 error tracking(track_post_commit_failure,与提交后步骤的处理方式一致)。转移被报告为完成,后续的提交后步骤和 refresh_permissions 仍会执行。提交之前发生的失败,仍然照常回滚。

判断依据是 transaction.state.committed?。材料给出的理由是:Rails 在运行记录级 after_commit 回调之前,已经把事务标记为已提交,所以这个判断只对“提交后失败”为真。

为什么不能用更直觉的两种写法

候选做法材料给出的问题
在 Project.transaction 块末尾设标志 提交发生在外层 WithLockRetries 事务结束时,不在该块末尾,块末标志无法反映提交是否已经发生。
用事务级 after_commit 回调设标志 事务级回调在记录级回调之后运行,等到它执行时,已经来不及影响本次 rescue 的判断。

这两点值得记住,因为它们不只是这个 MR 的实现细节,也是任何“提交后副作用失败该不该回滚”的代码都容易踩的位置:判断点必须放在能真实观测到提交状态的地方。

本地复现与检查步骤#

材料给出了一段 Rails 控制台验证代码,用于让 run_after_commit 块在转移过程中抛错。以下代码原样引自 MR 说明,本文未执行,也不提供预期输出之外的运行结果。

service.define_singleton_method(:execute_system_hooks) { super(); project.run_after_commit { raise 'boom' } }
service.execute(group)

适用环境:GitLab 开发环境的 Rails 控制台,对象为待转移项目对应的 Projects::TransferService 实例与目标组。材料提示,在开发环境下错误会被抛出(track_and_raise_for_dev_exception),因此控制台会看到异常,而不是静默吞掉。

验证修复是否生效,材料建议检查两点:

  1. project.reload.namespace 是否为目标组;
  2. project.project_repository.disk_path 是否等于 project.disk_path。

第二项对应的是本次故障的核心症状:旧仓库路径被写回后,仓库磁盘路径与项目记录不一致。只检查命名空间会漏掉这个问题。

结论与边界#

可以确认的结论是:在这条路径上,“回调抛错导致转移回滚”并不是事务语义本身的行为,而是 rescue 分支在提交后仍执行回滚副作用造成的;修复把提交前与提交后两种失败分开处理,提交后失败只上报、不回滚,提交前失败维持原行为。

需要保留的不确定性:材料未说明该 MR 的合并状态、随哪个 GitLab 版本发布,也未提供测试用例清单或性能影响。若要在自己的实例上确认行为,应以实际部署版本对应的源码与发布说明为准;本文不对版本适用性作推断。

常见问题(FAQ)

为什么不在 Project.transaction 块末尾设一个标志来判断是否已提交?
材料指出,提交发生在外层 WithLockRetries 事务结束时,而不是 Project.transaction 块末尾,所以块末设置的标志无法反映提交是否已经发生。Rails 在运行记录 after_commit 回调前已把事务标记为已提交,因此 transaction.state.committed? 只对提交后失败为真。
修复后,提交后回调抛出的错误去哪了?
按材料,错误被发送到 error tracking(track_post_commit_failure,与提交后步骤的做法一致),转移被报告为完成,后续提交后步骤和 refresh_permissions 仍会运行。

参考来源

  1. Keep a project transfer when an after-commit callback raises (!271664) · 合并请求 · GitLab.org / GitLab · GitLab

以上为本文写作时的参考资料,引用观点以原文为准。

作者:沐小悠

本文约 6 分钟读完 · 关键词:GitLab、项目转移、after_commit、run_after_commit、WithLockRetries

更多文章 GET 示例接口

「」标签下的其他文章