Configure IHostApplicationBuilder support for annotation library (#1999)

Author: GarrettBeatty

.autover/changes/792302e7-fe01-4ebe-9357-577bc4097f41.json

@@ -0,0 +1,11 @@
+{
+  "Projects": [
+    {
+      "Name": "Amazon.Lambda.Annotations",
+      "Type": "Minor",
+      "ChangelogMessages": [
+        "Add ConfigureHostBuilder function to `Startup` class for allowing the Lambda function to configure an `IHostApplicationBuilder`."
+      ]
+    }
+  ]
+}

Libraries/src/Amazon.Lambda.Annotations.SourceGenerator/Amazon.Lambda.Annotations.SourceGenerator.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFrameworks>netstandard2.0;net6.0;net8.0</TargetFrameworks>

Libraries/src/Amazon.Lambda.Annotations.SourceGenerator/Diagnostics/AnalyzerReleases.Shipped.md

@@ -1,6 +1,12 @@
 ; Shipped analyzer releases
 ; https://github.com/dotnet/roslyn-analyzers/blob/master/src/Microsoft.CodeAnalysis.Analyzers/ReleaseTrackingAnalyzers.Help.md
 
+## Release 1.7.0
+### New Rules
+Rule ID | Category | Severity | Notes
+--------|----------|----------|-------
+AWSLambda0119 | AWSLambdaCSharpGenerator | Error | Conflicting Service Configuration Methods Detected
+
 ## Release 1.5.1
 ### New Rules
 
@@ -79,4 +85,4 @@ Rule ID | Category | Severity | Notes
 AWSLambda0001 | AWSLambda | Error | Unhandled exception
 AWSLambda0101 | AWSLambdaCSharpGenerator | Error | Multiple LambdaStartup classes not allowed
 AWSLambda0102 | AWSLambdaCSharpGenerator | Error | Multiple events on Lambda function not supported
-AWSLambda0103 | AWSLambdaCSharpGenerator | Info | Generated code
+AWSLambda0103 | AWSLambdaCSharpGenerator | Info | Generated code

Libraries/src/Amazon.Lambda.Annotations.SourceGenerator/Diagnostics/DiagnosticDescriptors.cs

@@ -145,5 +145,13 @@ public static class DiagnosticDescriptors
             category: "AWSLambdaCSharpGenerator",
             DiagnosticSeverity.Error,
             isEnabledByDefault: true);
+
+        public static readonly DiagnosticDescriptor MultipleConfigureMethodsNotAllowed = new DiagnosticDescriptor(
+            id: "AWSLambda0119",
+            title: "Conflicting Service Configuration Methods Detected",
+            messageFormat: "Both '{0}' and '{1}' methods are present. Only {1} will be used. Please consolidate your service configuration into {1}.",
+            category: "AWSLambdaCSharpGenerator",
+            DiagnosticSeverity.Error,
+            isEnabledByDefault: true);
     }
-}
+}

Libraries/src/Amazon.Lambda.Annotations.SourceGenerator/Generator.cs

@@ -1,4 +1,4 @@
-using Amazon.Lambda.Annotations.SourceGenerator.Diagnostics;
+using Amazon.Lambda.Annotations.SourceGenerator.Diagnostics;
 using Amazon.Lambda.Annotations.SourceGenerator.Extensions;
 using Amazon.Lambda.Annotations.SourceGenerator.FileIO;
 using Amazon.Lambda.Annotations.SourceGenerator.Models;
@@ -93,9 +93,9 @@ public void Execute(GeneratorExecutionContext context)
                 var isExecutable = false;
 
                 bool foundFatalError = false;
-                
+
                 var assemblyAttributes = context.Compilation.Assembly.GetAttributes();
-                
+
                 var globalPropertiesAttribute = assemblyAttributes
                     .FirstOrDefault(attr => attr.AttributeClass.Name == nameof(LambdaGlobalPropertiesAttribute));
 
@@ -109,7 +109,7 @@ public void Execute(GeneratorExecutionContext context)
                         defaultRuntime = _targetFrameworksToRuntimes[targetFramework];
                     }
                 }
-                
+
                 // The runtime specified in the global property has precedence over the one we determined from the TFM (if we did)
                 if (globalPropertiesAttribute != null)
                 {
@@ -134,14 +134,26 @@ public void Execute(GeneratorExecutionContext context)
                     }
                 }
 
-                var configureMethodSymbol = semanticModelProvider.GetConfigureMethodModel(receiver.StartupClasses.FirstOrDefault());
+                var configureHostBuilderMethodSymbol = semanticModelProvider.GetConfigureHostBuilderMethodModel(receiver.StartupClasses.FirstOrDefault());
+                var configureServicesMethodSymbol = semanticModelProvider.GetConfigureServicesMethodModel(receiver.StartupClasses.FirstOrDefault());
+                var configureMethodSymbol = configureServicesMethodSymbol;
+
+                if (configureServicesMethodSymbol != null && configureHostBuilderMethodSymbol != null)
+                {
+                    diagnosticReporter.Report(Diagnostic.Create(DiagnosticDescriptors.MultipleConfigureMethodsNotAllowed, configureServicesMethodSymbol.Locations.FirstOrDefault(), configureServicesMethodSymbol.Name, configureHostBuilderMethodSymbol.Name));
+                }
+
+                if (configureHostBuilderMethodSymbol != null)
+                {
+                    configureMethodSymbol = configureHostBuilderMethodSymbol;
+                }
 
                 var annotationReport = new AnnotationReport();
 
                 var templateHandler = new CloudFormationTemplateHandler(_fileManager, _directoryManager);
 
                 var lambdaModels = new List<LambdaFunctionModel>();
-                
+
                 foreach (var lambdaMethodDeclarationSyntax in receiver.LambdaMethods)
                 {
                     var lambdaMethodSymbol = semanticModelProvider.GetMethodSemanticModel(lambdaMethodDeclarationSyntax);
@@ -163,7 +175,7 @@ public void Execute(GeneratorExecutionContext context)
                         sourceText = template.TransformText().ToEnvironmentLineEndings();
                         context.AddSource($"{lambdaFunctionModel.GeneratedMethod.ContainingType.Name}.g.cs", SourceText.From(sourceText, Encoding.UTF8, SourceHashAlgorithm.Sha256));
                     }
-                    catch (Exception e) when (e is NotSupportedException || e is InvalidOperationException)  
+                    catch (Exception e) when (e is NotSupportedException || e is InvalidOperationException)
                     {
                         diagnosticReporter.Report(Diagnostic.Create(DiagnosticDescriptors.CodeGenerationFailed, Location.Create(lambdaMethodDeclarationSyntax.SyntaxTree, lambdaMethodDeclarationSyntax.Span), e.Message));
                         return;
@@ -241,7 +253,7 @@ private static ExecutableAssembly GenerateExecutableAssemblySource(
                         DiagnosticDescriptors.MissingDependencies,
                         Location.None,
                         "Amazon.Lambda.RuntimeSupport"));
-                
+
                 return null;
             }
 
@@ -251,14 +263,14 @@ private static ExecutableAssembly GenerateExecutableAssemblySource(
                 var symbol = model.GetDeclaredSymbol(methodDeclaration) as IMethodSymbol;
 
                 // Check to see if a static main method exists in the same namespace that has 0 or 1 parameters
-                if (symbol.Name != "Main" || !symbol.IsStatic || symbol.ContainingNamespace.Name != lambdaModels[0].LambdaMethod.ContainingAssembly || (symbol.Parameters.Length > 1)) 
+                if (symbol.Name != "Main" || !symbol.IsStatic || symbol.ContainingNamespace.Name != lambdaModels[0].LambdaMethod.ContainingAssembly || (symbol.Parameters.Length > 1))
                     continue;
-                
+
                 diagnosticReporter.Report(
                     Diagnostic.Create(
                         DiagnosticDescriptors.MainMethodExists,
                         Location.None));
-                    
+
                 return null;
             }
 
@@ -284,4 +296,4 @@ public void Initialize(GeneratorInitializationContext context)
             context.RegisterForSyntaxNotifications(() => new SyntaxReceiver(_fileManager, _directoryManager));
         }
     }
-}
+}

Libraries/src/Amazon.Lambda.Annotations.SourceGenerator/Models/GeneratedMethodModelBuilder.cs

@@ -27,7 +27,7 @@ public static GeneratedMethodModel Build(IMethodSymbol lambdaMethodSymbol,
             return model;
         }
 
-        private static IList<string> BuildUsings(LambdaMethodModel lambdaMethodModel, 
+        private static IList<string> BuildUsings(LambdaMethodModel lambdaMethodModel,
             IMethodSymbol lambdaMethodSymbol,
             IMethodSymbol configureMethodSymbol,
             GeneratorExecutionContext context)
@@ -45,6 +45,12 @@ private static IList<string> BuildUsings(LambdaMethodModel lambdaMethodModel,
             if (configureMethodSymbol != null)
             {
                 namespaces.Add("Microsoft.Extensions.DependencyInjection");
+
+                if (lambdaMethodModel.UsingHostBuilderForDependencyInjection)
+                {
+                    namespaces.Add("Microsoft.Extensions.Hosting");
+                }
+
             }
 
             namespaces.Add("Amazon.Lambda.Core");
@@ -73,7 +79,7 @@ private static TypeModel BuildResponseType(IMethodSymbol lambdaMethodSymbol,
                 return TypeModelBuilder.Build(typeStream, context);
             }
 
-            
+
             if (lambdaMethodSymbol.HasAttribute(context, TypeFullNames.RestApiAttribute))
             {
                 var symbol = lambdaMethodModel.ReturnsVoidOrGenericTask ?

Libraries/src/Amazon.Lambda.Annotations.SourceGenerator/Models/LambdaFunctionModelBuilder.cs

@@ -83,4 +83,4 @@ private static LambdaSerializerInfo GetSerializerInfoAttribute(GeneratorExecutio
             return new LambdaSerializerInfo(serializerString);
         }
     }
-}
+}

Libraries/src/Amazon.Lambda.Annotations.SourceGenerator/Models/LambdaMethodModel.cs

@@ -54,7 +54,7 @@ public bool ReturnsIHttpResults
                 {
                     return true;
                 }
-                if(ReturnsGenericTask && ReturnType.TypeArguments.Count == 1 && ReturnType.TypeArguments[0].FullName == TypeFullNames.IHttpResult) 
+                if(ReturnsGenericTask && ReturnType.TypeArguments.Count == 1 && ReturnType.TypeArguments[0].FullName == TypeFullNames.IHttpResult)
                 {
                     return true;
                 }
@@ -100,6 +100,8 @@ public bool ReturnsVoidTaskOrSqsBatchResponse
         /// </summary>
         public bool UsingDependencyInjection { get; set; }
 
+        public bool UsingHostBuilderForDependencyInjection { get; set; }
+
         /// <summary>
         /// Gets or sets the namespace for the nearest enclosing namespace. Returns null if the
         /// symbol isn't contained in a namespace.
@@ -151,4 +153,4 @@ public AttributeModel<LambdaFunctionAttribute> LambdaFunctionAttribute
             }
         }
     }
-}
+}

Libraries/src/Amazon.Lambda.Annotations.SourceGenerator/Models/LambdaMethodModelBuilder.cs

@@ -27,10 +27,11 @@ public static LambdaMethodModel Build(IMethodSymbol lambdaMethodSymbol,
                 Events = EventTypeBuilder.Build(lambdaMethodSymbol, context),
                 ContainingType = TypeModelBuilder.Build(lambdaMethodSymbol.ContainingType, context),
                 UsingDependencyInjection = configureMethodSymbol != null,
+                UsingHostBuilderForDependencyInjection = configureMethodSymbol != null && configureMethodSymbol.Name == "ConfigureHostBuilder",
                 Attributes = lambdaMethodSymbol.GetAttributes().Select(att => AttributeModelBuilder.Build(att, context)).ToList()
             };
 
             return model;
         }
     }
-}
+}

Libraries/src/Amazon.Lambda.Annotations.SourceGenerator/SemanticModelProvider.cs

@@ -20,14 +20,14 @@ public SemanticModelProvider(GeneratorExecutionContext context)
         /// If <see cref="startupSyntax"/> is null, returns null.
         /// </summary>
         /// <param name="startupSyntax">LambdaStartup attributed class syntax</param>
-        public IMethodSymbol GetConfigureMethodModel(ClassDeclarationSyntax startupSyntax)
+        public IMethodSymbol GetConfigureServicesMethodModel(ClassDeclarationSyntax startupSyntax)
         {
             if (startupSyntax == null)
             {
                 return null;
             }
 
-            IMethodSymbol configureMethodSymbol = null;
+            IMethodSymbol configureServicesMethodSymbol = null;
 
             var iServiceCollectionSymbol = _context.Compilation.GetTypeByMetadataName("Microsoft.Extensions.DependencyInjection.IServiceCollection");
 
@@ -36,7 +36,6 @@ public IMethodSymbol GetConfigureMethodModel(ClassDeclarationSyntax startupSynta
             // Filter the methods which can potentially have Configure(IServiceCollection) parameter signature
             var members = startupSyntax.Members.Where(member => member.Kind() == SyntaxKind.MethodDeclaration);
 
-
             foreach (var member in members)
             {
                 var methodSyntax = (MethodDeclarationSyntax) member;
@@ -47,12 +46,37 @@ public IMethodSymbol GetConfigureMethodModel(ClassDeclarationSyntax startupSynta
                     && methodSymbol.Parameters[0].Type
                         .Equals(iServiceCollectionSymbol, SymbolEqualityComparer.Default))
                 {
-                    configureMethodSymbol = methodSymbol;
+                    configureServicesMethodSymbol = methodSymbol;
+                    break;
+                }
+            }
+
+            return configureServicesMethodSymbol;
+        }
+
+        public IMethodSymbol GetConfigureHostBuilderMethodModel(ClassDeclarationSyntax startupSyntax)
+        {
+            if (startupSyntax == null)
+            {
+                return null;
+            }
+
+            IMethodSymbol configureHostBuilderMethodSymbol = null;
+
+            var classModel = _context.Compilation.GetSemanticModel(startupSyntax.SyntaxTree);
+
+            foreach (var member in startupSyntax.Members.Where(member => member.Kind() == SyntaxKind.MethodDeclaration))
+            {
+                var methodSyntax = (MethodDeclarationSyntax)member;
+                var methodSymbol = classModel.GetDeclaredSymbol(methodSyntax);
+                if (methodSymbol != null && methodSymbol.Name == "ConfigureHostBuilder")
+                {
+                    configureHostBuilderMethodSymbol = methodSymbol;
                     break;
                 }
             }
 
-            return configureMethodSymbol;
+            return configureHostBuilderMethodSymbol;
         }
 
         /// <summary>
@@ -65,4 +89,4 @@ public IMethodSymbol GetMethodSemanticModel(MethodDeclarationSyntax syntax)
             return methodModel.GetDeclaredSymbol(syntax);
         }
     }
-}
+}