remote notion of HostDocument in favour of workspace

LEGO · Jan 29, 2025 · 06abb47 · 06abb47
1 parent 31f4868
commit 06abb47
Show file tree

Hide file tree

Showing 19 changed files with 41 additions and 37 deletions.
diff --git a/src/LEGO.AsyncAPI.Readers/AsyncApiJsonDocumentReader.cs b/src/LEGO.AsyncAPI.Readers/AsyncApiJsonDocumentReader.cs
@@ -197,7 +197,7 @@ private void ResolveInternalReferences(AsyncApiDiagnostic diagnostic, AsyncApiDo
         {
             var reader = new AsyncApiStringReader(this.settings);
 
-            var resolver = new AsyncApiReferenceHostDocumentResolver(document);
+            var resolver = new AsyncApiReferenceHostDocumentResolver(this.context.Workspace);
             var walker = new AsyncApiWalker(resolver);
             walker.Walk(document);
 
@@ -210,7 +210,7 @@ private void ResolveInternalReferences(AsyncApiDiagnostic diagnostic, AsyncApiDo
         private void ResolveExternalReferences(AsyncApiDiagnostic diagnostic, IAsyncApiSerializable serializable, AsyncApiDocument hostDocument)
         {
             var loader = this.settings.ExternalReferenceLoader ??= new DefaultStreamLoader(this.settings);
-            var collector = new AsyncApiRemoteReferenceCollector(hostDocument);
+            var collector = new AsyncApiRemoteReferenceCollector(this.context.Workspace);
             var walker = new AsyncApiWalker(collector);
             walker.Walk(serializable);
 

diff --git a/src/LEGO.AsyncAPI.Readers/AsyncApiReferenceHostDocumentResolver.cs b/src/LEGO.AsyncAPI.Readers/AsyncApiReferenceHostDocumentResolver.cs
@@ -9,13 +9,13 @@ namespace LEGO.AsyncAPI.Readers
 
     internal class AsyncApiReferenceHostDocumentResolver : AsyncApiVisitorBase
     {
-        private AsyncApiDocument currentDocument;
+        private AsyncApiWorkspace workspace;
         private List<AsyncApiError> errors = new List<AsyncApiError>();
 
         public AsyncApiReferenceHostDocumentResolver(
-            AsyncApiDocument currentDocument)
+            AsyncApiWorkspace workspace)
         {
-            this.currentDocument = currentDocument;
+            this.workspace = workspace;
         }
 
         public IEnumerable<AsyncApiError> Errors
@@ -30,7 +30,7 @@ public override void Visit(IAsyncApiReferenceable referenceable)
         {
             if (referenceable.Reference != null)
             {
-                referenceable.Reference.HostDocument = this.currentDocument;
+                referenceable.Reference.Workspace = this.workspace;
             }
         }
     }

diff --git a/src/LEGO.AsyncAPI.Readers/Services/AsyncApiRemoteReferenceCollector.cs b/src/LEGO.AsyncAPI.Readers/Services/AsyncApiRemoteReferenceCollector.cs
@@ -10,12 +10,12 @@ namespace LEGO.AsyncAPI.Readers.Services
     internal class AsyncApiRemoteReferenceCollector : AsyncApiVisitorBase
     {
         private readonly List<IAsyncApiReferenceable> references = new();
-        private AsyncApiDocument currentDocument;
+        private AsyncApiWorkspace workspace;
 
         public AsyncApiRemoteReferenceCollector(
-            AsyncApiDocument currentDocument)
+            AsyncApiWorkspace workspace)
         {
-            this.currentDocument = currentDocument;
+            this.workspace = workspace;
         }
         /// <summary>
         /// List of all external references collected from AsyncApiDocument.
@@ -36,9 +36,9 @@ public override void Visit(IAsyncApiReferenceable referenceable)
         {
             if (referenceable.Reference != null && referenceable.Reference.IsExternal)
             {
-                if (referenceable.Reference.HostDocument == null)
+                if (referenceable.Reference.Workspace == null)
                 {
-                    referenceable.Reference.HostDocument = this.currentDocument;
+                    referenceable.Reference.Workspace = this.workspace;
                 }
 
                 this.references.Add(referenceable);

diff --git a/src/LEGO.AsyncAPI/AsyncApiWorkspace.cs b/src/LEGO.AsyncAPI/AsyncApiWorkspace.cs
@@ -161,6 +161,12 @@ public bool Contains(string location)
             return this.resolvedReferenceRegistry.ContainsKey(key) || this.artifactsRegistry.ContainsKey(key);
         }
 
+        public T ResolveReference<T>(AsyncApiReference reference)
+            where T : class
+        {
+            return this.ResolveReference<T>(reference.Reference);
+        }
+
         public T ResolveReference<T>(string location)
             where T : class
         {

diff --git a/src/LEGO.AsyncAPI/Models/AsyncApiDocument.cs b/src/LEGO.AsyncAPI/Models/AsyncApiDocument.cs
@@ -74,8 +74,8 @@ public void SerializeV2(IAsyncApiWriter writer)
             }
 
             this.Workspace.RegisterComponents(this);
+            writer.Workspace = this.Workspace;
 
-            writer.RootDocument = this;
             writer.WriteStartObject();
 
             // asyncApi

diff --git a/src/LEGO.AsyncAPI/Models/AsyncApiReference.cs b/src/LEGO.AsyncAPI/Models/AsyncApiReference.cs
@@ -105,7 +105,7 @@ public string ExternalResource
         /// <summary>
         /// Gets or sets the AsyncApiDocument that is hosting the AsyncApiReference instance. This is used to enable dereferencing the reference.
         /// </summary>
-        public AsyncApiDocument HostDocument { get; set; } = null;
+        public AsyncApiWorkspace Workspace { get; set; } = null;
 
         /// <summary>
         /// Gets a flag indicating whether a file is a valid OpenAPI document or a fragment.

diff --git a/src/LEGO.AsyncAPI/Models/References/AsyncApiChannelReference.cs b/src/LEGO.AsyncAPI/Models/References/AsyncApiChannelReference.cs
@@ -14,7 +14,7 @@ private AsyncApiChannel Target
         {
             get
             {
-                this.target ??= this.Reference.HostDocument?.ResolveReference<AsyncApiChannel>(this.Reference);
+                this.target ??= this.Reference.Workspace?.ResolveReference<AsyncApiChannel>(this.Reference.Reference);
                 return this.target;
             }
         }
@@ -51,7 +51,7 @@ public override void SerializeV2(IAsyncApiWriter writer)
             }
             else
             {
-                this.Reference.HostDocument = writer.RootDocument;
+                this.Reference.Workspace = writer.Workspace;
                 this.Target.SerializeV2(writer);
             }
         }

diff --git a/src/LEGO.AsyncAPI/Models/References/AsyncApiCorrelationIdReference.cs b/src/LEGO.AsyncAPI/Models/References/AsyncApiCorrelationIdReference.cs
@@ -17,7 +17,7 @@ private AsyncApiCorrelationId Target
         {
             get
             {
-                this.target ??= this.Reference.HostDocument?.ResolveReference<AsyncApiCorrelationId>(this.Reference);
+                this.target ??= this.Reference.Workspace?.ResolveReference<AsyncApiCorrelationId>(this.Reference.Reference);
                 return this.target;
             }
         }
@@ -46,7 +46,7 @@ public override void SerializeV2(IAsyncApiWriter writer)
             }
             else
             {
-                this.Reference.HostDocument = writer.RootDocument;
+                this.Reference.Workspace = writer.Workspace;
                 this.Target.SerializeV2(writer);
             }
         }

diff --git a/src/LEGO.AsyncAPI/Models/References/AsyncApiJsonSchemaReference.cs b/src/LEGO.AsyncAPI/Models/References/AsyncApiJsonSchemaReference.cs
@@ -15,7 +15,7 @@ private AsyncApiJsonSchema Target
         {
             get
             {
-                this.target ??= this.Reference.HostDocument?.ResolveReference<AsyncApiJsonSchema>(this.Reference);
+                this.target ??= this.Reference.Workspace?.ResolveReference<AsyncApiJsonSchema>(this.Reference);
                 return this.target;
             }
         }
@@ -304,7 +304,7 @@ public override void SerializeV2(IAsyncApiWriter writer)
                 return;
             }
 
-            this.Reference.HostDocument = writer.RootDocument;
+            this.Reference.Workspace = writer.Workspace;
             // If Loop is detected then just Serialize as a reference.
             if (!settings.LoopDetector.PushLoop(this))
             {

diff --git a/src/LEGO.AsyncAPI/Models/References/AsyncApiMessageReference.cs b/src/LEGO.AsyncAPI/Models/References/AsyncApiMessageReference.cs
@@ -17,7 +17,7 @@ private AsyncApiMessage Target
         {
             get
             {
-                this.target ??= this.Reference.HostDocument?.ResolveReference<AsyncApiMessage>(this.Reference);
+                this.target ??= this.Reference.Workspace?.ResolveReference<AsyncApiMessage>(this.Reference.Reference);
                 return this.target;
             }
         }
@@ -72,7 +72,7 @@ public override void SerializeV2(IAsyncApiWriter writer)
             }
             else
             {
-                this.Reference.HostDocument = writer.RootDocument;
+                this.Reference.Workspace = writer.Workspace;
                 this.Target.SerializeV2(writer);
             }
         }

diff --git a/src/LEGO.AsyncAPI/Models/References/AsyncApiMessageTraitReference.cs b/src/LEGO.AsyncAPI/Models/References/AsyncApiMessageTraitReference.cs
@@ -17,7 +17,7 @@ private AsyncApiMessageTrait Target
         {
             get
             {
-                this.target ??= this.Reference.HostDocument?.ResolveReference<AsyncApiMessageTrait>(this.Reference);
+                this.target ??= this.Reference.Workspace?.ResolveReference<AsyncApiMessageTrait>(this.Reference);
                 return this.target;
             }
         }
@@ -68,7 +68,7 @@ public override void SerializeV2(IAsyncApiWriter writer)
             }
             else
             {
-                this.Reference.HostDocument = writer.RootDocument;
+                this.Reference.Workspace = writer.Workspace;
                 this.Target.SerializeV2(writer);
             }
         }

diff --git a/src/LEGO.AsyncAPI/Models/References/AsyncApiOperationTraitReference.cs b/src/LEGO.AsyncAPI/Models/References/AsyncApiOperationTraitReference.cs
@@ -17,7 +17,7 @@ private AsyncApiOperationTrait Target
         {
             get
             {
-                this.target ??= this.Reference.HostDocument?.ResolveReference<AsyncApiOperationTrait>(this.Reference);
+                this.target ??= this.Reference.Workspace?.ResolveReference<AsyncApiOperationTrait>(this.Reference);
                 return this.target;
             }
         }
@@ -54,7 +54,7 @@ public override void SerializeV2(IAsyncApiWriter writer)
             }
             else
             {
-                this.Reference.HostDocument = writer.RootDocument;
+                this.Reference.Workspace = writer.Workspace;
                 this.Target.SerializeV2(writer);
             }
         }

diff --git a/src/LEGO.AsyncAPI/Models/References/AsyncApiParameterReference.cs b/src/LEGO.AsyncAPI/Models/References/AsyncApiParameterReference.cs
@@ -17,7 +17,7 @@ private AsyncApiParameter Target
         {
             get
             {
-                this.target ??= this.Reference.HostDocument?.ResolveReference<AsyncApiParameter>(this.Reference);
+                this.target ??= this.Reference.Workspace?.ResolveReference<AsyncApiParameter>(this.Reference);
                 return this.target;
             }
         }
@@ -48,7 +48,7 @@ public override void SerializeV2(IAsyncApiWriter writer)
             }
             else
             {
-                this.Reference.HostDocument = writer.RootDocument;
+                this.Reference.Workspace = writer.Workspace;
                 this.Target.SerializeV2(writer);
             }
         }

diff --git a/src/LEGO.AsyncAPI/Models/References/AsyncApiSecuritySchemeReference.cs b/src/LEGO.AsyncAPI/Models/References/AsyncApiSecuritySchemeReference.cs
@@ -18,7 +18,7 @@ private AsyncApiSecurityScheme Target
         {
             get
             {
-                this.target ??= this.Reference.HostDocument?.ResolveReference<AsyncApiSecurityScheme>(this.Reference);
+                this.target ??= this.Reference.Workspace?.ResolveReference<AsyncApiSecurityScheme>(this.Reference);
                 return this.target;
             }
         }
@@ -59,7 +59,7 @@ public override void SerializeV2(IAsyncApiWriter writer)
             }
             else
             {
-                this.Reference.HostDocument = writer.RootDocument;
+                this.Reference.Workspace = writer.Workspace;
                 this.Target.SerializeV2(writer);
             }
         }

diff --git a/src/LEGO.AsyncAPI/Models/References/AsyncApiServerReference.cs b/src/LEGO.AsyncAPI/Models/References/AsyncApiServerReference.cs
@@ -17,7 +17,7 @@ private AsyncApiServer Target
         {
             get
             {
-                this.target ??= this.Reference.HostDocument?.ResolveReference<AsyncApiServer>(this.Reference);
+                this.target ??= this.Reference.Workspace?.ResolveReference<AsyncApiServer>(this.Reference);
                 return this.target;
             }
         }
@@ -58,7 +58,7 @@ public override void SerializeV2(IAsyncApiWriter writer)
             }
             else
             {
-                this.Reference.HostDocument = writer.RootDocument;
+                this.Reference.Workspace = writer.Workspace;
                 this.Target.SerializeV2(writer);
             }
         }

diff --git a/src/LEGO.AsyncAPI/Models/References/AsyncApiServerVariableReference.cs b/src/LEGO.AsyncAPI/Models/References/AsyncApiServerVariableReference.cs
@@ -17,7 +17,7 @@ private AsyncApiServerVariable Target
         {
             get
             {
-                this.target ??= this.Reference.HostDocument?.ResolveReference<AsyncApiServerVariable>(this.Reference);
+                this.target ??= this.Reference.Workspace?.ResolveReference<AsyncApiServerVariable>(this.Reference);
                 return this.target;
             }
         }
@@ -49,7 +49,7 @@ public override void SerializeV2(IAsyncApiWriter writer)
             }
             else
             {
-                this.Reference.HostDocument = writer.RootDocument;
+                this.Reference.Workspace = writer.Workspace;
                 this.Target.SerializeV2(writer);
             }
         }

diff --git a/src/LEGO.AsyncAPI/Writers/AsyncApiWriterBase.cs b/src/LEGO.AsyncAPI/Writers/AsyncApiWriterBase.cs
@@ -68,7 +68,7 @@ public AsyncApiWriterBase(TextWriter textWriter, AsyncApiWriterSettings settings
         /// </summary>
         protected TextWriter Writer { get; }
 
-        public AsyncApiDocument RootDocument { get; set; }
+        public AsyncApiWorkspace Workspace { get; set; } = new AsyncApiWorkspace();
 
         /// <summary>
         /// Write start object.

diff --git a/src/LEGO.AsyncAPI/Writers/IAsyncApiWriter.cs b/src/LEGO.AsyncAPI/Writers/IAsyncApiWriter.cs
@@ -6,7 +6,7 @@ namespace LEGO.AsyncAPI.Writers
 {
     public interface IAsyncApiWriter
     {
-        AsyncApiDocument RootDocument { get; set; }
+        AsyncApiWorkspace Workspace { get; set; }
 
         /// <summary>
         /// Write the start object.

diff --git a/test/LEGO.AsyncAPI.Tests/Models/AsyncApiReference_Should.cs b/test/LEGO.AsyncAPI.Tests/Models/AsyncApiReference_Should.cs
@@ -68,7 +68,6 @@ public void Reference()
             var reference = doc.Servers.First().Value as AsyncApiServerReference;
             reference.Reference.ExternalResource.Should().Be("https://github.com/test/test");
             reference.Reference.FragmentId.Should().Be("whatever");
-            reference.Reference.HostDocument.Should().Be(doc);
             reference.Reference.IsFragment.Should().BeTrue();
         }
 
@@ -136,7 +135,6 @@ public void ServerReference_WithComponentReference_ResolvesReference()
             var reference = doc.Servers.First().Value as AsyncApiServerReference;
             reference.Reference.ExternalResource.Should().BeNull();
             reference.Reference.FragmentId.Should().Be("/components/servers/whatever");
-            reference.Reference.HostDocument.Should().Be(doc);
             reference.Reference.IsFragment.Should().BeTrue();
             reference.Url.Should().Be("wss://production.gigantic-server.com:443");