Convert samples to use Aspire #593

twsouthwick · 2025-06-06T15:12:29Z

This updates the samples to use Aspire for connecting the client ASP.NET Core and the server ASP.NET Framework applications. This does the following:

Separate out Directory.Packages.props for samples/src/test. The src one pins all the dependencies so that we know which versions are being used, while the test/samples do not so they can run in a more hybrid setup
Update the folder structure to keep samples together
Update playwright tests to connect via Aspire
Ensure each sample has a smoke test (either via HttpClient or Playwright)
Use libman for managing sample javascript/css files

NOTE These are still not being built by CI - that is being covered by a separate PR at #566

This updates the samples to use Aspire for connecting the client ASP.NET Core and the server ASP.NET Framework applications. This does the following: - Separate out Directory.Packages.props for samples/src/test. The src one pins all the dependencies so that we know which versions are being used, while the test/samples do not so they can run in a more hybrid setup - Update the folder structure to keep samples together - Update playwright tests to connect via Aspire - Ensure each sample has a smoke test (either via HttpClient or Playwright) - Use libman for managing sample javascript/css files

Copilot

Pull Request Overview

This PR updates the samples to use Aspire for connecting ASP.NET Core clients with ASP.NET Framework servers. Key changes include reorganizing sample folders and project references, updating configuration keys and launch settings, and revising solution and build properties for the new setup.

Updated launch settings and project files in AuthRemoteFormsAuth samples.
Changed configuration keys for reverse proxy setup in AuthRemoteFormsAuthCore.
Revised solution and global build files to reflect new dependency and packaging strategies.

Reviewed Changes

Copilot reviewed 490 out of 490 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
samples/AuthRemoteFormsAuth/AuthRemoteFormsAuthCore/Properties/launchSettings.json	Adds launch settings for the ASP.NET Core sample.
samples/AuthRemoteFormsAuth/AuthRemoteFormsAuthCore/Program.cs	Refactors service configuration and reverse proxy mapping using updated configuration keys.
samples/AuthRemoteFormsAuth/AuthRemoteFormsAuthCore/AuthRemoteFormsAuthCore.csproj	Updates target framework and project references.
samples/AuthRemoteFormsAuth/AuthRemoteFormsAuthAppHost/appsettings.json	Introduces logging configuration with Aspire-specific log levels.
samples/AuthRemoteFormsAuth/AuthRemoteFormsAuthAppHost/Properties/launchSettings.json	Provides new launch settings for the AppHost sample.
samples/AuthRemoteFormsAuth/AuthRemoteFormsAuthAppHost/Program.cs	Configures the distributed application builder for the AppHost sample.
samples/AuthRemoteFormsAuth/AuthRemoteFormsAuthAppHost/AuthRemoteFormsAuthAppHost.csproj	Updates the AppHost project file to leverage the Aspire host SDK.
global.json	Adjusts dotnet and SDK versions and adds new SDK references.
Microsoft.AspNetCore.SystemWebAdapters.slnf	Modifies the solution file to include the new samples and package props.
Microsoft.AspNetCore.SystemWebAdapters.sln	Reorganizes project nesting and removes outdated test project references.
Directory.Build.props	Adds a packaging property for running pack on the solution.

Comments suppressed due to low confidence (1)

samples/AuthRemoteFormsAuth/AuthRemoteFormsAuthCore/Program.cs:14

The configuration keys have been updated from 'ProxyTo'/'RemoteAppApiKey' to 'RemoteApp:Url' and 'RemoteApp:ApiKey'. Please confirm that all consumers are aware of this API change and that documentation is updated accordingly.

options.RemoteAppUrl = new(builder.Configuration["RemoteApp:Url"]!);

samples/AuthRemoteFormsAuth/AuthRemoteFormsAuthCore/Program.cs

Co-authored-by: Copilot <[email protected]>

joperezr · 2025-06-06T19:10:04Z

samples/AuthRemoteFormsAuth/AuthRemoteFormsAuthAppHost/Program.cs

+
+var remoteApiKey = builder.AddParameter("apiKey", Guid.NewGuid().ToString(), secret: true);
+
+var frameworkApp = builder.AddIISExpress("iis")


TIL about these extensions! Preety neat!

Yes - thanks to some great work by @CZEMacLeod!

joperezr · 2025-06-06T19:11:41Z

samples/AuthRemoteFormsAuth/AuthRemoteFormsAuthAppHost/Program.cs

+
+var coreApp = builder.AddProject<Projects.AuthRemoteFormsAuthCore>("core")
+    .WithEnvironment("RemoteApp__ApiKey", remoteApiKey)
+    .WithEnvironment("RemoteApp__Url", frameworkApp.GetEndpoint("https"))


Assuming the resource returned back from the above is not an IResourceWithEnvironment? Otherwise you could just do a .WithReference(frameworkApp) here

cool. I'll get this merged in and then look at what can make the aspire experience better here

joperezr · 2025-06-06T19:14:18Z

samples/AuthRemoteFormsAuth/AuthRemoteFormsAuthCore/Program.cs

-app.MapForwarder("/{**catch-all}", app.Configuration["ProxyTo"]!).WithOrder(int.MaxValue);
+
+// Configure the reverse proxy to forward all unhandled requests to the remote app
+app.MapForwarder("/{**catch-all}", app.Configuration["RemoteApp:Url"]!)


NIT: If you want to also have HealthChecks enabled, you could also call here the app.MapDefaultEndpoints() from your ServiceDefaults project which should do that.

joperezr · 2025-06-06T19:17:23Z

samples/AuthRemoteIdentity/AuthRemoteIdentityAppHost/Program.cs

+var frameworkApp = iisExpress.AddSiteProject<Projects.AuthRemoteIdentityFramework>("framework")
+    .WithDefaultIISExpressEndpoints()
+    .WithEnvironment("RemoteApp__ApiKey", remoteApiKey)
+    .WithReference(db, connectionName: "DefaultConnection")


Nice! One more tip as a NIT, if you want, you could probably use the client sql integration inside the framework app for connecting to the db, which would then light up all of the telemetry in the dashboard for all calls made to the db. Not needed of course, but just in case you want to try it out.

This is something I want to look into after this PR settles - it's a framework app using entity framework 6, so not sure how well that all integrates

@twsouthwick I do have an EF6 sample for IIS with aspire and have just made sure it includes the SQL Server telemetry.
It also does all the stuff to dynamically connect using Aspire connection strings, and uses Microsoft.EntityFramework.SqlServer / Microsoft.Data.SqlClient.

joperezr

This looks awesome, thanks Taylor!

CZEMacLeod · 2025-06-07T04:40:54Z

samples/SessionRemote/SessionRemoteAppHost/Properties/launchSettings.json

+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development",
+        "DOTNET_ENVIRONMENT": "Development",
+        "DOTNET_DASHBOARD_OTLP_ENDPOINT_URL": "https://localhost:21002",


I think you need to use DOTNET_DASHBOARD_OTLP_HTTP_ENDPOINT_URL as framework does not support https over grpc.

yup figured that out on my next PR :) I hadn't hooked up OTLP yet

twsouthwick requested a review from Copilot June 6, 2025 15:12

Copilot AI reviewed Jun 6, 2025

View reviewed changes

samples/AuthRemoteFormsAuth/AuthRemoteFormsAuthCore/Program.cs Outdated Show resolved Hide resolved

twsouthwick and others added 2 commits June 6, 2025 08:13

Update samples/AuthRemoteFormsAuth/AuthRemoteFormsAuthCore/Program.cs

ee239af

Co-authored-by: Copilot <[email protected]>

net9

2aea7b2

twsouthwick requested a review from joperezr June 6, 2025 17:00

twsouthwick added 2 commits June 6, 2025 11:15

add windows auth sample to sln

3728b76

remove extra file

96579b6

joperezr reviewed Jun 6, 2025

View reviewed changes

joperezr approved these changes Jun 6, 2025

View reviewed changes

twsouthwick merged commit f9f44e1 into main Jun 6, 2025
5 checks passed

twsouthwick deleted the aspire-samples branch June 6, 2025 20:28

CZEMacLeod reviewed Jun 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Convert samples to use Aspire #593

Convert samples to use Aspire #593

Uh oh!

twsouthwick commented Jun 6, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

joperezr Jun 6, 2025

Uh oh!

twsouthwick Jun 6, 2025

Uh oh!

joperezr Jun 6, 2025

Uh oh!

twsouthwick Jun 6, 2025

Uh oh!

joperezr Jun 6, 2025

Uh oh!

joperezr Jun 6, 2025

Uh oh!

twsouthwick Jun 6, 2025

Uh oh!

CZEMacLeod Jun 7, 2025

Uh oh!

joperezr left a comment

Uh oh!

Uh oh!

CZEMacLeod Jun 7, 2025

Uh oh!

twsouthwick Jun 13, 2025

Uh oh!

Uh oh!


		var remoteApiKey = builder.AddParameter("apiKey", Guid.NewGuid().ToString(), secret: true);

		var frameworkApp = builder.AddIISExpress("iis")

Convert samples to use Aspire #593

Convert samples to use Aspire #593

Uh oh!

Conversation

twsouthwick commented Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joperezr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

twsouthwick commented Jun 6, 2025 •

edited

Loading