Add support for "soft delete" entities

[raix]

Contact Details

No response

Detailed description?

Is your feature request related to a problem? Please describe.
Part of supporting entities requiring a strong audit trail is protecting against deletion
(Feel free to close if out of scope for PlatformPlatform ❤️)

Describe the solution you'd like
We are currently using an interface to mark entities ISoftDeletedEntity and letting RepositoryBase check if Remove should do a hard or soft delete.

Describe alternatives you've considered
This solution was suggested by a "friend" but there might be better alternatives?

Additional context

SharedKernel/Domain/ISoftDeletedEntity.cs

public interface ISoftDeletedEntity
{
    /// <summary>
    ///    Gets or sets a value indicating whether the entity is deleted.
    /// </summary>
    bool IsDeleted { get; set; }

    /// <summary>
    ///    Gets or sets the date and time when the entity was deleted.
    /// </summary>
    DateTimeOffset? DeletedAt { get; set; }
}

SharedKernel/Persistence/RepositoryBase.cs

    public void Remove(T aggregate)
    {
        ArgumentNullException.ThrowIfNull(aggregate);

        if (aggregate is ISoftDeletedEntity softDeletedEntity)
        {
            softDeletedEntity.IsDeleted = true;
            softDeletedEntity.DeletedAt = DateTimeOffset.UtcNow;
            Update(aggregate);
        }
        else
        {
            DbSet.Remove(aggregate);
        }
    }

Usage:

public sealed class Foo(TenantId tenantId) : AggregateRoot<FooId>(FooId.NewId()), ITenantScopedEntity, ISoftDeletedEntity
   ...

Feature Type

.NET

Code of Conduct

• I agree to follow this project's Code of Conduct

[tjementum]

Yes, this is a great idea and something that is definitely in scope for PlatformPlatform. I would love to do this using Entity Framework query filters so deleted entities are not included by default when querying. I already use this for tenant isolation, which might cause some challenges, as one cannot disable only some query filters afaik. So, if we want to query deleted entities, then one has to manually add the general tenant filter, which is not ideal.

I already have this idea as a “Someday maybe” Roadmap item. I’m trying to get my list of issues down to what I consider to be in version 1.0, so I converted this to a discussion. It’s not a big thing, so maybe I will suddenly just make it.