feat: W-18903474 - add diagnostics LSP handling (#102)

* feat: lsp diagnostic

* chore: pr comments. treat everything as error, simplify, copy/paste error

* chore: enablePullDiagnostics flag

* chore: pr suggestions

* chore: type

* chore: merge conflict

---------

Co-authored-by: peternhale <[email protected]>

Author: CristiCanizales

packages/apex-ls-browser/src/index.ts

@@ -33,6 +33,7 @@ import {
   dispatchProcessOnSaveDocument,
   dispatchProcessOnDocumentSymbol,
   dispatchProcessOnFoldingRange,
+  dispatchProcessOnDiagnostic,
   ApexStorage,
 } from '@salesforce/apex-lsp-compliant-services';
 import {
@@ -89,6 +90,10 @@ connection.onInitialize((params: InitializeParams): InitializeResult => {
       hoverProvider: false,
       documentSymbolProvider: true,
       foldingRangeProvider: true, // Enable folding range support
+      diagnosticProvider: {
+        interFileDependencies: false,
+        workspaceDiagnostics: false,
+      },
     },
   };
 });
@@ -127,6 +132,31 @@ connection.onDocumentSymbol(async (params: DocumentSymbolParams) => {
   }
 });
 
+// Handle diagnostic requests
+connection.onRequest(
+  'textDocument/diagnostic',
+  async (params: DocumentSymbolParams) => {
+    logger.info(
+      `[SERVER] Received diagnostic request for: ${params.textDocument.uri}`,
+    );
+    logger.info(`[SERVER] DiagnosticParams: ${JSON.stringify(params)}`);
+
+    try {
+      const result = await dispatchProcessOnDiagnostic(params);
+      logger.info(
+        `[SERVER] Result for diagnostic (${params.textDocument.uri}): ${JSON.stringify(result)}`,
+      );
+      return result;
+    } catch (error) {
+      logger.error(
+        `[SERVER] Error processing diagnostic for ${params.textDocument.uri}: ${error}`,
+      );
+      // Return empty array in case of error, as per LSP spec for graceful failure
+      return [];
+    }
+  },
+);
+
 // Add a handler for folding ranges
 connection.onFoldingRanges(
   async (params: FoldingRangeParams): Promise<FoldingRange[] | null> => {

packages/apex-ls-browser/test/index.test.ts

@@ -35,6 +35,7 @@ type OnDocumentSymbolHandler = (
 type OnFoldingRangeHandler = (
   params: FoldingRangeParams,
 ) => Promise<FoldingRange[] | null>;
+type OnRequestHandler = (params: DocumentSymbolParams) => Promise<any[]>;
 
 // Define mock handlers type
 interface MockHandlerStore {
@@ -48,6 +49,7 @@ interface MockHandlerStore {
   onDidSave: OnDidSaveHandler | null;
   onDocumentSymbol: OnDocumentSymbolHandler | null;
   onFoldingRange: OnFoldingRangeHandler | null;
+  onRequest: OnRequestHandler | null;
 }
 
 // Store mock handlers
@@ -62,6 +64,7 @@ const mockHandlers: MockHandlerStore = {
   onDidSave: null,
   onDocumentSymbol: null,
   onFoldingRange: null,
+  onRequest: null,
 };
 
 // Set up the mock connection with proper type safety
@@ -80,6 +83,7 @@ interface MockConnection {
   onHover: jest.Mock;
   onDocumentSymbol: jest.Mock;
   onFoldingRanges: jest.Mock;
+  onRequest: jest.Mock;
   listen: jest.Mock;
   console: typeof mockConsole;
   sendNotification: jest.Mock;
@@ -97,6 +101,7 @@ const mockConnection: MockConnection = {
   onHover: jest.fn(),
   onDocumentSymbol: jest.fn(),
   onFoldingRanges: jest.fn(),
+  onRequest: jest.fn(),
   listen: jest.fn(),
   console: mockConsole,
   sendNotification: jest.fn(),
@@ -152,6 +157,15 @@ mockConnection.onFoldingRanges.mockImplementation(
   },
 );
 
+mockConnection.onRequest.mockImplementation(
+  (method: string, handler: OnRequestHandler) => {
+    if (method === 'textDocument/diagnostic') {
+      mockHandlers.onRequest = handler;
+    }
+    return mockConnection;
+  },
+);
+
 mockDocuments.onDidOpen.mockImplementation((handler: OnDidOpenHandler) => {
   mockHandlers.onDidOpen = handler;
   return mockDocuments;
@@ -220,6 +234,7 @@ const mockDispatchProcessOnCloseDocument = jest.fn().mockResolvedValue([]);
 const mockDispatchProcessOnSaveDocument = jest.fn().mockResolvedValue([]);
 const mockDispatchProcessOnDocumentSymbol = jest.fn().mockResolvedValue([]);
 const mockDispatchProcessOnFoldingRange = jest.fn().mockResolvedValue([]);
+const mockDispatchProcessOnDiagnostic = jest.fn().mockResolvedValue([]);
 
 jest.mock('@salesforce/apex-lsp-compliant-services', () => ({
   ...jest.requireActual('@salesforce/apex-lsp-compliant-services'),
@@ -229,6 +244,7 @@ jest.mock('@salesforce/apex-lsp-compliant-services', () => ({
   dispatchProcessOnSaveDocument: mockDispatchProcessOnSaveDocument,
   dispatchProcessOnDocumentSymbol: mockDispatchProcessOnDocumentSymbol,
   dispatchProcessOnFoldingRange: mockDispatchProcessOnFoldingRange,
+  dispatchProcessOnDiagnostic: mockDispatchProcessOnDiagnostic,
   ApexStorageManager: {
     getInstance: jest.fn().mockReturnValue({
       getStorage: jest.fn(),

packages/apex-ls-node/src/index.ts

@@ -30,6 +30,7 @@ import {
   dispatchProcessOnSaveDocument,
   dispatchProcessOnDocumentSymbol,
   dispatchProcessOnFoldingRange,
+  dispatchProcessOnDiagnostic,
   ApexStorageManager,
   ApexSettingsManager,
   LSPConfigurationManager,
@@ -141,6 +142,10 @@ export function startServer() {
         hoverProvider: false,
         documentSymbolProvider: true,
         foldingRangeProvider: true, // Enable folding range support
+        diagnosticProvider: {
+          interFileDependencies: false,
+          workspaceDiagnostics: false,
+        },
         workspace: {
           workspaceFolders: {
             supported: true,
@@ -206,6 +211,31 @@ export function startServer() {
     }
   });
 
+  // Handle diagnostic requests
+  connection.onRequest(
+    'textDocument/diagnostic',
+    async (params: DocumentSymbolParams) => {
+      logger.debug(
+        `[SERVER] Received diagnostic request for: ${params.textDocument.uri}`,
+      );
+      logger.debug(`[SERVER] DiagnosticParams: ${JSON.stringify(params)}`);
+
+      try {
+        const result = await dispatchProcessOnDiagnostic(params);
+        logger.debug(
+          `[SERVER] Result for diagnostic (${params.textDocument.uri}): ${JSON.stringify(result)}`,
+        );
+        return result;
+      } catch (error) {
+        logger.error(
+          `[SERVER] Error processing diagnostic for ${params.textDocument.uri}: ${error}`,
+        );
+        // Return empty array in case of error, as per LSP spec for graceful failure
+        return [];
+      }
+    },
+  );
+
   // Configuration change handling is now managed by the LSPConfigurationManager
   // through its enhanced registration system in registerForConfigurationChanges()
 

packages/apex-ls-node/test/index.test.ts

@@ -345,6 +345,10 @@ describe('Apex Language Server', () => {
           triggerCharacters: ['.'],
         },
         hoverProvider: false,
+        diagnosticProvider: {
+          interFileDependencies: false,
+          workspaceDiagnostics: false,
+        },
         documentSymbolProvider: true,
         foldingRangeProvider: true,
         workspace: {