Update benchmarking rules

Author: inputfalken

.github/workflows/dotnet.yml

@@ -41,3 +41,42 @@ jobs:
     - name: upload nuget package
       if: github.ref_type == 'tag' && startsWith(github.ref, 'refs/tags/v')
       run: dotnet nuget push nupkgs/*.nupkg -k ${{ secrets.NUGET_API_KEY }} -s https://api.nuget.org/v3/index.json
+  benchmark:
+    name: Run Benchmark.Net benchmark example
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: 8.0.x
+      - name: Run benchmark
+        run: cd tests/DynamoDBGenerator.SourceGenerator.Benchmarks && dotnet run --exporters json --filter '*'
+
+      - name: Store benchmark result
+        uses: rhysd/github-action-benchmark@v1
+        with:
+          name: Benchmark.Net Benchmark
+          tool: 'benchmarkdotnet'
+          output-file-path: examples/benchmarkdotnet/BenchmarkDotNet.Artifacts/results/Sample.Benchmarks-report-full-compressed.json
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          auto-push: true
+          # Show alert with commit comment on detecting possible performance regression
+          alert-threshold: '200%'
+          comment-on-alert: true
+          fail-on-alert: true
+          alert-comment-cc-users: '@inputfalken'
+
+      - name: Store benchmark result - separate results repo
+        uses: rhysd/github-action-benchmark@v1
+        with:
+          name: Benchmark.Net Benchmark
+          tool: 'benchmarkdotnet'
+          output-file-path: examples/benchmarkdotnet/BenchmarkDotNet.Artifacts/results/Sample.Benchmarks-report-full-compressed.json
+          github-token: ${{ secrets.BENCHMARK_ACTION_BOT_TOKEN }}
+          auto-push: true
+          # Show alert with commit comment on detecting possible performance regression
+          alert-threshold: '200%'
+          comment-on-alert: true
+          fail-on-alert: true
+          alert-comment-cc-users: '@inputfalken'
+          gh-repository: 'github.com/benchmark-action/github-action-benchmark-results'

tests/DynamoDBGenerator.SourceGenerator.Benchmarks/Benchmarkers/Collections.cs

@@ -0,0 +1,33 @@
+using DynamoDBGenerator.Attributes;
+
+namespace DynamoDBGenerator.SourceGenerator.Benchmarks.Benchmarkers;
+
+[DynamoDBMarshaller(EntityType = typeof(Container<List<string>>))]
+public partial class StringList() : SG_VS_AWS_Benchmarker<Container<List<string>>>(
+    ContainerMarshaller.Marshall,
+    ContainerMarshaller.Unmarshall
+);
+
+[DynamoDBMarshaller(EntityType = typeof(Container<Dictionary<string, int>>))]
+public partial class StringIntDictionary() : SG_VS_AWS_Benchmarker<Container<Dictionary<string, int>>>(
+    ContainerMarshaller.Marshall,
+    ContainerMarshaller.Unmarshall
+);
+
+[DynamoDBMarshaller(EntityType = typeof(Container<HashSet<string>>))]
+public partial class StringHashSet() : SG_VS_AWS_Benchmarker<Container<HashSet<string>>>(
+    ContainerMarshaller.Marshall,
+    ContainerMarshaller.Unmarshall
+);
+
+[DynamoDBMarshaller(EntityType = typeof(Container<HashSet<int>>))]
+public partial class IntHashSet() : SG_VS_AWS_Benchmarker<Container<HashSet<int>>>(
+    ContainerMarshaller.Marshall,
+    ContainerMarshaller.Unmarshall
+);
+
+[DynamoDBMarshaller(EntityType = typeof(Container<List<KeyValuePair<string, int>>>))]
+public partial class KeyValuePairList() : SG_BenchMarker<Container<List<KeyValuePair<string, int>>>>(
+    ContainerMarshaller.Marshall,
+    ContainerMarshaller.Unmarshall
+);

tests/DynamoDBGenerator.SourceGenerator.Benchmarks/Benchmarkers/Container.cs

@@ -0,0 +1,6 @@
+namespace DynamoDBGenerator.SourceGenerator.Benchmarks.Benchmarkers;
+
+public sealed class Container<T>
+{
+    public T Value { get; set; }
+}

tests/DynamoDBGenerator.SourceGenerator.Benchmarks/Benchmarkers/Dtos/PersonBenchmarker.cs

@@ -0,0 +1,12 @@
+using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Jobs;
+using DynamoDBGenerator.SourceGenerator.Benchmarks.Models;
+
+namespace DynamoDBGenerator.SourceGenerator.Benchmarks.Benchmarkers.Dtos;
+
+//[SimpleJob(RuntimeMoniker.Net80)]
+//[MemoryDiagnoser]
+//public class PersonBenchmarker() : MarshalBenchmarker<PersonEntity>(
+//    PersonEntity.PersonEntityMarshaller.Marshall,
+//    PersonEntity.PersonEntityMarshaller.Unmarshall
+//);

tests/DynamoDBGenerator.SourceGenerator.Benchmarks/Benchmarkers/SG_BenchMarker.cs

@@ -0,0 +1,44 @@
+using Amazon.DynamoDBv2.Model;
+using AutoFixture;
+using BenchmarkDotNet.Attributes;
+
+namespace DynamoDBGenerator.SourceGenerator.Benchmarks.Benchmarkers;
+
+[ShortRunJob, MarkdownExporter, MemoryDiagnoser]
+public abstract class SG_BenchMarker<T>
+{
+    private readonly Func<T, Dictionary<string, AttributeValue>> _marshaller;
+    private readonly Func<Dictionary<string, AttributeValue>, T> _unMarshaller;
+    protected readonly T SingleElement;
+    protected readonly Dictionary<string, AttributeValue> AttributeValues;
+
+    protected SG_BenchMarker(
+        Func<T, Dictionary<string, AttributeValue>> marshaller,
+        Func<Dictionary<string, AttributeValue>, T> unMarshaller
+    )
+    {
+        _marshaller = marshaller;
+        _unMarshaller = unMarshaller;
+        SingleElement = SetupFixture().Create<T>();
+        AttributeValues = marshaller(SingleElement);
+    }
+
+    [Benchmark]
+    public Dictionary<string, AttributeValue> Marshall_Source_Generated() => _marshaller(SingleElement);
+
+    [Benchmark]
+    public T Unmarshall_Source_Generated() => _unMarshaller(AttributeValues);
+
+    private static Fixture SetupFixture()
+    {
+        var fixture = new Fixture();
+
+        // Allow recursive types
+        fixture.Behaviors
+            .OfType<ThrowingRecursionBehavior>()
+            .ToList()
+            .ForEach(b => fixture.Behaviors.Remove(b));
+        fixture.Behaviors.Add(new OmitOnRecursionBehavior());
+        return fixture;
+    }
+}

tests/DynamoDBGenerator.SourceGenerator.Benchmarks/Benchmarkers/SG_VS_AWS_Benchmarker.cs

@@ -0,0 +1,29 @@
+using Amazon;
+using Amazon.DynamoDBv2;
+using Amazon.DynamoDBv2.DataModel;
+using Amazon.DynamoDBv2.DocumentModel;
+using Amazon.DynamoDBv2.Model;
+using BenchmarkDotNet.Attributes;
+
+namespace DynamoDBGenerator.SourceGenerator.Benchmarks.Benchmarkers;
+
+public abstract class SG_VS_AWS_Benchmarker<T>(
+    Func<T, Dictionary<string, AttributeValue>> marshaller,
+    Func<Dictionary<string, AttributeValue>, T> unMarshaller
+) : SG_BenchMarker<T>(marshaller, unMarshaller)
+{
+    private readonly DynamoDBContext _context = new DynamoDBContextBuilder()
+        .WithDynamoDBClient(() => new AmazonDynamoDBClient(RegionEndpoint.EUWest1))
+        .Build();
+
+    private readonly ToDocumentConfig _dynamoDbOperationConfig = new() { Conversion = DynamoDBEntryConversion.V2 };
+
+
+    [Benchmark]
+    public Dictionary<string, AttributeValue> Marshall_AWS_Reflection() => _context
+        .ToDocument(SingleElement, _dynamoDbOperationConfig)
+        .ToAttributeMap(_dynamoDbOperationConfig.Conversion);
+
+    [Benchmark]
+    public T Unmarshall_AWS_Reflection() => _context.FromDocument<T>(Document.FromAttributeMap(AttributeValues));
+}

tests/DynamoDBGenerator.SourceGenerator.Benchmarks/MarshallBenchmark.cs

@@ -1,7 +1 @@
-// See https://aka.ms/new-console-template for more information
-
-
-using BenchmarkDotNet.Running;
-using DynamoDBGenerator.SourceGenerator.Benchmarks;
-
-BenchmarkRunner.Run<MarshallBenchmark>();
+BenchmarkDotNet.Running.BenchmarkRunner.Run(typeof(Program).Assembly);