Refactor (#23)

* refactor: move filter interfaces to abstractions

* refactor: do not expose inner repositories on entity repository

instead, add a method to get the most recent snapshot, distinguish from method that returns current state

* refactor: require a snapshotting strategy to add redis snapshotting

* refactor: prune unused query

bring your own queries

* refactor: move constructing strategy to proper home

* refactor: remove reject files

* refactor: get snapshot or default, not or construct

if there's no snapshot, we want it to return null, not the newly constructed entity

* chore: parameter is actually ILogger not IServiceProvider, rename

* refactor: snapshotting changes

1. remove PreviousSnapshot from ITransactionCommand
2. test mode passes an object that controls disposal; we need this because we will be separating recording snapshots from pulling them, and end up with two different instances of ISnapshotRepository; it should not remove the entries created until all instances have been disposed

* refactor: stop injecting IServiceProvider

ask for the required dependencies explicitly

* feature: async transaction subscriber

in test mode, will run synchronously

* feature: snapshotting transaction subscriber

store transaction snapshots asynchronously, don't block or allow a failure to cause problems :)

Author: the-avid-engineer

src/EntityDb.Abstractions/Entities/IEntityRepository.cs

@@ -1,5 +1,4 @@
-using EntityDb.Abstractions.Snapshots;
-using EntityDb.Abstractions.Transactions;
+using EntityDb.Abstractions.Transactions;
 using System;
 using System.Threading.Tasks;
 
@@ -11,24 +10,25 @@ namespace EntityDb.Abstractions.Entities
     /// <typeparam name="TEntity">The type of the entity.</typeparam>
     public interface IEntityRepository<TEntity> : IDisposable, IAsyncDisposable
     {
-        /// <inheritdoc cref="ITransactionRepository{TEntity}" />
-        ITransactionRepository<TEntity> TransactionRepository { get; }
-
-        /// <inheritdoc cref="ISnapshotRepository{TEntity}" />
-        ISnapshotRepository<TEntity>? SnapshotRepository { get; }
-
         /// <summary>
-        ///     Returns a <typeparamref name="TEntity" /> snapshot or <c>default(<typeparamref name="TEntity" />)</c>.
+        ///     Returns the most recent snapshot of a <typeparamref name="TEntity" /> or <c>default(<typeparamref name="TEntity" />)</c>.
+        /// </summary>
+        /// <param name="entityId">The id of the entity.</param>
+        /// <returns>The most recent snapshot of a <typeparamref name="TEntity" /> or constructs a new <typeparamref name="TEntity" />.</returns>
+        Task<TEntity?> GetSnapshotOrDefault(Guid entityId);
+        
+        /// <summary>
+        ///     Returns the current state of a <typeparamref name="TEntity" /> or constructs a new <typeparamref name="TEntity" />.
         /// </summary>
         /// <param name="entityId">The id of the entity.</param>
-        /// <returns>A <typeparamref name="TEntity" /> snapshot or <c>default(<typeparamref name="TEntity" />)</c>.</returns>
-        Task<TEntity> Get(Guid entityId);
+        /// <returns>The current state of a <typeparamref name="TEntity" /> or constructs a new <typeparamref name="TEntity" />.</returns>
+        Task<TEntity> GetCurrentOrConstruct(Guid entityId);
 
         /// <summary>
         ///     Inserts a single transaction with an atomic commit.
         /// </summary>
         /// <param name="transaction">The transaction.</param>
-        /// <returns><c>true</c> if the insert suceeded, or <c>false</c> if the insert failed.</returns>
-        Task<bool> Put(ITransaction<TEntity> transaction);
+        /// <returns><c>true</c> if the insert succeeded, or <c>false</c> if the insert failed.</returns>
+        Task<bool> PutTransaction(ITransaction<TEntity> transaction);
     }
 }

src/EntityDb.Abstractions/Entities/IEntityRepositoryFactory.cs

@@ -0,0 +1,12 @@
+using EntityDb.Abstractions.Snapshots;
+using EntityDb.Abstractions.Transactions;
+using System.Threading.Tasks;
+
+namespace EntityDb.Abstractions.Entities
+{
+    public interface IEntityRepositoryFactory<TEntity>
+    {
+        Task<IEntityRepository<TEntity>> CreateRepository(ITransactionSessionOptions transactionSessionOptions,
+            ISnapshotSessionOptions? snapshotSessionOptions = null);
+    }
+}

src/EntityDb.Abstractions/Queries/Filters/ICommandFilter.cs

@@ -0,0 +1,18 @@
+using EntityDb.Abstractions.Queries.FilterBuilders;
+
+namespace EntityDb.Abstractions.Queries.Filters
+{
+    /// <summary>
+    ///     Represents a type that supplies filtering for a <see cref="ICommandQuery" />.
+    /// </summary>
+    public interface ICommandFilter
+    {
+        /// <summary>
+        ///     Returns a <typeparamref name="TFilter" /> built from a command filter builder.
+        /// </summary>
+        /// <typeparam name="TFilter">The type of filter used by the repository.</typeparam>
+        /// <param name="builder">The command filter builder.</param>
+        /// <returns>A <typeparamref name="TFilter" /> built from <paramref name="builder" />.</returns>
+        TFilter GetFilter<TFilter>(ICommandFilterBuilder<TFilter> builder);
+    }
+}

src/EntityDb.Abstractions/Queries/Filters/IFactFilter.cs

@@ -0,0 +1,18 @@
+using EntityDb.Abstractions.Queries.FilterBuilders;
+
+namespace EntityDb.Abstractions.Queries.Filters
+{
+    /// <summary>
+    ///     Represents a type that supplies filtering for a <see cref="IFactQuery" />.
+    /// </summary>
+    public interface IFactFilter
+    {
+        /// <summary>
+        ///     Returns a <typeparamref name="TFilter" /> built from a fact filter builder.
+        /// </summary>
+        /// <typeparam name="TFilter">The type of filter used by the repository.</typeparam>
+        /// <param name="builder">The fact filter builder.</param>
+        /// <returns>A <typeparamref name="TFilter" /> built from <paramref name="builder" />.</returns>
+        TFilter GetFilter<TFilter>(IFactFilterBuilder<TFilter> builder);
+    }
+}

src/EntityDb.Abstractions/Queries/Filters/ILeaseFilter.cs

@@ -0,0 +1,18 @@
+using EntityDb.Abstractions.Queries.FilterBuilders;
+
+namespace EntityDb.Abstractions.Queries.Filters
+{
+    /// <summary>
+    ///     Represents a type that supplies filtering for a <see cref="ILeaseQuery" />.
+    /// </summary>
+    public interface ILeaseFilter
+    {
+        /// <summary>
+        ///     Returns a <typeparamref name="TFilter" /> built from a lease filter builder.
+        /// </summary>
+        /// <typeparam name="TFilter">The type of filter used by the repository.</typeparam>
+        /// <param name="builder">The lease filter builder.</param>
+        /// <returns>A <typeparamref name="TFilter" /> built from <paramref name="builder" />.</returns>
+        TFilter GetFilter<TFilter>(ILeaseFilterBuilder<TFilter> builder);
+    }
+}

src/EntityDb.Abstractions/Queries/Filters/ISourceFilter.cs

@@ -0,0 +1,18 @@
+using EntityDb.Abstractions.Queries.FilterBuilders;
+
+namespace EntityDb.Abstractions.Queries.Filters
+{
+    /// <summary>
+    ///     Represents a type that supplies filtering for a <see cref="ISourceQuery" />.
+    /// </summary>
+    public interface ISourceFilter
+    {
+        /// <summary>
+        ///     Returns a <typeparamref name="TFilter" /> built from a source filter builder.
+        /// </summary>
+        /// <typeparam name="TFilter">The type of filter used by the repository.</typeparam>
+        /// <param name="builder">The source filter builder.</param>
+        /// <returns>A <typeparamref name="TFilter" /> built from <paramref name="builder" />.</returns>
+        TFilter GetFilter<TFilter>(ISourceFilterBuilder<TFilter> builder);
+    }
+}

src/EntityDb.Abstractions/Queries/Filters/ITagFilter.cs

@@ -0,0 +1,18 @@
+using EntityDb.Abstractions.Queries.FilterBuilders;
+
+namespace EntityDb.Abstractions.Queries.Filters
+{
+    /// <summary>
+    ///     Represents a type that supplies filtering for a <see cref="ITagQuery" />.
+    /// </summary>
+    public interface ITagFilter
+    {
+        /// <summary>
+        ///     Returns a <typeparamref name="TFilter" /> built from a tag filter builder.
+        /// </summary>
+        /// <typeparam name="TFilter">The type of filter used by the repository.</typeparam>
+        /// <param name="builder">The tag filter builder.</param>
+        /// <returns>A <typeparamref name="TFilter" /> built from <paramref name="builder" />.</returns>
+        TFilter GetFilter<TFilter>(ITagFilterBuilder<TFilter> builder);
+    }
+}

src/EntityDb.Abstractions/Queries/ICommandQuery.cs

@@ -1,21 +1,13 @@
-using EntityDb.Abstractions.Queries.FilterBuilders;
+using EntityDb.Abstractions.Queries.Filters;
 using EntityDb.Abstractions.Queries.SortBuilders;
 
 namespace EntityDb.Abstractions.Queries
 {
     /// <summary>
     ///     Abstracts a query on commands.
     /// </summary>
-    public interface ICommandQuery : IQuery
+    public interface ICommandQuery : IQuery, ICommandFilter
     {
-        /// <summary>
-        ///     Returns a <typeparamref name="TFilter" /> built from a command filter builder.
-        /// </summary>
-        /// <typeparam name="TFilter">The type of filter used by the repository.</typeparam>
-        /// <param name="builder">The command filter builder.</param>
-        /// <returns>A <typeparamref name="TFilter" /> built from <paramref name="builder" />.</returns>
-        TFilter GetFilter<TFilter>(ICommandFilterBuilder<TFilter> builder);
-
         /// <summary>
         ///     Returns a <typeparamref name="TSort" /> built from a command sort builder.
         /// </summary>

src/EntityDb.Abstractions/Queries/IFactQuery.cs

@@ -1,21 +1,13 @@
-using EntityDb.Abstractions.Queries.FilterBuilders;
+using EntityDb.Abstractions.Queries.Filters;
 using EntityDb.Abstractions.Queries.SortBuilders;
 
 namespace EntityDb.Abstractions.Queries
 {
     /// <summary>
     ///     Abstracts a query on facts.
     /// </summary>
-    public interface IFactQuery : IQuery
+    public interface IFactQuery : IQuery, IFactFilter
     {
-        /// <summary>
-        ///     Returns a <typeparamref name="TFilter" /> built from a fact filter builder.
-        /// </summary>
-        /// <typeparam name="TFilter">The type of filter used by the repository.</typeparam>
-        /// <param name="builder">The fact filter builder.</param>
-        /// <returns>A <typeparamref name="TFilter" /> built from <paramref name="builder" />.</returns>
-        TFilter GetFilter<TFilter>(IFactFilterBuilder<TFilter> builder);
-
         /// <summary>
         ///     Returns a <typeparamref name="TSort" /> built from a fact sort builder.
         /// </summary>

src/EntityDb.Abstractions/Queries/ILeaseQuery.cs

@@ -1,21 +1,13 @@
-using EntityDb.Abstractions.Queries.FilterBuilders;
+using EntityDb.Abstractions.Queries.Filters;
 using EntityDb.Abstractions.Queries.SortBuilders;
 
 namespace EntityDb.Abstractions.Queries
 {
     /// <summary>
     ///     Abstracts a query on leases.
     /// </summary>
-    public interface ILeaseQuery : IQuery
+    public interface ILeaseQuery : IQuery, ILeaseFilter
     {
-        /// <summary>
-        ///     Returns a <typeparamref name="TFilter" /> built from a lease filter builder.
-        /// </summary>
-        /// <typeparam name="TFilter">The type of filter used by the repository.</typeparam>
-        /// <param name="builder">The lease filter builder.</param>
-        /// <returns>A <typeparamref name="TFilter" /> built from <paramref name="builder" />.</returns>
-        TFilter GetFilter<TFilter>(ILeaseFilterBuilder<TFilter> builder);
-
         /// <summary>
         ///     Returns a <typeparamref name="TSort" /> built from a lease sort builder.
         /// </summary>