From f6eccde968e1e16aff3a0ed617fff1167ead98e3 Mon Sep 17 00:00:00 2001 From: Sipke Schoorstra Date: Fri, 18 Oct 2024 10:54:23 +0200 Subject: [PATCH 1/4] Switch to project references from package references Replaced package references for various Elsa modules with direct project references. This change aims to streamline dependency management and avoid issues related to differing package versions. Updated the solution file and Directory.Build.props accordingly to reflect the new paths. --- build/_build.csproj | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/build/_build.csproj b/build/_build.csproj index 4e4b70e2d..3ae4c9750 100644 --- a/build/_build.csproj +++ b/build/_build.csproj @@ -17,13 +17,12 @@ - + - - + From a2004128964ecf7010994528b185dbfadeb2a78b Mon Sep 17 00:00:00 2001 From: Sipke Schoorstra Date: Sat, 19 Oct 2024 10:44:28 +0200 Subject: [PATCH 2/4] Update package versions to fix vulnerabilities Upgrade various packages to their latest versions to address vulnerabilities and improve stability. This includes updates to Microsoft.Extensions, EntityFrameworkCore, and Npgsql among others. --- Directory.Packages.props | 44 ++++++++++++++++++++-------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index ab8552aff..0820a6e1d 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -138,33 +138,33 @@ - - - - - - - - - - - + + + + + + + + + + + - + - - - - - - - + + + + + + + - - + + - + \ No newline at end of file From b46d43257910baebbd60ea9b75fa2d1494354dd0 Mon Sep 17 00:00:00 2001 From: Sipke Schoorstra Date: Sat, 19 Oct 2024 11:56:50 +0200 Subject: [PATCH 3/4] Add JsonNode BSON serializer (#6043) Introduce JsonNodeBsonConverter for BSON serialization of JsonNode objects. Update MongoDbFeature to register the new serializer, enhancing JSON handling within MongoDB serialization context. --- .../Elsa.MongoDb/Features/MongoDbFeature.cs | 3 + .../Serializers/JsonNodeBsonSerializer.cs | 135 ++++++++++++++++++ 2 files changed, 138 insertions(+) create mode 100644 src/modules/Elsa.MongoDb/Serializers/JsonNodeBsonSerializer.cs diff --git a/src/modules/Elsa.MongoDb/Features/MongoDbFeature.cs b/src/modules/Elsa.MongoDb/Features/MongoDbFeature.cs index b0aabc67d..e168e37cf 100644 --- a/src/modules/Elsa.MongoDb/Features/MongoDbFeature.cs +++ b/src/modules/Elsa.MongoDb/Features/MongoDbFeature.cs @@ -1,4 +1,5 @@ using System.Text.Json; +using System.Text.Json.Nodes; using Elsa.Features.Abstractions; using Elsa.Features.Services; using Elsa.KeyValues.Entities; @@ -8,6 +9,7 @@ using Elsa.MongoDb.Options; using Elsa.MongoDb.Serializers; using Elsa.Workflows.Memory; using Elsa.Workflows.Runtime.Entities; +using Elsa.Workflows.Services; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.DependencyInjection.Extensions; using Microsoft.Extensions.Options; @@ -67,6 +69,7 @@ public class MongoDbFeature : FeatureBase TryRegisterSerializerOrSkipWhenExist(typeof(Variable), new VariableSerializer()); TryRegisterSerializerOrSkipWhenExist(typeof(Version), new VersionSerializer()); TryRegisterSerializerOrSkipWhenExist(typeof(JsonElement), new JsonElementSerializer()); + TryRegisterSerializerOrSkipWhenExist(typeof(JsonNode), new JsonNodeBsonConverter()); } private static void RegisterClassMaps() diff --git a/src/modules/Elsa.MongoDb/Serializers/JsonNodeBsonSerializer.cs b/src/modules/Elsa.MongoDb/Serializers/JsonNodeBsonSerializer.cs new file mode 100644 index 000000000..51d793298 --- /dev/null +++ b/src/modules/Elsa.MongoDb/Serializers/JsonNodeBsonSerializer.cs @@ -0,0 +1,135 @@ +using System.Text.Json.Nodes; +using MongoDB.Bson; +using MongoDB.Bson.IO; +using MongoDB.Bson.Serialization; + +namespace Elsa.MongoDb.Serializers; + +/// +/// Serializes a . +/// +public class JsonNodeBsonConverter : IBsonSerializer +{ + /// + public Type ValueType => typeof(JsonNode); + + /// + public void Serialize(BsonSerializationContext context, BsonSerializationArgs args, JsonNode value) + { + if (value == null!) + { + context.Writer.WriteNull(); + return; + } + + context.Writer.WriteStartDocument(); + context.Writer.WriteName("type"); + + switch (value) + { + case JsonObject jsonObject: + context.Writer.WriteString("JsonObject"); + context.Writer.WriteName("value"); + context.Writer.WriteString(jsonObject.ToJsonString()); + break; + + case JsonArray jsonArray: + context.Writer.WriteString("JsonArray"); + context.Writer.WriteName("value"); + context.Writer.WriteString(jsonArray.ToJsonString()); + break; + + case JsonValue jsonValue: + context.Writer.WriteString("JsonValue"); + context.Writer.WriteName("value"); + if (jsonValue.TryGetValue(out string? stringValue)) + context.Writer.WriteString(stringValue); + else if (jsonValue.TryGetValue(out int intValue)) + context.Writer.WriteInt32(intValue); + else if (jsonValue.TryGetValue(out int longValue)) + context.Writer.WriteInt64(longValue); + else if (jsonValue.TryGetValue(out double doubleValue)) + context.Writer.WriteDouble(doubleValue); + else if (jsonValue.TryGetValue(out bool boolValue)) + context.Writer.WriteBoolean(boolValue); + else if (jsonValue.TryGetValue(out DateTimeOffset dateTimeOffsetValue)) + context.Writer.WriteDateTime(dateTimeOffsetValue.ToUnixTimeMilliseconds()); + else if (jsonValue.TryGetValue(out DateTime dateTimeValue)) + context.Writer.WriteDateTime(new DateTimeOffset(dateTimeValue).ToUnixTimeMilliseconds()); + else + throw new BsonSerializationException("Unsupported JsonValue type"); + break; + + default: + throw new BsonSerializationException($"Unexpected JsonNode type: {value.GetType()}"); + } + + context.Writer.WriteEndDocument(); + } + + public JsonNode Deserialize(BsonDeserializationContext context, BsonDeserializationArgs args) + { + context.Reader.ReadStartDocument(); + var type = context.Reader.ReadString(); + context.Reader.ReadName(Utf8NameDecoder.Instance); + + JsonNode result; + switch (type) + { + case "JsonObject": + var jsonObjectString = context.Reader.ReadString(); + result = JsonNode.Parse(jsonObjectString); + break; + + case "JsonArray": + var jsonArrayString = context.Reader.ReadString(); + result = JsonNode.Parse(jsonArrayString); + break; + + case "JsonValue": + var bsonType = context.Reader.GetCurrentBsonType(); + switch (bsonType) + { + case BsonType.String: + result = JsonValue.Create(context.Reader.ReadString()); + break; + case BsonType.Int32: + result = JsonValue.Create(context.Reader.ReadInt32()); + break; + case BsonType.Int64: + result = JsonValue.Create(context.Reader.ReadInt64()); + break; + case BsonType.Double: + result = JsonValue.Create(context.Reader.ReadDouble()); + break; + case BsonType.Boolean: + result = JsonValue.Create(context.Reader.ReadBoolean()); + break; + case BsonType.DateTime: + result = JsonValue.Create(context.Reader.ReadDateTime()); + break; + default: + throw new BsonSerializationException($"Unsupported BSON type: {bsonType}"); + } + break; + + default: + throw new BsonSerializationException($"Unsupported JsonNode type: {type}"); + } + + context.Reader.ReadEndDocument(); + return result!; + } + + /// + public void Serialize(BsonSerializationContext context, BsonSerializationArgs args, object value) + { + Serialize(context, args, (JsonNode)value); + } + + object IBsonSerializer.Deserialize(BsonDeserializationContext context, BsonDeserializationArgs args) + { + return Deserialize(context, args); + } +} + From fefe36f49a615ca79624e03455fe853bc0f825c8 Mon Sep 17 00:00:00 2001 From: Sipke Schoorstra Date: Fri, 25 Oct 2024 14:51:27 +0200 Subject: [PATCH 4/4] Include $schema when exporting workflow definition (#6056) * Refactor AdditionalConvertersConfigurator constructor Simplify AdditionalConvertersConfigurator by using constructor injection directly in the class declaration. Also, annotate the class with [UsedImplicitly] to improve code clarity and maintainability. * Update workflow serialization to be asynchronous Refactor the workflow definition serialization to use asynchronous operations, improving efficiency and handling cancellation tokens. This change ensures the schema is correctly included in the serialized output. --- .../WorkflowDefinitions/Export/Endpoint.cs | 25 +++++++++++++++---- .../AdditionalConvertersConfigurator.cs | 16 +++--------- 2 files changed, 24 insertions(+), 17 deletions(-) diff --git a/src/modules/Elsa.Workflows.Api/Endpoints/WorkflowDefinitions/Export/Endpoint.cs b/src/modules/Elsa.Workflows.Api/Endpoints/WorkflowDefinitions/Export/Endpoint.cs index 1c0baac30..d5deb003f 100644 --- a/src/modules/Elsa.Workflows.Api/Endpoints/WorkflowDefinitions/Export/Endpoint.cs +++ b/src/modules/Elsa.Workflows.Api/Endpoints/WorkflowDefinitions/Export/Endpoint.cs @@ -74,7 +74,7 @@ internal class Export : ElsaEndpoint foreach (var definition in definitions) { var model = await CreateWorkflowModelAsync(definition, cancellationToken); - var binaryJson = SerializeWorkflowDefinition(model); + var binaryJson = await SerializeWorkflowDefinitionAsync(model, cancellationToken); var fileName = GetFileName(model); var entry = zipArchive.CreateEntry(fileName, CompressionLevel.Optimal); await using var entryStream = entry.Open(); @@ -103,7 +103,7 @@ internal class Export : ElsaEndpoint } var model = await CreateWorkflowModelAsync(definition, cancellationToken); - var binaryJson = SerializeWorkflowDefinition(model); + var binaryJson = await SerializeWorkflowDefinitionAsync(model, cancellationToken); var fileName = GetFileName(model); await SendBytesAsync(binaryJson, fileName, cancellation: cancellationToken); @@ -117,10 +117,25 @@ internal class Export : ElsaEndpoint return fileName; } - private byte[] SerializeWorkflowDefinition(WorkflowDefinitionModel model) + private async Task SerializeWorkflowDefinitionAsync(WorkflowDefinitionModel model, CancellationToken cancellationToken) { - JsonSerializerOptions serializerOptions = _serializer.GetOptions(); - var binaryJson = JsonSerializer.SerializeToUtf8Bytes(model, serializerOptions); + var serializerOptions = _serializer.GetOptions(); + var document = JsonSerializer.SerializeToDocument(model, serializerOptions); + var rootElement = document.RootElement; + + using var output = new MemoryStream(); + await using var writer = new Utf8JsonWriter(output); + + writer.WriteStartObject(); + writer.WriteString("$schema", "https://elsaworkflows.io/schemas/workflow-definition/v3.0.0/schema.json"); + + foreach (var property in rootElement.EnumerateObject()) + property.WriteTo(writer); + + writer.WriteEndObject(); + + await writer.FlushAsync(cancellationToken); + var binaryJson = output.ToArray(); return binaryJson; } diff --git a/src/modules/Elsa.Workflows.Core/Serialization/Configurators/AdditionalConvertersConfigurator.cs b/src/modules/Elsa.Workflows.Core/Serialization/Configurators/AdditionalConvertersConfigurator.cs index 6a5404312..da96c7e30 100644 --- a/src/modules/Elsa.Workflows.Core/Serialization/Configurators/AdditionalConvertersConfigurator.cs +++ b/src/modules/Elsa.Workflows.Core/Serialization/Configurators/AdditionalConvertersConfigurator.cs @@ -1,6 +1,7 @@ using System.Text.Json; using System.Text.Json.Serialization; using Elsa.Workflows.Serialization.Converters; +using JetBrains.Annotations; using Microsoft.Extensions.DependencyInjection; namespace Elsa.Workflows.Serialization.Configurators; @@ -8,23 +9,14 @@ namespace Elsa.Workflows.Serialization.Configurators; /// /// Add additional objects. /// -public class AdditionalConvertersConfigurator : SerializationOptionsConfiguratorBase +[UsedImplicitly] +public class AdditionalConvertersConfigurator(IServiceProvider serviceProvider) : SerializationOptionsConfiguratorBase { - private readonly IServiceProvider _serviceProvider; - - /// - /// Initializes a new instance of the class. - /// - public AdditionalConvertersConfigurator(IServiceProvider serviceProvider) - { - _serviceProvider = serviceProvider; - } - /// public override void Configure(JsonSerializerOptions options) { options.Converters.Add(Create()); } - private T Create() => ActivatorUtilities.CreateInstance(_serviceProvider); + private T Create() => ActivatorUtilities.CreateInstance(serviceProvider); } \ No newline at end of file