Skip to content

Fix config src-gen issues with binding nullable values #89397

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 1 commit into from
Jul 24, 2023
Merged

Fix config src-gen issues with binding nullable values #89397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 5 additions & 4 deletions ...raries/Microsoft.Extensions.Configuration.Binder/gen/Helpers/Emitter/CoreBindingHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,11 +98,12 @@ private void EmitGetCoreMethod()

foreach (TypeSpec type in types)
{
TypeSpecKind kind = type.SpecKind;
TypeSpec effectiveType = type.EffectiveType;
TypeSpecKind kind = effectiveType.SpecKind;

EmitStartBlock($"if (type == typeof({type.MinimalDisplayString}))");

if (type is ParsableFromStringSpec stringParsableType)
if (effectiveType is ParsableFromStringSpec stringParsableType)
{
EmitCastToIConfigurationSection();
EmitBindLogicFromString(
Expand All @@ -113,9 +114,9 @@ private void EmitGetCoreMethod()
checkForNullSectionValue: stringParsableType.StringParsableTypeKind is not StringParsableTypeKind.AssignFromSectionValue,
useIncrementalStringValueIdentifier: false);
}
else if (!EmitInitException(type))
else if (!EmitInitException(effectiveType))
{
EmitBindCoreCall(type, Identifier.obj, Identifier.configuration, InitializationKind.Declaration);
EmitBindCoreCall(effectiveType, Identifier.obj, Identifier.configuration, InitializationKind.Declaration);
_writer.WriteLine($"return {Identifier.obj};");
}

Expand Down
85 changes: 73 additions & 12 deletions ...raries/Microsoft.Extensions.Configuration.Binder/tests/Common/ConfigurationBinderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ public void EmptyStringIsNullable()
}

[Fact]
public void GetScalar()
public void Get_Scalar()
{
var dic = new Dictionary<string, string>
{
Expand All @@ -239,7 +239,7 @@ public void GetScalar()
}

[Fact]
public void GetScalarNullable()
public void Get_ScalarNullable()
{
var dic = new Dictionary<string, string>
{
Expand All @@ -260,6 +260,50 @@ public void GetScalarNullable()
Assert.Equal(11, (int)config.GetValue(typeof(int?), "Nested:Integer"));
}

[Fact]
public void GetValue_Scalar()
{
var dic = new Dictionary<string, string>
{
{"Integer", "-2"},
{"Boolean", "TRUe"},
{"Nested:Integer", "11"}
};
var configurationBuilder = new ConfigurationBuilder();
configurationBuilder.AddInMemoryCollection(dic);
var config = configurationBuilder.Build();

Assert.True(config.GetSection("Boolean").Get<bool>());
Assert.Equal(-2, config.GetSection("Integer").Get<int>());
Assert.Equal(11, config.GetSection("Nested:Integer").Get<int>());

Assert.True((bool)config.GetSection("Boolean").Get(typeof(bool)));
Assert.Equal(-2, (int)config.GetSection("Integer").Get(typeof(int)));
Assert.Equal(11, (int)config.GetSection("Nested:Integer").Get(typeof(int)));
}

[Fact]
public void GetValue_ScalarNullable()
{
var dic = new Dictionary<string, string>
{
{"Integer", "-2"},
{"Boolean", "TRUe"},
{"Nested:Integer", "11"}
};
var configurationBuilder = new ConfigurationBuilder();
configurationBuilder.AddInMemoryCollection(dic);
var config = configurationBuilder.Build();

Assert.True(config.GetSection("Boolean").Get<bool?>());
Assert.Equal(-2, config.GetSection("Integer").Get<int?>());
Assert.Equal(11, config.GetSection("Nested:Integer").Get<int?>());

Assert.True(config.GetSection("Boolean").Get(typeof(bool?)) is true);
Assert.Equal(-2, (int)config.GetSection("Integer").Get(typeof(int?)));
Assert.Equal(11, (int)config.GetSection("Nested:Integer").Get(typeof(int?)));
}

[Fact]
public void CanBindToObjectProperty()
{
Expand Down Expand Up @@ -1358,18 +1402,35 @@ public void CanBindClassWithPrimaryCtor()
[Fact]
public void CanBindRecordStructOptions()
{
var dic = new Dictionary<string, string>
IConfiguration config = GetConfiguration("Length", "Color");
Validate(config.Get<RecordStructTypeOptions>());
Validate(config.Get<RecordStructTypeOptions?>().Value);

config = GetConfiguration("Options.Length", "Options.Color");
// GetValue works for only primitives.
//Reflection impl handles them by honoring `TypeConverter` only.
// Source-gen supports based on an allow-list.
Assert.Equal(default(RecordStructTypeOptions), config.GetValue<RecordStructTypeOptions>("Options"));
Assert.False(config.GetValue<RecordStructTypeOptions?>("Options").HasValue);

static void Validate(RecordStructTypeOptions options)
{
{"Length", "42"},
{"Color", "Green"},
};
var configurationBuilder = new ConfigurationBuilder();
configurationBuilder.AddInMemoryCollection(dic);
var config = configurationBuilder.Build();
Assert.Equal(42, options.Length);
Assert.Equal("Green", options.Color);
}

var options = config.Get<RecordStructTypeOptions>();
Assert.Equal(42, options.Length);
Assert.Equal("Green", options.Color);
static IConfiguration GetConfiguration(string key1, string key2)
{
var dic = new Dictionary<string, string>
{
{ key1, "42" },
{ key2, "Green" },
};

var configurationBuilder = new ConfigurationBuilder();
configurationBuilder.AddInMemoryCollection(dic);
return configurationBuilder.Build();
}
}

[Fact]
Expand Down