Include benchmark result

Author: inputfalken

README.md

@@ -34,6 +34,17 @@ The source generator will look for attributes and implement interfaces that exis
     * Simplify Attribute Expressions: Easily create complex expressions with an intuitive approach.
 * Faster performance: Utilize the low-level API that would normally be implemented manually.
 
+## [Benchmarks](tests/DynamoDBGenerator.SourceGenerator.Benchmarks): 
+
+Here's a quick summary about how this library performs with a quick example of marshalling and unmarshalling a simple DTO object.
+
+| Method                      | Mean       | Error    | StdDev   | Gen0   | Gen1   | Allocated |
+|---------------------------- |-----------:|---------:|---------:|-------:|-------:|----------:|
+| Marshall_AWS_Reflection     | 2,467.8 ns | 48.87 ns | 68.51 ns | 0.5112 | 0.0038 |    6450 B |
+| Marshall_Source_Generated   |   234.0 ns |  2.92 ns |  2.73 ns | 0.1421 | 0.0010 |    1784 B |
+| Unmarshall_AWS_Reflection   | 2,397.0 ns | 36.13 ns | 30.17 ns | 0.5188 | 0.0038 |    6544 B |
+| Unmarshall_Source_Generated |   131.6 ns |  0.82 ns |  0.77 ns | 0.0126 |      - |     160 B |
+
 ## Features:
 
 * Reflection-Free Codebase: The generated code is built without reliance on reflection, ensuring compatibility with

tests/DynamoDBGenerator.SourceGenerator.Benchmarks/MarshallBenchmark.cs

@@ -0,0 +1,65 @@
+using Amazon;
+using Amazon.DynamoDBv2;
+using Amazon.DynamoDBv2.DataModel;
+using Amazon.DynamoDBv2.DocumentModel;
+using Amazon.DynamoDBv2.Model;
+using AutoFixture;
+using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Jobs;
+using DynamoDBGenerator.SourceGenerator.Benchmarks.Models;
+
+namespace DynamoDBGenerator.SourceGenerator.Benchmarks;
+
+[SimpleJob(RuntimeMoniker.Net80)]
+[MemoryDiagnoser]
+public class MarshallBenchmark
+{
+    private readonly DynamoDBContext _context;
+    private readonly ToDocumentConfig _dynamoDbOperationConfig;
+    private readonly PersonEntity _singleElement;
+    private readonly Dictionary<string, AttributeValue> _attributeValues;
+
+    public MarshallBenchmark()
+    {
+        var fixture = new Fixture();
+        fixture.Behaviors.OfType<ThrowingRecursionBehavior>().ToList().ForEach(b => fixture.Behaviors.Remove(b));
+        fixture.Behaviors.Add(new OmitOnRecursionBehavior());
+
+        _context = new DynamoDBContextBuilder()
+            .WithDynamoDBClient(() => new AmazonDynamoDBClient(RegionEndpoint.EUWest1))
+            .Build();
+        _dynamoDbOperationConfig = new()
+        {
+            Conversion = DynamoDBEntryConversion.V2
+        };
+
+        _singleElement = fixture.Create<PersonEntity>();
+        _attributeValues = _context.ToDocument(_singleElement).ToAttributeMap();
+    }
+
+
+    [Benchmark]
+    public Dictionary<string, AttributeValue> Marshall_AWS_Reflection()
+    {
+        return _context.ToDocument(_singleElement, _dynamoDbOperationConfig)
+            .ToAttributeMap(_dynamoDbOperationConfig.Conversion);
+    }
+
+    [Benchmark]
+    public Dictionary<string, AttributeValue> Marshall_Source_Generated()
+    {
+        return PersonEntity.PersonEntityMarshaller.Marshall(_singleElement);
+    }
+
+    [Benchmark]
+    public PersonEntity Unmarshall_AWS_Reflection()
+    {
+        return _context.FromDocument<PersonEntity>(Document.FromAttributeMap(_attributeValues));
+    }
+
+    [Benchmark]
+    public PersonEntity Unmarshall_Source_Generated()
+    {
+        return PersonEntity.PersonEntityMarshaller.Unmarshall(_attributeValues);
+    }
+}

tests/DynamoDBGenerator.SourceGenerator.Benchmarks/Models/Address.cs

@@ -1,6 +1,6 @@
 namespace DynamoDBGenerator.SourceGenerator.Benchmarks.Models;
 
-public class Address
+public sealed record Address
 {
     public string Id { get; set; } = null!;
 

tests/DynamoDBGenerator.SourceGenerator.Benchmarks/Models/PersonEntity.cs

@@ -4,7 +4,7 @@ namespace DynamoDBGenerator.SourceGenerator.Benchmarks.Models;
 
 
 [DynamoDBMarshaller(EntityType = typeof(PersonEntity))]
-public partial class PersonEntity
+public partial record PersonEntity
 {
     [DynamoDBHashKey]
     public string Id { get; set; } = null!;

tests/DynamoDBGenerator.SourceGenerator.Benchmarks/Models/PostalCode.cs

@@ -1,6 +1,6 @@
 namespace DynamoDBGenerator.SourceGenerator.Benchmarks.Models;
 
-public class PostalCode
+public sealed class PostalCode
 {
     public string ZipCode { get; set; } = null!;
     public string Town { get; set; } = null!;

tests/DynamoDBGenerator.SourceGenerator.Benchmarks/Program.cs

@@ -1,68 +1,7 @@
 // See https://aka.ms/new-console-template for more information
 
-using Amazon;
-using Amazon.DynamoDBv2;
-using Amazon.DynamoDBv2.DataModel;
-using Amazon.DynamoDBv2.DocumentModel;
-using Amazon.DynamoDBv2.Model;
-using AutoFixture;
-using BenchmarkDotNet.Attributes;
-using BenchmarkDotNet.Jobs;
+
 using BenchmarkDotNet.Running;
-using DynamoDBGenerator.SourceGenerator.Benchmarks.Models;
 using DynamoDBGenerator.SourceGenerator.Benchmarks;
 
-
-BenchmarkRunner.Run<Marshalling>();
-
-[SimpleJob(RuntimeMoniker.Net80)]
-[MemoryDiagnoser]
-public class Marshalling
-{
-    private readonly DynamoDBContext _context;
-    private readonly DynamoDBOperationConfig _dynamoDbOperationConfig;
-    private readonly PersonEntity _singleElement;
-    private readonly Dictionary<string, AttributeValue> _attributeValues;
-
-    public Marshalling()
-    {
-        var fixture = new Fixture();
-        fixture.Behaviors.OfType<ThrowingRecursionBehavior>().ToList().ForEach(b => fixture.Behaviors.Remove(b));
-        fixture.Behaviors.Add(new OmitOnRecursionBehavior());
-
-        _context = new(new AmazonDynamoDBClient(RegionEndpoint.EUWest1));
-        _dynamoDbOperationConfig = new()
-        {
-            Conversion = DynamoDBEntryConversion.V2
-        };
-
-        _singleElement = fixture.Create<PersonEntity>();
-        _attributeValues = _context.ToDocument(_singleElement).ToAttributeMap();
-    }
-
-
-    [Benchmark]
-    public Dictionary<string, AttributeValue> Marshall_AWS()
-    {
-        return _context.ToDocument(_singleElement, _dynamoDbOperationConfig).ToAttributeMap(_dynamoDbOperationConfig.Conversion);
-    }
-
-    [Benchmark]
-    public Dictionary<string, AttributeValue> Marshall_SG()
-    {
-        return PersonEntity.PersonEntityMarshaller.Marshall(_singleElement);
-    }
-
-    [Benchmark]
-    public PersonEntity Unmarshall_AWS()
-    {
-        return _context.FromDocument<PersonEntity>(Document.FromAttributeMap(_attributeValues));
-    }
-
-    [Benchmark]
-    public PersonEntity Unmarshall_SG()
-    {
-        return PersonEntity.PersonEntityMarshaller.Unmarshall(_attributeValues);
-    }
-
-}
+BenchmarkRunner.Run<MarshallBenchmark>();