Define StringComparer for all Dictionaries of string key type

Havunen · Feb 18, 2024 · 2819ce5 · 2819ce5
1 parent aba085f
commit 2819ce5
Show file tree

Hide file tree

Showing 24 changed files with 85 additions and 72 deletions.
diff --git a/.gitignore b/.gitignore
@@ -13,4 +13,5 @@ Thumbs.db
 test/WebSites/CliExample/wwwroot/api-docs/v1/*.json
 test/WebSites/CliExampleWithFactory/wwwroot/api-docs/v1/*.json
 test/WebSites/NswagClientExample/NSwagClient/
-*ncrunch*
+*ncrunch*
+BenchmarkDotNet.Artifacts
diff --git a/benches/DotSwashbuckle.AspNetCore.Benchmark.Logic/DotSwashbuckleGenerator.cs b/benches/DotSwashbuckle.AspNetCore.Benchmark.Logic/DotSwashbuckleGenerator.cs
@@ -8,11 +8,11 @@ namespace DotSwashbuckle.AspNetCore.Benchmark.Logic
     public class DotSwashbuckleGenerator
     {
 
-        public static string CreateSwaggerDoc(IServiceProvider serviceProvider, bool isYaml, bool isV2)
+        public static async Task<string> CreateSwaggerDoc(IServiceProvider serviceProvider, bool isYaml, bool isV2)
         {
             // 3) Retrieve Swagger via configured provider
             var swaggerProvider = serviceProvider.GetRequiredService<ISwaggerProvider>();
-            var swagger = swaggerProvider.GetSwagger(
+            var swagger = await swaggerProvider.GetSwaggerAsync(
                 "v1",
                 null,
                 null

diff --git a/benches/DotSwashbuckle.AspNetCore.Benchmark/OpenApiGenerateJsonBenchmark.cs b/benches/DotSwashbuckle.AspNetCore.Benchmark/OpenApiGenerateJsonBenchmark.cs
@@ -24,9 +24,9 @@ public void GlobalSetup()
         }
 
         [Benchmark]
-        public string DotSwashbuckleOpenApiV2()
+        public async Task<string> DotSwashbuckleOpenApiV2()
         {
-            return DotSwashbuckleGenerator.CreateSwaggerDoc(
+            return await DotSwashbuckleGenerator.CreateSwaggerDoc(
                 assemblyProviders["Basic.dll"],
                 false,
                 true

diff --git a/benches/DotSwashbuckle.AspNetCore.Console/Program.cs b/benches/DotSwashbuckle.AspNetCore.Console/Program.cs
@@ -5,7 +5,7 @@ namespace DotSwashbuckle.AspNetCore.Console;
 
 public class Program
 {
-    public static void Main(string[] args)
+    public static async Task Main(string[] args)
     {
         var serviceProvider = AssemblyServiceProvider.GetServiceProvider(
             AssemblyLoadContext.Default.LoadFromAssemblyPath(
@@ -15,7 +15,7 @@ public static void Main(string[] args)
 
         for (var i = 0; i < 1000; i++)
         {
-            DotSwashbuckleGenerator.CreateSwaggerDoc(
+            await DotSwashbuckleGenerator.CreateSwaggerDoc(
                 serviceProvider,
                 false,
                 true

diff --git a/src/DotSwashbuckle.AspNetCore.ApiTesting/ApiTestRunnerOptions.cs b/src/DotSwashbuckle.AspNetCore.ApiTesting/ApiTestRunnerOptions.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using Microsoft.OpenApi.Models;
 
@@ -7,7 +8,7 @@ public class ApiTestRunnerOptions
     {
         public ApiTestRunnerOptions()
         {
-            OpenApiDocs = new Dictionary<string, OpenApiDocument>();
+            OpenApiDocs = new Dictionary<string, OpenApiDocument>(StringComparer.Ordinal);
             ContentValidators = new List<IContentValidator> { new JsonContentValidator() };
             GenerateOpenApiFiles = false;
             FileOutputRoot = null;

diff --git a/src/DotSwashbuckle.AspNetCore.Cli/CommandRunner.cs b/src/DotSwashbuckle.AspNetCore.Cli/CommandRunner.cs
@@ -17,8 +17,8 @@ public CommandRunner(string commandName, string commandDescription, TextWriter o
         {
             CommandName = commandName;
             CommandDescription = commandDescription;
-            _argumentDescriptors = new Dictionary<string, string>();
-            _optionDescriptors = new Dictionary<string, OptionDescriptor>();
+            _argumentDescriptors = new Dictionary<string, string>(StringComparer.Ordinal);
+            _optionDescriptors = new Dictionary<string, OptionDescriptor>(StringComparer.Ordinal);
             _runFunc = (namedArgs) => { return 1; }; // noop
             _subRunners = new List<CommandRunner>();
             _output = output;
@@ -70,7 +70,7 @@ public int Run(IEnumerable<string> args)
 
         private bool TryParseArgs(IEnumerable<string> args, out IDictionary<string, string> namedArgs)
         {
-            namedArgs = new Dictionary<string, string>();
+            namedArgs = new Dictionary<string, string>(StringComparer.Ordinal);
             var argsQueue = new Queue<string>(args);
 
             // Process options first

diff --git a/src/DotSwashbuckle.AspNetCore.ReDoc/ReDocMiddleware.cs b/src/DotSwashbuckle.AspNetCore.ReDoc/ReDocMiddleware.cs
@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Reflection;
@@ -108,7 +109,7 @@ private async Task RespondWithIndexHtml(HttpResponse response)
 
         private IDictionary<string, string> GetIndexArguments()
         {
-            return new Dictionary<string, string>()
+            return new Dictionary<string, string>(StringComparer.Ordinal)
             {
                 { "%(DocumentTitle)", _options.DocumentTitle },
                 { "%(HeadContent)", _options.HeadContent },

diff --git a/src/DotSwashbuckle.AspNetCore.ReDoc/ReDocOptions.cs b/src/DotSwashbuckle.AspNetCore.ReDoc/ReDocOptions.cs
@@ -109,6 +109,6 @@ public class ConfigObject
         public bool SortPropsAlphabetically { get; set; } = false;
 
         [JsonExtensionData]
-        public Dictionary<string, object> AdditionalItems { get; set; } = new Dictionary<string, object>();
+        public Dictionary<string, object> AdditionalItems { get; set; } = new Dictionary<string, object>(StringComparer.Ordinal);
     }
 }
diff --git a/src/DotSwashbuckle.AspNetCore.Swagger/ISwaggerProvider.cs b/src/DotSwashbuckle.AspNetCore.Swagger/ISwaggerProvider.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Threading.Tasks;
 using Microsoft.OpenApi.Models;
 
 namespace DotSwashbuckle.AspNetCore.Swagger
@@ -11,6 +12,11 @@ OpenApiDocument GetSwagger(
             string documentName,
             string host = null,
             string basePath = null);
+
+        Task<OpenApiDocument> GetSwaggerAsync(
+            string documentName,
+            string host = null,
+            string basePath = null);
     }
 
     public class UnknownSwaggerDocument : InvalidOperationException

diff --git a/src/DotSwashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGenerator.cs b/src/DotSwashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGenerator.cs
@@ -345,7 +345,7 @@ private OpenApiSchema CreateObjectSchema(DataContract dataContract, SchemaReposi
             var schema = new OpenApiSchema
             {
                 Type = "object",
-                Properties = new Dictionary<string, OpenApiSchema>(),
+                Properties = new Dictionary<string, OpenApiSchema>(StringComparer.Ordinal),
                 Required = new SortedSet<string>(),
                 AdditionalPropertiesAllowed = false
             };

diff --git a/src/DotSwashbuckle.AspNetCore.SwaggerGen/SwaggerGenerator/SchemaRepository.cs b/src/DotSwashbuckle.AspNetCore.SwaggerGen/SwaggerGenerator/SchemaRepository.cs
@@ -16,7 +16,7 @@ public SchemaRepository(string documentName = null)
 
         public string DocumentName { get; }
 
-        public Dictionary<string, OpenApiSchema> Schemas { get; private set; } = new Dictionary<string, OpenApiSchema>();
+        public Dictionary<string, OpenApiSchema> Schemas { get; private set; } = new Dictionary<string, OpenApiSchema>(StringComparer.Ordinal);
 
         public void RegisterType(Type type, string schemaId)
         {

diff --git a/src/DotSwashbuckle.AspNetCore.SwaggerGen/SwaggerGenerator/SwaggerGenerator.cs b/src/DotSwashbuckle.AspNetCore.SwaggerGen/SwaggerGenerator/SwaggerGenerator.cs
@@ -504,7 +504,7 @@ private OpenApiSchema GenerateSchemaFromFormParameters(
             IEnumerable<ApiParameterDescription> formParameters,
             SchemaRepository schemaRepository)
         {
-            var properties = new Dictionary<string, OpenApiSchema>();
+            var properties = new Dictionary<string, OpenApiSchema>(StringComparer.Ordinal);
             var requiredPropertyNames = new List<string>();
 
             foreach (var formParameter in formParameters)
@@ -601,7 +601,7 @@ private OpenApiMediaType CreateResponseMediaType(ModelMetadata modelMetadata, Sc
             };
         }
 
-        private static readonly Dictionary<string, OperationType> OperationTypeMap = new Dictionary<string, OperationType>
+        private static readonly Dictionary<string, OperationType> OperationTypeMap = new Dictionary<string, OperationType>(StringComparer.Ordinal)
         {
             { "GET", OperationType.Get },
             { "PUT", OperationType.Put },

diff --git a/src/DotSwashbuckle.AspNetCore.SwaggerGen/SwaggerGenerator/SwaggerGeneratorOptions.cs b/src/DotSwashbuckle.AspNetCore.SwaggerGen/SwaggerGenerator/SwaggerGeneratorOptions.cs
@@ -13,15 +13,15 @@ public class SwaggerGeneratorOptions
     {
         public SwaggerGeneratorOptions()
         {
-            SwaggerDocs = new Dictionary<string, OpenApiInfo>();
+            SwaggerDocs = new Dictionary<string, OpenApiInfo>(StringComparer.Ordinal);
             DocInclusionPredicate = DefaultDocInclusionPredicate;
             OperationIdSelector = DefaultOperationIdSelector;
             TagsSelector = DefaultTagsSelector;
             SortKeySelector = DefaultSortKeySelector;
             SecuritySchemesSelector = null;
             SchemaComparer = StringComparer.Ordinal;
             Servers = new List<OpenApiServer>();
-            SecuritySchemes = new Dictionary<string, OpenApiSecurityScheme>();
+            SecuritySchemes = new Dictionary<string, OpenApiSecurityScheme>(StringComparer.Ordinal);
             SecurityRequirements = new List<OpenApiSecurityRequirement>();
             ParameterFilters = new List<IParameterFilter>();
             RequestBodyFilters = new List<IRequestBodyFilter>();

diff --git a/src/DotSwashbuckle.AspNetCore.SwaggerUI/SwaggerUIMiddleware.cs b/src/DotSwashbuckle.AspNetCore.SwaggerUI/SwaggerUIMiddleware.cs
@@ -14,6 +14,7 @@
 using Microsoft.Extensions.FileProviders;
 using Microsoft.AspNetCore.StaticFiles;
 using System.Linq;
+using System;
 
 namespace DotSwashbuckle.AspNetCore.SwaggerUI
 {
@@ -110,7 +111,7 @@ private async Task RespondWithIndexHtml(HttpResponse response)
 
         private IDictionary<string, string> GetIndexArguments()
         {
-            return new Dictionary<string, string>()
+            return new Dictionary<string, string>(StringComparer.Ordinal)
             {
                 { "%(DocumentTitle)", _options.DocumentTitle },
                 { "%(HeadContent)", _options.HeadContent },

diff --git a/src/DotSwashbuckle.AspNetCore.SwaggerUI/SwaggerUIOptions.cs b/src/DotSwashbuckle.AspNetCore.SwaggerUI/SwaggerUIOptions.cs
@@ -142,7 +142,7 @@ public class ConfigObject
         public string ValidatorUrl { get; set; } = null;
 
         [JsonExtensionData]
-        public Dictionary<string, object> AdditionalItems { get; set; } = new Dictionary<string, object>();
+        public Dictionary<string, object> AdditionalItems { get; set; } = new Dictionary<string, object>(StringComparer.Ordinal);
     }
 
     public class UrlDescriptor

diff --git a/test/DotSwashbuckle.AspNetCore.ApiTesting.Test/JsonValidatorTests.cs b/test/DotSwashbuckle.AspNetCore.ApiTesting.Test/JsonValidatorTests.cs
@@ -3,6 +3,7 @@
 using Microsoft.OpenApi.Models;
 using Newtonsoft.Json.Linq;
 using System.Linq;
+using System;
 
 namespace DotSwashbuckle.AspNetCore.ApiTesting.Test
 {
@@ -433,7 +434,7 @@ public void Validate_ReturnsError_IfKnownPropertyDoesNotMatchPropertySchema(
             var openApiSchema = new OpenApiSchema
             {
                 Type = "object",
-                Properties = new Dictionary<string, OpenApiSchema>
+                Properties = new Dictionary<string, OpenApiSchema>(StringComparer.Ordinal)
                 {
                     [ "id" ] = new OpenApiSchema { Type = propertySchemaType }
                 }
@@ -606,7 +607,7 @@ public void Validate_SupportsReferencedSchemas_IfDefinedInProvidedOpenApiDocumen
             {
                 Components = new OpenApiComponents
                 {
-                    Schemas = new Dictionary<string, OpenApiSchema>
+                    Schemas = new Dictionary<string, OpenApiSchema>(StringComparer.Ordinal)
                     {
                         ["ref"] = new OpenApiSchema { Type = "number" }
                     }

diff --git a/test/DotSwashbuckle.AspNetCore.ApiTesting.Test/RequestValidatorTests.cs b/test/DotSwashbuckle.AspNetCore.ApiTesting.Test/RequestValidatorTests.cs
@@ -262,7 +262,7 @@ public void Validate_ThrowsException_IfRequiredContentIsNotPresent(
                 RequestBody = new OpenApiRequestBody
                 {
                     Required = true,
-                    Content = new Dictionary<string, OpenApiMediaType>
+                    Content = new Dictionary<string, OpenApiMediaType>(StringComparer.Ordinal)
                     {
                         [ "text/plain" ] = new OpenApiMediaType()
                     }
@@ -294,7 +294,7 @@ public void Validate_ThrowsException_IfContentMediaTypeIsNotSpecified(
             {
                 RequestBody = new OpenApiRequestBody
                 {
-                    Content = new Dictionary<string, OpenApiMediaType>
+                    Content = new Dictionary<string, OpenApiMediaType>(StringComparer.Ordinal)
                     {
                         [ "application/json" ] = new OpenApiMediaType()
                     }
@@ -326,7 +326,7 @@ public void Validate_DelegatesContentValidationToInjectedContentValidators(
             {
                 RequestBody = new OpenApiRequestBody
                 {
-                    Content = new Dictionary<string, OpenApiMediaType>
+                    Content = new Dictionary<string, OpenApiMediaType>(StringComparer.Ordinal)
                     {
                         [ "application/json" ] = new OpenApiMediaType
                         {
@@ -370,7 +370,7 @@ private OpenApiDocument DocumentWithOperation(string pathTemplate, OperationType
                 },
                 Components = new OpenApiComponents
                 {
-                    Schemas = new Dictionary<string, OpenApiSchema>()
+                    Schemas = new Dictionary<string, OpenApiSchema>(StringComparer.Ordinal)
                 }
             };
         }

diff --git a/test/DotSwashbuckle.AspNetCore.ApiTesting.Test/ResponseValidatorTests.cs b/test/DotSwashbuckle.AspNetCore.ApiTesting.Test/ResponseValidatorTests.cs
@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using System.Net;
 using System.Net.Http;
 using System.Text;
@@ -50,7 +51,7 @@ public void Validate_ThrowsException_IfRequiredHeaderIsNotPresent(
                 {
                     [ "201" ] = new OpenApiResponse
                     {
-                        Headers = new Dictionary<string, OpenApiHeader>
+                        Headers = new Dictionary<string, OpenApiHeader>(StringComparer.Ordinal)
                         {
                             [ "test-header" ] = new OpenApiHeader
                             {
@@ -94,7 +95,7 @@ public void Validate_ThrowsException_IfHeaderIsNotOfSpecifiedType(
                 {
                     [ "201" ] = new OpenApiResponse
                     {
-                        Headers = new Dictionary<string, OpenApiHeader>
+                        Headers = new Dictionary<string, OpenApiHeader>(StringComparer.Ordinal)
                         {
                             [ "test-header" ] = new OpenApiHeader
                             {
@@ -135,7 +136,7 @@ public void Validate_ThrowsException_IfExpectedContentIsNotPresent(
                 {
                     [ "200" ] = new OpenApiResponse
                     {
-                        Content = new Dictionary<string, OpenApiMediaType>
+                        Content = new Dictionary<string, OpenApiMediaType>(StringComparer.Ordinal)
                         {
                             ["text/plain"] = new OpenApiMediaType()
                         }
@@ -168,7 +169,7 @@ public void Validate_ThrowsException_IfContentMediaTypeIsNotSpecified(
                 {
                     [ "200" ] = new OpenApiResponse
                     {
-                        Content = new Dictionary<string, OpenApiMediaType>
+                        Content = new Dictionary<string, OpenApiMediaType>(StringComparer.Ordinal)
                         {
                             ["application/json"] = new OpenApiMediaType()
                         }
@@ -201,7 +202,7 @@ public void Validate_DelegatesContentValidationToInjectedContentValidators(
                 {
                     [ "200" ] = new OpenApiResponse
                     {
-                        Content = new Dictionary<string, OpenApiMediaType>
+                        Content = new Dictionary<string, OpenApiMediaType>(StringComparer.Ordinal)
                         {
                             ["application/json"] = new OpenApiMediaType
                             {
@@ -245,7 +246,7 @@ private OpenApiDocument DocumentWithOperation(string pathTemplate, OperationType
                 },
                 Components = new OpenApiComponents
                 {
-                    Schemas = new Dictionary<string, OpenApiSchema>()
+                    Schemas = new Dictionary<string, OpenApiSchema>(StringComparer.Ordinal)
                 }
             };
         }

diff --git a/...tSwashbuckle.AspNetCore.Newtonsoft.Test/SchemaGenerator/NewtonsoftSchemaGeneratorTests.cs b/...tSwashbuckle.AspNetCore.Newtonsoft.Test/SchemaGenerator/NewtonsoftSchemaGeneratorTests.cs
@@ -651,7 +651,7 @@ public void GenerateSchema_HonorsSerializerSetting_TypeNameHandling(
                 Assert.NotNull(schema.Discriminator);
                 Assert.Equal("$type", schema.Discriminator.PropertyName);
                 Assert.Equal(
-                    expected: new Dictionary<string, string>
+                    expected: new Dictionary<string, string>(StringComparer.Ordinal)
                     {
                         [string.Format(expectedDiscriminatorMappingKeyFormat, "BaseType")] = "#/components/schemas/BaseType",
                         [string.Format(expectedDiscriminatorMappingKeyFormat, "SubType1")] = "#/components/schemas/SubType1",