feat(*): add constants for Content-Type

Author: jaredcnance

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 |

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);
         }
     }
 }

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;
 

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)

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)

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);
         }        
     }
-}
+}

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";
+    }
+}

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));

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;
         }
     }
-}
+}

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));
         }
     }
-}
+}

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)

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);
     }
 }