Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add index troubleshooting steps #2633

Merged
merged 5 commits into from
Sep 30, 2024
Merged

Add index troubleshooting steps #2633

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a62e22d
Add index troubleshooting steps
andyw8 Sep 30, 2024
c644ada
Apply suggestions from code review
andyw8 Sep 30, 2024
b5ea404
Add link to error message
andyw8 Sep 30, 2024
2a1b338
Update test
andyw8 Sep 30, 2024
236bc9e
Fix linting
andyw8 Sep 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion jekyll/troubleshooting.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ For example, if you configure `BUNDLE_PATH` to point to `vendor/bundle` so that
directory as your project, `bundle install` will automatically pick that up and install them in the right place. But
`gem install` will not as it requires a different setting to achieve it.

You can apply your prefered installed locations for RubyGems by using the `~/.gemrc` file. In that file, you can decide
You can apply your preferred installed locations for RubyGems by using the `~/.gemrc` file. In that file, you can decide
to either install it with `--user-install` or select a specific installation directory with `--install-dir`.

```yaml
Expand Down Expand Up @@ -230,6 +230,18 @@ ruby-lsp
Is there any extra information given from booting the server manually? Or does it only fail when booting through the
extension?

## Indexing

When Ruby LSP starts, it attempts to index your code as well as your dependencies as described in [Configuring code indexing](index#configuring-code-indexing).

In rare cases, Ruby LSP will encounter an error which prevents indexing from completing, which will result in incomplete information in the editor.

Firstly, ensure that you are using the latest release of the `ruby-lsp` gem, as the problem may have been already fixed.

To diagnose the particular file(s) causing a problem, run `ruby-lsp-check`. Please log an issue so that we can address it. If the code is not open source then please provide a minimal reproduction.

In the meantime, you can [configure Ruby LSP to ignore a particular gem or file for indexing](index#configuring-code-indexing).

## After troubleshooting

If after troubleshooting the Ruby LSP is still not initializing properly, please report an issue
Expand Down
4 changes: 3 additions & 1 deletion lib/ruby_lsp/server.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -969,7 +969,9 @@ def perform_initial_indexing
false
end
rescue StandardError => error
send_message(Notification.window_show_error("Error while indexing: #{error.message}"))
message = "Error while indexing (see [troubleshooting steps]" \
"(https://shopify.github.io/ruby-lsp/troubleshooting#indexing)): #{error.message}"
send_message(Notification.window_show_error(message))
end

# Indexing produces a high number of short lived object allocations. That might lead to some fragmentation and
Expand Down
4 changes: 3 additions & 1 deletion test/server_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,8 +186,10 @@ def test_initialized_recovers_from_indexing_failures

notification = @server.pop_response
assert_equal("window/showMessage", notification.method)
expected_message = "Error while indexing (see [troubleshooting steps]" \
"(https://shopify.github.io/ruby-lsp/troubleshooting#indexing)): boom!"
assert_equal(
"Error while indexing: boom!",
expected_message,
T.cast(notification.params, RubyLsp::Interface::ShowMessageParams).message,
)
end
Expand Down
Loading