LuaLS / LuaLS/lua-language-server

Unexpected repeated alias expanding 类型别名错误地重复展开

未关闭
#2,780 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

bug
主要语言
Lua
星标
4.4k
派生
442
PR 合并指标
30 天内没有已合并 PR

描述

How are you using the lua-language-server?

Visual Studio Code Extension (sumneko.lua)

Which OS are you using?

Windows

What is the issue affecting?

Hover

Expected Behaviour

hover.expandAliasfalse时,如下标注
Set hover.expandAlias to false, and do annotations like this:

---while `hover.expandAlias` is `false`
---@alias T string | [T, T]

当鼠标置于[T, T]中的任意一个T时,应为(alias) T 展开为 string | [T, T]
When the mouse is placed on one T of [T, T], it should be expanded to (alias) T 展开为 string | [T, T]

Actual Behaviour

如图所示
As is seen:
image

对于任何一个出现了多于一次递归引用的别名,都会这样
For any alias that has more than one recursive reference, this will be the case:
image

单次递归引用,或者是简单得没有意义的别名,则不会发生
A single recursive reference, or a simply meaningless alias, will not be with glitches:
image
image

此外,若hover.expandAliastrue,展开的效果非常惊悚
In addition, if hover. extpandAlias is set to true, the effect is very frightening:
image

Reproduction steps
---while `hover.expandAlias` is `true`
---@alias S string | [S] | [S, S]


---while `hover.expandAlias` is `false`
---@alias T string | [T, T]


---while `hover.expandAlias` is `false`
---@alias U string | {msg: U} | {err: U}


---while `hover.expandAlias` is `false`
---@alias V string | V[]


---while `hover.expandAlias` is `false`
---@alias W {[string]: W} | W[]
Additional Notes

我查阅了一下代码,做出一种猜想:

getInfer时的compileNode错误地使用了先前已缓存的节点(其并未标记这是一个不应该展开的别名),在_eraseAlias发挥效用前就展开了这个别名,并没有经过hover.expandAlias的判断,未在_drop集合中附上标注。这也是在单次使用递归时不会触发 bug 但两次使用递归就会触发的原因。

I looked up the code and made a guess:

When using getInfer, the compileNode mistakenly used a previously cached node which was not marked as an alias that should not be expanded. Without going through the judgment of hover.expandAlias, it expanded the alias before _eraseAlias takes into effect, which failed in marking in _drop set. This is the reason why it will not cause glitch when using recursion once, but only when using recursion twice.

作为本仓库的贡献者之一,我非常乐意协助这个 bug 的修复。但这个 bug 似乎太底层,有点超出我力所能及的范围了。故我提交本次 Issue,抛砖引玉一下。

As one of the contributors to this repository, I am more than happy to assist in fixing this glitch. But this glitch seems too fundamental for me to fix. So I am here to submit this issue for further discussion.

Log File

No response

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

先从报告中指出的 script/vm/infer.lua 里的 getInfer 和 _eraseAlias 开始,然后检查 script/vm/compiler.lua 中的 compileNode。切换 hover.expandAlias 时,使用递归别名 S、T、U、V 和 W 重现悬停行为。完成的标准是递归别名不再被重复展开,并且悬停输出与预期的单次展开一致。

由索引模型根据 Issue 内容生成。

评估

技术栈
lua
领域
devtools
Issue 类型
缺陷
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。