Annotate generated GetValue() with [NotNullIfNotNull]

dotnet · Apr 28, 2024 · 746a4ec · 746a4ec
1 parent 4007c29
commit 746a4ec
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 0 deletions.
diff --git a/...es/Microsoft.Extensions.Configuration.Binder/gen/ConfigurationBindingGenerator.Emitter.cs b/...es/Microsoft.Extensions.Configuration.Binder/gen/ConfigurationBindingGenerator.Emitter.cs
@@ -15,6 +15,7 @@ private sealed partial class Emitter
             private readonly TypeIndex _typeIndex;
             private readonly bool _emitEnumParseMethod;
             private readonly bool _emitGenericParseEnum;
+            private readonly bool _emitNotNullIfNotNull;
             private readonly bool _emitThrowIfNullMethod;
 
             private readonly SourceWriter _writer = new();
@@ -26,6 +27,7 @@ public Emitter(SourceGenerationSpec sourceGenSpec)
                 _typeIndex = new TypeIndex(sourceGenSpec.ConfigTypes);
                 _emitEnumParseMethod = sourceGenSpec.EmitEnumParseMethod;
                 _emitGenericParseEnum = sourceGenSpec.EmitGenericParseEnum;
+                _emitNotNullIfNotNull = sourceGenSpec.EmitNotNullIfNotNull;
                 _emitThrowIfNullMethod = sourceGenSpec.EmitThrowIfNullMethod;
             }
 

diff --git a/...ies/Microsoft.Extensions.Configuration.Binder/gen/ConfigurationBindingGenerator.Parser.cs b/...ies/Microsoft.Extensions.Configuration.Binder/gen/ConfigurationBindingGenerator.Parser.cs
@@ -57,6 +57,7 @@ internal sealed partial class Parser(CompilationData compilationData)
                     ConfigTypes = _createdTypeSpecs.Values.OrderBy(s => s.TypeRef.FullyQualifiedName).ToImmutableEquatableArray(),
                     EmitEnumParseMethod = _emitEnumParseMethod,
                     EmitGenericParseEnum = _emitGenericParseEnum,
+                    EmitNotNullIfNotNull = _typeSymbols.NotNullIfNotNullAttribute is not null,
                     EmitThrowIfNullMethod = IsThrowIfNullMethodToBeEmitted()
                 };
             }

diff --git a/src/libraries/Microsoft.Extensions.Configuration.Binder/gen/Emitter/ConfigurationBinder.cs b/src/libraries/Microsoft.Extensions.Configuration.Binder/gen/Emitter/ConfigurationBinder.cs
@@ -73,6 +73,7 @@ private void EmitGetValueMethods()
                 if (ShouldEmitMethods(MethodsToGen.ConfigBinder_GetValue_T_key_defaultValue))
                 {
                     EmitStartDefinition_Get_Or_GetValue_Overload(MethodsToGen.ConfigBinder_GetValue_T_key_defaultValue, documentation);
+                    EmitNotNullIfNotNull(Identifier.defaultValue);
                     _writer.WriteLine($"public static T? {Identifier.GetValue}<T>(this {Identifier.IConfiguration} {Identifier.configuration}, string {Identifier.key}, T {Identifier.defaultValue}) => " +
                         $"(T?)({expressionForGetValueCore}({Identifier.configuration}, typeof(T), {Identifier.key}) ?? {Identifier.defaultValue});");
                 }
@@ -87,11 +88,22 @@ private void EmitGetValueMethods()
                 if (ShouldEmitMethods(MethodsToGen.ConfigBinder_GetValue_TypeOf_key_defaultValue))
                 {
                     EmitStartDefinition_Get_Or_GetValue_Overload(MethodsToGen.ConfigBinder_GetValue_TypeOf_key_defaultValue, documentation);
+                    EmitNotNullIfNotNull(Identifier.defaultValue);
                     _writer.WriteLine($"public static object? {Identifier.GetValue}(this {Identifier.IConfiguration} {Identifier.configuration}, Type {Identifier.type}, string {Identifier.key}, object? {Identifier.defaultValue}) => " +
                         $"{expressionForGetValueCore}({Identifier.configuration}, {Identifier.type}, {Identifier.key}) ?? {Identifier.defaultValue};");
                 }
             }
 
+            private void EmitNotNullIfNotNull(string parameterName)
+            {
+                if (!_emitNotNullIfNotNull)
+                {
+                    return;
+                }
+
+                _writer.WriteLine($"[return: global::System.Diagnostics.CodeAnalysis.NotNullIfNotNull(nameof({parameterName}))]");
+            }
+
             private void EmitBindMethods_ConfigurationBinder()
             {
                 if (!ShouldEmitMethods(MethodsToGen.ConfigBinder_Bind))

diff --git a/src/libraries/Microsoft.Extensions.Configuration.Binder/gen/Parser/KnownTypeSymbols.cs b/src/libraries/Microsoft.Extensions.Configuration.Binder/gen/Parser/KnownTypeSymbols.cs
@@ -64,6 +64,7 @@ internal sealed class KnownTypeSymbols
         public INamedTypeSymbol? MemberInfo  { get; }
         public INamedTypeSymbol? ParameterInfo { get; }
         public INamedTypeSymbol? Delegate   { get; }
+        public INamedTypeSymbol? NotNullIfNotNullAttribute { get; }
 
         public KnownTypeSymbols(CSharpCompilation compilation)
         {
@@ -132,6 +133,9 @@ public KnownTypeSymbols(CSharpCompilation compilation)
             IntPtr = Compilation.GetSpecialType(SpecialType.System_IntPtr);
             UIntPtr = Compilation.GetSpecialType(SpecialType.System_UIntPtr);
             Delegate = Compilation.GetSpecialType(SpecialType.System_Delegate);
+
+            // Only generate nullable attributes if available
+            NotNullIfNotNullAttribute = compilation.GetBestTypeByMetadataName("System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute");
         }
     }
 }
diff --git a/src/libraries/Microsoft.Extensions.Configuration.Binder/gen/Specs/SourceGenerationSpec.cs b/src/libraries/Microsoft.Extensions.Configuration.Binder/gen/Specs/SourceGenerationSpec.cs
@@ -12,6 +12,7 @@ public sealed record SourceGenerationSpec
         public required ImmutableEquatableArray<TypeSpec> ConfigTypes { get; init; }
         public required bool EmitEnumParseMethod { get; set; }
         public required bool EmitGenericParseEnum { get; set; }
+        public required bool EmitNotNullIfNotNull { get; set; }
         public required bool EmitThrowIfNullMethod { get; set; }
     }
 }
diff --git a/...sts/SourceGenerationTests/Baselines/netcoreapp/ConfigurationBinder/GetValue.generated.txt b/...sts/SourceGenerationTests/Baselines/netcoreapp/ConfigurationBinder/GetValue.generated.txt
@@ -39,6 +39,7 @@ namespace Microsoft.Extensions.Configuration.Binder.SourceGeneration
 
         /// <summary>Extracts the value with the specified key and converts it to the specified type.</summary>
         [InterceptsLocation(@"src-0.cs", 16, 24)]
+        [return: global::System.Diagnostics.CodeAnalysis.NotNullIfNotNull(nameof(defaultValue))]
         public static T? GetValue<T>(this IConfiguration configuration, string key, T defaultValue) => (T?)(BindingExtensions.GetValueCore(configuration, typeof(T), key) ?? defaultValue);
 
         /// <summary>Extracts the value with the specified key and converts it to the specified type.</summary>
@@ -47,6 +48,7 @@ namespace Microsoft.Extensions.Configuration.Binder.SourceGeneration
 
         /// <summary>Extracts the value with the specified key and converts it to the specified type.</summary>
         [InterceptsLocation(@"src-0.cs", 17, 24)]
+        [return: global::System.Diagnostics.CodeAnalysis.NotNullIfNotNull(nameof(defaultValue))]
         public static object? GetValue(this IConfiguration configuration, Type type, string key, object? defaultValue) => BindingExtensions.GetValueCore(configuration, type, key) ?? defaultValue;
         #endregion IConfiguration extensions.
 

diff --git a/...nTests/Baselines/netcoreapp/ConfigurationBinder/GetValue_T_Key_DefaultValue.generated.txt b/...nTests/Baselines/netcoreapp/ConfigurationBinder/GetValue_T_Key_DefaultValue.generated.txt
@@ -35,6 +35,7 @@ namespace Microsoft.Extensions.Configuration.Binder.SourceGeneration
         #region IConfiguration extensions.
         /// <summary>Extracts the value with the specified key and converts it to the specified type.</summary>
         [InterceptsLocation(@"src-0.cs", 12, 20)]
+        [return: global::System.Diagnostics.CodeAnalysis.NotNullIfNotNull(nameof(defaultValue))]
         public static T? GetValue<T>(this IConfiguration configuration, string key, T defaultValue) => (T?)(BindingExtensions.GetValueCore(configuration, typeof(T), key) ?? defaultValue);
         #endregion IConfiguration extensions.
 

diff --git a/...s/Baselines/netcoreapp/ConfigurationBinder/GetValue_TypeOf_Key_DefaultValue.generated.txt b/...s/Baselines/netcoreapp/ConfigurationBinder/GetValue_TypeOf_Key_DefaultValue.generated.txt
@@ -35,6 +35,7 @@ namespace Microsoft.Extensions.Configuration.Binder.SourceGeneration
         #region IConfiguration extensions.
         /// <summary>Extracts the value with the specified key and converts it to the specified type.</summary>
         [InterceptsLocation(@"src-0.cs", 11, 20)]
+        [return: global::System.Diagnostics.CodeAnalysis.NotNullIfNotNull(nameof(defaultValue))]
         public static object? GetValue(this IConfiguration configuration, Type type, string key, object? defaultValue) => BindingExtensions.GetValueCore(configuration, type, key) ?? defaultValue;
         #endregion IConfiguration extensions.