log reanalyze invalid json messages in a more elaborate way, including an instruction on what to do with the error

Author: zth

client/src/commands.ts

@@ -1,4 +1,4 @@
-import { DiagnosticCollection } from "vscode";
+import { DiagnosticCollection, OutputChannel } from "vscode";
 
 import {
   DiagnosticsResultCodeActionsMap,
@@ -12,11 +12,13 @@ export { switchImplIntf } from "./commands/switch_impl_intf";
 export const codeAnalysisWithReanalyze = (
   targetDir: string | null,
   diagnosticsCollection: DiagnosticCollection,
-  diagnosticsResultCodeActions: DiagnosticsResultCodeActionsMap
+  diagnosticsResultCodeActions: DiagnosticsResultCodeActionsMap,
+  outputChannel: OutputChannel
 ) => {
   runCodeAnalysisWithReanalyze(
     targetDir,
     diagnosticsCollection,
-    diagnosticsResultCodeActions
+    diagnosticsResultCodeActions,
+    outputChannel
   );
 };

client/src/commands/code_analysis.ts

@@ -12,6 +12,7 @@ import {
   CodeAction,
   CodeActionKind,
   WorkspaceEdit,
+  OutputChannel,
 } from "vscode";
 
 export type DiagnosticsResultCodeActionsMap = Map<
@@ -157,7 +158,8 @@ let getAnalysisBinaryPath = (): string | null => {
 export const runCodeAnalysisWithReanalyze = (
   targetDir: string | null,
   diagnosticsCollection: DiagnosticCollection,
-  diagnosticsResultCodeActions: DiagnosticsResultCodeActionsMap
+  diagnosticsResultCodeActions: DiagnosticsResultCodeActionsMap,
+  outputChannel: OutputChannel
 ) => {
   let currentDocument = window.activeTextEditor.document;
   let cwd = targetDir ?? path.dirname(currentDocument.uri.fsPath);
@@ -207,8 +209,20 @@ export const runCodeAnalysisWithReanalyze = (
     try {
       json = JSON.parse(data);
     } catch (e) {
-      window.showErrorMessage(
-        `Something went wrong parsing the json output of reanalyze: '${e}'`
+      window
+        .showErrorMessage(
+          `Something went wrong when running the code analyzer.`,
+          "See details in error log"
+        )
+        .then((_choice) => {
+          outputChannel.show();
+        });
+
+      outputChannel.appendLine("--invalid json start--");
+      outputChannel.append(data);
+      outputChannel.appendLine("--invalid json end--");
+      outputChannel.appendLine(
+        "Parsing JSON from reanalyze failed. The raw, invalid JSON is logged above this message. Please report this on the extension bug tracker: https://github.com/rescript-lang/rescript-vscode/issues"
       );
     }
 

client/src/extension.ts

@@ -70,6 +70,11 @@ let client: LanguageClient;
 // });
 
 export function activate(context: ExtensionContext) {
+  let outputChannel = window.createOutputChannel(
+    "ReScript Language Server",
+    "rescript"
+  );
+
   function createLanguageClient() {
     // The server is implemented in node
     let serverModule = context.asAbsolutePath(
@@ -99,6 +104,7 @@ export function activate(context: ExtensionContext) {
       initializationOptions: {
         extensionConfiguration: workspace.getConfiguration("rescript.settings"),
       },
+      outputChannel,
     };
 
     const client = new LanguageClient(
@@ -123,7 +129,8 @@ export function activate(context: ExtensionContext) {
                 customCommands.codeAnalysisWithReanalyze(
                   inCodeAnalysisState.activatedFromDirectory,
                   diagnosticsCollection,
-                  diagnosticsResultCodeActions
+                  diagnosticsResultCodeActions,
+                  outputChannel
                 );
               }
             })
@@ -207,7 +214,8 @@ export function activate(context: ExtensionContext) {
     customCommands.codeAnalysisWithReanalyze(
       inCodeAnalysisState.activatedFromDirectory,
       diagnosticsCollection,
-      diagnosticsResultCodeActions
+      diagnosticsResultCodeActions,
+      outputChannel
     );
   });