LuaLS / LuaLS/lua-language-server

Accessing deeply nested variable at 'if' statemet cause type collision

Open
#2,725 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lua
Stars
4.4k
Forks
442
PR merge metrics
No merged PRs in 30d

Description

### 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?

Type Checking

### Expected Behaviour

Type checking does not breaks after accessing variable at 'if' statement.

### Actual Behaviour

2nd nested variable type became '\ | unknown' so accessing variable or function which not exists in this class does not cause warning.

### Reproduction steps

```lua
---@class DemoD
---@field c integer
local DemoD = {}
DemoD.c = 0

---@class DemoC
local DemoC = {}
DemoC.D = DemoD

---@class DemoB
local DemoB = {}
DemoB.C = DemoC

---@class DemoA
local DemoA = {}
DemoA.B = DemoB

---@class DemoRoot
DemoRoot = {}
DemoRoot.A = DemoA

local d = DemoRoot.A.B.C.D

-- if d.c > 1 then end -- if we replace 'DemoRoot.A.B.C.D' with 'd' then F is undefined in all 4 cases
if DemoRoot.A.B.C.D.c > 1 then end

DemoRoot.F() -- warning: F is undefined
DemoRoot.A.F() -- warning: F is undefined
DemoRoot.A.B.F() -- no warning
DemoRoot.A.B.C.F() -- no warning
```
![if-statement-bug](https://github.com/LuaLS/lua-language-server/assets/27363039/982f29e7-3ae5-4153-a438-68fd0e6b34ad)

### Additional Notes

_No response_

### Log File

_No response_

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the reported behavior with the Lua snippet in the issue, comparing the direct and local-variable forms in the type checker used by the Visual Studio Code extension. The fix is complete when invalid members such as DemoRoot.A.B.F() and DemoRoot.A.B.C.F() produce undefined-member warnings without breaking valid nested access.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
devtools
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.