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.

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

Jump to bottom

Reduce allocations in Microsoft.Extensions.Configuration #88211

Merged
merged 3 commits into from
Jun 30, 2023
Merged

Reduce allocations in Microsoft.Extensions.Configuration #88211

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
838a0b7
Reduce allocations in Microsoft.Extensions.Configuration
pentp Jun 29, 2023
deffb42
Update src/libraries/Microsoft.Extensions.Configuration.Abstractions/…
pentp Jun 30, 2023
36eaddf
Update src/libraries/Microsoft.Extensions.Configuration.Abstractions/…
pentp Jun 30, 2023
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
4 changes: 2 additions & 2 deletions src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationPath.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public static string Combine(IEnumerable<string> pathSegments)
return path;
}

int lastDelimiterIndex = path.LastIndexOf(KeyDelimiter, StringComparison.OrdinalIgnoreCase);
int lastDelimiterIndex = path.LastIndexOf(':');
return lastDelimiterIndex == -1 ? path : path.Substring(lastDelimiterIndex + 1);
pentp marked this conversation as resolved.
Show resolved Hide resolved
}

Expand All @@ -70,7 +70,7 @@ public static string Combine(IEnumerable<string> pathSegments)
return null;
}

int lastDelimiterIndex = path.LastIndexOf(KeyDelimiter, StringComparison.OrdinalIgnoreCase);
int lastDelimiterIndex = path.LastIndexOf(':');
return lastDelimiterIndex == -1 ? null : path.Substring(0, lastDelimiterIndex);
pentp marked this conversation as resolved.
Show resolved Hide resolved
}
}
Expand Down
23 changes: 13 additions & 10 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 @@ -35,7 +35,7 @@ public static class ConfigurationBinder
[RequiresDynamicCode(DynamicCodeWarningMessage)]
[RequiresUnreferencedCode(TrimmingWarningMessage)]
public static T? Get<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] T>(this IConfiguration configuration)
=> configuration.Get<T>(_ => { });
=> configuration.Get<T>(null);

/// <summary>
/// Attempts to bind the configuration instance to a new instance of type T.
Expand Down Expand Up @@ -71,7 +71,7 @@ public static class ConfigurationBinder
[RequiresDynamicCode(DynamicCodeWarningMessage)]
[RequiresUnreferencedCode(TrimmingWarningMessage)]
public static object? Get(this IConfiguration configuration, Type type)
=> configuration.Get(type, _ => { });
=> configuration.Get(type, null);

/// <summary>
/// Attempts to bind the configuration instance to a new instance of type T.
Expand Down Expand Up @@ -118,7 +118,7 @@ public static void Bind(this IConfiguration configuration, string key, object? i
[RequiresDynamicCode(DynamicCodeWarningMessage)]
[RequiresUnreferencedCode(InstanceGetTypeTrimmingWarningMessage)]
public static void Bind(this IConfiguration configuration, object? instance)
=> configuration.Bind(instance, _ => { });
=> configuration.Bind(instance, null);

/// <summary>
/// Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
Expand Down Expand Up @@ -220,13 +220,16 @@ private static void BindProperties(object instance, IConfiguration configuration
HashSet<string> propertyNames = new(modelProperties.Select(mp => mp.Name),
StringComparer.OrdinalIgnoreCase);

IEnumerable<IConfigurationSection> configurationSections = configuration.GetChildren();
List<string> missingPropertyNames = configurationSections
.Where(cs => !propertyNames.Contains(cs.Key))
.Select(mp => $"'{mp.Key}'")
.ToList();
List<string>? missingPropertyNames = null;
foreach (IConfigurationSection cs in configuration.GetChildren())
{
if (!propertyNames.Contains(cs.Key))
{
(missingPropertyNames ??= new()).Add($"'{cs.Key}'");
}
}

if (missingPropertyNames.Count > 0)
if (missingPropertyNames != null)
{
throw new InvalidOperationException(SR.Format(SR.Error_MissingConfig,
nameof(options.ErrorOnUnknownConfiguration), nameof(BinderOptions), instance.GetType(),
Expand Down Expand Up @@ -381,7 +384,7 @@ private static void BindInstance(
(interfaceGenericType == typeof(ICollection<>) || interfaceGenericType == typeof(IList<>)))
{
// For ICollection<T> and IList<T> we bind them to mutable List<T> type.
Type genericType = typeof(List<>).MakeGenericType(type.GenericTypeArguments[0]);
Type genericType = typeof(List<>).MakeGenericType(type.GenericTypeArguments);
tarekgh marked this conversation as resolved.
Show resolved Hide resolved
bindingPoint.SetValue(Activator.CreateInstance(genericType));
}
else
Expand Down
8 changes: 5 additions & 3 deletions src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@ namespace Microsoft.Extensions.Configuration
/// </summary>
public class ConfigurationBuilder : IConfigurationBuilder
{
private readonly List<IConfigurationSource> _sources = new();

/// <summary>
/// Returns the sources used to obtain configuration values.
/// </summary>
public IList<IConfigurationSource> Sources { get; } = new List<IConfigurationSource>();
public IList<IConfigurationSource> Sources => _sources;

/// <summary>
/// Gets a key/value collection that can be used to share data between the <see cref="IConfigurationBuilder"/>
Expand All @@ -31,7 +33,7 @@ public IConfigurationBuilder Add(IConfigurationSource source)
{
ThrowHelper.ThrowIfNull(source);

Sources.Add(source);
_sources.Add(source);
return this;
}

Expand All @@ -43,7 +45,7 @@ public IConfigurationBuilder Add(IConfigurationSource source)
public IConfigurationRoot Build()
{
var providers = new List<IConfigurationProvider>();
foreach (IConfigurationSource source in Sources)
foreach (IConfigurationSource source in _sources)
{
IConfigurationProvider provider = source.Build(this);
providers.Add(provider);
Expand Down
12 changes: 4 additions & 8 deletions src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,10 +229,7 @@ public void CopyTo(IConfigurationSource[] array, int arrayIndex)
_sources.CopyTo(array, arrayIndex);
}

public IEnumerator<IConfigurationSource> GetEnumerator()
{
return _sources.GetEnumerator();
}
public List<IConfigurationSource>.Enumerator GetEnumerator() => _sources.GetEnumerator();

public int IndexOf(IConfigurationSource source)
{
Expand All @@ -258,10 +255,9 @@ public void RemoveAt(int index)
_config.ReloadSources();
}

IEnumerator IEnumerable.GetEnumerator()
{
return GetEnumerator();
}
IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();

IEnumerator<IConfigurationSource> IEnumerable<IConfigurationSource>.GetEnumerator() => GetEnumerator();
}

private sealed class ConfigurationBuilderProperties : IDictionary<string, object>
Expand Down
3 changes: 2 additions & 1 deletion src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,8 @@ public virtual IEnumerable<string> GetChildKeys(

private static string Segment(string key, int prefixLength)
{
int indexOf = key.IndexOf(ConfigurationPath.KeyDelimiter, prefixLength, StringComparison.OrdinalIgnoreCase);
Debug.Assert(ConfigurationPath.KeyDelimiter == ":");
int indexOf = key.IndexOf(':', prefixLength);
return indexOf < 0 ? key.Substring(prefixLength) : key.Substring(prefixLength, indexOf - prefixLength);
}

Expand Down
6 changes: 3 additions & 3 deletions src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationSection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,11 @@ public string? this[string key]
{
get
{
return _root[ConfigurationPath.Combine(Path, key)];
return _root[Path + ConfigurationPath.KeyDelimiter + key];
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here are three places where the lookup-key is created. Although it's trivial code, should this be moved to a helper method in order to have only one place where that lookup-key is built?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally, should add an overload to ConfigurationPath.Combine that takes two path strings (the most common case), but adding it as an internal API wouldn't work because it's in a different assembly and adding a public API needs the full API review process. I'm willing to create an API review request for this, if it sounds useful enough?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think a public API is needed here. I thought just a helper in ConfigurationSection (as the PR's diff shows three places where that could be used).

}
set
{
_root[ConfigurationPath.Combine(Path, key)] = value;
_root[Path + ConfigurationPath.KeyDelimiter + key] = value;
}
}

Expand All @@ -86,7 +86,7 @@ public string? this[string key]
/// This method will never return <c>null</c>. If no matching sub-section is found with the specified key,
/// an empty <see cref="IConfigurationSection"/> will be returned.
/// </remarks>
public IConfigurationSection GetSection(string key) => _root.GetSection(ConfigurationPath.Combine(Path, key));
public IConfigurationSection GetSection(string key) => _root.GetSection(Path + ConfigurationPath.KeyDelimiter + key);

/// <summary>
/// Gets the immediate descendant configuration sub-sections.
Expand Down
2 changes: 1 addition & 1 deletion src/libraries/Microsoft.Extensions.Configuration/src/InternalConfigurationRootExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ internal static IEnumerable<IConfigurationSection> GetChildrenImplementation(thi
.Aggregate(Enumerable.Empty<string>(),
(seed, source) => source.GetChildKeys(seed, path))
.Distinct(StringComparer.OrdinalIgnoreCase)
.Select(key => root.GetSection(path == null ? key : ConfigurationPath.Combine(path, key)));
.Select(key => root.GetSection(path == null ? key : path + ConfigurationPath.KeyDelimiter + key));

if (reference is null)
{
Expand Down
Loading