使用二分法解决扩展问题
2021年2月16日,作者:Johannes Rieken, @johannesrieken
“就像 git-bisect 一样,但这是针对 VS Code 扩展的。”
Visual Studio Code 的真正力量在于它的扩展:主题扩展添加颜色和图标,语言扩展支持智能代码补全(IntelliSense)和导航,调试器扩展让你能够运行代码并轻松找到错误。有的扩展可以播放音乐,有的可以显示股票行情,还有的扩展支持跨地域和跨时区的协作。VS Code Marketplace 上有超过 28,000 个扩展,用户安装 50 个或更多的扩展并不少见。有这么多的扩展,出现问题是不可避免的。我们不想回避问题,而是希望让故障排查变得简单。
“坏”扩展
我们热爱扩展,并不真的认为有任何“坏”扩展。然而,像所有软件一样,扩展也有 Bug 和功能缺陷。因此,为了便于阅读和增加戏剧性,我们使用“坏扩展”这个词,它指的是可能会崩溃或仅仅是表现出不希望行为的扩展。幸运的是,我们在设计 VS Code 时考虑到了“坏”扩展的存在,因此我们将它们运行在一个独立的进程中。这种隔离保证了 VS Code 能够持续运行,光标总是在闪烁,并且你总能保存你的工作。
为了好玩,也为了更容易地演示扩展二分法,我们创建并发布了 Extension Bisect Demo 扩展。安装后,每当你的光标到达单词 "bisect" 时,它都会恼人地重置你的光标。你可以使用这个扩展来跟着这篇博客文章一起操作。
用笨办法寻找“坏”扩展
目前,寻找一个“坏”扩展可能很容易,也可能很困难。打开扩展视图(⇧⌘X (Windows、Linux Ctrl+Shift+X)),禁用一个扩展,重新加载窗口(Developer: Reload Window),然后检查问题是否仍然存在。如果问题消失了,那么那个扩展就是“坏”的,你就完成了。否则,重新启用该扩展,并对下一个扩展重复此过程。
如果你幸运,第一个扩展就是“坏”的;如果你不走运,它就是最后一个。用计算机科学的语言来说,这意味着对于 N
个扩展,最坏情况下你需要重复 O(N)
(N 的数量级)次,平均情况下是 O(N/2)
。因为这个算法是由人(你)来操作的,即使 N
的值很小,也会很费力。这就是扩展二分法(extension bisect)工具派上用场的地方。它在最坏和平均情况下的表现要好得多,因为它每次都禁用一半的扩展。
欢迎使用扩展二分法
VS Code 中的扩展二分法工具的灵感来源于 git bisect 命令。对于熟悉 Git 的人来说,这个命令有助于找出仓库中的哪个提交引入了问题。
让我们举个例子:我安装了 24 个扩展,第 8 个扩展是“坏”的。我们知道,迭代法需要 8 个步骤。那么二分法呢?
下面的视频展示了通过 Help: Start Extension Bisect 命令启动扩展二分法,然后选择 Good now(现在好了)或 This is bad(还是有问题),直到找到那个“坏”扩展。一旦找到,你可以选择为该扩展报告问题。
以下是找到“坏”扩展的详细步骤
- 二分法将 24 个扩展分成两半,每半 12 个,并禁用了后半部分的全部 12 个扩展。
- 在这个例子中,第 8 个扩展是“坏”的,所以它在前半部分并且没有被禁用。情况仍然没有像我们预期的那样工作。因为问题仍然存在,扩展二分法重复这个过程,将前半部分的 12 个扩展分成两部分:6 个启用,6 个禁用。所有其他扩展也都被重新启用。
- 现在第 8 个扩展被禁用了。一切正常了。这意味着二分法可以继续处理后半部分(扩展 6-11),并将它们分为 3 个启用和 3 个禁用。
- 现在,第 8 个扩展被重新启用,问题再次出现。这意味着二分法继续处理前半部分。它将它们分为 1 个启用和 2 个禁用。
- 现在第 8 个扩展被禁用了,一切又好了,二分法继续处理后半部分,将其分为 1 个启用和 1 个禁用。
- 第 8 个扩展是唯一被禁用的扩展,问题消失了。这意味着我们已经找到了“坏”扩展,我们完成了。
更快地排查问题
我们看到,在每一步中,二分法都将搜索空间减少了一半。现在这些步骤以对数时间运行,从而得到平均和最坏情况下的性能为 O(log N)
。这相当不错,因为它扩展性很好。有 24 个扩展时,你只需要 4 到 5 步就能找到一个“坏”扩展,有 38 个扩展时,只需要多 1 步。然而,最好的情况变差了,因为用迭代法,你可能运气好在第一轮就找到“坏”的。
请记住,扩展二分法依赖于你提供正确的反馈。你可以通过总是回答 Good now(会归咎于最后一个扩展)或 This is bad(将找不到任何扩展)来轻易地误导它,也误导你自己。
另一个有用的见解是,扩展二分法开始时会考虑所有已启用的扩展列表。这意味着你可以通过在开始前禁用一个已知的“好”扩展,并在结束后重新启用它,来将它从二分法排查中排除。但是,只有在你确定那个扩展不是“坏”的时候才这样做。
最后,你可能会注意到二分法多花了一步(log2(N) + 1
)。这是因为它在第一轮开始时会禁用所有扩展。这样做第一步是因为你看到的问题可能是由 VS Code 本身引起的,而不是由扩展引起的,我们不想让你不必要地掉进兔子洞。
就是这样。我们希望你永远不需要使用扩展二分法。但是,如果你确实遇到了可能与扩展相关的问题,那么我们希望我们能让故障排查变得更容易、更快、更愉快。
编程愉快,
Johannes Rieken,VS Code 首席软件工程师 @johannesrieken