Fix CMake debugger Copy Value copying variable name instead of value (#4672)

* Initial plan

* Fix CMake debugger copy value bug by removing evaluateName from variables

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

* Update test to follow repo patterns

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

* Fix test imports to match repository patterns

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

* Remove trailing spaces to fix lint errors

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

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: hanniavalera <[email protected]>

Author: Copilot

CHANGELOG.md

@@ -8,6 +8,7 @@ Features:
 Bug Fixes:
 
 - Fix user-level tasks defined in `~/.config/Code/User/tasks.json` causing infinite spinner. [#4659](https://github.com/microsoft/vscode-cmake-tools/pull/4659)
+- Fix "Copy Value" in CMake debugger copying variable name instead of value. [#4551](https://github.com/microsoft/vscode-cmake-tools/issues/4551)
 - cmakeDriver: Fixes getCompilerVersion by using compilerPath instead of compilerName. [#4647](https://github.com/microsoft/vscode-cmake-tools/pull/4647) [@lygstate](https://github.com/lygstate)
 
 ## 1.22

src/debug/cmakeDebugger/debuggerConfigureDriver.ts

@@ -43,6 +43,18 @@ export class DebugTrackerFactory implements vscode.DebugAdapterTrackerFactory {
                 if (message.command === "disconnect") {
                     await onDisconnected();
                 }
+            },
+            onWillReceiveMessage(message: any) {
+                // Fix for issue #4551: CMake's debugger sets evaluateName to the variable name,
+                // which causes "Copy Value" to copy the name instead of the value.
+                // We remove evaluateName from variables so VSCode falls back to copying the value.
+                if (message.type === 'response' && message.command === 'variables' && message.body?.variables) {
+                    for (const variable of message.body.variables) {
+                        if (variable.evaluateName) {
+                            delete variable.evaluateName;
+                        }
+                    }
+                }
             }
         };
     }

test/unit-tests/debug-tracker.test.ts

@@ -0,0 +1,99 @@
+/* eslint-disable no-unused-expressions */
+import { expect } from '@test/util';
+import * as vscode from 'vscode';
+import { DebugTrackerFactory } from '@cmt/debug/cmakeDebugger/debuggerConfigureDriver';
+
+suite('Debug Tracker tests', () => {
+    test('Variables response: evaluateName is removed from variables', () => {
+        const factory = new DebugTrackerFactory();
+        const tracker = factory.createDebugAdapterTracker({} as vscode.DebugSession);
+
+        // Create a mock variables response with evaluateName set
+        const message = {
+            type: 'response',
+            command: 'variables',
+            body: {
+                variables: [
+                    {
+                        name: 'VAR1',
+                        value: '99999',
+                        evaluateName: 'VAR1'
+                    },
+                    {
+                        name: 'VAR2',
+                        value: 'test',
+                        evaluateName: 'VAR2'
+                    },
+                    {
+                        name: 'VAR3',
+                        value: 'another',
+                        variablesReference: 1
+                        // No evaluateName
+                    }
+                ]
+            }
+        };
+
+        // Call onWillReceiveMessage if it exists
+        if (tracker && 'onWillReceiveMessage' in tracker) {
+            (tracker as any).onWillReceiveMessage(message);
+        }
+
+        // Verify evaluateName was removed from variables that had it
+        expect(message.body.variables[0]).to.not.have.property('evaluateName');
+        expect(message.body.variables[1]).to.not.have.property('evaluateName');
+        // VAR3 should remain unchanged (it never had evaluateName)
+        expect(message.body.variables[2]).to.not.have.property('evaluateName');
+
+        // Other properties should be preserved
+        expect(message.body.variables[0].name).to.be.eq('VAR1');
+        expect(message.body.variables[0].value).to.be.eq('99999');
+        expect(message.body.variables[2].variablesReference).to.be.eq(1);
+    });
+
+    test('Non-variables messages are not modified', () => {
+        const factory = new DebugTrackerFactory();
+        const tracker = factory.createDebugAdapterTracker({} as vscode.DebugSession);
+
+        const message = {
+            type: 'response',
+            command: 'scopes',
+            body: {
+                scopes: [
+                    {
+                        name: 'Local',
+                        variablesReference: 1
+                    }
+                ]
+            }
+        };
+
+        const originalMessage = JSON.stringify(message);
+
+        // Call onWillReceiveMessage if it exists
+        if (tracker && 'onWillReceiveMessage' in tracker) {
+            (tracker as any).onWillReceiveMessage(message);
+        }
+
+        // Message should remain unchanged
+        expect(JSON.stringify(message)).to.be.eq(originalMessage);
+    });
+
+    test('Variables response without body is handled gracefully', () => {
+        const factory = new DebugTrackerFactory();
+        const tracker = factory.createDebugAdapterTracker({} as vscode.DebugSession);
+
+        const message = {
+            type: 'response',
+            command: 'variables'
+            // No body
+        };
+
+        // Should not throw
+        expect(() => {
+            if (tracker && 'onWillReceiveMessage' in tracker) {
+                (tracker as any).onWillReceiveMessage(message);
+            }
+        }).to.not.throw();
+    });
+});