Publish EntityUpdatedEvent when navigation changes.

abpframework · Mar 15, 2024 · e44d7f6 · e44d7f6
1 parent 9b8b2c0
commit e44d7f6
Show file tree

Hide file tree

Showing 17 changed files with 407 additions and 26 deletions.
diff --git a/framework/src/Volo.Abp.Ddd.Domain/Volo/Abp/Domain/Entities/Events/AbpEntityChangeOptions.cs b/framework/src/Volo.Abp.Ddd.Domain/Volo/Abp/Domain/Entities/Events/AbpEntityChangeOptions.cs
@@ -0,0 +1,10 @@
+namespace Volo.Abp.Domain.Entities.Events;
+
+public class AbpEntityChangeOptions
+{
+    /// <summary>
+    /// Default: true.
+    /// Publish the EntityUpdatedEvent when any navigation property changes.
+    /// </summary>
+    public bool PublishEntityUpdatedEventWhenNavigationChanges { get; set; } = true;
+}
diff --git a/framework/src/Volo.Abp.EntityFrameworkCore/Volo/Abp/EntityFrameworkCore/AbpDbContext.cs b/framework/src/Volo.Abp.EntityFrameworkCore/Volo/Abp/EntityFrameworkCore/AbpDbContext.cs
@@ -54,6 +54,8 @@ public abstract class AbpDbContext<TDbContext> : DbContext, IAbpEfCoreDbContext,
 
     public IEntityChangeEventHelper EntityChangeEventHelper => LazyServiceProvider.LazyGetService<IEntityChangeEventHelper>(NullEntityChangeEventHelper.Instance);
 
+    public IOptions<AbpEntityChangeOptions> EntityChangeOptions => LazyServiceProvider.LazyGetRequiredService<IOptions<AbpEntityChangeOptions>>();
+
     public IAuditPropertySetter AuditPropertySetter => LazyServiceProvider.LazyGetRequiredService<IAuditPropertySetter>();
 
     public IEntityHistoryHelper EntityHistoryHelper => LazyServiceProvider.LazyGetService<IEntityHistoryHelper>(NullEntityHistoryHelper.Instance);
@@ -336,34 +338,59 @@ protected virtual void FillExtraPropertiesForTrackedEntities(EntityTrackedEventA
         }
     }
 
-    private void PublishEventsForTrackedEntity(EntityEntry entry)
+    protected virtual void PublishEventsForTrackedEntity(EntityEntry entry)
     {
-        switch (entry.State)
+       switch (entry.State)
         {
             case EntityState.Added:
                 ApplyAbpConceptsForAddedEntity(entry);
                 EntityChangeEventHelper.PublishEntityCreatedEvent(entry.Entity);
                 break;
-            case EntityState.Modified:
-                ApplyAbpConceptsForModifiedEntity(entry);
-                if (entry.Properties.Any(x => x.IsModified && (x.Metadata.ValueGenerated == ValueGenerated.Never || x.Metadata.ValueGenerated == ValueGenerated.OnAdd)))
-                {
-                    if (entry.Entity is ISoftDelete && entry.Entity.As<ISoftDelete>().IsDeleted)
-                    {
-                        EntityChangeEventHelper.PublishEntityDeletedEvent(entry.Entity);
-                    }
-                    else
-                    {
-                        EntityChangeEventHelper.PublishEntityUpdatedEvent(entry.Entity);
-                    }
-                }
 
-                break;
             case EntityState.Deleted:
                 ApplyAbpConceptsForDeletedEntity(entry);
                 EntityChangeEventHelper.PublishEntityDeletedEvent(entry.Entity);
                 break;
         }
+
+        foreach (var entityEntry in new[] { entry }.Where(HasEntityEntryChanged).Concat(ChangeTracker.Entries().Where(HasEntityEntryChanged)).DistinctBy(x => x.Entity))
+        {
+            ApplyAbpConceptsForModifiedEntity(entry);
+
+            if (entityEntry.Entity is ISoftDelete && entityEntry.Entity.As<ISoftDelete>().IsDeleted)
+            {
+                EntityChangeEventHelper.PublishEntityDeletedEvent(entityEntry.Entity);
+            }
+            else
+            {
+                EntityChangeEventHelper.PublishEntityUpdatedEvent(entityEntry.Entity);
+            }
+        }
+    }
+
+    protected virtual bool HasEntityEntryChanged(EntityEntry entry)
+    {
+        if (entry.State != EntityState.Modified && entry.State != EntityState.Unchanged)
+        {
+            return false;
+        }
+
+        var changed = entry.State == EntityState.Modified && entry.Properties.Any(x => x.IsModified && (x.Metadata.ValueGenerated == ValueGenerated.Never || x.Metadata.ValueGenerated == ValueGenerated.OnAdd));
+        if (changed)
+        {
+            return true;
+        }
+
+        if (!changed &&
+            EntityChangeOptions.Value.PublishEntityUpdatedEventWhenNavigationChanges)
+        {
+            if (entry.Navigations.Any(navigation => navigation.IsModified || (navigation is ReferenceEntry && navigation.As<ReferenceEntry>().TargetEntry?.State == EntityState.Modified)))
+            {
+                changed = true;
+            }
+        }
+
+        return changed;
     }
 
     protected virtual void HandlePropertiesBeforeSave()

diff --git a/framework/src/Volo.Abp.TestBase/Volo/Abp/Testing/Utils/ITestCounter.cs b/framework/src/Volo.Abp.TestBase/Volo/Abp/Testing/Utils/ITestCounter.cs
@@ -9,4 +9,6 @@ public interface ITestCounter
     int Increment(string name);
 
     int GetValue(string name);
+
+    void ResetCount(string name);
 }
diff --git a/framework/src/Volo.Abp.TestBase/Volo/Abp/Testing/Utils/TestCounter.cs b/framework/src/Volo.Abp.TestBase/Volo/Abp/Testing/Utils/TestCounter.cs
@@ -39,4 +39,12 @@ public int GetValue(string name)
             return _values.GetOrDefault(name);
         }
     }
+
+    public void ResetCount(string name)
+    {
+        lock (_values)
+        {
+            _values[name] = 0;
+        }
+    }
 }
diff --git a/framework/src/Volo.Abp.Uow/Volo/Abp/Uow/UnitOfWork.cs b/framework/src/Volo.Abp.Uow/Volo/Abp/Uow/UnitOfWork.cs
@@ -272,6 +272,7 @@ public virtual void OnCompleted(Func<Task> handler)
             }
             else
             {
+                eventRecord.SetOrder(eventRecords[foundIndex].EventOrder);
                 eventRecords[foundIndex] = eventRecord;
             }
         }

diff --git a/framework/src/Volo.Abp.Uow/Volo/Abp/Uow/UnitOfWorkEventRecord.cs b/framework/src/Volo.Abp.Uow/Volo/Abp/Uow/UnitOfWorkEventRecord.cs
@@ -9,7 +9,7 @@ public class UnitOfWorkEventRecord
 
     public Type EventType { get; }
 
-    public long EventOrder { get; }
+    public long EventOrder { get; protected set; }
 
     public bool UseOutbox { get; }
 
@@ -29,4 +29,9 @@ public class UnitOfWorkEventRecord
         EventOrder = eventOrder;
         UseOutbox = useOutbox;
     }
+
+    public void SetOrder(long order)
+    {
+        EventOrder = order;
+    }
 }
diff --git a/...ntityFrameworkCore.Tests/Volo/Abp/EntityFrameworkCore/AbpEntityFrameworkCoreTestModule.cs b/...ntityFrameworkCore.Tests/Volo/Abp/EntityFrameworkCore/AbpEntityFrameworkCoreTestModule.cs
@@ -48,6 +48,11 @@ public override void ConfigureServices(ServiceConfigurationContext context)
             {
                 opt.DefaultWithDetailsFunc = q => q.Include(p => p.Books);
             });
+
+            options.Entity<AppEntityWithNavigations>(opt =>
+            {
+                opt.DefaultWithDetailsFunc = q => q.Include(p => p.OneToOne).Include(p => p.OneToMany).Include(p => p.ManyToMany);
+            });
         });
 
         context.Services.AddAbpDbContext<HostTestAppDbContext>(options =>

diff --git a/...EntityFrameworkCore.Tests/Volo/Abp/EntityFrameworkCore/DomainEvents/DomainEvents_Tests.cs b/...EntityFrameworkCore.Tests/Volo/Abp/EntityFrameworkCore/DomainEvents/DomainEvents_Tests.cs
@@ -5,3 +5,7 @@ namespace Volo.Abp.EntityFrameworkCore.DomainEvents;
 public class DomainEvents_Tests : DomainEvents_Tests<AbpEntityFrameworkCoreTestModule>
 {
 }
+
+public class AbpEntityChangeOptions_DomainEvents_Tests : AbpEntityChangeOptions_DomainEvents_Tests<AbpEntityFrameworkCoreTestModule>
+{
+}
diff --git a/...olo.Abp.EntityFrameworkCore.Tests/Volo/Abp/EntityFrameworkCore/TestMigrationsDbContext.cs b/...olo.Abp.EntityFrameworkCore.Tests/Volo/Abp/EntityFrameworkCore/TestMigrationsDbContext.cs
@@ -26,6 +26,8 @@ public class TestMigrationsDbContext : AbpDbContext<TestMigrationsDbContext>
 
     public DbSet<Category> Categories { get; set; }
 
+    public DbSet<AppEntityWithNavigations> AppEntityWithNavigations { get; set; }
+
     public TestMigrationsDbContext(DbContextOptions<TestMigrationsDbContext> options)
         : base(options)
     {
@@ -64,5 +66,14 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
         {
             b.HasAbpQueryFilter(e => e.Name.StartsWith("abp"));
         });
+
+        modelBuilder.Entity<AppEntityWithNavigations>(b =>
+        {
+            b.ConfigureByConvention();
+            b.OwnsOne(v => v.AppEntityWithValueObjectAddress);
+            b.HasOne(x => x.OneToOne).WithOne().HasForeignKey<AppEntityWithNavigationChildOneToOne>(x => x.Id);
+            b.HasMany(x => x.OneToMany).WithOne().HasForeignKey(x => x.AppEntityWithNavigationId);
+            b.HasMany(x => x.ManyToMany).WithMany();
+        });
     }
 }
diff --git a/...lo.Abp.EntityFrameworkCore.Tests/Volo/Abp/TestApp/EntityFrameworkCore/TestAppDbContext.cs b/...lo.Abp.EntityFrameworkCore.Tests/Volo/Abp/TestApp/EntityFrameworkCore/TestAppDbContext.cs
@@ -34,6 +34,8 @@ public class TestAppDbContext : AbpDbContext<TestAppDbContext>, IThirdDbContext,
 
     public DbSet<Category> Categories { get; set; }
 
+    public DbSet<AppEntityWithNavigations> AppEntityWithNavigations { get; set; }
+
     public TestAppDbContext(DbContextOptions<TestAppDbContext> options)
         : base(options)
     {
@@ -92,6 +94,15 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
             b.HasAbpQueryFilter(e => e.Name.StartsWith("abp"));
         });
 
+        modelBuilder.Entity<AppEntityWithNavigations>(b =>
+        {
+            b.ConfigureByConvention();
+            b.OwnsOne(v => v.AppEntityWithValueObjectAddress);
+            b.HasOne(x => x.OneToOne).WithOne().HasForeignKey<AppEntityWithNavigationChildOneToOne>(x => x.Id);
+            b.HasMany(x => x.OneToMany).WithOne().HasForeignKey(x => x.AppEntityWithNavigationId);
+            b.HasMany(x => x.ManyToMany).WithMany();
+        });
+
         modelBuilder.TryConfigureObjectExtensions<TestAppDbContext>();
     }
 }
diff --git a/framework/test/Volo.Abp.MemoryDb.Tests/Volo/Abp/TestApp/MemoryDb/TestAppMemoryDbContext.cs b/framework/test/Volo.Abp.MemoryDb.Tests/Volo/Abp/TestApp/MemoryDb/TestAppMemoryDbContext.cs
@@ -11,7 +11,8 @@ public class TestAppMemoryDbContext : MemoryDbContext
     private static readonly Type[] EntityTypeList = {
             typeof(Person),
             typeof(EntityWithIntPk),
-            typeof(Product)
+            typeof(Product),
+            typeof(AppEntityWithNavigations)
     };
 
     public override IReadOnlyList<Type> GetEntityTypes()

diff --git a/...ork/test/Volo.Abp.MongoDB.Tests/Volo/Abp/MongoDB/Serializer/MongoDB_DateTimeKind_Tests.cs b/...ork/test/Volo.Abp.MongoDB.Tests/Volo/Abp/MongoDB/Serializer/MongoDB_DateTimeKind_Tests.cs
@@ -21,9 +21,6 @@ protected override void AfterAddApplication(IServiceCollection services)
         // We must reconfigure it in the new unit test.
         foreach (var registeredClassMap in BsonClassMap.GetRegisteredClassMaps())
         {
-            var frozen = registeredClassMap.GetType().BaseType?.GetField("_frozen", BindingFlags.NonPublic | BindingFlags.Instance);
-            frozen?.SetValue(registeredClassMap, false);
-
             foreach (var declaredMemberMap in registeredClassMap.DeclaredMemberMaps)
             {
                 var serializer = declaredMemberMap.GetSerializer();
@@ -46,8 +43,6 @@ protected override void AfterAddApplication(IServiceCollection services)
                         }
                 }
             }
-
-            frozen?.SetValue(registeredClassMap, true);
         }
     }
 }
@@ -62,6 +57,7 @@ protected override void AfterAddApplication(IServiceCollection services)
     }
 }
 
+[Collection(MongoTestCollection.Name)]
 public class DateTimeKindTests_Local : MongoDB_DateTimeKind_Tests
 {
     protected override void AfterAddApplication(IServiceCollection services)
@@ -72,6 +68,7 @@ protected override void AfterAddApplication(IServiceCollection services)
     }
 }
 
+[Collection(MongoTestCollection.Name)]
 public class DateTimeKindTests_Utc : MongoDB_DateTimeKind_Tests
 {
     protected override void AfterAddApplication(IServiceCollection services)

diff --git a/framework/test/Volo.Abp.MongoDB.Tests/Volo/Abp/TestApp/MongoDb/ITestAppMongoDbContext.cs b/framework/test/Volo.Abp.MongoDB.Tests/Volo/Abp/TestApp/MongoDb/ITestAppMongoDbContext.cs
@@ -14,4 +14,6 @@ public interface ITestAppMongoDbContext : IAbpMongoDbContext
     IMongoCollection<City> Cities { get; }
 
     IMongoCollection<Product> Products { get; }
+
+    IMongoCollection<AppEntityWithNavigations> AppEntityWithNavigations { get; }
 }
diff --git a/framework/test/Volo.Abp.MongoDB.Tests/Volo/Abp/TestApp/MongoDb/TestAppMongoDbContext.cs b/framework/test/Volo.Abp.MongoDB.Tests/Volo/Abp/TestApp/MongoDb/TestAppMongoDbContext.cs
@@ -25,9 +25,11 @@ public class TestAppMongoDbContext : AbpMongoDbContext, ITestAppMongoDbContext,
     public IMongoCollection<ThirdDbContextDummyEntity> DummyEntities => Collection<ThirdDbContextDummyEntity>();
 
     public IMongoCollection<FourthDbContextDummyEntity> FourthDummyEntities => Collection<FourthDbContextDummyEntity>();
-    
+
     public IMongoCollection<Product> Products => Collection<Product>();
 
+    public IMongoCollection<AppEntityWithNavigations> AppEntityWithNavigations => Collection<AppEntityWithNavigations>();
+
     protected internal override void CreateModel(IMongoModelBuilder modelBuilder)
     {
         base.CreateModel(modelBuilder);
@@ -36,7 +38,7 @@ protected internal override void CreateModel(IMongoModelBuilder modelBuilder)
         {
             b.CollectionName = "MyCities";
         });
-        
+
         modelBuilder.Entity<Person>(b =>
         {
             b.CreateCollectionOptions.Collation = new Collation(locale:"en_US", strength: CollationStrength.Secondary);

diff --git a/framework/test/Volo.Abp.TestApp/Volo/Abp/TestApp/Domain/AppEntityWithNavigations.cs b/framework/test/Volo.Abp.TestApp/Volo/Abp/TestApp/Domain/AppEntityWithNavigations.cs
@@ -0,0 +1,67 @@
+using System;
+using System.Collections.Generic;
+using Volo.Abp.Domain.Entities;
+using Volo.Abp.Domain.Values;
+
+namespace Volo.Abp.TestApp.Domain;
+
+public class AppEntityWithNavigations : AggregateRoot<Guid>
+{
+    protected AppEntityWithNavigations()
+    {
+
+    }
+
+    public AppEntityWithNavigations(Guid id, string name)
+        : base(id)
+    {
+        Name = name;
+        FullName = name;
+    }
+
+    public string Name { get; set; }
+
+    public string FullName { get; set; }
+
+    public AppEntityWithValueObjectAddress AppEntityWithValueObjectAddress { get; set; }
+
+    public virtual AppEntityWithNavigationChildOneToOne OneToOne { get; set; }
+
+    public virtual List<AppEntityWithNavigationChildOneToMany> OneToMany { get; set; }
+
+    public virtual List<AppEntityWithNavigationChildManyToMany> ManyToMany { get; set; }
+}
+
+public class AppEntityWithValueObjectAddress : ValueObject
+{
+    public AppEntityWithValueObjectAddress(string country)
+    {
+
+        Country = country;
+    }
+
+    public string Country { get; set; }
+
+    protected override IEnumerable<object> GetAtomicValues()
+    {
+        yield return Country;
+    }
+}
+
+
+public class AppEntityWithNavigationChildOneToOne : Entity<Guid>
+{
+    public string ChildName { get; set; }
+}
+
+public class AppEntityWithNavigationChildOneToMany : Entity<Guid>
+{
+    public Guid AppEntityWithNavigationId { get; set; }
+
+    public string ChildName { get; set; }
+}
+
+public class AppEntityWithNavigationChildManyToMany : Entity<Guid>
+{
+    public string ChildName { get; set; }
+}