Removed more case-insensitive string comparisons. They are tricky, because they hide potential usages of property names instead of resource names, which only works with the default camel-case convention but breaks on kebab casing.

Bart Koelman · Bart Koelman · commit e0a139b5fd9a · 2020-04-08T13:20:19.000+02:00
diff --git a/src/JsonApiDotNetCore/Formatters/JsonApiInputFormatter.cs b/src/JsonApiDotNetCore/Formatters/JsonApiInputFormatter.cs
@@ -15,7 +15,7 @@ public bool CanRead(InputFormatterContext context)
 
             var contentTypeString = context.HttpContext.Request.ContentType;
 
-            return contentTypeString == Constants.ContentType;
+            return contentTypeString == HeaderConstants.ContentType;
         }
 
         public async Task<InputFormatterResult> ReadAsync(InputFormatterContext context)
diff --git a/src/JsonApiDotNetCore/Formatters/JsonApiOutputFormatter.cs b/src/JsonApiDotNetCore/Formatters/JsonApiOutputFormatter.cs
@@ -15,7 +15,7 @@ public bool CanWriteResult(OutputFormatterCanWriteContext context)
 
             var contentTypeString = context.HttpContext.Request.ContentType;
 
-            return string.IsNullOrEmpty(contentTypeString) || contentTypeString == Constants.ContentType;
+            return string.IsNullOrEmpty(contentTypeString) || contentTypeString == HeaderConstants.ContentType;
         }
         public async Task WriteAsync(OutputFormatterWriteContext context)
         {
diff --git a/src/JsonApiDotNetCore/Formatters/JsonApiWriter.cs b/src/JsonApiDotNetCore/Formatters/JsonApiWriter.cs
@@ -50,7 +50,7 @@ public async Task WriteAsync(OutputFormatterWriteContext context)
             }
             else
             {
-                response.ContentType = Constants.ContentType;
+                response.ContentType = HeaderConstants.ContentType;
                 try
                 {
                     responseContent = SerializeResponse(context.Object, (HttpStatusCode)response.StatusCode);
diff --git a/src/JsonApiDotNetCore/Internal/Contracts/IResourceContextProvider.cs b/src/JsonApiDotNetCore/Internal/Contracts/IResourceContextProvider.cs
@@ -16,7 +16,7 @@ public interface IResourceContextProvider
         /// <summary>
         /// Get the resource metadata by the DbSet property name
         /// </summary>
-        ResourceContext GetResourceContext(string exposedResourceName);
+        ResourceContext GetResourceContext(string resourceName);
 
         /// <summary>
         /// Get the resource metadata by the resource type
diff --git a/src/JsonApiDotNetCore/Internal/HeaderConstants.cs b/src/JsonApiDotNetCore/Internal/HeaderConstants.cs
@@ -1,6 +1,6 @@
 namespace JsonApiDotNetCore.Internal
 {
-    public static class Constants
+    public static class HeaderConstants
     {
         public const string AcceptHeader = "Accept";
         public const string ContentType = "application/vnd.api+json";
diff --git a/src/JsonApiDotNetCore/Internal/ResourceGraph.cs b/src/JsonApiDotNetCore/Internal/ResourceGraph.cs
@@ -15,20 +15,20 @@ public class ResourceGraph : IResourceGraph
         internal List<ValidationResult> ValidationResults { get; }
         private List<ResourceContext> Resources { get; }
 
-        public ResourceGraph(List<ResourceContext> entities, List<ValidationResult> validationResults = null)
+        public ResourceGraph(List<ResourceContext> resources, List<ValidationResult> validationResults = null)
         {
-            Resources = entities;
+            Resources = resources;
             ValidationResults = validationResults;
         }
 
         /// <inheritdoc />
         public ResourceContext[] GetResourceContexts() => Resources.ToArray();
         /// <inheritdoc />
-        public ResourceContext GetResourceContext(string entityName)
-            => Resources.SingleOrDefault(e => string.Equals(e.ResourceName, entityName, StringComparison.OrdinalIgnoreCase));
+        public ResourceContext GetResourceContext(string resourceName)
+            => Resources.SingleOrDefault(e => e.ResourceName == resourceName);
         /// <inheritdoc />
-        public ResourceContext GetResourceContext(Type entityType)
-            => Resources.SingleOrDefault(e => e.ResourceType == entityType);
+        public ResourceContext GetResourceContext(Type resourceType)
+            => Resources.SingleOrDefault(e => e.ResourceType == resourceType);
         /// <inheritdoc />
         public ResourceContext GetResourceContext<TResource>() where TResource : class, IIdentifiable
             => GetResourceContext(typeof(TResource));
diff --git a/src/JsonApiDotNetCore/Middleware/CurrentRequestMiddleware.cs b/src/JsonApiDotNetCore/Middleware/CurrentRequestMiddleware.cs
@@ -149,7 +149,7 @@ private static async Task<bool> IsValidContentTypeHeaderAsync(HttpContext contex
                 await FlushResponseAsync(context, new Error(HttpStatusCode.UnsupportedMediaType)
                 {
                     Title = "The specified Content-Type header value is not supported.",
-                    Detail = $"Please specify '{Constants.ContentType}' for the Content-Type header value."
+                    Detail = $"Please specify '{HeaderConstants.ContentType}' for the Content-Type header value."
                 });
 
                 return false;
@@ -159,7 +159,7 @@ private static async Task<bool> IsValidContentTypeHeaderAsync(HttpContext contex
 
         private static async Task<bool> IsValidAcceptHeaderAsync(HttpContext context)
         {
-            if (context.Request.Headers.TryGetValue(Constants.AcceptHeader, out StringValues acceptHeaders) == false)
+            if (context.Request.Headers.TryGetValue(HeaderConstants.AcceptHeader, out StringValues acceptHeaders) == false)
                 return true;
 
             foreach (var acceptHeader in acceptHeaders)
@@ -172,7 +172,7 @@ private static async Task<bool> IsValidAcceptHeaderAsync(HttpContext context)
                 await FlushResponseAsync(context, new Error(HttpStatusCode.NotAcceptable)
                 {
                     Title = "The specified Accept header value is not supported.",
-                    Detail = $"Please specify '{Constants.ContentType}' for the Accept header value."
+                    Detail = $"Please specify '{HeaderConstants.ContentType}' for the Accept header value."
                 });
                 return false;
             }
@@ -184,19 +184,19 @@ private static bool ContainsMediaTypeParameters(string mediaType)
             var incomingMediaTypeSpan = mediaType.AsSpan();
 
             // if the content type is not application/vnd.api+json then continue on
-            if (incomingMediaTypeSpan.Length < Constants.ContentType.Length)
+            if (incomingMediaTypeSpan.Length < HeaderConstants.ContentType.Length)
             {
                 return false;
             }
 
-            var incomingContentType = incomingMediaTypeSpan.Slice(0, Constants.ContentType.Length);
-            if (incomingContentType.SequenceEqual(Constants.ContentType.AsSpan()) == false)
+            var incomingContentType = incomingMediaTypeSpan.Slice(0, HeaderConstants.ContentType.Length);
+            if (incomingContentType.SequenceEqual(HeaderConstants.ContentType.AsSpan()) == false)
                 return false;
 
             // anything appended to "application/vnd.api+json;" will be considered a media type param
             return (
-                incomingMediaTypeSpan.Length >= Constants.ContentType.Length + 2
-                && incomingMediaTypeSpan[Constants.ContentType.Length] == ';'
+                incomingMediaTypeSpan.Length >= HeaderConstants.ContentType.Length + 2
+                && incomingMediaTypeSpan[HeaderConstants.ContentType.Length] == ';'
             );
         }
 
diff --git a/src/JsonApiDotNetCore/Middleware/DefaultTypeMatchFilter.cs b/src/JsonApiDotNetCore/Middleware/DefaultTypeMatchFilter.cs
@@ -41,7 +41,7 @@ public void OnActionExecuting(ActionExecutingContext context)
 
         private bool IsJsonApiRequest(HttpRequest request)
         {
-            return (request.ContentType?.Equals(Constants.ContentType, StringComparison.OrdinalIgnoreCase) == true);
+            return request.ContentType == HeaderConstants.ContentType;
         }
 
         public void OnActionExecuted(ActionExecutedContext context) { /* noop */ }
diff --git a/src/JsonApiDotNetCore/Models/Annotation/HasManyThroughAttribute.cs b/src/JsonApiDotNetCore/Models/Annotation/HasManyThroughAttribute.cs
@@ -77,8 +77,8 @@ public HasManyThroughAttribute(string publicName, string internalThroughName, Li
         public override object GetValue(object entity)
         {
             var throughNavigationProperty = entity.GetType()
-                                        .GetProperties()
-                                        .SingleOrDefault(p => string.Equals(p.Name, InternalThroughName, StringComparison.OrdinalIgnoreCase));
+                .GetProperties()
+                .SingleOrDefault(p => p.Name == InternalThroughName);
 
             var throughEntities = throughNavigationProperty.GetValue(entity);
 
diff --git a/src/JsonApiDotNetCore/QueryParameterServices/Common/QueryParameterParser.cs b/src/JsonApiDotNetCore/QueryParameterServices/Common/QueryParameterParser.cs
@@ -33,7 +33,7 @@ public virtual void Parse(DisableQueryAttribute disableQueryAttribute)
 
             foreach (var pair in _queryStringAccessor.Query)
             {
-                if (string.IsNullOrWhiteSpace(pair.Value))
+                if (string.IsNullOrEmpty(pair.Value))
                 {
                     throw new InvalidQueryStringParameterException(pair.Key, "Missing query string parameter value.",
                         $"Missing value for '{pair.Key}' query string parameter.");
diff --git a/src/JsonApiDotNetCore/QueryParameterServices/FilterService.cs b/src/JsonApiDotNetCore/QueryParameterServices/FilterService.cs
@@ -83,8 +83,7 @@ private List<FilterQuery> GetFilterQueries(string parameterName, StringValues pa
             var queries = new List<FilterQuery>();
             // InArray case
             string op = GetFilterOperation(parameterValue);
-            if (string.Equals(op, FilterOperation.@in.ToString(), StringComparison.OrdinalIgnoreCase)
-                || string.Equals(op, FilterOperation.nin.ToString(), StringComparison.OrdinalIgnoreCase))
+            if (op == FilterOperation.@in.ToString() || op == FilterOperation.nin.ToString())
             {
                 var (_, filterValue) = ParseFilterOperation(parameterValue);
                 queries.Add(new FilterQuery(propertyName, filterValue, op));
diff --git a/test/JsonApiDotNetCoreExampleTests/Acceptance/Extensibility/CustomControllerTests.cs b/test/JsonApiDotNetCoreExampleTests/Acceptance/Extensibility/CustomControllerTests.cs
@@ -160,7 +160,7 @@ public async Task ApiController_attribute_transforms_NotFound_action_result_with
             var server = new TestServer(builder);
             var client = server.CreateClient();
             var request = new HttpRequestMessage(HttpMethod.Patch, route) {Content = new StringContent(content)};
-            request.Content.Headers.ContentType = new MediaTypeHeaderValue(Constants.ContentType);
+            request.Content.Headers.ContentType = new MediaTypeHeaderValue(HeaderConstants.ContentType);
 
             // Act
             var response = await client.SendAsync(request);
diff --git a/test/JsonApiDotNetCoreExampleTests/Acceptance/ModelStateValidationTests.cs b/test/JsonApiDotNetCoreExampleTests/Acceptance/ModelStateValidationTests.cs
@@ -36,7 +36,7 @@ public async Task When_posting_tag_with_invalid_name_it_must_fail()
             {
                 Content = new StringContent(content)
             };
-            request.Content.Headers.ContentType = new MediaTypeHeaderValue(Constants.ContentType);
+            request.Content.Headers.ContentType = new MediaTypeHeaderValue(HeaderConstants.ContentType);
 
             var options = (JsonApiOptions)_factory.GetService<IJsonApiOptions>();
             options.ValidateModelState = true;
@@ -72,7 +72,7 @@ public async Task When_posting_tag_with_invalid_name_without_model_state_validat
             {
                 Content = new StringContent(content)
             };
-            request.Content.Headers.ContentType = new MediaTypeHeaderValue(Constants.ContentType);
+            request.Content.Headers.ContentType = new MediaTypeHeaderValue(HeaderConstants.ContentType);
 
             var options = (JsonApiOptions)_factory.GetService<IJsonApiOptions>();
             options.ValidateModelState = false;
@@ -110,7 +110,7 @@ public async Task When_patching_tag_with_invalid_name_it_must_fail()
             {
                 Content = new StringContent(content)
             };
-            request.Content.Headers.ContentType = new MediaTypeHeaderValue(Constants.ContentType);
+            request.Content.Headers.ContentType = new MediaTypeHeaderValue(HeaderConstants.ContentType);
 
             var options = (JsonApiOptions)_factory.GetService<IJsonApiOptions>();
             options.ValidateModelState = true;
@@ -156,7 +156,7 @@ public async Task When_patching_tag_with_invalid_name_without_model_state_valida
             {
                 Content = new StringContent(content)
             };
-            request.Content.Headers.ContentType = new MediaTypeHeaderValue(Constants.ContentType);
+            request.Content.Headers.ContentType = new MediaTypeHeaderValue(HeaderConstants.ContentType);
 
             var options = (JsonApiOptions)_factory.GetService<IJsonApiOptions>();
             options.ValidateModelState = false;

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public bool CanRead(InputFormatterContext context)`
`15`	`15`
`16`	`16`	`var contentTypeString = context.HttpContext.Request.ContentType;`
`17`	`17`
`18`		`- return contentTypeString == Constants.ContentType;`
	`18`	`+ return contentTypeString == HeaderConstants.ContentType;`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`public async Task<InputFormatterResult> ReadAsync(InputFormatterContext context)`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public bool CanWriteResult(OutputFormatterCanWriteContext context)`
`15`	`15`
`16`	`16`	`var contentTypeString = context.HttpContext.Request.ContentType;`
`17`	`17`
`18`		`- return string.IsNullOrEmpty(contentTypeString) \|\| contentTypeString == Constants.ContentType;`
	`18`	`+ return string.IsNullOrEmpty(contentTypeString) \|\| contentTypeString == HeaderConstants.ContentType;`
`19`	`19`	`}`
`20`	`20`	`public async Task WriteAsync(OutputFormatterWriteContext context)`
`21`	`21`	`{`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ public async Task WriteAsync(OutputFormatterWriteContext context)`
`50`	`50`	`}`
`51`	`51`	`else`
`52`	`52`	`{`
`53`		`- response.ContentType = Constants.ContentType;`
	`53`	`+ response.ContentType = HeaderConstants.ContentType;`
`54`	`54`	`try`
`55`	`55`	`{`
`56`	`56`	`responseContent = SerializeResponse(context.Object, (HttpStatusCode)response.StatusCode);`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`namespace JsonApiDotNetCore.Internal`
`2`	`2`	`{`
`3`		`- public static class Constants`
	`3`	`+ public static class HeaderConstants`
`4`	`4`	`{`
`5`	`5`	`public const string AcceptHeader = "Accept";`
`6`	`6`	`public const string ContentType = "application/vnd.api+json";`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public void OnActionExecuting(ActionExecutingContext context)`
`41`	`41`
`42`	`42`	`private bool IsJsonApiRequest(HttpRequest request)`
`43`	`43`	`{`
`44`		`- return (request.ContentType?.Equals(Constants.ContentType, StringComparison.OrdinalIgnoreCase) == true);`
	`44`	`+ return request.ContentType == HeaderConstants.ContentType;`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`public void OnActionExecuted(ActionExecutedContext context) { /* noop */ }`
Original file line number	Diff line number	Diff line change
`@@ -77,8 +77,8 @@ public HasManyThroughAttribute(string publicName, string internalThroughName, Li`
`77`	`77`	`public override object GetValue(object entity)`
`78`	`78`	`{`
`79`	`79`	`var throughNavigationProperty = entity.GetType()`
`80`		`- .GetProperties()`
`81`		`- .SingleOrDefault(p => string.Equals(p.Name, InternalThroughName, StringComparison.OrdinalIgnoreCase));`
	`80`	`+ .GetProperties()`
	`81`	`+ .SingleOrDefault(p => p.Name == InternalThroughName);`
`82`	`82`
`83`	`83`	`var throughEntities = throughNavigationProperty.GetValue(entity);`
`84`	`84`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public virtual void Parse(DisableQueryAttribute disableQueryAttribute)`
`33`	`33`
`34`	`34`	`foreach (var pair in _queryStringAccessor.Query)`
`35`	`35`	`{`
`36`		`- if (string.IsNullOrWhiteSpace(pair.Value))`
	`36`	`+ if (string.IsNullOrEmpty(pair.Value))`
`37`	`37`	`{`
`38`	`38`	`throw new InvalidQueryStringParameterException(pair.Key, "Missing query string parameter value.",`
`39`	`39`	`$"Missing value for '{pair.Key}' query string parameter.");`