Can I use Entity Cache for Custom Property in Tenant Entity

[shinojk]

ABP Framework version: 10.1
UI type: MVC
Database: EF Core

Problem:

I have extended the Tenant entity by adding a new property named TenantStatus.

If the TenantStatus is set to "Suspended", I want to prevent tenant resolution and block further request processing.

To achieve this, I have implemented a custom middleware that checks the tenant status and blocks execution when the tenant is suspended.

Currently, this requires querying the database on each request, which I want to avoid.

Instead of querying the database, I would like to retrieve the TenantStatus from cache within the middleware.

Can I use the Entity Cache feature described in the below documentation for this purpose?
https://abp.io/docs/latest/framework/infrastructure/entity-cache

Is it appropriate to use entity cache for tenant data in middleware, or is there a better/recommended approach in ABP for this scenario?

Expected guidance:

Whether IEntityCache is suitable for this use case?
Any recommended patterns for caching tenant-related state in ABP middleware?
Best practices for keeping cache in sync when tenant status changes?

[maliming]

Whether IEntityCache is suitable for this use case?

Yes. IEntityCache handles automatic cache invalidation (via EntityChangedEventData<Tenant>) and auto-loading from the repository on cache miss, which fits your scenario well.

Any recommended patterns for caching tenant-related state in ABP middleware?

Define a TenantStatusCacheItem, register it with AddEntityCache<Tenant, TenantStatusCacheItem, Guid>(), and inject IEntityCache<TenantStatusCacheItem, Guid> in your middleware
to check the status.

Also consider the built-in IsActive property on TenantConfiguration — if "Suspended" is essentially "inactive", setting IsActive = false lets ABP handle it automatically
without custom middleware.

Best practices for keeping cache in sync when tenant status changes?

IEntityCache handles this automatically. It listens to EntityChangedEventData<Tenant> and invalidates the cache when the tenant is created, updated, or deleted. No manual cache
invalidation needed.

[shinojk]

Thank you for the quick response.

I think IsActive will not work for my case. Because I need to handle some other status too.

If I use IEntityCache for my new field 'TenantStatus', will it cause any issue for the existing cache for the Tenant entity IDistributedCache TenantConfigurationCacheItem?

[maliming]

No, it won't cause any issue. IEntityCache<TenantStatusCacheItem, Guid> and IDistributedCache<TenantConfigurationCacheItem> use different cache key namespaces, so they are completely independent.

Both will listen to EntityChangedEventData<Tenant> for cache invalidation, but they each invalidate their own cache entries independently — no conflict.

[shinojk]

That make sense. Thank you again, for the confirmation.