Add a high-level overview of the RLS #1257

Xanewok · 2019-01-23T22:37:57Z

This is the initial draft, which serves as reading material for the upcoming IDE discussion at Rust All-Hands.

Reviews, ideas about what could we include and the actual content welcome!

Rendered

h-michael

I have nitpicks :)

architecture.md

nrc

Looks good! One general comment: it would be useful to map the abstract descriptions here to modules (or even functions) in the code.

nrc · 2019-01-24T23:08:14Z

architecture.md

@@ -0,0 +1,174 @@
+# Rust Language Server (RLS) - Architecture


Can you link this file from README.md and contributing.md

architecture.md

nrc · 2019-01-24T23:14:19Z

architecture.md

+
+When initialized, (unless overriden by custom build command) RLS `cargo check`s the current project and collects inter-crate [1] dependency graph along with exact crate compilation invocations, which is used later to run the compiler again itself (but in-process).
+
+In-process compilation runs return populated internal data structures (`rls_data::Analysis`), which are further lowered and cross-referenced to expose a low-level indexing API (`rls_analysis::Analysis`) to finally be consumed by the Rust Language Server in order to answer relevant LSP [2] queries.


Would be good to say why we do in-process and also when (and why) we do standard out of process build

nrc · 2019-01-24T23:21:10Z

architecture.md

+This [crate](https://github.com/rust-dev-tools/rls-analysis) is responsible for loading and stitching multiple of
+the `rls_data::Analysis` data structures into a single, coherent interface.
+
+Main reason behind that is that each of those structures contains data centric


Another important reason is that rls-analysis is the 'stable' API, whereas the JSON data format can change at any time and should be considered an implementation detail

architecture.md

nrc · 2019-01-24T23:22:21Z

architecture.md

+build orchestration, and coordination of other components, such as
+* Racer for autocompletion
+* Cargo for project layout detection and initial build coordination
+* internal VFS for handling in-memory text buffers,


spell out VFS here

nrc · 2019-01-24T23:22:56Z

architecture.md

+* Cargo for project layout detection and initial build coordination
+* internal VFS for handling in-memory text buffers,
+* rls-analysis serving as our knowledge database
+


I would add Clippy and Rustfmt to the list (and then I think you can remove "etc")

architecture.md

h-michael · 2019-01-25T00:13:39Z

If you'd like, I want you to write about the relationship between rls and racer :)

Co-Authored-By: Xanewok <[email protected]>

Xanewok · 2019-01-25T16:41:49Z

Thank you for the review!

I'll merge this now so we can easily collaborate on the document together.

@h-michael I'd very much appreciate that, yeah! Mind appending this section to the bottom of the document?

submodule: update rls from c9d25b to e2145d Update rls rust-lang/rls@c9d25b6...e2145d rust-lang/rls#1276 - h-michael:clippy, r=Xanewok rust-lang/rls#1269 - rust-lang:dependabot/cargo/rand-0.6.5, r=Xanewok Remove extra backticks in contributing.md rust-lang/rls#1267 from h-michael/contributingmd rust-lang/rls#1268 from matthiaskrgr/rustup rust-lang/rls#1262 from rust-lang/dependabot/cargo/tokio-0.1.15 rust-lang/rls#1264 - h-michael:pub-crate, r=alexheretic rust-lang/rls#1261 - rust-lang:dependabot/cargo/tokio-timer-0.2.9, r=Xanewok rust-lang/rls#1263 - Xanewok:update-clippy, r=Xanewok rust-lang/rls#1257 from Xanewok/architecture rust-lang/rls#1258 - rust-lang:dependabot/cargo/lsp-types-0.55.1, r=Xanewok rust-lang/rls#1255 - Xanewok:you-only-complete-once-fool, r=Xanewok rust-lang/rls#1252 - rust-lang:dependabot/cargo/cargo_metadata-0.7.0, r=alexheretic rust-lang/rls#1253 - rust-lang:dependabot/cargo/lsp-types-0.55.0, r=Xanewok rust-lang/rls#1254 - rust-lang:dependabot/cargo/serde_json-1.0.37, r=Xanewok dependabot: Explicitly list default allowed_updates dependabot: Add automerge strategy for clippy_lints rust-lang/rls#1251 - Xanewok:translate-deglob-test, r=Xanewok rust-lang/rls#1250 from alexheretic/master rust-lang/rls#1244 - Xanewok:translate-tests, r=alexheretic rust-lang/rls#1247 - alexheretic:register-more-clippy, r=Xanewok rust-lang/rls#1230 - emilio:testing-testing, r=Xanewok rust-lang/rls#1246 from alexheretic/did-save-manifest Merge branch 'beta-version-bump' of https://github.com/rust-lang-nursery/rls

submodule: update rls from c9d25b to f331ff7 Update rls rust-lang/rls@c9d25b6...e2145d rust-lang/rls#1276 - h-michael:clippy, r=Xanewok rust-lang/rls#1269 - rust-lang:dependabot/cargo/rand-0.6.5, r=Xanewok Remove extra backticks in contributing.md rust-lang/rls#1267 from h-michael/contributingmd rust-lang/rls#1268 from matthiaskrgr/rustup rust-lang/rls#1262 from rust-lang/dependabot/cargo/tokio-0.1.15 rust-lang/rls#1264 - h-michael:pub-crate, r=alexheretic rust-lang/rls#1261 - rust-lang:dependabot/cargo/tokio-timer-0.2.9, r=Xanewok rust-lang/rls#1263 - Xanewok:update-clippy, r=Xanewok rust-lang/rls#1257 from Xanewok/architecture rust-lang/rls#1258 - rust-lang:dependabot/cargo/lsp-types-0.55.1, r=Xanewok rust-lang/rls#1255 - Xanewok:you-only-complete-once-fool, r=Xanewok rust-lang/rls#1252 - rust-lang:dependabot/cargo/cargo_metadata-0.7.0, r=alexheretic rust-lang/rls#1253 - rust-lang:dependabot/cargo/lsp-types-0.55.0, r=Xanewok rust-lang/rls#1254 - rust-lang:dependabot/cargo/serde_json-1.0.37, r=Xanewok dependabot: Explicitly list default allowed_updates dependabot: Add automerge strategy for clippy_lints rust-lang/rls#1251 - Xanewok:translate-deglob-test, r=Xanewok rust-lang/rls#1250 from alexheretic/master rust-lang/rls#1244 - Xanewok:translate-tests, r=alexheretic rust-lang/rls#1247 - alexheretic:register-more-clippy, r=Xanewok rust-lang/rls#1230 - emilio:testing-testing, r=Xanewok rust-lang/rls#1246 from alexheretic/did-save-manifest Merge branch 'beta-version-bump' of https://github.com/rust-lang-nursery/rls

Xanewok added 2 commits January 23, 2019 20:26

Architecture plan

cdee218

Initial draft

5ce1a02

h-michael reviewed Jan 24, 2019

View reviewed changes

architecture.md Outdated Show resolved Hide resolved

architecture.md Outdated Show resolved Hide resolved

Link to mentioned crates

31d2aad

nrc approved these changes Jan 24, 2019

View reviewed changes

nrc and others added 4 commits January 25, 2019 17:11

Apply suggestions from code review

f1598c5

Co-Authored-By: Xanewok <[email protected]>

Link to architecture.md from README and contributing doc

5734765

Apply review feedback

2a6ed4a

Link to crates' source in relevant subheadings

2bc02c3

Xanewok merged commit 6acf34e into rust-lang:master Jan 25, 2019

Xanewok deleted the architecture branch January 25, 2019 16:42

h-michael mentioned this pull request Jan 31, 2019

submodule: update rls from c9d25b to f331ff7 rust-lang/rust#58024

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a high-level overview of the RLS #1257

Add a high-level overview of the RLS #1257

Xanewok commented Jan 23, 2019 •

edited

Loading

h-michael left a comment

nrc left a comment

nrc Jan 24, 2019

nrc Jan 24, 2019

nrc Jan 24, 2019

nrc Jan 24, 2019

nrc Jan 24, 2019

h-michael commented Jan 25, 2019 •

edited

Loading

Xanewok commented Jan 25, 2019

		@@ -0,0 +1,174 @@
		# Rust Language Server (RLS) - Architecture


		When initialized, (unless overriden by custom build command) RLS `cargo check`s the current project and collects inter-crate [1] dependency graph along with exact crate compilation invocations, which is used later to run the compiler again itself (but in-process).

		In-process compilation runs return populated internal data structures (`rls_data::Analysis`), which are further lowered and cross-referenced to expose a low-level indexing API (`rls_analysis::Analysis`) to finally be consumed by the Rust Language Server in order to answer relevant LSP [2] queries.

Add a high-level overview of the RLS #1257

Add a high-level overview of the RLS #1257

Conversation

Xanewok commented Jan 23, 2019 • edited Loading

h-michael left a comment

Choose a reason for hiding this comment

nrc left a comment

Choose a reason for hiding this comment

nrc Jan 24, 2019

Choose a reason for hiding this comment

nrc Jan 24, 2019

Choose a reason for hiding this comment

nrc Jan 24, 2019

Choose a reason for hiding this comment

nrc Jan 24, 2019

Choose a reason for hiding this comment

nrc Jan 24, 2019

Choose a reason for hiding this comment

h-michael commented Jan 25, 2019 • edited Loading

Xanewok commented Jan 25, 2019

Xanewok commented Jan 23, 2019 •

edited

Loading

h-michael commented Jan 25, 2019 •

edited

Loading