Fix attach to process debugging (#1752)

* Fix an occassional dead lock on restarting debug
* Fix attach to process and other debugging issues
* Fixes #1736
  * Add a new context frame for runspace entrance and REPL loops
  * Ensure runspace access is not attempted on a broken runspace
  * When a remote runspace hits a debugger stop, ensure that the
     origin pipeline thread does not run a REPL concurrently
  * Fix many race conditions
* Use FilterText instead of Label for Assert
   * If multiple Write-Host's exist then this test will fail. FilterText
     contains the module qualified name when dupes are present.
* Use Contains instead of Collection in assert
  * If the testing machine has a pester template installed the collection
    will have an extra item.
* Add some safety to disposals
* Skip CLM E2E tests in unelevated process
* Add preset ExecutionOptions.ImmediateInteractive
* Cleanup extra null conditionals
* Add comment describing disconnect code path
* Add `Is*` properties for context frame types
* Use the new `Is*` props in a few more places
* Fix new analyzers

Author: SeeminglyScience

PowerShellEditorServices.build.ps1

@@ -202,6 +202,11 @@ task TestE2E Build, SetupHelpForTests, {
 
     # Run E2E tests in ConstrainedLanguage mode.
     if (!$script:IsNix) {
+        if (-not [Security.Principal.WindowsIdentity]::GetCurrent().Owner.IsWellKnown("BuiltInAdministratorsSid")) {
+            Write-Warning 'Skipping E2E CLM tests as they must be ran in an elevated process.'
+            return
+        }
+
         try {
             [System.Environment]::SetEnvironmentVariable("__PSLockdownPolicy", "0x80000007", [System.EnvironmentVariableTarget]::Machine);
             exec { & dotnet $script:dotnetTestArgs $script:NetRuntime.PS7 }

src/PowerShellEditorServices/Server/PsesDebugServer.cs

@@ -121,7 +121,7 @@ public void Dispose()
             // It represents the debugger on the PowerShell process we're in,
             // while a new debug server is spun up for every debugging session
             _psesHost.DebugContext.IsDebugServerActive = false;
-            _debugAdapterServer.Dispose();
+            _debugAdapterServer?.Dispose();
             _inputStream.Dispose();
             _outputStream.Dispose();
             _loggerFactory.Dispose();

src/PowerShellEditorServices/Services/DebugAdapter/BreakpointService.cs

@@ -12,6 +12,7 @@
 using Microsoft.PowerShell.EditorServices.Services.DebugAdapter;
 using Microsoft.PowerShell.EditorServices.Services.PowerShell;
 using Microsoft.PowerShell.EditorServices.Services.PowerShell.Host;
+using Microsoft.PowerShell.EditorServices.Services.PowerShell.Utility;
 
 namespace Microsoft.PowerShell.EditorServices.Services
 {
@@ -43,6 +44,7 @@ public async Task<List<Breakpoint>> GetBreakpointsAsync()
         {
             if (BreakpointApiUtils.SupportsBreakpointApis(_editorServicesHost.CurrentRunspace))
             {
+                _editorServicesHost.Runspace.ThrowCancelledIfUnusable();
                 return BreakpointApiUtils.GetBreakpoints(
                     _editorServicesHost.Runspace.Debugger,
                     _debugStateService.RunspaceId);

src/PowerShellEditorServices/Services/DebugAdapter/DebugService.cs

@@ -16,6 +16,7 @@
 using Microsoft.PowerShell.EditorServices.Services.PowerShell.Debugging;
 using Microsoft.PowerShell.EditorServices.Services.PowerShell.Execution;
 using Microsoft.PowerShell.EditorServices.Services.PowerShell.Host;
+using Microsoft.PowerShell.EditorServices.Services.PowerShell.Utility;
 using Microsoft.PowerShell.EditorServices.Services.TextDocument;
 using Microsoft.PowerShell.EditorServices.Utility;
 
@@ -74,6 +75,15 @@ internal class DebugService
         /// </summary>
         public DebuggerStoppedEventArgs CurrentDebuggerStoppedEventArgs { get; private set; }
 
+        /// <summary>
+        /// Tracks whether we are running <c>Debug-Runspace</c> in an out-of-process runspace.
+        /// </summary>
+        public bool IsDebuggingRemoteRunspace
+        {
+            get => _debugContext.IsDebuggingRemoteRunspace;
+            set => _debugContext.IsDebuggingRemoteRunspace = value;
+        }
+
         #endregion
 
         #region Constructors
@@ -128,6 +138,8 @@ public async Task<BreakpointDetails[]> SetLineBreakpointsAsync(
             DscBreakpointCapability dscBreakpoints = await _debugContext.GetDscBreakpointCapabilityAsync(CancellationToken.None).ConfigureAwait(false);
 
             string scriptPath = scriptFile.FilePath;
+
+            _psesHost.Runspace.ThrowCancelledIfUnusable();
             // Make sure we're using the remote script path
             if (_psesHost.CurrentRunspace.IsOnRemoteMachine && _remoteFileManager is not null)
             {
@@ -771,22 +783,23 @@ private async Task FetchStackFramesAsync(string scriptNameOverride)
             const string callStackVarName = $"$global:{PsesGlobalVariableNamePrefix}CallStack";
             const string getPSCallStack = $"Get-PSCallStack | ForEach-Object {{ [void]{callStackVarName}.Add(@($PSItem, $PSItem.GetFrameVariables())) }}";
 
+            _psesHost.Runspace.ThrowCancelledIfUnusable();
             // If we're attached to a remote runspace, we need to serialize the list prior to
             // transport because the default depth is too shallow. From testing, we determined the
-            // correct depth is 3. The script always calls `Get-PSCallStack`. On a local machine, we
-            // just return its results. On a remote machine we serialize it first and then later
+            // correct depth is 3. The script always calls `Get-PSCallStack`. In a local runspace, we
+            // just return its results. In a remote runspace we serialize it first and then later
             // deserialize it.
-            bool isOnRemoteMachine = _psesHost.CurrentRunspace.IsOnRemoteMachine;
-            string returnSerializedIfOnRemoteMachine = isOnRemoteMachine
+            bool isRemoteRunspace = _psesHost.CurrentRunspace.Runspace.RunspaceIsRemote;
+            string returnSerializedIfInRemoteRunspace = isRemoteRunspace
                 ? $"[Management.Automation.PSSerializer]::Serialize({callStackVarName}, 3)"
                 : callStackVarName;
 
             // PSObject is used here instead of the specific type because we get deserialized
             // objects from remote sessions and want a common interface.
-            PSCommand psCommand = new PSCommand().AddScript($"[Collections.ArrayList]{callStackVarName} = @(); {getPSCallStack}; {returnSerializedIfOnRemoteMachine}");
+            PSCommand psCommand = new PSCommand().AddScript($"[Collections.ArrayList]{callStackVarName} = @(); {getPSCallStack}; {returnSerializedIfInRemoteRunspace}");
             IReadOnlyList<PSObject> results = await _executionService.ExecutePSCommandAsync<PSObject>(psCommand, CancellationToken.None).ConfigureAwait(false);
 
-            IEnumerable callStack = isOnRemoteMachine
+            IEnumerable callStack = isRemoteRunspace
                 ? (PSSerializer.Deserialize(results[0].BaseObject as string) as PSObject)?.BaseObject as IList
                 : results;
 
@@ -797,7 +810,7 @@ private async Task FetchStackFramesAsync(string scriptNameOverride)
                 // We have to use reflection to get the variable dictionary.
                 IList callStackFrameComponents = (callStackFrameItem as PSObject)?.BaseObject as IList;
                 PSObject callStackFrame = callStackFrameComponents[0] as PSObject;
-                IDictionary callStackVariables = isOnRemoteMachine
+                IDictionary callStackVariables = isRemoteRunspace
                     ? (callStackFrameComponents[1] as PSObject)?.BaseObject as IDictionary
                     : callStackFrameComponents[1] as IDictionary;
 
@@ -861,7 +874,7 @@ private async Task FetchStackFramesAsync(string scriptNameOverride)
                 {
                     stackFrameDetailsEntry.ScriptPath = scriptNameOverride;
                 }
-                else if (isOnRemoteMachine
+                else if (_psesHost.CurrentRunspace.IsOnRemoteMachine
                     && _remoteFileManager is not null
                     && !string.Equals(stackFrameScriptPath, StackFrameDetails.NoFileScriptPath))
                 {
@@ -905,83 +918,98 @@ private static string TrimScriptListingLine(PSObject scriptLineObj, ref int pref
 
         internal async void OnDebuggerStopAsync(object sender, DebuggerStopEventArgs e)
         {
-            bool noScriptName = false;
-            string localScriptPath = e.InvocationInfo.ScriptName;
-
-            // If there's no ScriptName, get the "list" of the current source
-            if (_remoteFileManager is not null && string.IsNullOrEmpty(localScriptPath))
+            try
             {
-                // Get the current script listing and create the buffer
-                PSCommand command = new PSCommand().AddScript($"list 1 {int.MaxValue}");
+                bool noScriptName = false;
+                string localScriptPath = e.InvocationInfo.ScriptName;
 
-                IReadOnlyList<PSObject> scriptListingLines =
-                    await _executionService.ExecutePSCommandAsync<PSObject>(
-                        command, CancellationToken.None).ConfigureAwait(false);
-
-                if (scriptListingLines is not null)
+                // If there's no ScriptName, get the "list" of the current source
+                if (_remoteFileManager is not null && string.IsNullOrEmpty(localScriptPath))
                 {
-                    int linePrefixLength = 0;
+                    // Get the current script listing and create the buffer
+                    PSCommand command = new PSCommand().AddScript($"list 1 {int.MaxValue}");
 
-                    string scriptListing =
-                        string.Join(
-                            Environment.NewLine,
-                            scriptListingLines
-                                .Select(o => TrimScriptListingLine(o, ref linePrefixLength))
-                                .Where(s => s is not null));
+                    IReadOnlyList<PSObject> scriptListingLines =
+                        await _executionService.ExecutePSCommandAsync<PSObject>(
+                            command, CancellationToken.None).ConfigureAwait(false);
 
-                    temporaryScriptListingPath =
-                        _remoteFileManager.CreateTemporaryFile(
-                            $"[{_psesHost.CurrentRunspace.SessionDetails.ComputerName}] {TemporaryScriptFileName}",
-                            scriptListing,
-                            _psesHost.CurrentRunspace);
+                    if (scriptListingLines is not null)
+                    {
+                        int linePrefixLength = 0;
+
+                        string scriptListing =
+                            string.Join(
+                                Environment.NewLine,
+                                scriptListingLines
+                                    .Select(o => TrimScriptListingLine(o, ref linePrefixLength))
+                                    .Where(s => s is not null));
+
+                        temporaryScriptListingPath =
+                            _remoteFileManager.CreateTemporaryFile(
+                                $"[{_psesHost.CurrentRunspace.SessionDetails.ComputerName}] {TemporaryScriptFileName}",
+                                scriptListing,
+                                _psesHost.CurrentRunspace);
+
+                        localScriptPath =
+                            temporaryScriptListingPath
+                            ?? StackFrameDetails.NoFileScriptPath;
+
+                        noScriptName = localScriptPath is not null;
+                    }
+                    else
+                    {
+                        _logger.LogWarning("Could not load script context");
+                    }
+                }
 
-                    localScriptPath =
-                        temporaryScriptListingPath
-                        ?? StackFrameDetails.NoFileScriptPath;
+                // Get call stack and variables.
+                await FetchStackFramesAndVariablesAsync(noScriptName ? localScriptPath : null).ConfigureAwait(false);
 
-                    noScriptName = localScriptPath is not null;
+                // If this is a remote connection and the debugger stopped at a line
+                // in a script file, get the file contents
+                if (_psesHost.CurrentRunspace.IsOnRemoteMachine
+                    && _remoteFileManager is not null
+                    && !noScriptName)
+                {
+                    localScriptPath =
+                        await _remoteFileManager.FetchRemoteFileAsync(
+                            e.InvocationInfo.ScriptName,
+                            _psesHost.CurrentRunspace).ConfigureAwait(false);
                 }
-                else
+
+                if (stackFrameDetails.Length > 0)
                 {
-                    _logger.LogWarning("Could not load script context");
+                    // Augment the top stack frame with details from the stop event
+                    if (invocationTypeScriptPositionProperty.GetValue(e.InvocationInfo) is IScriptExtent scriptExtent)
+                    {
+                        stackFrameDetails[0].StartLineNumber = scriptExtent.StartLineNumber;
+                        stackFrameDetails[0].EndLineNumber = scriptExtent.EndLineNumber;
+                        stackFrameDetails[0].StartColumnNumber = scriptExtent.StartColumnNumber;
+                        stackFrameDetails[0].EndColumnNumber = scriptExtent.EndColumnNumber;
+                    }
                 }
-            }
 
-            // Get call stack and variables.
-            await FetchStackFramesAndVariablesAsync(noScriptName ? localScriptPath : null).ConfigureAwait(false);
+                CurrentDebuggerStoppedEventArgs =
+                    new DebuggerStoppedEventArgs(
+                        e,
+                        _psesHost.CurrentRunspace,
+                        localScriptPath);
 
-            // If this is a remote connection and the debugger stopped at a line
-            // in a script file, get the file contents
-            if (_psesHost.CurrentRunspace.IsOnRemoteMachine
-                && _remoteFileManager is not null
-                && !noScriptName)
+                // Notify the host that the debugger is stopped.
+                DebuggerStopped?.Invoke(sender, CurrentDebuggerStoppedEventArgs);
+            }
+            catch (OperationCanceledException)
             {
-                localScriptPath =
-                    await _remoteFileManager.FetchRemoteFileAsync(
-                        e.InvocationInfo.ScriptName,
-                        _psesHost.CurrentRunspace).ConfigureAwait(false);
+                // Ignore, likely means that a remote runspace has closed.
             }
-
-            if (stackFrameDetails.Length > 0)
+            catch (Exception exception)
             {
-                // Augment the top stack frame with details from the stop event
-                if (invocationTypeScriptPositionProperty.GetValue(e.InvocationInfo) is IScriptExtent scriptExtent)
-                {
-                    stackFrameDetails[0].StartLineNumber = scriptExtent.StartLineNumber;
-                    stackFrameDetails[0].EndLineNumber = scriptExtent.EndLineNumber;
-                    stackFrameDetails[0].StartColumnNumber = scriptExtent.StartColumnNumber;
-                    stackFrameDetails[0].EndColumnNumber = scriptExtent.EndColumnNumber;
-                }
+                // Log in a catch all so we don't crash the process.
+                _logger.LogError(
+                    exception,
+                    "Error occurred while obtaining debug info. Message: {message}",
+                    exception.Message);
             }
-
-            CurrentDebuggerStoppedEventArgs =
-                new DebuggerStoppedEventArgs(
-                    e,
-                    _psesHost.CurrentRunspace,
-                    localScriptPath);
-
-            // Notify the host that the debugger is stopped.
-            DebuggerStopped?.Invoke(sender, CurrentDebuggerStoppedEventArgs);
         }
 
         private void OnDebuggerResuming(object sender, DebuggerResumingEventArgs debuggerResumingEventArgs) => CurrentDebuggerStoppedEventArgs = null;