Adding snippet to fix pipeProgram in pipeTransport (#1829)

* Adding snippet to fix pipeProgram in pipeTransport

Now with VSCode 64 bit, WSL users need to use the correct pipeProgram in
the correct folder. We will attempt to help users with this.

* Fix tslint issue

* Remove 64 bit check and check for relative path

Author: WardenGnaw

Extension/src/Debugger/attachToProcess.ts

@@ -3,10 +3,15 @@
  * See 'LICENSE' in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 
-import * as vscode from 'vscode';
 import { execChildProcess } from '../common';
 import { PsProcessParser } from './nativeAttach';
+
+import * as debugUtils from './utils';
+import * as fs from 'fs';
+import * as os from 'os';
+import * as path from 'path';
 import * as util from '../common';
+import * as vscode from 'vscode';
 
 export interface AttachItem extends vscode.QuickPickItem {
     id: string;
@@ -49,20 +54,47 @@ export class RemoteAttachPicker {
 
     private _channel: vscode.OutputChannel = null;
 
-    public ShowAttachEntries(args: any): Promise<string> {
+    public ShowAttachEntries(config: any): Promise<string> {
         return util.isExtensionReady().then(ready => {
             if (!ready) {
                 util.displayExtensionNotReadyPrompt();
             } else {
                 this._channel.clear();
 
-                let pipeTransport: any = args ? args.pipeTransport : null;
+                let pipeTransport: any = config ? config.pipeTransport : null;
 
                 if (pipeTransport === null) {
                     return Promise.reject<string>(new Error("Chosen debug configuration does not contain pipeTransport"));
                 }
 
-                let pipeProgram: string = pipeTransport.pipeProgram;
+                let pipeProgram: string = null;
+
+                if (os.platform() === 'win32' &&
+                    pipeTransport.pipeProgram &&
+                    !fs.existsSync(pipeTransport.pipeProgram)) {
+                    const pipeProgramStr: string = pipeTransport.pipeProgram.toLowerCase().trim();
+                    const expectedArch: debugUtils.ArchType = debugUtils.ArchType[process.arch];
+                    
+                    // Check for pipeProgram
+                    if (!fs.existsSync(config.pipeTransport.pipeProgram)) {
+                        pipeProgram = debugUtils.ArchitectureReplacer.checkAndReplaceWSLPipeProgram(pipeProgramStr, expectedArch);
+                    }
+
+                    // If pipeProgram does not get replaced and there is a pipeCwd, concatenate with pipeProgramStr and attempt to replace.
+                    if (!pipeProgram && config.pipeTransport.pipeCwd) {
+                        const pipeCwdStr: string = config.pipeTransport.pipeCwd.toLowerCase().trim();
+                        const newPipeProgramStr: string = path.join(pipeCwdStr, pipeProgramStr);
+                        
+                        if (!fs.existsSync(newPipeProgramStr)) {
+                            pipeProgram = debugUtils.ArchitectureReplacer.checkAndReplaceWSLPipeProgram(newPipeProgramStr, expectedArch);
+                        }
+                    }
+                }
+
+                if (!pipeProgram) {
+                    pipeProgram = pipeTransport.pipeProgram;
+                }
+
                 let pipeArgs: string[] = pipeTransport.pipeArgs;
 
                 let argList: string = RemoteAttachPicker.createArgumentList(pipeArgs);

Extension/src/Debugger/configurationProvider.ts

@@ -3,8 +3,11 @@
  * See 'LICENSE' in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 
+import * as debugUtils from './utils';
 import * as os from 'os';
+import * as path from 'path';
 import * as vscode from 'vscode';
+
 import { IConfiguration, IConfigurationSnippet, DebuggerType, MIConfigurations, WindowsConfigurations, WSLConfigurations, PipeTransportConfigurations } from './configurations';
 import { parse } from 'jsonc-parser';
 
@@ -34,6 +37,29 @@ abstract class CppConfigurationProvider implements vscode.DebugConfigurationProv
             return undefined;
         }
 
+        // Modify WSL config for OpenDebugAD7
+        if (os.platform() === 'win32' &&
+            config.pipeTransport &&
+            config.pipeTransport.pipeProgram) {
+            let replacedPipeProgram: string = null;
+            const pipeProgramStr: string = config.pipeTransport.pipeProgram.toLowerCase().trim();
+
+            // OpenDebugAD7 is a 32-bit process. Make sure the WSL pipe transport is using the correct program.
+            replacedPipeProgram = debugUtils.ArchitectureReplacer.checkAndReplaceWSLPipeProgram(pipeProgramStr, debugUtils.ArchType.ia32);
+
+            // If pipeProgram does not get replaced and there is a pipeCwd, concatenate with pipeProgramStr and attempt to replace.
+            if (!replacedPipeProgram && !path.isAbsolute(pipeProgramStr) && config.pipeTransport.pipeCwd) {
+                const pipeCwdStr: string = config.pipeTransport.pipeCwd.toLowerCase().trim();
+                const newPipeProgramStr: string = path.join(pipeCwdStr, pipeProgramStr);
+                
+                replacedPipeProgram = debugUtils.ArchitectureReplacer.checkAndReplaceWSLPipeProgram(newPipeProgramStr, debugUtils.ArchType.ia32);
+            }
+
+            if (replacedPipeProgram) {
+                config.pipeTransport.pipeProgram = replacedPipeProgram;
+            }
+        }
+
         return config;
     }   
 }

Extension/src/Debugger/configurations.ts

@@ -218,7 +218,8 @@ export class WindowsConfigurations extends Configuration {
 }
 
 export class WSLConfigurations extends Configuration {
-    public bashPipeProgram = "C:\\\\Windows\\\\sysnative\\\\bash.exe";
+    // Detects if the current VSCode is 32-bit and uses the correct bash.exe
+    public bashPipeProgram = process.arch === 'ia32' ? "${env:windir}\\\\sysnative\\\\bash.exe" : "${env:windir}\\\\system32\\\\bash.exe";
 
     public GetLaunchConfiguration(): IConfigurationSnippet {
         let name: string = `(${this.MIMode}) Bash on Windows Launch`;

Extension/src/Debugger/utils.ts

@@ -0,0 +1,49 @@
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All Rights Reserved.
+ * See 'LICENSE' in the project root for license information.
+ * ------------------------------------------------------------------------------------------ */
+
+export enum ArchType {
+    ia32,
+    x64
+}
+
+export class ArchitectureReplacer {
+    public static checkAndReplaceWSLPipeProgram(pipeProgramStr: string, expectedArch: ArchType): string {
+        let replacedPipeProgram: string = null;
+        const winDir: string = process.env.WINDIR ? process.env.WINDIR.toLowerCase() : null;
+        const winDirAltDirSep: string =  process.env.WINDIR ? process.env.WINDIR.replace('\\', '/').toLowerCase() : null;
+        const winDirEnv: string = "${env:windir}";
+
+        if (winDir && winDirAltDirSep && (pipeProgramStr.indexOf(winDir) === 0 || pipeProgramStr.indexOf(winDirAltDirSep) === 0 || pipeProgramStr.indexOf(winDirEnv) === 0)) {
+            if (expectedArch === ArchType.x64) {
+                const pathSep: string = ArchitectureReplacer.checkForFolderInPath(pipeProgramStr, "sysnative");
+                if (pathSep) {
+                    // User has sysnative but we expect 64 bit. Should be using System32 since sysnative is a 32bit concept.
+                    replacedPipeProgram = pipeProgramStr.replace(`${pathSep}sysnative${pathSep}`, `${pathSep}system32${pathSep}`);
+                }
+            } else if (expectedArch === ArchType.ia32) {
+                const pathSep: string = ArchitectureReplacer.checkForFolderInPath(pipeProgramStr, "system32");
+                if (pathSep) {
+                    // User has System32 but we expect 32 bit. Should be using sysnative
+                    replacedPipeProgram = pipeProgramStr.replace(`${pathSep}system32${pathSep}`, `${pathSep}sysnative${pathSep}`);
+                }
+            }
+        }
+
+        return replacedPipeProgram;
+    }
+
+    // Checks to see if the folder name is in the path using both win and unix style path seperators.
+    // Returns the path seperator it detected if the folder is in the path. 
+    // Or else it returns empty string to indicate it did not find it in the path.
+    public static checkForFolderInPath(path: string, folder: string): string {
+        if (path.indexOf(`/${folder}/`) >= 0) {
+            return '/';
+        } else if (path.indexOf(`\\${folder}\\`) >= 0) {
+            return '\\';
+        }
+
+        return "";
+    }
+}