Skip to content

[release/6.0] Revert bind single elements to array in configuration binder #59733

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.

Sign up for GitHub

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
Sep 29, 2021
Merged

[release/6.0] Revert bind single elements to array in configuration binder #59733

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50785d0
Revert "Apply feedback from PR #57204 (#57872)"
safern Sep 28, 2021
cb04266
Revert "Allow ConfigBinder to bind arrays to Singular elements (#57204)"
safern Sep 28, 2021
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
33 changes: 4 additions & 29 deletions src/libraries/Microsoft.Extensions.Configuration.Binder/src/ConfigurationBinder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,6 @@ public static class ConfigurationBinder
private const string TrimmingWarningMessage = "In case the type is non-primitive, the trimmer cannot statically analyze the object's type so its members may be trimmed.";
private const string InstanceGetTypeTrimmingWarningMessage = "Cannot statically analyze the type of instance so its members may be trimmed";
private const string PropertyTrimmingWarningMessage = "Cannot statically analyze property.PropertyType so its members may be trimmed.";
private const string BindSingleElementsToArraySwitch = "Microsoft.Extensions.Configuration.BindSingleElementsToArray";

// Enable this switch by default.
private static bool ShouldBindSingleElementsToArray { get; } = AppContext.TryGetSwitch(BindSingleElementsToArraySwitch, out bool verifyCanBindSingleElementsToArray) ? verifyCanBindSingleElementsToArray : true;

/// <summary>
/// Attempts to bind the configuration instance to a new instance of type T.
Expand Down Expand Up @@ -366,7 +362,7 @@ private static object BindInstance(
return convertedValue;
}

if (config != null && (config.GetChildren().Any() || (configValue != null && ShouldBindSingleElementsToArray)))
if (config != null && config.GetChildren().Any())
{
// If we don't have an instance, try to create one
if (instance == null)
Expand Down Expand Up @@ -499,7 +495,7 @@ private static void BindCollection(
Type itemType = collectionType.GenericTypeArguments[0];
MethodInfo addMethod = collectionType.GetMethod("Add", DeclaredOnlyLookup);

foreach (IConfigurationSection section in GetChildrenOrSelf(config))
foreach (IConfigurationSection section in config.GetChildren())
{
try
{
Expand All @@ -522,7 +518,7 @@ private static void BindCollection(
[RequiresUnreferencedCode("Cannot statically analyze what the element type is of the Array so its members may be trimmed.")]
private static Array BindArray(Array source, IConfiguration config, BinderOptions options)
{
IConfigurationSection[] children = GetChildrenOrSelf(config).ToArray();
IConfigurationSection[] children = config.GetChildren().ToArray();
int arrayLength = source.Length;
Type elementType = source.GetType().GetElementType();
var newArray = Array.CreateInstance(elementType, arrayLength + children.Length);
Expand Down Expand Up @@ -706,26 +702,5 @@ private static string GetPropertyName(MemberInfo property)

return property.Name;
}

private static IEnumerable<IConfigurationSection> GetChildrenOrSelf(IConfiguration config)
{
if (!ShouldBindSingleElementsToArray)
{
return config.GetChildren();
}

IEnumerable<IConfigurationSection> children;
// If configuration's children is an array, the configuration key will be a number
if (config.GetChildren().Any(a => long.TryParse(a.Key, out _)))
{
children = config.GetChildren();
}
else
{
children = new[] { config as IConfigurationSection };
}

return children;
}
}
}
}
54 changes: 0 additions & 54 deletions src/libraries/Microsoft.Extensions.Configuration.Binder/tests/ConfigurationBinderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
using System.Collections.Generic;
using System.ComponentModel;
using System.Reflection;
using Microsoft.DotNet.RemoteExecutor;
using Xunit;

namespace Microsoft.Extensions.Configuration.Binder.Test
Expand Down Expand Up @@ -937,59 +936,6 @@ public void ExceptionWhenTryingToBindToByteArray()
exception.Message);
}

[Fact]
public void CanBindSingleElementToCollection()
{
var dic = new Dictionary<string, string>
{
{"MyString", "hello world"},
{"Nested:Integer", "11"},
};

var configurationBuilder = new ConfigurationBuilder();
configurationBuilder.AddInMemoryCollection(dic);
IConfiguration config = configurationBuilder.Build();

var stringArr = config.GetSection("MyString").Get<string[]>();
Assert.Equal("hello world", stringArr[0]);
Assert.Equal(1, stringArr.Length);

var stringAsStr = config.GetSection("MyString").Get<string>();
Assert.Equal("hello world", stringAsStr);

var nested = config.GetSection("Nested").Get<NestedOptions>();
Assert.Equal(11, nested.Integer);

var nestedAsArray = config.GetSection("Nested").Get<NestedOptions[]>();
Assert.Equal(11, nestedAsArray[0].Integer);
Assert.Equal(1, nestedAsArray.Length);
}

[ConditionalFact(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))]
public void CannotBindSingleElementToCollectionWhenSwitchSet()
{
RemoteExecutor.Invoke(() =>
{
AppContext.SetSwitch("Microsoft.Extensions.Configuration.BindSingleElementsToArray", false);

var dic = new Dictionary<string, string>
{
{"MyString", "hello world"},
{"Nested:Integer", "11"},
};

var configurationBuilder = new ConfigurationBuilder();
configurationBuilder.AddInMemoryCollection(dic);
IConfiguration config = configurationBuilder.Build();

var stringArr = config.GetSection("MyString").Get<string[]>();
Assert.Null(stringArr);

var stringAsStr = config.GetSection("MyString").Get<string>();
Assert.Equal("hello world", stringAsStr);
}).Dispose();
}

private interface ISomeInterface
{
}
Expand Down
1 change: 0 additions & 1 deletion ...ensions.Configuration.Binder/tests/Microsoft.Extensions.Configuration.Binder.Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
<PropertyGroup>
<TargetFrameworks>$(NetCoreAppCurrent);net461</TargetFrameworks>
<EnableDefaultItems>true</EnableDefaultItems>
<IncludeRemoteExecutor>true</IncludeRemoteExecutor>
</PropertyGroup>

<ItemGroup>
Expand Down