ESLint 并发修复代码可能引入新错误
来源标题:Problem with Concurrent Linter Fixes
ESLint 等 linter 并发应用多条自动修复时会生成错误代码,例如同时替换函数调用并删除原函数定义,导致引用丢失。问题根源是修复基于同一份分析结果批量执行,而非每改一处重新分析。作者以 ESLint 为例演示了该缺陷,指出其他 linter 也可能存在。
以下正文由 AI 翻译自 Hacker News 最新(原文版权归原站所有),可能存在偏差,重要内容请以原文为准。
今天我想聊一个 linter 会遇到的问题(本文以 JavaScript 的 ESLint 为例,但它并非个例):当 linter 并发地修复多个问题时,会引入一种本来不会出现的错误——如果每次修复后都重新分析代码,这个错误就不会发生。
问题
(所有代码都可以在这个仓库中找到。)
假设我们要分析这个 example.js 文件:
let scores = [ 0, 100, 40, 60 ];
let averageScore = sum(scores) / scores.length;
console.log(averageScore);
function average(array) {
return sum(array) / array.length;
}
function sum(array) {
let sum_ = 0;
for (const elem of array) {
sum_ += elem;
}
return sum_;
}
我们可以确定这里有两处改进:
问题在于,这两处改进——在 averageScore 的定义中使用 average,以及删除 average 函数——单独来看都没问题,但同时应用这两个改动会产生错误的代码:
let scores = [ 0, 100, 40, 60 ];
let averageScore = average(scores);
// ^^^^^^^ 未知引用
// 文件到此结束,或者只剩 `sum` 的定义,
// 取决于 linter 应用修复的程度。
在我上面链接的仓库里,我通过创建并启用 2 条 linter 规则演示了这个问题:
(这 2 条规则写得很朴素,在真实项目中根本不可用,但足以说明我们这个目标示例中的问题。)
过程走查
启用这 2 条规则后,实际会发生什么?linter(这里是 ESLint)对 example.js 运行所有规则的分析,并确定有两处可用的修复:
由于这两个修复之间没有冲突——仅就编辑范围而言——linter 会一次性应用它们,然后重新运行分析,发现此时 sum 也可以被删除了。
可能的解决方案
我曾经问过 Nicholas C. Zakas(ESLint 的创造者)这个问题,他告诉我,虽然这确实可能发生,但在实践中并不是什么大问题。我倾向于同意,因为我在实践中既没遇到过这个问题,也没听到过这类抱怨。但我确实认为,如果 ESLint 在删除无用代码上更激进一些(例如让 no-unused-vars 具备自动修复能力),并给其他规则也加上自动修复,这个问题会更突出。
虽然我同意这是罕见情况,但它的可能性一直让我在实现 elm-review(我自己为 Elm 语言写的 linter)时感到担忧。因此我在那里做了一个我认为更合理(虽然更慢)的选择:一次只应用一个修复,然后重新分析代码。
这确实意味着 linter 花在分析项目上的时间比理论上需要的更多,但也意味着它在任何给定时刻只会应用对文件/项目有意义的修复。
在这个例子中,如果第一个可用的修复(顺序可能是随机的)是使用 average,那么在第二轮迭代中 average 就会被视为被引用了,不会被删除。最终结果是:
let scores = [0, 100, 40, 60];
let averageScore = average(scores);
console.log(averageScore);
function average(array) {
return sum(array) / array.length;
}
function sum(array) {
let sum_ = 0;
for (const elem of array) {
sum_ += elem;
}
return sum_;
}
另一方面,如果第一个可用的修复是删除 average,那么在第二轮迭代中就没有 average 函数可用了,averageScore 会保持原样:
let scores = [0, 100, 40, 60];
let averageScore = sum(scores) / scores.length;
console.log(averageScore);
function sum(array) {
let sum_ = 0;
for (const elem of array) {
sum_ += elem;
}
return sum_;
}
两个版本都没问题,而且除非 linter 优先选择其中某个修复,否则两个版本在某种程度上都是对原代码的改进。真正错误的是,为了同时应用两个修复而最终得到损坏的代码。
结论
这个问题可能出现在任何一对会应用重大代码改动、且单独来看 100% 正确的规则上:
我认为,当你想给 linter 加上更大胆的自动修复时,这个问题就是一个拦路虎(例如 ESLint 的自动修复并不会删除多少代码)。
我选择的方案——在修复之间重新分析代码——有明确的性能代价。遗憾的是,当我无法控制规则时,我还没找到更好的方案,因为 elm-review 和 ESLint 都支持工具维护者并不了解的自定义规则。不支持自定义规则的 linter(在我看来这是一个严重缺失的功能)或许可以通过事先确定冲突来避开这个问题,例如通过优先级排序。
我非常享受完全不必担心这个问题。我不必担心自己规则的修复在特定情况下会与另一个规则的修复冲突(就是本文描述的这种冲突),也不必为用户可能遇到的这类问题花大量时间调试。
正文由 探How 从来源站点 RSS 同步,内容未经改写;遇到排版缺失或需要图片、视频时请以原文为准。