-
Notifications
You must be signed in to change notification settings - Fork 206
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial switch to breakpoint APIs (#1119)
* Initial switch to breakpoint APIs * codacy * codacy2 * address keith feedback * misc other code * move to runspaceId * fallback get-psbreakpoint * remove notification that caused issues * misc clean up and fixed action script blocks * codacy * get rid of extra GetBreakpointActionScriptBlock * new new breakpoint apis * misc feedback * make things internal for codacy * patrick comments
- Loading branch information
1 parent
40380f6
commit aa00910
Showing
15 changed files
with
776 additions
and
404 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
312 changes: 312 additions & 0 deletions
312
src/PowerShellEditorServices/Services/DebugAdapter/BreakpointService.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,312 @@ | ||
| // | ||
| // Copyright (c) Microsoft. All rights reserved. | ||
| // Licensed under the MIT license. See LICENSE file in the project root for full license information. | ||
| // | ||
|
|
||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Linq; | ||
| using System.Management.Automation; | ||
| using System.Threading.Tasks; | ||
| using Microsoft.Extensions.Logging; | ||
| using Microsoft.PowerShell.EditorServices.Logging; | ||
| using Microsoft.PowerShell.EditorServices.Services.DebugAdapter; | ||
|
|
||
| namespace Microsoft.PowerShell.EditorServices.Services | ||
| { | ||
| internal class BreakpointService | ||
| { | ||
| private readonly ILogger<BreakpointService> _logger; | ||
| private readonly PowerShellContextService _powerShellContextService; | ||
| private readonly DebugStateService _debugStateService; | ||
|
|
||
| // TODO: This needs to be managed per nested session | ||
| internal readonly Dictionary<string, HashSet<Breakpoint>> BreakpointsPerFile = | ||
| new Dictionary<string, HashSet<Breakpoint>>(); | ||
|
|
||
| internal readonly HashSet<Breakpoint> CommandBreakpoints = | ||
| new HashSet<Breakpoint>(); | ||
|
|
||
| public BreakpointService( | ||
| ILoggerFactory factory, | ||
| PowerShellContextService powerShellContextService, | ||
| DebugStateService debugStateService) | ||
| { | ||
| _logger = factory.CreateLogger<BreakpointService>(); | ||
| _powerShellContextService = powerShellContextService; | ||
| _debugStateService = debugStateService; | ||
| } | ||
|
|
||
| public async Task<List<Breakpoint>> GetBreakpointsAsync() | ||
| { | ||
| if (BreakpointApiUtils.SupportsBreakpointApis) | ||
| { | ||
| return BreakpointApiUtils.GetBreakpoints( | ||
| _powerShellContextService.CurrentRunspace.Runspace.Debugger, | ||
| _debugStateService.RunspaceId); | ||
| } | ||
|
|
||
| // Legacy behavior | ||
| PSCommand psCommand = new PSCommand(); | ||
| psCommand.AddCommand(@"Microsoft.PowerShell.Utility\Get-PSBreakpoint"); | ||
| IEnumerable<Breakpoint> breakpoints = await _powerShellContextService.ExecuteCommandAsync<Breakpoint>(psCommand); | ||
| return breakpoints.ToList(); | ||
| } | ||
|
|
||
| public async Task<IEnumerable<BreakpointDetails>> SetBreakpointsAsync(string escapedScriptPath, IEnumerable<BreakpointDetails> breakpoints) | ||
| { | ||
| if (BreakpointApiUtils.SupportsBreakpointApis) | ||
| { | ||
| foreach (BreakpointDetails breakpointDetails in breakpoints) | ||
| { | ||
| try | ||
| { | ||
| BreakpointApiUtils.SetBreakpoint(_powerShellContextService.CurrentRunspace.Runspace.Debugger, breakpointDetails, _debugStateService.RunspaceId); | ||
| } | ||
| catch(InvalidOperationException e) | ||
| { | ||
| breakpointDetails.Message = e.Message; | ||
| breakpointDetails.Verified = false; | ||
| } | ||
| } | ||
|
|
||
| return breakpoints; | ||
| } | ||
|
|
||
| // Legacy behavior | ||
| PSCommand psCommand = null; | ||
| List<BreakpointDetails> configuredBreakpoints = new List<BreakpointDetails>(); | ||
| foreach (BreakpointDetails breakpoint in breakpoints) | ||
| { | ||
| ScriptBlock actionScriptBlock = null; | ||
|
|
||
| // Check if this is a "conditional" line breakpoint. | ||
| if (!string.IsNullOrWhiteSpace(breakpoint.Condition) || | ||
| !string.IsNullOrWhiteSpace(breakpoint.HitCondition) || | ||
| !string.IsNullOrWhiteSpace(breakpoint.LogMessage)) | ||
| { | ||
| actionScriptBlock = BreakpointApiUtils.GetBreakpointActionScriptBlock( | ||
| breakpoint.Condition, | ||
| breakpoint.HitCondition, | ||
| breakpoint.LogMessage, | ||
| out string errorMessage); | ||
|
|
||
| if (!string.IsNullOrEmpty(errorMessage)) | ||
| { | ||
| breakpoint.Verified = false; | ||
| breakpoint.Message = errorMessage; | ||
| configuredBreakpoints.Add(breakpoint); | ||
| continue; | ||
| } | ||
| } | ||
|
|
||
| // On first iteration psCommand will be null, every subsequent | ||
| // iteration will need to start a new statement. | ||
| if (psCommand == null) | ||
| { | ||
| psCommand = new PSCommand(); | ||
| } | ||
| else | ||
| { | ||
| psCommand.AddStatement(); | ||
| } | ||
|
|
||
| psCommand | ||
| .AddCommand(@"Microsoft.PowerShell.Utility\Set-PSBreakpoint") | ||
| .AddParameter("Script", escapedScriptPath) | ||
| .AddParameter("Line", breakpoint.LineNumber); | ||
|
|
||
| // Check if the user has specified the column number for the breakpoint. | ||
| if (breakpoint.ColumnNumber.HasValue && breakpoint.ColumnNumber.Value > 0) | ||
| { | ||
| // It bums me out that PowerShell will silently ignore a breakpoint | ||
| // where either the line or the column is invalid. I'd rather have an | ||
| // error or warning message I could relay back to the client. | ||
| psCommand.AddParameter("Column", breakpoint.ColumnNumber.Value); | ||
| } | ||
|
|
||
| if (actionScriptBlock != null) | ||
| { | ||
| psCommand.AddParameter("Action", actionScriptBlock); | ||
| } | ||
| } | ||
|
|
||
| // If no PSCommand was created then there are no breakpoints to set. | ||
| if (psCommand != null) | ||
| { | ||
| IEnumerable<Breakpoint> setBreakpoints = | ||
| await _powerShellContextService.ExecuteCommandAsync<Breakpoint>(psCommand); | ||
| configuredBreakpoints.AddRange( | ||
| setBreakpoints.Select(BreakpointDetails.Create)); | ||
| } | ||
|
|
||
| return configuredBreakpoints; | ||
| } | ||
|
|
||
| public async Task<IEnumerable<CommandBreakpointDetails>> SetCommandBreakpoints(IEnumerable<CommandBreakpointDetails> breakpoints) | ||
| { | ||
| if (BreakpointApiUtils.SupportsBreakpointApis) | ||
| { | ||
| foreach (CommandBreakpointDetails commandBreakpointDetails in breakpoints) | ||
| { | ||
| try | ||
| { | ||
| BreakpointApiUtils.SetBreakpoint(_powerShellContextService.CurrentRunspace.Runspace.Debugger, commandBreakpointDetails, _debugStateService.RunspaceId); | ||
| } | ||
| catch(InvalidOperationException e) | ||
| { | ||
| commandBreakpointDetails.Message = e.Message; | ||
| commandBreakpointDetails.Verified = false; | ||
| } | ||
| } | ||
|
|
||
| return breakpoints; | ||
| } | ||
|
|
||
| // Legacy behavior | ||
| PSCommand psCommand = null; | ||
| List<CommandBreakpointDetails> configuredBreakpoints = new List<CommandBreakpointDetails>(); | ||
| foreach (CommandBreakpointDetails breakpoint in breakpoints) | ||
| { | ||
| // On first iteration psCommand will be null, every subsequent | ||
| // iteration will need to start a new statement. | ||
| if (psCommand == null) | ||
| { | ||
| psCommand = new PSCommand(); | ||
| } | ||
| else | ||
| { | ||
| psCommand.AddStatement(); | ||
| } | ||
|
|
||
| psCommand | ||
| .AddCommand(@"Microsoft.PowerShell.Utility\Set-PSBreakpoint") | ||
| .AddParameter("Command", breakpoint.Name); | ||
|
|
||
| // Check if this is a "conditional" line breakpoint. | ||
| if (!string.IsNullOrWhiteSpace(breakpoint.Condition) || | ||
| !string.IsNullOrWhiteSpace(breakpoint.HitCondition)) | ||
| { | ||
| ScriptBlock actionScriptBlock = | ||
| BreakpointApiUtils.GetBreakpointActionScriptBlock( | ||
| breakpoint.Condition, | ||
| breakpoint.HitCondition, | ||
| logMessage: null, | ||
| out string errorMessage); | ||
|
|
||
| // If there was a problem with the condition string, | ||
| // move onto the next breakpoint. | ||
| if (!string.IsNullOrEmpty(errorMessage)) | ||
| { | ||
| breakpoint.Verified = false; | ||
| breakpoint.Message = errorMessage; | ||
| configuredBreakpoints.Add(breakpoint); | ||
| continue; | ||
| } | ||
|
|
||
| psCommand.AddParameter("Action", actionScriptBlock); | ||
| } | ||
| } | ||
|
|
||
| // If no PSCommand was created then there are no breakpoints to set. | ||
| if (psCommand != null) | ||
| { | ||
| IEnumerable<Breakpoint> setBreakpoints = | ||
| await _powerShellContextService.ExecuteCommandAsync<Breakpoint>(psCommand); | ||
| configuredBreakpoints.AddRange( | ||
| setBreakpoints.Select(CommandBreakpointDetails.Create)); | ||
| } | ||
|
|
||
| return configuredBreakpoints; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Clears all breakpoints in the current session. | ||
| /// </summary> | ||
| public async Task RemoveAllBreakpointsAsync(string scriptPath = null) | ||
| { | ||
| try | ||
| { | ||
| if (BreakpointApiUtils.SupportsBreakpointApis) | ||
| { | ||
| foreach (Breakpoint breakpoint in BreakpointApiUtils.GetBreakpoints( | ||
| _powerShellContextService.CurrentRunspace.Runspace.Debugger, | ||
| _debugStateService.RunspaceId)) | ||
| { | ||
| if (scriptPath == null || scriptPath == breakpoint.Script) | ||
| { | ||
| BreakpointApiUtils.RemoveBreakpoint( | ||
| _powerShellContextService.CurrentRunspace.Runspace.Debugger, | ||
| breakpoint, | ||
| _debugStateService.RunspaceId); | ||
| } | ||
| } | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| // Legacy behavior | ||
|
|
||
| PSCommand psCommand = new PSCommand(); | ||
| psCommand.AddCommand(@"Microsoft.PowerShell.Utility\Get-PSBreakpoint"); | ||
|
|
||
| if (!string.IsNullOrEmpty(scriptPath)) | ||
| { | ||
| psCommand.AddParameter("Script", scriptPath); | ||
| } | ||
|
|
||
| psCommand.AddCommand(@"Microsoft.PowerShell.Utility\Remove-PSBreakpoint"); | ||
|
|
||
| await _powerShellContextService.ExecuteCommandAsync<object>(psCommand).ConfigureAwait(false); | ||
| } | ||
| catch (Exception e) | ||
| { | ||
| _logger.LogException("Caught exception while clearing breakpoints from session", e); | ||
| } | ||
| } | ||
|
|
||
| public async Task RemoveBreakpointsAsync(IEnumerable<Breakpoint> breakpoints) | ||
| { | ||
| if (BreakpointApiUtils.SupportsBreakpointApis) | ||
| { | ||
| foreach (Breakpoint breakpoint in breakpoints) | ||
| { | ||
| BreakpointApiUtils.RemoveBreakpoint( | ||
| _powerShellContextService.CurrentRunspace.Runspace.Debugger, | ||
| breakpoint, | ||
| _debugStateService.RunspaceId); | ||
|
|
||
| switch (breakpoint) | ||
| { | ||
| case CommandBreakpoint commandBreakpoint: | ||
| CommandBreakpoints.Remove(commandBreakpoint); | ||
| break; | ||
| case LineBreakpoint lineBreakpoint: | ||
| if (BreakpointsPerFile.TryGetValue(lineBreakpoint.Script, out HashSet<Breakpoint> bps)) | ||
| { | ||
| bps.Remove(lineBreakpoint); | ||
| } | ||
| break; | ||
| default: | ||
| throw new ArgumentException("Unsupported breakpoint type."); | ||
| } | ||
| } | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| // Legacy behavior | ||
| var breakpointIds = breakpoints.Select(b => b.Id).ToArray(); | ||
| if(breakpointIds.Length > 0) | ||
| { | ||
| PSCommand psCommand = new PSCommand(); | ||
| psCommand.AddCommand(@"Microsoft.PowerShell.Utility\Remove-PSBreakpoint"); | ||
| psCommand.AddParameter("Id", breakpoints.Select(b => b.Id).ToArray()); | ||
|
|
||
| await _powerShellContextService.ExecuteCommandAsync<object>(psCommand); | ||
| } | ||
| } | ||
|
|
||
|
|
||
| } | ||
| } |
Oops, something went wrong.