Add diagnostics command to help troubleshoot Ruby LSP issues

st0012 · st0012 · commit 7838039fdc42 · 2024-08-16T21:46:09.000+01:00
- Implement `diagnoseIssues` function in new `issueDiagnosingHelper.ts` file
- Add new command `rubyLsp.diagnoseIssues` in `package.json`
- Register the new command in `rubyLsp.ts`
- Collect and display diagnostic information including:
  - VS Code version
  - Ruby LSP version
  - Installed Ruby LSP addons
  - Relevant installed VS Code extensions

This feature will help users and maintainers quickly gather relevant information
for troubleshooting Ruby LSP related issues.
diff --git a/vscode/package.json b/vscode/package.json
@@ -140,6 +140,11 @@
         "title": "Ruby file operations",
         "category": "Ruby LSP",
         "icon": "$(ruby)"
+      },
+      {
+        "command": "rubyLsp.diagnoseIssues",
+        "title": "Diagnose issues",
+        "category": "Ruby LSP"
       }
     ],
     "configuration": {
diff --git a/vscode/src/common.ts b/vscode/src/common.ts
@@ -26,6 +26,7 @@ export enum Command {
   RailsGenerate = "rubyLsp.railsGenerate",
   RailsDestroy = "rubyLsp.railsDestroy",
   NewMinitestFile = "rubyLsp.newMinitestFile",
+  DiagnoseIssues = "rubyLsp.diagnoseIssues",
 }
 
 export interface RubyInterface {
diff --git a/vscode/src/issueDiagnosingHelper.ts b/vscode/src/issueDiagnosingHelper.ts
@@ -0,0 +1,97 @@
+import * as vscode from "vscode";
+
+import { Workspace } from "./workspace";
+
+export async function diagnoseIssues(workspace: Workspace | undefined) {
+  if (!workspace) {
+    await vscode.window.showErrorMessage("No active Ruby workspace found.");
+    return;
+  }
+
+  const diagnosticInfo = await collectDiagnosticInfo(workspace);
+  const panel = vscode.window.createWebviewPanel(
+    "rubyLspDiagnostics",
+    "Ruby LSP Diagnostics",
+    vscode.ViewColumn.One,
+    { enableScripts: true },
+  );
+
+  panel.webview.html = generateDiagnosticsHtml(diagnosticInfo);
+}
+
+async function collectDiagnosticInfo(
+  workspace: Workspace,
+): Promise<Record<string, string | string[]>> {
+  const vscodeVersion = vscode.version;
+  const rubyLspVersion = workspace.lspClient?.serverVersion ?? "Unknown";
+  const rubyLspAddons =
+    workspace.lspClient?.addons?.map((addon) => addon.name) ?? [];
+  const extensions = await getPublicExtensions();
+
+  return {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    "VS Code Version": vscodeVersion,
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    "Ruby LSP Version": rubyLspVersion,
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    "Ruby LSP Addons": rubyLspAddons,
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    "Installed Extensions": extensions,
+  };
+}
+
+async function getPublicExtensions(): Promise<string[]> {
+  return vscode.extensions.all
+    .filter((ext) => {
+      // Filter out built-in extensions
+      if (ext.packageJSON.isBuiltin) {
+        return false;
+      }
+
+      // Check for marketplace identifier
+      const galleryExtension = ext.packageJSON?.extensionPack?.[0] ?? ext.id;
+      return galleryExtension.includes(".");
+    })
+    .map((ext) => `${ext.packageJSON.name} (${ext.packageJSON.version})`);
+}
+
+function generateDiagnosticsHtml(
+  info: Record<string, string | string[]>,
+): string {
+  let html = `
+    <!DOCTYPE html>
+    <html lang="en">
+    <head>
+      <meta charset="UTF-8">
+      <meta name="viewport" content="width=device-width, initial-scale=1.0">
+      <title>Ruby LSP Diagnostics</title>
+      <style>
+        body { font-family: var(--vscode-font-family); padding: 20px; }
+        h1 { color: var(--vscode-editor-foreground); }
+        dl { margin-left: 20px; }
+        dt { font-weight: bold; margin-top: 10px; color: var(--vscode-editor-foreground); }
+        dd { margin-left: 20px; color: var(--vscode-editor-foreground); }
+      </style>
+    </head>
+    <body>
+      <h1>Ruby LSP Diagnostics</h1>
+      <dl>
+  `;
+
+  for (const [key, value] of Object.entries(info)) {
+    html += `<dt>${key}:</dt>`;
+    if (Array.isArray(value)) {
+      html += `<dd><ul>${value.map((val) => `<li>${val}</li>`).join("")}</ul></dd>`;
+    } else {
+      html += `<dd>${value}</dd>`;
+    }
+  }
+
+  html += `
+      </dl>
+    </body>
+    </html>
+  `;
+
+  return html;
+}
diff --git a/vscode/src/rubyLsp.ts b/vscode/src/rubyLsp.ts
@@ -17,6 +17,7 @@ import { Debugger } from "./debugger";
 import { DependenciesTree } from "./dependenciesTree";
 import { Rails } from "./rails";
 import { ChatAgent } from "./chatAgent";
+import { diagnoseIssues } from "./issueDiagnosingHelper";
 
 // The RubyLsp class represents an instance of the entire extension. This should only be instantiated once at the
 // activation event. One instance of this class controls all of the existing workspaces, telemetry and handles all
@@ -570,6 +571,10 @@ export class RubyLsp {
         await vscode.commands.executeCommand(pick.command, ...pick.args);
       }),
       vscode.commands.registerCommand(Command.NewMinitestFile, newMinitestFile),
+      vscode.commands.registerCommand(Command.DiagnoseIssues, async () => {
+        const workspace = await this.showWorkspacePick();
+        await diagnoseIssues(workspace);
+      }),
     );
   }
 

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ export enum Command {`
`26`	`26`	`RailsGenerate = "rubyLsp.railsGenerate",`
`27`	`27`	`RailsDestroy = "rubyLsp.railsDestroy",`
`28`	`28`	`NewMinitestFile = "rubyLsp.newMinitestFile",`
	`29`	`+ DiagnoseIssues = "rubyLsp.diagnoseIssues",`
`29`	`30`	`}`
`30`	`31`
`31`	`32`	`export interface RubyInterface {`