First try of implementing avro

still missing a few bits and bobs

Author: VisualBean

src/LEGO.AsyncAPI.Bindings/Http/HttpMessageBinding.cs

@@ -42,7 +42,7 @@ public override void SerializeProperties(IAsyncApiWriter writer)
         protected override FixedFieldMap<HttpMessageBinding> FixedFieldMap => new()
         {
             { "bindingVersion", (a, n) => { a.BindingVersion = n.GetScalarValue(); } },
-            { "headers", (a, n) => { a.Headers = JsonSchemaDeserializer.LoadSchema(n); } },
+            { "headers", (a, n) => { a.Headers = AsyncApiSchemaDeserializer.LoadSchema(n); } },
         };
     }
 }

src/LEGO.AsyncAPI.Bindings/Http/HttpOperationBinding.cs

@@ -63,7 +63,7 @@ public override void SerializeProperties(IAsyncApiWriter writer)
             { "bindingVersion", (a, n) => { a.BindingVersion = n.GetScalarValue(); } },
             { "type", (a, n) => { a.Type = n.GetScalarValue().GetEnumFromDisplayName<HttpOperationType>(); } },
             { "method", (a, n) => { a.Method = n.GetScalarValue(); } },
-            { "query", (a, n) => { a.Query = JsonSchemaDeserializer.LoadSchema(n); } },
+            { "query", (a, n) => { a.Query = AsyncApiSchemaDeserializer.LoadSchema(n); } },
         };
 
         public override string BindingKey => "http";

src/LEGO.AsyncAPI.Bindings/Kafka/KafkaMessageBinding.cs

@@ -67,7 +67,7 @@ public override void SerializeProperties(IAsyncApiWriter writer)
         protected override FixedFieldMap<KafkaMessageBinding> FixedFieldMap => new()
         {
             { "bindingVersion", (a, n) => { a.BindingVersion = n.GetScalarValue(); } },
-            { "key", (a, n) => { a.Key = JsonSchemaDeserializer.LoadSchema(n); } },
+            { "key", (a, n) => { a.Key = AsyncApiSchemaDeserializer.LoadSchema(n); } },
             { "schemaIdLocation", (a, n) => { a.SchemaIdLocation = n.GetScalarValue(); } },
             { "schemaIdPayloadEncoding", (a, n) => { a.SchemaIdPayloadEncoding = n.GetScalarValue(); } },
             { "schemaLookupStrategy", (a, n) => { a.SchemaLookupStrategy = n.GetScalarValue(); } },

src/LEGO.AsyncAPI.Bindings/Kafka/KafkaOperationBinding.cs

@@ -28,8 +28,8 @@ public class KafkaOperationBinding : OperationBinding<KafkaOperationBinding>
         protected override FixedFieldMap<KafkaOperationBinding> FixedFieldMap => new()
         {
             { "bindingVersion", (a, n) => { a.BindingVersion = n.GetScalarValue(); } },
-            { "groupId", (a, n) => { a.GroupId = JsonSchemaDeserializer.LoadSchema(n); } },
-            { "clientId", (a, n) => { a.ClientId = JsonSchemaDeserializer.LoadSchema(n); } },
+            { "groupId", (a, n) => { a.GroupId = AsyncApiSchemaDeserializer.LoadSchema(n); } },
+            { "clientId", (a, n) => { a.ClientId = AsyncApiSchemaDeserializer.LoadSchema(n); } },
         };
 
         /// <summary>

src/LEGO.AsyncAPI.Bindings/MQTT/MQTTMessageBinding.cs

@@ -57,7 +57,7 @@ public override void SerializeProperties(IAsyncApiWriter writer)
         protected override FixedFieldMap<MQTTMessageBinding> FixedFieldMap => new()
         {
             { "payloadFormatIndicator", (a, n) => { a.PayloadFormatIndicator = n.GetIntegerValueOrDefault(); } },
-            { "correlationData", (a, n) => { a.CorrelationData = JsonSchemaDeserializer.LoadSchema(n); } },
+            { "correlationData", (a, n) => { a.CorrelationData = AsyncApiSchemaDeserializer.LoadSchema(n); } },
             { "contentType", (a, n) => { a.ContentType = n.GetScalarValue(); } },
             { "responseTopic", (a, n) => { a.ResponseTopic = n.GetScalarValue(); } },
         };

src/LEGO.AsyncAPI.Bindings/WebSockets/WebSocketsChannelBinding.cs

@@ -31,8 +31,8 @@ public class WebSocketsChannelBinding : ChannelBinding<WebSocketsChannelBinding>
         {
             { "bindingVersion", (a, n) => { a.BindingVersion = n.GetScalarValue(); } },
             { "method", (a, n) => { a.Method = n.GetScalarValue(); } },
-            { "query", (a, n) => { a.Query = JsonSchemaDeserializer.LoadSchema(n); } },
-            { "headers", (a, n) => { a.Headers = JsonSchemaDeserializer.LoadSchema(n); } },
+            { "query", (a, n) => { a.Query = AsyncApiSchemaDeserializer.LoadSchema(n); } },
+            { "headers", (a, n) => { a.Headers = AsyncApiSchemaDeserializer.LoadSchema(n); } },
         };
 
         public override void SerializeProperties(IAsyncApiWriter writer)

src/LEGO.AsyncAPI.Readers/AsyncApiExternalReferenceResolver.cs

@@ -91,7 +91,10 @@ public override void Visit(AsyncApiOperation operation)
         public override void Visit(AsyncApiMessage message)
         {
             this.ResolveObject(message.Headers, r => message.Headers = r);
-            this.ResolveObject(message.Payload, r => message.Payload = r);
+            if (message.Payload is AsyncApiSchemaPayload)
+            {
+                this.ResolveObject(message.Payload as AsyncApiSchemaPayload, r => message.Payload = r);
+            }
             this.ResolveList(message.Traits);
             this.ResolveObject(message.CorrelationId, r => message.CorrelationId = r);
             this.ResolveObject(message.Bindings, r => message.Bindings = r);

src/LEGO.AsyncAPI.Readers/ParseNodes/PropertyNode.cs

@@ -79,7 +79,7 @@ public void ParseField<T>(
                 else
                 {
                     this.Context.Diagnostic.Errors.Add(
-                        new AsyncApiError("", $"{this.Name} is not a valid property at {this.Context.GetLocation()}"));
+                        new AsyncApiError(string.Empty, $"{this.Name} is not a valid property at {this.Context.GetLocation()}"));
                 }
             }
         }

src/LEGO.AsyncAPI.Readers/V2/AsyncApiComponentsDeserializer.cs

@@ -10,7 +10,7 @@ internal static partial class AsyncApiV2Deserializer
     {
         private static FixedFieldMap<AsyncApiComponents> componentsFixedFields = new()
         {
-            { "schemas", (a, n) => a.Schemas = n.CreateMapWithReference(ReferenceType.Schema, JsonSchemaDeserializer.LoadSchema) },
+            { "schemas", (a, n) => a.Schemas = n.CreateMapWithReference(ReferenceType.Schema, AsyncApiSchemaDeserializer.LoadSchema) },
             { "servers", (a, n) => a.Servers = n.CreateMapWithReference(ReferenceType.Server, LoadServer) },
             { "channels", (a, n) => a.Channels = n.CreateMapWithReference(ReferenceType.Channel, LoadChannel) },
             { "messages", (a, n) => a.Messages = n.CreateMapWithReference(ReferenceType.Message, LoadMessage) },

src/LEGO.AsyncAPI.Readers/V2/AsyncApiMessageDeserializer.cs

@@ -5,10 +5,19 @@ namespace LEGO.AsyncAPI.Readers
     using LEGO.AsyncAPI.Exceptions;
     using LEGO.AsyncAPI.Extensions;
     using LEGO.AsyncAPI.Models;
+    using LEGO.AsyncAPI.Models.Interfaces;
     using LEGO.AsyncAPI.Readers.ParseNodes;
+    using System;
     using System.Collections.Generic;
+    using System.Diagnostics.CodeAnalysis;
     using System.Linq;
 
+
+    internal static partial class AsyncApiV2Deserializer
+    {
+
+    }
+
     /// <summary>
     /// Class containing logic to deserialize AsyncApi document into
     /// runtime AsyncApi object model.
@@ -21,10 +30,10 @@ internal static partial class AsyncApiV2Deserializer
                 "messageId", (a, n) => { a.MessageId = n.GetScalarValue(); }
             },
             {
-                "headers", (a, n) => { a.Headers = JsonSchemaDeserializer.LoadSchema(n); }
+                "headers", (a, n) => { a.Headers = AsyncApiSchemaDeserializer.LoadSchema(n); }
             },
             {
-                "payload", (a, n) => { a.Payload = JsonSchemaDeserializer.LoadSchema(n); }
+                "payload", (a, n) => { a.Payload = null; /* resolved after the initial run */ }
             },
             {
                 "correlationId", (a, n) => { a.CorrelationId = LoadCorrelationId(n); }
@@ -64,7 +73,34 @@ internal static partial class AsyncApiV2Deserializer
             },
         };
 
-        static readonly IEnumerable<string> SupportedSchemaFormats = new List<string>
+        public static IAsyncApiMessagePayload LoadPayload(ParseNode n)
+        {
+            // #ToFix figure out a way to get the format in a proper way.
+            return LoadPayload(n, null);
+        }
+
+        private static IAsyncApiMessagePayload LoadPayload(ParseNode n, string format)
+        {
+            if (n == null)
+            {
+                return null;
+            }
+
+            switch (format)
+            {
+                case null:
+                case "":
+                case var _ when SupportedJsonSchemaFormats.Where(s => format.StartsWith(s)).Any():
+                    return new AsyncApiSchemaPayload(AsyncApiSchemaDeserializer.LoadSchema(n));
+                case var _ when SupportedAvroSchemaFormats.Where(s => format.StartsWith(s)).Any():
+                    return new AsyncApiAvroSchemaPayload();
+                default:
+                    var supportedFormats = SupportedJsonSchemaFormats.Concat(SupportedAvroSchemaFormats);
+                    throw new AsyncApiException($"'Could not deserialize Payload. Supported formats are {string.Join(", ", supportedFormats)}");
+            }
+        }
+
+        static readonly IEnumerable<string> SupportedJsonSchemaFormats = new List<string>
         {
             "application/vnd.aai.asyncapi+json",
             "application/vnd.aai.asyncapi+yaml",
@@ -73,11 +109,18 @@ internal static partial class AsyncApiV2Deserializer
             "application/schema+yaml;version=draft-07",
         };
 
+        static readonly IEnumerable<string> SupportedAvroSchemaFormats = new List<string>
+        {
+            "application/vnd.apache.avro+json;version=1.9.0",
+            "application/vnd.apache.avro+yaml;version=1.9.0",
+        };
+
         private static string LoadSchemaFormat(string schemaFormat)
         {
-            if (!SupportedSchemaFormats.Where(s => schemaFormat.StartsWith(s)).Any())
+            var supportedFormats = SupportedJsonSchemaFormats.Concat(SupportedAvroSchemaFormats);
+            if (!supportedFormats.Where(s => schemaFormat.StartsWith(s)).Any())
             {
-                throw new AsyncApiException($"'{schemaFormat}' is not a supported format. Supported formats are {string.Join(", ", SupportedSchemaFormats)}");
+                throw new AsyncApiException($"'{schemaFormat}' is not a supported format. Supported formats are {string.Join(", ", supportedFormats)}");
             }
 
             return schemaFormat;
@@ -100,6 +143,7 @@ public static AsyncApiMessage LoadMessage(ParseNode node)
             var message = new AsyncApiMessage();
 
             ParseMap(mapNode, message, messageFixedFields, messagePatternFields);
+            message.Payload = LoadPayload(mapNode["payload"]?.Value, message.SchemaFormat);
 
             return message;
         }

src/LEGO.AsyncAPI.Readers/V2/AsyncApiMessageTraitDeserializer.cs

@@ -11,7 +11,7 @@ internal static partial class AsyncApiV2Deserializer
         private static FixedFieldMap<AsyncApiMessageTrait> messageTraitFixedFields = new()
         {
             { "messageId", (a, n) => { a.MessageId = n.GetScalarValue(); } },
-            { "headers", (a, n) => { a.Headers = JsonSchemaDeserializer.LoadSchema(n); } },
+            { "headers", (a, n) => { a.Headers = AsyncApiSchemaDeserializer.LoadSchema(n); } },
             { "correlationId", (a, n) => { a.CorrelationId = LoadCorrelationId(n); } },
             { "schemaFormat", (a, n) => { a.SchemaFormat = n.GetScalarValue(); } },
             { "contentType", (a, n) => { a.ContentType = n.GetScalarValue(); } },

src/LEGO.AsyncAPI.Readers/V2/AsyncApiParameterDeserializer.cs

@@ -11,7 +11,7 @@ internal static partial class AsyncApiV2Deserializer
         private static FixedFieldMap<AsyncApiParameter> parameterFixedFields = new()
         {
             { "description", (a, n) => { a.Description = n.GetScalarValue(); } },
-            { "schema", (a, n) => { a.Schema = JsonSchemaDeserializer.LoadSchema(n); } },
+            { "schema", (a, n) => { a.Schema = AsyncApiSchemaDeserializer.LoadSchema(n); } },
             { "location", (a, n) => { a.Location = n.GetScalarValue(); } },
         };
 

src/LEGO.AsyncAPI.Readers/V2/AsyncApiSchemaDeserializer.cs

@@ -9,7 +9,7 @@ namespace LEGO.AsyncAPI.Readers
     using LEGO.AsyncAPI.Readers.ParseNodes;
     using LEGO.AsyncAPI.Writers;
 
-    public class JsonSchemaDeserializer
+    public class AsyncApiSchemaDeserializer
     {
         private static readonly FixedFieldMap<AsyncApiSchema> schemaFixedFields = new()
         {

src/LEGO.AsyncAPI.Readers/V2/AsyncApiV2VersionService.cs

@@ -35,7 +35,8 @@ public AsyncApiV2VersionService(AsyncApiDiagnostic diagnostic)
             [typeof(AsyncApiOAuthFlows)] = AsyncApiV2Deserializer.LoadOAuthFlows,
             [typeof(AsyncApiOperation)] = AsyncApiV2Deserializer.LoadOperation,
             [typeof(AsyncApiParameter)] = AsyncApiV2Deserializer.LoadParameter,
-            [typeof(AsyncApiSchema)] = JsonSchemaDeserializer.LoadSchema,
+            [typeof(AsyncApiSchema)] = AsyncApiSchemaDeserializer.LoadSchema,
+            [typeof(AsyncApiSchemaPayload)] = AsyncApiV2Deserializer.LoadPayload, // #ToFix how do we get the schemaFormat?!
             [typeof(AsyncApiSecurityRequirement)] = AsyncApiV2Deserializer.LoadSecurityRequirement,
             [typeof(AsyncApiSecurityScheme)] = AsyncApiV2Deserializer.LoadSecurityScheme,
             [typeof(AsyncApiServer)] = AsyncApiV2Deserializer.LoadServer,

src/LEGO.AsyncAPI/Models/AsyncApiAvroSchemaPayload.cs

@@ -0,0 +1,16 @@
+// Copyright (c) The LEGO Group. All rights reserved.
+
+namespace LEGO.AsyncAPI.Models
+{
+    using System;
+    using LEGO.AsyncAPI.Models.Interfaces;
+    using LEGO.AsyncAPI.Writers;
+
+    public class AsyncApiAvroSchemaPayload : IAsyncApiMessagePayload
+    {
+        public void SerializeV2(IAsyncApiWriter writer)
+        {
+            throw new NotImplementedException();
+        }
+    }
+}

src/LEGO.AsyncAPI/Models/AsyncApiMessage.cs

@@ -25,7 +25,7 @@ public class AsyncApiMessage : IAsyncApiExtensible, IAsyncApiReferenceable, IAsy
         /// <summary>
         /// definition of the message payload. It can be of any type but defaults to Schema object. It must match the schema format, including encoding type - e.g Avro should be inlined as either a YAML or JSON object NOT a string to be parsed as YAML or JSON.
         /// </summary>
-        public AsyncApiSchema Payload { get; set; }
+        public IAsyncApiMessagePayload Payload { get; set; }
 
         /// <summary>
         /// definition of the correlation ID used for message tracing or matching.

src/LEGO.AsyncAPI/Models/AsyncApiSchemaPayload.cs

@@ -0,0 +1,128 @@
+// Copyright (c) The LEGO Group. All rights reserved.
+
+namespace LEGO.AsyncAPI.Models
+{
+    using System.Collections.Generic;
+    using System.Runtime.CompilerServices;
+    using LEGO.AsyncAPI.Models.Interfaces;
+    using LEGO.AsyncAPI.Writers;
+
+    public class AsyncApiSchemaPayload : IAsyncApiMessagePayload, IAsyncApiReferenceable
+    {
+        private readonly AsyncApiSchema schema;
+
+        public AsyncApiSchemaPayload()
+        {
+            this.schema = new AsyncApiSchema();
+        }
+
+        public AsyncApiSchemaPayload(AsyncApiSchema schema)
+        {
+            this.schema = schema;
+        }
+
+        public string Title { get => this.schema.Title; set => this.schema.Title = value; }
+
+        public SchemaType? Type { get => this.schema.Type; set => this.schema.Type = value; }
+
+        public string Format { get => this.schema.Format; set => this.schema.Format = value; }
+
+        public string Description { get => this.schema.Description; set => this.schema.Description = value; }
+
+        public double? Maximum { get => this.schema.Maximum; set => this.schema.Maximum = value; }
+
+        public bool? ExclusiveMaximum { get => this.schema.ExclusiveMaximum; set => this.schema.ExclusiveMaximum = value; }
+
+        public double? Minimum { get => this.schema.Minimum; set => this.schema.Minimum = value; }
+
+        public bool? ExclusiveMinimum { get => this.schema.ExclusiveMinimum; set => this.schema.ExclusiveMinimum = value; }
+
+        public int? MaxLength { get => this.schema.MaxLength; set => this.schema.MaxLength = value; }
+
+        public int? MinLength { get => this.schema.MinLength; set => this.schema.MinLength = value; }
+
+        public string Pattern { get => this.schema.Pattern; set => this.schema.Pattern = value; }
+
+        public double? MultipleOf { get => this.schema.MultipleOf; set => this.schema.MultipleOf = value; }
+
+        public AsyncApiAny Default { get => this.schema.Default; set => this.schema.Default = value; }
+
+        public bool ReadOnly { get => this.schema.ReadOnly; set => this.schema.ReadOnly = value; }
+
+        public bool WriteOnly { get => this.schema.WriteOnly; set => this.schema.WriteOnly = value; }
+
+        public IList<AsyncApiSchema> AllOf { get => this.schema.AllOf; set => this.schema.AllOf = value; }
+
+        public IList<AsyncApiSchema> OneOf { get => this.schema.OneOf; set => this.schema.OneOf = value; }
+
+        public IList<AsyncApiSchema> AnyOf { get => this.schema.AnyOf; set => this.schema.AnyOf = value; }
+
+        public AsyncApiSchema Not { get => this.schema.Not; set => this.schema.Not = value; }
+
+        public AsyncApiSchema Contains { get => this.schema.Contains; set => this.schema.Contains = value; }
+
+        public AsyncApiSchema If { get => this.schema.If; set => this.schema.If = value; }
+
+        public AsyncApiSchema Then { get => this.schema.Then; set => this.schema.Then = value; }
+
+        public AsyncApiSchema Else { get => this.schema.Else; set => this.schema.Else = value; }
+
+        public ISet<string> Required { get => this.schema.Required; set => this.schema.Required = value; }
+
+        public AsyncApiSchema Items { get => this.schema.Items; set => this.schema.Items = value; }
+
+        public AsyncApiSchema AdditionalItems { get => this.schema.AdditionalItems; set => this.schema.AdditionalItems = value; }
+
+        public int? MaxItems { get => this.schema.MaxItems; set => this.schema.MaxItems = value; }
+
+        public int? MinItems { get => this.schema.MinItems; set => this.schema.MinItems = value; }
+
+        public bool? UniqueItems { get => this.schema.UniqueItems; set => this.schema.UniqueItems = value; }
+
+        public IDictionary<string, AsyncApiSchema> Properties { get => this.schema.Properties; set => this.schema.Properties = value; }
+
+        public int? MaxProperties { get => this.schema.MaxProperties; set => this.schema.MaxProperties = value; }
+
+        public int? MinProperties { get => this.schema.MinProperties; set => this.schema.MinProperties = value; }
+
+        public IDictionary<string, AsyncApiSchema> PatternProperties { get => this.schema.PatternProperties; set => this.schema.PatternProperties = value; }
+
+        public AsyncApiSchema PropertyNames { get => this.schema.PropertyNames; set => this.schema.PropertyNames = value; }
+
+        public string Discriminator { get => this.schema.Discriminator; set => this.schema.Discriminator = value; }
+
+        public IList<AsyncApiAny> Enum { get => this.schema.Enum; set => this.schema.Enum = value; }
+
+        public IList<AsyncApiAny> Examples { get => this.schema.Examples; set => this.schema.Examples = value; }
+
+        public AsyncApiAny Const { get => this.schema.Const; set => this.schema.Const = value; }
+
+        public bool Nullable { get => this.schema.Nullable; set => this.schema.Nullable = value; }
+
+        public AsyncApiExternalDocumentation ExternalDocs { get => this.schema.ExternalDocs; set => this.schema.ExternalDocs = value; }
+
+        public bool Deprecated { get => this.schema.Deprecated; set => this.schema.Deprecated = value; }
+
+        public bool UnresolvedReference { get => this.schema.UnresolvedReference; set => this.schema.UnresolvedReference = value; }
+
+        public AsyncApiReference Reference { get => this.schema.Reference; set => this.schema.Reference = value; }
+
+        public IDictionary<string, IAsyncApiExtension> Extensions { get => this.schema.Extensions; set => this.schema.Extensions = value; }
+
+        public AsyncApiSchema AdditionalProperties { get => this.schema.AdditionalProperties; set => this.schema.AdditionalProperties = value; }
+
+        public static implicit operator AsyncApiSchema(AsyncApiSchemaPayload payload) => payload.schema;
+
+        public static implicit operator AsyncApiSchemaPayload(AsyncApiSchema schema) => new AsyncApiSchemaPayload(schema);
+
+        public void SerializeV2(IAsyncApiWriter writer)
+        {
+            this.schema.SerializeV2(writer);
+        }
+
+        public void SerializeV2WithoutReference(IAsyncApiWriter writer)
+        {
+            this.schema.SerializeV2WithoutReference(writer);
+        }
+    }
+}

src/LEGO.AsyncAPI/Models/Interfaces/IAsyncApiPayload.cs

@@ -0,0 +1,8 @@
+// Copyright (c) The LEGO Group. All rights reserved.
+
+namespace LEGO.AsyncAPI.Models.Interfaces
+{
+    public interface IAsyncApiMessagePayload : IAsyncApiSerializable
+    {
+    }
+}