Add support for latest version of PTVSD as an experimental debugger

.vscode/launch.json

@@ -33,6 +33,22 @@
             "cwd": "${workspaceFolder}",
             "preLaunchTask": "Compile"
         },
+        {
+            "name": "Launch Experimental Debugger as debugServer", // https://code.visualstudio.com/docs/extensions/example-debuggers
+            "type": "node",
+            "request": "launch",
+            "program": "${workspaceFolder}/out/client/debugger/mainV2.js",
+            "stopOnEntry": false,
+            "args": [
+                "--server=4711"
+            ],
+            "sourceMaps": true,
+            "outFiles": [
+                "${workspaceFolder}/out/client/**/*.js"
+            ],
+            "cwd": "${workspaceFolder}",
+            "preLaunchTask": "Compile"
+        },
         {
             "name": "Launch Tests",
             "type": "extensionHost",

package.json

@@ -385,7 +385,8 @@
                             "console": "integratedTerminal",
                             "env": {},
                             "envFile": "^\"\\${workspaceFolder}/.env\"",
-                            "debugOptions": []
+                            "debugOptions": [],
+                            "internalConsoleOptions": "neverOpen"
                         }
                     },
                     {
@@ -402,7 +403,8 @@
                             "console": "externalTerminal",
                             "env": {},
                             "envFile": "^\"\\${workspaceFolder}/.env\"",
-                            "debugOptions": []
+                            "debugOptions": [],
+                            "internalConsoleOptions": "neverOpen"
                         }
                     },
                     {
@@ -740,7 +742,8 @@
                         "console": "integratedTerminal",
                         "env": {},
                         "envFile": "${workspaceFolder}/.env",
-                        "debugOptions": []
+                        "debugOptions": [],
+                        "internalConsoleOptions": "neverOpen"
                     },
                     {
                         "name": "Python: Terminal (external)",
@@ -753,7 +756,8 @@
                         "console": "externalTerminal",
                         "env": {},
                         "envFile": "${workspaceFolder}/.env",
-                        "debugOptions": []
+                        "debugOptions": [],
+                        "internalConsoleOptions": "neverOpen"
                     },
                     {
                         "name": "Python: Django",
@@ -884,6 +888,161 @@
                         ]
                     }
                 ]
+            },
+            {
+                "type": "pythonExperimental",
+                "label": "Python Experimental",
+                "languages": [
+                    "python"
+                ],
+                "enableBreakpointsFor": {
+                    "languageIds": [
+                        "python",
+                        "html"
+                    ]
+                },
+                "aiKey": "AIF-d9b70cd4-b9f9-4d70-929b-a071c400b217",
+                "program": "./out/client/debugger/mainV2.js",
+                "runtime": "node",
+                "configurationSnippets": [
+                    {
+                        "label": "Python Experimental: Terminal (integrated)",
+                        "description": "%python.snippet.launch.terminal.description%",
+                        "body": {
+                            "name": "Integrated Terminal/Console",
+                            "type": "pythonExperimental",
+                            "request": "launch",
+                            "stopOnEntry": true,
+                            "pythonPath": "^\"\\${config:python.pythonPath}\"",
+                            "program": "^\"\\${file}\"",
+                            "cwd": "",
+                            "console": "integratedTerminal",
+                            "env": {},
+                            "envFile": "^\"\\${workspaceFolder}/.env\"",
+                            "debugOptions": [],
+                            "internalConsoleOptions": "neverOpen"
+                        }
+                    },
+                    {
+                        "label": "Python Experimental: Terminal (external)",
+                        "description": "%python.snippet.launch.externalTerminal.description%",
+                        "body": {
+                            "name": "External Terminal/Console",
+                            "type": "pythonExperimental",
+                            "request": "launch",
+                            "stopOnEntry": true,
+                            "pythonPath": "^\"\\${config:python.pythonPath}\"",
+                            "program": "^\"\\${file}\"",
+                            "cwd": "",
+                            "console": "externalTerminal",
+                            "env": {},
+                            "envFile": "^\"\\${workspaceFolder}/.env\"",
+                            "debugOptions": [],
+                            "internalConsoleOptions": "neverOpen"
+                        }
+                    }
+                ],
+                "configurationAttributes": {
+                    "launch": {
+                        "properties": {
+                            "program": {
+                                "type": "string",
+                                "description": "Absolute path to the program.",
+                                "default": "${file}"
+                            },
+                            "pythonPath": {
+                                "type": "string",
+                                "description": "Path (fully qualified) to python executable. Defaults to the value in settings.json",
+                                "default": "${config:python.pythonPath}"
+                            },
+                            "args": {
+                                "type": "array",
+                                "description": "Command line arguments passed to the program",
+                                "default": [],
+                                "items": {
+                                    "type": "string"
+                                }
+                            },
+                            "stopOnEntry": {
+                                "type": "boolean",
+                                "description": "Automatically stop after launch.",
+                                "default": false
+                            },
+                            "console": {
+                                "enum": [
+                                    "integratedTerminal",
+                                    "externalTerminal"
+                                ],
+                                "description": "Where to launch the debug target: internal console, integrated terminal, or external terminal.",
+                                "default": "integratedTerminal"
+                            },
+                            "cwd": {
+                                "type": "string",
+                                "description": "Absolute path to the working directory of the program being debugged. Default is the root directory of the file (leave empty).",
+                                "default": ""
+                            },
+                            "debugOptions": {
+                                "type": "array",
+                                "description": "Advanced options, view read me for further details.",
+                                "items": {
+                                    "type": "string",
+                                    "enum": [
+                                        "Sudo"
+                                    ]
+                                },
+                                "default": []
+                            },
+                            "env": {
+                                "type": "object",
+                                "description": "Environment variables defined as a key value pair. Property ends up being the Environment Variable and the value of the property ends up being the value of the Env Variable.",
+                                "default": {}
+                            },
+                            "envFile": {
+                                "type": "string",
+                                "description": "Absolute path to a file containing environment variable definitions.",
+                                "default": ""
+                            },
+                            "port": {
+                                "type": "number",
+                                "description": "Debug port (default is 0, resulting in the use of a dynamic port).",
+                                "default": 0
+                            },
+                            "host": {
+                                "type": "string",
+                                "description": "IP address of the of the local debug server (default is localhost).",
+                                "default": "localhost"
+                            }
+                        }
+                    }
+                },
+                "initialConfigurations": [
+                    {
+                        "name": "Python Experimental: Current File (Integrated Terminal)",
+                        "type": "pythonExperimental",
+                        "request": "launch",
+                        "pythonPath": "${config:python.pythonPath}",
+                        "program": "${file}",
+                        "cwd": "",
+                        "console": "integratedTerminal",
+                        "env": {},
+                        "envFile": "${workspaceFolder}/.env",
+                        "debugOptions": [],
+                        "internalConsoleOptions": "neverOpen"
+                    },
+                    {
+                        "name": "Python Experimental: Current File (External Terminal)",
+                        "type": "pythonExperimental",
+                        "request": "launch",
+                        "pythonPath": "${config:python.pythonPath}",
+                        "program": "${file}",
+                        "cwd": "",
+                        "console": "externalTerminal",
+                        "env": {},
+                        "envFile": "${workspaceFolder}/.env",
+                        "debugOptions": [],
+                        "internalConsoleOptions": "neverOpen"
+                    }
+                ]
             }
         ],
         "configuration": {
@@ -1663,5 +1822,10 @@
         "typescript-formatter": "^6.0.0",
         "vscode": "^1.1.5",
         "vscode-debugadapter-testsupport": "^1.25.0"
+    },
+    "__metadata": {
+        "id": "f1f59ae4-9318-4f3c-a9b5-81b2eaa5f8a5",
+        "publisherDisplayName": "Microsoft",
+        "publisherId": "998b010b-e2af-44a5-a6cd-0b5fd3b9b6f8"
     }
 }

pythonFiles/experimental/ptvsd_launcher.py

@@ -0,0 +1,96 @@
+# Python Tools for Visual Studio
+# Copyright(c) Microsoft Corporation
+# All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the License); you may not use
+# this file except in compliance with the License. You may obtain a copy of the
+# License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# THIS CODE IS PROVIDED ON AN  *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS
+# OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY
+# IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
+# MERCHANTABLITY OR NON-INFRINGEMENT.
+#
+# See the Apache Version 2.0 License for specific language governing
+# permissions and limitations under the License.
+
+"""
+Starts Debugging, expected to start with normal program
+to start as first argument and directory to run from as
+the second argument.
+"""
+
+__author__ = "Microsoft Corporation <[email protected]>"
+__version__ = "3.2.0.0"
+
+import os
+import os.path
+import sys
+import traceback
+
+# Arguments are:
+# 1. Working directory.
+# 2. VS debugger port to connect to.
+# 3. GUID for the debug session.
+# 4. Debug options (as list of names - see enum PythonDebugOptions).
+# 5. '-g' to use the installed ptvsd package, rather than bundled one.
+# 6. '-m' or '-c' to override the default run-as mode. [optional]
+# 7. Startup script name.
+# 8. Script arguments.
+
+# change to directory we expected to start from
+os.chdir(sys.argv[1])
+
+port_num = int(sys.argv[2])
+debug_id = sys.argv[3]
+debug_options = set([opt.strip() for opt in sys.argv[4].split(',')])
+
+del sys.argv[0:5]
+
+# Use bundled ptvsd or not?
+bundled_ptvsd = True
+if sys.argv and sys.argv[0] == '-g':
+    bundled_ptvsd = False
+    del sys.argv[0]
+
+# set run_as mode appropriately
+run_as = 'script'
+if sys.argv and sys.argv[0] == '-m':
+    run_as = 'module'
+    del sys.argv[0]
+if sys.argv and sys.argv[0] == '-c':
+    run_as = 'code'
+    del sys.argv[0]
+
+# preserve filename before we del sys
+filename = sys.argv[0]
+
+# fix sys.path to be the script file dir
+sys.path[0] = ''
+
+# Load the debugger package
+try:
+    if bundled_ptvsd:
+        ptvs_lib_path = os.path.dirname(__file__)
+        sys.path.insert(0, ptvs_lib_path)
+    import ptvsd
+    import ptvsd.debugger as vspd
+    vspd.DONT_DEBUG.append(os.path.normcase(__file__))
+except:
+    traceback.print_exc()
+    print('''
+Internal error detected. Please copy the above traceback and report at
+https://go.microsoft.com/fwlink/?LinkId=293415
+
+Press Enter to close. . .''')
+    try:
+        raw_input()
+    except NameError:
+        input()
+    sys.exit(1)
+finally:
+    if bundled_ptvsd:
+        sys.path.remove(ptvs_lib_path)
+
+# and start debugging
+vspd.debug(filename, port_num, debug_id, debug_options, run_as)

src/client/common/configSettings.ts

@@ -5,6 +5,7 @@ import { EventEmitter } from 'events';
 import * as path from 'path';
 import * as vscode from 'vscode';
 import { ConfigurationTarget, Uri } from 'vscode';
+import { isTestExecution } from './constants';
 import {
     IAutoCompeteSettings,
     IFormattingSettings,
@@ -22,11 +23,6 @@ const untildify = require('untildify');
 
 export const IS_WINDOWS = /^win/.test(process.platform);
 
-export function isTestExecution(): boolean {
-    // tslint:disable-next-line:interface-name no-string-literal
-    return process.env['VSC_PYTHON_CI_TEST'] === '1';
-}
-
 // tslint:disable-next-line:completed-docs
 export class PythonSettings extends EventEmitter implements IPythonSettings {
     private static pythonSettings: Map<string, PythonSettings> = new Map<string, PythonSettings>();

src/client/common/constants.ts

@@ -63,3 +63,8 @@ export namespace LinterErrors {
 }
 
 export const STANDARD_OUTPUT_CHANNEL = 'STANDARD_OUTPUT_CHANNEL';
+
+export function isTestExecution(): boolean {
+    // tslint:disable-next-line:interface-name no-string-literal
+    return process.env['VSC_PYTHON_CI_TEST'] === '1';
+}

src/client/common/net/socket/socketServer.ts

@@ -1,13 +1,23 @@
 import { EventEmitter } from 'events';
+import { injectable } from 'inversify';
 import * as net from 'net';
-import { createDeferred } from '../../helpers';
+import { createDeferred, Deferred } from '../../helpers';
+import { ISocketServer } from '../../types';
 
-export class SocketServer extends EventEmitter {
+@injectable()
+export class SocketServer extends EventEmitter implements ISocketServer {
     private socketServer: net.Server | undefined;
+    private clientSocket: Deferred<net.Socket>;
+    public get client(): Promise<net.Socket> {
+        return this.clientSocket.promise;
+    }
     constructor() {
         super();
+        this.clientSocket = createDeferred<net.Socket>();
+    }
+    public dispose() {
+        this.Stop();
     }
-
     public Stop() {
         if (!this.socketServer) { return; }
         try {
@@ -37,6 +47,9 @@ export class SocketServer extends EventEmitter {
     }
 
     private connectionListener(client: net.Socket) {
+        if (!this.clientSocket.completed) {
+            this.clientSocket.resolve(client);
+        }
         client.on('close', () => {
             this.emit('close', client);
         });