使用二分法解决扩展问题
2021 年 2 月 16 日,作者:Johannes Rieken,@johannesrieken
“就像 git-bisect,但用于 VS Code 扩展。”
Visual Studio Code 的真正强大之处在于其扩展:主题扩展添加颜色和图标,语言扩展支持智能代码补全 (IntelliSense) 和导航,调试器扩展让您可以运行代码并轻松查找错误。还有播放音乐的扩展、显示股票行情的扩展,以及支持跨地点和时区协作的扩展。VS Code 市场托管着 28,000 多个扩展,用户安装 50 个或更多扩展的情况并不少见。有如此多的扩展,错误是不可避免的。我们不回避问题,而是希望让故障排除变得容易。
“不良”扩展
我们热爱扩展,并且不认为存在任何“不良”扩展。然而,与所有软件一样,扩展也存在 Bug 和功能缺陷。因此,为了便于阅读和增加一点“戏剧性”,我们使用“不良扩展”一词,它指可能崩溃或仅显示不必要行为的扩展。幸运的是,我们在设计 VS Code 时考虑到了“不良”扩展,因此在单独的进程中运行它们。这种隔离保证了 VS Code 持续运行,光标始终闪烁,并且您始终可以保存您的工作。
为了好玩,也为了更轻松地演示扩展二分法,我们创建并发布了扩展二分法演示扩展。安装后,每当您达到“bisect”(二分)这个词时,它就会烦人地重置您的光标。您可以使用此扩展来跟着本文进行操作。
以艰难的方式查找“不良”扩展
如今,查找“不良”扩展可能很容易,也可能很难。打开“扩展”视图(⇧⌘X (Windows、Linux Ctrl+Shift+X)),禁用一个扩展,重新加载窗口(开发人员:重新加载窗口),然后检查问题是否存在。如果问题消失,那么该扩展是“不良”的,您就完成了。否则,重新启用该扩展,并对下一个扩展重复此过程。
如果幸运的话,第一个扩展就是“不良”扩展;如果不幸的话,它就是最后一个扩展。用计算机科学的语言来说,这意味着对于 N
个扩展,最坏情况下重复该过程的复杂度为 O(N)
(N 阶),平均情况下为 O(N/2)
。由于此算法由人类(您)操作,因此即使 N
值很小,也需要付出大量劳动。这就是扩展二分法实用工具派上用场的地方。它在最坏情况和平均情况下都好得多,因为它通过对半禁用扩展。
欢迎使用扩展二分法
VS Code 中的扩展二分法实用工具受到了 git bisect 命令的启发。对于熟悉 Git 的人来说,此命令有助于查找仓库中引入问题的提交。
我们用一个示例:我安装了 24 个扩展,其中第 8 个扩展是“不良”的。我们知道迭代方法需要 8 个步骤。那么二分法呢?
下面的视频演示了通过帮助:启动扩展二分法命令启动扩展二分法,然后选择现在正常或有问题,直到识别出“不良”扩展。识别后,您可以选择报告该扩展的问题。
以下是分步演示如何找到“不良”扩展
- 二分法将 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 个扩展,只需再多一个步骤。然而,最佳情况更糟,因为使用迭代方法,您可能会幸运地在第一轮中找到“不良”扩展。
请记住,扩展二分法依赖于您提供正确的反馈。您可以通过始终回答现在正常(会归咎于最后一个扩展)或有问题(将找不到扩展)来轻易地愚弄它,以及您自己。
另一个有用的见解是,扩展二分法从考虑所有已启用的扩展列表开始。这意味着您可以从二分法中排除一个已知的“良好”扩展,方法是在开始之前禁用它,并在之后重新启用它。但是,仅当您确定该扩展不是“不良”扩展时才这样做。
最后,您可能会注意到二分法多花了一个步骤(log2(N) + 1
)。这是因为它在第一轮中禁用了所有扩展。执行此第一步是因为您可能正在看到一个由 VS Code 本身引起的问题,而不是由扩展引起的问题,我们不希望不必要地让您深入探究。
就是这样。我们希望您永远不需要使用扩展二分法。但是,如果您确实遇到可能与扩展相关的问题,那么我们希望能够使故障排除更轻松、更快、更愉快。
编程愉快,
Johannes Rieken,VS Code 首席软件工程师 @johannesrieken