feat(*): add constants for Content-Type

jaredcnance · jaredcnance · commit 16b47a93bdad · 2017-12-16T07:57:39.000-06:00
diff --git a/benchmarks/BenchmarkDotNet.Artifacts/results/Benchmarks.Query.QueryParser_Benchmarks-report-github.md b/benchmarks/BenchmarkDotNet.Artifacts/results/Benchmarks.Query.QueryParser_Benchmarks-report-github.md
@@ -4,13 +4,13 @@ BenchmarkDotNet=v0.10.10, OS=Mac OS X 10.12
 Processor=Intel Core i5-5257U CPU 2.70GHz (Broadwell), ProcessorCount=4
 .NET Core SDK=2.0.0
   [Host]     : .NET Core 1.1.4 (Framework 4.6.25714.03), 64bit RyuJIT
-  Job-OWXJBF : .NET Core 1.1.4 (Framework 4.6.25714.03), 64bit RyuJIT
+  Job-WKDOLS : .NET Core 1.1.4 (Framework 4.6.25714.03), 64bit RyuJIT
 
 LaunchCount=3  TargetCount=20  WarmupCount=10  
 
 ```
-|         Method |         Mean |      Error |      StdDev |       Median |
-|--------------- |-------------:|-----------:|------------:|-------------:|
-|  AscendingSort |     4.451 us |  1.5230 us |   3.2457 us |     3.305 us |
-| DescendingSort |     3.287 us |  0.0307 us |   0.0673 us |     3.263 us |
-|   ComplexQuery | 1,973.029 us | 67.5600 us | 143.9759 us | 1,952.663 us |
+|         Method |         Mean |      Error |     StdDev |    Gen 0 |   Gen 1 | Allocated |
+|--------------- |-------------:|-----------:|-----------:|---------:|--------:|----------:|
+|  AscendingSort |     4.316 us |  1.3773 us |  3.0232 us |   0.5066 |  0.1303 |   1.08 KB |
+| DescendingSort |     3.300 us |  0.0314 us |  0.0682 us |   0.5123 |  0.1318 |   1.13 KB |
+|   ComplexQuery | 2,041.642 us | 41.5631 us | 92.1010 us | 312.5000 | 80.2734 | 648.99 KB |
diff --git a/benchmarks/Program.cs b/benchmarks/Program.cs
@@ -5,9 +5,12 @@
 namespace Benchmarks {
     class Program {
         static void Main(string[] args) {
-            BenchmarkRunner.Run<JsonApiDeserializer_Benchmarks>();
-            BenchmarkRunner.Run<JsonApiSerializer_Benchmarks>();
-            BenchmarkRunner.Run<QueryParser_Benchmarks>();
+            var switcher = new BenchmarkSwitcher(new[] {
+                typeof(JsonApiDeserializer_Benchmarks),
+                typeof(JsonApiSerializer_Benchmarks),
+                typeof(QueryParser_Benchmarks)
+            });
+            switcher.Run(args);
         }
     }
 }
diff --git a/benchmarks/Query/QueryParser_Benchmarks.cs b/benchmarks/Query/QueryParser_Benchmarks.cs
@@ -12,7 +12,7 @@
 using Moq;
 
 namespace Benchmarks.Query {
-    [MarkdownExporter, SimpleJob(launchCount : 3, warmupCount : 10, targetCount : 20)]
+    [MarkdownExporter, SimpleJob(launchCount : 3, warmupCount : 10, targetCount : 20), MemoryDiagnoser]
     public class QueryParser_Benchmarks {
         private readonly BenchmarkFacade _queryParser;
 
diff --git a/src/JsonApiDotNetCore/Formatters/JsonApiInputFormatter.cs b/src/JsonApiDotNetCore/Formatters/JsonApiInputFormatter.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Threading.Tasks;
+using JsonApiDotNetCore.Internal;
 using Microsoft.AspNetCore.Mvc.Formatters;
 using Microsoft.Extensions.DependencyInjection;
 
@@ -14,7 +15,7 @@ public bool CanRead(InputFormatterContext context)
 
             var contentTypeString = context.HttpContext.Request.ContentType;
 
-            return contentTypeString == "application/vnd.api+json";
+            return contentTypeString == Constants.ContentType;
         }
 
         public async Task<InputFormatterResult> ReadAsync(InputFormatterContext context)
diff --git a/src/JsonApiDotNetCore/Formatters/JsonApiOutputFormatter.cs b/src/JsonApiDotNetCore/Formatters/JsonApiOutputFormatter.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Threading.Tasks;
+using JsonApiDotNetCore.Internal;
 using Microsoft.AspNetCore.Mvc.Formatters;
 using Microsoft.Extensions.DependencyInjection;
 
@@ -14,7 +15,7 @@ public bool CanWriteResult(OutputFormatterCanWriteContext context)
 
             var contentTypeString = context.HttpContext.Request.ContentType;
 
-            return string.IsNullOrEmpty(contentTypeString) || contentTypeString == "application/vnd.api+json";
+            return string.IsNullOrEmpty(contentTypeString) || contentTypeString == Constants.ContentType;
         }
 
         public async Task WriteAsync(OutputFormatterWriteContext context)
diff --git a/src/JsonApiDotNetCore/Formatters/JsonApiWriter.cs b/src/JsonApiDotNetCore/Formatters/JsonApiWriter.cs
@@ -13,7 +13,8 @@ public class JsonApiWriter : IJsonApiWriter
         private readonly ILogger<JsonApiWriter> _logger;
         private readonly IJsonApiSerializer _serializer;
 
-        public JsonApiWriter(IJsonApiSerializer serializer, 
+        public JsonApiWriter(
+            IJsonApiSerializer serializer, 
             ILoggerFactory loggerFactory)
         {
             _serializer = serializer;
@@ -30,7 +31,7 @@ public async Task WriteAsync(OutputFormatterWriteContext context)
             var response = context.HttpContext.Response;
             using (var writer = context.WriterFactory(response.Body, Encoding.UTF8))
             {
-                response.ContentType = "application/vnd.api+json";
+                response.ContentType = Constants.ContentType;
                 string responseContent;
                 try
                 {
@@ -55,4 +56,4 @@ private string GetResponseBody(object responseObject)
             return _serializer.Serialize(responseObject);
         }        
     }
-}
+}
diff --git a/src/JsonApiDotNetCore/Internal/Constants.cs b/src/JsonApiDotNetCore/Internal/Constants.cs
@@ -0,0 +1,8 @@
+namespace JsonApiDotNetCore.Internal
+{
+    public static class Constants
+    {
+        public const string AcceptHeader = "Accept";
+        public const string ContentType = "application/vnd.api+json";
+    }
+}
diff --git a/src/JsonApiDotNetCore/Internal/JsonApiExceptionFactory.cs b/src/JsonApiDotNetCore/Internal/JsonApiExceptionFactory.cs
@@ -5,14 +5,17 @@ namespace JsonApiDotNetCore.Internal
 {
     public static class JsonApiExceptionFactory
     {
+        private const string JsonApiException = nameof(JsonApiException);
+        private const string InvalidCastException = nameof(InvalidCastException);
+
         public static JsonApiException GetException(Exception exception)
         {
             var exceptionType = exception.GetType().ToString().Split('.').Last();
             switch(exceptionType)
             {
-                case "JsonApiException":
+                case JsonApiException:
                     return (JsonApiException)exception;
-                case "InvalidCastException":
+                case InvalidCastException:
                     return new JsonApiException(409, exception.Message);
                 default:
                     return new JsonApiException(500, exception.Message, GetExceptionDetail(exception.InnerException));
diff --git a/src/JsonApiDotNetCore/Internal/Query/BaseFilterQuery.cs b/src/JsonApiDotNetCore/Internal/Query/BaseFilterQuery.cs
@@ -8,10 +8,10 @@ protected FilterOperations GetFilterOperation(string prefix)
         {
             if (prefix.Length == 0) return FilterOperations.eq;
 
-            if (!Enum.TryParse(prefix, out FilterOperations opertion))
+            if (Enum.TryParse(prefix, out FilterOperations opertion) == false)
                 throw new JsonApiException(400, $"Invalid filter prefix '{prefix}'");
 
             return opertion;
         }
     }
-}
+}
diff --git a/src/JsonApiDotNetCore/Internal/Query/RelatedAttrFilterQuery.cs b/src/JsonApiDotNetCore/Internal/Query/RelatedAttrFilterQuery.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Linq;
 using JsonApiDotNetCore.Models;
 using JsonApiDotNetCore.Services;
@@ -14,7 +15,7 @@ public RelatedAttrFilterQuery(
         {
             _jsonApiContext = jsonApiCopntext;
 
-            var relationshipArray = filterQuery.Key.Split('.');
+            var relationshipArray = filterQuery.Attribute.Split('.');
 
             var relationship = GetRelationship(relationshipArray[0]);
             if (relationship == null)
@@ -36,14 +37,14 @@ public RelatedAttrFilterQuery(
         private RelationshipAttribute GetRelationship(string propertyName)
         {
             return _jsonApiContext.RequestEntity.Relationships
-              .FirstOrDefault(r => r.InternalRelationshipName.ToLower() == propertyName.ToLower());
+              .FirstOrDefault(r => string.Equals(r.PublicRelationshipName, propertyName, StringComparison.OrdinalIgnoreCase));
         }
 
         private AttrAttribute GetAttribute(RelationshipAttribute relationship, string attribute)
         {
             var relatedContextExntity = _jsonApiContext.ContextGraph.GetContextEntity(relationship.Type);
             return relatedContextExntity.Attributes
-              .FirstOrDefault(a => a.InternalAttributeName.ToLower() == attribute.ToLower());
+              .FirstOrDefault(a => string.Equals(a.PublicAttributeName, attribute, StringComparison.OrdinalIgnoreCase));
         }
     }
-}
+}
diff --git a/src/JsonApiDotNetCore/Middleware/RequestMiddleware.cs b/src/JsonApiDotNetCore/Middleware/RequestMiddleware.cs
@@ -1,4 +1,5 @@
 using System.Threading.Tasks;
+using JsonApiDotNetCore.Internal;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.Primitives;
 
@@ -37,7 +38,7 @@ private static bool IsValidContentTypeHeader(HttpContext context)
 
         private static bool IsValidAcceptHeader(HttpContext context)
         {
-            if (context.Request.Headers.TryGetValue("Accept", out StringValues acceptHeaders) == false)
+            if (context.Request.Headers.TryGetValue(Constants.AcceptHeader, out StringValues acceptHeaders) == false)
                 return true;
 
             foreach (var acceptHeader in acceptHeaders)
@@ -54,7 +55,7 @@ private static bool IsValidAcceptHeader(HttpContext context)
         private static bool ContainsMediaTypeParameters(string mediaType)
         {
             var mediaTypeArr = mediaType.Split(';');
-            return (mediaTypeArr[0] == "application/vnd.api+json" && mediaTypeArr.Length == 2);
+            return (mediaTypeArr[0] ==  Constants.ContentType && mediaTypeArr.Length == 2);
         }
 
         private static void FlushResponse(HttpContext context, int statusCode)
diff --git a/src/JsonApiDotNetCore/Models/DocumentBase.cs b/src/JsonApiDotNetCore/Models/DocumentBase.cs
@@ -15,19 +15,8 @@ public class DocumentBase
         public Dictionary<string, object> Meta { get; set; }
 
         // http://www.newtonsoft.com/json/help/html/ConditionalProperties.htm
-        public bool ShouldSerializeIncluded()
-        {
-            return (Included != null);
-        }
-
-        public bool ShouldSerializeMeta()
-        {
-            return (Meta != null);
-        }
-
-        public bool ShouldSerializeLinks()
-        {
-            return (Links != null);
-        }
+        public bool ShouldSerializeIncluded() => (Included != null);
+        public bool ShouldSerializeMeta() => (Meta != null);
+        public bool ShouldSerializeLinks() => (Links != null);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -5,9 +5,12 @@`
`5`	`5`	`namespace Benchmarks {`
`6`	`6`	`class Program {`
`7`	`7`	`static void Main(string[] args) {`
`8`		`- BenchmarkRunner.Run<JsonApiDeserializer_Benchmarks>();`
`9`		`- BenchmarkRunner.Run<JsonApiSerializer_Benchmarks>();`
`10`		`- BenchmarkRunner.Run<QueryParser_Benchmarks>();`
	`8`	`+ var switcher = new BenchmarkSwitcher(new[] {`
	`9`	`+ typeof(JsonApiDeserializer_Benchmarks),`
	`10`	`+ typeof(JsonApiSerializer_Benchmarks),`
	`11`	`+ typeof(QueryParser_Benchmarks)`
	`12`	`+ });`
	`13`	`+ switcher.Run(args);`
`11`	`14`	`}`
`12`	`15`	`}`
`13`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,8 @@ public class JsonApiWriter : IJsonApiWriter`
`13`	`13`	`private readonly ILogger<JsonApiWriter> _logger;`
`14`	`14`	`private readonly IJsonApiSerializer _serializer;`
`15`	`15`
`16`		`- public JsonApiWriter(IJsonApiSerializer serializer,`
	`16`	`+ public JsonApiWriter(`
	`17`	`+ IJsonApiSerializer serializer,`
`17`	`18`	`ILoggerFactory loggerFactory)`
`18`	`19`	`{`
`19`	`20`	`_serializer = serializer;`
`@@ -30,7 +31,7 @@ public async Task WriteAsync(OutputFormatterWriteContext context)`
`30`	`31`	`var response = context.HttpContext.Response;`
`31`	`32`	`using (var writer = context.WriterFactory(response.Body, Encoding.UTF8))`
`32`	`33`	`{`
`33`		`- response.ContentType = "application/vnd.api+json";`
	`34`	`+ response.ContentType = Constants.ContentType;`
`34`	`35`	`string responseContent;`
`35`	`36`	`try`
`36`	`37`	`{`
`@@ -55,4 +56,4 @@ private string GetResponseBody(object responseObject)`
`55`	`56`	`return _serializer.Serialize(responseObject);`
`56`	`57`	`}`
`57`	`58`	`}`
`58`		`-}`
	`59`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -5,14 +5,17 @@ namespace JsonApiDotNetCore.Internal`
`5`	`5`	`{`
`6`	`6`	`public static class JsonApiExceptionFactory`
`7`	`7`	`{`
	`8`	`+ private const string JsonApiException = nameof(JsonApiException);`
	`9`	`+ private const string InvalidCastException = nameof(InvalidCastException);`
	`10`	`+`
`8`	`11`	`public static JsonApiException GetException(Exception exception)`
`9`	`12`	`{`
`10`	`13`	`var exceptionType = exception.GetType().ToString().Split('.').Last();`
`11`	`14`	`switch(exceptionType)`
`12`	`15`	`{`
`13`		`- case "JsonApiException":`
	`16`	`+ case JsonApiException:`
`14`	`17`	`return (JsonApiException)exception;`
`15`		`- case "InvalidCastException":`
	`18`	`+ case InvalidCastException:`
`16`	`19`	`return new JsonApiException(409, exception.Message);`
`17`	`20`	`default:`
`18`	`21`	`return new JsonApiException(500, exception.Message, GetExceptionDetail(exception.InnerException));`
Original file line number	Diff line number	Diff line change
`@@ -8,10 +8,10 @@ protected FilterOperations GetFilterOperation(string prefix)`
`8`	`8`	`{`
`9`	`9`	`if (prefix.Length == 0) return FilterOperations.eq;`
`10`	`10`
`11`		`- if (!Enum.TryParse(prefix, out FilterOperations opertion))`
	`11`	`+ if (Enum.TryParse(prefix, out FilterOperations opertion) == false)`
`12`	`12`	`throw new JsonApiException(400, $"Invalid filter prefix '{prefix}'");`
`13`	`13`
`14`	`14`	`return opertion;`
`15`	`15`	`}`
`16`	`16`	`}`
`17`		`-}`
	`17`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+using System;`
`1`	`2`	`using System.Linq;`
`2`	`3`	`using JsonApiDotNetCore.Models;`
`3`	`4`	`using JsonApiDotNetCore.Services;`
`@@ -14,7 +15,7 @@ public RelatedAttrFilterQuery(`
`14`	`15`	`{`
`15`	`16`	`_jsonApiContext = jsonApiCopntext;`
`16`	`17`
`17`		`- var relationshipArray = filterQuery.Key.Split('.');`
	`18`	`+ var relationshipArray = filterQuery.Attribute.Split('.');`
`18`	`19`
`19`	`20`	`var relationship = GetRelationship(relationshipArray[0]);`
`20`	`21`	`if (relationship == null)`
`@@ -36,14 +37,14 @@ public RelatedAttrFilterQuery(`
`36`	`37`	`private RelationshipAttribute GetRelationship(string propertyName)`
`37`	`38`	`{`
`38`	`39`	`return _jsonApiContext.RequestEntity.Relationships`
`39`		`- .FirstOrDefault(r => r.InternalRelationshipName.ToLower() == propertyName.ToLower());`
	`40`	`+ .FirstOrDefault(r => string.Equals(r.PublicRelationshipName, propertyName, StringComparison.OrdinalIgnoreCase));`
`40`	`41`	`}`
`41`	`42`
`42`	`43`	`private AttrAttribute GetAttribute(RelationshipAttribute relationship, string attribute)`
`43`	`44`	`{`
`44`	`45`	`var relatedContextExntity = _jsonApiContext.ContextGraph.GetContextEntity(relationship.Type);`
`45`	`46`	`return relatedContextExntity.Attributes`
`46`		`- .FirstOrDefault(a => a.InternalAttributeName.ToLower() == attribute.ToLower());`
	`47`	`+ .FirstOrDefault(a => string.Equals(a.PublicAttributeName, attribute, StringComparison.OrdinalIgnoreCase));`
`47`	`48`	`}`
`48`	`49`	`}`
`49`		`-}`
	`50`	`+}`