Merge pull request #161 from koenbeuk/trigger-refactoring

Introducting synchronous triggers.

Author: koenbeuk

benchmarks/EntityFrameworkCore.Triggered.Benchmarks/Triggers/SetStudentRegistrationDateTrigger.cs

@@ -6,10 +6,9 @@ namespace EntityFrameworkCore.Triggered.Benchmarks.Triggers
 {
     public class SetStudentRegistrationDateTrigger : IBeforeSaveTrigger<Student>
     {
-        public Task BeforeSave(ITriggerContext<Student> context, CancellationToken cancellationToken)
+        public void BeforeSave(ITriggerContext<Student> context)
         {
             context.Entity.RegistrationDate = DateTimeOffset.Now;
-            return Task.CompletedTask;
         }
     }
 }

benchmarks/EntityFrameworkCore.Triggered.Benchmarks/Triggers/SignStudentUpForMandatoryCourses.cs

@@ -13,7 +13,7 @@ public SignStudentUpForMandatoryCourses(TriggeredApplicationContext applicationC
             _applicationContext = applicationContext;
         }
 
-        public Task BeforeSave(ITriggerContext<Student> context, CancellationToken cancellationToken)
+        public void BeforeSave(ITriggerContext<Student> context)
         {
             var mandatoryCourses = _applicationContext.Courses.Where(x => x.IsMandatory).ToList();
 
@@ -24,8 +24,6 @@ public Task BeforeSave(ITriggerContext<Student> context, CancellationToken cance
                     StudentId = context.Entity.Id
                 });
             }
-
-            return Task.CompletedTask;
         }
     }
 }

src/EntityFrameworkCore.Triggered.Abstractions/IAfterSaveAsyncTrigger.cs

@@ -0,0 +1,11 @@
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace EntityFrameworkCore.Triggered
+{
+    public interface IAfterSaveAsyncTrigger<TEntity>
+        where TEntity : class
+    {
+        Task AfterSaveAsync(ITriggerContext<TEntity> context, CancellationToken cancellationToken);
+    }
+}

src/EntityFrameworkCore.Triggered.Abstractions/IAfterSaveFailedAsyncTrigger.cs

@@ -0,0 +1,14 @@
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace EntityFrameworkCore.Triggered
+{
+    public interface IAfterSaveFailedAsyncTrigger<TEntity>
+        where TEntity : class
+    {
+        Task AfterSaveFailedAsync(ITriggerContext<TEntity> context, Exception exception, CancellationToken cancellationToken);
+    }
+
+
+}

src/EntityFrameworkCore.Triggered.Abstractions/IAfterSaveFailedTrigger.cs

@@ -1,12 +1,12 @@
 using System;
-using System.Threading;
-using System.Threading.Tasks;
 
 namespace EntityFrameworkCore.Triggered
 {
     public interface IAfterSaveFailedTrigger<TEntity>
         where TEntity : class
     {
-        Task AfterSaveFailed(ITriggerContext<TEntity> context, Exception exception, CancellationToken cancellationToken);
+        void AfterSaveFailed(ITriggerContext<TEntity> context, Exception exception);
     }
+
+
 }

src/EntityFrameworkCore.Triggered.Abstractions/IAfterSaveTrigger.cs

@@ -1,11 +1,8 @@
-using System.Threading;
-using System.Threading.Tasks;
-
-namespace EntityFrameworkCore.Triggered
+namespace EntityFrameworkCore.Triggered
 {
     public interface IAfterSaveTrigger<TEntity>
         where TEntity : class
     {
-        Task AfterSave(ITriggerContext<TEntity> context, CancellationToken cancellationToken);
+        void AfterSave(ITriggerContext<TEntity> context);
     }
 }

src/EntityFrameworkCore.Triggered.Abstractions/IBeforeSaveAsyncTrigger.cs

@@ -0,0 +1,11 @@
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace EntityFrameworkCore.Triggered
+{
+    public interface IBeforeSaveAsyncTrigger<in TEntity>
+        where TEntity : class
+    {
+        Task BeforeSaveAsync(ITriggerContext<TEntity> context, CancellationToken cancellationToken);
+    }
+}

src/EntityFrameworkCore.Triggered.Abstractions/IBeforeSaveTrigger.cs

@@ -1,11 +1,8 @@
-using System.Threading;
-using System.Threading.Tasks;
-
-namespace EntityFrameworkCore.Triggered
+namespace EntityFrameworkCore.Triggered
 {
     public interface IBeforeSaveTrigger<in TEntity>
         where TEntity : class
     {
-        Task BeforeSave(ITriggerContext<TEntity> context, CancellationToken cancellationToken);
+        void BeforeSave(ITriggerContext<TEntity> context);
     }
 }

src/EntityFrameworkCore.Triggered.Abstractions/ITriggerSession.cs

@@ -10,32 +10,55 @@ public interface ITriggerSession : IDisposable
         /// Discoveres any new pending changes in the DbContext
         /// </summary>
         void DiscoverChanges();
-        Task RaiseBeforeSaveStartingTriggers(CancellationToken cancellationToken = default);
-        Task RaiseBeforeSaveCompletedTriggers(CancellationToken cancellationToken = default);
-        Task RaiseAfterSaveFailedStartingTriggers(Exception exception, CancellationToken cancellationToken = default);
-        Task RaiseAfterSaveFailedCompletedTriggers(Exception exception, CancellationToken cancellationToken = default);
-        Task RaiseAfterSaveStartingTriggers(CancellationToken cancellationToken = default);
-        Task RaiseAfterSaveCompletedTriggers(CancellationToken cancellationToken = default);
+        void RaiseBeforeSaveStartingTriggers();
+        void RaiseBeforeSaveCompletedTriggers();
+        void RaiseAfterSaveFailedStartingTriggers(Exception exception);
+        void RaiseAfterSaveFailedCompletedTriggers(Exception exception);
+        void RaiseAfterSaveStartingTriggers();
+        void RaiseAfterSaveCompletedTriggers();
+        Task RaiseBeforeSaveStartingAsyncTriggers(CancellationToken cancellationToken = default);
+        Task RaiseBeforeSaveCompletedAsyncTriggers(CancellationToken cancellationToken = default);
+        Task RaiseAfterSaveFailedStartingAsyncTriggers(Exception exception, CancellationToken cancellationToken = default);
+        Task RaiseAfterSaveFailedCompletedAsyncTriggers(Exception exception, CancellationToken cancellationToken = default);
+        Task RaiseAfterSaveStartingAsyncTriggers(CancellationToken cancellationToken = default);
+        Task RaiseAfterSaveCompletedAsyncTriggers(CancellationToken cancellationToken = default);
         /// <summary>
         /// Makes a snapshot of all changes in the DbContext and invokes BeforeSaveTriggers while detecting and cascading based on the cascade settings until all changes have been processed
         /// </summary>
-        Task RaiseBeforeSaveTriggers(CancellationToken cancellationToken = default);
+        void RaiseBeforeSaveTriggers();
+        /// <summary>
+        /// Makes a snapshot of all changes in the DbContext and invokes BeforeSaveTriggers while detecting and cascading based on the cascade settings until all changes have been processed
+        /// </summary>
+        Task RaiseBeforeSaveAsyncTriggers(CancellationToken cancellationToken = default);
+        /// <summary>
+        /// Makes a snapshot of all changes in the DbContext and invokes BeforeSaveTriggers while detecting and cascading based on the cascade settings until all changes have been processed
+        /// </summary>
+        /// <param name="skipDetectedChanges">Allows BeforeSaveTriggers not to include previously detected changes. Only new changes will be detected and fired upon. This is useful in case of multiple calls to RaiseBeforeSaveTriggers</param>
+        void RaiseBeforeSaveTriggers(bool skipDetectedChanges);
         /// <summary>
         /// Makes a snapshot of all changes in the DbContext and invokes BeforeSaveTriggers while detecting and cascading based on the cascade settings until all changes have been processed
         /// </summary>
         /// <param name="skipDetectedChanges">Allows BeforeSaveTriggers not to include previously detected changes. Only new changes will be detected and fired upon. This is useful in case of multiple calls to RaiseBeforeSaveTriggers</param>
-        Task RaiseBeforeSaveTriggers(bool skipDetectedChanges, CancellationToken cancellationToken = default);
+        Task RaiseBeforeSaveAsyncTriggers(bool skipDetectedChanges, CancellationToken cancellationToken = default);
         /// <summary>
         /// Captures and locks all discovered changes
         /// </summary>
         void CaptureDiscoveredChanges();
         /// <summary>
         /// Invokes AfterSaveTriggers. Calling this method expects that either RaiseBeforeSaveTriggers() or DiscoverChanges() has been called
         /// </summary>
-        Task RaiseAfterSaveTriggers(CancellationToken cancellationToken = default);
+        void RaiseAfterSaveTriggers();
+        /// <summary>
+        /// Invokes AfterSaveTriggers. Calling this method expects that either RaiseBeforeSaveTriggers() or DiscoverChanges() has been called
+        /// </summary>
+        Task RaiseAfterSaveAsyncTriggers(CancellationToken cancellationToken = default);
+        /// <summary>
+        /// Invokes AfterSaveFailedTriggers. Calling this method expects that either RaiseBeforeSaveTriggers() or DiscoverChanges() has been called
+        /// </summary>
+        void RaiseAfterSaveFailedTriggers(Exception exception);
         /// <summary>
         /// Invokes AfterSaveFailedTriggers. Calling this method expects that either RaiseBeforeSaveTriggers() or DiscoverChanges() has been called
         /// </summary>
-        Task RaiseAfterSaveFailedTriggers(Exception exception, CancellationToken cancellationToken = default);
+        Task RaiseAfterSaveFailedAsyncTriggers(Exception exception, CancellationToken cancellationToken = default);
     }
 }

src/EntityFrameworkCore.Triggered.Abstractions/Lifecycles/IAfterSaveCompletedAsyncTrigger.cs

@@ -0,0 +1,10 @@
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace EntityFrameworkCore.Triggered.Lifecycles
+{
+    public interface IAfterSaveCompletedAsyncTrigger
+    {
+        Task AfterSaveCompletedAsync(CancellationToken cancellationToken);
+    }
+}