Renamed IHookExecutorHelper to IHookContainerProvider

Bart Koelman · Bart Koelman · commit e644a0f13c9e · 2021-03-11T11:28:05.000+01:00
diff --git a/src/JsonApiDotNetCore/Configuration/JsonApiApplicationBuilder.cs b/src/JsonApiDotNetCore/Configuration/JsonApiApplicationBuilder.cs
@@ -261,7 +261,7 @@ private void AddResourceHooks()
                 _services.AddSingleton(typeof(IHooksDiscovery<>), typeof(HooksDiscovery<>));
                 _services.AddScoped(typeof(IResourceHookContainer<>), typeof(ResourceHooksDefinition<>));
                 _services.AddTransient<IResourceHookExecutor, ResourceHookExecutor>();
-                _services.AddTransient<IHookExecutorHelper, HookExecutorHelper>();
+                _services.AddTransient<IHookContainerProvider, HookContainerProvider>();
                 _services.AddScoped<INodeNavigator, NodeNavigator>();
                 _services.AddScoped<IResourceHookExecutorFacade, ResourceHookExecutorFacade>();
             }
diff --git a/src/JsonApiDotNetCore/Hooks/Internal/Execution/HookContainerProvider.cs b/src/JsonApiDotNetCore/Hooks/Internal/Execution/HookContainerProvider.cs
@@ -17,7 +17,7 @@
 namespace JsonApiDotNetCore.Hooks.Internal.Execution
 {
     /// <inheritdoc />
-    internal sealed class HookExecutorHelper : IHookExecutorHelper
+    internal sealed class HookContainerProvider : IHookContainerProvider
     {
         private static readonly HooksCollectionConverter CollectionConverter = new HooksCollectionConverter();
         private static readonly HooksObjectFactory ObjectFactory = new HooksObjectFactory();
@@ -31,7 +31,7 @@ internal sealed class HookExecutorHelper : IHookExecutorHelper
         private readonly Dictionary<RightType, IHooksDiscovery> _hookDiscoveries;
         private readonly List<ResourceHook> _targetedHooksForRelatedResources;
 
-        public HookExecutorHelper(IGenericServiceFactory genericServiceFactory, IResourceContextProvider resourceContextProvider, IJsonApiOptions options)
+        public HookContainerProvider(IGenericServiceFactory genericServiceFactory, IResourceContextProvider resourceContextProvider, IJsonApiOptions options)
         {
             _options = options;
             _genericServiceFactory = genericServiceFactory;
diff --git a/src/JsonApiDotNetCore/Hooks/Internal/Execution/IHookContainerProvider.cs b/src/JsonApiDotNetCore/Hooks/Internal/Execution/IHookContainerProvider.cs
@@ -10,7 +10,7 @@ namespace JsonApiDotNetCore.Hooks.Internal.Execution
     /// A helper class for retrieving meta data about hooks, fetching database values and performing other recurring internal operations. Used internally by
     /// <see cref="ResourceHookExecutor" />
     /// </summary>
-    internal interface IHookExecutorHelper
+    internal interface IHookContainerProvider
     {
         /// <summary>
         /// For a particular ResourceHook and for a given model type, checks if the ResourceHooksDefinition has an implementation for the hook and if so, return
diff --git a/src/JsonApiDotNetCore/Hooks/Internal/IResourceHookExecutor.cs b/src/JsonApiDotNetCore/Hooks/Internal/IResourceHookExecutor.cs
@@ -7,7 +7,7 @@ namespace JsonApiDotNetCore.Hooks.Internal
     /// <summary>
     /// Transient service responsible for executing Resource Hooks as defined in <see cref="ResourceHooksDefinition{TResource}" />. See methods in
     /// <see cref="IReadHookExecutor" />, <see cref="IUpdateHookExecutor" /> and <see cref="IOnReturnHookExecutor" /> for more information. Uses
-    /// <see cref="NodeNavigator" /> for traversal of nested resource data structures. Uses <see cref="HookExecutorHelper" /> for retrieving meta data
+    /// <see cref="NodeNavigator" /> for traversal of nested resource data structures. Uses <see cref="HookContainerProvider" /> for retrieving meta data
     /// about hooks, fetching database values and performing other recurring internal operations.
     /// </summary>
     public interface IResourceHookExecutor : IReadHookExecutor, IUpdateHookExecutor, ICreateHookExecutor, IDeleteHookExecutor, IOnReturnHookExecutor
diff --git a/src/JsonApiDotNetCore/Hooks/Internal/ResourceHookExecutor.cs b/src/JsonApiDotNetCore/Hooks/Internal/ResourceHookExecutor.cs
@@ -25,16 +25,16 @@ internal sealed class ResourceHookExecutor : IResourceHookExecutor
         private static readonly HooksObjectFactory ObjectFactory = new HooksObjectFactory();
         private static readonly HooksCollectionConverter CollectionConverter = new HooksCollectionConverter();
 
-        private readonly IHookExecutorHelper _executorHelper;
+        private readonly IHookContainerProvider _containerProvider;
         private readonly INodeNavigator _nodeNavigator;
         private readonly IEnumerable<IQueryConstraintProvider> _constraintProviders;
         private readonly ITargetedFields _targetedFields;
         private readonly IResourceGraph _resourceGraph;
 
-        public ResourceHookExecutor(IHookExecutorHelper executorHelper, INodeNavigator nodeNavigator, ITargetedFields targetedFields,
+        public ResourceHookExecutor(IHookContainerProvider containerProvider, INodeNavigator nodeNavigator, ITargetedFields targetedFields,
             IEnumerable<IQueryConstraintProvider> constraintProviders, IResourceGraph resourceGraph)
         {
-            _executorHelper = executorHelper;
+            _containerProvider = containerProvider;
             _nodeNavigator = nodeNavigator;
             _targetedFields = targetedFields;
             _constraintProviders = constraintProviders;
@@ -45,7 +45,7 @@ public ResourceHookExecutor(IHookExecutorHelper executorHelper, INodeNavigator n
         public void BeforeRead<TResource>(ResourcePipeline pipeline, string stringId = null)
             where TResource : class, IIdentifiable
         {
-            IResourceHookContainer<TResource> hookContainer = _executorHelper.GetResourceHookContainer<TResource>(ResourceHook.BeforeRead);
+            IResourceHookContainer<TResource> hookContainer = _containerProvider.GetResourceHookContainer<TResource>(ResourceHook.BeforeRead);
             hookContainer?.BeforeRead(pipeline, false, stringId);
             List<Type> calledContainers = typeof(TResource).AsList();
 
@@ -239,7 +239,7 @@ private GetHookResult<TResource> GetHook<TResource>(ResourceHook target, IEnumer
             where TResource : class, IIdentifiable
         {
             RootNode<TResource> node = _nodeNavigator.CreateRootNode(resources);
-            IResourceHookContainer<TResource> container = _executorHelper.GetResourceHookContainer<TResource>(target);
+            IResourceHookContainer<TResource> container = _containerProvider.GetResourceHookContainer<TResource>(target);
 
             return new GetHookResult<TResource>(container, node);
         }
@@ -270,7 +270,7 @@ private void TraverseNextLayer(IEnumerable<IResourceNode> nextLayer, Action<IRes
         {
             foreach (IResourceNode node in nextLayer)
             {
-                IResourceHookContainer hookContainer = _executorHelper.GetResourceHookContainer(node.ResourceType, target);
+                IResourceHookContainer hookContainer = _containerProvider.GetResourceHookContainer(node.ResourceType, target);
 
                 if (hookContainer != null)
                 {
@@ -292,7 +292,7 @@ private void RecursiveBeforeRead(List<RelationshipAttribute> relationshipChain,
                 if (!calledContainers.Contains(relationship.RightType))
                 {
                     calledContainers.Add(relationship.RightType);
-                    IResourceHookContainer container = _executorHelper.GetResourceHookContainer(relationship.RightType, ResourceHook.BeforeRead);
+                    IResourceHookContainer container = _containerProvider.GetResourceHookContainer(relationship.RightType, ResourceHook.BeforeRead);
 
                     if (container != null)
                     {
@@ -326,7 +326,7 @@ private void FireNestedBeforeUpdateHooks(ResourcePipeline pipeline, IEnumerable<
         {
             foreach (IResourceNode node in layer)
             {
-                IResourceHookContainer nestedHookContainer = _executorHelper.GetResourceHookContainer(node.ResourceType, ResourceHook.BeforeUpdateRelationship);
+                IResourceHookContainer nestedHookContainer = _containerProvider.GetResourceHookContainer(node.ResourceType, ResourceHook.BeforeUpdateRelationship);
                 IEnumerable uniqueResources = node.UniqueResources;
                 RightType resourceType = node.ResourceType;
                 IDictionary<RelationshipAttribute, IEnumerable> currentResourcesGrouped;
@@ -427,15 +427,15 @@ private IDictionary<RelationshipAttribute, IEnumerable> ReplaceKeysWithInverseRe
         private void FireForAffectedImplicits(Type resourceTypeToInclude, IDictionary<RelationshipAttribute, IEnumerable> implicitsTarget,
             ResourcePipeline pipeline, IEnumerable existingImplicitResources = null)
         {
-            IResourceHookContainer container = _executorHelper.GetResourceHookContainer(resourceTypeToInclude, ResourceHook.BeforeImplicitUpdateRelationship);
+            IResourceHookContainer container = _containerProvider.GetResourceHookContainer(resourceTypeToInclude, ResourceHook.BeforeImplicitUpdateRelationship);
 
             if (container == null)
             {
                 return;
             }
 
             IDictionary<RelationshipAttribute, IEnumerable> implicitAffected =
-                _executorHelper.LoadImplicitlyAffected(implicitsTarget, existingImplicitResources);
+                _containerProvider.LoadImplicitlyAffected(implicitsTarget, existingImplicitResources);
 
             if (!implicitAffected.Any())
             {
@@ -565,12 +565,12 @@ private IEnumerable LoadDbValues(Type resourceType, IEnumerable uniqueResources,
         {
             // We only need to load database values if the target hook of this hook execution
             // cycle is compatible with displaying database values and has this option enabled.
-            if (!_executorHelper.ShouldLoadDbValues(resourceType, targetHook))
+            if (!_containerProvider.ShouldLoadDbValues(resourceType, targetHook))
             {
                 return null;
             }
 
-            return _executorHelper.LoadDbValues(resourceType, uniqueResources, relationshipsToNextLayer);
+            return _containerProvider.LoadDbValues(resourceType, uniqueResources, relationshipsToNextLayer);
         }
 
         /// <summary>
diff --git a/test/UnitTests/ResourceHooks/HooksTestsSetup.cs b/test/UnitTests/ResourceHooks/HooksTestsSetup.cs
@@ -54,7 +54,7 @@ protected TestObjectsA<TPrimary> CreateTestObjects<TPrimary>(IHooksDiscovery<TPr
 
             SetupProcessorFactoryForResourceDefinition(gpfMock, primaryResource.Object, primaryDiscovery);
 
-            var execHelper = new HookExecutorHelper(gpfMock.Object, ResourceGraph, options);
+            var execHelper = new HookContainerProvider(gpfMock.Object, ResourceGraph, options);
             var traversalHelper = new NodeNavigator(ResourceGraph, ufMock.Object);
             var hookExecutor = new ResourceHookExecutor(execHelper, traversalHelper, ufMock.Object, constraintsMock.Object, ResourceGraph);
 
@@ -81,7 +81,7 @@ protected TestObjectsB<TPrimary, TSecondary> CreateTestObjects<TPrimary, TSecond
             SetupProcessorFactoryForResourceDefinition(gpfMock, primaryResource.Object, primaryDiscovery, dbContext, resourceGraph);
             SetupProcessorFactoryForResourceDefinition(gpfMock, secondaryResource.Object, secondaryDiscovery, dbContext, resourceGraph);
 
-            var execHelper = new HookExecutorHelper(gpfMock.Object, ResourceGraph, options);
+            var execHelper = new HookContainerProvider(gpfMock.Object, ResourceGraph, options);
             var traversalHelper = new NodeNavigator(ResourceGraph, ufMock.Object);
             var hookExecutor = new ResourceHookExecutor(execHelper, traversalHelper, ufMock.Object, constraintsMock.Object, ResourceGraph);
 
@@ -113,7 +113,7 @@ protected TestObjectsC<TPrimary, TFirstSecondary, TSecondSecondary> CreateTestOb
             SetupProcessorFactoryForResourceDefinition(gpfMock, firstSecondaryResource.Object, firstSecondaryDiscovery, dbContext, resourceGraph);
             SetupProcessorFactoryForResourceDefinition(gpfMock, secondSecondaryResource.Object, secondSecondaryDiscovery, dbContext, resourceGraph);
 
-            var execHelper = new HookExecutorHelper(gpfMock.Object, ResourceGraph, options);
+            var execHelper = new HookContainerProvider(gpfMock.Object, ResourceGraph, options);
             var traversalHelper = new NodeNavigator(ResourceGraph, ufMock.Object);
             var hookExecutor = new ResourceHookExecutor(execHelper, traversalHelper, ufMock.Object, constraintsMock.Object, ResourceGraph);
 

Original file line number	Diff line number	Diff line change
`@@ -261,7 +261,7 @@ private void AddResourceHooks()`
`261`	`261`	`_services.AddSingleton(typeof(IHooksDiscovery<>), typeof(HooksDiscovery<>));`
`262`	`262`	`_services.AddScoped(typeof(IResourceHookContainer<>), typeof(ResourceHooksDefinition<>));`
`263`	`263`	`_services.AddTransient<IResourceHookExecutor, ResourceHookExecutor>();`
`264`		`- _services.AddTransient<IHookExecutorHelper, HookExecutorHelper>();`
	`264`	`+ _services.AddTransient<IHookContainerProvider, HookContainerProvider>();`
`265`	`265`	`_services.AddScoped<INodeNavigator, NodeNavigator>();`
`266`	`266`	`_services.AddScoped<IResourceHookExecutorFacade, ResourceHookExecutorFacade>();`
`267`	`267`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`namespace JsonApiDotNetCore.Hooks.Internal.Execution`
`18`	`18`	`{`
`19`	`19`	`/// <inheritdoc />`
`20`		`- internal sealed class HookExecutorHelper : IHookExecutorHelper`
	`20`	`+ internal sealed class HookContainerProvider : IHookContainerProvider`
`21`	`21`	`{`
`22`	`22`	`private static readonly HooksCollectionConverter CollectionConverter = new HooksCollectionConverter();`
`23`	`23`	`private static readonly HooksObjectFactory ObjectFactory = new HooksObjectFactory();`
`@@ -31,7 +31,7 @@ internal sealed class HookExecutorHelper : IHookExecutorHelper`
`31`	`31`	`private readonly Dictionary<RightType, IHooksDiscovery> _hookDiscoveries;`
`32`	`32`	`private readonly List<ResourceHook> _targetedHooksForRelatedResources;`
`33`	`33`
`34`		`- public HookExecutorHelper(IGenericServiceFactory genericServiceFactory, IResourceContextProvider resourceContextProvider, IJsonApiOptions options)`
	`34`	`+ public HookContainerProvider(IGenericServiceFactory genericServiceFactory, IResourceContextProvider resourceContextProvider, IJsonApiOptions options)`
`35`	`35`	`{`
`36`	`36`	`_options = options;`
`37`	`37`	`_genericServiceFactory = genericServiceFactory;`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ namespace JsonApiDotNetCore.Hooks.Internal.Execution`
`10`	`10`	`/// A helper class for retrieving meta data about hooks, fetching database values and performing other recurring internal operations. Used internally by`
`11`	`11`	`/// <see cref="ResourceHookExecutor" />`
`12`	`12`	`/// </summary>`
`13`		`- internal interface IHookExecutorHelper`
	`13`	`+ internal interface IHookContainerProvider`
`14`	`14`	`{`
`15`	`15`	`/// <summary>`
`16`	`16`	`/// For a particular ResourceHook and for a given model type, checks if the ResourceHooksDefinition has an implementation for the hook and if so, return`
Original file line number	Diff line number	Diff line change
`@@ -25,16 +25,16 @@ internal sealed class ResourceHookExecutor : IResourceHookExecutor`
`25`	`25`	`private static readonly HooksObjectFactory ObjectFactory = new HooksObjectFactory();`
`26`	`26`	`private static readonly HooksCollectionConverter CollectionConverter = new HooksCollectionConverter();`
`27`	`27`
`28`		`- private readonly IHookExecutorHelper _executorHelper;`
	`28`	`+ private readonly IHookContainerProvider _containerProvider;`
`29`	`29`	`private readonly INodeNavigator _nodeNavigator;`
`30`	`30`	`private readonly IEnumerable<IQueryConstraintProvider> _constraintProviders;`
`31`	`31`	`private readonly ITargetedFields _targetedFields;`
`32`	`32`	`private readonly IResourceGraph _resourceGraph;`
`33`	`33`
`34`		`- public ResourceHookExecutor(IHookExecutorHelper executorHelper, INodeNavigator nodeNavigator, ITargetedFields targetedFields,`
	`34`	`+ public ResourceHookExecutor(IHookContainerProvider containerProvider, INodeNavigator nodeNavigator, ITargetedFields targetedFields,`
`35`	`35`	`IEnumerable<IQueryConstraintProvider> constraintProviders, IResourceGraph resourceGraph)`
`36`	`36`	`{`
`37`		`- _executorHelper = executorHelper;`
	`37`	`+ _containerProvider = containerProvider;`
`38`	`38`	`_nodeNavigator = nodeNavigator;`
`39`	`39`	`_targetedFields = targetedFields;`
`40`	`40`	`_constraintProviders = constraintProviders;`
`@@ -45,7 +45,7 @@ public ResourceHookExecutor(IHookExecutorHelper executorHelper, INodeNavigator n`
`45`	`45`	`public void BeforeRead<TResource>(ResourcePipeline pipeline, string stringId = null)`
`46`	`46`	`where TResource : class, IIdentifiable`
`47`	`47`	`{`
`48`		`- IResourceHookContainer<TResource> hookContainer = _executorHelper.GetResourceHookContainer<TResource>(ResourceHook.BeforeRead);`
	`48`	`+ IResourceHookContainer<TResource> hookContainer = _containerProvider.GetResourceHookContainer<TResource>(ResourceHook.BeforeRead);`
`49`	`49`	`hookContainer?.BeforeRead(pipeline, false, stringId);`
`50`	`50`	`List<Type> calledContainers = typeof(TResource).AsList();`
`51`	`51`
`@@ -239,7 +239,7 @@ private GetHookResult<TResource> GetHook<TResource>(ResourceHook target, IEnumer`
`239`	`239`	`where TResource : class, IIdentifiable`
`240`	`240`	`{`
`241`	`241`	`RootNode<TResource> node = _nodeNavigator.CreateRootNode(resources);`
`242`		`- IResourceHookContainer<TResource> container = _executorHelper.GetResourceHookContainer<TResource>(target);`
	`242`	`+ IResourceHookContainer<TResource> container = _containerProvider.GetResourceHookContainer<TResource>(target);`
`243`	`243`
`244`	`244`	`return new GetHookResult<TResource>(container, node);`
`245`	`245`	`}`
`@@ -270,7 +270,7 @@ private void TraverseNextLayer(IEnumerable<IResourceNode> nextLayer, Action<IRes`
`270`	`270`	`{`
`271`	`271`	`foreach (IResourceNode node in nextLayer)`
`272`	`272`	`{`
`273`		`- IResourceHookContainer hookContainer = _executorHelper.GetResourceHookContainer(node.ResourceType, target);`
	`273`	`+ IResourceHookContainer hookContainer = _containerProvider.GetResourceHookContainer(node.ResourceType, target);`
`274`	`274`
`275`	`275`	`if (hookContainer != null)`
`276`	`276`	`{`
`@@ -292,7 +292,7 @@ private void RecursiveBeforeRead(List<RelationshipAttribute> relationshipChain,`
`292`	`292`	`if (!calledContainers.Contains(relationship.RightType))`
`293`	`293`	`{`
`294`	`294`	`calledContainers.Add(relationship.RightType);`
`295`		`- IResourceHookContainer container = _executorHelper.GetResourceHookContainer(relationship.RightType, ResourceHook.BeforeRead);`
	`295`	`+ IResourceHookContainer container = _containerProvider.GetResourceHookContainer(relationship.RightType, ResourceHook.BeforeRead);`
`296`	`296`
`297`	`297`	`if (container != null)`
`298`	`298`	`{`
`@@ -326,7 +326,7 @@ private void FireNestedBeforeUpdateHooks(ResourcePipeline pipeline, IEnumerable<`
`326`	`326`	`{`
`327`	`327`	`foreach (IResourceNode node in layer)`
`328`	`328`	`{`
`329`		`- IResourceHookContainer nestedHookContainer = _executorHelper.GetResourceHookContainer(node.ResourceType, ResourceHook.BeforeUpdateRelationship);`
	`329`	`+ IResourceHookContainer nestedHookContainer = _containerProvider.GetResourceHookContainer(node.ResourceType, ResourceHook.BeforeUpdateRelationship);`
`330`	`330`	`IEnumerable uniqueResources = node.UniqueResources;`
`331`	`331`	`RightType resourceType = node.ResourceType;`
`332`	`332`	`IDictionary<RelationshipAttribute, IEnumerable> currentResourcesGrouped;`
`@@ -427,15 +427,15 @@ private IDictionary<RelationshipAttribute, IEnumerable> ReplaceKeysWithInverseRe`
`427`	`427`	`private void FireForAffectedImplicits(Type resourceTypeToInclude, IDictionary<RelationshipAttribute, IEnumerable> implicitsTarget,`
`428`	`428`	`ResourcePipeline pipeline, IEnumerable existingImplicitResources = null)`
`429`	`429`	`{`
`430`		`- IResourceHookContainer container = _executorHelper.GetResourceHookContainer(resourceTypeToInclude, ResourceHook.BeforeImplicitUpdateRelationship);`
	`430`	`+ IResourceHookContainer container = _containerProvider.GetResourceHookContainer(resourceTypeToInclude, ResourceHook.BeforeImplicitUpdateRelationship);`
`431`	`431`
`432`	`432`	`if (container == null)`
`433`	`433`	`{`
`434`	`434`	`return;`
`435`	`435`	`}`
`436`	`436`
`437`	`437`	`IDictionary<RelationshipAttribute, IEnumerable> implicitAffected =`
`438`		`- _executorHelper.LoadImplicitlyAffected(implicitsTarget, existingImplicitResources);`
	`438`	`+ _containerProvider.LoadImplicitlyAffected(implicitsTarget, existingImplicitResources);`
`439`	`439`
`440`	`440`	`if (!implicitAffected.Any())`
`441`	`441`	`{`
`@@ -565,12 +565,12 @@ private IEnumerable LoadDbValues(Type resourceType, IEnumerable uniqueResources,`
`565`	`565`	`{`
`566`	`566`	`// We only need to load database values if the target hook of this hook execution`
`567`	`567`	`// cycle is compatible with displaying database values and has this option enabled.`
`568`		`- if (!_executorHelper.ShouldLoadDbValues(resourceType, targetHook))`
	`568`	`+ if (!_containerProvider.ShouldLoadDbValues(resourceType, targetHook))`
`569`	`569`	`{`
`570`	`570`	`return null;`
`571`	`571`	`}`
`572`	`572`
`573`		`- return _executorHelper.LoadDbValues(resourceType, uniqueResources, relationshipsToNextLayer);`
	`573`	`+ return _containerProvider.LoadDbValues(resourceType, uniqueResources, relationshipsToNextLayer);`
`574`	`574`	`}`
`575`	`575`
`576`	`576`	`/// <summary>`