Attach to process quick pick - Windows support (#9249)

* Renaming functions and classes
* Windows support
* Typo
* Refactoring pt 1
* Temp tests
* Move ps perf comment to ps file
* Temp commit to test ti on windows
* Revert "Temp commit to test it on windows"
* Windows unit tests
* More tests + some cleanup

Author: kimadeline

src/client/debugger/extension/adapter/activator.ts

@@ -24,8 +24,7 @@ export class DebugAdapterActivator implements IExtensionSingleActivationService
     ) { }
     public async activate(): Promise<void> {
         if (this.experimentsManager.inExperiment(DebugAdapterDescriptorFactory.experiment)) {
-            const attachProcessProvider = this.attachProcessProviderFactory.getProvider();
-            attachProcessProvider.registerCommands();
+            this.attachProcessProviderFactory.registerCommands();
 
             this.disposables.push(this.debugService.registerDebugAdapterTrackerFactory(DebuggerTypeName, this.debugSessionLoggingFactory));
             this.disposables.push(this.debugService.registerDebugAdapterDescriptorFactory(DebuggerTypeName, this.descriptorFactory));

src/client/debugger/extension/attachQuickPick/baseProvider.ts

@@ -5,10 +5,12 @@
 
 import { inject, injectable } from 'inversify';
 import { IApplicationShell, ICommandManager } from '../../../common/application/types';
+import { Commands } from '../../../common/constants';
 import { IPlatformService } from '../../../common/platform/types';
 import { IProcessServiceFactory } from '../../../common/process/types';
 import { IDisposableRegistry } from '../../../common/types';
-import { PsAttachProcessProvider } from './psProvider';
+import { AttachPicker } from './picker';
+import { AttachProcessProvider } from './provider';
 import { IAttachProcessProviderFactory } from './types';
 
 @injectable()
@@ -21,14 +23,13 @@ export class AttachProcessProviderFactory implements IAttachProcessProviderFacto
         @inject(IDisposableRegistry) private readonly disposableRegistry: IDisposableRegistry
     ) { }
 
-    public getProvider() {
-        // Will add Windows provider in a separate PR
-        return new PsAttachProcessProvider(
-            this.applicationShell,
-            this.commandManager,
-            this.disposableRegistry,
+    public registerCommands() {
+        const provider = new AttachProcessProvider(
             this.platformService,
             this.processServiceFactory
         );
+        const picker = new AttachPicker(this.applicationShell, provider);
+        const disposable = this.commandManager.registerCommand(Commands.PickLocalProcess, () => picker.showQuickPick(), this);
+        this.disposableRegistry.push(disposable);
     }
 }

src/client/debugger/extension/attachQuickPick/factory.ts

@@ -0,0 +1,58 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';
+
+import { inject, injectable } from 'inversify';
+import { IPlatformService } from '../../../common/platform/types';
+import { IProcessServiceFactory } from '../../../common/process/types';
+import { AttachProcess as AttachProcessLocalization } from '../../../common/utils/localize';
+import { PsProcessParser } from './psProcessParser';
+import { IAttachItem, IAttachProcessProvider, ProcessListCommand } from './types';
+import { WmicProcessParser } from './wmicProcessParser';
+
+@injectable()
+export class AttachProcessProvider implements IAttachProcessProvider {
+    constructor(
+        @inject(IPlatformService) private readonly platformService: IPlatformService,
+        @inject(IProcessServiceFactory) private readonly processServiceFactory: IProcessServiceFactory
+    ) { }
+
+    public getAttachItems(): Promise<IAttachItem[]> {
+        return this._getInternalProcessEntries().then(processEntries => {
+            // localeCompare is significantly slower than < and > (2000 ms vs 80 ms for 10,000 elements)
+            // We can change to localeCompare if this becomes an issue
+            processEntries.sort((a, b) => {
+                const aLower = a.label.toLowerCase();
+                const bLower = b.label.toLowerCase();
+
+                if (aLower === bLower) {
+                    return 0;
+                }
+
+                return aLower < bLower ? -1 : 1;
+            });
+
+            return processEntries;
+        });
+    }
+
+    public async _getInternalProcessEntries(): Promise<IAttachItem[]> {
+        let processCmd: ProcessListCommand;
+        if (this.platformService.isMac) {
+            processCmd = PsProcessParser.psDarwinCommand;
+        } else if (this.platformService.isLinux) {
+            processCmd = PsProcessParser.psLinuxCommand;
+        } else if (this.platformService.isWindows) {
+            processCmd = WmicProcessParser.wmicCommand;
+        } else {
+            throw new Error(AttachProcessLocalization.unsupportedOS().format(this.platformService.osType));
+        }
+
+        const processService = await this.processServiceFactory.create();
+        const output = await processService.exec(processCmd.command, processCmd.args, { throwOnStdErr: true });
+
+        return this.platformService.isWindows ?
+            WmicProcessParser.parseProcesses(output.stdout) : PsProcessParser.parseProcesses(output.stdout);
+    }
+}

src/client/debugger/extension/attachQuickPick/provider.ts

@@ -9,6 +9,30 @@ export namespace PsProcessParser {
     const secondColumnCharacters = 50;
     const commColumnTitle = ''.padStart(secondColumnCharacters, 'a');
 
+    // Perf numbers:
+    // OS X 10.10
+    // | # of processes | Time (ms) |
+    // |----------------+-----------|
+    // |            272 |        52 |
+    // |            296 |        49 |
+    // |            384 |        53 |
+    // |            784 |       116 |
+    //
+    // Ubuntu 16.04
+    // | # of processes | Time (ms) |
+    // |----------------+-----------|
+    // |            232 |        26 |
+    // |            336 |        34 |
+    // |            736 |        62 |
+    // |           1039 |       115 |
+    // |           1239 |       182 |
+
+    // ps outputs as a table. With the option "ww", ps will use as much width as necessary.
+    // However, that only applies to the right-most column. Here we use a hack of setting
+    // the column header to 50 a's so that the second column will have at least that many
+    // characters. 50 was chosen because that's the maximum length of a "label" in the
+    // QuickPick UI in VS Code.
+
     // the BSD version of ps uses '-c' to have 'comm' only output the executable name and not
     // the full path. The Linux version of ps has 'comm' to only display the name of the executable
     // Note that comm on Linux systems is truncated to 16 characters:
@@ -23,7 +47,7 @@ export namespace PsProcessParser {
         args: ['axww', '-o', `pid=,comm=${commColumnTitle},args=`, '-c']
     };
 
-    export function parseProcessesFromPs(processes: string): IAttachItem[] {
+    export function parseProcesses(processes: string): IAttachItem[] {
         const lines: string[] = processes.split('\n');
         return parseProcessesFromPsArray(lines);
     }

src/client/debugger/extension/attachQuickPick/psProcessParser.ts

@@ -12,13 +12,12 @@ export interface IAttachItem extends QuickPickItem {
 }
 
 export interface IAttachProcessProvider {
-    registerCommands(): void;
     getAttachItems(): Promise<IAttachItem[]>;
 }
 
 export const IAttachProcessProviderFactory = Symbol('IAttachProcessProviderFactory');
 export interface IAttachProcessProviderFactory {
-    getProvider(): IAttachProcessProvider;
+    registerCommands(): void;
 }
 
 export interface IAttachPicker {

src/client/debugger/extension/attachQuickPick/psProvider.ts

@@ -0,0 +1,78 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';
+
+import { IAttachItem, ProcessListCommand } from './types';
+
+export namespace WmicProcessParser {
+    const wmicNameTitle = 'Name';
+    const wmicCommandLineTitle = 'CommandLine';
+    const wmicPidTitle = 'ProcessId';
+    const defaultEmptyEntry: IAttachItem = {
+        label: '',
+        description: '',
+        detail: '',
+        id: ''
+    };
+
+    // Perf numbers on Win10:
+    // | # of processes | Time (ms) |
+    // |----------------+-----------|
+    // |            309 |       413 |
+    // |            407 |       463 |
+    // |            887 |       746 |
+    // |           1308 |      1132 |
+    export const wmicCommand: ProcessListCommand = {
+        command: 'wmic',
+        args: ['process', 'get', 'Name,ProcessId,CommandLine', '/FORMAT:list']
+    };
+
+    export function parseProcesses(processes: string): IAttachItem[] {
+        const lines: string[] = processes.split('\r\n');
+        const processEntries: IAttachItem[] = [];
+        let entry = { ...defaultEmptyEntry };
+
+        for (const line of lines) {
+            if (!line.length) {
+                continue;
+            }
+
+            parseLineFromWmic(line, entry);
+
+            // Each entry of processes has ProcessId as the last line
+            if (line.lastIndexOf(wmicPidTitle, 0) === 0) {
+                processEntries.push(entry);
+                entry = { ...defaultEmptyEntry };
+            }
+        }
+
+        return processEntries;
+    }
+
+    function parseLineFromWmic(line: string, item: IAttachItem): IAttachItem {
+        const splitter = line.indexOf('=');
+        const currentItem = item;
+
+        if (splitter > 0) {
+            const key = line.slice(0, splitter).trim();
+            let value = line.slice(splitter + 1).trim();
+
+            if (key === wmicNameTitle) {
+                currentItem.label = value;
+            } else if (key === wmicPidTitle) {
+                currentItem.description = value;
+                currentItem.id = value;
+            } else if (key === wmicCommandLineTitle) {
+                const dosDevicePrefix = '\\??\\'; // DOS device prefix, see https://reverseengineering.stackexchange.com/a/15178
+                if (value.lastIndexOf(dosDevicePrefix, 0) === 0) {
+                    value = value.slice(dosDevicePrefix.length);
+                }
+
+                currentItem.detail = value;
+            }
+        }
+
+        return currentItem;
+    }
+}

src/client/debugger/extension/attachQuickPick/types.ts

@@ -24,7 +24,6 @@ import { DebugAdapterActivator } from '../../../../client/debugger/extension/ada
 import { DebugAdapterDescriptorFactory } from '../../../../client/debugger/extension/adapter/factory';
 import { DebugSessionLoggingFactory } from '../../../../client/debugger/extension/adapter/logging';
 import { AttachProcessProviderFactory } from '../../../../client/debugger/extension/attachQuickPick/factory';
-import { PsAttachProcessProvider } from '../../../../client/debugger/extension/attachQuickPick/psProvider';
 import { IAttachProcessProviderFactory } from '../../../../client/debugger/extension/attachQuickPick/types';
 import { IDebugAdapterDescriptorFactory, IDebugSessionLoggingFactory } from '../../../../client/debugger/extension/types';
 import { clearTelemetryReporter } from '../../../../client/telemetry';
@@ -86,8 +85,6 @@ suite('Debugging - Adapter Factory and logger Registration', () => {
         spiedInstance = spy(experimentsManager);
 
         attachFactory = mock(AttachProcessProviderFactory);
-        const attachProvider = mock(PsAttachProcessProvider);
-        when(attachFactory.getProvider()).thenReturn(instance(attachProvider));
 
         debugService = mock(DebugService);
         descriptorFactory = mock(DebugAdapterDescriptorFactory);