bench(QueryParser): add sort benchmarks

Author: jaredcnance

benchmarks/.gitignore

@@ -1,4 +1,7 @@
 _data/
+*-report-default.md
+*-report.csv
+*-report.html
 
 ## Ignore Visual Studio temporary files, build results, and
 ## files generated by popular Visual Studio add-ons.

benchmarks/BenchmarkDotNet.Artifacts/results/Benchmarks.Query.QueryParser_Benchmarks-report-github.md

@@ -0,0 +1,15 @@
+``` ini
+
+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-HURVUO : .NET Core 1.1.4 (Framework 4.6.25714.03), 64bit RyuJIT
+
+LaunchCount=3  TargetCount=20  WarmupCount=10  
+
+```
+|         Method |     Mean |     Error |    StdDev |
+|--------------- |---------:|----------:|----------:|
+|  AscendingSort | 3.146 us | 0.0326 us | 0.0709 us |
+| DescendingSort | 3.372 us | 0.1228 us | 0.2618 us |

benchmarks/Benchmarks.csproj

@@ -3,6 +3,7 @@
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>$(NetCoreAppVersion)</TargetFramework>
+    <AssemblyName>Benchmarks</AssemblyName>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="BenchmarkDotNet" Version="0.10.10" />

benchmarks/Program.cs

@@ -1,11 +1,13 @@
 using BenchmarkDotNet.Running;
+using Benchmarks.Query;
 using Benchmarks.Serialization;
 
 namespace Benchmarks {
     class Program {
         static void Main(string[] args) {
             BenchmarkRunner.Run<JsonApiDeserializer_Benchmarks>();
             BenchmarkRunner.Run<JsonApiSerializer_Benchmarks>();
+            BenchmarkRunner.Run<QueryParser_Benchmarks>();
         }
     }
 }

benchmarks/Query/QueryParser_Benchmarks.cs

@@ -0,0 +1,48 @@
+using System.Collections.Generic;
+using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Attributes.Exporters;
+using BenchmarkDotNet.Attributes.Jobs;
+using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.Internal;
+using JsonApiDotNetCore.Models;
+using JsonApiDotNetCore.Services;
+using Moq;
+
+namespace Benchmarks.Query {
+    [MarkdownExporter, SimpleJob(launchCount : 3, warmupCount : 10, targetCount : 20)]
+    public class QueryParser_Benchmarks {
+        private readonly BenchmarkFacade _queryParser;
+
+        private const string ATTRIBUTE = "Attribute";
+        private const string ASCENDING_SORT = ATTRIBUTE;
+        private const string DESCENDING_SORT = "-" + ATTRIBUTE;
+
+        public QueryParser_Benchmarks() {
+            var controllerContextMock = new Mock<IControllerContext>();
+            controllerContextMock.Setup(m => m.RequestEntity).Returns(new ContextEntity {
+                Attributes = new List<AttrAttribute> {
+                    new AttrAttribute(ATTRIBUTE) {
+                        InternalAttributeName = ATTRIBUTE
+                    }
+                }
+            });
+            var options = new JsonApiOptions();
+            _queryParser = new BenchmarkFacade(controllerContextMock.Object, options);
+        }
+
+        [Benchmark]
+        public void AscendingSort() => _queryParser._ParseSortParameters(ASCENDING_SORT);
+
+        [Benchmark]
+        public void DescendingSort() => _queryParser._ParseSortParameters(DESCENDING_SORT);
+
+        // this facade allows us to expose and micro-benchmark protected methods
+        private class BenchmarkFacade : QueryParser {
+            public BenchmarkFacade(
+                IControllerContext controllerContext,
+                JsonApiOptions options) : base(controllerContext, options) { }
+
+            public void _ParseSortParameters(string value) => base.ParseSortParameters(value);
+        }
+    }
+}