Merge #1094

1094: Improve cargo-watch animation and refactoring r=matklad a=edwin0cheng

* Refactoring code and fixed some minor bugs.
* Add more error log and better error handling.
* Add current checking artifact name in Cargo-watch animation.

![new_status_animation](https://i.imgur.com/Zr2JLa5.gif)

Co-authored-by: Edwin Cheng <[email protected]>

Author: bors[bot]

editors/code/src/commands/cargo_watch.ts

@@ -68,7 +68,11 @@ export class CargoWatchProvider {
         this.cargoProcess.stdout.on('data', (s: string) => {
             stdoutData.processOutput(s, line => {
                 this.logInfo(line);
-                this.parseLine(line);
+                try {
+                    this.parseLine(line);
+                } catch (err) {
+                    this.logError(`Failed to parse: ${err}, content : ${line}`);
+                }
             });
         });
 
@@ -133,79 +137,99 @@ export class CargoWatchProvider {
             if (s === 'error') {
                 return vscode.DiagnosticSeverity.Error;
             }
-
             if (s.startsWith('warn')) {
                 return vscode.DiagnosticSeverity.Warning;
             }
-
             return vscode.DiagnosticSeverity.Information;
         }
 
-        interface ErrorSpan {
+        // Reference:
+        // https://github.com/rust-lang/rust/blob/master/src/libsyntax/json.rs
+        interface RustDiagnosticSpan {
             line_start: number;
             line_end: number;
             column_start: number;
             column_end: number;
+            is_primary: boolean;
+            file_name: string;
         }
 
-        interface ErrorMessage {
-            reason: string;
-            message: {
-                spans: ErrorSpan[];
-                rendered: string;
-                level: string;
-                code?: {
-                    code: string;
-                };
+        interface RustDiagnostic {
+            spans: RustDiagnosticSpan[];
+            rendered: string;
+            level: string;
+            code?: {
+                code: string;
             };
         }
 
+        interface CargoArtifact {
+            reason: string;
+            package_id: string;
+        }
+
+        // https://github.com/rust-lang/cargo/blob/master/src/cargo/util/machine_message.rs
+        interface CargoMessage {
+            reason: string;
+            package_id: string;
+            message: RustDiagnostic;
+        }
+
         // cargo-watch itself output non json format
         // Ignore these lines
-        let data: ErrorMessage;
+        let data: CargoMessage;
         try {
             data = JSON.parse(line.trim());
         } catch (error) {
-            this.logError(`Fail to pass to json : { ${error} }`);
+            this.logError(`Fail to parse to json : { ${error} }`);
             return;
         }
 
-        // Only handle compiler-message now
-        if (data.reason !== 'compiler-message') {
-            return;
-        }
+        if (data.reason === 'compiler-artifact') {
+            const msg = data as CargoArtifact;
 
-        let spans: any[] = data.message.spans;
-        spans = spans.filter(o => o.is_primary);
+            // The format of the package_id is "{name} {version} ({source_id})",
+            // https://github.com/rust-lang/cargo/blob/37ad03f86e895bb80b474c1c088322634f4725f5/src/cargo/core/package_id.rs#L53
+            this.statusDisplay!.packageName = msg.package_id.split(' ')[0];
+        } else if (data.reason === 'compiler-message') {
+            const msg = data.message as RustDiagnostic;
 
-        // We only handle primary span right now.
-        if (spans.length > 0) {
-            const o = spans[0];
+            const spans = msg.spans.filter(o => o.is_primary);
 
-            const rendered = data.message.rendered;
-            const level = getLevel(data.message.level);
-            const range = new vscode.Range(
-                new vscode.Position(o.line_start - 1, o.column_start - 1),
-                new vscode.Position(o.line_end - 1, o.column_end - 1)
-            );
+            // We only handle primary span right now.
+            if (spans.length > 0) {
+                const o = spans[0];
+
+                const rendered = msg.rendered;
+                const level = getLevel(msg.level);
+                const range = new vscode.Range(
+                    new vscode.Position(o.line_start - 1, o.column_start - 1),
+                    new vscode.Position(o.line_end - 1, o.column_end - 1)
+                );
 
-            const fileName = path.join(vscode.workspace.rootPath!, o.file_name);
-            const diagnostic = new vscode.Diagnostic(range, rendered, level);
+                const fileName = path.join(
+                    vscode.workspace.rootPath!,
+                    o.file_name
+                );
+                const diagnostic = new vscode.Diagnostic(
+                    range,
+                    rendered,
+                    level
+                );
 
-            diagnostic.source = 'rustc';
-            diagnostic.code = data.message.code
-                ? data.message.code.code
-                : undefined;
-            diagnostic.relatedInformation = [];
+                diagnostic.source = 'rustc';
+                diagnostic.code = msg.code ? msg.code.code : undefined;
+                diagnostic.relatedInformation = [];
 
-            const fileUrl = vscode.Uri.file(fileName!);
+                const fileUrl = vscode.Uri.file(fileName!);
 
-            const diagnostics: vscode.Diagnostic[] = [
-                ...(this.diagnosticCollection!.get(fileUrl) || [])
-            ];
-            diagnostics.push(diagnostic);
+                const diagnostics: vscode.Diagnostic[] = [
+                    ...(this.diagnosticCollection!.get(fileUrl) || [])
+                ];
+                diagnostics.push(diagnostic);
 
-            this.diagnosticCollection!.set(fileUrl, diagnostics);
+                this.diagnosticCollection!.set(fileUrl, diagnostics);
+            }
         }
     }
 }

editors/code/src/commands/watch_status.ts

@@ -3,6 +3,8 @@ import * as vscode from 'vscode';
 const spinnerFrames = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
 
 export class StatusDisplay {
+    public packageName?: string;
+
     private i = 0;
     private statusBarItem: vscode.StatusBarItem;
     private timer?: NodeJS.Timeout;
@@ -17,10 +19,18 @@ export class StatusDisplay {
     }
 
     public show() {
+        this.packageName = undefined;
+
         this.timer =
             this.timer ||
             setInterval(() => {
-                this.statusBarItem!.text = 'cargo check ' + this.frame();
+                if (this.packageName) {
+                    this.statusBarItem!.text = `cargo check [${
+                        this.packageName
+                    }] ${this.frame()}`;
+                } else {
+                    this.statusBarItem!.text = `cargo check ${this.frame()}`;
+                }
             }, 300);
 
         this.statusBarItem!.show();