Upgrade to KNet 2.2.0 (#112)

* Added disclaimer

* Upgrade to KNet 2.2.0, version and refinements

* Update parameter order

README.md

@@ -7,12 +7,22 @@ Based on [KNet](https://github.com/masesgroup/KNet) it allows to use [Apache Kaf
 
 [![latest version](https://img.shields.io/nuget/v/MASES.EntityFrameworkCore.KNet)](https://www.nuget.org/packages/MASES.EntityFrameworkCore.KNet) [![downloads](https://img.shields.io/nuget/dt/MASES.EntityFrameworkCore.KNet)](https://www.nuget.org/packages/MASES.EntityFrameworkCore.KNet)
 
+> IMPORTANT NOTE: till the first major version, all releases shall be considered not stable: this means the API public, or internal, can change without notice.
+
 ### Pipelines
 
 [![CI_BUILD](https://github.com/masesgroup/KEFCore/actions/workflows/build.yaml/badge.svg)](https://github.com/masesgroup/KEFCore/actions/workflows/build.yaml) 
 [![CI_RELEASE](https://github.com/masesgroup/KEFCore/actions/workflows/release.yaml/badge.svg)](https://github.com/masesgroup/KEFCore/actions/workflows/release.yaml) 
 
-> IMPORTANT NOTE: till the first major version, all releases shall be considered not stable: this means the API public, or internal, can be change without notice.
+### Project disclaimer
+
+KEFCore is a project, curated by MASES Group, can be supported by the open-source community.
+
+Its primary scope is to support other, public or internal, MASES Group projects: open-source community and commercial entities can use it for their needs and support this project, moreover there are dedicated community and commercial subscription plans.
+
+The repository code and releases may contain bugs, the release cycle depends from critical discovered issues and/or enhancement requested from this or other projects.
+
+Looking for the help of [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) and [Apache Kafka](https://kafka.apache.org/) experts? MASES Group can help you design, build, deploy, and manage [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) and [Apache Kafka](https://kafka.apache.org/) applications.
 
 ---
 

src/documentation/articles/externalapplication.md

@@ -3,7 +3,7 @@
 [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/) shall convert the entities used within the model in something viable from the backend.
 Continuing from the concepts introduced in [serialization](serialization.md), an external application can use the data stored in the topics in a way it decides: [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/) gives some helpers to get back the CLR Entity objects stored in the topics.
 
-> IMPORTANT NOTE: till the first major version, all releases shall be considered not stable: this means the API public, or internal, can be change without notice.
+> IMPORTANT NOTE: till the first major version, all releases shall be considered not stable: this means the API public, or internal, can change without notice.
 
 ## Basic concepts
 

src/documentation/articles/gettingstarted.md

@@ -4,7 +4,7 @@ To use [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provi
 - an installed JRE/JDK (11+)
 - an accessible Apache Kafka broker (a full cluster or a local Dockerized version)
 
-> IMPORTANT NOTE: till the first major version, all releases shall be considered not stable: this means the API public, or internal, can be change without notice.
+> IMPORTANT NOTE: till the first major version, all releases shall be considered not stable: this means the API public, or internal, can change without notice.
 
 ## First project setup
 

src/documentation/articles/intro.md

@@ -1,8 +1,44 @@
-# Welcome to KEFCore
+# KEFCore: [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/)
 
 KEFCore is the [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/).
 Based on [KNet](https://github.com/masesgroup/KNet) it allows to use [Apache Kafka](https://kafka.apache.org/) as a distributed database and more.
 
-This project adheres to the Contributor [Covenant code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to coc_reporting@masesgroup.com.
+### Libraries and Tools
+
+[![latest version](https://img.shields.io/nuget/v/MASES.EntityFrameworkCore.KNet)](https://www.nuget.org/packages/MASES.EntityFrameworkCore.KNet) [![downloads](https://img.shields.io/nuget/dt/MASES.EntityFrameworkCore.KNet)](https://www.nuget.org/packages/MASES.EntityFrameworkCore.KNet)
+
+> IMPORTANT NOTE: till the first major version, all releases shall be considered not stable: this means the API public, or internal, can change without notice.
+
+### Pipelines
+
+[![CI_BUILD](https://github.com/masesgroup/KEFCore/actions/workflows/build.yaml/badge.svg)](https://github.com/masesgroup/KEFCore/actions/workflows/build.yaml) 
+[![CI_RELEASE](https://github.com/masesgroup/KEFCore/actions/workflows/release.yaml/badge.svg)](https://github.com/masesgroup/KEFCore/actions/workflows/release.yaml) 
+
+### Project disclaimer
+
+KEFCore is a project, curated by MASES Group, can be supported by the open-source community.
+
+Its primary scope is to support other, public or internal, MASES Group projects: open-source community and commercial entities can use it for their needs and support this project, moreover there are dedicated community and commercial subscription plans.
+
+The repository code and releases may contain bugs, the release cycle depends from critical discovered issues and/or enhancement requested from this or other projects.
 
-> IMPORTANT NOTE: till the first major version, all releases shall be considered not stable: this means the API public, or internal, can be change without notice.
+Looking for the help of [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) and [Apache Kafka](https://kafka.apache.org/) experts? MASES Group can help you design, build, deploy, and manage [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) and [Apache Kafka](https://kafka.apache.org/) applications.
+
+---
+
+## Scope of the project
+
+This project aims to create a provider to access the information stored within an Apache Kafka cluster using the paradigm behind Entity Framework.
+The project is based on available information within the official [EntityFrameworkCore repository](https://github.com/dotnet/efcore), many classes was copied from there as reported in the official documentation within the Microsoft website at https://docs.microsoft.com/en-us/ef/core/providers/writing-a-provider.
+
+### Community and Contribution
+
+Do you like the project? 
+- Request your free [community subscription](https://www.jcobridge.com/pricing-25/).
+
+Do you want to help us?
+- put a :star: on this project
+- open [issues](https://github.com/masesgroup/KEFCore/issues) to request features or report bugs :bug:
+- improves the project with Pull Requests
+
+This project adheres to the Contributor [Covenant code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to coc_reporting@masesgroup.com.

src/documentation/articles/serialization.md

@@ -3,7 +3,7 @@
 [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/) shall convert the entities used within the model in something viable from the backend.
 Each backend has its own schema to convert entities into something else; database providers converts entities into database schema or blob in Cosmos.
 
-> IMPORTANT NOTE: till the first major version, all releases shall be considered not stable: this means the API public, or internal, can be change without notice.
+> IMPORTANT NOTE: till the first major version, all releases shall be considered not stable: this means the API public, or internal, can change without notice.
 
 ## Basic concepts
 

src/documentation/index.md

@@ -1,11 +1,25 @@
 # KEFCore: [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/)
 
-[![CI_BUILD](https://github.com/masesgroup/KEFCore/actions/workflows/build.yaml/badge.svg)](https://github.com/masesgroup/KEFCore/actions/workflows/build.yaml) [![CI_RELEASE](https://github.com/masesgroup/KEFCore/actions/workflows/release.yaml/badge.svg)](https://github.com/masesgroup/KEFCore/actions/workflows/release.yaml) 
-
 KEFCore is the [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/).
 Based on [KNet](https://github.com/masesgroup/KNet) it allows to use [Apache Kafka](https://kafka.apache.org/) as a distributed database and more.
 
-> IMPORTANT NOTE: till the first major version, all releases shall be considered not stable: this means the API public, or internal, can be change without notice.
+### Libraries and Tools
+
+[![latest version](https://img.shields.io/nuget/v/MASES.EntityFrameworkCore.KNet)](https://www.nuget.org/packages/MASES.EntityFrameworkCore.KNet) [![downloads](https://img.shields.io/nuget/dt/MASES.EntityFrameworkCore.KNet)](https://www.nuget.org/packages/MASES.EntityFrameworkCore.KNet)
+
+> IMPORTANT NOTE: till the first major version, all releases shall be considered not stable: this means the API public, or internal, can change without notice.
+
+### Project disclaimer
+
+KEFCore is a project, curated by MASES Group, can be supported by the open-source community.
+
+Its primary scope is to support other, public or internal, MASES Group projects: open-source community and commercial entities can use it for their needs and support this project, moreover there are dedicated community and commercial subscription plans.
+
+The repository code and releases may contain bugs, the release cycle depends from critical discovered issues and/or enhancement requested from this or other projects.
+
+Looking for the help of [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) and [Apache Kafka](https://kafka.apache.org/) experts? MASES Group can help you design, build, deploy, and manage [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) and [Apache Kafka](https://kafka.apache.org/) applications.
+
+---
 
 ## Scope of the project
 

src/net/Common/Common.props

@@ -4,7 +4,7 @@
 		<Owners>MASES s.r.l.</Owners>
 		<Authors>MASES s.r.l.</Authors>
 		<Company>MASES s.r.l.</Company>
-		<Version>0.9.3.0</Version>
+		<Version>0.10.0.0</Version>
 		<TargetFrameworks>net6.0</TargetFrameworks>
 		<LangVersion>latest</LangVersion>
 		<GenerateAssemblyInfo>true</GenerateAssemblyInfo>

src/net/KEFCore.SerDes.Avro.Compiler/AvroSerializationHelper.cs

@@ -20,39 +20,16 @@
 
 #nullable enable
 
-using Avro;
+using MASES.KNet.Serialization.Avro;
 
 namespace MASES.EntityFrameworkCore.KNet.Serialization.Avro.Compiler;
 
 public static class AvroSerializationHelper
 {
-    public static void BuildSchemaClasses( string outputFolder, params string[] schemas)
-    {
-        var codegen = new CodeGen();
-        foreach (var schema in schemas)
-        {
-            codegen.AddSchema(schema);
-        }
-        codegen.GenerateCode();
-        codegen.WriteTypes(outputFolder, true);
-    }
-
-    public static void BuildSchemaClassesFromFiles( string outputFolder, params string[] schemaFiles)
-    {
-        var codegen = new CodeGen();
-        foreach (var schemaFile in schemaFiles)
-        {
-            var schema = File.ReadAllText(schemaFile);
-            codegen.AddSchema(schema);
-        }
-        codegen.GenerateCode();
-        codegen.WriteTypes(outputFolder, true);
-    }
-
     public static void BuildDefaultSchema(string outputFolder)
     {
-        BuildSchemaClassesFromFiles(outputFolder, "AvroValueContainer.avsc");
-        BuildSchemaClassesFromFiles(outputFolder, "AvroKeyContainer.avsc");
+       AvroSerDes.CompilerSupport.BuildSchemaClassesFromFiles(outputFolder, "AvroValueContainer.avsc");
+        AvroSerDes.CompilerSupport.BuildSchemaClassesFromFiles(outputFolder, "AvroKeyContainer.avsc");
     }
 }
 

src/net/KEFCore.SerDes.Avro.Compiler/KEFCore.SerDes.Avro.Compiler.csproj

@@ -23,7 +23,7 @@
 	</ItemGroup>
 
 	<ItemGroup>
-		<PackageReference Include="Apache.Avro" Version="1.11.3" />
+		<PackageReference Include="MASES.KNet.Serialization.Avro" Version="2.2.0" />
 		<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1">
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>

src/net/KEFCore.SerDes.Avro/AvroKEFCoreSerDes.cs

@@ -73,8 +73,8 @@ public override byte[] Serialize(string topic, T data)
             /// <inheritdoc cref="KNetSerDes{T}.SerializeWithHeaders(string, Headers, T)"/>
             public override byte[] SerializeWithHeaders(string topic, Headers headers, T data)
             {
-                headers?.Add(KEFCoreSerDesNames.KeyTypeIdentifier, keyTypeName);
-                headers?.Add(KEFCoreSerDesNames.KeySerializerIdentifier, keySerDesName);
+                headers?.Add(KNetSerialization.KeyTypeIdentifier, keyTypeName);
+                headers?.Add(KNetSerialization.KeySerializerIdentifier, keySerDesName);
 
                 if (_defaultSerDes != null) return _defaultSerDes.SerializeWithHeaders(topic, headers, data);
 
@@ -139,8 +139,8 @@ public override byte[] Serialize(string topic, T data)
             /// <inheritdoc cref="KNetSerDes{T}.SerializeWithHeaders(string, Headers, T)"/>
             public override byte[] SerializeWithHeaders(string topic, Headers headers, T data)
             {
-                headers?.Add(KEFCoreSerDesNames.KeyTypeIdentifier, keyTypeName);
-                headers?.Add(KEFCoreSerDesNames.KeySerializerIdentifier, keySerDesName);
+                headers?.Add(KNetSerialization.KeyTypeIdentifier, keyTypeName);
+                headers?.Add(KNetSerialization.KeySerializerIdentifier, keySerDesName);
 
                 if (_defaultSerDes != null) return _defaultSerDes.SerializeWithHeaders(topic, headers, data);
 
@@ -215,8 +215,8 @@ public override byte[] Serialize(string topic, T data)
             /// <inheritdoc cref="KNetSerDes{T}.SerializeWithHeaders(string, Headers, T)"/>
             public override byte[] SerializeWithHeaders(string topic, Headers headers, T data)
             {
-                headers?.Add(KEFCoreSerDesNames.ValueContainerSerializerIdentifier, valueContainerSerDesName);
-                headers?.Add(KEFCoreSerDesNames.ValueContainerIdentifier, valueContainerName);
+                headers?.Add(KNetSerialization.ValueSerializerIdentifier, valueContainerSerDesName);
+                headers?.Add(KNetSerialization.ValueTypeIdentifier, valueContainerName);
 
                 using MemoryStream memStream = new();
                 BinaryEncoder encoder = new(memStream);
@@ -280,8 +280,8 @@ public override byte[] Serialize(string topic, T data)
             /// <inheritdoc cref="KNetSerDes{T}.SerializeWithHeaders(string, Headers, T)"/>
             public override byte[] SerializeWithHeaders(string topic, Headers headers, T data)
             {
-                headers?.Add(KEFCoreSerDesNames.ValueContainerSerializerIdentifier, valueContainerSerDesName);
-                headers?.Add(KEFCoreSerDesNames.ValueContainerIdentifier, valueContainerName);
+                headers?.Add(KNetSerialization.ValueSerializerIdentifier, valueContainerSerDesName);
+                headers?.Add(KNetSerialization.ValueTypeIdentifier, valueContainerName);
 
                 using MemoryStream memStream = new();
                 JsonEncoder encoder = new(AvroValueContainer._SCHEMA, memStream);

src/net/KEFCore.SerDes/DefaultKEFCoreSerDes.cs

@@ -68,8 +68,8 @@ public override byte[] Serialize(string topic, T data)
             /// <inheritdoc cref="KNetSerDes{T}.SerializeWithHeaders(string, Headers, T)"/>
             public override byte[] SerializeWithHeaders(string topic, Headers headers, T data)
             {
-                headers?.Add(KEFCoreSerDesNames.KeyTypeIdentifier, keyTypeName);
-                headers?.Add(KEFCoreSerDesNames.KeySerializerIdentifier, keySerDesName);
+                headers?.Add(KNetSerialization.KeyTypeIdentifier, keyTypeName);
+                headers?.Add(KNetSerialization.KeySerializerIdentifier, keySerDesName);
 
                 if (_defaultSerDes != null) return _defaultSerDes.SerializeWithHeaders(topic, headers, data);
 
@@ -136,8 +136,8 @@ public override byte[] Serialize(string topic, T data)
             /// <inheritdoc cref="KNetSerDes{T}.SerializeWithHeaders(string, Headers, T)"/>
             public override byte[] SerializeWithHeaders(string topic, Headers headers, T data)
             {
-                headers?.Add(KEFCoreSerDesNames.ValueContainerSerializerIdentifier, valueContainerSerDesName);
-                headers?.Add(KEFCoreSerDesNames.ValueContainerIdentifier, valueContainerName);
+                headers?.Add(KNetSerialization.ValueSerializerIdentifier, valueContainerSerDesName);
+                headers?.Add(KNetSerialization.ValueTypeIdentifier, valueContainerName);
 
                 var jsonStr = System.Text.Json.JsonSerializer.Serialize<T>(data);
                 return Encoding.UTF8.GetBytes(jsonStr);

src/net/KEFCore.SerDes/KEFCore.SerDes.csproj

@@ -41,7 +41,7 @@
 	</ItemGroup>
 
 	<ItemGroup>
-		<PackageReference Include="MASES.KNet" Version="2.1.3">
+		<PackageReference Include="MASES.KNet" Version="2.2.0">
 			<IncludeAssets>All</IncludeAssets>
 			<PrivateAssets>None</PrivateAssets>
 		</PackageReference>