Merge pull request #8 from yv989c/develop

yv989c · web-flow · commit 34a0a015bef3 · 2022-01-15T20:06:42.000-05:00
Feature/benchmarks (#7)
diff --git a/BlazarTech.QueryableValues.Benchmarks.sln b/BlazarTech.QueryableValues.Benchmarks.sln
@@ -0,0 +1,25 @@
+﻿
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.0.32014.148
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "QueryableValues.SqlServer.Benchmarks", "benchmarks\QueryableValues.SqlServer.Benchmarks\QueryableValues.SqlServer.Benchmarks.csproj", "{7C293C8A-107E-4C94-B046-7753938A4CD8}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{7C293C8A-107E-4C94-B046-7753938A4CD8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{7C293C8A-107E-4C94-B046-7753938A4CD8}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{7C293C8A-107E-4C94-B046-7753938A4CD8}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{7C293C8A-107E-4C94-B046-7753938A4CD8}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {13B09C6A-3CA7-41E5-B059-AE5616B18EB6}
+	EndGlobalSection
+EndGlobal
diff --git a/README.md b/README.md
@@ -19,9 +19,110 @@ The `AsQueryableValues` extension method is intended for queries that are depend
 
 It provides a solution to the following long standing [EF Core issue](https://github.com/dotnet/efcore/issues/13617) and enables other currently unsupported scenarios; like the ability to efficiently create joins with in-memory data.
 
-## Getting Started
+## Benchmarks
+The following [benchmarks] consist of EF Core queries that have a dependency on a random sequence of [Int32] and [Guid] values via the `Contains` LINQ method. It shows the performance differences between not using and using QueryableValues.
 
-### Installation
+### Benchmarked Libraries
+| Package | Version |
+| ------- |:-------:|
+| Microsoft.EntityFrameworkCore.SqlServer | 6.0.1 |
+| BlazarTech.QueryableValues.SqlServer | 6.3.0 |
+
+### BenchmarkDotNet Configuration and System Specs
+```
+BenchmarkDotNet=v0.13.1, OS=Windows 10.0.19042.1466 (20H2/October2020Update)
+Intel Core i7-8650U CPU 1.90GHz (Kaby Lake R), 1 CPU, 8 logical and 4 physical cores
+.NET SDK=6.0.101
+  [Host]     : .NET 6.0.1 (6.0.121.56705), X64 RyuJIT
+  Job-GMTUEM : .NET 6.0.1 (6.0.121.56705), X64 RyuJIT
+
+Server=True  InvocationCount=200  IterationCount=25
+RunStrategy=Monitoring  UnrollFactor=1  WarmupCount=1
+```
+### SQL Server Instance Specs
+```
+Microsoft SQL Server 2017 (RTM-GDR) (KB4583456) - 14.0.2037.2 (X64)
+Nov  2 2020 19:19:59
+Copyright (C) 2017 Microsoft Corporation
+Express Edition (64-bit) on Windows 10 Pro 10.0 <X64> (Build 19042: ) (Hypervisor)
+```
+- The SQL Server instance was running in the same system where the benchmark was executed.
+- Shared Memory is the only network protocol that's enabled on this instance.
+
+
+### Results for Int32
+
+![Benchmarks Int32 Values][BenchmarksInt32]
+
+<details>
+
+| Method  | Values |  Mean (us)   |  Error (us)  |  Std Dev (us)  |  Median (us)  | Ratio | RatioSD | Allocated | 
+|---------|--------|--------------|--------------|----------------|---------------|-------|---------|-----------| 
+| Without | 2      |  921.20      |  31.30       |  41.78         |  903.80       | 1.00  | 0.00    | 20 KB     | 
+| With    | 2      |  734.30      |  45.28       |  60.44         |  696.10       | 0.80  | 0.04    | 51 KB     | 
+| Without | 4      |  997.80      |  31.79       |  42.44         |  981.10       | 1.00  | 0.00    | 21 KB     | 
+| With    | 4      |  779.40      |  47.22       |  63.04         |  738.70       | 0.78  | 0.05    | 51 KB     | 
+| Without | 8      |  1,081.00    |  31.26       |  41.74         |  1,061.30     | 1.00  | 0.00    | 21 KB     | 
+| With    | 8      |  814.20      |  47.34       |  63.20         |  775.70       | 0.75  | 0.04    | 51 KB     | 
+| Without | 16     |  1,331.70    |  88.81       |  118.56        |  1,283.40     | 1.00  | 0.00    | 23 KB     | 
+| With    | 16     |  872.70      |  42.46       |  56.68         |  840.30       | 0.66  | 0.06    | 52 KB     | 
+| Without | 32     |  1,731.40    |  40.59       |  54.18         |  1,732.60     | 1.00  | 0.00    | 26 KB     | 
+| With    | 32     |  1,006.00    |  47.61       |  63.56         |  973.60       | 0.58  | 0.03    | 53 KB     | 
+| Without | 64     |  2,615.40    |  103.77      |  138.53        |  2,540.20     | 1.00  | 0.00    | 31 KB     | 
+| With    | 64     |  1,264.20    |  36.95       |  49.33         |  1,239.90     | 0.48  | 0.03    | 55 KB     | 
+| Without | 128    |  5,687.30    |  200.05      |  267.06        |  5,588.20     | 1.00  | 0.00    | 41 KB     | 
+| With    | 128    |  1,917.00    |  34.06       |  45.47         |  1,897.90     | 0.34  | 0.02    | 60 KB     | 
+| Without | 256    |  10,565.00   |  186.05      |  248.37        |  10,473.00    | 1.00  | 0.00    | 63 KB     | 
+| With    | 256    |  2,977.00    |  29.38       |  39.23         |  2,964.50     | 0.28  | 0.01    | 69 KB     | 
+| Without | 512    |  20,110.50   |  452.28      |  603.79        |  20,108.30    | 1.00  | 0.00    | 106 KB    | 
+| With    | 512    |  5,313.10    |  47.66       |  63.62         |  5,340.80     | 0.26  | 0.01    | 88 KB     | 
+| Without | 1024   |  46,599.30   |  4,286.13    |  5,721.87      |  48,194.20    | 1.00  | 0.00    | 192 KB    | 
+| With    | 1024   |  11,614.40   |  85.81       |  114.55        |  11,619.80    | 0.25  | 0.03    | 128 KB    | 
+| Without | 2048   |  105,096.90  |  5,359.60    |  7,154.92      |  106,405.10   | 1.00  | 0.00    | 363 KB    | 
+| With    | 2048   |  19,481.40   |  66.66       |  88.99         |  19,474.80    | 0.19  | 0.01    | 213 KB    | 
+| Without | 4096   |  177,245.80  |  1,812.40    |  2,419.51      |  176,767.90   | 1.00  | 0.00    | 706 KB    | 
+| With    | 4096   |  38,743.00   |  2,422.07    |  3,233.40      |  37,414.70    | 0.22  | 0.02    | 368 KB    | 
+
+</details>
+
+### Results for Guid
+
+![Benchmarks Guid Values][BenchmarksGuid]
+
+<details>
+
+| Method  | Values |  Mean (us)   |  Error (us)  |  Std Dev (us)  |  Median (us)  | Ratio | RatioSD | Allocated | 
+|---------|--------|--------------|--------------|----------------|---------------|-------|---------|-----------| 
+| Without | 2      |  895.60      |  30.64       |  40.91         |  877.90       | 1.00  | 0.00    | 21 KB     | 
+| With    | 2      |  741.80      |  46.44       |  62.00         |  704.40       | 0.83  | 0.04    | 51 KB     | 
+| Without | 4      |  968.90      |  33.69       |  44.97         |  950.40       | 1.00  | 0.00    | 22 KB     | 
+| With    | 4      |  727.00      |  43.20       |  57.68         |  689.80       | 0.75  | 0.04    | 52 KB     | 
+| Without | 8      |  1,075.50    |  34.88       |  46.57         |  1,054.90     | 1.00  | 0.00    | 23 KB     | 
+| With    | 8      |  773.10      |  42.45       |  56.67         |  737.10       | 0.72  | 0.04    | 53 KB     | 
+| Without | 16     |  1,372.60    |  66.21       |  88.39         |  1,383.80     | 1.00  | 0.00    | 26 KB     | 
+| With    | 16     |  808.90      |  40.12       |  53.55         |  777.80       | 0.59  | 0.06    | 55 KB     | 
+| Without | 32     |  1,710.70    |  26.25       |  35.04         |  1,699.90     | 1.00  | 0.00    | 33 KB     | 
+| With    | 32     |  869.80      |  49.27       |  65.78         |  830.40       | 0.51  | 0.03    | 59 KB     | 
+| Without | 64     |  2,656.60    |  30.28       |  40.43         |  2,652.30     | 1.00  | 0.00    | 47 KB     | 
+| With    | 64     |  1,038.70    |  58.99       |  78.75         |  994.40       | 0.39  | 0.03    | 67 KB     | 
+| Without | 128    |  5,415.90    |  45.76       |  61.09         |  5,417.00     | 1.00  | 0.00    | 74 KB     | 
+| With    | 128    |  1,456.30    |  53.76       |  71.77         |  1,424.10     | 0.27  | 0.02    | 84 KB     | 
+| Without | 256    |  9,461.50    |  45.09       |  60.20         |  9,469.10     | 1.00  | 0.00    | 128 KB    | 
+| With    | 256    |  2,156.00    |  36.01       |  48.07         |  2,139.30     | 0.23  | 0.00    | 120 KB    | 
+| Without | 512    |  18,015.10   |  117.47      |  156.82        |  17,946.50    | 1.00  | 0.00    | 219 KB    | 
+| With    | 512    |  3,511.30    |  62.41       |  83.32         |  3,460.80     | 0.19  | 0.00    | 197 KB    | 
+| Without | 1024   |  44,525.60   |  754.94      |  1,007.82      |  44,601.80    | 1.00  | 0.00    | 419 KB    | 
+| With    | 1024   |  7,825.80    |  72.45       |  96.72         |  7,808.20     | 0.18  | 0.00    | 319 KB    | 
+| Without | 2048   |  83,843.30   |  778.80      |  1,039.68      |  83,954.70    | 1.00  | 0.00    | 801 KB    | 
+| With    | 2048   |  12,372.40   |  207.91      |  277.55        |  12,232.20    | 0.15  | 0.00    | 596 KB    | 
+| Without | 4096   |  217,255.80  |  3,458.95    |  4,617.60      |  216,353.20   | 1.00  | 0.00    | 1,566 KB  | 
+| With    | 4096   |  24,981.10   |  274.10      |  365.92        |  25,116.70    | 0.12  | 0.00    | 1,132 KB  | 
+
+</details>
+
+# Getting Started
+
+## Installation
 QueryableValues is distributed as a [NuGet Package]. The major version number of this library is aligned with the version of [Entity Framework Core] by which it's supported (e.g. If you are using EF Core 5, then you must use version 5 of QueryableValues).
 
 Please choose the appropriate command below to install it using the NuGet Package Manager Console window in Visual Studio:
@@ -32,7 +133,7 @@ EF Core | Command
 5.x | `Install-Package BlazarTech.QueryableValues.SqlServer -Version 5.3.0`
 6.x | `Install-Package BlazarTech.QueryableValues.SqlServer -Version 6.3.0`
 
-### Configuration
+## Configuration
 Look for the place in your code where you are setting up your [DbContext] and calling the [UseSqlServer] extension method, then use a lambda expression to access the `SqlServerDbContextOptionsBuilder` provided by it. It is on this builder that you must call the `UseQueryableValues` extension method as shown in the following simplified examples:
 
 When using the `OnConfiguring` method inside your [DbContext]:
@@ -74,15 +175,15 @@ public class Startup
 }
 ```
 
-### How Do You Use It?
+## How Do You Use It?
 The `AsQueryableValues` extension method is provided by the `BlazarTech.QueryableValues` namespace; therefore, you must add the following `using` directive to your source code file for it to appear as a method of your [DbContext] instance:
 ```
 using BlazarTech.QueryableValues;
 ```
 
 Below are a few examples composing a query using the values provided by an [IEnumerable\<T\>].
 
-#### Simple Type Examples
+### Simple Type Examples
 Using the [Contains][ContainsQueryable] LINQ method:
 
 ```c#
@@ -141,7 +242,7 @@ var myQuery2 =
         i.PropA
     };
 ```
-#### Complex Type Example
+### Complex Type Example
 ```c#
 // Performance Tip:
 // If your IEnumerable<T> item type (T) has many properties, project only 
@@ -321,3 +422,6 @@ PRs are welcome! 🙂
 [Guid]: https://docs.microsoft.com/en-us/dotnet/api/system.guid
 [Char]: https://docs.microsoft.com/en-us/dotnet/api/system.char
 [String]: https://docs.microsoft.com/en-us/dotnet/api/system.string
+[benchmarks]: /benchmarks/QueryableValues.SqlServer.Benchmarks
+[BenchmarksInt32]: /docs/images/benchmarks/int32-v6.3.0.png
+[BenchmarksGuid]: /docs/images/benchmarks/guid-v6.3.0.png
diff --git a/benchmarks/QueryableValues.SqlServer.Benchmarks/ContainsBenchmarks.cs b/benchmarks/QueryableValues.SqlServer.Benchmarks/ContainsBenchmarks.cs
@@ -0,0 +1,124 @@
+﻿using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Configs;
+using BenchmarkDotNet.Engines;
+using BlazarTech.QueryableValues;
+using Microsoft.Data.SqlClient;
+using Microsoft.EntityFrameworkCore;
+
+namespace QueryableValues.SqlServer.Benchmarks;
+
+[SimpleJob(RunStrategy.Monitoring, warmupCount: 1, targetCount: 25, invocationCount: 200)]
+[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory)]
+[GcServer(true), MemoryDiagnoser]
+public class ContainsBenchmarks
+{
+#pragma warning disable CS8618
+    private IQueryable<Int32Entity> _int32Query;
+    private IQueryable<GuidEntity> _guidQuery;
+    private IQueryable<Int32Entity> _queryableValuesInt32Query;
+    private IQueryable<GuidEntity> _queryableValuesGuidQuery;
+#pragma warning restore CS8618
+
+    [Params(2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096)]
+    public int NumberOfValues { get; set; }
+
+    private IEnumerable<int> GetIntValues()
+    {
+        for (var i = 0; i < NumberOfValues; i++)
+        {
+            yield return Random.Shared.Next(10000);
+        }
+    }
+
+    private IEnumerable<Guid> GetGuidValues()
+    {
+        for (var i = 0; i < NumberOfValues; i++)
+        {
+            yield return Guid.NewGuid();
+        }
+    }
+
+    [GlobalSetup]
+    public void GlobalSetup()
+    {
+        Console.WriteLine("Initializing...");
+
+        var dbContext = new MyDbContext();
+
+        #region Init db
+        {
+            var wasCreated = dbContext.Database.EnsureCreated();
+
+            if (wasCreated)
+            {
+                for (int i = 0; i < 1000; i++)
+                {
+                    dbContext.Add(new Int32Entity());
+                    dbContext.Add(new GuidEntity());
+                }
+
+                dbContext.SaveChanges();
+            }
+
+            var versionParam = new SqlParameter("@Version", System.Data.SqlDbType.NVarChar, -1)
+            {
+                Direction = System.Data.ParameterDirection.Output
+            };
+
+            dbContext.Database.ExecuteSqlRaw("SET @Version = @@VERSION;", versionParam);
+
+            Console.WriteLine(versionParam.Value);
+
+            dbContext.Database.ExecuteSqlRaw("DBCC FREEPROCCACHE; DBCC DROPCLEANBUFFERS;");
+        }
+        #endregion
+
+        #region Int32 Queries
+        {
+            var intValues = GetIntValues();
+
+            _int32Query = dbContext.Int32Entities
+                .Where(i => intValues.Contains(i.Id));
+
+            _queryableValuesInt32Query = dbContext.Int32Entities
+                .Where(i => dbContext.AsQueryableValues(intValues).Contains(i.Id));
+        }
+        #endregion
+
+        #region Guid Queries
+        {
+            var guidValues = GetGuidValues();
+
+            _guidQuery = dbContext.GuidEntities
+                .Where(i => guidValues.Contains(i.Id));
+
+            _queryableValuesGuidQuery = dbContext.GuidEntities
+                .Where(i => dbContext.AsQueryableValues(guidValues).Contains(i.Id));
+        }
+        #endregion
+    }
+
+    [Benchmark(Baseline = true), BenchmarkCategory("Int32")]
+    public void Without_Int32()
+    {
+        _int32Query.Any();
+    }
+
+    [Benchmark, BenchmarkCategory("Int32")]
+    public void With_Int32()
+    {
+        _queryableValuesInt32Query.Any();
+    }
+
+    [Benchmark(Baseline = true), BenchmarkCategory("Guid")]
+    public void Without_Guid()
+    {
+        _guidQuery.Any();
+    }
+
+    [Benchmark, BenchmarkCategory("Guid")]
+    public void With_Guid()
+    {
+        _queryableValuesGuidQuery.Any();
+    }
+}
diff --git a/benchmarks/QueryableValues.SqlServer.Benchmarks/MyDbContext.cs b/benchmarks/QueryableValues.SqlServer.Benchmarks/MyDbContext.cs
@@ -0,0 +1,36 @@
+﻿using BlazarTech.QueryableValues;
+using Microsoft.EntityFrameworkCore;
+
+namespace QueryableValues.SqlServer.Benchmarks
+{
+    public class MyDbContext : DbContext
+    {
+#pragma warning disable CS8618
+        public DbSet<Int32Entity> Int32Entities { get; set; }
+        public DbSet<GuidEntity> GuidEntities { get; set; }
+#pragma warning restore CS8618
+
+        protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
+        {
+            optionsBuilder.UseSqlServer(
+                @"Server=.\SQLEXPRESS;Integrated Security=true;Database=QueryableValuesBenchmarks",
+                builder => builder.UseQueryableValues()
+                );
+        }
+
+        protected override void OnModelCreating(ModelBuilder modelBuilder)
+        {
+            modelBuilder.HasDefaultSchema("dbo");
+        }
+    }
+
+    public class Int32Entity
+    {
+        public int Id { get; set; }
+    }
+
+    public class GuidEntity
+    {
+        public Guid Id { get; set; }
+    }
+}
diff --git a/benchmarks/QueryableValues.SqlServer.Benchmarks/Program.cs b/benchmarks/QueryableValues.SqlServer.Benchmarks/Program.cs
@@ -0,0 +1,11 @@
+﻿using BenchmarkDotNet.Running;
+
+namespace QueryableValues.SqlServer.Benchmarks;
+
+class Program
+{
+    static void Main(string[] args)
+    {
+        var summary = BenchmarkRunner.Run<ContainsBenchmarks>();
+    }
+}
diff --git a/benchmarks/QueryableValues.SqlServer.Benchmarks/QueryableValues.SqlServer.Benchmarks.csproj b/benchmarks/QueryableValues.SqlServer.Benchmarks/QueryableValues.SqlServer.Benchmarks.csproj
@@ -0,0 +1,16 @@
+﻿<Project Sdk="Microsoft.NET.Sdk">
+
+	<PropertyGroup>
+		<OutputType>Exe</OutputType>
+		<TargetFramework>net6.0</TargetFramework>
+		<ImplicitUsings>enable</ImplicitUsings>
+		<Nullable>enable</Nullable>
+	</PropertyGroup>
+
+	<ItemGroup>
+		<PackageReference Include="BenchmarkDotNet" Version="0.13.1" />
+		<PackageReference Include="BlazarTech.QueryableValues.SqlServer" Version="6.3.0" />
+		<PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="6.0.1" />
+	</ItemGroup>
+
+</Project>
diff --git a/docs/images/benchmarks/guid-v6.3.0.png b/docs/images/benchmarks/guid-v6.3.0.png
diff --git a/docs/images/benchmarks/int32-v6.3.0.png b/docs/images/benchmarks/int32-v6.3.0.png
