Merge pull request #13466 from abpframework/liangshiwei/event

Remove unnecessary Event Data classes

framework/src/Volo.Abp.Ddd.Domain/Volo/Abp/Domain/Entities/Events/EntityChangeEventHelper.cs

@@ -42,18 +42,6 @@ public class EntityChangeEventHelper : IEntityChangeEventHelper, ITransientDepen
         Logger = NullLogger<EntityChangeEventHelper>.Instance;
     }
 
-    public virtual void PublishEntityCreatingEvent(object entity)
-    {
-        TriggerEventWithEntity(
-            LocalEventBus,
-#pragma warning disable 618
-                typeof(EntityCreatingEventData<>),
-#pragma warning restore 618
-                entity,
-            entity
-        );
-    }
-
     public virtual void PublishEntityCreatedEvent(object entity)
     {
         TriggerEventWithEntity(
@@ -89,18 +77,6 @@ public class EntityChangeEventHelper : IEntityChangeEventHelper, ITransientDepen
             );
     }
 
-    public virtual void PublishEntityUpdatingEvent(object entity)
-    {
-        TriggerEventWithEntity(
-            LocalEventBus,
-#pragma warning disable 618
-                typeof(EntityUpdatingEventData<>),
-#pragma warning restore 618
-                entity,
-            entity
-        );
-    }
-
     public virtual void PublishEntityUpdatedEvent(object entity)
     {
         TriggerEventWithEntity(
@@ -125,18 +101,6 @@ public class EntityChangeEventHelper : IEntityChangeEventHelper, ITransientDepen
         }
     }
 
-    public virtual void PublishEntityDeletingEvent(object entity)
-    {
-        TriggerEventWithEntity(
-            LocalEventBus,
-#pragma warning disable 618
-                typeof(EntityDeletingEventData<>),
-#pragma warning restore 618
-                entity,
-            entity
-        );
-    }
-
     public virtual void PublishEntityDeletedEvent(object entity)
     {
         TriggerEventWithEntity(

framework/src/Volo.Abp.Ddd.Domain/Volo/Abp/Domain/Entities/Events/EntityChangingEventData.cs

@@ -1,23 +0,0 @@
-using System;
-
-namespace Volo.Abp.Domain.Entities.Events;
-
-/// <summary>
-/// Used to pass data for an event when an entity (<see cref="IEntity"/>) is being changed (creating, updating or deleting).
-/// See <see cref="EntityCreatingEventData{TEntity}"/>, <see cref="EntityDeletingEventData{TEntity}"/> and <see cref="EntityUpdatingEventData{TEntity}"/> classes.
-/// </summary>
-/// <typeparam name="TEntity">Entity type</typeparam>
-[Serializable]
-[Obsolete("This event is no longer needed and identical to EntityChangedEventData. Please use EntityChangedEventData instead.")]
-public class EntityChangingEventData<TEntity> : EntityEventData<TEntity>
-{
-    /// <summary>
-    /// Constructor.
-    /// </summary>
-    /// <param name="entity">Changing entity in this event</param>
-    public EntityChangingEventData(TEntity entity)
-        : base(entity)
-    {
-
-    }
-}

framework/src/Volo.Abp.Ddd.Domain/Volo/Abp/Domain/Entities/Events/EntityCreatingEventData.cs

@@ -1,22 +0,0 @@
-using System;
-
-namespace Volo.Abp.Domain.Entities.Events;
-
-/// <summary>
-/// This type of event is used to notify just before creation of an Entity.
-/// </summary>
-/// <typeparam name="TEntity">Entity type</typeparam>
-[Serializable]
-[Obsolete("This event is no longer needed and identical to EntityCreatedEventData. Please use EntityCreatedEventData instead.")]
-public class EntityCreatingEventData<TEntity> : EntityChangingEventData<TEntity>
-{
-    /// <summary>
-    /// Constructor.
-    /// </summary>
-    /// <param name="entity">The entity which is being created</param>
-    public EntityCreatingEventData(TEntity entity)
-        : base(entity)
-    {
-
-    }
-}

framework/src/Volo.Abp.Ddd.Domain/Volo/Abp/Domain/Entities/Events/EntityDeletingEventData.cs

@@ -1,22 +0,0 @@
-using System;
-
-namespace Volo.Abp.Domain.Entities.Events;
-
-/// <summary>
-/// This type of event is used to notify just before deletion of an Entity.
-/// </summary>
-/// <typeparam name="TEntity">Entity type</typeparam>
-[Serializable]
-[Obsolete("This event is no longer needed and identical to EntityDeletedEventData. Please use EntityDeletedEventData instead.")]
-public class EntityDeletingEventData<TEntity> : EntityChangingEventData<TEntity>
-{
-    /// <summary>
-    /// Constructor.
-    /// </summary>
-    /// <param name="entity">The entity which is being deleted</param>
-    public EntityDeletingEventData(TEntity entity)
-        : base(entity)
-    {
-
-    }
-}

framework/src/Volo.Abp.Ddd.Domain/Volo/Abp/Domain/Entities/Events/EntityUpdatingEventData.cs

@@ -1,22 +0,0 @@
-using System;
-
-namespace Volo.Abp.Domain.Entities.Events;
-
-/// <summary>
-/// This type of event is used to notify just before update of an Entity.
-/// </summary>
-/// <typeparam name="TEntity">Entity type</typeparam>
-[Serializable]
-[Obsolete("This event is no longer needed and identical to EntityUpdatedEventData. Please use EntityUpdatedEventData instead.")]
-public class EntityUpdatingEventData<TEntity> : EntityChangingEventData<TEntity>
-{
-    /// <summary>
-    /// Constructor.
-    /// </summary>
-    /// <param name="entity">The entity which is being updated</param>
-    public EntityUpdatingEventData(TEntity entity)
-        : base(entity)
-    {
-
-    }
-}

framework/src/Volo.Abp.Ddd.Domain/Volo/Abp/Domain/Entities/Events/IEntityChangeEventHelper.cs

@@ -5,12 +5,9 @@ namespace Volo.Abp.Domain.Entities.Events;
 /// </summary>
 public interface IEntityChangeEventHelper
 {
-    void PublishEntityCreatingEvent(object entity);
     void PublishEntityCreatedEvent(object entity);
 
-    void PublishEntityUpdatingEvent(object entity);
     void PublishEntityUpdatedEvent(object entity);
 
-    void PublishEntityDeletingEvent(object entity);
     void PublishEntityDeletedEvent(object entity);
 }

framework/src/Volo.Abp.Ddd.Domain/Volo/Abp/Domain/Entities/Events/NullEntityChangeEventHelper.cs

@@ -14,26 +14,14 @@ public class NullEntityChangeEventHelper : IEntityChangeEventHelper
     {
     }
 
-    public void PublishEntityCreatingEvent(object entity)
-    {
-    }
-
     public void PublishEntityCreatedEvent(object entity)
     {
     }
 
-    public void PublishEntityUpdatingEvent(object entity)
-    {
-    }
-
     public void PublishEntityUpdatedEvent(object entity)
     {
     }
 
-    public void PublishEntityDeletingEvent(object entity)
-    {
-    }
-
     public void PublishEntityDeletedEvent(object entity)
     {
     }

framework/src/Volo.Abp.EntityFrameworkCore/Volo/Abp/EntityFrameworkCore/AbpDbContext.cs

@@ -292,7 +292,6 @@ public abstract class AbpDbContext<TDbContext> : DbContext, IAbpEfCoreDbContext,
         {
             case EntityState.Added:
                 ApplyAbpConceptsForAddedEntity(entry);
-                EntityChangeEventHelper.PublishEntityCreatingEvent(entry.Entity);
                 EntityChangeEventHelper.PublishEntityCreatedEvent(entry.Entity);
                 break;
             case EntityState.Modified:
@@ -301,12 +300,10 @@ public abstract class AbpDbContext<TDbContext> : DbContext, IAbpEfCoreDbContext,
                 {
                     if (entry.Entity is ISoftDelete && entry.Entity.As<ISoftDelete>().IsDeleted)
                     {
-                        EntityChangeEventHelper.PublishEntityDeletingEvent(entry.Entity);
                         EntityChangeEventHelper.PublishEntityDeletedEvent(entry.Entity);
                     }
                     else
                     {
-                        EntityChangeEventHelper.PublishEntityUpdatingEvent(entry.Entity);
                         EntityChangeEventHelper.PublishEntityUpdatedEvent(entry.Entity);
                     }
                 }
@@ -314,7 +311,6 @@ public abstract class AbpDbContext<TDbContext> : DbContext, IAbpEfCoreDbContext,
                 break;
             case EntityState.Deleted:
                 ApplyAbpConceptsForDeletedEntity(entry);
-                EntityChangeEventHelper.PublishEntityDeletingEvent(entry.Entity);
                 EntityChangeEventHelper.PublishEntityDeletedEvent(entry.Entity);
                 break;
         }

framework/src/Volo.Abp.MemoryDb/Volo/Abp/Domain/Repositories/MemoryDb/MemoryDbRepository.cs

@@ -159,19 +159,16 @@ public class MemoryDbRepository<TMemoryDbContext, TEntity> : RepositoryBase<TEnt
 
     protected virtual void TriggerEntityCreateEvents(TEntity entity)
     {
-        EntityChangeEventHelper.PublishEntityCreatingEvent(entity);
         EntityChangeEventHelper.PublishEntityCreatedEvent(entity);
     }
 
     protected virtual void TriggerEntityUpdateEvents(TEntity entity)
     {
-        EntityChangeEventHelper.PublishEntityUpdatingEvent(entity);
         EntityChangeEventHelper.PublishEntityUpdatedEvent(entity);
     }
 
     protected virtual void TriggerEntityDeleteEvents(TEntity entity)
     {
-        EntityChangeEventHelper.PublishEntityDeletingEvent(entity);
         EntityChangeEventHelper.PublishEntityDeletedEvent(entity);
     }
 

framework/src/Volo.Abp.MongoDB/Volo/Abp/Domain/Repositories/MongoDB/MongoDbRepository.cs

@@ -597,13 +597,11 @@ public class MongoDbRepository<TMongoDbContext, TEntity>
 
     private void TriggerEntityCreateEvents(TEntity entity)
     {
-        EntityChangeEventHelper.PublishEntityCreatingEvent(entity);
         EntityChangeEventHelper.PublishEntityCreatedEvent(entity);
     }
 
     protected virtual void TriggerEntityUpdateEvents(TEntity entity)
     {
-        EntityChangeEventHelper.PublishEntityUpdatingEvent(entity);
         EntityChangeEventHelper.PublishEntityUpdatedEvent(entity);
     }
 
@@ -616,7 +614,6 @@ public class MongoDbRepository<TMongoDbContext, TEntity>
 
     protected virtual void TriggerEntityDeleteEvents(TEntity entity)
     {
-        EntityChangeEventHelper.PublishEntityDeletingEvent(entity);
         EntityChangeEventHelper.PublishEntityDeletedEvent(entity);
     }
 

framework/test/Volo.Abp.TestApp/Volo/Abp/TestApp/Testing/EntityChangeEvents_Tests.cs

@@ -32,37 +32,18 @@ public abstract class EntityChangeEvents_Tests<TStartupModule> : TestAppTestBase
     {
         var personName = Guid.NewGuid().ToString("N");
 
-        var creatingEventTriggered = false;
         var createdEventTriggered = false;
         var createdEtoTriggered = false;
 
         using (var uow = GetRequiredService<IUnitOfWorkManager>().Begin())
         {
-#pragma warning disable 618
-            LocalEventBus.Subscribe<EntityCreatingEventData<Person>>(data =>
-#pragma warning restore 618
-            {
-                creatingEventTriggered.ShouldBeFalse();
-                createdEventTriggered.ShouldBeFalse();
-
-                creatingEventTriggered = true;
-
-                data.Entity.Name.ShouldBe(personName);
-
-                    /* Want to change age from 15 to 18 */
-                data.Entity.Age.ShouldBe(15);
-                data.Entity.Age = 18;
-                return Task.CompletedTask;
-            });
-
             LocalEventBus.Subscribe<EntityCreatedEventData<Person>>(data =>
             {
-                creatingEventTriggered.ShouldBeTrue();
                 createdEventTriggered.ShouldBeFalse();
 
                 createdEventTriggered = true;
 
-                data.Entity.Age.ShouldBe(18);
+                data.Entity.Age.ShouldBe(15);
                 data.Entity.Name.ShouldBe(personName);
 
                 return Task.CompletedTask;
@@ -81,8 +62,7 @@ public abstract class EntityChangeEvents_Tests<TStartupModule> : TestAppTestBase
 
             await uow.CompleteAsync();
         }
-
+        
-        creatingEventTriggered.ShouldBeTrue();
         createdEventTriggered.ShouldBeTrue();
         createdEtoTriggered.ShouldBeTrue();
     }