Skip to content

Ensure Singleton registration for TokenAcquisition Services when TokenAcquirerFactory is null #3155

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

Merged
merged 2 commits into from
Dec 3, 2024
Merged
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 @@ -68,7 +68,7 @@ public static IServiceCollection AddTokenAcquisition(
ServiceDescriptor? tokenAcquisitionhost = services.FirstOrDefault(s => s.ServiceType == typeof(ITokenAcquisitionHost));
ServiceDescriptor? authenticationHeaderCreator = services.FirstOrDefault(s => s.ServiceType == typeof(IAuthorizationHeaderProvider));
ServiceDescriptor? tokenAcquirerFactory = services.FirstOrDefault(s => s.ServiceType == typeof(ITokenAcquirerFactory));
if (tokenAcquisitionService != null && tokenAcquisitionInternalService != null && tokenAcquisitionhost != null && authenticationHeaderCreator != null && tokenAcquirerFactory != null)
if (tokenAcquisitionService != null && tokenAcquisitionInternalService != null && tokenAcquisitionhost != null && authenticationHeaderCreator != null)
{
if (isTokenAcquisitionSingleton ^ (tokenAcquisitionService.Lifetime == ServiceLifetime.Singleton))
{
Expand All @@ -77,8 +77,13 @@ public static IServiceCollection AddTokenAcquisition(
services.Remove(tokenAcquisitionInternalService);
services.Remove(tokenAcquisitionhost);
services.Remove(authenticationHeaderCreator);
services.Remove(tokenAcquirerFactory);
tokenAcquirerFactory = null;

// To support ASP.NET Core 2.x on .NET FW. It won't use the TokenAcquirerFactory.GetDefaultInstance()
if (tokenAcquirerFactory != null)
{
services.Remove(tokenAcquirerFactory);
tokenAcquirerFactory = null;
}
}
else
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;
using Microsoft.Identity.Abstractions;
Expand Down Expand Up @@ -140,6 +139,111 @@ public void AddHttpContextAccessor_ThrowsWithoutServices()
{
Assert.Throws<ArgumentNullException>("services", () => ServiceCollectionExtensions.AddTokenAcquisition(null!));
}

[Fact]
public void AddTokenAcquisitionCalledTwice_RegistersTokenAcquisitionOnlyAsSingleton_WhenFlagIsTrue()
{
// Arrange
var services = new ServiceCollection();

// Act
// Token acquisition services were originally registered as scoped
services.AddTokenAcquisition();

// Token acquisition services should now be registered as singleton
services.AddTokenAcquisition(isTokenAcquisitionSingleton: true);

// Assert
var orderedServices = services.OrderBy(s => s.ServiceType.FullName).ToList();

// Check that the first service is registered as singleton
Assert.Collection(
orderedServices,
actual =>
{
Assert.Equal(ServiceLifetime.Singleton, actual.Lifetime);
Assert.Equal(typeof(IPostConfigureOptions<MicrosoftIdentityApplicationOptions>), actual.ServiceType);
Assert.Equal(typeof(MicrosoftIdentityApplicationOptionsMerger), actual.ImplementationType);
Assert.Null(actual.ImplementationInstance);
Assert.Null(actual.ImplementationFactory);
}, actual =>
{
Assert.Equal(ServiceLifetime.Singleton, actual.Lifetime);
Assert.Equal(typeof(IPostConfigureOptions<ConfidentialClientApplicationOptions>), actual.ServiceType);
Assert.Equal(typeof(ConfidentialClientApplicationOptionsMerger), actual.ImplementationType);
Assert.Null(actual.ImplementationInstance);
Assert.Null(actual.ImplementationFactory);
},
actual =>
{
Assert.Equal(ServiceLifetime.Singleton, actual.Lifetime);
Assert.Equal(typeof(IPostConfigureOptions<MicrosoftIdentityOptions>), actual.ServiceType);
Assert.Equal(typeof(MicrosoftIdentityOptionsMerger), actual.ImplementationType);
Assert.Null(actual.ImplementationInstance);
Assert.Null(actual.ImplementationFactory);
},
actual =>
{
Assert.Equal(ServiceLifetime.Singleton, actual.Lifetime);
Assert.Equal(typeof(IAuthorizationHeaderProvider), actual.ServiceType);
Assert.Equal(typeof(DefaultAuthorizationHeaderProvider), actual.ImplementationType);
Assert.Null(actual.ImplementationInstance);
Assert.Null(actual.ImplementationFactory);
},
actual =>
{
Assert.Equal(typeof(ICredentialsLoader), actual.ServiceType);
Assert.Equal(typeof(DefaultCertificateLoader), actual.ImplementationType);
Assert.Null(actual.ImplementationInstance);
Assert.Null(actual.ImplementationFactory);
},
actual =>
{
Assert.Equal(ServiceLifetime.Singleton, actual.Lifetime);
Assert.Equal(typeof(ITokenAcquirerFactory), actual.ServiceType);
Assert.Equal(typeof(DefaultTokenAcquirerFactoryImplementation), actual.ImplementationType);
Assert.Null(actual.ImplementationInstance);
Assert.Null(actual.ImplementationFactory);
},
actual =>
{
Assert.Equal(ServiceLifetime.Singleton, actual.Lifetime);
Assert.Equal(typeof(IMergedOptionsStore), actual.ServiceType);
Assert.Equal(typeof(MergedOptionsStore), actual.ImplementationType);
Assert.Null(actual.ImplementationInstance);
Assert.Null(actual.ImplementationFactory);
},
actual =>
{
Assert.Equal(ServiceLifetime.Singleton, actual.Lifetime);
Assert.Equal(typeof(IMergedOptionsStore), actual.ServiceType);
Assert.Equal(typeof(MergedOptionsStore), actual.ImplementationType);
Assert.Null(actual.ImplementationInstance);
Assert.Null(actual.ImplementationFactory);
},
actual =>
{
Assert.Equal(ServiceLifetime.Singleton, actual.Lifetime);
Assert.Equal(typeof(ITokenAcquisition), actual.ServiceType);
Assert.Equal(typeof(TokenAcquisitionAspNetCore), actual.ImplementationType);
Assert.Null(actual.ImplementationInstance);
Assert.Null(actual.ImplementationFactory);
},
actual =>
{
Assert.Equal(ServiceLifetime.Singleton, actual.Lifetime);
Assert.Equal(typeof(ITokenAcquisitionHost), actual.ServiceType);
Assert.Null(actual.ImplementationInstance);
Assert.Null(actual.ImplementationFactory);
},
actual =>
{
Assert.Equal(ServiceLifetime.Singleton, actual.Lifetime);
Assert.Equal(typeof(ITokenAcquisitionInternal), actual.ServiceType);
Assert.Null(actual.ImplementationInstance);
Assert.NotNull(actual.ImplementationFactory);
});
}
}

internal class MockCredentialsLoader : ICredentialsLoader
Expand Down
Loading