feature: teach rust-analyzer to discover `linked_projects` #17246

davidbarsky · 2024-05-16T16:57:47Z

This PR's been a long-time coming, but like the title says, it introduces server-side project discovery and removes the extension hooks I previously introduced. I don't think this PR is ready to land, but here are the things I'm feeling squishy about:

I don't think I like the idea of introducing the cargo-metadata command-but-for-everything-else in the flycheck module, but the progress reporting infrastructure was too convenient to pass up. Happy to move it elsewhere.

Here are the things I know I need to change:

For progress reporting, I'm extracting from a serde_json::Value that corresponds to tracing_subsciber::fmt::Layer's JSON output. I'd like to make this a bit more structured/documented than the current nonsense I wrote.
The progress reporting currently hardcodes "Buck"; it should be deriving that from the previously mentioned more-structured-output.
This doesn't handle reloading when a corresponding buildfile is changed. It should be doing that.

Anyway, here's a video of rust-analyzer discovering a Buck target.

rust-project.mov

Veykril

Haven't looked at the main_loop.rs and reload.rs changes yet, will do that tomorrow

Veykril · 2024-05-22T19:46:41Z

crates/rust-analyzer/src/reload.rs

        if self.config.linked_or_discovered_projects() != old_config.linked_or_discovered_projects()
        {
-            self.fetch_workspaces_queue.request_op("discovered projects changed".to_owned(), false)
+            self.fetch_workspaces_queue.request_op("discovered projects changed".to_owned(), true)


Seeing this we should probably make this an enum (I'm at fault for introducing a bool here and being lazy)

I can change this to an enum, since I'm doing a bunch of surgery here anyways: would something like (bad namesincoming!) ReloadBehavior { Force, Done } be a decent starting point?

crates/project-model/Cargo.toml

crates/rust-analyzer/src/config.rs

crates/rust-analyzer/src/lsp/utils.rs

Veykril · 2024-05-22T20:08:04Z

I don't think I like the idea of introducing the cargo-metadata command-but-for-everything-else in the flycheck module, but the progress reporting infrastructure was too convenient to pass up. Happy to move it elsewhere.

The flycheck crate is a mess now (at least name wise) anyways as it also does stuff for the test explorer, so that doesn't really make things a lot worse now...

bors · 2024-05-23T18:27:08Z

☔ The latest upstream changes (presumably #17287) made this pull request unmergeable. Please resolve the merge conflicts.

bors · 2024-05-24T18:39:10Z

☔ The latest upstream changes (presumably #17275) made this pull request unmergeable. Please resolve the merge conflicts.

crates/rust-analyzer/src/config.rs

bors · 2024-06-01T08:52:25Z

☔ The latest upstream changes (presumably #17278) made this pull request unmergeable. Please resolve the merge conflicts.

davidbarsky · 2024-06-05T18:02:56Z

For "reload rust-analyzer reasons when a TARGETS/BUCK file changes"; this PR is based atop of #16840.

Summary: To support rust-lang/rust-analyzer#17246, I've added an argument for logging using JSON to that rust-analyzer can use these fields for progress reporting. Reviewed By: Wilfred Differential Revision: D57924551 fbshipit-source-id: 992e9e096fdea1eefe2b199d8dd84be7b247a732

bors · 2024-06-06T09:13:02Z

☔ The latest upstream changes (presumably #17346) made this pull request unmergeable. Please resolve the merge conflicts.

bors · 2024-06-11T09:01:53Z

☔ The latest upstream changes (presumably #17374) made this pull request unmergeable. Please resolve the merge conflicts.

cormacrelf · 2024-07-15T12:37:01Z

crates/flycheck/src/project_json.rs

+
+#[derive(PartialEq, Clone, Debug, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub enum Arguments {


Suggest DiscoverArgument or similar. This gets used below as project_json::Arguments which is not entirely self-explanatory. And since this is the interface that other build systems will program their project discovery tools against, needs some docs -- what does RA want them to do, roughly, for Path vs Label?

yeah, i'll add those docs today. thanks!

(the tl;dr is that it assumes a somewhat expansive client like Buck's rust-project because the smarts can't live in rust-analyzer.)

crates/flycheck/src/project_json.rs

crates/rust-analyzer/src/reload.rs

docs/user/generated_config.adoc

davidbarsky · 2024-07-18T16:14:24Z

@bors r=@Veykril

bors · 2024-07-18T16:14:26Z

📌 Commit db43a5a has been approved by Veykril

It is now in the queue for this repository.

bors · 2024-07-18T16:15:34Z

⌛ Testing commit db43a5a with merge 52143a5...

bors · 2024-07-18T16:30:09Z

☀️ Test successful - checks-actions
Approved by: Veykril
Pushing 52143a5 to master...

…ification, r=Veykril chore: remove `UnindexinedProject` notification This PR is split out from #17246 (and contains its changes, which is a little annoying from a review perspective...). I'd like to land this change a week or so after #17246 lands in order to give any users of the unindexed project notification time to adopt migrate.

…oject-notification, r=Veykril chore: remove `UnindexinedProject` notification This PR is split out from rust-lang/rust-analyzer#17246 (and contains its changes, which is a little annoying from a review perspective...). I'd like to land this change a week or so after rust-lang#17246 lands in order to give any users of the unindexed project notification time to adopt migrate.

`linkedProjects` is owned by the user's configuration, so when users update this setting, `linkedProjects` is reset. This is problematic when `linkedProjects` also contains projects discovered with `discoverCommand`. The buggy behaviour occurred when: (1) The user configures `discoverCommand` and loads a Rust project. (2) The user changes any setting in VS Code, so rust-analyzer receives `workspace/didChangeConfiguration`. (3) `handle_did_change_configuration` ultimately calls `Client::apply_change_with_sink()`, which updates `config.user_config` and discards any items we added in `linkedProjects`. Instead, separate out `discovered_projects_from_filesystem` and `discovered_projects_from_command` from user configuration, so user settings cannot affect any type of discovered project. This fixes the subtle issue mentioned here: rust-lang#17246 (comment)

fix: Updating settings should not clobber discovered projects `linkedProjects` is owned by the user's configuration, so when users update this setting, `linkedProjects` is reset. This is problematic when `linkedProjects` also contains projects discovered with `discoverCommand`. The buggy behaviour occurred when: (1) The user configures `discoverCommand` and loads a Rust project. (2) The user changes any setting in VS Code, so rust-analyzer receives `workspace/didChangeConfiguration`. (3) `handle_did_change_configuration` ultimately calls `Client::apply_change_with_sink()`, which updates `config.user_config` and discards any items we added in `linkedProjects`. Instead, separate out `discovered_projects_from_filesystem` and `discovered_projects_from_command` from user configuration, so user settings cannot affect any type of discovered project. This fixes the subtle issue mentioned here: #17246 (comment)

`linkedProjects` is owned by the user's configuration, so when users update this setting, `linkedProjects` is reset. This is problematic when `linkedProjects` also contains projects discovered with `discoverCommand`. The buggy behaviour occurred when: (1) The user configures `discoverCommand` and loads a Rust project. (2) The user changes any setting in VS Code, so rust-analyzer receives `workspace/didChangeConfiguration`. (3) `handle_did_change_configuration` ultimately calls `Client::apply_change_with_sink()`, which updates `config.user_config` and discards any items we added in `linkedProjects`. Instead, separate out `discovered_projects_from_filesystem` and `discovered_projects_from_command` from user configuration, so user settings cannot affect any type of discovered project. This fixes the subtle issue mentioned here: rust-lang/rust-analyzer#17246 (comment)

fix: Updating settings should not clobber discovered projects `linkedProjects` is owned by the user's configuration, so when users update this setting, `linkedProjects` is reset. This is problematic when `linkedProjects` also contains projects discovered with `discoverCommand`. The buggy behaviour occurred when: (1) The user configures `discoverCommand` and loads a Rust project. (2) The user changes any setting in VS Code, so rust-analyzer receives `workspace/didChangeConfiguration`. (3) `handle_did_change_configuration` ultimately calls `Client::apply_change_with_sink()`, which updates `config.user_config` and discards any items we added in `linkedProjects`. Instead, separate out `discovered_projects_from_filesystem` and `discovered_projects_from_command` from user configuration, so user settings cannot affect any type of discovered project. This fixes the subtle issue mentioned here: rust-lang/rust-analyzer#17246 (comment)

rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 16, 2024

davidbarsky force-pushed the david/move-rust-project-generation-to-server branch 4 times, most recently from 378ef57 to e62932f Compare May 22, 2024 16:26

Veykril reviewed May 22, 2024

View reviewed changes

davidbarsky force-pushed the david/move-rust-project-generation-to-server branch 2 times, most recently from ace6d7d to 1003808 Compare May 22, 2024 21:22

davidbarsky force-pushed the david/move-rust-project-generation-to-server branch from 1003808 to 57fa458 Compare May 23, 2024 22:35

Veykril added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 27, 2024

davidbarsky force-pushed the david/move-rust-project-generation-to-server branch from 57fa458 to 1404d02 Compare May 29, 2024 20:58

mathew-horner reviewed May 29, 2024

View reviewed changes

crates/rust-analyzer/src/config.rs Outdated Show resolved Hide resolved

davidbarsky force-pushed the david/move-rust-project-generation-to-server branch from 1404d02 to ce2c55c Compare May 30, 2024 23:08

davidbarsky mentioned this pull request Jun 3, 2024

[WIP]: generating rust-project file for r-a rust-lang/rust#120611

Draft

davidbarsky force-pushed the david/move-rust-project-generation-to-server branch from ce2c55c to be92e74 Compare June 5, 2024 15:00

davidbarsky force-pushed the david/move-rust-project-generation-to-server branch 3 times, most recently from 93e6138 to 7d6408a Compare June 10, 2024 20:51

davidbarsky mentioned this pull request Jun 11, 2024

Allow rust-project.json to include arbitrary shell commands for runnables #16840

Merged

davidbarsky force-pushed the david/move-rust-project-generation-to-server branch from 7d6408a to 651983d Compare June 11, 2024 17:45

davidbarsky mentioned this pull request Jun 11, 2024

chore: remove UnindexinedProject notification #17395

Merged

davidbarsky force-pushed the david/move-rust-project-generation-to-server branch from f4fe143 to 2f44eb0 Compare July 9, 2024 23:13

cormacrelf reviewed Jul 15, 2024

View reviewed changes

davidbarsky force-pushed the david/move-rust-project-generation-to-server branch 3 times, most recently from acf5f3c to f3ee31f Compare July 18, 2024 13:46

feature: move linked_projects discovery to the rust-analyzer server

db43a5a

davidbarsky force-pushed the david/move-rust-project-generation-to-server branch from f3ee31f to db43a5a Compare July 18, 2024 16:01

bors merged commit 52143a5 into rust-lang:master Jul 18, 2024
11 checks passed

davidbarsky deleted the david/move-rust-project-generation-to-server branch July 18, 2024 17:16

This was referenced Jul 22, 2024

Integration with rust-analyzer's automatic project discovery bazelbuild/rules_rust#2755

Open

rust-analyzer ignores linkedProjects after version 0.4.2040 #17664

Closed

levino mentioned this pull request Jul 24, 2024

Regression in v0.3.2045 #17681

Closed

cormacrelf mentioned this pull request Jul 26, 2024

minor: Read workspace root ratomls on startup #17661

Merged

davidbarsky mentioned this pull request Aug 9, 2024

Support .rust-project.json (i.e. hidden) #17816

Closed

ojeda mentioned this pull request Aug 12, 2024

rust-analyzer wanted features & bugfixes Rust-for-Linux/linux#1051

Open

5 tasks

Wilfred mentioned this pull request Sep 5, 2024

fix: Updating settings should not clobber discovered projects #18059

Merged

torshepherd mentioned this pull request Sep 12, 2024

Configuration Provider API clangd/vscode-clangd#436

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: teach rust-analyzer to discover `linked_projects` #17246

feature: teach rust-analyzer to discover `linked_projects` #17246

davidbarsky commented May 16, 2024 •

edited

Loading

Veykril left a comment

Veykril May 22, 2024

davidbarsky May 23, 2024

Veykril commented May 22, 2024

bors commented May 23, 2024

bors commented May 24, 2024

bors commented Jun 1, 2024

davidbarsky commented Jun 5, 2024

bors commented Jun 6, 2024

bors commented Jun 11, 2024

cormacrelf Jul 15, 2024

davidbarsky Jul 15, 2024

davidbarsky commented Jul 18, 2024

bors commented Jul 18, 2024

bors commented Jul 18, 2024

bors commented Jul 18, 2024

feature: teach rust-analyzer to discover linked_projects #17246

feature: teach rust-analyzer to discover linked_projects #17246

Conversation

davidbarsky commented May 16, 2024 • edited Loading

Veykril left a comment

Choose a reason for hiding this comment

Veykril May 22, 2024

Choose a reason for hiding this comment

davidbarsky May 23, 2024

Choose a reason for hiding this comment

Veykril commented May 22, 2024

bors commented May 23, 2024

bors commented May 24, 2024

bors commented Jun 1, 2024

davidbarsky commented Jun 5, 2024

bors commented Jun 6, 2024

bors commented Jun 11, 2024

cormacrelf Jul 15, 2024

Choose a reason for hiding this comment

davidbarsky Jul 15, 2024

Choose a reason for hiding this comment

davidbarsky commented Jul 18, 2024

bors commented Jul 18, 2024

bors commented Jul 18, 2024

bors commented Jul 18, 2024

feature: teach rust-analyzer to discover `linked_projects` #17246

feature: teach rust-analyzer to discover `linked_projects` #17246

davidbarsky commented May 16, 2024 •

edited

Loading