Added deserialization methods for EntityInstanceUpdateRequest

.github/workflows/build.yml

@@ -7,7 +7,7 @@ on:
     branches: [ "main" ]
 
 env:
-  PACKAGE_VERSION: 1.2.12
+  PACKAGE_VERSION: 1.2.13
 
 jobs:
 

CloudFabric.EAV.Service/EAVService.cs

@@ -2309,6 +2309,171 @@ await GetAttributeConfigurationsForEntityConfiguration(
         return (_mapper.Map<EntityInstanceViewModel>(entityInstance), null)!;
     }
 
+    /// <remarks>
+    /// Use following json format:
+    ///
+    /// ```
+    /// {
+    ///     "id": "c06e4e1f-bece-481c-a5e8-98ddcb86254f",
+    ///     "entityConfigurationId": "fb80cb74-6f47-4d38-bb87-25bd820efee7",    
+    ///     "sku": "123",
+    ///     "name": "Updated entity name",
+    ///     "attributeMachineNamesToRemove": [
+    ///       "firstAttributeMachineNameToRemove",
+    ///       "secondAttributeMachineNameToRemove"
+    ///     ]
+    /// }
+    /// ```
+    ///
+    /// Where "sku" and "name" are attributes machine names to add or update,
+    /// "attributeMachineNamesToRemove" an array of attribute machine names,
+    /// "id" - entity instance id to update,
+    /// "entityConfigurationId" - obviously the id of entity configuration which has all attributes.
+    /// </remarks>
+    public async Task<(EntityInstanceUpdateRequest?, ProblemDetails?)> DeserializeEntityInstanceUpdateRequestFromJson(
+        JsonElement entityJson,
+        CancellationToken cancellationToken = default
+    )
+    {
+        Guid entityConfigurationId;
+        if (entityJson.TryGetProperty("entityConfigurationId", out var entityConfigurationIdJsonElement))
+        {
+            if (entityConfigurationIdJsonElement.TryGetGuid(out var entityConfigurationIdGuid))
+            {
+                entityConfigurationId = entityConfigurationIdGuid;
+            }
+            else
+            {
+                return (null, new ValidationErrorResponse("entityConfigurationId", "Value is not a valid Guid"))!;
+            }
+        }
+        else
+        {
+            return (null, new ValidationErrorResponse("entityConfigurationId", "Value is missing"));
+        }
+
+        Guid instanceId;
+        if (entityJson.TryGetProperty("id", out var idJsonElement))
+        {
+            if (idJsonElement.TryGetGuid(out var idGuid))
+            {
+                instanceId = idGuid;
+            }
+            else
+            {
+                return (null, new ValidationErrorResponse("id", "Value is not a valid Guid"))!;
+            }
+        }
+        else
+        {
+            return (null, new ValidationErrorResponse("id", "Value is missing"));
+        }
+
+        return await DeserializeEntityInstanceUpdateRequestFromJson(
+            entityJson, entityConfigurationId, instanceId, cancellationToken
+        );
+    }
+
+    /// <remarks>
+    /// Use following json format:
+    ///
+    /// ```
+    /// {
+    ///     "id": "c06e4e1f-bece-481c-a5e8-98ddcb86254f",
+    ///     "sku": "123",
+    ///     "name": "Updated entity name",
+    ///     "attributeMachineNamesToRemove": [
+    ///       "firstAttributeMachineNameToRemove",
+    ///       "secondAttributeMachineNameToRemove"
+    ///     ]
+    /// }
+    /// ```
+    ///
+    /// Where "sku" and "name" are attributes machine names to add or update,
+    /// "attributeMachineNamesToRemove" an array of attribute machine names,
+    /// "id" - entity instance id to update.
+    ///
+    /// Note that this overload accepts "entityConfigurationId" via method arguments,
+    /// so it should not be in json.
+    /// </remarks>
+    public async Task<(EntityInstanceUpdateRequest?, ProblemDetails?)> DeserializeEntityInstanceUpdateRequestFromJson(
+        JsonElement updateEntityJson,
+        Guid entityConfgigurationId,
+        CancellationToken cancellationToken = default
+    )
+    {
+        Guid instanceId;
+        if (updateEntityJson.TryGetProperty("id", out var idJsonElement))
+        {
+            if (idJsonElement.TryGetGuid(out var tenantIdGuid))
+            {
+                instanceId = tenantIdGuid;
+            }
+            else
+            {
+                return (null, new ValidationErrorResponse("id", "Value is not a valid Guid"))!;
+            }
+        }
+        else
+        {
+            return (null, new ValidationErrorResponse("id", "Value is missing"));
+        }
+
+        return await DeserializeEntityInstanceUpdateRequestFromJson(
+            updateEntityJson, entityConfgigurationId, instanceId, cancellationToken
+        );
+    }
+
+    /// <remarks>
+    /// Use following json format:
+    ///
+    /// ```
+    /// {
+    ///     "sku": "123",
+    ///     "name": "Updated entity name",
+    ///     "attributeMachineNamesToRemove": [
+    ///       "firstAttributeMachineNameToRemove",
+    ///       "secondAttributeMachineNameToRemove"
+    ///     ]
+    /// }
+    /// ```
+    /// Where "sku" and "name" are attributes machine names to add or update,
+    /// "attributeMachineNamesToRemove" an array of attribute machine names.
+    /// 
+    /// Note that this overload accepts "instanceId" and "entityConfigurationId" via method arguments,
+    /// so they should not be in json.
+    /// </remarks>
+    public async Task<(EntityInstanceUpdateRequest?, ProblemDetails?)> DeserializeEntityInstanceUpdateRequestFromJson(
+        JsonElement entityJson,
+        Guid entityConfigurationId,
+        Guid instanceId,
+        CancellationToken cancellationToken = default
+    )
+    {
+        EntityConfiguration? entityConfiguration = await _entityConfigurationRepository.LoadAsync(
+                entityConfigurationId,
+                entityConfigurationId.ToString(),
+                cancellationToken
+            )
+            .ConfigureAwait(false);
+
+        if (entityConfiguration == null)
+        {
+            return (null, new ValidationErrorResponse("EntityConfigurationId", "EntityConfiguration not found"))!;
+        }
+
+        List<AttributeConfiguration> attributeConfigurations =
+            await GetAttributeConfigurationsForEntityConfiguration(
+                    entityConfiguration,
+                    cancellationToken
+                )
+                .ConfigureAwait(false);
+
+        return await _entityInstanceCreateUpdateRequestFromJsonDeserializer.DeserializeEntityInstanceUpdateRequest(
+            instanceId, entityConfigurationId, attributeConfigurations, entityJson
+        );
+    }
+
     /// <summary>
     /// Returns records in internal EntityInstanceViewModel format - use this is library is used by .net code.
     /// That way you will have full control over attributes and will be able to convert them to

CloudFabric.EAV.Service/Serialization/EntityInstanceCreateUpdateRequestFromJsonDeserializer.cs

@@ -1,5 +1,4 @@
 using System.Globalization;
-using System.Linq;
 using System.Text.Json;
 
 using CloudFabric.EAV.Domain.Models;
@@ -51,6 +50,69 @@ JsonElement record
         return (entityInstance, null);
     }
 
+    public async Task<(EntityInstanceUpdateRequest?, ValidationErrorResponse?)> DeserializeEntityInstanceUpdateRequest(
+        Guid id,
+        Guid entityConfigurrationId,
+        List<AttributeConfiguration> attributesConfigurations,
+        JsonElement record
+    )
+    {
+        var entityInstance = new EntityInstanceUpdateRequest
+        {
+            Id = id,
+            EntityConfigurationId = entityConfigurrationId
+        };
+
+        (List<AttributeInstanceCreateUpdateRequest> attributes, ValidationErrorResponse? deserializeAttributeErrors) =
+            await DeserializeAttributes(attributesConfigurations, record);
+
+        if (deserializeAttributeErrors != null)
+        {
+            return (null, deserializeAttributeErrors);
+        }
+        else
+        {
+            entityInstance.AttributesToAddOrUpdate = attributes;
+        }
+
+        string attributeMahineNamesToRemoveCamelCasePropName =
+            char.ToLower(nameof(EntityInstanceUpdateRequest.AttributeMachineNamesToRemove)[0])
+            + nameof(EntityInstanceUpdateRequest.AttributeMachineNamesToRemove).Substring(1);
+
+        if (record.TryGetProperty(
+            $"{attributeMahineNamesToRemoveCamelCasePropName}", out var attributeMachinaNamesToRemoveJson)
+            && attributeMachinaNamesToRemoveJson.ValueKind != JsonValueKind.Null
+        )
+        {
+            if (attributeMachinaNamesToRemoveJson.ValueKind != JsonValueKind.Array
+            )
+            {
+                return (null, new ValidationErrorResponse(
+                    $"{nameof(EntityInstanceUpdateRequest.AttributeMachineNamesToRemove)}",
+                    $" {attributeMachinaNamesToRemoveJson.ValueKind} is an unavaliable type.")
+                );
+            }
+
+            var enumeratedArray = attributeMachinaNamesToRemoveJson.EnumerateArray();
+
+            if (enumeratedArray.Count() > 0)
+            {
+                if (enumeratedArray.Any(x => x.ValueKind != JsonValueKind.String))
+                {
+                    return (null, new ValidationErrorResponse(
+                        $"{nameof(EntityInstanceUpdateRequest.AttributeMachineNamesToRemove)}",
+                        $"Array contains unsupported elements type.")
+                    );
+                }
+            }
+
+            entityInstance.AttributeMachineNamesToRemove
+                = attributeMachinaNamesToRemoveJson.Deserialize<List<string>>(_jsonSerializerOptions);
+        }
+
+        return (entityInstance, null);
+    }
+
     public async Task<(CategoryInstanceCreateRequest?, ValidationErrorResponse?)> DeserializeCategoryInstanceCreateRequest(
         Guid categoryConfigurationId,
         Guid? tenantId,
@@ -279,7 +341,8 @@ JsonElement attributeValue
                                 localizedText.Value.Add(
                                     new LocalizedStringCreateRequest()
                                     {
-                                        CultureInfoId = cultureInfo.LCID, String = element.Value.GetString()!
+                                        CultureInfoId = cultureInfo.LCID,
+                                        String = element.Value.GetString()!
                                     }
                                 );
                             }

CloudFabric.EAV.Tests/Factories/EntityInstanceFactory.cs

@@ -60,6 +60,36 @@ public static string CreateValidBoardGameCategoryCreateRequestJson(Guid category
         ";
     }
 
+    public static string CreateValidBoardGameEntityInstanceUpdateRequestJson(Guid entityConfigurationId, Guid instanceId)
+    {
+        return @"
+            {
+                ""entityConfigurationId"": """ + entityConfigurationId + @""",
+                ""id"": """ + instanceId + @""",
+                ""name"": ""Caverna"",
+                ""description"": ""It is a complex worker placement strategy game that shares similarities in gameplay and theme with his earlier board game, Agricola,[1] The game's theme revolves around helping a small dwarf family to settle a cave and nearby woodlands and to develop the setting through furnishing caves as well as converting forests into meadows, fields and pastures."",
+                ""brand"": ""LookoutGames"",
+                ""players_max"": 7,
+                ""price"": 195.50,
+                ""images"": [
+                    {
+                        ""title"": ""Photo 2"",
+                        ""url"": ""/images/photo2.jpg"",
+                        ""alt"": ""A photo of Caverna board game box""
+                    },
+                    {
+                        ""title"": ""Caverna Rulebook"",
+                        ""url"": ""/images/rulebook.jpg"",
+                        ""alt"": ""A photo of Caverna board game rulebook, page 1""
+                    }
+                ]                ,
+                ""attributeMachineNamesToRemove"": [
+                    ""avg_time_mins"", ""release_date""
+                ]
+            }
+        ";
+    }
+
     public static string CreateValidBoardGameEntityInstanceCreateRequestJsonSingleLanguage(Guid entityConfigurationId)
     {
         return @"

CloudFabric.EAV.Tests/JsonSerializationTests.cs

@@ -322,4 +322,27 @@ public async Task CreateCategoryInstance()
         JsonSerializer.Deserialize<List<CategoryPath>>(resultDocument!.RootElement.GetProperty("categoryPaths"), _serializerOptions)!
             .First().TreeId.Should().Be(hierarchy.Id);
     }
+
+    [TestMethod]
+    public async Task DeserializeEntityInstanceUpdateRequest_Success()
+    {
+        var entityConfigurationCreateRequest = EntityConfigurationFactory.CreateBoardGameEntityConfigurationCreateRequest();
+        (var entityConfiguration, _) = await _eavService.CreateEntityConfiguration(entityConfigurationCreateRequest, CancellationToken.None);
+
+        var entityInstanceCreateRequest = EntityInstanceFactory.CreateValidBoardGameEntityInstanceCreateRequest(entityConfiguration!.Id);
+        (var entityInstance, _) = await _eavService.CreateEntityInstance(entityInstanceCreateRequest);
+
+        string entityInstanceUpdateRequest
+            = EntityInstanceFactory.CreateValidBoardGameEntityInstanceUpdateRequestJson(entityInstance!.EntityConfigurationId, entityInstance.Id);
+
+        JsonDocument entityJson = JsonDocument.Parse(entityInstanceUpdateRequest);
+
+        (var instanceUpdateRequest, var errors) = await _eavService.DeserializeEntityInstanceUpdateRequestFromJson(entityJson.RootElement);
+
+        errors.Should().BeNull();
+
+        (var updatedInstance, _) = await _eavService.UpdateEntityInstance(entityConfiguration.Id.ToString(), instanceUpdateRequest);
+
+        updatedInstance.Should().NotBeNull();
+    }
 }