hash error messages with sha1 (#1067)

Author: Eskibear

src/daemon/serverLog/logWatcher.ts

@@ -53,25 +53,21 @@ export class LogWatcher {
             if (Date.now() - this.logProcessedTimestamp < 1000) { return; } // reduce frequency of log file I/O.
             const logs = await logsForLatestSession(e.fsPath);
             const errors = collectErrorsSince(logs, this.logProcessedTimestamp);
-            const consentToCollectLogs = vscode.workspace.getConfiguration("java").get<boolean>("help.collectErrorLog");
+            const consentToCollectLogs = vscode.workspace.getConfiguration("java").get<boolean>("help.collectErrorLog") ?? false;
             if (errors) {
                 errors.forEach(e => {
-                    if (consentToCollectLogs) {
-                        sendInfo("", {
-                            name: "jdtls-error",
-                            error: e.message,
-                            stack: e.stack!,
-                            timestamp: e.timestamp!.toString()
-                        });
-                    } else {
-                        const {message, tags} = redact(e.message);
-                        sendInfo("", {
-                            name: "jdtls-error",
-                            error: message,
-                            tags: tags.join(","),
-                            timestamp: e.timestamp!.toString()
-                        })
+                    const {message, tags, hash} = redact(e.message, consentToCollectLogs);
+                    const infoBody: {[key: string]: any} = {
+                        name: "jdtls-error",
+                        error: message,
+                        tags: tags.join(","),
+                        hash: hash,
+                        timestamp: e.timestamp!.toString()
+                    };
+                    if (consentToCollectLogs && e.stack) {
+                        infoBody.stack = e.stack;
                     }
+                    sendInfo("", infoBody);
                 })
             }
             this.logProcessedTimestamp = Date.now();
@@ -111,26 +107,21 @@ export class LogWatcher {
         if (this.serverLogUri) {
             const logs = await logsForLatestSession(path.join(this.serverLogUri?.fsPath, ".log"));
             const errors = collectErrors(logs);
-            const consentToCollectLogs = vscode.workspace.getConfiguration("java").get<boolean>("help.collectErrorLog");
+            const consentToCollectLogs = vscode.workspace.getConfiguration("java").get<boolean>("help.collectErrorLog") ?? false;
             if (errors) {
                 errors.forEach(e => {
-                    if (consentToCollectLogs) {
-                        sendInfo("", {
-                            name: "jdtls-error-in-crashed-session",
-                            error: e.message,
-                            stack: e.stack!,
-                            timestamp: e.timestamp!.toString()
-                        })
-                    } else {
-                        const { message, tags } = redact(e.message);
-                        sendInfo("", {
-                            name: "jdtls-error-in-crashed-session",
-                            error: message,
-                            tags: tags.join(","),
-                            timestamp: e.timestamp!.toString()
-                        })
+                    const {message, tags, hash} = redact(e.message, consentToCollectLogs);
+                    const infoBody: {[key: string]: any} = {
+                        name: "jdtls-error-in-crashed-session",
+                        error: message,
+                        tags: tags.join(","),
+                        hash: hash,
+                        timestamp: e.timestamp!.toString()
+                    };
+                    if (consentToCollectLogs && e.stack) {
+                        infoBody.stack = e.stack;
                     }
-
+                    sendInfo("", infoBody);
                 })
             }
         }

src/daemon/serverLog/whitelist.ts

@@ -1,5 +1,6 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
+import { createHash } from "crypto";
 
 const TAGS: string[] = [
     "buildship",
@@ -42,15 +43,25 @@ const MESSAGE_WHITELIST: string[] = [
     "Workspace restored, but some problems occurred.",
 ];
 
-export function redact(rawMessage: string): {
+export function redact(rawMessage: string, consentToCollectLogs: boolean): {
     message: string;
     tags: string[];
+    hash: string;
 } {
-    const message = MESSAGE_WHITELIST.find(msg => rawMessage.includes(msg)) ?? "";
+    const matchedMessage = MESSAGE_WHITELIST.find(msg => rawMessage.includes(msg));
+    const message = matchedMessage ?? (consentToCollectLogs ? rawMessage : "");
+    const hash = sha1(matchedMessage ?? rawMessage);
     const tags = TAGS.filter(tag => rawMessage.toLocaleLowerCase().includes(tag));
 
     return {
         message,
-        tags
+        tags,
+        hash
     }
+}
+
+function sha1(content: string): string {
+    const hash = createHash("sha1");
+    hash.update(content);
+    return hash.digest('hex');
 }