Merged with master

Author: koenbeuk

README.md

@@ -90,15 +90,15 @@ public class Startup
 }
 ```
 
-### Recursion (Cascading changes)
-`BeforeSaveTrigger<TEntity>` supports recursion. This is useful since it allows your triggers to subsequently modify the same DbContext entity graph and have it raise additional triggers. By default this behavior is turned on and protected from infinite loops by limiting the number of recursion runs. If you don't like this behavior or want to change it, you can do so by:
+### Cascading changes (previously called Recursion)
+`BeforeSaveTrigger<TEntity>` supports cascading triggers. This is useful since it allows your triggers to subsequently modify the same DbContext entity graph and have it raise additional triggers. By default this behavior is turned on and protected from infinite loops by limiting the number of cascading cycles. If you don't like this behavior or want to change it, you can do so by:
 ```csharp
 optionsBuilder.UseTriggers(triggerOptions => {
-    triggerOptions.RecursionMode(RecursionMode.EntityAndType).MaxRecusion(20)
+    triggerOptions.CascadeBehavior(CascadeBehavior.EntityAndType).MaxRecusion(20)
 })
 ```
 
-Currently there are 2 types of recursion strategies out of the box, with the support to providing your own:  `NoRecursion` and `EntityAndTypeRecursion` (default). The former simply disables recursion whereas the latter recursively detects changes and raises triggers for those changes for as long as the combination of the Entity and the change type is unique. `EntityAndTypeRecursion` is the recommended and default recursion strategy.
+Currently there are 2 types of cascading strategies out of the box, with the support to providing your own:  `NoCascade` and `EntityAndType` (default). The former simply disables cascading whereas the latter cascades triggers for as long as the combination of the Entity and the change type is unique. `EntityAndType` is the recommended and default cascading strategy.
 
 ### Inheritance
 Triggers support inheritance and sort execution of these triggers based on least concrete to most concrete. Given the following example:
@@ -124,7 +124,7 @@ Triggers shine in combination with DI. When configured, triggers are resolved fr
 - DEPRECATED: Use one of our integration packages. Currently we only support direct integration with ASP.NET Core through the [EntityFrameworkCore.Triggered.AspNetCore](https://www.nuget.org/packages/EntityFrameworkCore.Triggered.AspNetCore/) nuget package. This will use the IHttpContextAccessor to access the scoped ServiceProvider of the current request. To use this, please make sure to either call: `services.AddAspNetCoreTriggeredDbContext<MyTriggeredDbContext>()` or `triggerOptions.UseAspNetCoreIntegration()`.
 
 ### Error handling
-In some cases, you want to be triggered when a DbUpdateException occurs. For this purpose we have `IAfterSaveFailedTrigger<TEntity>`. This gets triggered for all entities as part of the change set when DbContext.SaveChanges raises a DbUpdateException. The handling method: `AfterSaveFailed` in turn gets called with the trigger context containing the entity as well as the exception. You may attempt to call `DbContext.SaveChanges` again from within this trigger. This will not raise triggers that are already raised and only raise triggers that have since become relevant (based on recursive configuration). 
+In some cases, you want to be triggered when a DbUpdateException occurs. For this purpose we have `IAfterSaveFailedTrigger<TEntity>`. This gets triggered for all entities as part of the change set when DbContext.SaveChanges raises a DbUpdateException. The handling method: `AfterSaveFailed` in turn gets called with the trigger context containing the entity as well as the exception. You may attempt to call `DbContext.SaveChanges` again from within this trigger. This will not raise triggers that are already raised and only raise triggers that have since become relevant (based on the cascading configuration). 
 
 ### Transactions
 Many database providers support the concept of a Transaction. By default when using SqlServer with EntityFrameworkCore, any call to SaveChanges will be wrapped in a transaction. Any changes made in `IBeforeSaveTrigger<TEntity>` will be included within the transaction and changes made in `IAfterSaveTrigger<TEntity>` will not. However, it is possible for the user to [explicitly control transactions](https://docs.microsoft.com/en-us/ef/core/saving/transactions). Triggers are extensible and one such extension are [Transactional Triggers](https://www.nuget.org/packages/EntityFrameworkCore.Triggered.Transactions/). In order to use this plugin you will have to implement a few steps:
@@ -174,4 +174,4 @@ public class ApplicationDbContext : DbContext {
 
 ### Similar products
 - [Ramses](https://github.com/JValck/Ramses): Lifecycle hooks for EFCore. A simple yet effective way of reacting to changes. Great for situations where you simply want to make sure that a property is set before saving to the database. Limited though in features as there is no dependency injection, no async support, no extensibility model and lifecycle hooks need to be implemented on the entity type itself.
-- [EntityFramework.Triggers](https://github.com/NickStrupat/EntityFramework.Triggers). Add triggers to your entities with insert, update, and delete events. There are three events for each: before, after, and upon failure. A fine alternative to EntityFrameworkCore.Triggered. It has been around for some time and has support for EF6 and boast a decent community. There are plenty of trigger types to opt into including the option to cancel SaveChanges from within a trigger. A big drawback however is that it does not support recursion so that triggers can never be relied on to enforce a domain constraint.
+- [EntityFramework.Triggers](https://github.com/NickStrupat/EntityFramework.Triggers). Add triggers to your entities with insert, update, and delete events. There are three events for each: before, after, and upon failure. A fine alternative to EntityFrameworkCore.Triggered. It has been around for some time and has support for EF6 and boast a decent community. There are plenty of trigger types to opt into including the option to cancel SaveChanges from within a trigger. A big drawback however is that it does not support cascading triggers so that triggers can never be relied on to enforce a domain constraint.

samples/v2/2 - PrimarySchool/README.MD

@@ -1,5 +1,5 @@
 # Hello world
-A sample application showing triggers using dependency injection and causing recursion.
+A sample application showing triggers using dependency injection and cascading triggers.
 
 ## Triggers
 

src/EntityFrameworkCore.Triggered.Abstractions/ITriggerSession.cs

@@ -17,11 +17,11 @@ public interface ITriggerSession : IDisposable
         Task RaiseAfterSaveStartingTriggers(CancellationToken cancellationToken = default);
         Task RaiseAfterSaveCompletedTriggers(CancellationToken cancellationToken = default);
         /// <summary>
-        /// Makes a snapshot of all changes in the DbContext and invokes BeforeSaveTriggers recursively based on the recursive settings until all changes have been processed
+        /// 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);
         /// <summary>
-        /// Makes a snapshot of all changes in the DbContext and invokes BeforeSaveTriggers recursively based on the recursive settings until all changes have been processed
+        /// 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);
@@ -30,11 +30,11 @@ public interface ITriggerSession : IDisposable
         /// </summary>
         void CaptureDiscoveredChanges();
         /// <summary>
-        /// Invokes AfterSaveTriggers non-recursively. Calling this method expects that either RaiseBeforeSaveTriggers() or DiscoverChanges() has been called
+        /// Invokes AfterSaveTriggers. Calling this method expects that either RaiseBeforeSaveTriggers() or DiscoverChanges() has been called
         /// </summary>
         Task RaiseAfterSaveTriggers(CancellationToken cancellationToken = default);
         /// <summary>
-        /// Invokes AfterSaveFailedTriggers non-recursively. Calling this method expects that either RaiseBeforeSaveTriggers() or DiscoverChanges() has been called
+        /// Invokes AfterSaveFailedTriggers. Calling this method expects that either RaiseBeforeSaveTriggers() or DiscoverChanges() has been called
         /// </summary>
         Task RaiseAfterSaveFailedTriggers(Exception exception, CancellationToken cancellationToken = default);
     }

src/EntityFrameworkCore.Triggered.Transactions/TriggeredSessionExtensions.cs

@@ -26,7 +26,7 @@ public static Task RaiseBeforeCommitTriggers(this ITriggerSession triggerSession
 
             if (_beforeCommitTriggerContextDiscoveryStrategy == null)
             {
-                _beforeCommitTriggerContextDiscoveryStrategy = new NonRecursiveTriggerContextDiscoveryStrategy("BeforeCommit");
+                _beforeCommitTriggerContextDiscoveryStrategy = new NonCascadingTriggerContextDiscoveryStrategy("BeforeCommit");
             }
 
 
@@ -42,7 +42,7 @@ public static Task RaiseAfterCommitTriggers(this ITriggerSession triggerSession,
 
             if (_afterCommitTriggerContextDiscoveryStrategy == null)
             {
-                _afterCommitTriggerContextDiscoveryStrategy = new NonRecursiveTriggerContextDiscoveryStrategy("AfterCommit");
+                _afterCommitTriggerContextDiscoveryStrategy = new NonCascadingTriggerContextDiscoveryStrategy("AfterCommit");
             }
 
             return ((TriggerSession)triggerSession).RaiseTriggers(typeof(IAfterCommitTrigger<>), null, _afterCommitTriggerContextDiscoveryStrategy, entityType => new AfterCommitTriggerDescriptor(entityType), cancellationToken);
@@ -56,7 +56,7 @@ public static Task RaiseBeforeRollbackTriggers(this ITriggerSession triggerSessi
 
             if (_beforeRollbackTriggerContextDiscoveryStrategy == null)
             {
-                _beforeRollbackTriggerContextDiscoveryStrategy = new NonRecursiveTriggerContextDiscoveryStrategy("BeforeRollback");
+                _beforeRollbackTriggerContextDiscoveryStrategy = new NonCascadingTriggerContextDiscoveryStrategy("BeforeRollback");
             }
 
             return ((TriggerSession)triggerSession).RaiseTriggers(typeof(IBeforeRollbackTrigger<>), null, _beforeRollbackTriggerContextDiscoveryStrategy, entityType => new BeforeRollbackTriggerDescriptor(entityType), cancellationToken);
@@ -72,7 +72,7 @@ public static Task RaiseAfterRollbackTriggers(this ITriggerSession triggerSessio
 
             if (_afterRollbackTriggerContextDiscoveryStrategy == null)
             {
-                _afterRollbackTriggerContextDiscoveryStrategy = new NonRecursiveTriggerContextDiscoveryStrategy("AfterRollback");
+                _afterRollbackTriggerContextDiscoveryStrategy = new NonCascadingTriggerContextDiscoveryStrategy("AfterRollback");
             }
 
 

…riggered/Infrastructure/RecursionMode.cs …ggered/Infrastructure/CascadeBehavior.cssrc/EntityFrameworkCore.Triggered/Infrastructure/RecursionMode.cs renamed to src/EntityFrameworkCore.Triggered/Infrastructure/CascadeBehavior.cs src/EntityFrameworkCore.Triggered/Infrastructure/RecursionMode.cs renamed to src/EntityFrameworkCore.Triggered/Infrastructure/CascadeBehavior.cs

@@ -1,12 +1,12 @@
 namespace EntityFrameworkCore.Triggered.Infrastructure
 {
-    public enum RecursionMode
+    public enum CascadeBehavior
     {
         /// <summary>
-        /// Disables recursion. Any changes made in <see cref="EntityFrameworkCore.Triggered.IBeforeSaveTrigger{TEntity}"/> will not raise additional triggers
+        /// Disables cascading. Any changes made in <see cref="EntityFrameworkCore.Triggered.IBeforeSaveTrigger{TEntity}"/> will not raise additional triggers
         /// </summary>
         /// <remarks>
-        /// No recursion is often not desired since it puts a soft restriction on <see cref="EntityFrameworkCore.Triggered.IBeforeSaveTrigger{TEntity}"/>.
+        /// No cascading is often not desired since it puts a soft restriction on <see cref="EntityFrameworkCore.Triggered.IBeforeSaveTrigger{TEntity}"/>.
         /// </remarks>
         None,
         /// <summary>

src/EntityFrameworkCore.Triggered/Infrastructure/Internal/TriggersOptionExtension.cs

@@ -2,7 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using EntityFrameworkCore.Triggered.Internal;
-using EntityFrameworkCore.Triggered.Internal.RecursionStrategy;
+using EntityFrameworkCore.Triggered.Internal.CascadeStrategies;
 using EntityFrameworkCore.Triggered.Lyfecycles;
 using Microsoft.EntityFrameworkCore.Diagnostics;
 using Microsoft.EntityFrameworkCore.Infrastructure;
@@ -61,8 +61,8 @@ public override long GetServiceProviderHashCode()
                         }
                     }
 
-                    hashCode ^= extension._maxRecursion.GetHashCode();
-                    hashCode ^= extension._recursionMode.GetHashCode();
+                    hashCode ^= extension._maxCascadeCycles.GetHashCode();
+                    hashCode ^= extension._cascadeBehavior.GetHashCode();
 
                     if (extension._serviceProviderTransform != null)
                     {
@@ -84,16 +84,16 @@ public override void PopulateDebugInfo(IDictionary<string, string> debugInfo)
 
                 debugInfo["Triggers:TriggersCount"] = (((TriggersOptionExtension)Extension)._triggers?.Count() ?? 0).ToString();
                 debugInfo["Triggers:TriggerTypesCount"] = (((TriggersOptionExtension)Extension)._triggerTypes?.Count() ?? 0).ToString();
-                debugInfo["Triggers:MaxRecursion"] = ((TriggersOptionExtension)Extension)._maxRecursion.ToString();
-                debugInfo["Triggers:RecursionMode"] = ((TriggersOptionExtension)Extension)._recursionMode.ToString();
+                debugInfo["Triggers:MaxCascadeCycles"] = ((TriggersOptionExtension)Extension)._maxCascadeCycles.ToString();
+                debugInfo["Triggers:CascadeBehavior"] = ((TriggersOptionExtension)Extension)._cascadeBehavior.ToString();
             }
         }
 
         private ExtensionInfo? _info;
         private IEnumerable<(object typeOrInstance, ServiceLifetime lifetime)>? _triggers;
         private IEnumerable<Type> _triggerTypes;
-        private int _maxRecursion = 100;
-        private RecursionMode _recursionMode = RecursionMode.EntityAndType;
+        private int _maxCascadeCycles = 100;
+        private CascadeBehavior _cascadeBehavior = CascadeBehavior.EntityAndType;
         private Func<IServiceProvider, IServiceProvider>? _serviceProviderTransform;
 
         public TriggersOptionExtension()
@@ -119,16 +119,16 @@ public TriggersOptionExtension(TriggersOptionExtension copyFrom)
             }
 
             _triggerTypes = copyFrom._triggerTypes;
-            _maxRecursion = copyFrom._maxRecursion;
-            _recursionMode = copyFrom._recursionMode;
+            _maxCascadeCycles = copyFrom._maxCascadeCycles;
+            _cascadeBehavior = copyFrom._cascadeBehavior;
             _serviceProviderTransform = copyFrom._serviceProviderTransform;
         }
 
         public DbContextOptionsExtensionInfo Info
             => _info ??= new ExtensionInfo(this);
 
-        public int MaxRecursion => _maxRecursion;
-        public RecursionMode RecursionMode => _recursionMode;
+        public int MaxCascadeCycles => _maxCascadeCycles;
+        public CascadeBehavior CascadeBehavior => _cascadeBehavior;
         public IEnumerable<(object typeOrInstance, ServiceLifetime lifetime)> Triggers => _triggers ?? Enumerable.Empty<(object typeOrInstance, ServiceLifetime lifetime)>();
 
         public void ApplyServices(IServiceCollection services)
@@ -153,17 +153,17 @@ public void ApplyServices(IServiceCollection services)
 
 
             services.Configure<TriggerOptions>(triggerServiceOptions => {
-                triggerServiceOptions.MaxRecursion = _maxRecursion;
+                triggerServiceOptions.MaxCascadeCycles = _maxCascadeCycles;
             });
 
-            var recursionStrategyType = _recursionMode switch
+            var cascadeStrategyType = _cascadeBehavior switch
             {
-                RecursionMode.None => typeof(NoRecursionStrategy),
-                RecursionMode.EntityAndType => typeof(EntityAndTypeRecursionStrategy),
-                _ => throw new InvalidOperationException("Unsupported recursion mode")
+                CascadeBehavior.None => typeof(NoCascadeStrategy),
+                CascadeBehavior.EntityAndType => typeof(EntityAndTypeCascadeStrategy),
+                _ => throw new InvalidOperationException("Unsupported cascading mode")
             };
 
-            services.TryAddTransient(typeof(IRecursionStrategy), recursionStrategyType);
+            services.TryAddTransient(typeof(ICascadeStrategy), cascadeStrategyType);
 
             if (_triggers != null)
             {
@@ -221,20 +221,20 @@ private bool TypeIsValidTrigger(Type type)
             }
         }
 
-        public TriggersOptionExtension WithRecursionMode(RecursionMode recursionMode)
+        public TriggersOptionExtension WithCascadeBehavior(CascadeBehavior cascadeBehavior)
         {
             var clone = Clone();
 
-            clone._recursionMode = recursionMode;
+            clone._cascadeBehavior = cascadeBehavior;
 
             return clone;
         }
 
-        public TriggersOptionExtension WithMaxRecursion(int maxRecursion)
+        public TriggersOptionExtension WithMaxCascadeCycles(int maxCascadeCycles)
         {
             var clone = Clone();
 
-            clone._maxRecursion = maxRecursion;
+            clone._maxCascadeCycles = maxCascadeCycles;
 
             return clone;
         }

src/EntityFrameworkCore.Triggered/Infrastructure/TriggersContextOptionsBuilder.cs

@@ -27,11 +27,11 @@ public TriggersContextOptionsBuilder AddTrigger(Type triggerType, ServiceLifetim
         public TriggersContextOptionsBuilder AddTrigger(object trigger)
             => WithOption(e => e.WithAdditionalTrigger(trigger));
 
-        public TriggersContextOptionsBuilder RecursionMode(RecursionMode recursionMode = Infrastructure.RecursionMode.EntityAndType)
-            => WithOption(e => e.WithRecursionMode(recursionMode));
+        public TriggersContextOptionsBuilder CascadeBehavior(CascadeBehavior cascadeBehavior = Infrastructure.CascadeBehavior.EntityAndType)
+            => WithOption(e => e.WithCascadeBehavior(cascadeBehavior));
 
-        public TriggersContextOptionsBuilder MaxRecusion(int maxRecursion = 100)
-            => WithOption(e => e.WithMaxRecursion(maxRecursion));
+        public TriggersContextOptionsBuilder MaxCascadeCycles(int maxCascadingCycles = 100)
+            => WithOption(e => e.WithMaxCascadeCycles(maxCascadingCycles));
 
         public TriggersContextOptionsBuilder AddTriggerType(Type triggerType)
             => WithOption(e => e.WithAdditionalTriggerType(triggerType));

…tegies/EntityAndTypeRecursionStrategy.cs …rategies/EntityAndTypeCascadeStrategy.cssrc/EntityFrameworkCore.Triggered/Internal/RecursionStrategies/EntityAndTypeRecursionStrategy.cs renamed to src/EntityFrameworkCore.Triggered/Internal/CascadeStrategies/EntityAndTypeCascadeStrategy.cs src/EntityFrameworkCore.Triggered/Internal/RecursionStrategies/EntityAndTypeRecursionStrategy.cs renamed to src/EntityFrameworkCore.Triggered/Internal/CascadeStrategies/EntityAndTypeCascadeStrategy.cs

@@ -1,10 +1,10 @@
 using Microsoft.EntityFrameworkCore.ChangeTracking;
 
-namespace EntityFrameworkCore.Triggered.Internal.RecursionStrategy
+namespace EntityFrameworkCore.Triggered.Internal.CascadeStrategies
 {
-    public class EntityAndTypeRecursionStrategy : IRecursionStrategy
+    public class EntityAndTypeCascadeStrategy : ICascadeStrategy
     {
-        public bool CanRecurse(EntityEntry entry, ChangeType changeType, TriggerContextDescriptor previousTriggerContextDescriptor)
+        public bool CanCascade(EntityEntry entry, ChangeType changeType, TriggerContextDescriptor previousTriggerContextDescriptor)
             => changeType != previousTriggerContextDescriptor.ChangeType;
     }
 }

src/EntityFrameworkCore.Triggered/Internal/CascadeStrategies/ICascadeStrategy.cs

@@ -0,0 +1,9 @@
+using Microsoft.EntityFrameworkCore.ChangeTracking;
+
+namespace EntityFrameworkCore.Triggered.Internal.CascadeStrategies
+{
+    public interface ICascadeStrategy
+    {
+        bool CanCascade(EntityEntry entry, ChangeType changeType, TriggerContextDescriptor previousTriggerContextDescriptor);
+    }
+}

src/EntityFrameworkCore.Triggered/Internal/CascadeStrategies/NoCascadeStrategy.cs

@@ -0,0 +1,10 @@
+using Microsoft.EntityFrameworkCore.ChangeTracking;
+
+namespace EntityFrameworkCore.Triggered.Internal.CascadeStrategies
+{
+    public class NoCascadeStrategy : ICascadeStrategy
+    {
+        public bool CanCascade(EntityEntry entry, ChangeType changeType, TriggerContextDescriptor previousTriggerContextDescriptor)
+            => false;
+    }
+}