使用二分查找解决扩展问题
2021 年 2 月 16 日,Johannes Rieken,@johannesrieken
“就像 git-bisect 一样,但用于 VS Code 扩展。”
Visual Studio Code 的真正力量在于其扩展:主题扩展添加颜色和图标,语言扩展启用智能代码完成(IntelliSense)和导航,调试器扩展使您能够运行代码并轻松查找错误。有些扩展播放音乐,有些显示股票行情,还有一些扩展支持跨位置和时区的协作工作。VS Code 市场托管超过 28,000 个扩展,用户安装 50 个或更多扩展的情况并不少见。由于有如此多的扩展,出现错误是不可避免的。我们不想否认这一点,而是希望使故障排除变得容易。
“不良”扩展
我们喜欢扩展,并不认为有任何“不良”扩展。然而,像所有软件一样,扩展存在错误和功能缺陷。因此,为了方便阅读和人为制造戏剧性,我们使用术语“不良扩展”,指的是可能崩溃或只是显示不需要的行为的扩展。幸运的是,我们在设计 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 个扩展,只需要多 1 个步骤。但是,最佳情况更糟糕,因为使用迭代方法,您可能会很幸运地在第一轮中找到“不良”扩展。
请记住,扩展二分查找依赖于您提供正确的反馈。您可以通过始终回答现在很好(指责最后一个扩展)或这是坏的(找不到扩展)来轻松地欺骗它以及您自己。
另一个有用的见解是,扩展二分查找从考虑所有启用的扩展列表开始。这意味着您可以通过在启动之前禁用已知的“良好”扩展,并在之后重新启用它来将其从二分查找中排除。但是,只有当您确定该扩展不是“不良”扩展时才执行此操作。
最后,您可能会注意到二分查找会多执行一个步骤(log2(N) + 1
)。那是因为它通过禁用所有扩展来启动第一轮。之所以执行第一步,是因为您可能会看到由 VS Code 本身而不是扩展引起的问题,我们不希望让您不必要地陷入困境。
就是这样。我们希望您永远不需要使用扩展二分查找。但是,如果您确实遇到可能与扩展相关的问题,那么我们希望我们可以使故障排除更容易、更快、更愉快。
编码愉快,
Johannes Rieken,VS Code 首席软件工程师 @johannesrieken