Skip to content

Make the aspire integration a bit idiomatic #605

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@

var coreApp = builder.AddProject<Projects.AuthRemoteFormsAuthCore>("core")
.WithHttpHealthCheck()
.WaitFor(frameworkApp)
.WithIncrementalMigrationFallback(frameworkApp, options => options.RemoteAuthentication = RemoteAuthentication.DefaultScheme);
.WaitFor(frameworkApp);

var incremental = builder.AddIncrementalMigrationFallback(coreApp, frameworkApp)
.WithAuthentication(RemoteAuthentication.DefaultScheme);

builder.Build().Run();
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<Project Sdk="MSBuild.SDK.SystemWeb">
<PropertyGroup>
<TargetFramework>net481</TargetFramework>
<TargetFramework>net48</TargetFramework>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Antlr" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@

var coreApp = builder.AddProject<Projects.AuthRemoteIdentityCore>("core")
.WithHttpHealthCheck()
.WaitFor(frameworkApp)
.WithIncrementalMigrationFallback(frameworkApp, options => options.RemoteAuthentication = RemoteAuthentication.DefaultScheme);
.WaitFor(frameworkApp);

var incremental = builder.AddIncrementalMigrationFallback(coreApp, frameworkApp)
.WithAuthentication(RemoteAuthentication.DefaultScheme);

builder.Build().Run();
4 changes: 2 additions & 2 deletions samples/ServiceDefaults/Samples.ServiceDefaults.csproj
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFrameworks>net481;net9.0</TargetFrameworks>
<TargetFrameworks>net48;net9.0</TargetFrameworks>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<IsAspireSharedProject>true</IsAspireSharedProject>
Expand All @@ -25,7 +25,7 @@
<Compile Remove="Framework/**/*" />
</ItemGroup>

<ItemGroup Condition=" '$(TargetFramework)' == 'net481' ">
<ItemGroup Condition=" '$(TargetFramework)' == 'net48' ">
<PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks" />
<PackageReference Include="OpenTelemetry.Instrumentation.AspNet" />
<PackageReference Include="Microsoft.Extensions.FileProviders.Abstractions" />
Expand Down
6 changes: 4 additions & 2 deletions samples/SessionRemote/SessionRemoteAppHost/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@

var coreApp = builder.AddProject<Projects.SessionRemoteCore>("core")
.WithHttpHealthCheck()
.WaitFor(frameworkApp)
.WithIncrementalMigrationFallback(frameworkApp, options => options.RemoteSession = RemoteSession.Enabled);
.WaitFor(frameworkApp);

var incremental = builder.AddIncrementalMigrationFallback(coreApp, frameworkApp)
.WithSession();

builder.Build().Run();
6 changes: 4 additions & 2 deletions samples/WebFormsToBlazor/WebFormsToBlazorAppHost/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@

var coreApp = builder.AddProject<Projects.WebFormsToBlazorCore>("core")
.WithHttpHealthCheck()
.WaitFor(frameworkApp)
.WithIncrementalMigrationFallback(frameworkApp, options => options.RemoteSession = RemoteSession.Enabled);
.WaitFor(frameworkApp);

var incremental = builder.AddIncrementalMigrationFallback(coreApp, frameworkApp)
.WithSession();

builder.Build().Run();
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net9.0-windows</TargetFramework>
<TargetFramework>net10.0-windows</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<IsAspireHost>true</IsAspireHost>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,19 @@ namespace Microsoft.AspNetCore.SystemWebAdapters;

internal static partial class AspireConstants
{
public const string RootKey = "SystemWebAdapters";
public const string ProxyKey = RootKey + Separator + "Proxy";
public const string DefaultIncrementalServiceName = "Default";

public const string ProxyKey = "Proxy";
public const string ProxyKeyIsEnabled = ProxyKey + Separator + "UseForwardedHeaders";
public const string RemoteKey = RootKey + Separator + "Remote";
public const string RemoteKey = "Remote";
public const string RemoteApiKey = RemoteKey + Separator + "ApiKey";
public const string RemoteUrl = RemoteKey + Separator + "RemoteAppUrl";
public const string RemoteSessionKey = RemoteKey + Separator + "Session";
public const string RemoteAuthKey = RemoteKey + Separator + "Authentication";
public const string RemoteAuthIsDefaultScheme = RemoteAuthKey + Separator + "IsDefaultScheme";
public const string IsEnabled = Separator + "IsEnabled";

public static string GetConfigSection(string name) => $"IncrementalMigration{Separator}{name}";

public static string GetKey(string name, string key) => $"{GetConfigSection(name)}{Separator}{key}";
}
12 changes: 12 additions & 0 deletions src/Aspire.Hosting.IncrementalMigration/IncrementalMigration.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
using Aspire.Hosting.ApplicationModel;

namespace Aspire.Hosting;

public class IncrementalMigration(string name) : Resource(name)
{
internal RemoteAuthentication RemoteAuthentication { get; set; } = RemoteAuthentication.Disabled;

internal RemoteSession RemoteSession { get; set; } = RemoteSession.Disabled;

internal string RemoteAppEndpointName { get; set; } = "https";
}

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -8,63 +8,106 @@ namespace Aspire.Hosting;

public static class IncrementalMigrationResourceExtensions
{
public static IResourceBuilder<TCore> WithIncrementalMigrationFallback<TCore, TFramework>(
this IResourceBuilder<TCore> coreApp,
public static IResourceBuilder<IncrementalMigration> AddIncrementalMigrationFallback<TCore, TFramework>(
this IDistributedApplicationBuilder builder,
IResourceBuilder<TCore> coreApp,
IResourceBuilder<TFramework> frameworkApp,
IResourceBuilder<ParameterResource>? apiKey = null
)
where TCore : IResourceWithEnvironment
where TFramework : IResourceWithEnvironment, IResourceWithEndpoints
=> builder.AddIncrementalMigrationFallback(DefaultIncrementalServiceName, coreApp, frameworkApp, apiKey);

public static IResourceBuilder<IncrementalMigration> AddIncrementalMigrationFallback<TCore, TFramework>(
this IDistributedApplicationBuilder builder,
string name,
IResourceBuilder<TCore> coreApp,
IResourceBuilder<TFramework> frameworkApp,
Action<IncrementalMigrationOptions>? configureOptions = null,
IResourceBuilder<ParameterResource>? apiKey = null
)
where TCore : IResourceWithEnvironment
where TFramework : IResourceWithEnvironment, IResourceWithEndpoints
{
ArgumentNullException.ThrowIfNull(builder);
ArgumentException.ThrowIfNullOrWhiteSpace(name);
ArgumentNullException.ThrowIfNull(coreApp);
ArgumentNullException.ThrowIfNull(frameworkApp);

apiKey ??= coreApp.ApplicationBuilder.AddParameter($"{coreApp.Resource.Name}-{frameworkApp.Resource.Name}-remoteapp-apiKey", () => Guid.NewGuid().ToString(), secret: true);
var incrementalMigration = new IncrementalMigration(name);

var options = new IncrementalMigrationOptions();
configureOptions?.Invoke(options);
apiKey ??= coreApp.ApplicationBuilder.AddParameter($"{name}-IncrementalMigration-ApiKey", () => Guid.NewGuid().ToString(), secret: true);

coreApp.WithReferenceRelationship(frameworkApp.Resource);

coreApp.WithEnvironment(ctx =>
{
ctx.EnvironmentVariables[RemoteUrl] = frameworkApp.Resource.GetEndpoint(options.RemoteAppEndpointName);
ctx.EnvironmentVariables[RemoteApiKey] = apiKey;
ctx.EnvironmentVariables[GetKey(name, RemoteUrl)] = frameworkApp.Resource.GetEndpoint(incrementalMigration.RemoteAppEndpointName);
ctx.EnvironmentVariables[GetKey(name, RemoteApiKey)] = apiKey;

if (options.RemoteSession == RemoteSession.Enabled)
if (incrementalMigration.RemoteSession == RemoteSession.Enabled)
{
ctx.EnvironmentVariables[RemoteSessionKey + IsEnabled] = true;
ctx.EnvironmentVariables[GetKey(name, RemoteSessionKey + IsEnabled)] = true;
}

if (options.RemoteAuthentication != RemoteAuthentication.Disabled)
if (incrementalMigration.RemoteAuthentication != RemoteAuthentication.Disabled)
{
ctx.EnvironmentVariables[RemoteAuthKey + IsEnabled] = true;
ctx.EnvironmentVariables[GetKey(name, RemoteAuthKey + IsEnabled)] = true;

if (options.RemoteAuthentication == RemoteAuthentication.DefaultScheme)
if (incrementalMigration.RemoteAuthentication == RemoteAuthentication.DefaultScheme)
{
ctx.EnvironmentVariables[RemoteAuthIsDefaultScheme] = true;
ctx.EnvironmentVariables[GetKey(name, RemoteAuthIsDefaultScheme)] = true;
}
}
});

frameworkApp.WithEnvironment(ctx =>
{
ctx.EnvironmentVariables[RemoteApiKey] = apiKey;
ctx.EnvironmentVariables[GetKey(name, RemoteApiKey)] = apiKey;

ctx.EnvironmentVariables[ProxyKeyIsEnabled] = true;
ctx.EnvironmentVariables[GetKey(name, ProxyKeyIsEnabled)] = true;

if (options.RemoteSession == RemoteSession.Enabled)
if (incrementalMigration.RemoteSession == RemoteSession.Enabled)
{
ctx.EnvironmentVariables[RemoteSessionKey + IsEnabled] = true;
ctx.EnvironmentVariables[GetKey(name, RemoteSessionKey + IsEnabled)] = true;
}

if (options.RemoteAuthentication != RemoteAuthentication.Disabled)
if (incrementalMigration.RemoteAuthentication != RemoteAuthentication.Disabled)
{
ctx.EnvironmentVariables[RemoteAuthKey + IsEnabled] = true;
ctx.EnvironmentVariables[GetKey(name, RemoteAuthKey + IsEnabled)] = true;
}
});

return coreApp;
return builder.AddResource(incrementalMigration)
.WithInitialState(new()
{
Properties = [],
ResourceType = "IncrementalMigration",
IsHidden = true,
});
}

public static IResourceBuilder<IncrementalMigration> WithSession(this IResourceBuilder<IncrementalMigration> incrementalMigration, RemoteSession mode = RemoteSession.Enabled)
{
ArgumentNullException.ThrowIfNull(incrementalMigration);
incrementalMigration.Resource.RemoteSession = mode;
return incrementalMigration;
}

public static IResourceBuilder<IncrementalMigration> WithAuthentication(
this IResourceBuilder<IncrementalMigration> incrementalMigration,
RemoteAuthentication mode = RemoteAuthentication.Enabled)
{
ArgumentNullException.ThrowIfNull(incrementalMigration);
incrementalMigration.Resource.RemoteAuthentication = mode;
return incrementalMigration;
}

public static IResourceBuilder<IncrementalMigration> WithEndpointName(
this IResourceBuilder<IncrementalMigration> incrementalMigration,
string endpointName)
{
ArgumentNullException.ThrowIfNull(incrementalMigration);
incrementalMigration.Resource.RemoteAppEndpointName = endpointName;
return incrementalMigration;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ namespace Microsoft.Extensions.Hosting;

public static class AspireSystemWebAdaptersExtensions
{
public static ISystemWebAdapterBuilder AddSystemWebAdapters(this IHostApplicationBuilder builder)
public static ISystemWebAdapterBuilder AddSystemWebAdapters(this IHostApplicationBuilder builder, string? serviceName = null)
{
#if NET
ArgumentNullException.ThrowIfNull(builder);
Expand All @@ -30,7 +30,8 @@ public static ISystemWebAdapterBuilder AddSystemWebAdapters(this IHostApplicatio
}
#endif

var config = builder.Configuration;
serviceName ??= DefaultIncrementalServiceName;
var config = builder.Configuration.GetSection(GetConfigSection(serviceName));
var adapters = builder.Services.AddSystemWebAdapters();

#if NET
Expand Down Expand Up @@ -61,6 +62,7 @@ public static ISystemWebAdapterBuilder AddSystemWebAdapters(this IHostApplicatio

if (config.GetValue<bool>(RemoteSessionKey + IsEnabled))
{
adapters.AddSessionSerializer();
remoteConfig.AddSessionServer(config.GetSection(RemoteSessionKey).Bind);
}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
using Aspire.Hosting;
using Aspire.Hosting.ApplicationModel;
using Azure;
using Microsoft.Extensions.Hosting;
using Xunit;
using Xunit.Abstractions;

namespace Microsoft.AspNetCore.SystemWebAdapters.E2E.Tests;

internal static class AspireFixtureExtensions
{
public static IResource GetResource(this DistributedApplication app, string resourceName)
{
ThrowIfNotStarted(app);

var applicationModel = app.Services.GetRequiredService<DistributedApplicationModel>();

var resources = applicationModel.Resources;
var resource = resources.SingleOrDefault(r => string.Equals(r.Name, resourceName, StringComparison.OrdinalIgnoreCase));

ArgumentNullException.ThrowIfNull(resource);

return resource;
}

public static async Task<IEnumerable<KeyValuePair<string, string>>> GetIncrementalMigrationEnvironmentVariableValuesAsync<TEntryPoint>(this AspireFixture<TEntryPoint> fixture, string resourceName, ITestOutputHelper output)
where TEntryPoint : class
{
var app = await fixture.GetApplicationAsync();
var resource = Assert.IsAssignableFrom<IResourceWithEnvironment>(app.GetResource(resourceName));
var values = await resource.GetEnvironmentVariableValuesAsync(DistributedApplicationOperation.Publish);
var filtered = values.Where(s => s.Key.StartsWith("IncrementalMigration__", StringComparison.Ordinal)).OrderBy(s => s.Key).ToList();

output.WriteLine($"Environment variables for resource '{resourceName}':");

foreach (var kvp in filtered)
{
output.WriteLine($"{kvp.Key} = {kvp.Value}");
}

output.WriteLine("---------------------------------");

return filtered;
}

static void ThrowIfNotStarted(DistributedApplication app)
{
var lifetime = app.Services.GetRequiredService<IHostApplicationLifetime>();
if (!lifetime.ApplicationStarted.IsCancellationRequested)
{
throw new InvalidOperationException("App not started");
}
}
}
Loading