fix: Prevent a deadlock waiting for browser debugger to attach #704
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#702 fixed the fact that the debugger never attached to projects using the
projectstyle configuration, but I found in my larger repo's that a potential deadlock could occur waiting for the debugger to attach.Scenario:
The RPC event
onBrowserDebugis sent as soon as VSCode completes it's promise to attach to the browser in thethen. There's a timing issue if the browser hasn't yet executed thesetupFilefrom the extension that triggers the await for the event.So:
onBrowserDebugeventbrowserSetupFile.tsthat await for theonBrowserEventvia the__vscode_waitForDebuggercommand created hereBecause the event fired before the setupfile started to listen, the debug session deadlocks here waiting for the signal.
This PR starts listening to the event before adding the
setupFileto the project collection, and stores the state in a private variable. The Command now checks this variable first to see if it's already attached (and immediately returns) or subscribes to the event again like it was doing before to resolve the promise.