Ruby LSP's own dependencies indexed as part of project's dependencies

[carlqt]

Description

Ruby LSP Information

VS Code Version

1.98.2

Ruby LSP Extension Version

0.9.12

Ruby LSP Server Version

0.23.12

Ruby LSP Add-ons

• custom add on

Ruby Version

3.4.2

Ruby Version Manager

asdf

Installed Extensions

Click to expand

• Bookmarks (13.5.0)
• atlas-hcl (0.5.8)
• caddyfile-support (0.4.0)
• code-spell-checker (4.0.40)
• explorer (1.16.1)
• gitlens (16.3.3)
• go (0.46.1)
• hcl (0.6.0)
• lua (3.13.9)
• material-icon-theme (5.20.0)
• mock-debug (0.52.0)
• prettier-vscode (11.0.0)
• rainbow-csv (3.18.0)
• rbs-snippets (1.1.1)
• remote-containers (0.401.0)
• ruby-extensions-pack (0.1.13)
• ruby-lsp (0.9.12)
• sorbet-vscode-extension (0.3.40)
• steep-vscode (0.10.0)
• svelte-vscode (109.5.3)
• test-adapter-converter (0.2.1)
• theme-dracula (2.25.1)
• vim (1.29.0)
• vs-code-prettier-eslint (6.0.0)
• vscode-docker (1.29.4)
• vscode-erb-beautify (0.5.0)
• vscode-eslint (3.0.10)
• vscode-github-actions (0.27.1)
• vscode-graphql (0.13.2)
• vscode-graphql-syntax (1.3.8)
• vscode-mdx (1.8.13)
• vscode-rdbg (0.2.2)
• vscode-rubocop (0.7.0)
• vscode-test-explorer (2.22.1)

Ruby LSP Settings

Click to expand

Workspace

{}

User

{
  "enabledFeatures": {
    "codeActions": true,
    "diagnostics": true,
    "documentHighlights": true,
    "documentLink": true,
    "documentSymbols": true,
    "foldingRanges": true,
    "formatting": true,
    "hover": true,
    "inlayHint": true,
    "onTypeFormatting": true,
    "selectionRanges": true,
    "semanticHighlighting": true,
    "completion": true,
    "codeLens": true,
    "definition": true,
    "workspaceSymbol": true,
    "signatureHelp": true,
    "typeHierarchy": true
  },
  "featuresConfiguration": {},
  "addonSettings": {},
  "rubyVersionManager": {
    "identifier": "auto"
  },
  "customRubyCommand": "",
  "formatter": "auto",
  "linters": null,
  "bundleGemfile": "",
  "testTimeout": 30,
  "branch": "",
  "pullDiagnosticsOn": "both",
  "useBundlerCompose": false,
  "bypassTypechecker": false,
  "rubyExecutablePath": "",
  "indexing": {},
  "erbSupport": true,
  "featureFlags": {},
  "sigOpacityLevel": "1"
}

Reproduction steps

1. In an empty repo and an emtpy Ruby file, write event.
2. ruby-lsp will display a list of suggested methods even when nothing was defined.

Note:
Posted this question in slack and it was mentioned that ruby-lsp was matching event to LanguageServer::Protocol::Interface::FileEvent

Video

Screen.Recording.2025-03-26.at.20.28.34.mov

[vinistock]

Thank you for submitting the bug report. I changed the title just to describe the root cause of the issue instead of the symptom.

For anyone looking to fix this, here's an explanation of why it happens and the steps to fix. The Ruby LSP runs under the composed bundle, which includes all project dependencies + the Ruby LSP itself, the debug gem and potentially the Rails add-on.

If we simply ask Bundler APIs to return us the dependencies, the result will always include these added gems because we're running under that bundle. We always need to reset the environment temporarily to get only the application's dependencies, like we do here.

The problem is that we're not doing that when listing all gems that should be indexed in our configuration implementation.

To fix this:

1. Write a test that reproduces the issue and verifies that the LSP's own dependencies are accidentally included when computing the indexable URIs
2. Wrap listing the locked gems in an original_env block
3. Verify if the problem is fully fixed