Merge pull request #231 from algesten/progress-params

accept window/progress instead of beginBuild/diagnosticEnd

Author: Xanewok

src/extension.ts

@@ -129,7 +129,7 @@ function makeRlsProcess(): Promise<child_process.ChildProcess> {
     });
 
     return childProcessPromise.catch(() => {
-        window.setStatusBarMessage('RLS could not be started');
+        stopSpinner('RLS could not be started');
         return Promise.reject(undefined);
     });
 }
@@ -151,7 +151,7 @@ function startLanguageClient(context: ExtensionContext)
     }
     warnOnMissingCargoToml();
 
-    window.setStatusBarMessage('RLS: starting up');
+    startSpinner('RLS', 'Starting');
 
     warnOnRlsToml();
     // Check for deprecated env vars.
@@ -172,7 +172,7 @@ function startLanguageClient(context: ExtensionContext)
     // Create the language client and start the client.
     lc = new LanguageClient('Rust Language Server', serverOptions, clientOptions);
 
-    diagnosticCounter();
+    progressCounter();
 
     const disposable = lc.start();
     context.subscriptions.push(disposable);
@@ -207,17 +207,45 @@ async function autoUpdate() {
     }
 }
 
-function diagnosticCounter() {
+function progressCounter() {
+    const runningProgress: Set<string> = new Set();
+    const asPercent = (fraction: number): string => `${Math.round(fraction * 100)}%`;
     let runningDiagnostics = 0;
     lc.onReady().then(() => {
-        lc.onNotification(new NotificationType('rustDocument/beginBuild'), function(_f: any) {
+
+        stopSpinner('RLS');
+
+        lc.onNotification(new NotificationType('window/progress'), function (progress: any) {
+            if (progress.done) {
+                runningProgress.delete(progress.id);
+            } else {
+                runningProgress.add(progress.id);
+            }
+            if (runningProgress.size) {
+                let status = '';
+                if (typeof progress.percentage === 'number') {
+                    status = asPercent(progress.percentage);
+                } else if (progress.message) {
+                    status = progress.message;
+                } else if (progress.title) {
+                    status = `[${progress.title.toLowerCase()}]`;
+                }
+                startSpinner('RLS', status);
+            } else {
+                stopSpinner('RLS');
+            }
+        });
+
+        // FIXME these are legacy notifications used by RLS ca jan 2018.
+        // remove once we're certain we've progress on.
+        lc.onNotification(new NotificationType('rustDocument/beginBuild'), function (_f: any) {
             runningDiagnostics++;
-            startSpinner('RLS: working');
+            startSpinner('RLS', 'working');
         });
-        lc.onNotification(new NotificationType('rustDocument/diagnosticsEnd'), function(_f: any) {
+        lc.onNotification(new NotificationType('rustDocument/diagnosticsEnd'), function (_f: any) {
             runningDiagnostics--;
             if (runningDiagnostics <= 0) {
-                stopSpinner('RLS: done');
+                stopSpinner('RLS');
             }
         });
     });

src/rustup.ts

@@ -25,7 +25,7 @@ export function runRlsViaRustup(env: any): Promise<child_process.ChildProcess> {
 }
 
 export async function rustupUpdate() {
-    startSpinner('Updating RLS...');
+    startSpinner('RLS', 'Updating…');
 
     try {
         const { stdout } = await execChildProcess(CONFIGURATION.rustupPath + ' update');
@@ -74,7 +74,7 @@ async function hasToolchain(): Promise<boolean> {
 }
 
 async function tryToInstallToolchain(): Promise<void> {
-    startSpinner('Installing toolchain...');
+    startSpinner('RLS', 'Installing toolchain…');
     try {
         const { stdout, stderr } = await execChildProcess(CONFIGURATION.rustupPath + ' toolchain install ' + CONFIGURATION.channel);
         console.log(stdout);
@@ -129,7 +129,7 @@ async function hasRlsComponents(): Promise<boolean> {
 }
 
 async function installRls(): Promise<void> {
-    startSpinner('Installing RLS components');
+    startSpinner('RLS', 'Installing components');
 
     const tryFn: (component: string) => Promise<(Error | null)> = async (component: string) => {
         try {

src/spinner.ts

@@ -12,14 +12,15 @@
 
 import { window } from 'vscode';
 
-export function startSpinner(message: string) {
-    if (spinnerTimer == null) {
-        let state = 0;
-        spinnerTimer = setInterval(function() {
-            window.setStatusBarMessage(message + ' ' + spinner[state]);
-            state = (state + 1) % spinner.length;
-        }, 100);
+export function startSpinner(prefix: string, postfix: string) {
+    if (spinnerTimer != null) {
+        clearInterval(spinnerTimer);
     }
+    let state = 0;
+    spinnerTimer = setInterval(function() {
+        window.setStatusBarMessage(prefix + ' ' + spinner[state] + ' ' + postfix);
+        state = (state + 1) % spinner.length;
+    }, 100);
 }
 
 export function stopSpinner(message: string) {