Merge pull request #2 from agocke/add-gh-workflow

Implement basic support for MessagePack

Author: agocke

.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: 8.0.*
+    - name: Restore dependencies
+      run: dotnet restore
+    - name: Build
+      run: dotnet build --no-restore -warnaserror
+    - name: Test
+      run: dotnet test --no-build --verbosity normal
+    - name: Pack
+      run: dotnet pack -c Release

.github/workflows/pack.yml

@@ -0,0 +1,21 @@
+name: Pack
+on:
+  push:
+    branches: [ main ]
+jobs:
+  pack:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: 8.0.*
+    - name: Pack
+      run: dotnet pack -c Release
+    - name: Upload package
+      uses: actions/upload-artifact@v4
+      with:
+        name: NuGet packages
+        path: artifacts/package/release/*.nupkg

.github/workflows/publish.yml

@@ -0,0 +1,22 @@
+
+name: publish
+on:
+  push:
+    branches: [ release ]
+  release:
+    types: [ published ]
+
+jobs:
+  pack:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: 8.0.*
+    - name: Pack
+      run: dotnet pack -c Release
+    - name: Publish package
+      run: dotnet nuget push --skip-duplicate -k ${{ secrets.NUGET_API_KEY }} -s https://api.nuget.org/v3/index.json artifacts/package/release/*.nupkg

bench/DataGenerator.cs

@@ -0,0 +1,59 @@
+
+using System;
+
+namespace Benchmarks
+{
+    internal static class DataGenerator
+    {
+        public static T GenerateSerialize<T>() where T : Serde.ISerializeProvider<T>
+        {
+            if (typeof(T) == typeof(LoginViewModel))
+                return (T)(object)CreateLoginViewModel();
+            if (typeof(T) == typeof(Location))
+                return (T)(object)Location.Sample;
+
+            throw new InvalidOperationException();
+
+            static LoginViewModel CreateLoginViewModel() => new LoginViewModel
+            {
+                Email = "[email protected]",
+                // [SuppressMessage("Microsoft.Security", "CS002:SecretInNextLine", Justification="Dummy credentials for perf testing.")]
+                Password = "abcdefgh123456!@",
+                RememberMe = true
+            };
+
+        }
+
+        public static Location CreateLocation() => new Location
+        {
+            Id = 1234,
+            Address1 = "The Street Name",
+            Address2 = "20/11",
+            City = "The City",
+            State = "The State",
+            PostalCode = "abc-12",
+            Name = "Nonexisting",
+            PhoneNumber = "+0 11 222 333 44",
+            Country = "The Greatest"
+        };
+
+        public static byte[] GenerateDeserialize<T>()
+        {
+            if (typeof(T) == typeof(LoginViewModel))
+                return MessagePack.MessagePackSerializer.Serialize(LoginViewSample);
+            if (typeof(T) == typeof(Location))
+                return MessagePack.MessagePackSerializer.Serialize(Location.Sample);
+
+            throw new InvalidOperationException("Unexpected type");
+        }
+
+        public const string LoginViewSample = """
+{
+    "email": "[email protected]",
+    "password": "abcdefgh123456!@",
+    "rememberMe": true
+}
+""";
+
+    }
+}

bench/DeserializeFromString.cs

@@ -0,0 +1,42 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using BenchmarkDotNet.Attributes;
+using MessagePack;
+using Serde;
+
+namespace Benchmarks
+{
+    [GenericTypeArguments(typeof(Location), typeof(LocationWrap))]
+    public class DeserializeFromString<T, U>
+        where T : Serde.IDeserializeProvider<T>
+        where U : Serde.IDeserializeProvider<T>
+    {
+        private byte[] value = null!;
+
+        private readonly IDeserialize<T> _proxy = T.DeserializeInstance;
+        private readonly IDeserialize<T> _manualProxy = U.DeserializeInstance;
+
+        [GlobalSetup]
+        public void Setup()
+        {
+            value = DataGenerator.GenerateDeserialize<T>();
+        }
+
+        [Benchmark]
+        public T? MessagePack()
+        {
+            return MessagePackSerializer.Deserialize<T>(value);
+        }
+
+        [Benchmark]
+        public T SerdeMsgPack() => Serde.MsgPack.MsgPackSerializer.Deserialize<T, IDeserialize<T>>(value, _proxy);
+
+        [Benchmark]
+        public T SerdeMsgPackManual() => Serde.MsgPack.MsgPackSerializer.Deserialize<T, IDeserialize<T>>(value, _manualProxy);
+
+        // DataContractJsonSerializer does not provide an API to serialize to string
+        // so it's not included here (apples vs apples thing)
+    }
+}

bench/Program.cs

@@ -1,37 +1,35 @@
-// See https://aka.ms/new-console-template for more information
-using System;
-using System.Security.Cryptography;
-using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Configs;
+using BenchmarkDotNet.Diagnosers;
 using BenchmarkDotNet.Running;
+using Benchmarks;
+using MessagePack;
 
-namespace MsgPack.Benchmarks;
+var msg1 = MessagePackSerializer.Serialize(Location.Sample);
+var msg2 = Serde.MsgPack.MsgPackSerializer.Serialize(Location.Sample);
 
-public class MessagePackUnit
+if (!msg1.SequenceEqual(msg2))
 {
-    private const int N = 10000;
-    private readonly byte[] data;
-
-    private readonly SHA256 sha256 = SHA256.Create();
-    private readonly MD5 md5 = MD5.Create();
-
-    public MessagePackUnit()
-    {
-        data = new byte[N];
-        new Random(42).NextBytes(data);
-    }
-
-    [Benchmark]
-    public byte[] Sha256() => sha256.ComputeHash(data);
-
-    [Benchmark]
-    public byte[] Md5() => md5.ComputeHash(data);
+    Console.WriteLine(string.Join(", ", msg1));
+    Console.WriteLine(string.Join(", ", msg2));
+    throw new InvalidOperationException("bytes do not match");
 }
 
-public class Program
+var loc1 = MessagePackSerializer.Deserialize<Location>(msg1);
+var loc2 = Serde.MsgPack.MsgPackSerializer.Deserialize<Location, LocationWrap>(msg1, LocationWrap.Instance);
+
+Console.WriteLine("Checking correctness of serialization: " + (loc1 == loc2));
+if (loc1 != loc2)
 {
-    public static void Main(string[] args)
-    {
-        var summary = BenchmarkRunner.Run<MessagePackUnit>();
-    }
+    throw new InvalidOperationException($"""
+Serialization is not correct
+STJ:
+{loc1}
+
+Serde:
+{loc2}
+""");
 }
 
+var config = DefaultConfig.Instance.AddDiagnoser(MemoryDiagnoser.Default);
+var summary = BenchmarkSwitcher.FromAssembly(typeof(DeserializeFromString<,>).Assembly)
+    .Run(args, config);