Add support for launching debugging proxy from UI extension #3013

captainsafia · 2021-01-27T19:22:25Z

Summary of the changes

Adds devcontainer for aspnetcore-tooling repo under .devcontainer/
Updates tasks.json to support launching workspace inside dev container (preface all paths with ${workspaceFolder}
Add companion extension under Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension
- Adds ms-blazorwasm-companion.launchDebugProxy and ms-blazorwasm-companion.killDebugProxy commands on the UI extension that can be invoked from the workspace
- Adds LocalDebugProxyManager for downloading and getting path of debugging proxy package locally
Updates BlazorWasmDebugConfig type to use debugging proxy launched via the companion extension

Review Guide

To review this PR, I recommend reading through the changes in src/Razor/src/Microsoft.AspNetCore.Razor.VSCode/src/BlazorDebug/BlazorDebugConfigurationProvider.ts then tracing that to the new APIs introduced in the companion extension at src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/src/extension.ts.

Fixes: dotnet/aspnetcore#22587

.vscode/tasks.json

...Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/src/LocalDebugProxyManager.ts

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.Extension/package.json

...or/src/Microsoft.AspNetCore.Razor.VSCode/src/BlazorDebug/BlazorDebugConfigurationProvider.ts

ryanbrandenburg

Awesome, just some nitpicks and one questions mostly for my own education.

.vscode/tasks.json

ryanbrandenburg · 2021-01-27T19:46:33Z

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/README.md

@@ -0,0 +1,23 @@
+# Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension
+
+This directory contains the code for the Blazor WASM companion extension. This extension is designed to support remote debugging scenarios for Blazor WebAssembly.


Love the informative README.

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/package.json

...Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/src/LocalDebugProxyManager.ts

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/src/extension.ts

...or/src/Microsoft.AspNetCore.Razor.VSCode/src/BlazorDebug/BlazorDebugConfigurationProvider.ts

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.Extension/package.json

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/src/extension.ts

...Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/src/LocalDebugProxyManager.ts

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/README.md

TanayParikh

Nice! Just some minor comments;

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/tsconfig.json

...Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/src/LocalDebugProxyManager.ts

captainsafia · 2021-01-28T20:23:46Z

🆙 📅 Made some major changes to this after a convo with @NTaylorMullen:

Instead of acquiring the debug proxy from NuGet, the extension comes bundled with it. Pros: we don't need to worry about acquisition logic in the extension. Cons: users have less flexibility to change the version of the debug proxy they are on and we will need to republish the extension if we want to update to use a newer version that has bugs/features.
I used the vscode-dotnet-runtime extension to acquire a dotnet install when running in remote scenarios.

TanayParikh · 2021-01-28T21:19:00Z

Not sure if I missed the context on this, but what's the empty src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/BlazorDebugProxy/_._ file for?

captainsafia · 2021-01-28T21:34:54Z

Not sure if I missed the context on this, but what's the empty src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/BlazorDebugProxy/. file for?

Git doesn't commit empty folders sometimes and I wanted this to be included so that devs know it needs to be loaded with content. I decided to change this and added a README that outlines what content it should contain (in addition to the docs that already exist in the extension's README).

NTaylorMullen

Just to clarify, this PR purposefully doesn't have the VSIX creation / publish lifecycle bits included right?

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/package.json

...c/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/src/acquireDotnetInstall.ts

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/package.json

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/src/extension.ts

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/package.json

.vscode/tasks.json

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/src/extension.ts

...c/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/src/acquireDotnetInstall.ts

captainsafia · 2021-01-29T00:35:44Z

Just to clarify, this PR purposefully doesn't have the VSIX creation / publish lifecycle bits included right?

Correct. This PR is here to get consensus on the implementation of the PR. My plan is to open a separate PR for publishing-related things.

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/src/extension.ts

NTaylorMullen

Loooks good!

To make sure I have the next steps in my head correctly could you verify this list is correct:

Meet with O# about adding the dependency & it's implications
Find the msdotnettools subscription owners and learn what it takes to publish an extension under that publisher
Implement the publishing logic to create the VSCode extension assets

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/src/extension.ts

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/package.json

captainsafia · 2021-02-01T02:19:34Z

Meet with O# about adding the dependency & it's implications

I've spoken with @JoeRobich a handful of times about this but we can loop in other folks from the extension team for awareness now that the concrete implementation is done.

Find the msdotnettools subscription owners and learn what it takes to publish an extension under that publisher

I already did this. Chatted with Joey and Sarah a while back and they've created a doc about this.

Implement the publishing logic to create the VSCode extension assets

Can you clarify what you mean by this? For publishing, we can use the vsce to package and publish everything.

NTaylorMullen · 2021-02-01T18:22:13Z

Can you clarify what you mean by this? For publishing, we can use the vsce to package and publish everything.

This is just referring to adding the MSBuild logic to aspnetcore-tooling to actually generate a VSIX that we can then publish to the marketplace.

I've spoken with @JoeRobich a handful of times about this but we can loop in other folks from the extension team for awareness now that the concrete implementation is done.

Have you spoken to the management on that side to get buy off? Asking because technically it influences the install experience of O# so we'll need a concrete agreement of what's going to happen.

I already did this. Chatted with Joey and Sarah a while back and they've created a doc about this.

O could you link? I imagine we'd need to go through some sort of managerial hurdles to get approved to publish another extension under that publisher.

captainsafia requested review from NTaylorMullen, TanayParikh, allisonchou and ryanbrandenburg as code owners January 27, 2021 19:22

Launch Blazor WASM debugging proxy via companion extension

9866928

captainsafia force-pushed the safia/remote-dbg branch from 8d6bf96 to 9866928 Compare January 27, 2021 19:24

captainsafia commented Jan 27, 2021

View reviewed changes

.vscode/tasks.json Show resolved Hide resolved

captainsafia commented Jan 27, 2021

View reviewed changes

...Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/src/LocalDebugProxyManager.ts Outdated Show resolved Hide resolved

captainsafia commented Jan 27, 2021

View reviewed changes

...Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/src/LocalDebugProxyManager.ts Outdated Show resolved Hide resolved

Add license header to new source files

04b8d28

captainsafia commented Jan 27, 2021

View reviewed changes

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.Extension/package.json Outdated Show resolved Hide resolved

captainsafia commented Jan 27, 2021

View reviewed changes

...or/src/Microsoft.AspNetCore.Razor.VSCode/src/BlazorDebug/BlazorDebugConfigurationProvider.ts Show resolved Hide resolved

ryanbrandenburg approved these changes Jan 27, 2021

View reviewed changes

Address feedback from peer review

b0a6d86

NTaylorMullen suggested changes Jan 27, 2021

View reviewed changes

TanayParikh reviewed Jan 28, 2021

View reviewed changes

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/tsconfig.json Outdated Show resolved Hide resolved

...Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/src/LocalDebugProxyManager.ts Outdated Show resolved Hide resolved

Address feedback from peer review

45c4156

TanayParikh reviewed Jan 28, 2021

View reviewed changes

...Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/src/LocalDebugProxyManager.ts Outdated Show resolved Hide resolved

Package debug proxy and acquire dotnet

20e0ad9

Clean up package.json and fix async iterator

3b7429c

NTaylorMullen suggested changes Jan 28, 2021

View reviewed changes

sfoslund reviewed Jan 28, 2021

View reviewed changes

...c/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/src/acquireDotnetInstall.ts Outdated Show resolved Hide resolved

...c/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/src/acquireDotnetInstall.ts Show resolved Hide resolved

Address feedback from peer review

63f6139

Read runtime version from package.json

ecba7ef

NTaylorMullen reviewed Jan 29, 2021

View reviewed changes

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/src/extension.ts Outdated Show resolved Hide resolved

Always acquire dotnet

5b264c0

NTaylorMullen reviewed Jan 29, 2021

View reviewed changes

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension/src/extension.ts Outdated Show resolved Hide resolved

captainsafia added 2 commits January 29, 2021 13:53

Add dependency on C# extension for companion

399bdff

Verify dotnet install via dotnet --info

5951019

NTaylorMullen approved these changes Jan 29, 2021

View reviewed changes

Add logging for PIDs and clean up acquisition code

55137f4

captainsafia merged commit f21b320 into master Feb 1, 2021

captainsafia deleted the safia/remote-dbg branch February 1, 2021 02:20

		@@ -0,0 +1,23 @@
		# Microsoft.AspNetCore.Razor.VSCode.BlazorWasmCompanionExtension

		This directory contains the code for the Blazor WASM companion extension. This extension is designed to support remote debugging scenarios for Blazor WebAssembly.

Add support for launching debugging proxy from UI extension #3013

Add support for launching debugging proxy from UI extension #3013

Uh oh!

Conversation

captainsafia commented Jan 27, 2021

Summary of the changes

Review Guide

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ryanbrandenburg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ryanbrandenburg Jan 27, 2021

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!

TanayParikh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

captainsafia commented Jan 28, 2021

Uh oh!

TanayParikh commented Jan 28, 2021

Uh oh!

captainsafia commented Jan 28, 2021

Uh oh!

NTaylorMullen left a comment

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!

captainsafia commented Jan 29, 2021

Uh oh!

Uh oh!

Uh oh!

NTaylorMullen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

captainsafia commented Feb 1, 2021

Uh oh!

NTaylorMullen commented Feb 1, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone