Moving from debugProxy to AdapterExecutableCommand (#1387)

* Moving from debugProxy to AdapterExecutableCommand

* Addressing PR issues

Moving registerAdapterExecutableCommand to Debugger/extension.ts

* Updating comment

Author: WardenGnaw

Extension/package.json

@@ -307,8 +307,7 @@
             "cpp"
           ]
         },
-        "runtime": "node",
-        "program": "./out/src/Debugger/Proxy/debugProxy.js",
+        "adapterExecutableCommand": "extension.cppdbgAdapterExecutableCommand",
         "aiKey": "AIF-d9b70cd4-b9f9-4d70-929b-a071c400b217",
         "variables": {
           "pickProcess": "extension.pickNativeProcess",
@@ -758,11 +757,7 @@
             "cpp"
           ]
         },
-        "runtime": "node",
-        "program": "./out/src/Debugger/Proxy/debugProxy.js",
-        "args": [
-          "--interpreter=vscode"
-        ],
+        "adapterExecutableCommand": "extension.cppvsdbgAdapterExecutableCommand",
         "aiKey": "AIF-d9b70cd4-b9f9-4d70-929b-a071c400b217",
         "variables": {
           "pickProcess": "extension.pickNativeProcess"
@@ -1213,4 +1208,4 @@
       "binaries": []
     }
   ]
-}
+}

Extension/src/Debugger/Proxy/debugProtocol.ts

@@ -15,7 +15,7 @@ import * as path from 'path';
 // The extension deactivate method is asynchronous, so we handle the disposables ourselves instead of using extensonContext.subscriptions.
 let disposables: vscode.Disposable[] = [];
 
-export function activate() {
+export function initialize() {
     // Activate Process Picker Commands
     let attachItemsProvider = NativeAttachItemsProviderFactory.Get();
     let attacher = new AttachPicker(attachItemsProvider);
@@ -37,13 +37,69 @@ export function activate() {
 
     disposables.push(vscode.window.onDidChangeActiveTextEditor(onDidChangeActiveTextEditor));
     onDidChangeActiveTextEditor(vscode.window.activeTextEditor);
+
+     // Activate Adapter Commands 
+     registerAdapterExecutableCommands();
 }
 
-export function deactivate(): void {
+export function dispose(): void {
     disposables.forEach(d => d.dispose());
 }
 
 function onDidChangeActiveTextEditor(editor: vscode.TextEditor): void {
     if (util.getShowReloadPromptOnce() && editor && editor.document.fileName.endsWith(path.sep + "launch.json"))
         util.showReloadOrWaitPromptOnce();
+}
+
+// Registers adapterExecutableCommands for cppdbg and cppvsdbg. If it is not ready, it will prompt waiting for the download.
+// 
+// Note: util.extensionContext.extensionPath is needed for the commands because VsCode does not support relative paths for adapterExecutableComand
+function registerAdapterExecutableCommands(): void {
+    disposables.push(vscode.commands.registerCommand('extension.cppdbgAdapterExecutableCommand', () => {
+        return util.checkInstallLockFile().then(ready => {
+            if (ready)
+            {
+                let command: string = path.join(util.extensionContext.extensionPath, './debugAdapters/OpenDebugAD7');
+
+                // Windows has the exe in debugAdapters/bin.
+                if (os.platform() === 'win32')
+                {
+                    command = path.join(util.extensionContext.extensionPath, "./debugAdapters/bin/OpenDebugAD7.exe");
+                }
+
+                return {
+                    command: command
+                }
+            }
+            else {
+                util.showReloadOrWaitPromptOnce();
+                // TODO: VsCode displays null return as "Cannot find executable 'null'". Fix if they have a way to not display their prompt.
+                return null;
+            }
+        });
+    }));
+
+    disposables.push(vscode.commands.registerCommand('extension.cppvsdbgAdapterExecutableCommand', () => {
+        if (os.platform() != 'win32')
+        {
+            vscode.window.showErrorMessage("Debugger type 'cppvsdbg' is not avaliable for non-Windows machines.");
+            return null;
+        }
+        else {
+            return util.checkInstallLockFile().then(ready => {
+                if (ready)
+                {
+                    return {
+                        command: path.join(util.extensionContext.extensionPath,'./debugAdapters/vsdbg/bin/vsdbg.exe'),
+                        args: ['--interpreter=vscode']
+                    }
+                }
+                else {
+                    util.showReloadOrWaitPromptOnce();
+                    // TODO: VsCode displays null return as "Cannot find executable 'null'". Fix if they have a way to not display their prompt.
+                    return null;
+                }
+            });
+        }
+    }));
 }

Extension/src/Debugger/Proxy/debugProxy.ts

@@ -107,8 +107,8 @@ export function activate(context: vscode.ExtensionContext) {
     Telemetry.activate();
     util.setProgress(0);
 
-    // Activate Configuration Provider and Process Picker Commands.
-    DebuggerExtension.activate();
+    // Initialize the DebuggerExtension and register the related commands and providers.
+    DebuggerExtension.initialize();
 
     if (context.globalState.get<number>(userBucketString, -1) == -1) {
         let bucket = Math.floor(Math.random() * userBucketMax) + 1; // Range is [1, userBucketMax].
@@ -165,7 +165,7 @@ export function activate(context: vscode.ExtensionContext) {
 }
 
 export function deactivate(): Thenable<void> {
-    DebuggerExtension.deactivate();
+    DebuggerExtension.dispose();
 
     tempCommands.forEach((command) => {
         command.dispose();
@@ -427,7 +427,7 @@ function checkDistro(channel: vscode.OutputChannel, platformInfo: PlatformInform
     }
 }
 
-function rewriteManifest(installBlob: InstallBlob): Promise<void> {
+function rewriteManifest(installBlob: InstallBlob): void {
     installBlob.stage = "rewriteManifest";
 
     // Replace activationEvents with the events that the extension should be activated for subsequent sessions.
@@ -452,20 +452,4 @@ function rewriteManifest(installBlob: InstallBlob): Promise<void> {
         "onCommand:C_Cpp.TakeSurvey",
         "onDebug"
     ];
-
-    // Remove the entry for cppdbg's proxy stub and replace it with the real debugger binary
-    util.packageJson.contributes.debuggers[0].runtime = undefined;
-    util.packageJson.contributes.debuggers[0].program = './debugAdapters/OpenDebugAD7';
-    util.packageJson.contributes.debuggers[0].windows = { "program": "./debugAdapters/bin/OpenDebugAD7.exe" };
-
-    // Remove the entry for cppvsdbg's proxy stub and replace it with the real debugger binary for Windows only.
-    if (os.platform() === 'win32') {
-        util.packageJson.contributes.debuggers[1].runtime = undefined;
-        util.packageJson.contributes.debuggers[1].program = './debugAdapters/vsdbg/bin/vsdbg.exe';
-    }
-
-    if (util.packageJson.extensionFolderPath.includes(".vscode-insiders"))
-        util.packageJson.contributes.configuration.properties["C_Cpp.intelliSenseEngine"].default = "Default";
-
-    return util.writeFileText(util.getPackageJsonPath(), util.getPackageJsonString());
-}
+}