Merge branch 'main' into beh/persistent-cookies-server-side-sessions-bug

bff/docs/upgrade-guide.md

@@ -0,0 +1,101 @@
+# Upgrade guide
+
+## From v2.x => v3.x
+
+If you rely on the default extension methods for wiring up the BFF, then V3 should be a drop-in replacement. 
+
+### Migrating from custom implementations of IHttpMessageInvokerFactory 
+
+In Duende.BFF V2, there was an interface called IHttpMessageInvokerFactory. This class was responsible for creating 
+and wiring up yarp's HttpMessageInvoker. This interface has been removed in favor yarp's IForwarderHttpClientFactory.
+
+One common scenario for creating a custom implementation of this class was for mocking the http client
+during unit testing. 
+
+If you wish to inject a http handler for unit testing, you should now inject a custom IForwarderHttpClientFactory. For example:
+
+``` c#
+   // A Forwarder factory that forwards the messages to a message handler (which can be easily retrieved from a testhost)
+    public class BackChannelHttpMessageInvokerFactory(HttpMessageHandler backChannel) 
+        : IForwarderHttpClientFactory
+    {
+        public HttpMessageInvoker CreateClient(ForwarderHttpClientContext context) => 
+            new HttpMessageInvoker(backChannel);
+    }
+
+   // Wire up the forwarder in your application's test host:
+    services.AddSingleton<IForwarderHttpClientFactory>(
+         new BackChannelHttpMessageInvokerFactory(_apiHost.Server.CreateHandler()));
+
+
+```
+
+### Migrating from custom implementations IHttpTransformerFactory
+The *IHttpTransformerFactory* was a way to globally configure the YARP tranform pipeline. In V3, the way that 
+the default *endpoints.MapRemoteBffApiEndpoint()* method builds up the YARP transform has been simplified
+significantly. Most of the logic has been pushed down to the *AccessTokenRequestTransform*. 
+
+Here are common scenario's for implementing your own *IHttpTransformerFactory* and how to upgrade:
+
+**Replacing defaults**
+
+If you used a custom implementation of IHttpTransformerFactory to change the default behavior of *MapRemoteBffApiEndpoint()*, 
+for example to add additional transforms, then you can now inject a custom delegate into the di container:
+
+```
+services.AddSingleton<BffYarpTransformBuilder>(CustomDefaultYarpTransforms);
+
+//...
+
+// This is an example of how to add a response header to ALL invocations of MapRemoteBffApiEndpoint()
+private void CustomDefaultBffTransformBuilder(string localpath, TransformBuilderContext context)
+{
+    context.AddResponseHeader("added-by-custom-default-transform", "some-value");
+    DefaultBffYarpTransformerBuilders.DirectProxyWithAccessToken(localpath, context);
+}
+```
+
+Another way of doing this is to create a custom extensionmethod *MyCustomMapRemoteBffApiEndpoint()* that wraps
+the MapRemoteBffApiEndpoint() and use that everywhere in your application. This is a great way to add other defaults
+that should apply to all endpoints, such as requiring a specific type of access token. 
+
+**Configuring transforms for a single route**
+Another common usecase for overriding the IHttpTransformerFactory was to have a custom transform for a single route, by
+applying a switch statement and testing for specific routes. 
+
+Now, there is an overload on the *endpoints.MapRemoteBffApiEndpoint()* that allows you to configure the pipeline directly:
+
+``` c#
+
+            endpoints.MapRemoteBffApiEndpoint(
+                "/local-path",
+                _apiHost.Url(),
+                context =>
+                {
+                    // do something custom: IE: copy request headers
+                    context.CopyRequestHeaders = true;
+
+                    // wire up the default transformer logic
+                    DefaultTransformers.DirectProxyWithAccessToken("/local-path", context);
+                })
+                // Continue with normal BFF configuration, for example, allowing optional user access tokens
+                .WithOptionalUserAccessToken();
+
+```
+
+### Removed method RemoteApiEndpoint.Map(localpath, apiAddress). 
+The Map method was no longer needed as most of the logic had been moved to either the MapRemoteBffApiEndpoint and the DefaultTransformers. The map method also wasn't very explicit about what it did and a number of test scenario's tried to verify if it wasn't called wrongly. You are now expected to call the method MapRemoteBffApiEndpoint. This method now has a nullable parameter that allows you to inject your own transformers. 
+
+### AccessTokenRetrievalContext properties are now typed
+The LocalPath and ApiAddress properties are now typed. They used to be strings. If you rely on these, for example for implementing 
+a custom IAccessTokenRetriever, then you should adjust their usage accordingly. 
+
+    /// <summary>
+    /// The locally requested path.
+    /// </summary>
+    public required PathString LocalPath { get; set; }
+
+    /// <summary>
+    /// The remote address of the API.
+    /// </summary>
+    public required Uri ApiAddress { get; set; }

bff/migrations/Directory.Build.props

@@ -1,4 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project>
+  <PropertyGroup>
+	  <TargetFramework>net9.0</TargetFramework>
+  </PropertyGroup>
   <Import Project="../../samples.props" />
 </Project>

bff/migrations/UserSessionDb/UserSessionDb.csproj

@@ -1,11 +1,11 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
-	  <TargetFrameworks>net9.0</TargetFrameworks>
+	  <TargetFramework>net9.0</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.EntityFrameworkCore.Design" >
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Design">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>

bff/samples/Apis/Api.DPoP/Api.DPoP.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
 
     <PropertyGroup>
-	    <TargetFramework>net9.0</TargetFramework>
+	    <TargetFrameworks>net9.0</TargetFrameworks>
     </PropertyGroup>
 
     <ItemGroup>

bff/samples/Bff/Bff.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
 
     <PropertyGroup>
-	    <TargetFramework>net9.0</TargetFramework>
+	    <TargetFrameworks>net9.0</TargetFrameworks>
         <RootNamespace>Bff</RootNamespace>
         <Nullable>enable</Nullable>
     </PropertyGroup>

bff/samples/Directory.Build.props

@@ -1,4 +1,23 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project>
+  <PropertyGroup>
+    <!-- This line is needed because:
+    
+    Aspire needs a single target framework 
+      (until this is resolved: https://github.com/dotnet/aspire/issues/2962)
+    
+    When you add <TargetFrameworks>net9.0</TargetFrameworks> then aspire thinks there are more than
+    one framework. But this causes a problem for the Directory.Packages.props file.
+
+    In the Directory.Packages.props where we check for $(TargetFramework) == 'net9.0',
+    which is ONLY set if you use <TargetFrameworks>net9.0</TargetFrameworks> in the csproj file, not
+    if you set <TargetFramework>. 
+
+    Now normally it's not recommended to set both, however, since this is only for samples, AND
+    we do need this check, we're setting it here as well. 
+
+      -->
+    <TargetFramework>net9.0</TargetFramework>
+  </PropertyGroup>
   <Import Project="../../samples.props" />
 </Project>

bff/samples/Hosts.Tests/Hosts.Tests.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
-		<TargetFramework>net9.0</TargetFramework>
+		<TargetFrameworks>net9.0</TargetFrameworks>
 		<ImplicitUsings>enable</ImplicitUsings>
 		<Nullable>enable</Nullable>
 		<IsPackable>false</IsPackable>

bff/samples/Hosts.Tests/TestInfra/BffClient.cs

@@ -1,5 +1,5 @@
-// // Copyright (c) Duende Software. All rights reserved.
-// // See LICENSE in the project root for license information.
+// Copyright (c) Duende Software. All rights reserved.
+// See LICENSE in the project root for license information.
 
 using System.Text.Json;
 using AngleSharp;

bff/samples/Hosts.Tests/TestInfra/CloningHttpMessageHandler.cs

@@ -1,5 +1,5 @@
-// // Copyright (c) Duende Software. All rights reserved.
-// // See LICENSE in the project root for license information.
+// Copyright (c) Duende Software. All rights reserved.
+// See LICENSE in the project root for license information.
 
 namespace Hosts.Tests.TestInfra;
 

bff/samples/IdentityServer/Extensions.cs

@@ -1,5 +1,5 @@
-// // Copyright (c) Duende Software. All rights reserved.
-// // See LICENSE in the project root for license information.
+// Copyright (c) Duende Software. All rights reserved.
+// See LICENSE in the project root for license information.
 
 using IdentityServerHost;
 namespace IdentityServer;

bff/samples/IdentityServer/ServiceDiscoveringClientStore.cs

@@ -1,5 +1,5 @@
-// // Copyright (c) Duende Software. All rights reserved.
-// // See LICENSE in the project root for license information.
+// Copyright (c) Duende Software. All rights reserved.
+// See LICENSE in the project root for license information.
 
 using Duende.IdentityModel;
 using Duende.IdentityServer.Models;

bff/src/Duende.Bff.Blazor.Client/ClaimRecord.cs

@@ -0,0 +1,41 @@
+using System.Text.Json.Serialization;
+
+namespace Duende.Bff;
+
+/// <summary>
+/// Serialization friendly claim.
+///
+/// Note, this is a copy of the ClaimRecord class from Duende.Bff, but since we can't create a reference to it, we need to copy it here.
+/// We also can't link to it (as we do with the extensions) because the other ClaimRecord class is public and this one is intentionally internal.
+/// </summary>
+internal class ClaimRecord()
+{
+    /// <summary>
+    /// Serialization friendly claim
+    /// </summary>
+    /// <param name="type">The type</param>
+    /// <param name="value">The Value</param>
+    internal ClaimRecord(string type, object value) : this()
+    {
+        Type = type;
+        Value = value;
+    }
+
+    /// <summary>
+    /// The type
+    /// </summary>
+    [JsonPropertyName("type")]
+    public string Type { get; init; } = default!;
+
+    /// <summary>
+    /// The value
+    /// </summary>
+    [JsonPropertyName("value")]
+    public object Value { get; init; } = default!;
+
+    /// <summary>
+    /// The value type
+    /// </summary>
+    [JsonPropertyName("valueType")]
+    public string? ValueType { get; init; }
+}

bff/src/Duende.Bff.Blazor.Client/Duende.Bff.Blazor.Client.csproj

@@ -4,12 +4,12 @@
     <TargetFrameworks>net8.0</TargetFrameworks>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
   </PropertyGroup>
 
   <ItemGroup>
-    <Compile Include="..\Duende.Bff\Shared\ClaimLite.cs" Link="Shared\ClaimLite.cs" />
-    <Compile Include="..\Duende.Bff\Shared\ClaimsLiteExtensions.cs" Link="Shared\ClaimsLiteExtensions.cs" />
-    <Compile Include="..\Duende.Bff\Shared\ClaimsPrincipalLite.cs" Link="Shared\ClaimsPrincipalLite.cs" />
+    <Compile Include="..\Duende.Bff\Shared\ClaimRecordExtensions.cs" Link="Shared\ClaimRecordExtensions.cs" />
+    <Compile Include="..\Duende.Bff\Shared\ClaimsPrincipalRecord.cs" Link="Shared\ClaimsPrincipalRecord.cs" />
   </ItemGroup>
 
   <ItemGroup>

bff/src/Duende.Bff.Blazor.Client/Internals/GetUserService.cs

@@ -58,9 +58,6 @@ public async ValueTask<ClaimsPrincipal> GetUserAsync(bool useCache = true)
         return _cachedUser;
     }
 
-    // TODO - Consider using ClaimLite instead here
-    record ClaimRecord(string Type, object Value);
-
     internal async Task<ClaimsPrincipal> FetchUser()
     {
         try

bff/src/Duende.Bff.Blazor.Client/Internals/PersistentUserService.cs

@@ -17,7 +17,7 @@ internal class PersistentUserService(PersistentComponentState state, ILogger<Per
     /// <inheritdoc />
     public ClaimsPrincipal GetPersistedUser()
     {
-        if (!state.TryTakeFromJson<ClaimsPrincipalLite>(nameof(ClaimsPrincipalLite), out var lite) || lite is null)
+        if (!state.TryTakeFromJson<ClaimsPrincipalRecord>(nameof(ClaimsPrincipalRecord), out var lite) || lite is null)
         {
             logger.LogDebug("Failed to load persisted user.");
             return new ClaimsPrincipal(new ClaimsIdentity());

bff/src/Duende.Bff.Blazor/BffServerAuthenticationStateProvider.cs

@@ -73,14 +73,14 @@ private async Task OnPersistingAsync()
         var authenticationState = await _authenticationStateTask;
 
         var claims = authenticationState.User.Claims
-            .Select(c => new ClaimLite
+            .Select(c => new ClaimRecord
             {
                 Type = c.Type,
                 Value = c.Value?.ToString() ?? string.Empty,
                 ValueType = c.ValueType == ClaimValueTypes.String ? null : c.ValueType
             }).ToArray();
 
-        var principal = new ClaimsPrincipalLite
+        var principal = new ClaimsPrincipalRecord
         {
             AuthenticationType = authenticationState.User.Identity!.AuthenticationType,
             NameClaimType = authenticationState.User.Identities.First().NameClaimType,
@@ -90,7 +90,7 @@ private async Task OnPersistingAsync()
 
         _logger.LogDebug("Persisting Authentication State");
 
-        _state.PersistAsJson(nameof(ClaimsPrincipalLite), principal);
+        _state.PersistAsJson(nameof(ClaimsPrincipalRecord), principal);
     }
 
 

bff/src/Duende.Bff.Blazor/Duende.Bff.Blazor.csproj

@@ -1,9 +1,11 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+
   </PropertyGroup>
 
   <ItemGroup>

bff/src/Duende.Bff.EntityFramework/Duende.Bff.EntityFramework.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFrameworks>net8.0;net9.0</TargetFrameworks>