Merge pull request #15 from MobileTeleSystems/feature/14_external_ref

genusP · web-flow · commit 8c0875d58490 · 2024-11-18T17:21:36.000+03:00
External reference not resolve
diff --git a/src/ApiCodeGenerator.AsyncApi/ApiCodeGenerator.AsyncApi.csproj b/src/ApiCodeGenerator.AsyncApi/ApiCodeGenerator.AsyncApi.csproj
@@ -27,7 +27,8 @@
 
   <ItemGroup>
     <PackageReference Include="NJsonSchema.CodeGeneration.CSharp" Version="$(NJsonSchemaVersion)" />
-    <PackageReference Include="YamlDotNet" Version="11.2.1" />
+    <PackageReference Include="NJsonSchema.Yaml" Version="$(NJsonSchemaVersion)" />
+    <PackageReference Include="YamlDotNet" Version="16.2.0" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/src/ApiCodeGenerator.AsyncApi/AsyncApiContentGenerator.cs b/src/ApiCodeGenerator.AsyncApi/AsyncApiContentGenerator.cs
@@ -92,10 +92,23 @@ private static async Task<AsyncApiDocument> LoadDocumentAsync(GeneratorContext c
             var data = await context.DocumentReader!.ReadToEndAsync();
             data = InvokePreprocessors<string>(data, context.Preprocessors, context.DocumentPath, context.Logger);
 
-            var documentTask = data.StartsWith("{")
-                ? AsyncApiDocument.FromJsonAsync(data)
-                : AsyncApiDocument.FromYamlAsync(data);
-            var document = await documentTask.ConfigureAwait(false);
+            AsyncApiDocument document;
+            try
+            {
+                document = await AsyncApiDocument.FromJsonAsync(data, context.DocumentPath).ConfigureAwait(false);
+            }
+            catch (JsonException ex)
+            {
+                try
+                {
+                    document = await AsyncApiDocument.FromYamlAsync(data, context.DocumentPath).ConfigureAwait(false);
+                }
+                catch (YamlDotNet.Core.YamlException ex2)
+                {
+                    throw new InvalidOperationException(
+                        $"Can not read document as JSON ({ex.Message}) or YAML ({ex2.Message}).");
+                }
+            }
 
             document = InvokePreprocessors<AsyncApiDocument>(document, context.Preprocessors, context.DocumentPath, context.Logger);
             return document;
diff --git a/src/ApiCodeGenerator.AsyncApi/DOM/AsyncApiDocument.cs b/src/ApiCodeGenerator.AsyncApi/DOM/AsyncApiDocument.cs
@@ -2,12 +2,13 @@
 using Newtonsoft.Json.Linq;
 using NJsonSchema;
 using NJsonSchema.Generation;
+using NJsonSchema.Yaml;
 using YamlDotNet.Serialization;
 
 namespace ApiCodeGenerator.AsyncApi.DOM
 {
 #pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider declaring as nullable.
-    public class AsyncApiDocument
+    public class AsyncApiDocument : IDocumentPathProvider
     {
         private static readonly JsonSerializerSettings JSONSERIALIZERSETTINGS = new()
         {
@@ -41,14 +42,27 @@ public class AsyncApiDocument
         [JsonProperty("externalDocs", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
         public ICollection<ExternalDocumentation>? ExternalDocs { get; set; }
 
+        [JsonIgnore]
+        public string? DocumentPath { get; set; }
+
         /// <summary>
         /// Load document from JSON text.
         /// </summary>
         /// <param name="data">JSON text.</param>
         /// <returns>AsyncApi document object model.</returns>
         public static Task<AsyncApiDocument> FromJsonAsync(string data)
+            => FromJsonAsync(data, null);
+
+        /// <summary>
+        /// Load document from JSON text.
+        /// </summary>
+        /// <param name="data">JSON text.</param>
+        /// <param name="documentPath"> Path to document. </param>
+        /// <returns>AsyncApi document object model.</returns>
+        public static Task<AsyncApiDocument> FromJsonAsync(string data, string? documentPath)
         {
             var document = JsonConvert.DeserializeObject<AsyncApiDocument>(data, JSONSERIALIZERSETTINGS)!;
+            document.DocumentPath = documentPath;
             return UpdateSchemaReferencesAsync(document);
         }
 
@@ -58,6 +72,15 @@ public static Task<AsyncApiDocument> FromJsonAsync(string data)
         /// <param name="data">YAML text.</param>
         /// <returns>AsyncApi document object model.</returns>
         public static Task<AsyncApiDocument> FromYamlAsync(string data)
+            => FromYamlAsync(data, null);
+
+        /// <summary>
+        /// Load document from YAML text.
+        /// </summary>
+        /// <param name="data">YAML text.</param>
+        /// <param name="documentPath"> Path to document. </param>
+        /// <returns>AsyncApi document object model.</returns>
+        public static Task<AsyncApiDocument> FromYamlAsync(string data, string? documentPath)
         {
             var deserializer = new DeserializerBuilder().Build();
             using var reader = new StringReader(data);
@@ -66,14 +89,17 @@ public static Task<AsyncApiDocument> FromYamlAsync(string data)
             var jObject = JObject.FromObject(yamlDocument)!;
             var serializer = JsonSerializer.Create(JSONSERIALIZERSETTINGS);
             var doc = jObject.ToObject<AsyncApiDocument>(serializer)!;
+            doc.DocumentPath = documentPath;
             return UpdateSchemaReferencesAsync(doc);
         }
 
-        private static Task<AsyncApiDocument> UpdateSchemaReferencesAsync(AsyncApiDocument document)
-            => JsonSchemaReferenceUtilities.UpdateSchemaReferencesAsync(
-                document,
-                new(new AsyncApiSchemaResolver(document, new SystemTextJsonSchemaGeneratorSettings())))
-                .ContinueWith(t => document);
+        private static async Task<AsyncApiDocument> UpdateSchemaReferencesAsync(AsyncApiDocument document)
+        {
+            await JsonSchemaReferenceUtilities.UpdateSchemaReferencesAsync(
+                       document,
+                       new JsonAndYamlReferenceResolver(new AsyncApiSchemaResolver(document, new SystemTextJsonSchemaGeneratorSettings())));
+            return document;
+        }
     }
 #pragma warning restore CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider declaring as nullable.
 }
diff --git a/src/ApiCodeGenerator.OpenApi/ApiCodeGenerator.OpenApi.csproj b/src/ApiCodeGenerator.OpenApi/ApiCodeGenerator.OpenApi.csproj
@@ -16,9 +16,10 @@
   <ItemGroup>
     <PackageReference Include="NSwag.CodeGeneration.CSharp" Version="$(NswagVersion)" />
     <PackageReference Include="NSwag.Core.Yaml" Version="$(NswagVersion)" />
+    <PackageReference Include="YamlDotNet" Version="16.2.0" />
   </ItemGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\ApiCodeGenerator.Abstraction\ApiCodeGenerator.Abstraction.csproj" />
   </ItemGroup>
-</Project>
+</Project>
diff --git a/src/ApiCodeGenerator.OpenApi/ContentGeneratorBase.cs b/src/ApiCodeGenerator.OpenApi/ContentGeneratorBase.cs
@@ -11,6 +11,7 @@
 using NSwag;
 using NSwag.CodeGeneration;
 using NSwag.CodeGeneration.CSharp;
+using YamlDotNet.Core;
 
 namespace ApiCodeGenerator.OpenApi
 {
@@ -126,9 +127,24 @@ protected static async Task<OpenApiDocument> ReadAndProcessOpenApiDocument(Gener
             var documentStr = context.DocumentReader!.ReadToEnd();
             documentStr = InvokePreprocessors<string>(documentStr, context.Preprocessors, context.DocumentPath, context.Logger);
 
-            var openApiDocument = !(documentStr.StartsWith("{") && documentStr.EndsWith("}"))
-                ? await OpenApiYamlDocument.FromYamlAsync(documentStr)
-                : await OpenApiDocument.FromJsonAsync(documentStr);
+            OpenApiDocument openApiDocument;
+
+            try
+            {
+                openApiDocument = await OpenApiDocument.FromJsonAsync(documentStr, context.DocumentPath);
+            }
+            catch (JsonException ex)
+            {
+                try
+                {
+                    openApiDocument = await OpenApiYamlDocument.FromYamlAsync(documentStr, context.DocumentPath);
+                }
+                catch (YamlException ex2)
+                {
+                    throw new InvalidOperationException(
+                        $"Can not read document as JSON ({ex.Message}) or YAML ({ex2.Message}).");
+                }
+            }
 
             openApiDocument = InvokePreprocessors<OpenApiDocument>(openApiDocument, context.Preprocessors, context.DocumentPath, context.Logger);
             return openApiDocument;
diff --git a/test/ApiCodeGenerator.AsyncApi.Tests/AsyncApiContentGeneratorTests.cs b/test/ApiCodeGenerator.AsyncApi.Tests/AsyncApiContentGeneratorTests.cs
@@ -164,6 +164,22 @@ public async Task LoadApiDocument_WithModelPreprocess()
         Assert.That(sch, Is.EqualTo("{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"properties\":{\"processedModel\":{}}}"));
     }
 
+    [TestCase("externalRef.json")]
+    [TestCase("externalRef.yaml")]
+    public async Task LoadApiDocument_WithExternalRef(string documentPath)
+    {
+        var settingsJson = new JObject();
+        var context = CreateContext(settingsJson);
+        context.DocumentReader = await TestHelpers.LoadApiDocumentAsync(documentPath);
+        context.DocumentPath = documentPath;
+
+        var contentGenerator = (FakeContentGenerator)await FakeContentGenerator.CreateAsync(context);
+
+        var document = contentGenerator.Document;
+
+        Assert.NotNull(document.Components?.Messages["lightMeasured"].Reference);
+    }
+
     private static Func<Type, Newtonsoft.Json.JsonSerializer?, IReadOnlyDictionary<string, string>?, object?> GetSettingsFactory(string json)
         => (t, s, v) => (s ?? new()).Deserialize(new StringReader(json), t);
 
diff --git a/test/ApiCodeGenerator.AsyncApi.Tests/asyncApi/externalRef.json b/test/ApiCodeGenerator.AsyncApi.Tests/asyncApi/externalRef.json
@@ -0,0 +1,15 @@
+{
+  "asyncapi": "2.6.0",
+  "info": {
+    "title": "Document with reference to external schema",
+    "version": "1.0"
+  },
+  "channels": {},
+  "components": {
+    "messages": {
+      "lightMeasured": {
+        "$ref": "asyncapi.json#/components/messages/lightMeasured"
+      }
+    }
+  }
+}
diff --git a/test/ApiCodeGenerator.AsyncApi.Tests/asyncApi/externalRef.yaml b/test/ApiCodeGenerator.AsyncApi.Tests/asyncApi/externalRef.yaml
@@ -0,0 +1,9 @@
+asyncapi: "2.6.0"
+info:
+  title: Document with reference to external schema
+  version: "1.0"
+channels: {}
+components:
+  messages:
+    lightMeasured:
+      $ref: asyncapi.yml#/components/messages/lightMeasured
diff --git a/test/ApiCodeGenerator.OpenApi.Tests/ContentGeneratorFactoryTests.cs b/test/ApiCodeGenerator.OpenApi.Tests/ContentGeneratorFactoryTests.cs
@@ -158,14 +158,32 @@ public async Task LoadOpenApiDocument_WithModelPreprocess()
         public async Task LoadOpenApiDocument_FromYaml()
         {
             var context = CreateContext(new());
-            var schemaText = await File.ReadAllTextAsync(TestHelpers.GetSwaggerPath("testSchema.yaml"));
+            context.DocumentPath = TestHelpers.GetSwaggerPath("testSchema.yaml");
+            var schemaText = await File.ReadAllTextAsync(context.DocumentPath);
             context.DocumentReader = new StringReader(schemaText);
 
             var gen = (CSharpClientContentGenerator)await CSharpClientContentGenerator.CreateAsync(context);
 
             var openApiDocument = GetDocument(gen.Generator);
 
             Assert.NotNull(openApiDocument);
+            Assert.NotNull(openApiDocument!.DocumentPath);
+        }
+
+        [TestCase("externalRef.json")]
+        public async Task LoadOpenApiDocument_ExternalRef(string documentPath)
+        {
+            var context = CreateContext(new());
+            context.DocumentPath = TestHelpers.GetSwaggerPath(documentPath);
+            var documentContent = await File.ReadAllTextAsync(context.DocumentPath);
+            context.DocumentReader = new StringReader(documentContent);
+
+            var gen = (CSharpClientContentGenerator)await CSharpClientContentGenerator.CreateAsync(context);
+
+            var openApiDocument = GetDocument(gen.Generator);
+
+            Assert.NotNull(openApiDocument);
+            Assert.NotNull(openApiDocument!.Definitions["test"].AllOf.Single().Reference);
         }
 
         private GeneratorContext CreateContext(JObject settingsJson, Core.ExtensionManager.Extensions? extension = null)
diff --git a/test/ApiCodeGenerator.OpenApi.Tests/swagger/externalRef.json b/test/ApiCodeGenerator.OpenApi.Tests/swagger/externalRef.json
@@ -0,0 +1,19 @@
+{
+  "openapi": "3.0.0",
+  "components": {
+    "schemas": {
+      "test": {
+        "allOf": [
+          {
+            "$ref": "testSchema.json#/definitions/testOperResponse"
+          }
+        ],
+        "properties": {
+          "prop": {
+            "type": "integer"
+          }
+        }
+      }
+    }
+  }
+}
