Git Bisect 实战:用二分法快速找到引入 Bug 的提交
前言项目跑了一段时间以后最麻烦的 Bug 往往不是一眼能看出来的语法错误而是那种“之前明明是好的现在突然坏了”的回归问题。比如某个接口在上个月还能正常返回数据最近发版后开始报错某个页面之前可以打开现在出现白屏某个测试以前一直通过某次合并之后开始失败。面对几十次、几百次提交靠肉眼翻提交记录基本靠运气。提交信息写得好的项目还能猜一猜提交信息混乱的项目就很难排。Git Bisect 就适合处理这种问题。它不要求你知道是哪一段代码出了问题只需要知道两个点一个版本是好的一个版本是坏的。Git 会在这两个版本之间不断取中间提交让你判断当前状态是否有问题。每判断一次搜索范围就缩小一半最后定位到第一个引入问题的提交。这个工具平时用得不多但一旦遇到回归 Bug会非常省时间。一、什么时候适合用 Git BisectGit Bisect 最适合定位回归问题。所谓回归问题就是功能曾经正常后来某个时间点开始坏掉。它有一个非常明确的特征你能找到一个好版本也能找到一个坏版本。适合使用 Git Bisect 的场景包括某个测试以前通过现在失败 某个接口以前正常现在返回异常 某个页面以前能打开现在白屏 某个性能指标以前正常现在明显变慢 某个命令以前能执行现在报错不太适合的场景也要先排除。如果这个功能从来没有正常过Git Bisect 很难帮你定位“从哪里开始坏”。如果 Bug 依赖外部环境比如第三方接口、线上配置、数据库数据、时间、网络状态那么每次切换提交后的测试结果可能不稳定二分结果也会变得不可靠。我一般会先问自己三个问题能不能找到一个确定正常的提交或版本标签 能不能找到一个确定有问题的提交 当前问题能不能用一个稳定的测试步骤复现这三个问题都能回答Git Bisect 就很适合上场。二、手动定位一次问题提交手动使用 Git Bisect 的流程很简单。假设当前HEAD已经有问题而v1.8.0这个版本还正常可以这样开始gitbisect startgitbisect badgitbisect good v1.8.0这里的意思是当前提交是坏的 v1.8.0 是好的 请在这两个点之间开始二分查找执行后Git 会自动切到中间某个提交。你需要在这个提交上验证问题是否存在。比如运行测试npmtest或者手动启动项目验证npmrun dev如果当前提交仍然有问题标记为 badgitbisect bad如果当前提交没有问题标记为 goodgitbisect goodGit 会继续切到下一个中间提交。这个过程重复几次以后会输出类似结果a1b2c3d4e5f6 is the first bad commit这就是第一个引入问题的提交。看完结果后不要忘记退出二分状态gitbisect resetgit bisect reset会把工作区切回开始二分之前的位置。很多人第一次用的时候会忘记这一步然后发现自己还停在某个历史提交上以为分支出问题了。定位到提交后可以直接看变更gitshow a1b2c3d4e5f6如果想看某个文件的具体修改历史再配合gitblame path/to/fileGit Bisect 负责找到可疑提交真正修复问题还要回到代码变更本身。三、能自动测试就不要手动点手动二分适合 UI 问题、交互问题、肉眼可判断的问题。只要问题能用测试脚本判断最好交给git bisect run。它的基本思路是让 Git 每切换到一个提交就自动执行一条命令。命令退出码决定当前提交是好是坏。约定很简单退出码 0 表示 good 退出码 1 到 124 表示 bad 退出码 125 表示 skip 其他异常退出可能中断 bisect比如 JavaScript 项目可以直接跑测试gitbisect startgitbisect bad HEADgitbisect good v1.8.0gitbisect runnpmtestPython 项目可以这样gitbisect startgitbisect bad HEADgitbisect good v1.8.0gitbisect run pytest如果现成测试能稳定复现问题这种方式非常舒服。你设置好好坏边界然后等结果就行。真实项目里测试步骤往往没这么简单。可能需要安装依赖、构建、运行某个特定测试文件甚至要先清理缓存。可以写一个脚本#!/usr/bin/env bashset-enpmciif!npmrun build;thenexit125finpmtest-- tests/order-status.test.ts假设文件叫bisect-test.sh放在仓库外部或一个整个历史范围内都存在的位置然后执行chmodx../bisect-test.shgitbisect startgitbisect bad HEADgitbisect good v1.8.0gitbisect run../bisect-test.sh这里有一个很容易踩的坑测试脚本如果是在后来的提交里才新增的二分切到旧提交时可能找不到脚本。所以脚本最好放在仓库外部比如上级目录或者确保它在整个二分区间内都存在。如果某个历史提交编译不过不要直接把它当成 bad。编译不过不一定是引入目标 Bug 的提交可能只是历史上的临时状态。这个时候返回 125让 Git 跳过它更稳。四、复杂场景下怎么缩小范围Git Bisect 默认会在两个提交之间查找所有相关提交。如果你已经知道问题只可能出现在某个目录可以直接限制路径。比如问题只出现在前端页面gitbisect start HEAD v1.8.0 -- apps/web只查某个模块gitbisect start HEAD v1.8.0 -- src/order只查某个文件gitbisect start HEAD v1.8.0 -- src/order/status.ts这种写法能减少很多无关提交。尤其是 Monorepo 里一个仓库里有前端、后端、文档、脚本、基础设施配置如果不限制路径Git 可能让你验证很多和问题无关的提交。如果遇到无法测试的提交可以跳过gitbisect skip也可以跳过一段范围gitbisect skip v1.9.0..v1.9.3不过跳过要谨慎。被跳过的提交越多定位结果越可能变得不精确。尤其是坏提交就在跳过范围附近时Git 可能只能告诉你“问题在这些提交之中”无法锁定唯一提交。还有一种场景是找“修复问题的提交”。比如某个 Bug 在旧版本存在后来某个提交修好了它。用 good 和 bad 也能做但语义上容易别扭。可以改用自定义术语gitbisect start --term-oldbroken --term-newfixedgitbisect broken v1.8.0gitbisect fixed HEAD后续就用gitbisect brokengitbisect fixed这样更符合直觉。旧提交是 broken新提交是 fixed最后找到第一个修复问题的提交。五、定位以后还要做一次人工判断Git Bisect 找到的是第一个让测试结果变坏的提交但这个提交不一定就是最终的业务根因。有时候它只是暴露了更早隐藏的问题。比如某个提交升级了依赖导致旧代码里的类型问题暴露出来。Bisect 会定位到依赖升级提交但真正需要修的可能是旧代码里不兼容的写法。有时候它定位到的是一次重构但问题其实来自某个边界条件遗漏。你还需要看提交 diff确认到底是哪一行改变了行为。我一般会按这个顺序继续排查gitshowbad-commit先看这个提交改了什么。gitshow--statbad-commit看涉及哪些文件判断影响范围。gitdiffbad-commit^bad-commit只看这个提交相对父提交的变化。如果某个文件可疑再看历史gitblame path/to/file这里不要急着马上回滚。回滚可能会带走其他正常改动尤其是一个提交里混了多个变更时。更稳的做法是先把问题最小化写一个能复现 Bug 的测试再修复代码。理想流程是用 Git Bisect 找到坏提交 阅读 diff 判断可疑改动 补一个失败测试复现问题 修改代码让测试通过 再确认相关功能没有回归Git Bisect 解决的是定位效率修复质量还要靠测试和审查。六、养成能被 Bisect 的提交习惯Git Bisect 好不好用很大程度取决于平时的提交质量。如果每个提交都很大一次提交里既改数据库结构又改接口又改前端页面还顺手格式化了几十个文件那么 Bisect 就算定位到这个提交后续分析仍然很痛苦。更适合 Bisect 的提交应该尽量原子化一个提交解决一个明确问题 不要把格式化和业务修改混在一起 不要把依赖升级和功能改造混在一起 提交后尽量保持项目能构建、测试能跑 提交信息写清楚为什么改而不只写改了什么如果团队习惯 squash merge也不影响使用 Bisect但 squash 后的提交会更大定位粒度会变粗。对于回归问题较多的项目可以在合并前要求 PR 里的关键提交保持相对清晰或者至少保证 squash commit 的描述足够具体。还有一点很重要不要在有未提交修改的工作区里直接开始 Bisect。二分过程会频繁 checkout 历史提交未提交修改很容易造成冲突或丢失判断。开始前先看状态gitstatus如果有临时改动可以先 stashgitstash push-mbefore bisect二分结束后再恢复gitbisect resetgitstash pop这样流程更干净。总结Git Bisect 适合定位回归 Bug。只要能找到一个好版本和一个坏版本再准备一个稳定的验证方式它就能用二分查找把问题范围快速缩小到某个提交。手动模式适合需要人工判断的场景比如 UI 异常、交互问题、肉眼可确认的行为变化。自动模式适合测试能复现的问题git bisect run配合测试脚本可以省掉大量重复操作。复杂项目里可以通过路径限制减少无关提交通过skip跳过无法测试的历史提交通过自定义术语查找修复提交。定位结果出来以后还要继续看 diff、补测试、分析真实根因不要只看到第一个 bad commit 就急着回滚。我更建议把 Git Bisect 当成日常调试工具而不是最后没办法时才想起来的救命工具。只要项目有清晰提交、稳定测试和相对干净的历史遇到“之前好好的现在坏了”的问题Git Bisect 往往比翻日志、猜提交、问同事都更快。
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2631361.html
如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!