Files
mixtape/zero.Core/Collections/CollectionInterceptor.cs
T

150 lines
4.8 KiB
C#
Raw Normal View History

2020-11-18 15:55:18 +01:00
using FluentValidation;
using Raven.Client.Documents.Session;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using zero.Core.Database;
using zero.Core.Entities;
2020-11-19 00:14:52 +01:00
namespace zero.Core.Collections
2020-11-18 15:55:18 +01:00
{
2020-11-19 00:14:52 +01:00
public abstract class CollectionInterceptor : ICollectionInterceptor
2020-11-18 15:55:18 +01:00
{
/// <inheritdoc />
public virtual HashSet<Type> Types { get; } = new();
/// <inheritdoc />
2021-05-04 17:23:52 +02:00
public virtual Task<EntityResult<T>> Creating<T>(CreateParameters<T> args) where T : ZeroEntity => Task.FromResult<EntityResult<T>>(default);
2020-11-18 15:55:18 +01:00
/// <inheritdoc />
2021-05-04 17:23:52 +02:00
public virtual Task<EntityResult<T>> Updating<T>(UpdateParameters<T> args) where T : ZeroEntity => Task.FromResult<EntityResult<T>>(default);
2020-11-18 15:55:18 +01:00
/// <inheritdoc />
2021-05-04 17:23:52 +02:00
public virtual Task<EntityResult<T>> Deleting<T>(DeleteParameters<T> args) where T : ZeroEntity => Task.FromResult<EntityResult<T>>(default);
2020-11-18 15:55:18 +01:00
/// <inheritdoc />
2021-05-04 17:23:52 +02:00
public virtual Task<EntityResult<T>> Purging<T>(PurgeParameters<T> args) where T : ZeroEntity => Task.FromResult<EntityResult<T>>(default);
2020-11-18 15:55:18 +01:00
/// <inheritdoc />
2021-05-04 17:23:52 +02:00
public virtual Task Created<T>(CreateParameters<T> args) where T : ZeroEntity => Task.CompletedTask;
2020-11-18 15:55:18 +01:00
/// <inheritdoc />
2021-05-04 17:23:52 +02:00
public virtual Task Updated<T>(UpdateParameters<T> args) where T : ZeroEntity => Task.CompletedTask;
2020-11-18 15:55:18 +01:00
/// <inheritdoc />
2021-05-04 17:23:52 +02:00
public virtual Task Deleted<T>(DeleteParameters<T> args) where T : ZeroEntity => Task.CompletedTask;
2020-11-18 15:55:18 +01:00
/// <inheritdoc />
2021-05-04 17:23:52 +02:00
public virtual Task Purged<T>(PurgeParameters<T> args) where T : ZeroEntity => Task.CompletedTask;
2020-11-18 15:55:18 +01:00
2021-05-04 17:23:52 +02:00
public class Parameters<T> where T : ZeroEntity
2020-11-18 15:55:18 +01:00
{
/// <summary>
/// The current zero context
/// </summary>
public IZeroContext Context { get; set; }
/// <summary>
/// Raven document store
/// </summary>
public IZeroStore Store { get; set; }
/// <summary>
/// Currently loaded document session
/// </summary>
public IAsyncDocumentSession Session { get; set; }
/// <summary>
/// Validator for the affected entity
/// </summary>
public IValidator<T> Validator { get; set; }
}
2021-05-04 17:23:52 +02:00
public class CreateParameters<T> : Parameters<T> where T : ZeroEntity
2020-11-18 15:55:18 +01:00
{
/// <summary>
/// The model which is created
/// </summary>
public T Model { get; set; }
}
2021-05-04 17:23:52 +02:00
public class UpdateParameters<T> : Parameters<T> where T : ZeroEntity
2020-11-18 15:55:18 +01:00
{
/// <summary>
/// The Id of the model which is updated
/// </summary>
public string Id { get; set; }
/// <summary>
/// The module which is updated
/// </summary>
public T Model { get; set; }
}
2021-05-04 17:23:52 +02:00
public class DeleteParameters<T> : Parameters<T> where T : ZeroEntity
2020-11-18 15:55:18 +01:00
{
/// <summary>
/// The id of the model which is deleted
/// </summary>
public string Id { get; set; }
/// <summary>
/// The model which is deleted
/// </summary>
public T Model { get; set; }
}
2021-05-04 17:23:52 +02:00
public class PurgeParameters<T> : Parameters<T> where T : ZeroEntity { }
2020-11-18 15:55:18 +01:00
}
2020-11-19 00:14:52 +01:00
public interface ICollectionInterceptor
2020-11-18 15:55:18 +01:00
{
/// <summary>
/// Affacted document types
/// </summary>
HashSet<Type> Types { get; }
/// <summary>
/// Called after an entity has been stored but before the session has saved its changes
/// </summary>
2021-05-04 17:23:52 +02:00
Task Created<T>(CollectionInterceptor.CreateParameters<T> args) where T : ZeroEntity;
2020-11-18 15:55:18 +01:00
/// <summary>
/// Called before an entity is stored and validated
/// </summary>
2021-05-04 17:23:52 +02:00
Task<EntityResult<T>> Creating<T>(CollectionInterceptor.CreateParameters<T> args) where T : ZeroEntity;
2020-11-18 15:55:18 +01:00
/// <summary>
/// Called after an entity has been deleted but before the session has saved its changes
/// </summary>
2021-05-04 17:23:52 +02:00
Task Deleted<T>(CollectionInterceptor.DeleteParameters<T> args) where T : ZeroEntity;
2020-11-18 15:55:18 +01:00
/// <summary>
/// Called before an entity is deleted
/// </summary>
2021-05-04 17:23:52 +02:00
Task<EntityResult<T>> Deleting<T>(CollectionInterceptor.DeleteParameters<T> args) where T : ZeroEntity;
2020-11-18 15:55:18 +01:00
/// <summary>
/// Called after the document collection has been purged
/// </summary>
2021-05-04 17:23:52 +02:00
Task Purged<T>(CollectionInterceptor.PurgeParameters<T> args) where T : ZeroEntity;
2020-11-18 15:55:18 +01:00
/// <summary>
/// Called before a collection is purged
/// </summary>
2021-05-04 17:23:52 +02:00
Task<EntityResult<T>> Purging<T>(CollectionInterceptor.PurgeParameters<T> args) where T : ZeroEntity;
2020-11-18 15:55:18 +01:00
/// <summary>
/// Called after an entity has been updated but before the session has saved its changes
/// </summary>
2021-05-04 17:23:52 +02:00
Task Updated<T>(CollectionInterceptor.UpdateParameters<T> args) where T : ZeroEntity;
2020-11-18 15:55:18 +01:00
/// <summary>
/// Called before an entity is stored and validated
/// </summary>
2021-05-04 17:23:52 +02:00
Task<EntityResult<T>> Updating<T>(CollectionInterceptor.UpdateParameters<T> args) where T : ZeroEntity;
2020-11-18 15:55:18 +01:00
}
}