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 reflection path for ActivatorUtilities.CreateFactory #81262

Merged
Merged
Show file tree
Hide file tree
Changes from 17 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 @@ -2,10 +2,12 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Linq.Expressions;
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.ExceptionServices;
using Microsoft.Extensions.Internal;

Expand Down Expand Up @@ -127,6 +129,13 @@ public static ObjectFactory CreateFactory(
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] Type instanceType,
Type[] argumentTypes)
{
#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP
if (!RuntimeFeature.IsDynamicCodeSupported)
{
return CreateFactoryReflection(instanceType, argumentTypes);
JamesNK marked this conversation as resolved.
Show resolved Hide resolved
}
#endif

CreateFactoryInternal(instanceType, argumentTypes, out ParameterExpression provider, out ParameterExpression argumentArray, out Expression factoryExpressionBody);

var factoryLambda = Expression.Lambda<Func<IServiceProvider, object?[]?, object>>(
Expand All @@ -152,6 +161,15 @@ public static ObjectFactory<T>
CreateFactory<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] T>(
Type[] argumentTypes)
{
#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP
if (!RuntimeFeature.IsDynamicCodeSupported)
{
var factory = CreateFactoryReflection(typeof(T), argumentTypes);

return (serviceProvider, arguments) => (T)factory(serviceProvider, arguments);
JamesNK marked this conversation as resolved.
Show resolved Hide resolved
}
#endif

CreateFactoryInternal(typeof(T), argumentTypes, out ParameterExpression provider, out ParameterExpression argumentArray, out Expression factoryExpressionBody);

var factoryLambda = Expression.Lambda<Func<IServiceProvider, object?[]?, T>>(
Expand Down Expand Up @@ -264,6 +282,65 @@ private static NewExpression BuildFactoryExpression(
return Expression.New(constructor, constructorArguments);
}

#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP
private static ObjectFactory CreateFactoryReflection(
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] Type instanceType,
Type?[] argumentTypes)
{
FindApplicableConstructor(instanceType, argumentTypes, out ConstructorInfo constructor, out int?[] parameterMap);

ParameterInfo[] constructorParameters = constructor.GetParameters();
JamesNK marked this conversation as resolved.
Show resolved Hide resolved
FactoryParameterContext[] parameters = new FactoryParameterContext[constructorParameters.Length];
for (int i = 0; i < constructorParameters.Length; i++)
{
ParameterInfo constructorParameter = constructorParameters[i];
bool hasDefaultValue = ParameterDefaultValue.TryGetDefaultValue(constructorParameter, out object? defaultValue);

parameters[i] = new FactoryParameterContext(constructorParameter.ParameterType, hasDefaultValue, defaultValue, parameterMap[i] ?? -1);
}
Type declaringType = constructor.DeclaringType!;

return (IServiceProvider serviceProvider, object?[]? arguments) =>
{
object?[]? constructorArguments = null;
if (parameters.Length != 0)
{
constructorArguments = new object?[parameters.Length];
for (int i = 0; i < parameters.Length; i++)
{
ref FactoryParameterContext parameter = ref parameters[i];
constructorArguments[i] = ((parameter.ArgumentIndex != -1)
// Throws an NullReferenceException if arguments is null. Consistent with expression-based factory.
? arguments![parameter.ArgumentIndex]
: GetService(
serviceProvider,
parameter.ParameterType,
declaringType,
parameter.HasDefaultValue)) ?? parameter.DefaultValue;
}
}
JamesNK marked this conversation as resolved.
Show resolved Hide resolved

return constructor.Invoke(BindingFlags.DoNotWrapExceptions, binder: null, constructorArguments, culture: null);
};
}

private readonly struct FactoryParameterContext
{
public FactoryParameterContext(Type parameterType, bool hasDefaultValue, object? defaultValue, int argumentIndex)
{
ParameterType = parameterType;
HasDefaultValue = hasDefaultValue;
DefaultValue = defaultValue;
ArgumentIndex = argumentIndex;
}

public Type ParameterType { get; }
public bool HasDefaultValue { get; }
public object? DefaultValue { get; }
jkotas marked this conversation as resolved.
Show resolved Hide resolved
public int ArgumentIndex { get; }
}
#endif

private static void FindApplicableConstructor(
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] Type instanceType,
Type?[] argumentTypes,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System;
using Microsoft.DotNet.RemoteExecutor;
using Xunit;
using static Microsoft.Extensions.DependencyInjection.Tests.AsyncServiceScopeTests;

Expand Down Expand Up @@ -191,6 +192,135 @@ public void CreateFactory_CreatesFactoryMethod()
Assert.IsType<ObjectFactory<ClassWithABCS>>(factory2);
Assert.IsType<ClassWithABCS>(item2);
}

[ConditionalTheory(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))]
JamesNK marked this conversation as resolved.
Show resolved Hide resolved
[InlineData(true)]
#if NETCOREAPP
[InlineData(false)]
#endif
public void CreateFactory_RemoteExecutor_CreatesFactoryMethod(bool isDynamicCodeSupported)
{
var options = new RemoteInvokeOptions();
if (!isDynamicCodeSupported)
{
options.RuntimeConfigurationOptions.Add("System.Runtime.CompilerServices.RuntimeFeature.IsDynamicCodeSupported", "false");
}

using var remoteHandle = RemoteExecutor.Invoke(static () =>
{
var factory1 = ActivatorUtilities.CreateFactory(typeof(ClassWithABCS), new Type[] { typeof(B) });
var factory2 = ActivatorUtilities.CreateFactory<ClassWithABCS>(new Type[] { typeof(B) });

var services = new ServiceCollection();
services.AddSingleton(new A());
services.AddSingleton(new C());
services.AddSingleton(new S());
using var provider = services.BuildServiceProvider();
object item1 = factory1(provider, new[] { new B() });
var item2 = factory2(provider, new[] { new B() });

Assert.IsType<ObjectFactory>(factory1);
Assert.IsType<ClassWithABCS>(item1);

Assert.IsType<ObjectFactory<ClassWithABCS>>(factory2);
Assert.IsType<ClassWithABCS>(item2);
}, options);
}

[ConditionalTheory(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))]
[InlineData(true)]
#if NETCOREAPP
[InlineData(false)]
#endif
public void CreateFactory_RemoteExecutor_NullArguments_Throws(bool isDynamicCodeSupported)
{
var options = new RemoteInvokeOptions();
if (!isDynamicCodeSupported)
{
options.RuntimeConfigurationOptions.Add("System.Runtime.CompilerServices.RuntimeFeature.IsDynamicCodeSupported", "false");
}

using var remoteHandle = RemoteExecutor.Invoke(static () =>
{
var factory1 = ActivatorUtilities.CreateFactory(typeof(ClassWithA), new Type[] { typeof(A) });

var services = new ServiceCollection();
using var provider = services.BuildServiceProvider();
Assert.Throws<NullReferenceException>(() => factory1(provider, null));
}, options);
}

[ConditionalTheory(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))]
[InlineData(true)]
#if NETCOREAPP
[InlineData(false)]
#endif
public void CreateFactory_RemoteExecutor_NoArguments_UseNullDefaultValue(bool isDynamicCodeSupported)
{
var options = new RemoteInvokeOptions();
if (!isDynamicCodeSupported)
{
options.RuntimeConfigurationOptions.Add("System.Runtime.CompilerServices.RuntimeFeature.IsDynamicCodeSupported", "false");
}

using var remoteHandle = RemoteExecutor.Invoke(static () =>
{
var factory1 = ActivatorUtilities.CreateFactory(typeof(ClassWithADefaultValue), new Type[0]);

var services = new ServiceCollection();
using var provider = services.BuildServiceProvider();
var item = (ClassWithADefaultValue)factory1(provider, null);
Assert.Null(item.A);
}, options);
}

[ConditionalTheory(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))]
[InlineData(true)]
#if NETCOREAPP
[InlineData(false)]
#endif
public void CreateFactory_RemoteExecutor_NoArguments_ThrowRequiredValue(bool isDynamicCodeSupported)
{
var options = new RemoteInvokeOptions();
if (!isDynamicCodeSupported)
{
options.RuntimeConfigurationOptions.Add("System.Runtime.CompilerServices.RuntimeFeature.IsDynamicCodeSupported", "false");
}

using var remoteHandle = RemoteExecutor.Invoke(static () =>
{
var factory1 = ActivatorUtilities.CreateFactory(typeof(ClassWithA), new Type[0]);

var services = new ServiceCollection();
using var provider = services.BuildServiceProvider();
var ex = Assert.Throws<InvalidOperationException>(() => factory1(provider, null));
Assert.Equal($"Unable to resolve service for type '{typeof(A).FullName}' while attempting to activate '{typeof(ClassWithA).FullName}'.", ex.Message);
}, options);
}

[ConditionalTheory(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))]
[InlineData(true)]
#if NETCOREAPP
[InlineData(false)]
#endif
public void CreateFactory_RemoteExecutor_NullArgument_UseDefaultValue(bool isDynamicCodeSupported)
{
var options = new RemoteInvokeOptions();
if (!isDynamicCodeSupported)
{
options.RuntimeConfigurationOptions.Add("System.Runtime.CompilerServices.RuntimeFeature.IsDynamicCodeSupported", "false");
}

using var remoteHandle = RemoteExecutor.Invoke(static () =>
{
var factory1 = ActivatorUtilities.CreateFactory(typeof(ClassWithStringDefaultValue), new[] { typeof(string) });

var services = new ServiceCollection();
using var provider = services.BuildServiceProvider();
var item = (ClassWithStringDefaultValue)factory1(provider, new object[] { null });
Assert.Equal("DEFAULT", item.Text);
}, options);
}
}

internal class A { }
Expand Down Expand Up @@ -265,6 +395,15 @@ public ClassWithA(A a)
}
}

internal class ClassWithADefaultValue
{
public A A { get; }
public ClassWithADefaultValue(A a = null)
{
A = a;
}
}

internal class ABCS
{
public A A { get; }
Expand Down Expand Up @@ -354,4 +493,13 @@ public ClassWithABC_DefaultConstructorLast(A a, B b) : base (a, b) { }
public ClassWithABC_DefaultConstructorLast(A a) : base(a) { }
public ClassWithABC_DefaultConstructorLast() : base() { }
}

internal class ClassWithStringDefaultValue
{
public string Text { get; set; }
public ClassWithStringDefaultValue(string text = "DEFAULT")
{
Text = text;
}
}
}