Refactor: Move SyncWorkspace from Session into ServerState (#7166)

## Description
* Moves `SyncWorkspace` ownership from individual `Session` instances to
a single, global instance within `ServerState`.
* `SyncWorkspace` is now initialized once when the LSP server starts,
creating a single temporary workspace clone.

Also removes the `resync` function. This was causing the server and the
IDE to fall out of sync with each other. For example, if you have 2
panels open and then save a file in one of the tabs but have unsaved
changes in the other tab then those changes would not be reflected in
the temp memory folder. This meant everything would be out of sync. We
already are syncing everything on each keystroke per file so this fn was
not necessary in the first place.

This PR is a precursor to #7139
part of #7111

## Checklist

- [x] I have linked to any relevant issues.
- [x] I have commented my code, particularly in hard-to-understand
areas.
- [ ] I have updated the documentation where relevant (API docs, the
reference, and the Sway book).
- [ ] If my change requires substantial documentation changes, I have
[requested support from the DevRel
team](https://github.com/FuelLabs/devrel-requests/issues/new/choose)
- [x] I have added tests that prove my fix is effective or that my
feature works.
- [x] I have added (or requested a maintainer to add) the necessary
`Breaking*` or `New Feature` labels where relevant.
- [x] I have done my best to ensure that my PR adheres to [the Fuel Labs
Code Review
Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md).
- [x] I have requested a review from the relevant team or maintainers.

---------

Co-authored-by: zees-dev <[email protected]>

Author: JoshuaBatty

sway-core/src/semantic_analysis/namespace/package.rs

@@ -13,7 +13,7 @@ pub struct Package {
     // The contents of the package being compiled.
     root_module: Module,
     // Program id for the package.
-    program_id: ProgramId,
+    pub program_id: ProgramId,
     // True if the current package is a contract, false otherwise.
     is_contract_package: bool,
     // The external dependencies of the current package. Note that an external package is

sway-lsp/benches/lsp_benchmarks/compile.rs

@@ -1,4 +1,6 @@
 use codspeed_criterion_compat::{black_box, criterion_group, Criterion};
+use forc_pkg::manifest::{GenericManifestFile, ManifestFile};
+use lsp_types::Url;
 use std::sync::Arc;
 use sway_core::Engines;
 use sway_lsp::core::session;
@@ -7,13 +9,16 @@ use tokio::runtime::Runtime;
 const NUM_DID_CHANGE_ITERATIONS: usize = 10;
 
 fn benchmarks(c: &mut Criterion) {
-    let (uri, session, _) = Runtime::new()
+    let (uri, session, state) = Runtime::new()
         .unwrap()
         .block_on(async { black_box(super::compile_test_project().await) });
 
+    let sync = state.sync_workspace.get().unwrap();
     let build_plan = session
         .build_plan_cache
-        .get_or_update(&session.sync.manifest_path(), || session::build_plan(&uri))
+        .get_or_update(&sync.workspace_manifest_path(), || {
+            session::build_plan(&uri)
+        })
         .unwrap();
 
     let mut lsp_mode = Some(sway_core::LspConfig {
@@ -35,9 +40,12 @@ fn benchmarks(c: &mut Criterion) {
         let results =
             black_box(session::compile(&build_plan, &engines, None, lsp_mode.as_ref()).unwrap());
         let session = Arc::new(session::Session::new());
+        let member_path = sync.member_path(&uri).unwrap();
+
         b.iter(|| {
             let _ = black_box(
                 session::traverse(
+                    member_path.clone(),
                     results.clone(),
                     &engines,
                     session.clone(),
@@ -59,6 +67,36 @@ fn benchmarks(c: &mut Criterion) {
             }
         })
     });
+
+    let examples_workspace_dir = super::sway_workspace_dir().join("examples");
+    let member_manifests = ManifestFile::from_dir(examples_workspace_dir)
+        .unwrap()
+        .member_manifests()
+        .unwrap();
+    c.bench_function("open_all_example_workspace_members", |b| {
+        b.iter(|| {
+            let engines = Engines::default();
+            for package_manifest in member_manifests.values() {
+                let dir = Url::from_file_path(
+                    package_manifest
+                        .path()
+                        .parent()
+                        .unwrap()
+                        .join("src/main.sw"),
+                )
+                .unwrap();
+                let build_plan = session::build_plan(&dir).unwrap();
+                let _ = black_box(
+                    session::compile(&build_plan, &engines, None, lsp_mode.as_ref()).unwrap(),
+                );
+            }
+        })
+    });
+
+    // Remove the temp dir after the benchmarks are done
+    Runtime::new()
+        .unwrap()
+        .block_on(async { sync.remove_temp_dir() });
 }
 
 criterion_group! {

sway-lsp/benches/lsp_benchmarks/mod.rs

@@ -4,31 +4,36 @@ pub mod token_map;
 
 use lsp_types::Url;
 use std::{path::PathBuf, sync::Arc};
-use sway_lsp::core::{
-    document::Documents,
-    session::{self, Session},
+use sway_lsp::{
+    core::session::{self, Session},
+    server_state::ServerState,
 };
 
-pub async fn compile_test_project() -> (Url, Arc<Session>, Documents) {
+pub async fn compile_test_project() -> (Url, Arc<Session>, ServerState) {
+    // Load the test project
+    let uri = Url::from_file_path(benchmark_dir().join("src/main.sw")).unwrap();
+    let state = ServerState::default();
     let session = Arc::new(Session::new());
-    let documents = Documents::new();
+    let sync = state.get_or_init_global_sync_workspace(&uri).await.unwrap();
+    let temp_uri = sync.workspace_to_temp_url(&uri).unwrap();
+
     let lsp_mode = Some(sway_core::LspConfig {
         optimized_build: false,
         file_versions: Default::default(),
     });
-    // Load the test project
-    let uri = Url::from_file_path(benchmark_dir().join("src/main.sw")).unwrap();
-    documents.handle_open_file(&uri).await;
+
+    state.documents.handle_open_file(&temp_uri).await;
     // Compile the project
     session::parse_project(
-        &uri,
+        &temp_uri,
         &session.engines.read(),
         None,
         lsp_mode,
         session.clone(),
+        &sync,
     )
     .unwrap();
-    (uri, session, documents)
+    (temp_uri, session, state)
 }
 
 pub fn sway_workspace_dir() -> PathBuf {

sway-lsp/benches/lsp_benchmarks/requests.rs

@@ -9,9 +9,10 @@ use sway_lsp::{
 use tokio::runtime::Runtime;
 
 fn benchmarks(c: &mut Criterion) {
-    let (uri, session, documents) = Runtime::new()
+    let (uri, session, state) = Runtime::new()
         .unwrap()
         .block_on(async { black_box(super::compile_test_project().await) });
+    let sync = state.sync_workspace.get().unwrap();
     let config = sway_lsp::config::Config::default();
     let keyword_docs = KeywordDocs::new();
     let position = Position::new(1717, 24);
@@ -46,6 +47,7 @@ fn benchmarks(c: &mut Criterion) {
                 &uri,
                 position,
                 LspClient::default(),
+                sync,
             )
         })
     });
@@ -55,11 +57,11 @@ fn benchmarks(c: &mut Criterion) {
     });
 
     c.bench_function("find_all_references", |b| {
-        b.iter(|| session.token_references(&uri, position))
+        b.iter(|| session.token_references(&uri, position, sync))
     });
 
     c.bench_function("goto_definition", |b| {
-        b.iter(|| session.token_definition_response(&uri, position))
+        b.iter(|| session.token_definition_response(&uri, position, sync))
     });
 
     c.bench_function("inlay_hints", |b| {
@@ -74,7 +76,7 @@ fn benchmarks(c: &mut Criterion) {
     });
 
     c.bench_function("prepare_rename", |b| {
-        b.iter(|| capabilities::rename::prepare_rename(session.clone(), &uri, position))
+        b.iter(|| capabilities::rename::prepare_rename(session.clone(), &uri, position, sync))
     });
 
     c.bench_function("rename", |b| {
@@ -84,6 +86,7 @@ fn benchmarks(c: &mut Criterion) {
                 "new_token_name".to_string(),
                 &uri,
                 position,
+                sync,
             )
         })
     });
@@ -108,12 +111,19 @@ fn benchmarks(c: &mut Criterion) {
                 text: "\n".to_string(),
             }],
         };
-        b.iter(|| capabilities::on_enter::on_enter(&config.on_enter, &documents, &uri, &params))
+        b.iter(|| {
+            capabilities::on_enter::on_enter(&config.on_enter, &state.documents, &uri, &params)
+        })
     });
 
     c.bench_function("format", |b| {
-        b.iter(|| capabilities::formatting::format_text(&documents, &uri))
+        b.iter(|| capabilities::formatting::format_text(&state.documents, &uri))
     });
+
+    // Remove the temp dir after the benchmarks are done
+    Runtime::new()
+        .unwrap()
+        .block_on(async { sync.remove_temp_dir() });
 }
 
 criterion_group! {

sway-lsp/benches/lsp_benchmarks/token_map.rs

@@ -3,9 +3,10 @@ use lsp_types::Position;
 use tokio::runtime::Runtime;
 
 fn benchmarks(c: &mut Criterion) {
-    let (uri, session, _) = Runtime::new()
+    let (uri, session, state) = Runtime::new()
         .unwrap()
         .block_on(async { black_box(super::compile_test_project().await) });
+    let sync = state.sync_workspace.get().unwrap();
     let engines = session.engines.read();
     let position = Position::new(1716, 24);
 
@@ -42,6 +43,11 @@ fn benchmarks(c: &mut Criterion) {
                 .parent_decl_at_position(&engines, &uri, position)
         })
     });
+
+    // Remove the temp dir after the benchmarks are done
+    Runtime::new()
+        .unwrap()
+        .block_on(async { sync.remove_temp_dir() });
 }
 
 criterion_group! {

sway-lsp/src/capabilities/hover/hover_link_contents.rs

@@ -1,5 +1,5 @@
 use crate::{
-    core::{session::Session, token::get_range_from_span},
+    core::{session::Session, sync::SyncWorkspace, token::get_range_from_span},
     utils::document::get_url_from_span,
 };
 use std::sync::Arc;
@@ -30,15 +30,17 @@ pub struct HoverLinkContents<'a> {
     pub implementations: Vec<Span>,
     session: Arc<Session>,
     engines: &'a Engines,
+    sync: &'a SyncWorkspace,
 }
 
 impl<'a> HoverLinkContents<'a> {
-    pub fn new(session: Arc<Session>, engines: &'a Engines) -> Self {
+    pub fn new(session: Arc<Session>, engines: &'a Engines, sync: &'a SyncWorkspace) -> Self {
         Self {
             related_types: Vec::new(),
             implementations: Vec::new(),
             session,
             engines,
+            sync,
         }
     }
 
@@ -77,7 +79,7 @@ impl<'a> HoverLinkContents<'a> {
     /// Adds a single type to the list of related types.
     fn add_related_type(&mut self, name: String, span: &Span, callpath: CallPath) {
         if let Ok(mut uri) = get_url_from_span(self.engines.se(), span) {
-            let converted_url = self.session.sync.temp_to_workspace_url(&uri);
+            let converted_url = self.sync.temp_to_workspace_url(&uri);
             if let Ok(url) = converted_url {
                 uri = url;
             }
@@ -133,10 +135,7 @@ impl<'a> HoverLinkContents<'a> {
         all_spans.append(&mut impl_spans);
         all_spans.dedup();
         for span in &all_spans {
-            let span_result = self
-                .session
-                .sync
-                .temp_to_workspace_span(self.engines.se(), span);
+            let span_result = self.sync.temp_to_workspace_span(self.engines.se(), span);
             if let Ok(span) = span_result {
                 self.implementations.push(span);
             }

sway-lsp/src/capabilities/hover/mod.rs

@@ -2,6 +2,7 @@ pub(crate) mod hover_link_contents;
 
 use self::hover_link_contents::HoverLinkContents;
 use crate::config::LspClient;
+use crate::core::sync::SyncWorkspace;
 use crate::{
     core::{
         session::Session,
@@ -26,6 +27,7 @@ pub fn hover_data(
     url: &Url,
     position: Position,
     client_config: LspClient,
+    sync: &SyncWorkspace,
 ) -> Option<lsp_types::Hover> {
     let t = session.token_map().token_at_position(url, position)?;
     let (ident, token) = t.pair();
@@ -61,6 +63,7 @@ pub fn hover_data(
                 decl_token,
                 &decl_ident.name,
                 client_config.clone(),
+                sync,
             )
         }
         // The `TypeInfo` of the token does not contain an `Ident`. In this case,
@@ -71,6 +74,7 @@ pub fn hover_data(
             token,
             &ident.name,
             client_config.clone(),
+            sync,
         ),
     };
 
@@ -131,6 +135,7 @@ fn hover_format(
     token: &Token,
     ident_name: &str,
     client_config: LspClient,
+    sync: &SyncWorkspace,
 ) -> lsp_types::HoverContents {
     let decl_engine = engines.de();
     let doc_comment = format_doc_attributes(engines, token);
@@ -141,7 +146,7 @@ fn hover_format(
     };
 
     // Used to collect all the information we need to generate links for the hover component.
-    let mut hover_link_contents = HoverLinkContents::new(session, engines);
+    let mut hover_link_contents = HoverLinkContents::new(session, engines, sync);
 
     let sway_block = token
         .as_typed()

sway-lsp/src/capabilities/rename.rs

@@ -1,6 +1,7 @@
 use crate::{
     core::{
         session::Session,
+        sync::SyncWorkspace,
         token::{SymbolKind, Token, TokenIdent, TypedAstToken},
         token_map::TokenMapExt,
     },
@@ -19,6 +20,7 @@ pub fn rename(
     new_name: String,
     url: &Url,
     position: Position,
+    sync: &SyncWorkspace,
 ) -> Result<WorkspaceEdit, LanguageServerError> {
     let _p = tracing::trace_span!("rename").entered();
     // Make sure the new name is not a keyword or a literal int type
@@ -76,7 +78,7 @@ pub fn rename(
         }
         if let Some(path) = &ident.path {
             let url = get_url_from_path(path).ok()?;
-            if let Some(url) = session.sync.to_workspace_url(url) {
+            if let Some(url) = sync.to_workspace_url(url) {
                 let edit = TextEdit::new(range, new_name.clone());
                 return Some((url, vec![edit]));
             };
@@ -102,6 +104,7 @@ pub fn prepare_rename(
     session: Arc<Session>,
     url: &Url,
     position: Position,
+    sync: &SyncWorkspace,
 ) -> Result<PrepareRenameResponse, LanguageServerError> {
     let t = session
         .token_map()
@@ -111,7 +114,7 @@ pub fn prepare_rename(
 
     // Only let through tokens that are in the users workspace.
     // tokens that are external to the users workspace cannot be renamed.
-    let _ = is_token_in_workspace(&session, &session.engines.read(), token)?;
+    let _ = is_token_in_workspace(&session.engines.read(), token, sync)?;
 
     // Make sure we don't allow renaming of tokens that
     // are keywords or intrinsics.
@@ -147,16 +150,16 @@ fn formatted_name(ident: &TokenIdent) -> String {
 
 /// Checks if the token is in the users workspace.
 fn is_token_in_workspace(
-    session: &Arc<Session>,
     engines: &Engines,
     token: &Token,
+    sync: &SyncWorkspace,
 ) -> Result<bool, LanguageServerError> {
     let decl_ident = token
         .declared_token_ident(engines)
         .ok_or(RenameError::TokenNotFound)?;
 
     // Check the span of the tokens definitions to determine if it's in the users workspace.
-    let temp_path = &session.sync.temp_dir()?;
+    let temp_path = &sync.temp_dir()?;
     if let Some(path) = &decl_ident.path {
         if !path.starts_with(temp_path) {
             return Err(LanguageServerError::RenameError(