Merge pull request #10 from Odonno/feat/cbor

Im5tu · web-flow · commit 923ed7169321 · 2025-01-20T08:58:02.000Z
Create benchmark for CBOR format
diff --git a/BinaryBenchmark.CBOR.cs b/BinaryBenchmark.CBOR.cs
@@ -0,0 +1,34 @@
+﻿using BenchmarkDotNet.Attributes;
+using Dahomey.Cbor;
+using SerializationBenchmarks.Converters.Cbor;
+using SerializationBenchmarks.Models;
+
+public partial class BinaryBenchmark
+{
+    private static readonly CborOptions _options = new();
+
+    static BinaryBenchmark()
+    {
+        _options.Registry.ConverterRegistry.RegisterConverter(typeof(Guid), new GuidConverter());
+    }
+    
+    [Benchmark, BenchmarkCategory("Serialization", "Binary"), ArgumentsSource(nameof(GenerateDataSets))]
+    public Task<byte[]> CBOR_Serialize(DataSet data)
+    {
+        return DataConvert_CBOR(data.Payload);
+    }
+    
+    [Benchmark, BenchmarkCategory("Deserialization", "Binary"), ArgumentsSource(nameof(GenerateDataSets))]
+    public ValueTask<List<User>> CBOR_Deserialize(DataSet data)
+    {
+        using var ms = new MemoryStream(data.SerializedData.CBOR);
+        return Cbor.DeserializeAsync<List<User>>(ms, _options);
+    }
+    
+    private async Task<byte[]> DataConvert_CBOR(List<User> users)
+    {
+        using var ms = new MemoryStream();
+        await Cbor.SerializeAsync(users, ms, _options).ConfigureAwait(false);
+        return ms.ToArray();
+    }
+}
diff --git a/BinaryBenchmark.cs b/BinaryBenchmark.cs
@@ -27,6 +27,9 @@ public IEnumerable<DataSet> GenerateDataSets()
         {
             var json = File.ReadAllText(set.File);
             var users = JsonSerializer.Deserialize<List<User>>(json, options);
+            
+            var cborData = DataConvert_CBOR(users).GetAwaiter().GetResult();
+            
             yield return new DataSet
             {
                 Name = set.Subset,
@@ -35,12 +38,13 @@ public IEnumerable<DataSet> GenerateDataSets()
                 {
                     AvroConvert = DataConvert_AvroConvert(users),
                     BSON = DataConvert_BSON(users),
+                    CBOR = cborData,
                     GroBuf = DataConvert_GroBuf(users),
                     Hyperion = DataConvert_Hyperion(users),
                     MessagePack = DataConvert_MessagePack(users),
                     MemoryPack = DataConvert_MemoryPack(users),
                     MsgPack = DataConvert_MsgPack(users),
-                    ProtoBufNet = DataConvert_ProtoBufNet(users)
+                    ProtoBufNet = DataConvert_ProtoBufNet(users),
                 }
             };
         }
@@ -58,6 +62,7 @@ public class SerializedData
     {
         public byte[] AvroConvert { get; set; }
         public byte[] BSON { get; set; }
+        public byte[] CBOR { get; set; }
         public byte[] GroBuf { get; set; }
         public byte[] Hyperion { get; set; }
         public byte[] MessagePack { get; set; }
diff --git a/Converters/Cbor/GuidConverter.cs b/Converters/Cbor/GuidConverter.cs
@@ -0,0 +1,38 @@
+﻿using Dahomey.Cbor;
+using Dahomey.Cbor.Serialization;
+using Dahomey.Cbor.Serialization.Converters;
+
+namespace SerializationBenchmarks.Converters.Cbor;
+
+internal sealed class GuidConverter : CborConverterBase<Guid>
+{
+    private const int CBOR_ARRAY_SIZE = 16;
+    private const ulong TAG_UUID = 37;
+
+    public override Guid Read(ref CborReader reader)
+    {
+        var value = reader.ReadByteString();
+
+        if (value.Length != CBOR_ARRAY_SIZE)
+        {
+            throw new CborException("Expected a CBOR byte array with 16 elements");
+        }
+
+        return new Guid(value);
+    }
+
+    public override void Write(ref CborWriter writer, Guid value)
+    {
+        writer.WriteSemanticTag(TAG_UUID);
+
+        Span<byte> bytes = new byte[CBOR_ARRAY_SIZE];
+        if (value.TryWriteBytes(bytes))
+        {
+            writer.WriteByteString(bytes);
+        }
+        else
+        {
+            throw new CborException("Cannot serialize the GUID to CBOR");
+        }
+    }
+}
diff --git a/Models/Bebop.Models.g.cs b/Models/Bebop.Models.g.cs
@@ -4,31 +4,31 @@
 //
 //
 //       bebopc version:
-//           2.4.6
+//           3.0.14
 //
 //
 //       bebopc source:
-//           https://github.com/RainwayApp/bebop
+//           https://github.com/betwixt-labs/bebop
 //
 //
 //     Changes to this file may cause incorrect behavior and will be lost if
 //     the code is regenerated.
 // </auto-generated>
 //
-// This source code was auto-generated by bebopc, Version=2.4.6.
+// This source code was auto-generated by bebopc, Version=3.0.14.
 //
 namespace SerializationBenchmarks.Models.Bebop {
 
-  [global::System.CodeDom.Compiler.GeneratedCode("bebopc", "2.4.6")]
+  [global::System.CodeDom.Compiler.GeneratedCode("bebopc", "3.0.14")]
   [global::Bebop.Attributes.BebopRecord(global::Bebop.Runtime.BebopKind.Enum)]
   public enum Gender : uint {
     Male = 0,
     Female = 1
   }
 
-  [global::System.CodeDom.Compiler.GeneratedCode("bebopc", "2.4.6")]
+  [global::System.CodeDom.Compiler.GeneratedCode("bebopc", "3.0.14")]
   [global::Bebop.Attributes.BebopRecord(global::Bebop.Runtime.BebopKind.Message)]
-  public partial class Order : global::Bebop.Runtime.BaseBebopRecord, global::System.IEquatable<Order> {
+  public partial class Order : global::Bebop.Runtime.BaseBebopRecord, global::Bebop.Runtime.IDecodable<Order>, global::System.IEquatable<Order> {
     #nullable enable
     /// <inheritdoc />
     public sealed override int MaxByteCount => GetMaxByteCount();
@@ -315,9 +315,9 @@ public override int GetHashCode() {
 
   }
 
-  [global::System.CodeDom.Compiler.GeneratedCode("bebopc", "2.4.6")]
+  [global::System.CodeDom.Compiler.GeneratedCode("bebopc", "3.0.14")]
   [global::Bebop.Attributes.BebopRecord(global::Bebop.Runtime.BebopKind.Message)]
-  public partial class User : global::Bebop.Runtime.BaseBebopRecord, global::System.IEquatable<User> {
+  public partial class User : global::Bebop.Runtime.BaseBebopRecord, global::Bebop.Runtime.IDecodable<User>, global::System.IEquatable<User> {
     #nullable enable
     /// <inheritdoc />
     public sealed override int MaxByteCount => GetMaxByteCount();
@@ -819,9 +819,9 @@ public override int GetHashCode() {
 
   }
 
-  [global::System.CodeDom.Compiler.GeneratedCode("bebopc", "2.4.6")]
+  [global::System.CodeDom.Compiler.GeneratedCode("bebopc", "3.0.14")]
   [global::Bebop.Attributes.BebopRecord(global::Bebop.Runtime.BebopKind.Message)]
-  public partial class UserWrapper : global::Bebop.Runtime.BaseBebopRecord, global::System.IEquatable<UserWrapper> {
+  public partial class UserWrapper : global::Bebop.Runtime.BaseBebopRecord, global::Bebop.Runtime.IDecodable<UserWrapper>, global::System.IEquatable<UserWrapper> {
     #nullable enable
     /// <inheritdoc />
     public sealed override int MaxByteCount => GetMaxByteCount();
diff --git a/Program.cs b/Program.cs
@@ -3,7 +3,6 @@
 using System.Text.Json.Serialization;
 using BenchmarkDotNet.Running;
 using Bogus;
-using Microsoft.Diagnostics.Runtime;
 using SerializationBenchmarks.Models;
 
 internal static class Program
@@ -43,6 +42,7 @@ private static void VerifySerializedSizes()
             var results = binaryResults[bds.Name];
             results["AvroConvert"] = bds.SerializedData.AvroConvert.Length;
             results["BSON"] = bds.SerializedData.BSON.Length;
+            results["CBOR"] = bds.SerializedData.CBOR.Length;
             results["GroBuf"] = bds.SerializedData.GroBuf.Length;
             results["Hyperion"] = bds.SerializedData.Hyperion.Length;
             results["MessagePack"] = bds.SerializedData.MessagePack.Length;
diff --git a/README.md b/README.md
@@ -18,6 +18,7 @@ As part of a [YouTube video](https://www.youtube.com/watch?v=XMoNYQPi2k8), I wen
 - [AvroConvert](https://www.nuget.org/packages/AvroConvert/)
 - [Bebop](https://www.nuget.org/packages/bebop)
 - [BSON](https://www.nuget.org/packages/MongoDB.Bson)
+- [CBOR](https://www.nuget.org/packages/Dahomey.Cbor)
 - [GroBuf](https://www.nuget.org/packages/GroBuf)
 - [Hyperion](https://www.nuget.org/packages/Hyperion)
 - [MessagePack](https://www.nuget.org/packages/MessagePack)
diff --git a/SerializationBenchmarks.csproj b/SerializationBenchmarks.csproj
@@ -2,7 +2,7 @@
 
     <PropertyGroup>
         <OutputType>Exe</OutputType>
-        <TargetFramework>net7.0</TargetFramework>
+        <TargetFramework>net9.0</TargetFramework>
         <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>disable</Nullable>
         <DefineConstants>$(DefineConstants);DATASET_SMALL;</DefineConstants>
@@ -11,25 +11,26 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="AvroConvert" Version="3.4.6" />
-        <PackageReference Include="bebop" Version="3.0.5" />
-        <PackageReference Include="bebop-tools" Version="3.0.5">
+        <PackageReference Include="AvroConvert" Version="3.4.10" />
+        <PackageReference Include="bebop" Version="3.0.14" />
+        <PackageReference Include="bebop-tools" Version="3.0.14">
           <PrivateAssets>all</PrivateAssets>
           <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>
-        <PackageReference Include="BenchmarkDotNet" Version="0.13.12" />
-        <PackageReference Include="Bogus" Version="35.5.0" />
+        <PackageReference Include="BenchmarkDotNet" Version="0.14.0" />
+        <PackageReference Include="Bogus" Version="35.6.1" />
+        <PackageReference Include="Dahomey.Cbor" Version="1.24.3" />
         <PackageReference Include="GroBuf" Version="1.9.2" />
         <PackageReference Include="Hyperion" Version="0.12.2" />
         <PackageReference Include="Jil" Version="2.17.0" />
-        <PackageReference Include="MemoryPack" Version="1.20.2" />
-        <PackageReference Include="MessagePack" Version="2.5.140" />
-        <PackageReference Include="MongoDB.Bson" Version="2.24.0" />
+        <PackageReference Include="MemoryPack" Version="1.21.3" />
+        <PackageReference Include="MessagePack" Version="2.5.192" />
+        <PackageReference Include="MongoDB.Bson" Version="2.30.0" />
         <PackageReference Include="MsgPack.Cli" Version="1.0.1" />
         <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
-        <PackageReference Include="protobuf-net" Version="3.2.30" />
-        <PackageReference Include="ServiceStack.Text" Version="8.2.2" />
-        <PackageReference Include="SpanJson" Version="4.0.1" />
+        <PackageReference Include="protobuf-net" Version="3.2.45" />
+        <PackageReference Include="ServiceStack.Text" Version="8.4.0" />
+        <PackageReference Include="SpanJson" Version="4.2.1" />
         <PackageReference Include="Utf8Json" Version="1.3.7" />
     </ItemGroup>
 

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,9 @@ public IEnumerable<DataSet> GenerateDataSets()`
`27`	`27`	`{`
`28`	`28`	`var json = File.ReadAllText(set.File);`
`29`	`29`	`var users = JsonSerializer.Deserialize<List<User>>(json, options);`
	`30`	`+`
	`31`	`+ var cborData = DataConvert_CBOR(users).GetAwaiter().GetResult();`
	`32`	`+`
`30`	`33`	`yield return new DataSet`
`31`	`34`	`{`
`32`	`35`	`Name = set.Subset,`
`@@ -35,12 +38,13 @@ public IEnumerable<DataSet> GenerateDataSets()`
`35`	`38`	`{`
`36`	`39`	`AvroConvert = DataConvert_AvroConvert(users),`
`37`	`40`	`BSON = DataConvert_BSON(users),`
	`41`	`+ CBOR = cborData,`
`38`	`42`	`GroBuf = DataConvert_GroBuf(users),`
`39`	`43`	`Hyperion = DataConvert_Hyperion(users),`
`40`	`44`	`MessagePack = DataConvert_MessagePack(users),`
`41`	`45`	`MemoryPack = DataConvert_MemoryPack(users),`
`42`	`46`	`MsgPack = DataConvert_MsgPack(users),`
`43`		`- ProtoBufNet = DataConvert_ProtoBufNet(users)`
	`47`	`+ ProtoBufNet = DataConvert_ProtoBufNet(users),`
`44`	`48`	`}`
`45`	`49`	`};`
`46`	`50`	`}`
`@@ -58,6 +62,7 @@ public class SerializedData`
`58`	`62`	`{`
`59`	`63`	`public byte[] AvroConvert { get; set; }`
`60`	`64`	`public byte[] BSON { get; set; }`
	`65`	`+ public byte[] CBOR { get; set; }`
`61`	`66`	`public byte[] GroBuf { get; set; }`
`62`	`67`	`public byte[] Hyperion { get; set; }`
`63`	`68`	`public byte[] MessagePack { get; set; }`