fix(Sdk): Moved the methods used to load external definitions out of the WorkflowReader into a new IWorkflowExternalDefinitionResolver service

Author: cdavernas

src/ServerlessWorkflow.Sdk.UnitTests/Cases/Services/WorkflowReaderTests.cs

@@ -163,7 +163,7 @@ public async Task Read_Json_ExternalDefinitions_ShouldWork()
             var yaml = File.ReadAllText(Path.Combine("Resources", "Workflows", "externalref.json"));
 
             //act
-            var workflow = await this.Reader.ParseAsync(yaml);
+            var workflow = await this.Reader.ParseAsync(yaml, new WorkflowReaderOptions() { LoadExternalDefinitions = true });
 
             //assert
             workflow

src/ServerlessWorkflow.Sdk.UnitTests/Cases/Validation/WorkflowValidationTests.cs

@@ -2,9 +2,12 @@
 using FluentValidation;
 using Microsoft.Extensions.DependencyInjection;
 using Moq;
+using Newtonsoft.Json;
 using ServerlessWorkflow.Sdk.Models;
+using ServerlessWorkflow.Sdk.Services.Validation;
 using System;
 using System.Collections.Generic;
+using System.IO;
 using Xunit;
 
 namespace ServerlessWorkflow.Sdk.UnitTests.Cases.Validation
@@ -25,6 +28,8 @@ public WorkflowValidationTests()
 
         protected IValidator<WorkflowDefinition> WorkflowDefinitionValidator { get; }
 
+        protected IWorkflowValidator WorkflowValidator = Sdk.Services.Validation.WorkflowValidator.Create();
+
         [Fact]
         public void Validate_Workflow_NoId_ShouldFail()
         {
@@ -275,12 +280,29 @@ public void Validate_Workflow_DuplicateRetryPolicyNames_ShouldFail()
 
             //assert
             result.Should()
-               .NotBeNull();
+                .NotBeNull();
             result.Errors.Should()
                 .NotBeNullOrEmpty()
                 .And.Contain(e => e.PropertyName == nameof(WorkflowDefinition.Retries));
         }
 
+        [Fact]
+        public async void Validate_Workflow_WithExternalReferences_ShouldWork()
+        {
+            //arrange
+            var json = File.ReadAllText(Path.Combine("resources", "workflows", "external-function-definition.json"));
+            var workflow = JsonConvert.DeserializeObject<WorkflowDefinition>(json);
+
+            //act
+            var result = await this.WorkflowValidator.ValidateAsync(workflow);
+            var loadedWorflowJson = JsonConvert.SerializeObject(workflow);
+            var deserializedWorkflow = JsonConvert.DeserializeObject<WorkflowDefinition>(loadedWorflowJson);
+
+            //assert
+            result.IsValid.Should().BeTrue();
+            deserializedWorkflow.Functions.Should().BeNullOrEmpty();
+        }
+
     }
 
 }

src/ServerlessWorkflow.Sdk.UnitTests/Resources/workflows/external-function-definition.json

@@ -0,0 +1,22 @@
+{
+  "id": "undefined",
+  "name": "Undefined",
+  "version": "0.1.0",
+  "specVersion": "0.8",
+  "functions": "file://resources/functions/petstore.json",
+  "states": [
+    {
+      "name": "Test",
+      "type": "operation",
+      "actions": [
+        {
+          "name": "test",
+          "functionRef": {
+            "refName": "GetPetById"
+          }
+        }
+      ],
+      "end": true
+    }
+  ]
+}

src/ServerlessWorkflow.Sdk.UnitTests/ServerlessWorkflow.Sdk.UnitTests.csproj

@@ -62,6 +62,9 @@
     <None Update="Resources\secrets\default.yaml">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
+    <None Update="Resources\workflows\external-function-definition.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
     <None Update="Resources\workflows\externalref.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>

src/ServerlessWorkflow.Sdk/Extensions/IServiceCollectionExtensions.cs

@@ -45,8 +45,9 @@ public static IServiceCollection AddServerlessWorkflow(this IServiceCollection s
         {
             var newtonsoftJsonDefaultConfig = (JsonSerializerSettings settings) =>
             {
+                settings.ContractResolver = new NonPublicSetterContractResolver();
                 settings.NullValueHandling = NullValueHandling.Ignore;
-                settings.ContractResolver = new CamelCasePropertyNamesContractResolver();
+                settings.DefaultValueHandling = DefaultValueHandling.Ignore;
             };
             var defaultSettings = JsonConvert.DefaultSettings;
             JsonConvert.DefaultSettings = () =>
@@ -74,6 +75,7 @@ public static IServiceCollection AddServerlessWorkflow(this IServiceCollection s
                         inner => new OneOfDeserializer(inner),
                         syntax => syntax.InsteadOf<Iso8601TimeSpanConverter>()));
             services.AddHttpClient();
+            services.AddSingleton<IWorkflowExternalDefinitionResolver, WorkflowExternalDefinitionResolver>();
             services.AddSingleton<IWorkflowReader, WorkflowReader>();
             services.AddSingleton<IWorkflowWriter, WorkflowWriter>();
             services.AddSingleton<IWorkflowSchemaValidator, WorkflowSchemaValidator>();

src/ServerlessWorkflow.Sdk/Extensions/IWorkflowReaderExtensions.cs

@@ -32,14 +32,27 @@ public static async Task<WorkflowDefinition> ReadAsync(this IWorkflowReader read
         /// </summary>
         /// <param name="reader">The extended <see cref="IWorkflowReader"/></param>
         /// <param name="input">The input to parse</param>
+        /// <param name="options"><see cref="WorkflowReaderOptions"/> to use</param>
         /// <param name="cancellationToken">A <see cref="CancellationToken"/></param>
         /// <returns>A new <see cref="WorkflowDefinition"/></returns>
-        public static async Task<WorkflowDefinition> ParseAsync(this IWorkflowReader reader, string input, CancellationToken cancellationToken = default)
+        public static async Task<WorkflowDefinition> ParseAsync(this IWorkflowReader reader, string input, WorkflowReaderOptions options, CancellationToken cancellationToken = default)
         {
             if (string.IsNullOrWhiteSpace(input))
                 throw new ArgumentNullException(nameof(input));
             using Stream stream = new MemoryStream(Encoding.UTF8.GetBytes(input));
-            return await reader.ReadAsync(stream, cancellationToken);
+            return await reader.ReadAsync(stream, options, cancellationToken);
+        }
+
+        /// <summary>
+        /// Parses the specified input into a new <see cref="WorkflowDefinition"/>
+        /// </summary>
+        /// <param name="reader">The extended <see cref="IWorkflowReader"/></param>
+        /// <param name="input">The input to parse</param>
+        /// <param name="cancellationToken">A <see cref="CancellationToken"/></param>
+        /// <returns>A new <see cref="WorkflowDefinition"/></returns>
+        public static async Task<WorkflowDefinition> ParseAsync(this IWorkflowReader reader, string input,CancellationToken cancellationToken = default)
+        {
+            return await reader.ParseAsync(input, new(), cancellationToken);
         }
 
     }

src/ServerlessWorkflow.Sdk/ServerlessWorkflow.Sdk.csproj

@@ -4,9 +4,9 @@
     <TargetFramework>net6.0</TargetFramework>
 	<Nullable>enable</Nullable>
     <NeutralLanguage>en</NeutralLanguage>
-    <AssemblyVersion>0.8.1.14</AssemblyVersion>
-    <FileVersion>0.8.1.14</FileVersion>
-    <Version>0.8.1.14</Version>
+    <AssemblyVersion>0.8.1.16</AssemblyVersion>
+    <FileVersion>0.8.1.16</FileVersion>
+    <Version>0.8.1.16</Version>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>