AvroReferences work.

VisualBean · VisualBean · commit c785ee8ebd45 · 2025-01-30T11:36:55.000+01:00
diff --git a/src/LEGO.AsyncAPI.Readers/AsyncApiJsonDocumentReader.cs b/src/LEGO.AsyncAPI.Readers/AsyncApiJsonDocumentReader.cs
@@ -295,8 +295,18 @@ private IAsyncApiSerializable ResolveStreamReferences(Stream stream, IAsyncApiRe
             switch (reference.Reference.Type)
             {
                 case ReferenceType.Schema:
-                    result = this.ReadFragment<AsyncApiJsonSchema>(json, AsyncApiVersion.AsyncApi2_0, out fragmentDiagnostic);
+                    if (reference is AsyncApiJsonSchemaReference)
+                    {
+                        result = this.ReadFragment<AsyncApiJsonSchema>(json, AsyncApiVersion.AsyncApi2_0, out fragmentDiagnostic);
+                    }
+
+                    if (reference is AsyncApiAvroSchemaReference)
+                    {
+                        result = this.ReadFragment<AsyncApiAvroSchema>(json, AsyncApiVersion.AsyncApi2_0, out fragmentDiagnostic);
+                    }
+
                     break;
+
                 case ReferenceType.Server:
                     result = this.ReadFragment<AsyncApiServer>(json, AsyncApiVersion.AsyncApi2_0, out fragmentDiagnostic);
                     break;
diff --git a/src/LEGO.AsyncAPI.Readers/V2/AsyncApiAvroSchemaDeserializer.cs b/src/LEGO.AsyncAPI.Readers/V2/AsyncApiAvroSchemaDeserializer.cs
@@ -236,11 +236,7 @@ public static AsyncApiAvroSchema LoadSchema(ParseNode node)
 
                 if (pointer != null)
                 {
-                    return new AvroRecord
-                    {
-                        UnresolvedReference = true,
-                        Reference = node.Context.VersionService.ConvertToAsyncApiReference(pointer, ReferenceType.Schema),
-                    };
+                    return new AsyncApiAvroSchemaReference(pointer);
                 }
 
                 var isLogicalType = mapNode["logicalType"] != null;
diff --git a/src/LEGO.AsyncAPI/Models/Avro/AsyncApiAvroSchema.cs b/src/LEGO.AsyncAPI/Models/Avro/AsyncApiAvroSchema.cs
@@ -7,7 +7,7 @@ namespace LEGO.AsyncAPI.Models
     using LEGO.AsyncAPI.Models.Interfaces;
     using LEGO.AsyncAPI.Writers;
 
-    public abstract class AsyncApiAvroSchema : IAsyncApiSerializable, IAsyncApiReferenceable, IAsyncApiMessagePayload
+    public abstract class AsyncApiAvroSchema : IAsyncApiSerializable, IAsyncApiMessagePayload
     {
         public abstract string Type { get; }
 
@@ -16,31 +16,29 @@ public abstract class AsyncApiAvroSchema : IAsyncApiSerializable, IAsyncApiRefer
         /// </summary>
         public abstract IDictionary<string, AsyncApiAny> Metadata { get; set; }
 
-        public bool UnresolvedReference { get; set; }
-
-        public AsyncApiReference Reference { get; set; }
-
         public static implicit operator AsyncApiAvroSchema(AvroPrimitiveType type)
         {
             return new AvroPrimitive(type);
         }
 
-        public virtual void SerializeV2(IAsyncApiWriter writer)
-        {
-            if (writer is null)
-            {
-                throw new ArgumentNullException(nameof(writer));
-            }
+        public abstract void SerializeV2(IAsyncApiWriter writer);
 
-            if (this.Reference != null && !writer.GetSettings().ShouldInlineReference(this.Reference))
-            {
-                this.Reference.SerializeV2(writer);
-                return;
-            }
-
-            this.SerializeV2Core(writer);
+        public virtual bool TryGetAs<T>(out T result)
+where T : AsyncApiAvroSchema
+        {
+            result = this as T;
+            return result != null;
+        }
+        public virtual bool Is<T>()
+            where T : AsyncApiAvroSchema
+        {
+            return this is T;
         }
 
-        public abstract void SerializeV2Core(IAsyncApiWriter writer);
+        public virtual T As<T>()
+            where T : AsyncApiAvroSchema
+        {
+            return this as T;
+        }
     }
 }
diff --git a/src/LEGO.AsyncAPI/Models/Avro/AvroArray.cs b/src/LEGO.AsyncAPI/Models/Avro/AvroArray.cs
@@ -20,7 +20,7 @@ public class AvroArray : AsyncApiAvroSchema
         /// </summary>
         public override IDictionary<string, AsyncApiAny> Metadata { get; set; } = new Dictionary<string, AsyncApiAny>();
 
-        public override void SerializeV2Core(IAsyncApiWriter writer)
+        public override void SerializeV2(IAsyncApiWriter writer)
         {
             writer.WriteStartObject();
             writer.WriteOptionalProperty("type", this.Type);
diff --git a/src/LEGO.AsyncAPI/Models/Avro/AvroEnum.cs b/src/LEGO.AsyncAPI/Models/Avro/AvroEnum.cs
@@ -45,7 +45,7 @@ public class AvroEnum : AsyncApiAvroSchema
         /// </summary>
         public override IDictionary<string, AsyncApiAny> Metadata { get; set; } = new Dictionary<string, AsyncApiAny>();
 
-        public override void SerializeV2Core(IAsyncApiWriter writer)
+        public override void SerializeV2(IAsyncApiWriter writer)
         {
             writer.WriteStartObject();
             writer.WriteOptionalProperty("type", this.Type);
diff --git a/src/LEGO.AsyncAPI/Models/Avro/AvroFixed.cs b/src/LEGO.AsyncAPI/Models/Avro/AvroFixed.cs
@@ -36,7 +36,7 @@ public class AvroFixed : AsyncApiAvroSchema
         /// </summary>
         public override IDictionary<string, AsyncApiAny> Metadata { get; set; } = new Dictionary<string, AsyncApiAny>();
 
-        public override void SerializeV2Core(IAsyncApiWriter writer)
+        public override void SerializeV2(IAsyncApiWriter writer)
         {
             writer.WriteStartObject();
             writer.WriteOptionalProperty("type", this.Type);
diff --git a/src/LEGO.AsyncAPI/Models/Avro/AvroMap.cs b/src/LEGO.AsyncAPI/Models/Avro/AvroMap.cs
@@ -17,7 +17,7 @@ public class AvroMap : AsyncApiAvroSchema
         /// </summary>
         public override IDictionary<string, AsyncApiAny> Metadata { get; set; } = new Dictionary<string, AsyncApiAny>();
 
-        public override void SerializeV2Core(IAsyncApiWriter writer)
+        public override void SerializeV2(IAsyncApiWriter writer)
         {
             writer.WriteStartObject();
             writer.WriteOptionalProperty("type", this.Type);
diff --git a/src/LEGO.AsyncAPI/Models/Avro/AvroPrimitive.cs b/src/LEGO.AsyncAPI/Models/Avro/AvroPrimitive.cs
@@ -20,7 +20,7 @@ public AvroPrimitive(AvroPrimitiveType type)
             this.Type = type.GetDisplayName();
         }
 
-        public override void SerializeV2Core(IAsyncApiWriter writer)
+        public override void SerializeV2(IAsyncApiWriter writer)
         {
             writer.WriteValue(this.Type);
             if (this.Metadata.Any())
diff --git a/src/LEGO.AsyncAPI/Models/Avro/AvroRecord.cs b/src/LEGO.AsyncAPI/Models/Avro/AvroRecord.cs
@@ -40,7 +40,7 @@ public class AvroRecord : AsyncApiAvroSchema
         /// </summary>
         public override IDictionary<string, AsyncApiAny> Metadata { get; set; } = new Dictionary<string, AsyncApiAny>();
 
-        public override void SerializeV2Core(IAsyncApiWriter writer)
+        public override void SerializeV2(IAsyncApiWriter writer)
         {
             writer.WriteStartObject();
             writer.WriteOptionalProperty("type", this.Type);
diff --git a/src/LEGO.AsyncAPI/Models/Avro/AvroUnion.cs b/src/LEGO.AsyncAPI/Models/Avro/AvroUnion.cs
@@ -20,7 +20,7 @@ public class AvroUnion : AsyncApiAvroSchema
         /// </summary>
         public override IDictionary<string, AsyncApiAny> Metadata { get; set; } = new Dictionary<string, AsyncApiAny>();
 
-        public override void SerializeV2Core(IAsyncApiWriter writer)
+        public override void SerializeV2(IAsyncApiWriter writer)
         {
             writer.WriteStartArray();
             foreach (var type in this.Types)
diff --git a/src/LEGO.AsyncAPI/Models/Avro/LogicalTypes/AvroDuration.cs b/src/LEGO.AsyncAPI/Models/Avro/LogicalTypes/AvroDuration.cs
@@ -11,7 +11,7 @@ public class AvroDuration : AvroFixed
 
         public new int Size { get; } = 12;
 
-        public override void SerializeV2Core(IAsyncApiWriter writer)
+        public override void SerializeV2(IAsyncApiWriter writer)
         {
             writer.WriteStartObject();
             writer.WriteOptionalProperty("type", this.Type);
diff --git a/src/LEGO.AsyncAPI/Models/MessagePayloadExtensions.cs b/src/LEGO.AsyncAPI/Models/MessagePayloadExtensions.cs
@@ -15,23 +15,16 @@ public static bool TryGetAs<T>(this IAsyncApiMessagePayload payload, out T resul
             return result != null;
         }
 
-        public static bool TryGetAs<T>(this AsyncApiAvroSchema avroSchema, out T result)
-    where T : AsyncApiAvroSchema
+        public static T As<T>(this IAsyncApiMessagePayload payload)
+            where T : class, IAsyncApiMessagePayload
         {
-            result = avroSchema as T;
-            return result != null;
+            return payload as T;
         }
 
         public static bool Is<T>(this IAsyncApiMessagePayload payload)
             where T : class, IAsyncApiMessagePayload
         {
             return payload is T;
         }
-
-        public static bool Is<T>(this AsyncApiAvroSchema schema)
-            where T : AsyncApiAvroSchema
-        {
-            return schema is T;
-        }
     }
 }
diff --git a/src/LEGO.AsyncAPI/Models/References/AsyncApiAvroSchemaReference.cs b/src/LEGO.AsyncAPI/Models/References/AsyncApiAvroSchemaReference.cs
@@ -0,0 +1,80 @@
+﻿// Copyright (c) The LEGO Group. All rights reserved.
+
+namespace LEGO.AsyncAPI.Models
+{
+    using System;
+    using System.Collections.Generic;
+    using LEGO.AsyncAPI.Models.Interfaces;
+    using LEGO.AsyncAPI.Writers;
+
+    public class AsyncApiAvroSchemaReference : AsyncApiAvroSchema, IAsyncApiReferenceable
+    {
+        private AsyncApiAvroSchema target;
+
+        private AsyncApiAvroSchema Target
+        {
+            get
+            {
+                this.target ??= this.Reference.Workspace?.ResolveReference<AsyncApiAvroSchema>(this.Reference);
+                return this.target;
+            }
+        }
+
+        public AsyncApiAvroSchemaReference(string reference)
+        {
+            this.Reference = new AsyncApiReference(reference, ReferenceType.Schema);
+        }
+
+        public override string Type => this.Target?.Type;
+
+        public override IDictionary<string, AsyncApiAny> Metadata { get => this.Target?.Metadata; set => this.Target.Metadata = value; }
+
+        public bool UnresolvedReference { get { return this.Target == null; } }
+
+        public AsyncApiReference Reference { get; set; }
+
+        public override T As<T>()
+        {
+            if (this.Target == null)
+            {
+                return null;
+            }
+            return this.Target.As<T>();
+        }
+
+        public override bool Is<T>()
+        {
+            if (Target == null)
+            {
+                return false;
+            }
+            return this.Target.Is<T>();
+        }
+
+        public override bool TryGetAs<T>(out T result)
+        {
+            if (this.Target == null)
+            {
+                result = default;
+                return false;
+            }
+            return this.Target.TryGetAs(out result);
+        }
+
+        public override void SerializeV2(IAsyncApiWriter writer)
+        {
+            if (writer is null)
+            {
+                throw new ArgumentNullException(nameof(writer));
+            }
+
+            if (this.Reference != null && !writer.GetSettings().ShouldInlineReference(this.Reference))
+            {
+                this.Reference.SerializeV2(writer);
+                return;
+            }
+
+            this.Target.SerializeV2(writer);
+        }
+    }
+}
diff --git a/src/LEGO.AsyncAPI/Services/AsyncApiReferenceResolver.cs b/src/LEGO.AsyncAPI/Services/AsyncApiReferenceResolver.cs
diff --git a/src/LEGO.AsyncAPI/Services/AsyncApiWalker.cs b/src/LEGO.AsyncAPI/Services/AsyncApiWalker.cs
@@ -343,6 +343,12 @@ internal void Walk(IAsyncApiMessagePayload payload)
 
         internal void Walk(AsyncApiAvroSchema schema)
         {
+            if (schema is AsyncApiAvroSchemaReference reference)
+            {
+                this.Walk(reference as IAsyncApiReferenceable);
+                return;
+            }
+
             this.visitor.Visit(schema);
         }
 
@@ -1079,6 +1085,7 @@ public void Walk(IAsyncApiElement element)
                 case AsyncApiOperation e: this.Walk(e); break;
                 case AsyncApiParameter e: this.Walk(e); break;
                 case AsyncApiJsonSchema e: this.Walk(e); break;
+                case AsyncApiAvroSchema e: this.Walk(e); break;
                 case AsyncApiSecurityRequirement e: this.Walk(e); break;
                 case AsyncApiSecurityScheme e: this.Walk(e); break;
                 case AsyncApiServer e: this.Walk(e); break;
diff --git a/src/LEGO.AsyncAPI/Writers/AsyncApiWriterSettings.cs b/src/LEGO.AsyncAPI/Writers/AsyncApiWriterSettings.cs
@@ -72,6 +72,11 @@ public ReferenceInlineSetting ReferenceInline
         /// <returns>True if it should be inlined otherwise false.</returns>
         public bool ShouldInlineReference(AsyncApiReference reference)
         {
+            if (reference.IsExternal)
+            {
+                return false;
+            }
+
             return this.InlineLocalReferences;
         }
     }
diff --git a/test/LEGO.AsyncAPI.Tests/Models/AsyncApiReference_Should.cs b/test/LEGO.AsyncAPI.Tests/Models/AsyncApiReference_Should.cs

Original file line number	Diff line number	Diff line change
`@@ -236,11 +236,7 @@ public static AsyncApiAvroSchema LoadSchema(ParseNode node)`
`236`	`236`
`237`	`237`	`if (pointer != null)`
`238`	`238`	`{`
`239`		`- return new AvroRecord`
`240`		`- {`
`241`		`- UnresolvedReference = true,`
`242`		`- Reference = node.Context.VersionService.ConvertToAsyncApiReference(pointer, ReferenceType.Schema),`
`243`		`- };`
	`239`	`+ return new AsyncApiAvroSchemaReference(pointer);`
`244`	`240`	`}`
`245`	`241`
`246`	`242`	`var isLogicalType = mapNode["logicalType"] != null;`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ public class AvroArray : AsyncApiAvroSchema`
`20`	`20`	`/// </summary>`
`21`	`21`	`public override IDictionary<string, AsyncApiAny> Metadata { get; set; } = new Dictionary<string, AsyncApiAny>();`
`22`	`22`
`23`		`- public override void SerializeV2Core(IAsyncApiWriter writer)`
	`23`	`+ public override void SerializeV2(IAsyncApiWriter writer)`
`24`	`24`	`{`
`25`	`25`	`writer.WriteStartObject();`
`26`	`26`	`writer.WriteOptionalProperty("type", this.Type);`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ public class AvroEnum : AsyncApiAvroSchema`
`45`	`45`	`/// </summary>`
`46`	`46`	`public override IDictionary<string, AsyncApiAny> Metadata { get; set; } = new Dictionary<string, AsyncApiAny>();`
`47`	`47`
`48`		`- public override void SerializeV2Core(IAsyncApiWriter writer)`
	`48`	`+ public override void SerializeV2(IAsyncApiWriter writer)`
`49`	`49`	`{`
`50`	`50`	`writer.WriteStartObject();`
`51`	`51`	`writer.WriteOptionalProperty("type", this.Type);`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public class AvroFixed : AsyncApiAvroSchema`
`36`	`36`	`/// </summary>`
`37`	`37`	`public override IDictionary<string, AsyncApiAny> Metadata { get; set; } = new Dictionary<string, AsyncApiAny>();`
`38`	`38`
`39`		`- public override void SerializeV2Core(IAsyncApiWriter writer)`
	`39`	`+ public override void SerializeV2(IAsyncApiWriter writer)`
`40`	`40`	`{`
`41`	`41`	`writer.WriteStartObject();`
`42`	`42`	`writer.WriteOptionalProperty("type", this.Type);`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ public class AvroMap : AsyncApiAvroSchema`
`17`	`17`	`/// </summary>`
`18`	`18`	`public override IDictionary<string, AsyncApiAny> Metadata { get; set; } = new Dictionary<string, AsyncApiAny>();`
`19`	`19`
`20`		`- public override void SerializeV2Core(IAsyncApiWriter writer)`
	`20`	`+ public override void SerializeV2(IAsyncApiWriter writer)`
`21`	`21`	`{`
`22`	`22`	`writer.WriteStartObject();`
`23`	`23`	`writer.WriteOptionalProperty("type", this.Type);`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ public AvroPrimitive(AvroPrimitiveType type)`
`20`	`20`	`this.Type = type.GetDisplayName();`
`21`	`21`	`}`
`22`	`22`
`23`		`- public override void SerializeV2Core(IAsyncApiWriter writer)`
	`23`	`+ public override void SerializeV2(IAsyncApiWriter writer)`
`24`	`24`	`{`
`25`	`25`	`writer.WriteValue(this.Type);`
`26`	`26`	`if (this.Metadata.Any())`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public class AvroRecord : AsyncApiAvroSchema`
`40`	`40`	`/// </summary>`
`41`	`41`	`public override IDictionary<string, AsyncApiAny> Metadata { get; set; } = new Dictionary<string, AsyncApiAny>();`
`42`	`42`
`43`		`- public override void SerializeV2Core(IAsyncApiWriter writer)`
	`43`	`+ public override void SerializeV2(IAsyncApiWriter writer)`
`44`	`44`	`{`
`45`	`45`	`writer.WriteStartObject();`
`46`	`46`	`writer.WriteOptionalProperty("type", this.Type);`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ public class AvroUnion : AsyncApiAvroSchema`
`20`	`20`	`/// </summary>`
`21`	`21`	`public override IDictionary<string, AsyncApiAny> Metadata { get; set; } = new Dictionary<string, AsyncApiAny>();`
`22`	`22`
`23`		`- public override void SerializeV2Core(IAsyncApiWriter writer)`
	`23`	`+ public override void SerializeV2(IAsyncApiWriter writer)`
`24`	`24`	`{`
`25`	`25`	`writer.WriteStartArray();`
`26`	`26`	`foreach (var type in this.Types)`