Fix diagnostics removal code action

Author: chrisqm-dev

src/handlers/ExecutionHandler.ts

@@ -1,4 +1,4 @@
-import { ExecuteCommandParams, MessageType } from 'vscode-languageserver';
+import { ExecuteCommandParams, MessageType, Range } from 'vscode-languageserver';
 import { ServerRequestHandler } from 'vscode-languageserver/lib/common/server';
 import { LspDocuments } from '../protocol/LspDocuments';
 import { ServerComponents } from '../server/ServerComponents';
@@ -67,9 +67,10 @@ export function executionHandler(
                 const args = params.arguments ?? [];
                 if (args.length >= 2) {
                     const uri = args[0] as string;
-                    const diagnosticId = args[1] as string;
+                    const diagnosticRange = args[1] as Range;
+                    const diagnosticMessage = args[2] as string;
                     components.diagnosticCoordinator
-                        .handleClearCfnDiagnostic(uri, diagnosticId)
+                        .handleClearCfnDiagnostic(uri, diagnosticRange, diagnosticMessage)
                         .catch((err) => log.error(`Error clearing diagnostic: ${extractErrorMessage(err)}`));
                 }
                 break;

src/services/CodeActionService.ts

@@ -15,7 +15,7 @@ import { SyntaxTreeManager } from '../context/syntaxtree/SyntaxTreeManager';
 import { NodeSearch } from '../context/syntaxtree/utils/NodeSearch';
 import { NodeType } from '../context/syntaxtree/utils/NodeType';
 import { DocumentManager } from '../document/DocumentManager';
-import { ANALYZE_DIAGNOSTIC } from '../handlers/ExecutionHandler';
+import { ANALYZE_DIAGNOSTIC, CLEAR_DIAGNOSTIC } from '../handlers/ExecutionHandler';
 import { CfnInfraCore } from '../server/CfnInfraCore';
 import { CFN_VALIDATION_SOURCE } from '../stacks/actions/ValidationWorkflow';
 import { LoggerFactory } from '../telemetry/LoggerFactory';
@@ -127,8 +127,8 @@ export class CodeActionService {
                 textEdits: [],
                 command: {
                     title: CodeActionService.REMOVE_ERROR_TITLE,
-                    command: '/command/template/clear-diagnostic',
-                    arguments: [uri, diagnostic.data],
+                    command: CLEAR_DIAGNOSTIC,
+                    arguments: [uri, diagnostic.range, diagnostic.message],
                 },
             },
         ];

src/services/DiagnosticCoordinator.ts

@@ -1,4 +1,4 @@
-import { Diagnostic, PublishDiagnosticsParams } from 'vscode-languageserver';
+import { Diagnostic, PublishDiagnosticsParams, Range } from 'vscode-languageserver';
 import { LspDiagnostics } from '../protocol/LspDiagnostics';
 import { CFN_VALIDATION_SOURCE } from '../stacks/actions/ValidationWorkflow';
 import { LoggerFactory } from '../telemetry/LoggerFactory';
@@ -92,16 +92,23 @@ export class DiagnosticCoordinator {
     }
 
     /**
-     * Handle clearing a CFN diagnostic by ID.
+     * Handle clearing a CFN diagnostic by range and message.
      */
-    async handleClearCfnDiagnostic(uri: string, diagnosticId: string): Promise<void> {
+    async handleClearCfnDiagnostic(uri: string, range: Range, message: string): Promise<void> {
         const collection = this.urisToDiagnostics.get(uri);
         if (!collection) return;
 
         const sourceDiagnostics = collection.get(CFN_VALIDATION_SOURCE);
         if (!sourceDiagnostics) return;
 
-        const filteredDiagnostics = sourceDiagnostics.filter((d) => d.data !== diagnosticId);
+        const filteredDiagnostics = sourceDiagnostics.filter(
+            (d) =>
+                !(
+                    d.range.start.line === range.start.line &&
+                    d.range.start.character === range.start.character &&
+                    d.message === message
+                ),
+        );
         collection.set(CFN_VALIDATION_SOURCE, filteredDiagnostics);
 
         const mergedDiagnostics = this.mergeDiagnostics(collection);

tst/unit/services/CodeActionService.test.ts

@@ -243,7 +243,6 @@ describe('CodeActionService', () => {
                 message: 'Validation failed',
                 severity: DiagnosticSeverity.Error,
                 source: CFN_VALIDATION_SOURCE,
-                data: 'test-uuid-123',
             };
 
             const params: CodeActionParams = {
@@ -266,7 +265,7 @@ describe('CodeActionService', () => {
                 command: {
                     title: 'Remove validation error',
                     command: '/command/template/clear-diagnostic',
-                    arguments: [params.textDocument.uri, 'test-uuid-123'],
+                    arguments: [params.textDocument.uri, diagnostic.range, diagnostic.message],
                 },
             });
         });

tst/unit/services/DiagnosticCoordinator.test.ts

@@ -379,14 +379,14 @@ describe('DiagnosticCoordinator', () => {
     });
 
     describe('handleClearCfnDiagnostic', () => {
-        it('should clear diagnostic by ID', async () => {
-            const diagnostic1 = { ...createDiagnostic(0, 0, 'Error 1'), data: 'id-1' };
-            const diagnostic2 = { ...createDiagnostic(1, 0, 'Error 2'), data: 'id-2' };
+        it('should clear diagnostic by range and message', async () => {
+            const diagnostic1 = createDiagnostic(0, 0, 'Error 1');
+            const diagnostic2 = createDiagnostic(1, 0, 'Error 2');
 
             await coordinator.publishDiagnostics(CFN_VALIDATION_SOURCE, testUri, [diagnostic1, diagnostic2]);
             vi.clearAllMocks();
 
-            await coordinator.handleClearCfnDiagnostic(testUri, 'id-1');
+            await coordinator.handleClearCfnDiagnostic(testUri, diagnostic1.range, 'Error 1');
 
             expect(mockPublishDiagnostics).toHaveBeenCalledWith({
                 uri: testUri,
@@ -395,16 +395,18 @@ describe('DiagnosticCoordinator', () => {
         });
 
         it('should handle non-existent URI gracefully', async () => {
-            await coordinator.handleClearCfnDiagnostic('non-existent', 'id-1');
+            const range = Range.create(Position.create(0, 0), Position.create(0, 10));
+            await coordinator.handleClearCfnDiagnostic('non-existent', range, 'Error');
             expect(mockPublishDiagnostics).not.toHaveBeenCalled();
         });
 
-        it('should handle non-existent diagnostic ID gracefully', async () => {
-            const diagnostic = { ...createDiagnostic(0, 0, 'Error'), data: 'id-1' };
+        it('should handle non-matching diagnostic gracefully', async () => {
+            const diagnostic = createDiagnostic(0, 0, 'Error');
             await coordinator.publishDiagnostics(CFN_VALIDATION_SOURCE, testUri, [diagnostic]);
             vi.clearAllMocks();
 
-            await coordinator.handleClearCfnDiagnostic(testUri, 'non-existent-id');
+            const differentRange = Range.create(Position.create(1, 0), Position.create(1, 10));
+            await coordinator.handleClearCfnDiagnostic(testUri, differentRange, 'Different Error');
 
             expect(mockPublishDiagnostics).toHaveBeenCalledWith({
                 uri: testUri,