|
| 1 | +using System.Collections.Generic; |
| 2 | +using System.IO; |
| 3 | +using System.Reflection; |
| 4 | +using System.Xml; |
| 5 | +using System.Xml.XPath; |
| 6 | +using BenchmarkDotNet.Attributes; |
| 7 | +using Microsoft.AspNetCore.Mvc.ApiExplorer; |
| 8 | +using Microsoft.AspNetCore.Mvc.Controllers; |
| 9 | +using Microsoft.OpenApi.Models; |
| 10 | +using Swashbuckle.AspNetCore.SwaggerGen; |
| 11 | +using Swashbuckle.AspNetCore.SwaggerGen.Test; |
| 12 | +using Swashbuckle.AspNetCore.TestSupport; |
| 13 | + |
| 14 | +namespace Swashbuckle.AspNetCore.Benchmarks; |
| 15 | + |
| 16 | +[MemoryDiagnoser] |
| 17 | +public class XmlCommentsBenchmark |
| 18 | +{ |
| 19 | + private XmlCommentsDocumentFilter _documentFilter; |
| 20 | + private OpenApiDocument _document; |
| 21 | + private DocumentFilterContext _documentFilterContext; |
| 22 | + |
| 23 | + private XmlCommentsOperationFilter _operationFilter; |
| 24 | + private OpenApiOperation _operation; |
| 25 | + private OperationFilterContext _operationFilterContext; |
| 26 | + |
| 27 | + private XmlCommentsParameterFilter _parameterFilter; |
| 28 | + private OpenApiParameter _parameter; |
| 29 | + private ParameterFilterContext _parameterFilterContext; |
| 30 | + |
| 31 | + private XmlCommentsRequestBodyFilter _requestBodyFilter; |
| 32 | + private OpenApiRequestBody _requestBody; |
| 33 | + private RequestBodyFilterContext _requestBodyFilterContext; |
| 34 | + |
| 35 | + private const int AddMemberCount = 10_000; |
| 36 | + |
| 37 | + [GlobalSetup] |
| 38 | + public void Setup() |
| 39 | + { |
| 40 | + // Load XML |
| 41 | + XmlDocument xmlDocument; |
| 42 | + using (var xmlComments = File.OpenText($"{typeof(FakeControllerWithXmlComments).Assembly.GetName().Name}.xml")) |
| 43 | + { |
| 44 | + xmlDocument = new XmlDocument(); |
| 45 | + xmlDocument.Load(xmlComments); |
| 46 | + } |
| 47 | + |
| 48 | + // Append dummy members to XML document |
| 49 | + XPathNavigator navigator = xmlDocument.CreateNavigator()!; |
| 50 | + navigator.MoveToRoot(); |
| 51 | + navigator.MoveToChild("doc", string.Empty); |
| 52 | + navigator.MoveToChild("members", string.Empty); |
| 53 | + |
| 54 | + for (int i = 0; i < AddMemberCount; i++) |
| 55 | + { |
| 56 | + navigator.PrependChild(@$"<member name=""benchmark_{i}""></member>"); |
| 57 | + } |
| 58 | + |
| 59 | + using var xmlStream = new MemoryStream(); |
| 60 | + xmlDocument.Save(xmlStream); |
| 61 | + xmlStream.Seek(0, SeekOrigin.Begin); |
| 62 | + var xPathDocument = new XPathDocument(xmlStream); |
| 63 | + |
| 64 | + // Document |
| 65 | + _document = new OpenApiDocument(); |
| 66 | + _documentFilterContext = new DocumentFilterContext( |
| 67 | + [ |
| 68 | + new ApiDescription |
| 69 | + { |
| 70 | + ActionDescriptor = new ControllerActionDescriptor |
| 71 | + { |
| 72 | + ControllerTypeInfo = typeof(FakeControllerWithXmlComments).GetTypeInfo(), |
| 73 | + ControllerName = nameof(FakeControllerWithXmlComments), |
| 74 | + }, |
| 75 | + }, |
| 76 | + new ApiDescription |
| 77 | + { |
| 78 | + ActionDescriptor = new ControllerActionDescriptor |
| 79 | + { |
| 80 | + ControllerTypeInfo = typeof(FakeControllerWithXmlComments).GetTypeInfo(), |
| 81 | + ControllerName = nameof(FakeControllerWithXmlComments), |
| 82 | + }, |
| 83 | + }, |
| 84 | + ], |
| 85 | + null, |
| 86 | + null); |
| 87 | + |
| 88 | + _documentFilter = new XmlCommentsDocumentFilter(xPathDocument); |
| 89 | + |
| 90 | + // Operation |
| 91 | + _operation = new OpenApiOperation(); |
| 92 | + var methodInfo = typeof(FakeConstructedControllerWithXmlComments) |
| 93 | + .GetMethod(nameof(FakeConstructedControllerWithXmlComments.ActionWithSummaryAndResponseTags)); |
| 94 | + |
| 95 | + var apiDescription = ApiDescriptionFactory.Create(methodInfo: methodInfo, groupName: "v1", httpMethod: "POST", relativePath: "resource"); |
| 96 | + _operationFilterContext = new OperationFilterContext(apiDescription, null, null, methodInfo); |
| 97 | + _operationFilter = new XmlCommentsOperationFilter(xPathDocument); |
| 98 | + |
| 99 | + // Parameter |
| 100 | + _parameter = new() |
| 101 | + { |
| 102 | + Schema = new() |
| 103 | + { |
| 104 | + Type = "string", |
| 105 | + Description = "schema-level description", |
| 106 | + }, |
| 107 | + }; |
| 108 | + |
| 109 | + var propertyInfo = typeof(XmlAnnotatedType).GetProperty(nameof(XmlAnnotatedType.StringProperty)); |
| 110 | + var apiParameterDescription = new ApiParameterDescription(); |
| 111 | + _parameterFilterContext = new ParameterFilterContext(apiParameterDescription, null, null, propertyInfo: propertyInfo); |
| 112 | + _parameterFilter = new XmlCommentsParameterFilter(xPathDocument); |
| 113 | + |
| 114 | + // Request Body |
| 115 | + _requestBody = new OpenApiRequestBody |
| 116 | + { |
| 117 | + Content = new Dictionary<string, OpenApiMediaType>() |
| 118 | + { |
| 119 | + ["application/json"] = new() |
| 120 | + { |
| 121 | + Schema = new() |
| 122 | + { |
| 123 | + Type = "string", |
| 124 | + }, |
| 125 | + }, |
| 126 | + }, |
| 127 | + }; |
| 128 | + var parameterInfo = typeof(FakeControllerWithXmlComments) |
| 129 | + .GetMethod(nameof(FakeControllerWithXmlComments.ActionWithParamTags))! |
| 130 | + .GetParameters()[0]; |
| 131 | + |
| 132 | + var bodyParameterDescription = new ApiParameterDescription |
| 133 | + { |
| 134 | + ParameterDescriptor = new ControllerParameterDescriptor { ParameterInfo = parameterInfo } |
| 135 | + }; |
| 136 | + _requestBodyFilterContext = new RequestBodyFilterContext(bodyParameterDescription, null, null, null); |
| 137 | + _requestBodyFilter = new XmlCommentsRequestBodyFilter(xPathDocument); |
| 138 | + } |
| 139 | + |
| 140 | + [Benchmark] |
| 141 | + public void Document() |
| 142 | + => _documentFilter.Apply(_document, _documentFilterContext); |
| 143 | + |
| 144 | + [Benchmark] |
| 145 | + public void Operation() |
| 146 | + => _operationFilter.Apply(_operation, _operationFilterContext); |
| 147 | + |
| 148 | + [Benchmark] |
| 149 | + public void Parameter() |
| 150 | + => _parameterFilter.Apply(_parameter, _parameterFilterContext); |
| 151 | + |
| 152 | + [Benchmark] |
| 153 | + public void RequestBody() |
| 154 | + => _requestBodyFilter.Apply(_requestBody, _requestBodyFilterContext); |
| 155 | +} |
0 commit comments