Ruff in VSCode repteadly crashing on hover: The Ruff language server exited with a panic #644

aflip · 2024-11-23T18:21:14Z

I am working in vscode on a .ipynb notebook, and everytime my cursor hovers over any code, i get the ruff panic message as above

example of the code it crashed over

def search_and_lookup(query_vector, top_k=10):
    # Perform the search
    results = ngt_corpus_index.search(query_vector, top_k)
    
    # Look up the document information for each result
    enriched_results = []    
    for ngt_index, distance in results:
        # Find the corresponding document and chunk
        cumulative_count = 0
        for doc in lookup_table:
            if ngt_index < cumulative_count + doc['num_chunks']:
                chunk_id = ngt_index - cumulative_count
                enriched_results.append({
                    'ngt_index': ngt_index,
                    'distance': distance,
                    'document_id': doc['document_id'],
                    'chunk_id': chunk_id
                })
                break
            cumulative_count += doc['num_chunks']
    
    return enriched_results

settins.json

Ruff.log is here: It's the same message repeated.

2024-11-23 22:45:07.465 [info] Name: Ruff
2024-11-23 22:45:07.465 [info] Module: ruff
2024-11-23 22:45:07.465 [info] Python extension loading
2024-11-23 22:45:07.465 [info] Waiting for interpreter from python extension.
2024-11-23 22:45:07.465 [info] Python extension loaded
2024-11-23 22:45:07.465 [info] Using interpreter: /bin/python
2024-11-23 22:45:07.465 [info] Using bundled executable: /home/XX/.vscode-oss/extensions/charliermarsh.ruff-2024.56.0-linux-x64/bundled/libs/bin/ruff
2024-11-23 22:45:07.465 [info] Found Ruff 0.8.0 at /home/XX/.vscode-oss/extensions/charliermarsh.ruff-2024.56.0-linux-x64/bundled/libs/bin/ruff
2024-11-23 22:45:07.465 [info] Server run command: /home/XX/.vscode-oss/extensions/charliermarsh.ruff-2024.56.0-linux-x64/bundled/libs/bin/ruff server
2024-11-23 22:45:07.465 [info] Server: Start requested.
2024-11-23 23:37:34.744 [info] panicked at crates/ruff_server/src/server/api/requests/hover.rs:36:10:
hover should only be called on text documents or notebook cells

2024-11-23 23:37:34.807 [info]    0: 
2024-11-23 23:37:34.807 [info] ruff_server::server::Server::run::{{closure}}
   1: std::panicking::rust_panic_with_hook
   2: std::panicking::begin_panic_handler::{{closure}}
   3: std::sys::backtrace::__rust_end_short_backtrace
   4: rust_begin_unwind
   5: core::panicking::panic_fmt
   6: core::option::expect_failed
   7: <ruff_server::server::api::requests::hover::Hover as ruff_server::server::api::traits::BackgroundDocumentRequestHandler>::run_with_snapshot
   8: core::ops::function::FnOnce::call_once{{vtable.shim}}
   9: core::ops::function::FnOnce::call_once{{vtable.shim}}
  10: std::sys::backtrace::__rust_begin_short_backtrace
  11: core::ops::function::FnOnce::call_once{{vtable.shim}}
  12: std::sys::pal::unix::thread::Thread::new::thread_start
  13: start_thread
             at ./nptl/pthread_create.c:447:8
  14: clone3
             at ./misc/../sysdeps/unix/sysv/linux/x86_64/clone3.S:78


2024-11-23 23:37:35.122 [info] panicked at crates/ruff_server/src/server/api/requests/hover.rs:36:10:
hover should only be called on text documents or notebook cells
   0: ruff_server::server::Server::run::
2024-11-23 23:37:35.122 [info] {{closure}}
   1: std::panicking::rust_panic_with_hook
   2: std::panicking::begin_panic_handler::{{closure}}
   3: std::sys::backtrace::__rust_end_short_backtrace
   4: rust_begin_unwind
   5: core::panicking::panic_fmt
   6: core::option::expect_failed
   7: <ruff_server::server::api::requests::hover::Hover as ruff_server::server::api::traits::BackgroundDocumentRequestHandler>::run_with_snapshot
   8: core::ops::function::FnOnce::call_once{{vtable.shim}}
   9: core::ops::function::FnOnce::call_once{{vtable.shim}}
  10: std::sys::backtrace::__rust_begin_short_backtrace
  11: core::ops::function::FnOnce::call_once{{vtable.shim}}
  12: std::sys::pal::unix::thread::Thread::new::thread_start
  13: start_thread
             at ./nptl/pthread_create.c:447:8
  14: clone3
             at ./misc/../sysdeps/unix/sysv/linux/x86_64/clone3.S:78


2024-11-23 23:37:35.316 [info] panicked at crates/ruff_server/src/server/api/requests/hover.rs:36:10:
hover should only be called on text documents or notebook cells
   0: ruff_server::server::Server::run::{{closure}}
   1: std::panicking::rust_panic_with_hook
2024-11-23 23:37:35.316 [info] 
   2: std::panicking::begin_panic_handler::{{closure}}
   3: std::sys::backtrace::__rust_end_short_backtrace
   4: rust_begin_unwind
   5: core::panicking::panic_fmt
   6: core::option::expect_failed
   7: <ruff_server::server::api::requests::hover::Hover as ruff_server::server::api::traits::BackgroundDocumentRequestHandler>::run_with_snapshot
   8: core::ops::function::FnOnce::call_once{{vtable.shim}}
   9: core::ops::function::FnOnce::call_once{{vtable.shim}}
  10: std::sys::backtrace::__rust_begin_short_backtrace
  11: core::ops::function::FnOnce::call_once{{vtable.shim}}
  12: std::sys::pal::unix::thread::Thread::new::thread_start
  13: start_thread
             at ./nptl/pthread_create.c:447:8
  14: clone3
             at ./misc/../sysdeps/unix/sysv/linux/x86_64/clone3.S:78


2024-11-23 23:37:37.547 [info] panicked at crates/ruff_server/src/server/api/requests/hover.rs:36:10:
hover should only be called on text documents or notebook cells
   0: ruff_server::server::Server::run::{{closure}}
   1: std::panicking::rust_panic_with_hook
   2: std::panicking::begin_panic_handler::{{closure}}
   3: std::sys::backtrace::__rust_end_short_backtrace
   4
2024-11-23 23:37:37.547 [info] : rust_begin_unwind
   5: core::panicking::panic_fmt
   6: core::option::expect_failed
   7: <ruff_server::server::api::requests::hover::Hover as ruff_server::server::api::traits::BackgroundDocumentRequestHandler>::run_with_snapshot
   8: core::ops::function::FnOnce::call_once{{vtable.shim}}
   9: core::ops::function::FnOnce::call_once{{vtable.shim}}
  10: std::sys::backtrace::__rust_begin_short_backtrace
  11: core::ops::function::FnOnce::call_once{{vtable.shim}}
  12: std::sys::pal::unix::thread::Thread::new::thread_start
  13: start_thread
             at ./nptl/pthread_create.c:447:8
  14: clone3
             at ./misc/../sysdeps/unix/sysv/linux/x86_64/clone3.S:78


2024-11-23 23:39:09.761 [info] panicked at crates/ruff_server/src/server/api/requests/hover.rs:36:10:
hover should only be called on text documents or notebook cells

2024-11-23 23:39:09.762 [info]    0: ruff_server::server::Server::run::{{closure}}
   1: std::panicking::rust_panic_with_hook
   2: std::panicking::begin_panic_handler::{{closure}}
   3: std::sys::backtrace::__rust_end_short_backtrace
   4: rust_begin_unwind
   5: core::panicking::panic_fmt
   6: core::option::expect_failed
   7: <ruff_server::server::api::requests::hover::Hover as ruff_server::server::api::traits::BackgroundDocumentRequestHandler>::run_with_snapshot
   8: core::ops::function::FnOnce::call_once{{vtable.shim}}
   9: core::ops::function::FnOnce::call_once{{vtable.shim}}
  10: std::sys::backtrace::__rust_begin_short_backtrace
  11: core::ops::function::FnOnce::call_once{{vtable.shim}}
  12: std::sys::pal::unix::thread::Thread::new::
2024-11-23 23:39:09.762 [info] thread_start
  13: start_thread
             at ./nptl/pthread_create.c:447:8
  14: clone3
             at ./misc/../sysdeps/unix/sysv/linux/x86_64/clone3.S:78


2024-11-23 23:39:12.228 [info] panicked at crates/ruff_server/src/server/api/requests/hover.rs:36:10:
hover should only be called on text documents or notebook cells
   0: ruff_server::server::Server::run::{{closure}}
   1: std::panicking::rust_panic_with_hook
   2: std::panicking::begin_panic_handler::{{closure}}
   3: std::sys::backtrace::__rust_end_short_backtrace
   4: rust_begin_unwind
   5: core::panicking::panic_fmt
  
2024-11-23 23:39:12.229 [info]  6: core::option::expect_failed
   7: <ruff_server::server::api::requests::hover::Hover as ruff_server::server::api::traits::BackgroundDocumentRequestHandler>::run_with_snapshot
   8: core::ops::function::FnOnce::call_once{{vtable.shim}}
   9: core::ops::function::FnOnce::call_once{{vtable.shim}}
  10: std::sys::backtrace::__rust_begin_short_backtrace
  11: core::ops::function::FnOnce::call_once{{vtable.shim}}
  12: std::sys::pal::unix::thread::Thread::new::thread_start
  13: start_thread
             at ./nptl/pthread_create.c:447:8
  14: clone3
             at ./misc/../sysdeps/unix/sysv/linux/x86_64/clone3.S:78


2024-11-23 23:41:15.697 [info] panicked at crates/ruff_server/src/server/api/requests/hover.rs:36:10:
hover should only be called on text documents or notebook cells

2024-11-23 23:41:15.698 [info]    0: ruff_server::server::Server::run::{{closure}}
   1: std::panicking::rust_panic_with_hook
   2: std::panicking::begin_panic_handler::{{closure}}
   3: std::sys::backtrace::__rust_end_short_backtrace
   4: rust_begin_unwind
   5: core::panicking::panic_fmt
   6: core::option::expect_failed
   7: <ruff_server::server::api::requests::hover::Hover as ruff_server::server::api::traits::BackgroundDocumentRequestHandler>::run_with_snapshot
   8: core::ops::function::FnOnce::call_once{{vtable.shim}}
   9: core::ops::function::FnOnce::call_once{{vtable.shim}}
  10: std::sys::backtrace::__rust_begin_short_backtrace
  11: core::ops::function::FnOnce::call_once{{vtable.shim}}
  12: std::sys::pal::unix::thread::Thread::new::thread_start
  13: start_thread
             at ./nptl/pthread_create.c:447:8
  14: clone3
             at ./misc/../sysdeps/unix/sysv/linux/x86_64/clone3.S:78


2024-11-23 23:42:34.445 [info] panicked at crates/ruff_server/src/server/api/requests/hover.rs:36:10:
hover should only be called on text documents or notebook cells

2024-11-23 23:42:34.445 [info]    0: ruff_server::server::Server::run::{{closure}}
   1: std::panicking::rust_panic_with_hook
   2: std::panicking::begin_panic_handler::{{closure}}
   3: std::sys::backtrace::__rust_end_short_backtrace
   4: rust_begin_unwind
   5: core::panicking::panic_fmt
   6: core::option::expect_failed
   7: <ruff_server::server::api::requests::hover::Hover as ruff_server::server::api::traits::BackgroundDocumentRequestHandler>::run_with_snapshot
   8: core::ops::function::FnOnce::call_once{{vtable.shim}}
   9: core::ops::function::FnOnce::call_once{{vtable.shim}}
  10: std::sys::backtrace::__rust_begin_short_backtrace
  11: core::ops::function::FnOnce::call_once{{vtable.shim}}
  12: std::sys::pal::unix::thread::Thread::new::thread_start
  13: start_thread
             at ./nptl/pthread_create.c:447:8
  14: clone3
             at ./misc/../sysdeps/unix/sysv/linux/x86_64/clone3.S:78

2024-11-23 23:41:15.697 [info] panicked at crates/ruff_server/src/server/api/requests/hover.rs:36:10:
hover should only be called on text documents or notebook cells

2024-11-23 23:41:15.698 [info]    0: ruff_server::server::Server::run::{{closure}}
   1: std::panicking::rust_panic_with_hook
   2: std::panicking::begin_panic_handler::{{closure}}
   3: std::sys::backtrace::__rust_end_short_backtrace
   4: rust_begin_unwind
   5: core::panicking::panic_fmt
   6: core::option::expect_failed
   7: <ruff_server::server::api::requests::hover::Hover as ruff_server::server::api::traits::BackgroundDocumentRequestHandler>::run_with_snapshot
   8: core::ops::function::FnOnce::call_once{{vtable.shim}}
   9: core::ops::function::FnOnce::call_once{{vtable.shim}}
  10: std::sys::backtrace::__rust_begin_short_backtrace
  11: core::ops::function::FnOnce::call_once{{vtable.shim}}
  12: std::sys::pal::unix::thread::Thread::new::thread_start
  13: start_thread
             at ./nptl/pthread_create.c:447:8
  14: clone3
             at ./misc/../sysdeps/unix/sysv/linux/x86_64/clone3.S:78

The text was updated successfully, but these errors were encountered:

aflip · 2024-11-23T18:41:48Z

I changed the source of ruff from bundled to environment and now it's not crashing. I don't get it.

MichaReiser · 2024-11-23T21:54:54Z

This sounds similar to #607

I changed the source of ruff from bundled to environment and now it's not crashing. I don't get it.

Oh, that's interesting. What ruff version do you use locally (non bundled)?

Do you have a notebook that you could share that we can use for reproduction?

MichaReiser · 2024-11-23T22:00:31Z

I just tried creating a notebook with the code above and I can't get Ruff to crash when hovering. Can you tell me a bit more about your setup? What extensions are you using? What VS code version are you using? Can you share a video where you hover over a name and Ruff crashes. I wonder what I do wrong that I'm unable to reproduce.

aflip · 2024-11-24T10:08:38Z

I am unable to reproduce the bug myself. it was present all day yesterday, despite various usual interventions like restarting code, the system etc.It stopped when I switched to useenv, but it's still using the bundled ruff. Found Ruff 0.8.0 at /home/XXX/.vscode-oss/extensions/charliermarsh.ruff-2024.56.0-linux-x64/bundled/libs/bin/ruff and i am usually running the notebook from a mamba environment that doesn't have ruff so internally, nothing has changed. this is the notebook i was running https://github.com/pinecone-io/examples/blob/master/learn/generation/better-rag/02a-alt-chunking-methods.ipynb

should i mark this closed since i cant reproduce it?

MichaReiser · 2024-11-24T20:59:27Z

I don't mind keeping the issue open for a little longer. Maybe you'll be able to reproduce the bug in the coming days. I do think there's a bug in Ruff or VS Code (or in combination with some other extension), but we just have never been able to reproduce it, which makes it hard to fix.

dhruvmanila · 2024-11-25T03:12:02Z

Thanks for the issue.

As per the panic message, it should only occur when a hover request is being made by the client for the entire notebook instead of a single text document (Python file) or a notebook cell. But, the method through which is panics (DocumentQuery::as_single_document) could also return None if there's a bug in adding the cell index (NotebookDocument.cell_index field) or if the NotebookCell itself doesn't exists in the vector (NotebookDocument.cells field). If we can figure out which one is the actual cause of this issue, that can be very helpful.

I think we can update the return type of as_single_document from Option to Result in which we can capture what the source of the error is.

## Summary Ref: astral-sh/ruff-vscode#644 (comment) ## Test Plan Not sure how to test this as this is mainly to get more context on the panic that the server is raising.

dhruvmanila · 2024-12-04T11:08:32Z

@aflip Hi, I've added the new message and the latest Ruff release contains it. If possible, can you upgrade your Ruff version to the latest version and provide us the new messages whenever the panic occurs? That would really help in understanding the root cause of this and allow us to fix this quickly.

aflip · 2024-12-04T12:09:56Z

@dhruvmanila have upgraded, so far no more panic. will upload if anything happens. thank you

rnckp · 2025-01-02T18:02:33Z

@dhruvmanila @MichaReiser Unfortunately I observe these crashes too, see the logfile I have mailed you and my identical comment here. Thanks for any help in this matter.

dhruvmanila · 2025-01-03T02:53:54Z

Thanks for sharing the logs, I'll look at that today.

Quemoy · 2025-01-10T02:23:49Z

I would just like to add that I'm starting to notice this quite often, and I think I am able to reproduce the panic.

It happens if I'm editing a Python jupyter notebook (with interactive execution). Let's say I write code in 3 jupyter cells, A B and C, then execute the cells one by one. After, I move say cell B to before where cell A was, Ruff does two things:

Red underlines names in cell C which depends on the code in cell B (but shouldn't, because cell B still exists)
After a bit, throws the "The Ruff language server exited with a panic" message.

What I do to solve this is to disable Ruff in the extension error, and then re-enable and restart it. Ruff then functions again.

I hope this is of use to you.

dhruvmanila · 2025-01-10T08:46:25Z

@Quemoy Thank you! I'm able to get a panic based on the steps that you've mentioned.

dhruvmanila · 2025-01-10T13:25:32Z

Thank you all for the patience. This issue has been fixed and will be released in Ruff 0.9.1.

If you encounter this issue again after upgrading to the mentioned Ruff version, please feel free to comment here or open a new issue for that.

aflip changed the title ~~Ruff in VSCode repteadly crashing on hover: The Ruff language server exited with a panic. See the logs for more details.~~ Ruff in VSCode repteadly crashing on hover: The Ruff language server exited with a panic Nov 23, 2024

MichaReiser added the needs-mre Needs more information for reproduction label Nov 24, 2024

dhruvmanila mentioned this issue Nov 25, 2024

Use Result for failed text document retrieval in LSP requests astral-sh/ruff#14579

Merged

dhruvmanila mentioned this issue Dec 4, 2024

hovering over variable in jupyter notebook causes ruff server to crash astral-sh/ruff#14768

Closed

MichaReiser added bug Something isn't working and removed needs-mre Needs more information for reproduction labels Jan 10, 2025

dhruvmanila mentioned this issue Jan 10, 2025

Insert the cells from the start position astral-sh/ruff#15398

Merged

dhruvmanila closed this as completed in astral-sh/ruff#15398 Jan 10, 2025

dhruvmanila closed this as completed in astral-sh/ruff@6e9ff44 Jan 10, 2025

dhruvmanila mentioned this issue Jan 10, 2025

Ruff Langauge Server crash #573

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ruff in VSCode repteadly crashing on hover: The Ruff language server exited with a panic #644

Ruff in VSCode repteadly crashing on hover: The Ruff language server exited with a panic #644

aflip commented Nov 23, 2024 •

edited

Loading

aflip commented Nov 23, 2024

MichaReiser commented Nov 23, 2024 •

edited

Loading

MichaReiser commented Nov 23, 2024 •

edited

Loading

aflip commented Nov 24, 2024 •

edited

Loading

MichaReiser commented Nov 24, 2024

dhruvmanila commented Nov 25, 2024

dhruvmanila commented Dec 4, 2024

aflip commented Dec 4, 2024

rnckp commented Jan 2, 2025

dhruvmanila commented Jan 3, 2025

Quemoy commented Jan 10, 2025 •

edited

Loading

dhruvmanila commented Jan 10, 2025

dhruvmanila commented Jan 10, 2025

Ruff in VSCode repteadly crashing on hover: The Ruff language server exited with a panic #644

Ruff in VSCode repteadly crashing on hover: The Ruff language server exited with a panic #644

Comments

aflip commented Nov 23, 2024 • edited Loading

aflip commented Nov 23, 2024

MichaReiser commented Nov 23, 2024 • edited Loading

MichaReiser commented Nov 23, 2024 • edited Loading

aflip commented Nov 24, 2024 • edited Loading

MichaReiser commented Nov 24, 2024

dhruvmanila commented Nov 25, 2024

dhruvmanila commented Dec 4, 2024

aflip commented Dec 4, 2024

rnckp commented Jan 2, 2025

dhruvmanila commented Jan 3, 2025

Quemoy commented Jan 10, 2025 • edited Loading

dhruvmanila commented Jan 10, 2025

dhruvmanila commented Jan 10, 2025

aflip commented Nov 23, 2024 •

edited

Loading

MichaReiser commented Nov 23, 2024 •

edited

Loading

MichaReiser commented Nov 23, 2024 •

edited

Loading

aflip commented Nov 24, 2024 •

edited

Loading

Quemoy commented Jan 10, 2025 •

edited

Loading