Support all applicable ConfigurationBinder method overloads in binding generator

[layomia]

Full list: https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.configurationbinder?view=dotnet-plat-ext-8.0

An open question is whether to support overloads that take BinderOptions:

BindNonPublicProperties	When false (the default), the binder will only attempt to set public properties. If true, the binder will attempt to set all non read-only properties.BindNonPublicProperties	When false (the default), the binder will only attempt to set public properties. If true, the binder will attempt to set all non read-only properties.
ErrorOnUnknownConfiguration	Gets or sets a value that indicates whether an exception is thrown when a configuration key doesn't have a matching property in the model object.ErrorOnUnknownConfiguration	Gets or sets a value that indicates whether an exception is thrown when a configuration key doesn't have a matching property in the model object.

The issue is that source generators cannot support private properties; and it might not make sense to have partial support for the binder options.

cc @tarekgh @ericstj @eerhardt

Tagging subscribers to this area: @dotnet/area-extensions-configuration
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Full list: https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.configurationbinder?view=dotnet-plat-ext-8.0

An open question is whether to support over loads that take BinderOptions:

BindNonPublicProperties	When false (the default), the binder will only attempt to set public properties. If true, the binder will attempt to set all non read-only properties.BindNonPublicProperties	When false (the default), the binder will only attempt to set public properties. If true, the binder will attempt to set all non read-only properties.
ErrorOnUnknownConfiguration	Gets or sets a value that indicates whether an exception is thrown when a configuration key doesn't have a matching property in the model object.ErrorOnUnknownConfiguration	Gets or sets a value that indicates whether an exception is thrown when a configuration key doesn't have a matching property in the model object.

The issue is that source generators cannot support private properties; and it might not make sense to have partial support for the binder options.

cc @tarekgh @ericstj @eerhardt

Author:	layomia
Assignees:	layomia
Labels:	area-Extensions-Configuration, source-generator
Milestone:	8.0.0

[layomia]

An open question is whether to support overloads that take BinderOptions

The current direction is to support BinderOptions. We'll throw NotSupportedException when BindNonPublicProperties is specified, but support ErrorOnUnknownConfiguration

[DamianEdwards]

We also need to support:

• OptionsBuilderConfigurationExtensions.OptionsBuilder<TOptions>.BindConfiguration<TOptions>(this OptionsBuilder<TOptions> optionsBuilder, string configSectionPath, Action<BinderOptions>? configureBinder)
• OptionsBuilderConfigurationExtensions.OptionsBuilder<TOptions>.Bind<TOptions>(this OptionsBuilder<TOptions> optionsBuilder, IConfiguration config)
• OptionsBuilderConfigurationExtensions.OptionsBuilder<TOptions>.Bind<TOptions>(this OptionsBuilder<TOptions> optionsBuilder, IConfiguration config, Action<BinderOptions>? configureBinder)

[layomia]

The following issues related to supported/generated overloads will be present in .NET 8 preview 4 and addressed in p5:

• Compilation error in generated OptionsConfigurationServiceCollectionExtensions.Configure implementations
• We don't yet support the full matrix of Bind​, Get​, and GetValue method overloads on ConfigurationBinder​
• We don't yet support Bind​ and BindConfiguration​ overloads on OptionsBuilderConfigurationExtensions.OptionsBuilder

[ericstj]

The following entry points also call into the binder:

1. ConsoleLoggerExtensions.AddConsoleFormatter Method (Microsoft.Extensions.Logging) | Microsoft Learn
   Constrast this to other built in loggers, AddConsole doesn't actually use binding, instead it uses ConsoleFormatterConfigureOptions to invoke the internal virtual void Configure(IConfiguration configuration) which is implemented by those loggers to do their own binding. We didn't expose this method though, so customer formatters can only go through the binder. Here's a sample app that registers a custom formatter: https://gist.github.com/ericstj/19a60f344cb2ea170d5d885004c16ccc
   We could give this the treatment (lift code into source gen, removing type parameter) or we could try to expose that Configure member and tell people to implement it rather than rely on the binder.
2. LoggerProviderOptions.RegisterProviderOptions<TOptions,TProvider> Method (Microsoft.Extensions.Logging.Configuration) | Microsoft Learn
3. Here's a couple places we can remove annotations by ensuring we use the generator:
   

   runtime/src/libraries/Microsoft.Extensions.Hosting/src/HostingHostBuilderExtensions.cs

   Lines 260 to 261 in b05b4e4

   	[UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026:RequiresUnreferencedCode", Justification = "Calling IConfiguration.GetValue is safe when the T is bool.")]
   	static bool GetReloadConfigOnChangeValue(HostBuilderContext hostingContext) => hostingContext.Configuration.GetValue("hostBuilder:reloadConfigOnChange", defaultValue: true);

   
   

   runtime/src/libraries/Microsoft.Extensions.Logging.Configuration/src/LoggerFilterConfigureOptions.cs

   Lines 55 to 57 in b05b4e4

   	[UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026:RequiresUnreferencedCode",
   	Justification = "IConfiguration.GetValue is safe when T is a bool.")]
   	bool GetCaptureScopesValue(LoggerFilterOptions options) => _configuration.GetValue(nameof(options.CaptureScopes), options.CaptureScopes);