Sync breakpoints outside of debug sessions #1853

SeeminglyScience · 2022-07-08T19:50:40Z

PR Summary

This change is paired with PowerShell/vscode-powershell#4065

Adds a client utilizing a custom notification to sync breakpoints between the client and the server at all times. All breakpoint additions, removals, and enable/disable will be synced regardless of if they occur within the console (e.g. sbp -Variable someVar -Mode Write) or in the UI. The only exception is when a breakpoint is enabled/disabled in the PSIC (there's no way to directly enable or disable a breakpoint in the vsc API afaict)

Setting as WIP as I still need to figure out a way to add tests, but please review carefully anyway @andschwa. Ideally we'd release a stable before merging this as I'd like a slightly longer preview period for this change if possible.

SeeminglyScience · 2022-07-08T19:53:44Z

src/PowerShellEditorServices/Index.cs

@@ -0,0 +1,154 @@
+// <auto-generated>
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.


I don't 100% know what to do with this and Index. I may have to rip these out and stop using the range syntax for arbitrary legal reasons but I'd like to check out what other MS projects are doing to polyfill.

I think we chatted about this and it was fine.

andyleejordan

Ok I got through some of this!

src/PowerShellEditorServices/Server/PsesLanguageServer.cs

andyleejordan · 2022-07-12T23:26:59Z

src/PowerShellEditorServices/Services/DebugAdapter/BreakpointSyncService.cs

+        if (!_map.ByPwshId.TryGetValue(eventArgs.Breakpoint.Id, out SyncedBreakpoint existing))
+        {
+            // If we haven't told the client about the breakpoint yet then we can just ignore.
+            if (eventArgs.UpdateType is BreakpointUpdateType.Removed)
+            {
+                return;
+            }
+
+            existing = CreateFromServerBreakpoint(eventArgs.Breakpoint);
+            string? id = await SendToClientAsync(existing.Client, BreakpointUpdateType.Set)
+                .ConfigureAwait(false);
+
+            existing.Client.Id = id!;
+            RegisterBreakpoint(existing);
+            return;
+        }


Just a little confusing to have this in an if (!getThing(named out param)) as the out param is not used (since it's not, it wasn't in the map) but we then assign to it locally and use that. I'd do out Thing _ and then locally declare Thing breakpoint. Or did I read this wrong?

Yeah it's used outside of that if block. The if block is the exit early condition for it not already existing.

I can for sure see how that's confusing though I'll think of a better way to write this

Alright I rewrote this to call a nested method and added a new variable instead of reusing existing since that was really confusing. LMK what you think!

src/PowerShellEditorServices/Services/DebugAdapter/BreakpointSyncService.cs

src/PowerShellEditorServices/Services/DebugAdapter/Handlers/LaunchAndAttachHandler.cs

src/PowerShellEditorServices/Services/PowerShell/Host/PsesInternalHost.cs

The assert here didn't really make sense, since when it's serialized to json `Id` will obviously be accessed.

andyleejordan

Reviewed! Thinking we should do a team review too. But this is very exciting, let's get it into the next preview!

andyleejordan · 2023-10-16T23:23:02Z

src/PowerShellEditorServices/Index.cs

@@ -0,0 +1,154 @@
+// <auto-generated>
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.


I think we chatted about this and it was fine.

andyleejordan · 2023-10-16T23:26:06Z

src/PowerShellEditorServices/Services/DebugAdapter/BreakpointService.cs

@@ -227,6 +247,13 @@ public async Task<IReadOnlyList<CommandBreakpointDetails>> SetCommandBreakpoints
        /// </summary>
        public async Task RemoveAllBreakpointsAsync(string scriptPath = null)
        {
+            // Only need to remove all breakpoints if we're not able to sync outside of debug
+            // sessions.
+            if (_breakpointSyncService?.IsSupported is true)


Should this check actually be wherever we call RemoveAllBreakpointsAsync?

src/PowerShellEditorServices/Services/DebugAdapter/BreakpointSyncService.cs

andyleejordan · 2023-10-16T23:27:47Z

src/PowerShellEditorServices/Services/DebugAdapter/BreakpointSyncService.cs

+
+        public void Unregister(SyncedBreakpoint breakpoint)
+        {
+            ByGuid.TryRemove(breakpoint.Client.Id, out _);


In fact the C# analyzer on GitHub is complaining about Client.Id being possibly null here (since it isn't ignored via !).

andyleejordan · 2023-10-16T23:36:28Z

src/PowerShellEditorServices/Services/DebugAdapter/BreakpointSyncService.cs

+
+        if (id is null)
+        {
+            LogBreakpointError(newBreakpoint, "Did not receive a breakpoint ID from the client.");


Can we proceed without a client ID?

Perhaps the ID shouldn't be nullable if we don't get one, we skip it. Seems like everything else expects/requires it be defined.

andyleejordan · 2023-10-16T23:58:19Z

src/PowerShellEditorServices/Services/DebugAdapter/BreakpointSyncService.cs

+        VariableAccessMode mode = default;
+        SyncedBreakpointKind kind = default;
+
+        if (clientBreakpoint.FunctionName is not null)


This clause could use commentary...I think it's first checking if we were given a variable name and if so resolving it to the function name and otherwise assuming we were given the function name directly.

andyleejordan · 2023-10-16T23:58:51Z

src/PowerShellEditorServices/Services/DebugAdapter/BreakpointSyncService.cs

+            script = clientBreakpoint.Location.Uri.Scheme is "untitled"
+                ? clientBreakpoint.Location.Uri.ToString()
+                : clientBreakpoint.Location.Uri.GetFileSystemPath();


Another thing to double-check (since I think we have a "is URI untitled" helper function with unit tests).

andyleejordan · 2023-10-17T00:03:25Z

src/PowerShellEditorServices/Services/DebugAdapter/Handlers/BreakpointHandlers.cs

+            {
+                // TODO: Find some way to actually verify these. Unfortunately the sync event comes
+                // through *after* the `SetBreakpoints` event so we can't just look at what synced
+                // breakpoints were successfully set.


andyleejordan · 2023-10-17T00:04:46Z

src/PowerShellEditorServices/Services/PowerShell/IPowerShellExecutionService.cs

+        /// the work for the pipeline thread. This method must only be invoked when the caller
+        /// has ensured that they are already running on the pipeline thread.
+        /// </summary>
+        IReadOnlyList<TResult> UnsafeInvokePSCommand<TResult>(PSCommand psCommand, PowerShellExecutionOptions executionOptions, CancellationToken cancellationToken);


I wonder if we should actually use this to process user input from the prompt when we're already on the thread receiving said input...

andyleejordan · 2023-10-17T00:05:43Z

src/PowerShellEditorServices/Services/PowerShell/Host/PsesInternalHost.cs

+            PowerShellExecutionOptions executionOptions,
+            CancellationToken cancellationToken)
+            => InvokePSCommand<TResult>(psCommand, executionOptions, cancellationToken);
+
        public void InvokePSCommand(PSCommand psCommand, PowerShellExecutionOptions executionOptions, CancellationToken cancellationToken) => InvokePSCommand<PSObject>(psCommand, executionOptions, cancellationToken);


Perhaps we should make this private and require the Unsafe versions be called?

SeeminglyScience added 4 commits July 8, 2022 14:47

Add NRT attribs polyfill

17e0d3f

Add index and range polyfills

ec8806f

Add new services for syncing bps outside of DAP

5e7a614

hook up bp sync services

ef47274

SeeminglyScience mentioned this pull request Jul 8, 2022

Sync breakpoints outside of DAP with onDidChangeBreakpoints event PowerShell/vscode-powershell#4065

Draft

4 tasks

SeeminglyScience commented Jul 8, 2022

View reviewed changes

andyleejordan reviewed Jul 12, 2022

View reviewed changes

andyleejordan force-pushed the main branch from cadf294 to 712c0f8 Compare July 13, 2023 01:30

SeeminglyScience and others added 7 commits September 13, 2023 13:00

Merge branch 'main' into bp-sync

f357fa1

Fix build errors

bed8cc3

Fix synced breakpoints for untitled files

347f500

Fix tests

17f3e8c

Fix crash in debug config

55c749d

The assert here didn't really make sense, since when it's serialized to json `Id` will obviously be accessed.

Add a note about alterations and ifdef to polyfill

d6971a9

Address PR feedback

8c10d8a

SeeminglyScience marked this pull request as ready for review October 16, 2023 16:11

SeeminglyScience requested a review from a team as a code owner October 16, 2023 16:11

SeeminglyScience changed the title ~~WIP: Sync breakpoints outside of debug sessions~~ Sync breakpoints outside of debug sessions Oct 16, 2023

andyleejordan reviewed Oct 17, 2023

View reviewed changes

andyleejordan force-pushed the main branch from e390755 to db3d833 Compare March 27, 2024 19:05

andyleejordan force-pushed the main branch 2 times, most recently from caa9e27 to 677f42c Compare May 3, 2024 23:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sync breakpoints outside of debug sessions #1853

Sync breakpoints outside of debug sessions #1853

SeeminglyScience commented Jul 8, 2022 •

edited

SeeminglyScience Jul 8, 2022

andyleejordan Oct 16, 2023

andyleejordan left a comment

andyleejordan Jul 12, 2022

SeeminglyScience Jul 13, 2022

SeeminglyScience Sep 20, 2023

andyleejordan left a comment

andyleejordan Oct 16, 2023

andyleejordan Oct 16, 2023

andyleejordan Oct 16, 2023

andyleejordan Oct 16, 2023

andyleejordan Oct 16, 2023

andyleejordan Oct 16, 2023

andyleejordan Oct 16, 2023

andyleejordan Oct 17, 2023

andyleejordan Oct 17, 2023

andyleejordan Oct 17, 2023

Sync breakpoints outside of debug sessions #1853

Are you sure you want to change the base?

Sync breakpoints outside of debug sessions #1853

Conversation

SeeminglyScience commented Jul 8, 2022 • edited

PR Summary

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andyleejordan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andyleejordan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SeeminglyScience commented Jul 8, 2022 •

edited