< Summary

Information
Class: Elsa.Persistence.EFCore.EntityHandlers.SetTenantIdFilter
Assembly: Elsa.Persistence.EFCore.Common
File(s): /home/runner/work/elsa-core/elsa-core/src/modules/Elsa.Persistence.EFCore.Common/EntityHandlers/SetTenantIdFilter.cs
Line coverage
100%
Covered lines: 36
Uncovered lines: 0
Coverable lines: 36
Total lines: 80
Line coverage: 100%
Branch coverage
83%
Covered branches: 5
Total branches: 6
Branch coverage: 83.3%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%11100%
Handle(...)100%44100%
CreateTenantFilterExpression(...)100%11100%
.ctor(...)100%11100%
VisitParameter(...)50%22100%

File(s)

/home/runner/work/elsa-core/elsa-core/src/modules/Elsa.Persistence.EFCore.Common/EntityHandlers/SetTenantIdFilter.cs

#LineLine coverage
 1using System.Linq.Expressions;
 2using Elsa.Common.Entities;
 3using Elsa.Common.Multitenancy;
 4using Elsa.Tenants.Options;
 5using Microsoft.EntityFrameworkCore;
 6using Microsoft.EntityFrameworkCore.Metadata;
 7using Microsoft.Extensions.Options;
 8
 9namespace Elsa.Persistence.EFCore.EntityHandlers;
 10
 11/// <summary>
 12/// Represents a class that applies a filter to set the TenantId for entities.
 13/// </summary>
 14public class SetTenantIdFilter : IEntityModelCreatingHandler
 15{
 4816    public SetTenantIdFilter(IOptions<TenantsOptions> tenantsOptions) => ArgumentNullException.ThrowIfNull(tenantsOption
 17
 18    /// <inheritdoc />
 19    /// <remarks>
 20    /// The filter is always part of the model. Whether it is active is read from the current context so
 21    /// EF Core model caching cannot retain the tenant setting of the first context that built the model.
 22    /// </remarks>
 23    public void Handle(ElsaDbContextBase dbContext, ModelBuilder modelBuilder, IMutableEntityType entityType)
 24    {
 18625        if (!typeof(Entity).IsAssignableFrom(entityType.ClrType))
 9626            return;
 27
 9028        var tenantFilter = CreateTenantFilterExpression(dbContext, entityType.ClrType);
 9029        var existingFilter = entityType.GetQueryFilter();
 9030        if (existingFilter is not null)
 31        {
 7532            var parameter = tenantFilter.Parameters[0];
 7533            var existingBody = new ParameterReplacementVisitor(existingFilter.Parameters[0], parameter).Visit(existingFi
 7534            tenantFilter = Expression.Lambda(Expression.AndAlso(existingBody, tenantFilter.Body), parameter);
 35        }
 36
 9037        modelBuilder.Entity(entityType.ClrType).HasQueryFilter(tenantFilter);
 9038    }
 39
 40    private LambdaExpression CreateTenantFilterExpression(ElsaDbContextBase dbContext, Type clrType)
 41    {
 9042        var parameter = Expression.Parameter(clrType, "e");
 43
 44        // e => EF.Property<string>(e, "TenantId") == this.TenantId || EF.Property<string>(e, "TenantId") == "*" || (EF.
 9045        var tenantIdProperty = Expression.Call(
 9046            typeof(EF),
 9047            nameof(EF.Property),
 9048            [typeof(string)],
 9049            parameter,
 9050            Expression.Constant("TenantId"));
 51
 9052        var tenantIdOnContext = Expression.Property(
 9053            Expression.Constant(dbContext),
 9054            nameof(ElsaDbContextBase.TenantId));
 55
 9056        var tenantFilteringEnabled = Expression.Property(
 9057            Expression.Constant(dbContext),
 9058            nameof(ElsaDbContextBase.IsTenantFilteringEnabled));
 59
 9060        var equalityCheck = Expression.Equal(tenantIdProperty, tenantIdOnContext);
 9061        var agnosticCheck = Expression.Equal(tenantIdProperty, Expression.Constant(Tenant.AgnosticTenantId, typeof(strin
 62
 63        // For backwards compatibility: include records with null TenantId when context TenantId is empty string
 9064        var nullTenantCheck = Expression.Equal(tenantIdProperty, Expression.Constant(null, typeof(string)));
 9065        var emptyContextCheck = Expression.Equal(tenantIdOnContext, Expression.Constant(string.Empty, typeof(string)));
 9066        var backwardsCompatibilityCheck = Expression.AndAlso(nullTenantCheck, emptyContextCheck);
 67
 9068        var tenantVisibilityCheck = Expression.OrElse(
 9069            Expression.OrElse(equalityCheck, agnosticCheck),
 9070            backwardsCompatibilityCheck);
 9071        var body = Expression.OrElse(Expression.Not(tenantFilteringEnabled), tenantVisibilityCheck);
 72
 9073        return Expression.Lambda(body, parameter);
 74    }
 75
 7576    private sealed class ParameterReplacementVisitor(ParameterExpression source, ParameterExpression replacement) : Expr
 77    {
 67578        protected override Expression VisitParameter(ParameterExpression node) => node == source ? replacement : base.Vi
 79    }
 80}