refactor: pass entityId to IConstructingStrategy.Construct instead of ITaggingStrategy.GetTags

this way, the entityId is generally available to any current or future logic that needs to access it

Author: the-avid-engineer

EntityDb.Abstractions/Strategies/IConstructingStrategy.cs

@@ -1,4 +1,6 @@
-namespace EntityDb.Abstractions.Strategies
+using System;
+
+namespace EntityDb.Abstractions.Strategies
 {
     /// <summary>
     /// Represents a type that constructs a new instance of <typeparamref name="TEntity"/>.
@@ -9,7 +11,8 @@ public interface IConstructingStrategy<TEntity>
         /// <summary>
         /// Returns a new instance of a <typeparamref name="TEntity"/>.
         /// </summary>
+        /// <param name="entityId">The id of the entity.</param>
         /// <returns>A new instaance of <typeparamref name="TEntity"/>.</returns>
-        TEntity Construct();
+        TEntity Construct(Guid entityId);
     }
 }

EntityDb.Abstractions/Strategies/ITaggingStrategy.cs

@@ -12,9 +12,8 @@ public interface ITaggingStrategy<TEntity>
         /// <summary>
         /// Returns the tags for a <typeparamref name="TEntity"/>.
         /// </summary>
-        /// <param name="entityId">The id of the entity.</param>
         /// <param name="entity">The entity.</param>
         /// <returns>The tags for <paramref name="entity"/>.</returns>
-        ITag[] GetTags(Guid entityId, TEntity entity);
+        ITag[] GetTags(TEntity entity);
     }
 }

EntityDb.Common.Tests/Extensions/IServiceProviderExtensionsTests.cs

@@ -25,7 +25,7 @@ public void GivenNoTaggingStrategy_WhenGettingTags_ThenReturnEmptyArray()
 
             // ACT
 
-            var tags = serviceProvider.GetTags(Guid.NewGuid(), new TransactionEntity());
+            var tags = serviceProvider.GetTags(new TransactionEntity());
 
             // ASSERT
 

EntityDb.Common/Entities/ITaggedEntity.cs

@@ -1,6 +1,5 @@
 using EntityDb.Abstractions.Strategies;
 using EntityDb.Abstractions.Tags;
-using System;
 using System.Collections.Generic;
 
 namespace EntityDb.Common.Entities
@@ -10,7 +9,7 @@ namespace EntityDb.Common.Entities
     /// </summary>
     public interface ITaggedEntity
     {
-        /// <inheritdoc cref="ITaggingStrategy{TEntity}.GetTags(Guid, TEntity)"/>
-        public IEnumerable<ITag> GetTags(Guid entityId);
+        /// <inheritdoc cref="ITaggingStrategy{TEntity}.GetTags(TEntity)"/>
+        public IEnumerable<ITag> GetTags();
     }
 }

EntityDb.Common/Extensions/IServiceProviderExtensions.cs

@@ -66,12 +66,13 @@ public static async Task<ISnapshotRepository<TEntity>> CreateSnapshotRepository<
         /// </summary>
         /// <typeparam name="TEntity">The type of the entity.</typeparam>
         /// <param name="serviceProvider">The service provider.</param>
+        /// <param name="entityId">The id of the entity.</param>
         /// <returns>A new instance of <typeparamref name="TEntity"/>.</returns>
-        public static TEntity Construct<TEntity>(this IServiceProvider serviceProvider)
+        public static TEntity Construct<TEntity>(this IServiceProvider serviceProvider, Guid entityId)
         {
             var constructingStrategy = serviceProvider.GetRequiredService<IConstructingStrategy<TEntity>>();
 
-            return constructingStrategy.Construct();
+            return constructingStrategy.Construct(entityId);
         }
 
         /// <summary>
@@ -107,16 +108,15 @@ public static IFact<TEntity> GetVersionNumberFact<TEntity>(this IServiceProvider
         /// </summary>
         /// <typeparam name="TEntity">The type of the entity.</typeparam>
         /// <param name="serviceProvider">The service provider.</param>
-        /// <param name="entityId">The id of the entity.</param>
         /// <param name="entity">The entity.</param>
         /// <returns>The tags for <paramref name="entity"/>.</returns>
-        public static ITag[] GetTags<TEntity>(this IServiceProvider serviceProvider, Guid entityId, TEntity entity)
+        public static ITag[] GetTags<TEntity>(this IServiceProvider serviceProvider, TEntity entity)
         {
             var taggingStrategy = serviceProvider.GetService<ITaggingStrategy<TEntity>>();
 
             if (taggingStrategy != null)
             {
-                return taggingStrategy.GetTags(entityId, entity);
+                return taggingStrategy.GetTags(entity);
             }
 
             return Array.Empty<ITag>();
@@ -181,7 +181,7 @@ public static async Task<TEntity> GetEntity<TEntity>(this IServiceProvider servi
                 snapshot = await snapshotRepository.GetSnapshot(entityId);
             }
 
-            var entity = snapshot ?? serviceProvider.Construct<TEntity>();
+            var entity = snapshot ?? serviceProvider.Construct<TEntity>(entityId);
 
             var versionNumber = serviceProvider.GetVersionNumber(entity);
 

EntityDb.Common/Strategies/TaggedEntityTaggingStrategy.cs

@@ -1,17 +1,16 @@
 using EntityDb.Abstractions.Strategies;
 using EntityDb.Abstractions.Tags;
 using EntityDb.Common.Entities;
-using System;
 using System.Linq;
 
 namespace EntityDb.Common.Strategies
 {
     internal sealed class TaggedEntityTaggingStrategy<TEntity> : ITaggingStrategy<TEntity>
         where TEntity : ITaggedEntity
     {
-        public ITag[] GetTags(Guid entityId, TEntity entity)
+        public ITag[] GetTags(TEntity entity)
         {
-            return entity.GetTags(entityId).ToArray();
+            return entity.GetTags().ToArray();
         }
     }
 }

EntityDb.Common/Transactions/TransactionBuilder.cs

@@ -37,7 +37,7 @@ private void AddTransactionCommand(Guid entityId, ICommand<TEntity> command)
         {
             var previousEntity = _knownEntities[entityId];
             var previousVersionNumber = _serviceProvider.GetVersionNumber(previousEntity);
-            var previousTags = _serviceProvider.GetTags(entityId, previousEntity);
+            var previousTags = _serviceProvider.GetTags(previousEntity);
 
             if (_serviceProvider.IsAuthorized(previousEntity, command, _claimsPrincipal) == false)
             {
@@ -49,7 +49,7 @@ private void AddTransactionCommand(Guid entityId, ICommand<TEntity> command)
             nextFacts.Add(_serviceProvider.GetVersionNumberFact<TEntity>(previousVersionNumber + 1));
 
             var nextEntity = nextFacts.Reduce(previousEntity);
-            var nextTags = _serviceProvider.GetTags(entityId, nextEntity);
+            var nextTags = _serviceProvider.GetTags(nextEntity);
 
             var transactionFacts = new List<TransactionFact<TEntity>>();
 
@@ -113,7 +113,7 @@ public async Task Load(Guid entityId, ITransactionRepository<TEntity> transactio
         /// </remarks>
         public TransactionBuilder<TEntity> Create(Guid entityId, ICommand<TEntity> command)
         {
-            var entity = _serviceProvider.Construct<TEntity>();
+            var entity = _serviceProvider.Construct<TEntity>(entityId);
 
             if (_knownEntities.ContainsKey(entityId))
             {

EntityDb.TestImplementations/Entities/TransactionEntity.cs

@@ -36,7 +36,7 @@ public TransactionEntity WithVersionNumber(ulong versionNumber)
             return this with { VersionNumber = versionNumber };
         }
 
-        public IEnumerable<ITag> GetTags(Guid entityId)
+        public IEnumerable<ITag> GetTags()
         {
             if (Tags != null)
             {

EntityDb.TestImplementations/Entities/TransactionStateConstructingStrategy.cs

@@ -1,10 +1,11 @@
 using EntityDb.Abstractions.Strategies;
+using System;
 
 namespace EntityDb.TestImplementations.Entities
 {
     public class TransactionEntityConstructingStrategy : IConstructingStrategy<TransactionEntity>
     {
-        public TransactionEntity Construct()
+        public TransactionEntity Construct(Guid entityId)
         {
             return new TransactionEntity();
         }