Add audit support for JSON property changes.

framework/src/Volo.Abp.EntityFrameworkCore/Volo/Abp/EntityFrameworkCore/EntityHistory/EntityHistoryHelper.cs

@@ -187,6 +187,11 @@ public class EntityHistoryHelper : IEntityHistoryHelper, ITransientDependency
 
         foreach (var property in properties)
         {
+            if (entityEntry.Metadata.IsMappedToJson() && property.GetJsonPropertyName() == null)
+            {
+                continue;
+            }
+
             var propertyEntry = entityEntry.Property(property.Name);
             if (ShouldSavePropertyHistory(propertyEntry, isCreated || isDeleted) && !IsSoftDeleted(entityEntry))
             {
@@ -215,26 +220,22 @@ public class EntityHistoryHelper : IEntityHistoryHelper, ITransientDependency
             {
                 continue;
             }
-                
+
             if (navigationEntry.Metadata.TargetEntityType.IsMappedToJson() && navigationEntry is ReferenceEntry referenceEntry && referenceEntry.TargetEntry != null)
             {
                 foreach (var propertyChange in GetPropertyChanges(referenceEntry.TargetEntry))
                 {
-                    if (propertyChanges.Any(pc => pc.PropertyName == propertyChange.PropertyName))
-                    {
-                        propertyChange.PropertyName = $"{referenceEntry.Metadata.Name}.{propertyChange.PropertyName}";
-                    }
-
+                    propertyChange.PropertyName = $"{referenceEntry.Metadata.Name}.{propertyChange.PropertyName}";
                     propertyChanges.Add(propertyChange);
                 }
-                
+
                 continue;
             }
 
             if (AbpEfCoreNavigationHelper.IsNavigationEntryModified(entityEntry, index))
             {
                 var abpNavigationEntry = AbpEfCoreNavigationHelper.GetNavigationEntry(entityEntry, index);
-                    
+
                 var isCollection = navigationEntry.Metadata.IsCollection;
                 propertyChanges.Add(new EntityPropertyChangeInfo
                 {

framework/test/Volo.Abp.Auditing.Tests/Volo/Abp/Auditing/AbpAuditingTestModule.cs

@@ -59,6 +59,8 @@ public class AbpAuditingTestModule : AbpModule
                     "AppEntityWithValueObject",
                     type => type == typeof(AppEntityWithValueObject) || type == typeof(AppEntityWithValueObjectAddress))
             );
+
+            options.EntityHistorySelectors.Add(new NamedTypeSelector(nameof(AppEntityWithJsonProperty), type => type == typeof(AppEntityWithJsonProperty)));
         });
 
         context.Services.AddType<Auditing_Tests.MyAuditedObject1>();

framework/test/Volo.Abp.Auditing.Tests/Volo/Abp/Auditing/App/Entities/AppEntityWithJsonProperty.cs

@@ -0,0 +1,27 @@
+using System;
+using System.Collections.Generic;
+using Volo.Abp.Domain.Entities.Auditing;
+
+namespace Volo.Abp.Auditing.App.Entities;
+
+public class AppEntityWithJsonProperty : FullAuditedAggregateRoot<Guid>
+{
+    public string Name { get; set; }
+
+    public JsonPropertyObject Data { get; set; }
+
+    public int Count { get; set; }
+
+    public AppEntityWithJsonProperty()
+    {
+    }
+
+    public AppEntityWithJsonProperty(Guid id, string name) : base(id)
+    {
+        Name = name;
+    }
+}
+
+public class JsonPropertyObject : Dictionary<string, object>
+{
+}

framework/test/Volo.Abp.Auditing.Tests/Volo/Abp/Auditing/App/EntityFrameworkCore/AbpAuditingTestDbContext.cs

@@ -30,6 +30,7 @@ public class AbpAuditingTestDbContext : AbpDbContext<AbpAuditingTestDbContext>
     public DbSet<AppEntityWithNavigations> AppEntityWithNavigations { get; set; }
     public DbSet<AppEntityWithNavigationChildOneToMany> AppEntityWithNavigationChildOneToMany { get; set; }
     public DbSet<AppEntityWithNavigationsAndDisableAuditing> AppEntityWithNavigationsAndDisableAuditing { get; set; }
+    public DbSet<AppEntityWithJsonProperty> EntitiesWithObjectProperty { get; set; }
 
     public AbpAuditingTestDbContext(DbContextOptions<AbpAuditingTestDbContext> options)
         : base(options)
@@ -56,5 +57,25 @@ public class AbpAuditingTestDbContext : AbpDbContext<AbpAuditingTestDbContext>
             b.HasMany(x => x.ManyToMany).WithMany(x => x.ManyToMany).UsingEntity<AppEntityWithNavigationsAndAppEntityWithNavigationChildManyToMany>();
         });
 
+        modelBuilder.Entity<AppEntityWithJsonProperty>(b =>
+        {
+            b.ConfigureByConvention();
+            b.OwnsOne(x => x.Data, b2 =>
+            {
+                b2.ToJson();
+
+                b2.Property<object>("Name")
+                    .HasConversion<string>(
+                        v => v.ToString(),
+                        v => v
+                    );
+
+                b2.Property<object>("Value")
+                    .HasConversion<string>(
+                        v => v.ToString(),
+                        v => v
+                    );
+            });
+        });
     }
 }

framework/test/Volo.Abp.Auditing.Tests/Volo/Abp/Auditing/Auditing_Tests.cs

@@ -720,6 +720,104 @@ public class Auditing_Tests : AbpAuditingTestBase
                                                                      x.EntityChanges[1].PropertyChanges[0].PropertyName == nameof(AppEntityWithNavigationChildManyToMany.ManyToMany) &&
                                                                      x.EntityChanges[1].PropertyChanges[0].PropertyTypeFullName == typeof(List<AppEntityWithNavigations>).FullName));
 
+#pragma warning restore 4014
+    }
+
+    [Fact]
+    public async Task Should_Write_AuditLog_For_Json_Property_Changes()
+    {
+        var entityId = Guid.NewGuid();
+        var repository = ServiceProvider.GetRequiredService<IBasicRepository<AppEntityWithJsonProperty, Guid>>();
+
+        using (var scope = _auditingManager.BeginScope())
+        {
+            using (var uow = _unitOfWorkManager.Begin())
+            {
+                var entity = new AppEntityWithJsonProperty(entityId, "Test Entity")
+                {
+                    Data = new JsonPropertyObject()
+                    {
+                        { "Name", "String Name" },
+                        { "Value", "String Value"}
+                    },
+                    Count = 10
+                };
+
+                await repository.InsertAsync(entity);
+
+                await uow.CompleteAsync();
+                await scope.SaveAsync();
+            }
+        }
+
+#pragma warning disable 4014
+        AuditingStore.Received().SaveAsync(Arg.Is<AuditLogInfo>(x => x.EntityChanges.Count == 1 &&
+                                                                     x.EntityChanges[0].ChangeType == EntityChangeType.Created &&
+                                                                     x.EntityChanges[0].EntityTypeFullName == typeof(AppEntityWithJsonProperty).FullName &&
+                                                                     x.EntityChanges[0].PropertyChanges.Count == 4 &&
+
+                                                                     x.EntityChanges[0].PropertyChanges[0].OriginalValue == null &&
+                                                                     x.EntityChanges[0].PropertyChanges[0].NewValue == "10" &&
+                                                                     x.EntityChanges[0].PropertyChanges[0].PropertyName == nameof(AppEntityWithJsonProperty.Count) &&
+                                                                     x.EntityChanges[0].PropertyChanges[0].PropertyTypeFullName == typeof(int).FullName &&
+
+                                                                     x.EntityChanges[0].PropertyChanges[1].OriginalValue == null &&
+                                                                     x.EntityChanges[0].PropertyChanges[1].NewValue == "\"Test Entity\"" &&
+                                                                     x.EntityChanges[0].PropertyChanges[1].PropertyName == nameof(AppEntityWithJsonProperty.Name) &&
+                                                                     x.EntityChanges[0].PropertyChanges[1].PropertyTypeFullName == typeof(string).FullName &&
+
+                                                                     x.EntityChanges[0].PropertyChanges[2].OriginalValue == null &&
+                                                                     x.EntityChanges[0].PropertyChanges[2].NewValue == "\"String Name\"" &&
+                                                                     x.EntityChanges[0].PropertyChanges[2].PropertyName == "Data.Name" &&
+                                                                     x.EntityChanges[0].PropertyChanges[2].PropertyTypeFullName == typeof(string).FullName &&
+
+                                                                     x.EntityChanges[0].PropertyChanges[3].OriginalValue == null &&
+                                                                     x.EntityChanges[0].PropertyChanges[3].NewValue == "\"String Value\"" &&
+                                                                     x.EntityChanges[0].PropertyChanges[3].PropertyName == "Data.Value" &&
+                                                                     x.EntityChanges[0].PropertyChanges[3].PropertyTypeFullName == typeof(string).FullName));
+        AuditingStore.ClearReceivedCalls();
+#pragma warning restore 4014
+
+
+        using (var scope = _auditingManager.BeginScope())
+        {
+            using (var uow = _unitOfWorkManager.Begin())
+            {
+                var entity = await repository.GetAsync(entityId);
+
+                entity.Name = "Updated Test Entity";
+
+                entity.Data["Name"] = "Updated String Name";
+                entity.Data["Value"] = "Updated String Value";
+
+                await repository.UpdateAsync(entity);
+
+                await uow.CompleteAsync();
+                await scope.SaveAsync();
+            }
+        }
+
+#pragma warning disable 4014
+        AuditingStore.Received().SaveAsync(Arg.Is<AuditLogInfo>(x => x.EntityChanges.Count == 1 &&
+                                                                     x.EntityChanges[0].ChangeType == EntityChangeType.Updated &&
+                                                                     x.EntityChanges[0].EntityTypeFullName == typeof(AppEntityWithJsonProperty).FullName &&
+                                                                     x.EntityChanges[0].PropertyChanges.Count == 3 &&
+
+                                                                     x.EntityChanges[0].PropertyChanges[0].OriginalValue == "\"Test Entity\"" &&
+                                                                     x.EntityChanges[0].PropertyChanges[0].NewValue == "\"Updated Test Entity\"" &&
+                                                                     x.EntityChanges[0].PropertyChanges[0].PropertyName == nameof(AppEntityWithJsonProperty.Name) &&
+                                                                     x.EntityChanges[0].PropertyChanges[0].PropertyTypeFullName == typeof(string).FullName &&
+
+                                                                     x.EntityChanges[0].PropertyChanges[1].OriginalValue == "\"String Name\"" &&
+                                                                     x.EntityChanges[0].PropertyChanges[1].NewValue == "\"Updated String Name\"" &&
+                                                                     x.EntityChanges[0].PropertyChanges[1].PropertyName == "Data.Name" &&
+                                                                     x.EntityChanges[0].PropertyChanges[1].PropertyTypeFullName == typeof(string).FullName &&
+
+                                                                     x.EntityChanges[0].PropertyChanges[2].OriginalValue == "\"String Value\"" &&
+                                                                     x.EntityChanges[0].PropertyChanges[2].NewValue == "\"Updated String Value\"" &&
+                                                                     x.EntityChanges[0].PropertyChanges[2].PropertyName == "Data.Value" &&
+                                                                     x.EntityChanges[0].PropertyChanges[2].PropertyTypeFullName == typeof(string).FullName));
+        AuditingStore.ClearReceivedCalls();
 #pragma warning restore 4014
     }
 }