使用 Bisect 解决扩展问题
2021 年 2 月 16 日,Johannes Rieken,@johannesrieken
“就像 git-bisect,但用于 VS Code 扩展。”
Visual Studio Code 的真正力量在于其扩展:主题扩展添加颜色和图标,语言扩展启用智能代码完成 (IntelliSense) 和导航,调试器扩展使您能够运行代码并轻松查找错误。有些扩展可以播放音乐,有些可以显示股票行情,还有一些扩展可以实现跨地点和时区的协作工作。VS Code Marketplace 托管超过 28,000 个扩展,用户安装 50 个或更多扩展并不罕见。有如此多的扩展,错误是不可避免的。我们不想否认这一点,而是希望使故障排除变得容易。
“不良”扩展
我们喜欢扩展,并且真的不认为有任何“不良”扩展。但是,与所有软件一样,扩展也存在错误和功能缺陷。因此,为了便于阅读和人为的戏剧性,让我们使用术语“不良扩展”,这是一种可能崩溃或只是表现出不良行为的扩展。幸运的是,我们在设计 VS Code 时考虑了“不良”扩展,因此将它们在单独的进程中运行。这种隔离保证了 VS Code 持续运行,光标始终闪烁,并且您可以随时保存您的工作。
为了好玩,并且为了更容易演示扩展 Bisect,我们创建并发布了Extension Bisect Demo扩展。安装后,每当您遇到“bisect”一词时,它都会烦人地重置您的光标。您可以使用此扩展来跟随这篇博客文章。
以艰难的方式查找“不良”扩展
今天,找到“不良”扩展可能很容易或很难。打开扩展视图(⇧⌘X (Windows, Linux Ctrl+Shift+X)),禁用扩展,重新加载窗口(开发人员:重新加载窗口),并检查问题是否仍然存在。如果问题消失,则该扩展是“不良”扩展,您就完成了。否则,重新启用扩展,并对下一个扩展重复此过程。
如果您幸运,第一个扩展是“不良”扩展;如果您不幸,它是最后一个扩展。使用计算机科学语言,这意味着对于 N
个扩展,您在最坏情况下需要重复该过程 O(N)
(阶 N)次,平均情况下为 O(N/2)
次。由于此算法由人(您)操作,即使 N
的值很小也很费力。这就是扩展 Bisect 实用程序派上用场的地方。它在最坏情况和平均情况下都好得多,因为它以一半一半的方式禁用扩展。
欢迎使用扩展 Bisect
VS Code 中的扩展 Bisect 实用程序的灵感来自 git bisect 命令。对于熟悉 Git 的人来说,此命令有助于找出存储库中引入问题的提交。
让我们使用一个示例:我安装了 24 个扩展,第 8 个扩展是“不良”扩展。我们知道迭代方法需要 8 个步骤。那么 Bisect 呢?
下面的视频演示了通过帮助:启动扩展 Bisect 命令启动扩展 Bisect,然后选择现在正常或这很糟糕,直到找到“不良”扩展。找到后,您可以选择报告该扩展的问题。
以下是逐步说明如何找到“不良”扩展的步骤
- Bisect 将 24 个扩展分为两半,每半 12 个扩展,并禁用后一半的所有 12 个扩展。
- 在此示例中,第 8 个扩展是“不良”扩展,因此它位于前半部分,并且未被禁用。事情仍然没有按我们期望的那样工作。由于仍然存在问题,扩展 Bisect 重复该过程,将前 12 个扩展分为两部分:6 个启用,6 个禁用。所有其他扩展也被重新启用。
- 第 8 个扩展现在被禁用。现在一切正常。这意味着 Bisect 可以继续处理后半部分(扩展 6-11),并将它们分为 3 个启用和 3 个禁用扩展。
- 现在,第 8 个扩展被重新启用,问题再次出现。这意味着 Bisect 继续处理前半部分。它将它们分为 1 个启用和 2 个禁用扩展。
- 第 8 个扩展现在被禁用,事情再次正常,Bisect 继续处理后半部分,将其分为 1 个启用和 1 个禁用扩展。
- 第 8 个扩展是唯一禁用的扩展,问题消失了。这意味着我们找到了“不良”扩展,并且我们完成了。
更快地进行故障排除
我们看到,在每个步骤中,Bisect 都将搜索空间减少一半。现在的步骤以对数时间运行,导致平均和最坏情况下的性能为 O(log N)
。这非常好,因为它具有良好的可扩展性。对于 24 个扩展,您需要 4 到 5 个步骤才能找到“不良”扩展,对于 38 个扩展,仅需多 1 个步骤。但是,最佳情况更糟,因为使用迭代方法,您可能会幸运地在第一轮中找到“不良”扩展。
请记住,扩展 Bisect 依赖于您提供正确的反馈。您很容易欺骗它,也欺骗自己,始终回答现在正常(责怪最后一个扩展)或这很糟糕(找不到扩展)。
另一个有用的见解是,扩展 Bisect 首先考虑已启用扩展的完整列表。这意味着您可以通过在启动之前禁用已知的“良好”扩展,并在之后重新启用它,从而将其从 Bisect 中排除。但是,仅当您确定该扩展不是“不良”扩展时才这样做。
最后,您可能会注意到 Bisect 正在执行额外的步骤 (log2(N) + 1
)。这是因为它在第一轮开始时禁用了所有扩展。执行第一步是因为您可能会看到由 VS Code 本身而不是扩展引起的问题,并且我们不想不必要地让您陷入困境。
就是这样。我们希望您永远不需要使用扩展 Bisect。但是,如果您确实遇到可能与扩展相关的问题,那么我们希望我们可以使故障排除更容易、更快、更愉快。
祝您编码愉快,
Johannes Rieken,VS Code 首席软件工程师 @johannesrieken