feat: enhance LSP diagnostics with better error handling and server identification #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

riatzukiza wants to merge 8 commits into dev from feat/lsp-server-id

packages/opencode/src/lsp/client.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -129,9 +129,24 @@ export namespace LSPClient { @@
           },
           notify: {
             async open(input: { path: string }) {
-              input.path = path.isAbsolute(input.path) ? input.path : path.resolve(Instance.directory, input.path)
+              input.path = path.isAbsolute(input.path)
+                ? input.path
+                : path.resolve(Instance.directory, input.path)
               const file = Bun.file(input.path)
-              const text = await file.text()
+              let text = ""
+              try {
+                text = await file.text()
+              } catch (error) {
+                // Check if it's a file not found error
+                if (error && typeof error === "object" && "code" in error && error.code === "ENOENT") {
+                  // File doesn't exist, use empty content
+                  text = ""
+                } else {
+                  // Log other I/O errors and rethrow
+                  log.error(`Failed to read file ${input.path}:`, { error })
+                  throw error
+                }
+              }
               const extension = path.extname(input.path)
               const languageId = LANGUAGE_EXTENSIONS[extension] ?? "plaintext"
@@ Expand Down @@

packages/opencode/src/lsp/index.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -8,6 +8,7 @@ import { spawn } from "child_process" @@
     import { Instance } from "../project/instance"
     import { Bus } from "../bus"
+    import { formatDiagnosticsWithServers as formatDiagnosticsWithServersUtil } from "../util/diagnostic"
     export namespace LSP {
       const log = Log.create({ service: "lsp" })
@@ Expand Down Expand Up / @@ -320,5 +321,24 @@ export namespace LSP { @@
           return `${severity} [${line}:${col}] ${diagnostic.message}`
         }
+        export function prettyWithServer(diagnostic: LSPClient.Diagnostic, serverID: string) {
+          const sanitizedServerID = serverID
+            .replace(/[\x00-\x1F\x7F]/g, "") // Remove control characters
+            .replace(/[\r\n]/g, "") // Remove newlines
+            .replace(/[\[\]]/g, "") // Remove square brackets
+            .replace(/[{}|\\]/g, "") // Remove other potentially problematic chars
+            .replace(/[^a-zA-Z0-9_-]/g, "_") // Replace other unsafe chars with underscore
+            .substring(0, 50) // Limit length
+            .trim() || "Unknown"
+          return `${pretty(diagnostic)} [${sanitizedServerID}]`
+        }
+        export function formatDiagnosticsWithServers(
+          diagnostics: Array<{ diagnostic: LSPClient.Diagnostic; serverID: string }>,
+        ): string {
+          return formatDiagnosticsWithServersUtil(diagnostics)
+        }
       }
     }

packages/opencode/src/util/diagnostic.ts

-Original file line number
+Diff line change
@@ -0,0 +1,183 @@
+    import { LSPClient } from "../lsp/client"
+    import type { Diagnostic } from "vscode-languageserver-types"
+    /**
+     * Type guard to check if diagnostics are in the new multi-server format
+     */
+    export function isMultiServerFormat(
+      diagnostics: Diagnostic[] | Array<{ diagnostic: Diagnostic; serverID: string }>,
+    ): diagnostics is Array<{ diagnostic: Diagnostic; serverID: string }> {
+      return diagnostics.length > 0 && "diagnostic" in diagnostics[0]
+    }
+    /**
+     * Sanitize server ID for safe display in UI
+     */
+    export function sanitizeServerID(serverID: string): string {
+      if (typeof serverID !== "string") return "Unknown"
+      let result = serverID
+      // Handle special case: single tag like <typescript> -> typescript
+      const singleTagMatch = result.match(/^<(\w+)>$/)
+      if (singleTagMatch) {
+        result = singleTagMatch[1]
+      } else {
+        // Remove HTML tags completely for other cases
+        result = result.replace(/<[^>]*>/g, "")
+      }
+      return result
+        .replace(/javascript:/gi, "") // Remove javascript protocol
+        .replace(/data:/gi, "") // Remove data protocol
+        .replace(/vbscript:/gi, "") // Remove vbscript protocol
+        .replace(/on\w+=/gi, "") // Remove event handlers
+        .trim()
+        .substring(0, 100) // Limit length
+    }
+    /**
+     * Group diagnostics by server ID for efficient processing
+     * Optimized for large datasets using Map and batch operations
+     */
+    export function groupDiagnosticsByServer(
+      diagnostics: Array<{ diagnostic: Diagnostic; serverID: string }>,
+    ): Record<string, Diagnostic[]> {
+      if (!Array.isArray(diagnostics) || diagnostics.length === 0) {
+        return {}
+      }
+      const grouped = new Map<string, Diagnostic[]>()
+      // Batch process for better performance
+      for (const item of diagnostics) {
+        if (!validateDiagnosticItem(item)) continue
+        const serverID = sanitizeServerID(item.serverID || "Unknown")
+        const existing = grouped.get(serverID)
+        if (existing) {
+          existing.push(item.diagnostic)
+        } else {
+          grouped.set(serverID, [item.diagnostic])
+        }
+      }
+      return Object.fromEntries(grouped)
+    }
+    /**
+     * Sanitize diagnostic message for safe display
+     */
+    export function sanitizeDiagnosticMessage(message: string): string {
+      if (typeof message !== "string") return ""
+      return message
+        .replace(/[<>]/g, "") // Remove HTML tags
+        .replace(/javascript:/gi, "") // Remove javascript protocol
+        .replace(/data:/gi, "") // Remove data protocol
+        .replace(/vbscript:/gi, "") // Remove vbscript protocol
+        .replace(/on\w+=/gi, "") // Remove event handlers
+        .trim()
+        .substring(0, 1000) // Limit length
+    }
+    /**
+     * Format a single diagnostic with server information
+     */
+    export function formatDiagnosticWithServer(diagnostic: Diagnostic, serverID: string): string {
+      if (!validateDiagnostic(diagnostic)) {
+        return "ERROR [Invalid diagnostic]"
+      }
+      const severityMap: Record<number, string> = {
+: "ERROR",
+: "WARN",
+: "INFO",
+: "HINT",
+      }
+      const severity = severityMap[diagnostic.severity || 1]
+      const line = Math.max(0, diagnostic.range.start.line + 1)
+      const col = Math.max(0, diagnostic.range.start.character + 1)
+      const sanitizedMessage = sanitizeDiagnosticMessage(diagnostic.message)
+      return `${severity} [${line}:${col}] ${sanitizedMessage}`
+    }
+    /**
+     * Format diagnostics with server grouping and separators
+     */
+    export function formatDiagnosticsWithServers(diagnostics: Array<{ diagnostic: Diagnostic; serverID: string }>): string {
+      if (!Array.isArray(diagnostics)) return ""
+      const validDiagnostics = diagnostics.filter(validateDiagnosticItem)
+      if (validDiagnostics.length === 0) return ""
+      const grouped = groupDiagnosticsByServer(validDiagnostics)
+      const serverNames = Object.keys(grouped)
+      if (serverNames.length === 1) {
+        // Only one server, no need for separators
+        return grouped[serverNames[0]].map((d) => formatDiagnosticWithServer(d, serverNames[0])).join("\n")
+      }
+      // Multiple servers, add separators
+      const result: string[] = []
+      for (const [serverID, serverDiagnostics] of Object.entries(grouped)) {
+        if (result.length > 0) {
+          result.push("") // Add empty line for spacing
+        }
+        result.push(`--- ${sanitizeServerID(serverID).toUpperCase()} ---`)
+        result.push(...serverDiagnostics.map((d) => formatDiagnosticWithServer(d, serverID)))
+      }
+      return result.join("\n")
+    }
+    /**
+     * Filter diagnostics by severity level
+     * Optimized with early validation
+     */
+    export function filterDiagnosticsBySeverity(
+      diagnostics: Array<{ diagnostic: Diagnostic; serverID: string }>,
+      severity: number,
+    ): Array<{ diagnostic: Diagnostic; serverID: string }> {
+      if (!Array.isArray(diagnostics) || typeof severity !== "number") {
+        return []
+      }
+      return diagnostics.filter((item) => validateDiagnosticItem(item) && item.diagnostic.severity === severity)
+    }
+    /**
+     * Validate diagnostic object structure
+     */
+    export function validateDiagnostic(diagnostic: any): diagnostic is Diagnostic {
+      return !!(
+        diagnostic != null &&
+        typeof diagnostic === "object" &&
+        typeof diagnostic.message === "string" &&
+        diagnostic.range &&
+        typeof diagnostic.range.start === "object" &&
+        typeof diagnostic.range.start.line === "number" &&
+        typeof diagnostic.range.start.character === "number"
+      )
+    }
+    /**
+     * Get error diagnostics (severity 1) from multi-server format
+     */
+    export function getErrorDiagnostics(
+      diagnostics: Array<{ diagnostic: Diagnostic; serverID: string }>,
+    ): Array<{ diagnostic: Diagnostic; serverID: string }> {
+      return filterDiagnosticsBySeverity(diagnostics, 1)
+    }
+    /**
+     * Validate multi-server diagnostic item structure
+     */
+    export function validateDiagnosticItem(item: any): item is { diagnostic: Diagnostic; serverID: string } {
+      return (
+        item != null && typeof item === "object" && validateDiagnostic(item.diagnostic) && typeof item.serverID === "string"
+      )
+    }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: enhance LSP diagnostics with better error handling and server identification #60

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

feat: enhance LSP diagnostics with better error handling and server identification #60

Are you sure you want to change the base?

Uh oh!

feat: enhance LSP diagnostics with better error handling and server identification #60

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!