Code Review Bench PR #64401 - [release/10.0] Fix ModelMetadata null reference exception in emitted XMLComment transformers

src/OpenApi/gen/XmlCommentGenerator.Emitter.cs

@@ -1,6 +1,3 @@
-// Licensed to the .NET Foundation under one or more agreements.
-// The .NET Foundation licenses this file to you under the MIT license.
-
 using System.Collections.Generic;
 using System.Collections.Immutable;
 using System.IO;
@@ -382,7 +379,7 @@ public Task TransformAsync(OpenApiOperation operation, OpenApiOperationTransform
                 }
                 if (methodComment.Remarks is { } remarks)
                 {
-                    operation.Description = remarks;
+                    operation.Summary = remarks;
                 }
                 if (methodComment.Parameters is { Count: > 0})
                 {
@@ -444,14 +441,15 @@ public Task TransformAsync(OpenApiOperation operation, OpenApiOperationTransform
             foreach (var parameterDescription in context.Description.ParameterDescriptions)
             {
                 var metadata = parameterDescription.ModelMetadata;
-                if (metadata.MetadataKind == ModelMetadataKind.Property
+                if (metadata is not null
+                    && metadata.MetadataKind == ModelMetadataKind.Property
                     && metadata.ContainerType is { } containerType
                     && metadata.PropertyName is { } propertyName)
                 {
                     var propertyDocId = DocumentationCommentIdHelper.CreateDocumentationId(containerType, propertyName);
                     if (XmlCommentCache.Cache.TryGetValue(DocumentationCommentIdHelper.NormalizeDocId(propertyDocId), out var propertyComment))
                     {
-                        var parameter = operation.Parameters?.SingleOrDefault(p => p.Name == metadata.Name);
+                        var parameter = operation.Parameters?.SingleOrDefault(p => p.Name == propertyName);
                         var description = propertyComment.Summary;
                         if (!string.IsNullOrEmpty(description) && !string.IsNullOrEmpty(propertyComment.Value))
                         {
@@ -465,7 +463,6 @@ public Task TransformAsync(OpenApiOperation operation, OpenApiOperationTransform
                         {
                             if (operation.RequestBody is not null)
                             {
-                                operation.RequestBody.Description = description;
                                 if (propertyComment.Examples?.FirstOrDefault() is { } jsonString)
                                 {
                                     var content = operation.RequestBody.Content?.Values;
@@ -479,6 +476,7 @@ public Task TransformAsync(OpenApiOperation operation, OpenApiOperationTransform
                                         mediaType.Example = parsedExample;
                                     }
                                 }
+                                operation.RequestBody.Description = description;
                             }
                             continue;
                         }

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.SourceGenerators.Tests/OperationTests.Controllers.cs

@@ -96,4 +96,49 @@ await SnapshotTestHelper.VerifyOpenApi(compilation, document =>
             Assert.Equal("The todo to insert into the database.", path3.RequestBody.Description);
         });
     }
+
+    [Fact]
+    public async Task SupportsRouteParametersFromControllers()
+    {
+        var source = """
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.DependencyInjection;
+
+var builder = WebApplication.CreateBuilder();
+
+builder.Services
+    .AddControllers()
+    .AddApplicationPart(typeof(TestController).Assembly);
+builder.Services.AddOpenApi();
+
+var app = builder.Build();
+
+app.MapControllers();
+
+app.Run();
+
+[ApiController]
+[Route("[controller]")]
+public class TestController : ControllerBase
+{
+    /// <param name="userId">The id of the user.</param>
+    [HttpGet("{userId}")]
+    public string Get()
+    {
+        return "Hello, World!";
+    }
+}
+
+public partial class Program {}
+
+""";
+        var generator = new XmlCommentGenerator();
+        await SnapshotTestHelper.Verify(source, generator, out var compilation);
+        await SnapshotTestHelper.VerifyOpenApi(compilation, document =>
+        {
+            var path = document.Paths["/Test/{userId}"].Operations[HttpMethod.Get];
+            Assert.Equal("The id of the user.", path.Parameters[0].Description);
+        });
+    }
 }

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.SourceGenerators.Tests/snapshots/AddOpenApiTests.CanInterceptAddOpenApi#OpenApiXmlCommentSupport.generated.verified.cs

@@ -426,7 +426,8 @@ public Task TransformAsync(OpenApiOperation operation, OpenApiOperationTransform
             foreach (var parameterDescription in context.Description.ParameterDescriptions)
             {
                 var metadata = parameterDescription.ModelMetadata;
-                if (metadata.MetadataKind == ModelMetadataKind.Property
+                if (metadata is not null
+                    && metadata.MetadataKind == ModelMetadataKind.Property
                     && metadata.ContainerType is { } containerType
                     && metadata.PropertyName is { } propertyName)
                 {

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.SourceGenerators.Tests/snapshots/AdditionalTextsTests.CanHandleXmlForSchemasInAdditionalTexts#OpenApiXmlCommentSupport.generated.verified.cs

@@ -455,7 +455,8 @@ public Task TransformAsync(OpenApiOperation operation, OpenApiOperationTransform
             foreach (var parameterDescription in context.Description.ParameterDescriptions)
             {
                 var metadata = parameterDescription.ModelMetadata;
-                if (metadata.MetadataKind == ModelMetadataKind.Property
+                if (metadata is not null
+                    && metadata.MetadataKind == ModelMetadataKind.Property
                     && metadata.ContainerType is { } containerType
                     && metadata.PropertyName is { } propertyName)
                 {

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.SourceGenerators.Tests/snapshots/CompletenessTests.SupportsAllXmlTagsOnSchemas#OpenApiXmlCommentSupport.generated.verified.cs

@@ -553,7 +553,8 @@ public Task TransformAsync(OpenApiOperation operation, OpenApiOperationTransform
             foreach (var parameterDescription in context.Description.ParameterDescriptions)
             {
                 var metadata = parameterDescription.ModelMetadata;
-                if (metadata.MetadataKind == ModelMetadataKind.Property
+                if (metadata is not null
+                    && metadata.MetadataKind == ModelMetadataKind.Property
                     && metadata.ContainerType is { } containerType
                     && metadata.PropertyName is { } propertyName)
                 {