Remove support for old Webkit debugger which nobody used

And cleaned up some code

Author: Paul van Brenk

Nodejs/Product/Nodejs/Project/NodejsProjectLauncher.cs

@@ -32,8 +32,6 @@ internal class NodejsProjectLauncher : IProjectLauncher
         private readonly NodejsProjectNode _project;
         private int? _testServerPort;
 
-        private static readonly Guid WebkitDebuggerGuid = Guid.Parse("4cc6df14-0ab5-4a91-8bb4-eb0bf233d0fe");
-        private static readonly Guid WebkitPortSupplierGuid = Guid.Parse("4103f338-2255-40c0-acf5-7380e2bea13d");
         internal static readonly Guid WebKitDebuggerV2Guid = Guid.Parse("30d423cc-6d0b-4713-b92d-6b2a374c3d89");
 
         public NodejsProjectLauncher(NodejsProjectNode project)
@@ -64,26 +62,20 @@ public int LaunchFile(string file, bool debug)
             }
 
             var nodeVersion = Nodejs.GetNodeVersion(nodePath);
-            var chromeProtocolRequired = nodeVersion >= new Version(8, 0) || CheckDebugProtocolOption();
             var startBrowser = ShouldStartBrowser();
 
             // The call to Version.ToString() is safe, since changes to the ToString method are very unlikely, as the current output is widely documented.
-            if (debug && !chromeProtocolRequired)
+            if (debug)
             {
-                StartWithDebugger(file);
-                TelemetryHelper.LogDebuggingStarted("Node6", nodeVersion.ToString());
-            }
-            else if (debug && chromeProtocolRequired)
-            {
-                if (CheckUseNewChromeDebugProtocolOption())
+                if (nodeVersion >= new Version(8, 0))
                 {
                     StartWithChromeV2Debugger(file, nodePath, startBrowser);
                     TelemetryHelper.LogDebuggingStarted("ChromeV2", nodeVersion.ToString());
                 }
                 else
                 {
-                    StartAndAttachDebugger(file, nodePath, startBrowser);
-                    TelemetryHelper.LogDebuggingStarted("Chrome", nodeVersion.ToString());
+                    StartWithDebugger(file);
+                    TelemetryHelper.LogDebuggingStarted("Node6", nodeVersion.ToString());
                 }
             }
             else
@@ -97,144 +89,13 @@ public int LaunchFile(string file, bool debug)
 
         // todo: move usersettings to separate class, so we can use this from other places.
 
-        internal static bool CheckUseNewChromeDebugProtocolOption()
-        {
-            var optionString = NodejsDialogPage.LoadString(name: "WebKitVersion", cat: "Debugging");
-
-            return !StringComparer.OrdinalIgnoreCase.Equals(optionString, "V1");
-        }
-
-        internal static bool CheckDebugProtocolOption()
-        {
-            var optionString = NodejsDialogPage.LoadString(name: "DebugProtocol", cat: "Debugging");
-
-            return StringComparer.OrdinalIgnoreCase.Equals(optionString, "chrome");
-        }
-
         internal static bool CheckEnableDiagnosticLoggingOption()
         {
             var optionString = NodejsDialogPage.LoadString(name: "DiagnosticLogging", cat: "Debugging");
 
             return StringComparer.OrdinalIgnoreCase.Equals(optionString, "true");
         }
 
-        internal static string CheckForRegistrySpecifiedNodeParams()
-        {
-            var paramString = NodejsDialogPage.LoadString(name: "NodeCmdParams", cat: "Debugging");
-
-            return paramString;
-        }
-
-        private void StartAndAttachDebugger(string file, string nodePath, bool startBrowser)
-        {
-            // start the node process
-            var workingDir = _project.GetWorkingDirectory();
-            var url = GetFullUrl();
-            var env = GetEnvironmentVariablesString(url);
-            var interpreterOptions = _project.GetProjectProperty(NodeProjectProperty.NodeExeArguments);
-            var debugOptions = this.GetDebugOptions();
-            var script = GetFullArguments(file, includeNodeArgs: false);
-
-            var process = NodeDebugger.StartNodeProcessWithInspect(exe: nodePath, script: script, dir: workingDir, env: env, interpreterOptions: interpreterOptions, debugOptions: debugOptions);
-            process.Start();
-
-            // setup debug info and attach
-            var debugUri = $"http://127.0.0.1:{process.DebuggerPort}";
-
-            var dbgInfo = new VsDebugTargetInfo4();
-            dbgInfo.dlo = (uint)DEBUG_LAUNCH_OPERATION.DLO_AlreadyRunning;
-            dbgInfo.LaunchFlags = (uint)__VSDBGLAUNCHFLAGS.DBGLAUNCH_StopDebuggingOnEnd;
-
-            dbgInfo.guidLaunchDebugEngine = WebkitDebuggerGuid;
-            dbgInfo.dwDebugEngineCount = 1;
-
-            var enginesPtr = MarshalDebugEngines(new[] { WebkitDebuggerGuid });
-            dbgInfo.pDebugEngines = enginesPtr;
-            dbgInfo.guidPortSupplier = WebkitPortSupplierGuid;
-            dbgInfo.bstrPortName = debugUri;
-            dbgInfo.fSendToOutputWindow = 0;
-
-            // we connect through a URI, so no need to set the process, 
-            // we need to set the process id to '1' so the debugger is able to attach 
-            dbgInfo.bstrExe = $"\01";
-
-            AttachDebugger(dbgInfo);
-
-            if (startBrowser)
-            {
-                Uri uri = null;
-                if (!String.IsNullOrWhiteSpace(url))
-                {
-                    uri = new Uri(url);
-                }
-
-                if (uri != null)
-                {
-                    OnPortOpenedHandler.CreateHandler(
-                        uri.Port,
-                        shortCircuitPredicate: () => process.HasExited,
-                        action: () =>
-                        {
-                            VsShellUtilities.OpenBrowser(url, (uint)__VSOSPFLAGS.OSP_LaunchNewBrowser);
-                        }
-                    );
-                }
-            }
-        }
-
-        private NodeDebugOptions GetDebugOptions()
-        {
-            var debugOptions = NodeDebugOptions.None;
-
-            if (NodejsPackage.Instance.GeneralOptionsPage.WaitOnAbnormalExit)
-            {
-                debugOptions |= NodeDebugOptions.WaitOnAbnormalExit;
-            }
-
-            if (NodejsPackage.Instance.GeneralOptionsPage.WaitOnNormalExit)
-            {
-                debugOptions |= NodeDebugOptions.WaitOnNormalExit;
-            }
-
-            return debugOptions;
-        }
-
-        private void AttachDebugger(VsDebugTargetInfo4 dbgInfo)
-        {
-            var serviceProvider = _project.Site;
-
-            var debugger = serviceProvider.GetService(typeof(SVsShellDebugger)) as IVsDebugger4;
-
-            if (debugger == null)
-            {
-                throw new InvalidOperationException("Failed to get the debugger service.");
-            }
-
-            var launchResults = new VsDebugTargetProcessInfo[1];
-            debugger.LaunchDebugTargets4(1, new[] { dbgInfo }, launchResults);
-        }
-
-        private static IntPtr MarshalDebugEngines(Guid[] debugEngines)
-        {
-            if (debugEngines.Length == 0)
-            {
-                return IntPtr.Zero;
-            }
-
-            var guidSize = Marshal.SizeOf(typeof(Guid));
-            var size = debugEngines.Length * guidSize;
-            var bytes = new byte[size];
-            for (var i = 0; i < debugEngines.Length; ++i)
-            {
-                debugEngines[i].ToByteArray().CopyTo(bytes, i * guidSize);
-            }
-
-            var pDebugEngines = Marshal.AllocCoTaskMem(size);
-            Marshal.Copy(bytes, 0, pDebugEngines, size);
-
-            return pDebugEngines;
-        }
-
         private void StartNodeProcess(string file, string nodePath, bool startBrowser)
         {
             //TODO: looks like this duplicates a bunch of code in NodeDebugger
@@ -385,6 +246,8 @@ private void StartWithChromeV2Debugger(string file, string nodePath, bool startB
             }
 
             var runtimeArguments = ConvertArguments(this._project.GetProjectProperty(NodeProjectProperty.NodeExeArguments));
+            // If we supply the port argument we also need to manually add --inspect-brk=port to the runtime arguments
+            runtimeArguments = runtimeArguments.Append($"--inspect-brk=${debuggerPort}");
             var scriptArguments = ConvertArguments(this._project.GetProjectProperty(NodeProjectProperty.ScriptArguments));
 
             var cwd = _project.GetWorkingDirectory(); // Current working directory
@@ -395,7 +258,7 @@ private void StartWithChromeV2Debugger(string file, string nodePath, bool startB
                 new JProperty("program", file),
                 new JProperty("args", scriptArguments),
                 new JProperty("runtimeExecutable", nodePath),
-                new JProperty("runtimeArgs", runtimeArguments.Concat(new[] { $"--inspect-brk=${debuggerPort}" }).ToArray()), // If we supply the port argument we also need to manually add --inspect-brk=port to the runtime arguments
+                new JProperty("runtimeArgs", runtimeArguments),
                 new JProperty("port", debuggerPort),
                 new JProperty("cwd", cwd),
                 new JProperty("console", "externalTerminal"),

Nodejs/Product/Nodejs/Workspace/JsFileDebugLaunchTargetProvider.cs

@@ -31,7 +31,7 @@ void IVsDebugLaunchTargetProvider.SetupDebugTargetInfo(ref VsDebugTargetInfo vsD
             var nodeExe = CheckNodeInstalledAndWarn(debugLaunchContext);
 
             var nodeVersion = Nodejs.GetNodeVersion(nodeExe);
-            if (nodeVersion >= new Version(8, 0) || NodejsProjectLauncher.CheckDebugProtocolOption())
+            if (nodeVersion >= new Version(8, 0))
             {
                 this.SetupDebugTargetInfoForInspectProtocol(ref vsDebugTargetInfo, debugLaunchContext, nodeExe);
                 TelemetryHelper.LogDebuggingStarted("ChromeV2", nodeVersion.ToString(), isProject: false);

Nodejs/Product/Nodejs/Workspace/LaunchDebugTargetProvider.cs

@@ -61,9 +61,11 @@ protected string CheckNodeInstalledAndWarn(DebugLaunchActionContext debugLaunchC
 
         protected static string GetJsonConfigurationForInspectProtocol(string target, string workingDir, string nodeExe, DebugLaunchActionContext debugLaunchContext)
         {
+            var debuggerPort = debugLaunchContext.LaunchConfiguration.GetValue(DebuggerPortKey, defaultValue: NodejsConstants.DefaultDebuggerPort);
             var runtimeArguments = ConvertArguments(debugLaunchContext.LaunchConfiguration.GetValue<string>(NodeArgsKey, defaultValue: null));
+            // If we supply the port argument we also need to manually add --inspect-brk=port to the runtime arguments
+            runtimeArguments = runtimeArguments.Append($"--inspect-brk=${debuggerPort}");
             var scriptArguments = ConvertArguments(debugLaunchContext.LaunchConfiguration.GetValue<string>(ScriptArgsKey, defaultValue: null));
-            var port = debugLaunchContext.LaunchConfiguration.GetValue(DebuggerPortKey, defaultValue: NodejsConstants.DefaultDebuggerPort);
 
             var configuration = new JObject(
                 new JProperty("name", "Debug Node.js program from Visual Studio"),
@@ -73,7 +75,7 @@ protected static string GetJsonConfigurationForInspectProtocol(string target, st
                 new JProperty("args", scriptArguments),
                 new JProperty("runtimeExecutable", nodeExe),
                 new JProperty("runtimeArgs", runtimeArguments),
-                new JProperty("port", port),
+                new JProperty("port", debuggerPort),
                 new JProperty("cwd", workingDir),
                 new JProperty("console", "externalTerminal"),
                 new JProperty("trace", NodejsProjectLauncher.CheckEnableDiagnosticLoggingOption()),

Nodejs/Product/Nodejs/Workspace/NodeJsDebugLaunchTargetProvider.cs

@@ -36,7 +36,7 @@ void IVsDebugLaunchTargetProvider2.SetupDebugTargetInfo(ref VsDebugTargetInfo4 v
             var nodeExe = CheckNodeInstalledAndWarn(debugLaunchContext);
 
             var nodeVersion = Nodejs.GetNodeVersion(nodeExe);
-            if (nodeVersion >= new Version(8, 0) || NodejsProjectLauncher.CheckDebugProtocolOption())
+            if (nodeVersion >= new Version(8, 0))
             {
                 SetupDebugTargetInfoForInspectProtocol(ref vsDebugTargetInfo, debugLaunchContext, nodeExe);
                 TelemetryHelper.LogDebuggingStarted("ChromeV2", nodeVersion.ToString(), isProject: false);