VSCode Sticky Scroll no longer works in ERB files after 0.7.10

[brianclinkenbeard]

Description

Reproduction steps

1. Start Ruby LSP > 0.7.10 using vscode
2. Open an ERB file
3. Regression occurs where sticky scroll no longer appears

Example with a YAML file:
On 0.7.10:

On 0.7.12:

Likely related to the ERB code navigation change in #2235. I am using v0.17.7 of the language server.

[Ak-github-dev]

Hi @brianclinkenbeard,

I am new to this so probably correct if i am wrong , but as i see its working fine for me for the .erb files. I am using v0.7.13 of Ruby LSP in VSCode.

Example check: Check below screens:

when scrolled:

Check any logs you see in output panel once, Also try to add below in settings.json:

{
"ruby.useLanguageServer": true,
"ruby.languageServer.LaunchArgs": [
"--stdio",
"--verbose"
]
}
to log more detailed info

Please do ignore if this doesn't help or looks a noob solution.

Thanks

[andyw8]

Settings beginning with ruby. are not used by Ruby LSP – those are for a different extension.

[st0012]

@brianclinkenbeard I can't reproduce the "fix" of downgrading extension. I do notice that I got sticky scroll back briefly when the extension restarts, like after downgrading or upgrading it.
Can you let me know if you still get the sticky scroll with the following steps:

• Downgrade to v0.7.10 and restart the extension
• Close the file
• Open the file again

Additionally, can you check the language mark (example in screenshot) always indicates erb?

And are you sure v0.7.10 is when the behaviour first changed?

[brianclinkenbeard]

@st0012 Yup, following those steps maintains no sticky scroll on the .yml.erb file I have open. The language mark in the bottom right always indicates erb (except when no version of Ruby LSP is installed, then it goes to Ruby). It seems that v0.7.11 is the first version when this occurs, and the sticky scroll goes away right after the LSP server starts.

[brianclinkenbeard]

It looks like v0.7.14 fixes this issue, but I'm not sure why: I didn't disable the new rubyLsp.erbSupport setting, which defaults to true. 🤔

[vinistock]

Since the issue seems to be gone, I'm closing this until we receive other reports. If you experience the issue again, let us know!

[brianclinkenbeard]

@vinistock Can we reopen this issue, actually? It turned out that this being "fixed" previously was from an issue where Ruby LSP was failing to start and enable the erb syntax.

[brianclinkenbeard]

This appears to be related to the documentSymbols feature. When this feature turned off, sticky scroll and the erb formatting works correctly.

[vinistock]

@brianclinkenbeard do you have a reproduction example so that we can investigate? If this is related to document symbols in ERB files, it might be some specific code pattern that triggers it.

[brianclinkenbeard]

Hi @vinistock, I've spent some time narrowing this down to these reproduction steps:

1. Make sure documentSymbols feature is enabled to reproduce the issue (and LSP has restarted if necessary)
2. View a .yml.erb file following this pattern in VSCode:

<% CONST = nil %>

list:
  nested_list:
    - item
    - item
    - item
    # ...

list2: # For whatever reason, a trailing list is needed to ever show sticky scroll

Disabling documentSymbols will restore the sticky scroll.