Skip to content
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

Add support for IServiceProviderIsService #54047

Merged
merged 6 commits into from
Jun 11, 2021
Merged
Show file tree
Hide file tree
Changes from 2 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 @@ -36,6 +36,10 @@ public partial interface IServiceProviderFactory<TContainerBuilder> where TConta
TContainerBuilder CreateBuilder(Microsoft.Extensions.DependencyInjection.IServiceCollection services);
System.IServiceProvider CreateServiceProvider(TContainerBuilder containerBuilder);
}
public partial interface IServiceProviderIsService
{
bool IsService(System.Type serviceType);
}
public partial interface IServiceScope : System.IDisposable
{
System.IServiceProvider ServiceProvider { get; }
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System;

namespace Microsoft.Extensions.DependencyInjection
{
/// <summary>
/// Optional service used to determine if the specified type is resolvable by the <see cref="IServiceProvider"/>.
davidfowl marked this conversation as resolved.
Show resolved Hide resolved
/// </summary>
public interface IServiceProviderIsService
{
/// <summary>
/// Determines if the specified service type is resolvable by the <see cref="IServiceProvider"/>.
/// </summary>
/// <param name="serviceType">An object that specifies the type of service object to test.</param>
/// <returns>true if the specified service is a resolvable, false if it is not.</returns>
davidfowl marked this conversation as resolved.
Show resolved Hide resolved
bool IsService(Type serviceType);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Extensions.DependencyInjection.Specification.Fakes;
using Xunit;

namespace Microsoft.Extensions.DependencyInjection.Specification
{
public abstract class ServiceProviderIsServiceSpecificationTests
davidfowl marked this conversation as resolved.
Show resolved Hide resolved
davidfowl marked this conversation as resolved.
Show resolved Hide resolved
{
protected abstract IServiceProvider CreateServiceProvider(IServiceCollection serviceCollection);

[Fact]
public void ExplictServiceRegisterationWithIsService()
{
// Arrange
var collection = new TestServiceCollection();
collection.AddTransient(typeof(IFakeService), typeof(FakeService));
var provider = CreateServiceProvider(collection);

// Act
var serviceProviderIsService = provider.GetService<IServiceProviderIsService>();

// Assert
Assert.NotNull(serviceProviderIsService);
Assert.True(serviceProviderIsService.IsService(typeof(IFakeService)));
Assert.False(serviceProviderIsService.IsService(typeof(FakeService)));
}

[Fact]
public void OpenGenericsWithIsService()
{
// Arrange
var collection = new TestServiceCollection();
collection.AddTransient(typeof(IFakeOpenGenericService<>), typeof(FakeOpenGenericService<>));
var provider = CreateServiceProvider(collection);

// Act
var serviceProviderIsService = provider.GetService<IServiceProviderIsService>();

// Assert
Assert.NotNull(serviceProviderIsService);
Assert.True(serviceProviderIsService.IsService(typeof(IFakeOpenGenericService<IFakeService>)));
Assert.False(serviceProviderIsService.IsService(typeof(IFakeOpenGenericService<>)));
}

[Fact]
public void ClosedGenericsWithIsService()
{
// Arrange
var collection = new TestServiceCollection();
collection.AddTransient(typeof(IFakeOpenGenericService<IFakeService>), typeof(FakeOpenGenericService<IFakeService>));
var provider = CreateServiceProvider(collection);

// Act
var serviceProviderIsService = provider.GetService<IServiceProviderIsService>();

// Assert
Assert.NotNull(serviceProviderIsService);
Assert.True(serviceProviderIsService.IsService(typeof(IFakeOpenGenericService<IFakeService>)));
}

[Fact]
public void IEnumerableWithIsServiceAlwaysReturnsTrue()
{
// Arrange
var collection = new TestServiceCollection();
collection.AddTransient(typeof(IFakeService), typeof(FakeService));
var provider = CreateServiceProvider(collection);

// Act
var serviceProviderIsService = provider.GetService<IServiceProviderIsService>();

// Assert
Assert.NotNull(serviceProviderIsService);
Assert.True(serviceProviderIsService.IsService(typeof(IEnumerable<IFakeService>)));
Assert.True(serviceProviderIsService.IsService(typeof(IEnumerable<FakeService>)));
davidfowl marked this conversation as resolved.
Show resolved Hide resolved
Assert.False(serviceProviderIsService.IsService(typeof(IEnumerable<>)));
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

namespace Microsoft.Extensions.DependencyInjection.ServiceLookup
{
internal sealed class CallSiteFactory
internal sealed class CallSiteFactory : IServiceProviderIsService
{
private const int DefaultSlot = 0;
private readonly ServiceDescriptor[] _descriptors;
Expand Down Expand Up @@ -441,6 +441,32 @@ public void Add(Type type, ServiceCallSite serviceCallSite)
_callSiteCache[new ServiceCacheKey(type, DefaultSlot)] = serviceCallSite;
}

public bool IsService(Type serviceType)
{
if (serviceType is null)
{
throw new ArgumentNullException(nameof(serviceType));
}

// Querying for an open generic should return false (they aren't resolvable)
if (serviceType.IsGenericTypeDefinition)
{
return false;
}

if (_descriptorLookup.ContainsKey(serviceType))
{
return true;
}

if (serviceType.IsConstructedGenericType && serviceType.GetGenericTypeDefinition() is Type genericDefinition)
{
return genericDefinition == typeof(IEnumerable<>) || _descriptorLookup.ContainsKey(genericDefinition);
davidfowl marked this conversation as resolved.
Show resolved Hide resolved
}

return false;
}

private struct ServiceDescriptorCacheItem
{
private ServiceDescriptor _item;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ internal ServiceProvider(IEnumerable<ServiceDescriptor> serviceDescriptors, Serv
CallSiteFactory = new CallSiteFactory(serviceDescriptors);
CallSiteFactory.Add(typeof(IServiceProvider), new ServiceProviderCallSite());
CallSiteFactory.Add(typeof(IServiceScopeFactory), new ServiceScopeFactoryCallSite(Root));
CallSiteFactory.Add(typeof(IServiceProviderIsService), new ConstantCallSite(typeof(IServiceProviderIsService), CallSiteFactory));

if (options.ValidateScopes)
{
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System;
using Microsoft.Extensions.DependencyInjection.Specification;

namespace Microsoft.Extensions.DependencyInjection.Tests
{
public class ServiceProviderIsServiceTests : ServiceProviderIsServiceSpecificationTests
{
protected override IServiceProvider CreateServiceProvider(IServiceCollection serviceCollection) => serviceCollection.BuildServiceProvider();
}
}