Improve extensibility by virtualising repo methods

Author: RwnRchrds

QueryKit.Repositories/BaseEntityReadRepository.cs

@@ -59,7 +59,7 @@ protected BaseEntityReadRepository(IConnectionFactory factory)
     }
 
     /// <inheritdoc />
-    public async Task<TEntity?> GetByIdAsync(TKey id, CancellationToken cancellationToken = default)
+    public virtual async Task<TEntity?> GetByIdAsync(TKey id, CancellationToken cancellationToken = default)
     {
         if (id is null)
         {
@@ -71,7 +71,7 @@ protected BaseEntityReadRepository(IConnectionFactory factory)
     }
 
     /// <inheritdoc />
-    public async Task<PageResult<TEntity>> GetListPagedAsync(FilterOptions? filter = null, SortOptions? sort = null,
+    public virtual async Task<PageResult<TEntity>> GetListPagedAsync(FilterOptions? filter = null, SortOptions? sort = null,
         PageOptions? paging = null, bool includeDeleted = false, CancellationToken cancellationToken = default)
     {
         var (whereSql, parameters) = QuerySqlBuilder.BuildWhere<TEntity>(filter);
@@ -102,7 +102,7 @@ public async Task<PageResult<TEntity>> GetListPagedAsync(FilterOptions? filter =
     }
 
     /// <inheritdoc />
-    public async Task<IList<TEntity>> GetListAsync(FilterOptions? filter = null, SortOptions? sort = null,
+    public virtual async Task<IList<TEntity>> GetListAsync(FilterOptions? filter = null, SortOptions? sort = null,
         bool includeDeleted = false,
         CancellationToken cancellationToken = default)
     {
@@ -137,7 +137,7 @@ public async Task<IList<TEntity>> GetListAsync(FilterOptions? filter = null, Sor
     }
 
     /// <inheritdoc />
-    public async Task<bool> IsUniqueIncludingDeletedAsync(string columnName, string? value,
+    public virtual async Task<bool> IsUniqueIncludingDeletedAsync(string columnName, string? value,
         CancellationToken cancellationToken = default)
     {
         var resolved = ResolveColumnOrNull(columnName);
@@ -166,7 +166,7 @@ public async Task<bool> IsUniqueIncludingDeletedAsync(string columnName, string?
     }
 
     /// <inheritdoc />
-    public async Task<bool> IsUniqueExcludingDeletedAsync(string columnName, string? value,
+    public virtual async Task<bool> IsUniqueExcludingDeletedAsync(string columnName, string? value,
         CancellationToken cancellationToken = default)
     {
         var resolved = ResolveColumnOrNull(columnName);
@@ -206,7 +206,7 @@ public async Task<bool> IsUniqueExcludingDeletedAsync(string columnName, string?
     /// <summary>
     /// Gets a single entity using the provided SQL and parameters.
     /// </summary>
-    protected async Task<TEntity?> GetAsync(string sql, object? parameters, CancellationToken cancellationToken = default)
+    protected virtual async Task<TEntity?> GetAsync(string sql, object? parameters, CancellationToken cancellationToken = default)
     {
         using var conn = await OpenConnection(cancellationToken);
         var cmd = new CommandDefinition(sql, parameters, cancellationToken: cancellationToken);
@@ -216,7 +216,7 @@ public async Task<bool> IsUniqueExcludingDeletedAsync(string columnName, string?
     /// <summary>
     /// Gets a list of entities using the provided SQL and parameters.
     /// </summary>
-    protected async Task<IList<TEntity>> GetListAsync(string sql, object? parameters, CancellationToken cancellationToken = default)
+    protected virtual async Task<IList<TEntity>> GetListAsync(string sql, object? parameters, CancellationToken cancellationToken = default)
     {
         using var conn = await OpenConnection(cancellationToken);
         var cmd = new CommandDefinition(sql, parameters, cancellationToken: cancellationToken);
@@ -227,7 +227,7 @@ protected async Task<IList<TEntity>> GetListAsync(string sql, object? parameters
     /// <summary>
     /// Gets a single record of type <typeparamref name="T"/> using the provided SQL and parameters.
     /// </summary>
-    protected async Task<T?> GetAsync<T>(string sql, object? parameters, CancellationToken cancellationToken = default)
+    protected virtual async Task<T?> GetAsync<T>(string sql, object? parameters, CancellationToken cancellationToken = default)
     {
         using var conn = await OpenConnection(cancellationToken);
         var cmd = new CommandDefinition(sql, parameters, cancellationToken: cancellationToken);
@@ -237,7 +237,7 @@ protected async Task<IList<TEntity>> GetListAsync(string sql, object? parameters
     /// <summary>
     /// Gets a list of records of type <typeparamref name="T"/> using the provided SQL and parameters.
     /// </summary>
-    protected async Task<IList<T>> GetListAsync<T>(string sql, object? parameters, CancellationToken cancellationToken = default)
+    protected virtual async Task<IList<T>> GetListAsync<T>(string sql, object? parameters, CancellationToken cancellationToken = default)
     {
         using var conn = await OpenConnection(cancellationToken);
         var cmd = new CommandDefinition(sql, parameters, cancellationToken: cancellationToken);
@@ -248,7 +248,7 @@ protected async Task<IList<T>> GetListAsync<T>(string sql, object? parameters, C
     /// <summary>
     /// Gets a paged list of records of type <typeparamref name="T"/> using the provided SQL, parameters, and optional filtering, sorting, and paging options.
     /// </summary>
-    protected async Task<PageResult<T>> GetListPagedAsync<T>(string sql, object? parameters, FilterOptions? filter, SortOptions? sort, PageOptions? paging,
+    protected virtual async Task<PageResult<T>> GetListPagedAsync<T>(string sql, object? parameters, FilterOptions? filter, SortOptions? sort, PageOptions? paging,
         bool includeDeleted = false, CancellationToken cancellationToken = default)
     {
         paging ??= new PageOptions();
@@ -292,7 +292,7 @@ protected async Task<PageResult<T>> GetListPagedAsync<T>(string sql, object? par
     /// <summary>
     /// Gets a paged list of records of type <typeparamref name="T"/> using the provided SQL for data retrieval and counting, along with parameters and paging options.
     /// </summary>
-    protected async Task<PageResult<T>> GetListPagedAsync<T>(
+    protected virtual async Task<PageResult<T>> GetListPagedAsync<T>(
         string dataSql,
         string countSql,
         object? parameters,
@@ -317,7 +317,7 @@ protected async Task<PageResult<T>> GetListPagedAsync<T>(
     /// Override to customize connection behavior.
     /// </summary>
     /// <returns>An open <see cref="IDbConnection"/>.</returns>
-    protected async Task<IDbConnection> OpenConnection(CancellationToken cancellationToken = default)
+    protected virtual async Task<IDbConnection> OpenConnection(CancellationToken cancellationToken = default)
     {
         var conn = _factory.Create();
 
@@ -336,7 +336,7 @@ protected async Task<IDbConnection> OpenConnection(CancellationToken cancellatio
     /// <summary>
     /// Gets a paged list of <typeparamref name="TEntity"/> using the provided WHERE clause, ORDER BY clause, parameters, and paging options.
     /// </summary>
-    protected async Task<PageResult<TEntity>> GetPagedAsync(string whereSql, string orderBy, object? parameters,
+    protected virtual async Task<PageResult<TEntity>> GetPagedAsync(string whereSql, string orderBy, object? parameters,
         int page, int pageSize, CancellationToken cancellationToken = default)
     {
         using var conn = await OpenConnection(cancellationToken);

QueryKit.Repositories/BaseEntityRepository.cs

@@ -31,33 +31,29 @@ protected BaseEntityRepository(IConnectionFactory factory) : base(factory)
     }
 
     /// <inheritdoc/>
-    public async Task<TEntity> InsertAsync(TEntity entity, CancellationToken cancellationToken = default)
+    public virtual async Task<TEntity> InsertAsync(TEntity entity, CancellationToken cancellationToken = default)
     {
         using var conn = await OpenConnection(cancellationToken);
 
         var result = await conn.InsertAsync<TKey, TEntity>(entity, cancellationToken: cancellationToken);
 
         if (result != null) entity.Id = result;
-
-        await OnInsertAsync(entity, cancellationToken);
 
         return entity;
     }
 
     /// <inheritdoc/>
-    public async Task<TEntity> UpdateAsync(TEntity entity, CancellationToken cancellationToken = default)
+    public virtual async Task<TEntity> UpdateAsync(TEntity entity, CancellationToken cancellationToken = default)
     {
         using var conn = await OpenConnection(cancellationToken);
 
         await conn.UpdateAsync(entity, cancellationToken: cancellationToken);
 
-        await OnUpdateAsync(entity, cancellationToken);
-        
         return entity;
     }
 
     /// <inheritdoc/>
-    public async Task<TEntity> InsertOrUpdateAsync(TEntity entity, CancellationToken cancellationToken = default)
+    public virtual async Task<TEntity> InsertOrUpdateAsync(TEntity entity, CancellationToken cancellationToken = default)
     {
         if (IsNewEntity(entity))
         {
@@ -68,7 +64,7 @@ public async Task<TEntity> InsertOrUpdateAsync(TEntity entity, CancellationToken
     }
 
     /// <inheritdoc/>
-    public async Task<bool> DeleteAsync(TKey id, CancellationToken cancellationToken = default)
+    public virtual async Task<bool> DeleteAsync(TKey id, CancellationToken cancellationToken = default)
     {
         if (EqualityComparer<TKey>.Default.Equals(id, default!))
         {
@@ -87,22 +83,13 @@ public async Task<bool> DeleteAsync(TKey id, CancellationToken cancellationToken
         if (SoftDeleteProp is null)
         {
             var affected = await conn.DeleteAsync<TEntity>(id, cancellationToken: cancellationToken);
-            if (affected > 0)
-            {
-                await OnDeleteAsync(entity, false, cancellationToken);
-            }
             return affected > 0;
         }
 
         SoftDeleteProp.SetValue(entity, true);
 
         var rows = await conn.UpdateAsync(entity, cancellationToken: cancellationToken);
 
-        if (rows > 0)
-        {
-            await OnDeleteAsync(entity, true, cancellationToken);
-        }
-
         return rows > 0;
     }
 
@@ -139,29 +126,4 @@ protected bool IsNewEntity(TEntity entity)
     {
         return EqualityComparer<TKey>.Default.Equals(entity.Id, default!);
     }
-
-    /// <summary>
-    /// Custom logic to execute after an entity is inserted.
-    /// </summary>
-    protected virtual async Task OnInsertAsync(TEntity entity, CancellationToken cancellationToken = default)
-    {
-        await Task.CompletedTask;
-    }
-
-    /// <summary>
-    /// Custom logic to execute after an entity is updated.
-    /// </summary>
-    protected virtual async Task OnUpdateAsync(TEntity entity, CancellationToken cancellationToken = default)
-    {
-        await Task.CompletedTask;
-    }
-
-    /// <summary>
-    /// Custom logic to execute after an entity is deleted.
-    /// </summary>
-    protected virtual async Task OnDeleteAsync(TEntity entity, bool wasSoftDelete,
-        CancellationToken cancellationToken = default)
-    {
-        await Task.CompletedTask;
-    }
 }