Aspire failing in GitHub Codespace

[justinyoo]

Hi, Team.

When the current AppHost is running in GitHub Codespaces (and possibly in devcontainer), I found a few issues:

1. The dashboard page is not automatically opening - (Related to [WebToolsE2E][Aspire] The web page cannot be opened automatically after debugging the aspire project in VS Code. #655 ) Either Blazor app or API app automatically opens a new tab when I run it individually. But, the dashboard doesn't automatically open a new page. Instead I have to manually find the page and open it through the port forwarding tab.

• [CodeSpaces] The launchSettings.json of AppHost doesn't seem to be properly respected #1296

  "applicationUrl": "http://localhost:<random_port_number>",
  "environmentVariables": {
    "DOTNET_DASHBOARD_OTLP_ENDPOINT_URL": "http://localhost:<random_port_number>"
  }

  I initially expected that the applicationUrl attribute will be used to launch the dashboard page, but it uses http://localhost:18888. I'm not sure what these applicationUrl and DOTNET_DASHBOARD_OTLP_ENDPOINT_URL are for.

• [CodeSpaces] Dashboard URIs is looking for a URL that may not work #1297

• [Codespaces] instance is recognised as Production #1298

[timheuer]

Thanks @justinyoo this was a bit of a compound issue, so I logged them individually.

[justinyoo]

@timheuer Thanks for splitting it to individual issues!

[davidfowl]

@timheuer we need to re-test this now that we've moved everything around

[timheuer]

@timheuer we need to re-test this now that we've moved everything around

I'm sure this will still not work due to port forwarding... I don't know enough of the implementation details when we do the project/debugger change areas if it will auto-map the right ports.

[davidfowl]

I want to make sure we do this for v1.

[timheuer]

We need someone more familiar with what's needed to map the ports we all create. Not sure if @kvenkatrajan's team work will automatically get this but with the nature of our proxy ports even within the apphost, I assume we want to map the traefik ones.

[kvenkatrajan]

Since the dashboard in preview 3 is now a "known" executable resource that dcp runs - this should just work. We will have to retest to confirm.

[danmoseley]

clarified title (because we could also set up a codespace for this repo)

[joperezr]

Pending validation.

[davidfowl]

@kvenkatrajan I assigned this to you.

[kvenkatrajan]

Aspire launch debug in C# dev kit is currently working on linux, as of end of last week - we are unblocked on testing.

[kvenkatrajan]

Summary after testing:

We were able to test the experience of C# dev kit in code spaces with the new version of C# dev kit and here were our early observations :

• Debug/launch session worked as expected in codespaces
• Dashboard url was attempted to be launched via debug/launch in the browser, though blocked with a popup blocker. Once popups were enabled in browser, dashboard was displayed successfully with the resource application urls displayed
• The application urls displayed in the resources page, does not have the github code space prefix or port forwarded ports - we need some appmodel changes to translate the app urls to include specific github codespace prefix For Example - here is the prefix : https://turbo-space-tribble-xv6w5xxj76h6g64.github.dev/ . And here is an example of a port forwarded version of url is : https://turbo-space-tribble-xv6w5xxj76h6g64-5169.app.github.dev/counter CC: @mitchdenny @WardenGnaw Github codespaces - Dashboard resource urls has incorrect urls not specifying the github code space prefix or port forwarded ports #3441
• Port forwarding UI displays the right url in the Ports tab in C# dev kit
• While attempting to load the application urls it was noticed that the app doesn't render the styles as expected - on further analysis bootstrap and non-app specific css references were not getting added to the source folder within the github deployed website - This appears to be an issue in any ASP .NET core web site deployed and not specific to Aspire

[mitchdenny]

Moving to backlog. We should decide whether this goes in for 9.0.

[mitchdenny]

I did some experimentation this weekend on how to make the upcoming version of .NET Aspire (9.0) work with GitHub Codespaces. Here is what I did.

The first step is creating a GitHub repo and creating a new .NET Aspire project in it (I used the starter project). Next I opened that container and tweaked the .devcontainer file:

https://github.com/mitchdenny/aspire-withcodespaces/blob/main/.devcontainer/devcontainer.json

Then in the Program.cs of the AppHost I created this extension method class:

https://github.com/mitchdenny/aspire-withcodespaces/blob/448476fce79258e3a927634c7cba72c2c8795982/CustomResources.AppHost/Program.cs#L21-L82

And wired it up to the builder like this:

https://github.com/mitchdenny/aspire-withcodespaces/blob/448476fce79258e3a927634c7cba72c2c8795982/CustomResources.AppHost/Program.cs#L7

Then you should just be able to install the C# extensions and F5 the project and it'll start up. The WithCodespaces(...) extension figures out the right forwarded URLs and replaces them on the dashboard: