replaced beginBuild, diagnosticsBegin and diagnosticsEnd with progress

Author: algesten

contributing.md

@@ -306,14 +306,14 @@ The RLS uses some custom extensions to the Language Server Protocol.
 These are all sent from the RLS to an LSP client and are only used to improve
 the user experience by showing progress indicators.
 
-
-* `rustDocument/beginBuild`: notification, no arguments. Sent before a
-  build starts.
-* `rustDocument/diagnosticsBegin`: notification, no arguments. Sent before
-  indexing or any diagnostics from a build are sent (build is likely in progress).
-* `rustDocument/diagnosticsEnd`: notification, no arguments. Sent when a build
-  is complete (successfully or not, or even skipped) and all post-build analysis
-  by the RLS is complete.
+* `window/progress`: notification, `title: "Build"`. Sent before build starts.
+* `window/progress`: notification with `title: "Build"`, repeated for each compile target.
+  * When total amount of work is not known, has field `message` set to the current crate name.
+  * When total amount of work is known, has field `percentage` set to how much of build has started.
+* `window/progress`: notification, `title: "Build"`, `"done": true`. Sent when build ends.
+* `window/progress`: notification, `title: "Diagnostics"`. Sent before analysis of build starts.
+* ... standard LSP `publishDiagnostics`
+* `window/progress`: notification, `title: "Diagnostics"`, `"done": true`. Sent when analysis ends.
 
 #### LSP Client to RLS
 

src/actions/mod.rs

@@ -22,11 +22,11 @@ use span;
 use Span;
 
 use actions::post_build::{BuildResults, PostBuildHandler, DiagnosticsNotifier};
-use actions::notifications::{BeginBuild, DiagnosticsBegin, DiagnosticsEnd, PublishDiagnostics, Progress};
+use actions::notifications::{PublishDiagnostics, Progress};
 use build::*;
 use lsp_data;
 use lsp_data::*;
-use server::{Output, Notification, NoParams};
+use server::{Output, Notification};
 
 use std::collections::HashMap;
 use std::path::{Path, PathBuf};
@@ -198,22 +198,48 @@ impl InitActionContext {
 
     fn build<O: Output>(&self, project_path: &Path, priority: BuildPriority, out: O) {
 
+        lazy_static! {
+            static ref PROGRESS_ID_COUNTER: AtomicUsize = {
+                AtomicUsize::new(0)
+            };
+        }
+
+        fn new_progress_params(id: String, title: &str) -> ProgressParams {
+            ProgressParams {
+                id,
+                title: Some(title.into()),
+                message: None,
+                percentage: None,
+                done: None,
+            }
+        }
+
         // notifier of diagnostics after the build
         struct BuildDiagnosticsNotifier<O: Output> {
             out: O,
             active_build_count: Arc<AtomicUsize>,
+            progress_params: ProgressParams,
         }
 
+        // base progress parameters for notification of the analysis.
+        let diganostics_progress_params = {
+            let id = format!("diagnostics_{}", PROGRESS_ID_COUNTER.fetch_add(1, Ordering::SeqCst));
+            new_progress_params(id, "Diagnostics")
+        };
+
         impl<O: Output> DiagnosticsNotifier for BuildDiagnosticsNotifier<O> {
             fn notify_begin_diagnostics(&self) {
-                self.out.notify(Notification::<DiagnosticsBegin>::new(NoParams {}));
+                let params = self.progress_params.clone();
+                self.out.notify(Notification::<Progress>::new(params));
             }
             fn notify_publish_diagnostics(&self, params: PublishDiagnosticsParams) {
                 self.out.notify(Notification::<PublishDiagnostics>::new(params));
             }
             fn notify_end_diagnostics(&self) {
                 self.active_build_count.fetch_sub(1, Ordering::SeqCst);
-                self.out.notify(Notification::<DiagnosticsEnd>::new(NoParams {}));
+                let mut params = self.progress_params.clone();
+                params.done = Some(true);
+                self.out.notify(Notification::<Progress>::new(params));
             }
         }
 
@@ -225,19 +251,8 @@ impl InitActionContext {
 
         // base progress parameters for notification of this build.
         let progress_params = {
-            lazy_static! {
-                static ref ID_COUNTER: AtomicUsize = {
-                    AtomicUsize::new(0)
-                };
-            }
-
-            ProgressParams {
-                id: format!("progress_{}", ID_COUNTER.fetch_add(1, Ordering::SeqCst)),
-                title: None,
-                message: None,
-                percentage: None,
-                done: None,
-            }
+            let id = format!("progress_{}", PROGRESS_ID_COUNTER.fetch_add(1, Ordering::SeqCst));
+            new_progress_params(id, "Build")
         };
 
         impl<O: Output> ProgressNotifier for BuildProgressNotifier<O> {
@@ -255,7 +270,6 @@ impl InitActionContext {
             }
             fn notify_end_progress(&self) {
                 let mut params = self.progress_params.clone();
-                params.percentage = Some(1.0);
                 params.done = Some(true);
                 self.out.notify(Notification::<Progress>::new(params));
             }
@@ -272,6 +286,7 @@ impl InitActionContext {
                 notifier: Box::new(BuildDiagnosticsNotifier {
                     out: out.clone(),
                     active_build_count: self.active_build_count.clone(),
+                    progress_params: diganostics_progress_params,
                 }),
                 blocked_threads: vec![],
             }
@@ -282,7 +297,6 @@ impl InitActionContext {
             progress_params,
         });
 
-        out.notify(Notification::<BeginBuild>::new(NoParams {}));
         self.active_build_count.fetch_add(1, Ordering::SeqCst);
         self.build_queue
             .request_build(project_path, priority, notifier, pbh);

src/actions/notifications.rs

@@ -389,38 +389,6 @@ impl Action for ShowMessage {
     const METHOD: &'static str = NOTIFICATION__ShowMessage;
 }
 
-/// Custom LSP notification sent to client indicating that the server is currently
-/// processing data and may publish new diagnostics on `rustDocument/diagnosticsEnd`.
-#[derive(Debug)]
-pub struct DiagnosticsBegin;
-
-impl Action for DiagnosticsBegin {
-    type Params = NoParams;
-    const METHOD: &'static str = "rustDocument/diagnosticsBegin";
-}
-
-/// Custom LSP notification sent to client indicating that data processing started
-/// by a `rustDocument`/diagnosticsBegin` has ended.
-/// For each `diagnosticsBegin` message, there is a single `diagnosticsEnd` message.
-/// This means that for multiple active `diagnosticsBegin` messages, there will
-/// be sent multiple `diagnosticsEnd` notifications.
-#[derive(Debug)]
-pub struct DiagnosticsEnd;
-
-impl Action for DiagnosticsEnd {
-    type Params = NoParams;
-    const METHOD: &'static str = "rustDocument/diagnosticsEnd";
-}
-
-/// Custom LSP notification sent to client indicating that a build process has begun.
-#[derive(Debug)]
-pub struct BeginBuild;
-
-impl Action for BeginBuild {
-    type Params = NoParams;
-    const METHOD: &'static str = "rustDocument/beginBuild";
-}
-
 // Notification from server to client for build progress.
 #[derive(Debug)]
 pub struct Progress;

src/actions/post_build.rs

@@ -53,12 +53,12 @@ pub trait DiagnosticsNotifier: Send {
 
 impl PostBuildHandler {
     pub fn handle(mut self, result: BuildResult) {
-        self.notifier.notify_begin_diagnostics();
 
         match result {
             BuildResult::Success(cwd, messages, new_analysis) => {
                 thread::spawn(move || {
                     trace!("build - Success");
+                    self.notifier.notify_begin_diagnostics();
 
                     // Emit appropriate diagnostics using the ones from build.
                     self.handle_messages(&cwd, messages);
@@ -81,11 +81,9 @@ impl PostBuildHandler {
             }
             BuildResult::Squashed => {
                 trace!("build - Squashed");
-                self.notifier.notify_end_diagnostics();
             }
             BuildResult::Err => {
                 trace!("build - Error");
-                self.notifier.notify_end_diagnostics();
             }
         }
     }

src/cmd.rs

@@ -442,7 +442,7 @@ fn init() -> Sender<String> {
             ).to_string(),
         )
         .expect("Error sending init");
-    println!("Initializing (look for `diagnosticsEnd` message)...");
+    println!("Initializing (look for `progress[done:true]` message)...");
 
     sender
 }