Merge pull request #2380 from tiksn/replace-bond-with-protobuf

Replace Microsoft Bond with Google Protobuf

Author: tiksn

Directory.Packages.props

@@ -7,9 +7,10 @@
     <PackageVersion Include="Autofac.Extensions.DependencyInjection" Version="10.0.0" />
     <PackageVersion Include="Azure.Data.Tables" Version="12.11.0" />
     <PackageVersion Include="Azure.Storage.Blobs" Version="12.24.0" />
-    <PackageVersion Include="Bond.CSharp" Version="13.0.2" />
     <PackageVersion Include="coverlet.collector" Version="6.0.4" />
     <PackageVersion Include="FluentValidation" Version="12.0.0" />
+    <PackageVersion Include="Google.Protobuf" Version="3.31.1" />
+    <PackageVersion Include="Grpc.Tools" Version="2.72.0" />
     <PackageVersion Include="IdGen" Version="3.0.7" />
     <PackageVersion Include="LanguageExt.Core" Version="4.4.9" />
     <PackageVersion Include="LanguageExt.FSharp" Version="4.4.9" />

TIKSN.Framework.Core.Tests/Licensing/TestEntitlementsConverter.cs

@@ -1,4 +1,6 @@
 using System.Collections.Generic;
+using System.Linq;
+using Google.Protobuf;
 using LanguageExt;
 using LanguageExt.Common;
 using TIKSN.Licensing;
@@ -61,7 +63,7 @@ public Validation<Error, TestLicenseEntitlements> Convert(
             }
             else
             {
-                result.Salt = entitlements.Salt.ToArray();
+                result.Salt = ByteString.CopyFrom([.. entitlements.Salt]);
             }
         }
 
@@ -104,7 +106,7 @@ public Validation<Error, TestEntitlements> Convert(
                 errors.Add(Error.New(314894957, "EmployeeId is invalid"));
             }
 
-            if (entitlementsData.Salt.Count == 0)
+            if (entitlementsData.Salt.Length == 0)
             {
                 errors.Add(Error.New(139152695, "Salt is missing"));
             }

TIKSN.Framework.Core.Tests/Licensing/schema.bond

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+option csharp_namespace = "TIKSN.Tests.Licensing";
+
+message TestLicenseEntitlements {
+    string Name = 1;
+    int32 Quantity = 2;
+    bytes Salt = 3;
+    int64 CompanyId = 4;
+    int64 EmployeeId = 5;
+}

TIKSN.Framework.Core.Tests/Licensing/schema.proto

@@ -10,7 +10,10 @@
     <RootNamespace>TIKSN.Tests</RootNamespace>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="Bond.CSharp" />
+    <PackageReference Include="Grpc.Tools">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
     <PackageReference Include="Microsoft.Extensions.Hosting" />
     <PackageReference Include="Microsoft.Extensions.TimeProvider.Testing" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" />
@@ -44,4 +47,7 @@
       <CustomToolNamespace>TIKSN.Tests.Licensing</CustomToolNamespace>
     </EmbeddedResource>
   </ItemGroup>
+  <ItemGroup>
+    <Protobuf Include="Licensing\schema.proto" GrpcServices="None" />
+  </ItemGroup>
 </Project>

TIKSN.Framework.Core.Tests/TIKSN.Framework.Core.Tests.csproj

@@ -15,7 +15,6 @@
 using TIKSN.Licensing;
 using TIKSN.Network;
 using TIKSN.Serialization;
-using TIKSN.Serialization.Bond;
 using TIKSN.Serialization.MessagePack;
 using TIKSN.Serialization.Numerics;
 using TIKSN.Shell;
@@ -48,25 +47,15 @@ public static IServiceCollection AddFrameworkCore(this IServiceCollection servic
         services.TryAddSingleton<IKnownFolders, KnownFolders>();
         services.TryAddSingleton<INetworkConnectivityService, NetworkConnectivityService>();
 
-        services.TryAddSingleton<CompactBinaryBondDeserializer>();
-        services.TryAddSingleton<CompactBinaryBondSerializer>();
         services.TryAddSingleton<DotNetXmlDeserializer>();
         services.TryAddSingleton<DotNetXmlSerializer>();
-        services.TryAddSingleton<FastBinaryBondDeserializer>();
-        services.TryAddSingleton<FastBinaryBondSerializer>();
         services.TryAddSingleton<ICustomDeserializer<byte[], BigInteger>, UnsignedBigIntegerBinaryDeserializer>();
         services.TryAddSingleton<ICustomSerializer<byte[], BigInteger>, UnsignedBigIntegerBinarySerializer>();
         services.TryAddSingleton<IRestRequester, RestRequester>();
         services.TryAddSingleton<JsonDeserializer>();
         services.TryAddSingleton<JsonSerializer>();
         services.TryAddSingleton<MessagePackDeserializer>();
         services.TryAddSingleton<MessagePackSerializer>();
-        services.TryAddSingleton<SimpleBinaryBondDeserializer>();
-        services.TryAddSingleton<SimpleBinaryBondSerializer>();
-        services.TryAddSingleton<SimpleJsonBondDeserializer>();
-        services.TryAddSingleton<SimpleJsonBondSerializer>();
-        services.TryAddSingleton<SimpleXmlBondDeserializer>();
-        services.TryAddSingleton<SimpleXmlBondSerializer>();
         services.TryAddSingleton<IIdentityGenerator<long>, IdGenIdentityGenerator>();
         services.TryAddScoped<IShellCommandContext, ShellCommandContext>();
         services.TryAddSingleton(MessageBus.Current);

TIKSN.Framework.Core/DependencyInjection/ServiceCollectionExtensions.cs

@@ -1,13 +1,11 @@
 using System.Security.Cryptography.X509Certificates;
+using Google.Protobuf;
 using LanguageExt;
 using LanguageExt.Common;
 
 namespace TIKSN.Licensing;
 
-#pragma warning disable S2326 // Unused type parameters should be removed
-
-public interface ILicenseFactory<TEntitlements, TEntitlementsData>
-#pragma warning restore S2326 // Unused type parameters should be removed
+public interface ILicenseFactory<TEntitlements, TEntitlementsData> where TEntitlementsData : IMessage<TEntitlementsData>
 {
     Validation<Error, License<TEntitlements>> Create(
         LicenseTerms terms,

TIKSN.Framework.Core/Licensing/ILicenseFactory.cs

@@ -1,31 +1,25 @@
 using System.Security.Cryptography.X509Certificates;
+using Google.Protobuf;
 using LanguageExt;
 using LanguageExt.Common;
 using Microsoft.Extensions.DependencyInjection;
-using TIKSN.Serialization.Bond;
 using static LanguageExt.Prelude;
 
 namespace TIKSN.Licensing;
 
-public class LicenseFactory<TEntitlements, TEntitlementsData> : ILicenseFactory<TEntitlements, TEntitlementsData>
+public class LicenseFactory<TEntitlements, TEntitlementsData> : ILicenseFactory<TEntitlements, TEntitlementsData> where TEntitlementsData : IMessage<TEntitlementsData>
 {
-    private readonly CompactBinaryBondDeserializer deserializer;
     private readonly IEntitlementsConverter<TEntitlements, TEntitlementsData> entitlementsConverter;
     private readonly ILicenseDescriptor<TEntitlements> licenseDescriptor;
-    private readonly CompactBinaryBondSerializer serializer;
     private readonly IServiceProvider serviceProvider;
     private readonly TimeProvider timeProvider;
 
     public LicenseFactory(
-        CompactBinaryBondSerializer serializer,
-        CompactBinaryBondDeserializer deserializer,
         ILicenseDescriptor<TEntitlements> licenseDescriptor,
         IEntitlementsConverter<TEntitlements, TEntitlementsData> entitlementsConverter,
         TimeProvider timeProvider,
         IServiceProvider serviceProvider)
     {
-        this.serializer = serializer ?? throw new ArgumentNullException(nameof(serializer));
-        this.deserializer = deserializer ?? throw new ArgumentNullException(nameof(deserializer));
         this.licenseDescriptor = licenseDescriptor ?? throw new ArgumentNullException(nameof(licenseDescriptor));
         this.entitlementsConverter = entitlementsConverter ?? throw new ArgumentNullException(nameof(entitlementsConverter));
         this.timeProvider = timeProvider ?? throw new ArgumentNullException(nameof(timeProvider));
@@ -49,8 +43,7 @@ public Validation<Error, License<TEntitlements>> Create(
 
         _ = this.entitlementsConverter.Convert(entitlements)
             .Match(
-                succ => envelope.Message.Entitlements =
-                    new ArraySegment<byte>(this.serializer.Serialize(succ)),
+                succ => envelope.Message.Entitlements = succ.ToByteString(),
                 fail => errors.AddRange(fail));
 
         if (!privateCertificate.HasPrivateKey)
@@ -63,15 +56,15 @@ public Validation<Error, License<TEntitlements>> Create(
             return errors.ToSeq();
         }
 
-        var messageData = this.serializer.Serialize(envelope.Message);
+        var messageData = envelope.Message.ToByteString();
 
         var keyAlgorithm = privateCertificate.GetKeyAlgorithm();
         envelope.SignatureAlgorithm = keyAlgorithm;
         var signatureService = this.serviceProvider.GetRequiredKeyedService<ICertificateSignatureService>(keyAlgorithm);
-        var signature = signatureService.Sign(messageData, privateCertificate);
-        envelope.Signature = new ArraySegment<byte>(signature);
+        var signature = signatureService.Sign(messageData.ToByteArray(), privateCertificate);
+        envelope.Signature = ByteString.CopyFrom(signature);
 
-        var envelopeData = this.serializer.Serialize(envelope);
+        var envelopeData = envelope.ToByteString();
 
         return new License<TEntitlements>(
             terms,
@@ -93,10 +86,14 @@ public Validation<Error, License<TEntitlements>> Create(
             return errors.ToSeq();
         }
 
-        var envelope = this.deserializer.Deserialize<LicenseEnvelope>([.. data]);
+        var envelope = LicenseEnvelope.Parser.ParseFrom([.. data]);
 
         var licenseTermsValidation = this.GetTerms(envelope, this.timeProvider);
-        var entitlementsValidation = this.entitlementsConverter.Convert(this.deserializer.Deserialize<TEntitlementsData>([.. envelope.Message.Entitlements]));
+
+        var entitlementsData = Activator.CreateInstance<TEntitlementsData>();
+        entitlementsData.MergeFrom(envelope.Message.Entitlements.CreateCodedInput());
+
+        var entitlementsValidation = this.entitlementsConverter.Convert(entitlementsData);
 
         var keyAlgorithm = publicCertificate.GetKeyAlgorithm();
 
@@ -107,9 +104,9 @@ public Validation<Error, License<TEntitlements>> Create(
 
         var signatureService = this.serviceProvider.GetRequiredKeyedService<ICertificateSignatureService>(keyAlgorithm);
 
-        var messageData = this.serializer.Serialize(envelope.Message);
+        var messageData = envelope.Message.ToByteArray();
 
-        if (!signatureService.Verify(messageData, [.. envelope.Signature], publicCertificate))
+        if (!signatureService.Verify(messageData, envelope.Signature.ToByteArray(), publicCertificate))
         {
             errors.Add(Error.New(1311896038, "License signature is invalid"));
         }
@@ -133,12 +130,7 @@ private Validation<Error, LicenseTerms> GetTerms(
     {
         ArgumentNullException.ThrowIfNull(envelope);
 
-        if (envelope.Message.VersionNumber != 1)
-        {
-            return Error.New(2129266854, "License version is invalid");
-        }
-
-        if (envelope.Message.Discriminator.Count != Guid.Empty.ToByteArray().Length ||
+        if (envelope.Message.Discriminator.Count() != Guid.Empty.ToByteArray().Length ||
             envelope.Message.Discriminator.All(x => x == byte.MinValue) ||
             !envelope.Message.Discriminator.SequenceEqual(this.licenseDescriptor.Discriminator.ToByteArray()))
         {
@@ -193,14 +185,15 @@ private Validation<Error, LicenseEnvelope> Populate(
 
         var errors = new List<Error>();
 
-        envelope.Message.VersionNumber = 1;
-
         if (this.licenseDescriptor.Discriminator == Guid.Empty)
         {
             errors.Add(Error.New(13127674, "'Discriminator' should not be empty GUID"));
         }
 
-        envelope.Message.Discriminator = new ArraySegment<byte>(this.licenseDescriptor.Discriminator.ToByteArray());
+        envelope.Message = new LicenseMessage
+        {
+            Discriminator = ByteString.CopyFrom(this.licenseDescriptor.Discriminator.ToByteArray()),
+        };
 
         if (terms.NotAfter < terms.NotBefore)
         {