Add attachDotnetDebugger debug option by JustinGrote · Pull Request #3903 · PowerShell/vscode-powershell ·

PR Summary

Adds an option to attach the omnisharp C# debugger for binary module projects, enabling mixed debugging for Powershell Binary Modules.

Demo.mp4

The attach task runs as a child task to the PowerShell debugging session and is managed via its lifecycle.

Related Changes

As part of this PR I also refactored/rearranged the debug config resolution/validation/mutation steps, to occur at the proper stages of functions that were called. I added tests for what I changed.

WIP Checklist

Cleanup on Temporary PSIC stop
Multi-Root Workspace Validation
Generalize to allow specification of a config name

PR Checklist

Note: Tick the boxes below that apply to this pull request by putting an x between the square brackets.
Please mark anything not applicable to this PR NA.

PR has a meaningful title
Summarized changes
PR has tests
This PR is ready to merge and is not work in progress
- If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready

This PR is still active, and I likely will try to fix it before PSConfEU as it will dovetail well into our binary module presentation.

@andschwa

@andschwa picking this back up again. Would you prefer me to add the functionality in PR increments since it requires an explicit debug option to activate for easier review, or do you want this to be a big ol' PR with all batteries included?

Uhh just how big do you think one big PR will be? Certainly less overhead to do it in one go.

Uhh just how big do you think one big PR will be? Certainly less overhead to do it in one go.

Not super huge, see the WIP items. Maybe a couple hundred lines at most.

@andschwa

@andschwa this PR now works great locally for me, but uh, any idea how to troubleshoot the CI problem here?

EDIT: It helps to rebase to the latest main :)

@andschwa

@andschwa I may need some help with getting the tests up and running, I can't for the life of me get it to work either in codespaces or locally.

EDIT: Not sure what I did but I completely blew away all of node_modules, etc. and did an npm ci and things seem to be OK again.

@JustinGrote

@JustinGrote ping me when you want a review! I should be on Discord too.

@andschwa

@andschwa implementation code is good for review, we'll just need to dream up some tests.

Here is an extension build for anyone wanting to play with it. You will need to rename .zip to .vsix and then use "Install Extension from VSIX" in the VSCode command palette.
powershell-2023.3.2-binaryModuleDebug.zip

Or specify the extension on commandline: code --install-extension (Resolve-Path "~\Downloads\powershell-2023.3.2-binaryModuleDebug.vsix")

Rebased to latest main

Looks really good, just some changes!

package.json

src/features/DebugSession.ts

test/features/DebugSession.test.ts

src/process.ts

@andschwa

@andschwa this is ready for review. End to End tests for the binary module debugging were added and it tests both that it starts correctly and that a C# breakpoint is hit in a hybrid module.

@andschwa

Extract processId Fetch Cleanup legacy bad rebase Revert breakout config Add dotnetDebuggerConfigName info TODO the workspace folder support Fix typo Cleanup flow and breakout temporary console to dedicated functions Add handlers to cleanup dotnet attach Fix linting issues Refactor one-time event disposal using variable scope demonry Clarify the handlers Remove Disposable (lint fix) Add initial test Lint fix Fix description to use correct and more specific terminology. Co-authored-by: Andy Jordan <[email protected]> Apply suggestions from @andschwa review Fixed E2E Debug Testing Remove Only Add initial Debug test scaffolding Remove "only" Move validation logic to resolve functions and implement first resolve test Rearrange methods with public first and implementation details last, in order of implemented interfaces. Add more tests Fixed positioning of resolvesubstitutedvariables, now the public methods happen in the order they are called Populate more tests Some more scaffoldng and a broken test Add optional attach port to runTests and remove only *again* Fix wrong argv for port Add check for PSES Binaries Adjust StubInterface to use Partial to preserve intellisense More test fixes Fix test names to be consistent with other tests More specific error checks and implement structuredClone Add structuredclone to dev dependencies Revert accidental commit of new build tasks Update package.json Co-authored-by: Andy Jordan <[email protected]> Enable ESModuleInterop and fix related issues Updated structuredclone import to ES6 syntax Add ESModuleInterop to tsconfig.json More test adds and add newlines between Arrange Act Assert More test scaffolding ESModuleInterop fixes Bump package-lock More esModuleInterop fixes Tests TESTS TESTS TESTS TESTS Flaky Test Check Move testing default folder to examples Add binary module example and C# extension fetching Add precompiled binarymodule so that it doesnt have to be built for testing Fix pid for ProcessID Add first binary module E2E test Suppress first run messages in examples folder Remove Only Add createDebugAdapterDescriptor test Remove Only Move working dir back to test (was breaking settings tests) and add dummy csproj for C# activation Move dummy to mocks folder Reload window for CI Fix assertion order in binary module test Skip Mac on binary module script test for now Fix bug where stdout is null if CLI install fails Extract CSharp extension install to separate function for DAMP clarity Add test if C# extension was found Remove imports More MacOS troubleshooting (7 minute cycles between tests is hell) More troubleshooting lines Add hack to change cwd to make resolveCliArgs happy Found out the electron extensions run in a whole separate process on MacOS, handle that Re-enable resolveCliArgs detection problem fix Remove error reference Try without window reload Remove Async from InstallCSharpExtension Remove more async Wait for C# extension to load rather than just reloading the window More binary module test scaffolding End to End Tests Done! 🎉🎉🎉 Spoke too soon, find out why CI breakpoint test fails (probably because it might be headless) Add undefined checks Build test binary module locally to avoid absolute PDB path issues MacOS why you gotta be such a PIA Remove dummy csproj, maybe MacOS search was a flake Try reload window on mac Move MacOS C# install to before tests to avoid test duplications Fix reload loop on mac Remove reload from initial Add some debugging to try to find macos issue Move event registration to before startDebugging Try increasing timeout for MacOS Add WaitEvent helper function Try MacOS Hot Install Again Retry: RunCode test seems to be flaky Change exec to spawn to make CodeQL happy Revert "Change exec to spawn to make CodeQL happy" This reverts commit d3aea33.

… Windows 5.1

package.json

src/features/DebugSession.ts

test/mocks/BinaryModule/BinaryModule.csproj

test/features/DebugSession.test.ts

test/utils.ts

Co-authored-by: Andy Jordan <[email protected]>

Doing the "hot install" of the extension seems to be flaky and locking up the extension host on 2022 PS7 for some reason on occasion, I may just move the C# initialization to the beginning prior to starting the tests in the first place.

👏

Fixes dotnetDebuggerConfigName-option in launch config when using new attachDotnetDebugger feature introduced in #3903. Always threw config not found-error when dotnetDebuggerConfigName was set. Co-authored-by: Justin Grote <[email protected]>

JustinGrote added Area-Debugging Area-Configuration labels Apr 1, 2022

JustinGrote requested review from andyleejordan and SeeminglyScience April 1, 2022 21:27

JustinGrote self-assigned this Apr 1, 2022

JustinGrote marked this pull request as draft May 25, 2022 16:38

JustinGrote removed request for andyleejordan and SeeminglyScience January 12, 2023 23:27

JustinGrote force-pushed the binaryModuleDebug branch from 2dd742a to 613f208 Compare March 29, 2023 05:25

JustinGrote force-pushed the binaryModuleDebug branch from 961fcb4 to ccc2783 Compare March 30, 2023 02:58

JustinGrote marked this pull request as ready for review March 30, 2023 04:05

JustinGrote requested a review from a team March 30, 2023 04:05

JustinGrote marked this pull request as draft March 30, 2023 04:05

JustinGrote marked this pull request as ready for review March 30, 2023 04:06

JustinGrote requested a review from andyleejordan March 30, 2023 04:07

JustinGrote changed the title ~~WIP: Add attachDotnetDebugger debug option~~ Add attachDotnetDebugger debug option Mar 30, 2023

andyleejordan added the Issue-EnhancementA feature request (enhancement).label Apr 3, 2023

JustinGrote force-pushed the binaryModuleDebug branch from f5cd8aa to 0fcf727 Compare April 5, 2023 19:17

andyleejordan requested changes Apr 5, 2023
View reviewed changes

JustinGrote disabled auto-merge April 10, 2023 16:20

JustinGrote force-pushed the binaryModuleDebug branch from 0ce15de to 15f65cf Compare April 10, 2023 20:11

Add explicit type to createDebugSessionFeatureStub

43da008

JustinGrote force-pushed the binaryModuleDebug branch from 3f16de2 to 43da008 Compare April 10, 2023 20:42

JustinGrote added 3 commits April 10, 2023 14:06

Eliminate race condition from RunCode test that is making it flaky on…

22d308f
… Windows 5.1

Clarify how WaitEvent returns

7616258

Forgot to register the event prior to the debug start

e5f2340

andyleejordan requested changes Apr 10, 2023
View reviewed changes

JustinGrote and others added 10 commits April 10, 2023 14:42

Make StructuredClone Dependency Explicit

1bcd565
Co-authored-by: Andy Jordan <[email protected]>

Update all vscode imports in DebugSession to destructured syntax

ce23551

Refix writeandshowerror from await to void

2c6e818

Forgive resolveDebugConfiguration not having an await

efc6756

Remove private config reference as it is unused and update tests

aa8a1ad

Bump PSStandard.Library to 5.1.1

5c72a06

Fix typo

fcaeaab

Remove note about C# extension because it happens later

441db78

Add back cleanup

719275b

Merge branch 'main' into binaryModuleDebug

3e0c28f

JustinGrote requested a review from andyleejordan April 11, 2023 18:58

Move csharp extension installation outside of process

24f9b64

andyleejordan approved these changes Apr 11, 2023
View reviewed changes

JustinGrote enabled auto-merge (squash) April 11, 2023 20:18

JustinGrote merged commit c990d7f into main Apr 11, 2023

JustinGrote deleted the binaryModuleDebug branch April 11, 2023 20:18

fflaten mentioned this pull request Apr 13, 2023
Fix attachDotnetDebugger with custom config #4517
Merged
3 tasks

ALIENQuake mentioned this pull request Aug 16, 2023
Binary Module Debugging with Script specified causes a terminal error exit -1 at the end of the debugging session on Windows only #4702
Closed
6 tasks

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Conversation

PR Summary

Related Changes

WIP Checklist

PR Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!