Disable QueryFilter for Root Tenant Globally

[eluvitie]

Hi there

In my web API I have a root tenant, which should be able to access all the data that the tenants have.

Here is some Information about the Project:

• .NET 8 Web API
• Postgresql
• EF Core
• Ardialis Specifications
• Clean Architecture
• Tenants Share the same Database
• Finbuckle Multitenancy

Currently I set on each query the IgnoreGlobalQuery() and then set manaully the Filter for the SoftDelete Flag. This approach works if i only load one Entity, the problem is when i try to load child elements, because i'd have to set the SoftDelete Filter for each related Entity or else it displays all the deleted child elements.

So here is my question, is there a way to disable the global filter queries for the tenantId just for one Tenant (in my case the root Tenant)?

In my Optinion a nice way would be to set the filter (or disable) it when the DbContext for the Tenant gets initialized.

Here is my BaseDbContext:

public abstract class BaseDbContext : MultiTenantIdentityDbContext<ApplicationUser, ApplicationRole, string, IdentityUserClaim<string>, IdentityUserRole<string>, IdentityUserLogin<string>, ApplicationRoleClaim, IdentityUserToken<string>>
{
    protected readonly ICurrentUser _currentUser;
    private readonly ISerializerService _serializer;
    private readonly DatabaseSettings _dbSettings;
    private readonly IEventPublisher _events;

    protected BaseDbContext(ITenantInfo currentTenant, DbContextOptions options, ICurrentUser currentUser, ISerializerService serializer, IOptions<DatabaseSettings> dbSettings, IEventPublisher events)
        : base(currentTenant, options)
    {
        _currentUser = currentUser;
        _serializer = serializer;
        _dbSettings = dbSettings.Value;
        _events = events;
    }

   // this gets called once per startup
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        // SoftDelete FilterQuery gets set for each Entitiy
        modelBuilder.AppendGlobalQueryFilter<ISoftDelete>(s => s.DeletedOn == null);

        base.OnModelCreating(modelBuilder);

        modelBuilder.ApplyConfigurationsFromAssembly(GetType().Assembly);
    }

    // this gets called for each Tenant
    // here would be a good place to disable to filter queries if the tenant is the root tenant.
    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
      
       ......

    }

....

}

Thank for your help!

spent already a lot of time trying to figure out what the cleanest way is to achiev this.

[eluvitie]

@AndrewTriesToCode Do you have an input what I could try or test to get this working?

[AndrewTriesToCode]

hi @eluvitie sorry for the slow reply

You are hitting up against a design constraint within EFCore and the Finbuckle approach using global query filters. Here is something you can try that I've seen work well. Have a base DbContext class with your entities that your root tenant or admins use and derive your MultiTenant DbContext from it. Then the filters are only on instances of the subclass. This means your subclass can't inherit from MultiTenantDbContext but instead must implement IMultiTenantDbContext. [This section of the docs should help.] Then also you'll need to use the [fluent syntax] to designate which entities are multitenant in the derived class.

Let me know what you think!

[eluvitie]

hi @AndrewTriesToCode Thanks for your reply and sorry for my long response.

I've been struggling to make this work. so i've updated my whole Project to use the newest versions of the Nuget Packages.

So what i've tried to do is to add a ApplicationBaseDbContext which extends the BaseDbContext, this Context does not have any Multitenancy but holds all the DbSet definitions. Then i added a ApplicationDbContext which implements the Mutlitenancy and also extends the ApplicationBaseDbContext.

here is the Code:

public class ApplicationBaseDbContext : BaseDbContext
{
    public ApplicationBaseDbContext(DbContextOptions<ApplicationBaseDbContext> options, ICurrentUser currentUser, ISerializerService serializer, IOptions<DatabaseSettings> dbSettings, IEventPublisher events)
        : base(options, currentUser, serializer, dbSettings, events)
    {
    }

    public DbSet<DeviceLocation> DeviceLocations => Set<DeviceLocation>();
    // Other DbSets

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);

        // other modelBuilder Settings

    }
}

public class ApplicationDbContext : ApplicationBaseDbContext, IMultiTenantDbContext
{
    public ApplicationDbContext(DbContextOptions<ApplicationBaseDbContext> options, ICurrentUser currentUser, ISerializerService serializer, IOptions<DatabaseSettings> dbSettings, IEventPublisher events, IMultiTenantContextAccessor tenantAccessor)
        : base(options, currentUser, serializer, dbSettings, events)
    {
           // EDIT: This was the missing piece!
           TenantInfo = tenantAccessor.MultiTenantContext.TenantInfo
               ?? throw new InvalidOperationException("ApplicationDbContext: no ITenantInfo available");
    }

    public ITenantInfo? TenantInfo { get; }

    public TenantMismatchMode TenantMismatchMode { get; set; } = TenantMismatchMode.Throw;

    public TenantNotSetMode TenantNotSetMode { get; set; } = TenantNotSetMode.Throw;

    protected override void OnModelCreating(ModelBuilder builder)
    {

        // If necessary call the base class method.
        // Recommended to be called first.
        base.OnModelCreating(builder);

        // Configure all entity types marked with the [MultiTenant] data attribute
        builder.ConfigureMultiTenant();

       // Configure an entity type to be multi-tenant.
       builder.Entity<DeviceLocation>().IsMultiTenant();

    }
}

After this Implementation my MediatR Handler throws an Error when trying to List All Entries (for testing) via the Respository (i'm using the Ardialis Spec Package).

public async Task<List<DeviceLocationDto>> Handle(GetDeviceLocationRequest request, CancellationToken cancellationToken)
{
    _currentTenant = await _tenantService.GetCurrentTenant();

    if (_currentTenant == null)
    {
        // Test if Tenant is still set after Update
        throw new InvalidOperationException("TenantInfo is null. Ensure that the tenant is set before querying the database.");
    }

    var items = await _repository.ListAsync(cancellationToken);
    return items.Adapt<List<DeviceLocationDto>>();

}

The Error is being thrown in the Microsoft.EntityFrameworkCore.Query.Internal.ExecuteCore function (https://github.com/dotnet/efcore/blob/3b5648db341fd230b2e83ff0e24fc579b6ee46a9/src/EFCore/Query/Internal/QueryCompiler.cs#L87) when calling compiledQuery(queryContext). The Error is a "Object reference not set to an isntance of an object" error.

Am I Missing something during the manual setup for Multitenancy with the IMultiTenantDbContext?

i've followed this part in the documentation: https://www.finbuckle.com/MultiTenant/Docs/v9.0.0/EFCore#adding-multitenant-functionality-to-an-existing-dbcontext

I have not added the SaveChanges override yet, since i only need a read operation.

I feel like i'm just missing a tiny but important detail....

Thanks again for your valuable time!

[eluvitie]

After clearing my head it klicked....

I've missed to set the ITenantInfo manually...
I adjusted my previous comment, in case someone has the same troubles in the future.

If you want to add these code snippets to your documentation feel free to use it.

and if you have improvedments to my answer i'm very open for improvements!