[4.x] Cache prefix mode for separating tenant caches

[abrardev99]

closes #531

This PR adds support for cache prefix mode for separating tenant caches using a bootstrapper that can be enabled. The bootstrapper simply adds the prefix for cache keys.

Note: It does not work for the file driver.

Usage

enable bootstrapper in the tenancy.php config.

'bootstrappers' => [
        Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper::class,
        // Stancl\Tenancy\Bootstrappers\CacheTenancyBootstrapper::class,
        Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper::class,
        Stancl\Tenancy\Bootstrappers\QueueTenancyBootstrapper::class,
        Stancl\Tenancy\Bootstrappers\BatchTenancyBootstrapper::class,
        Stancl\Tenancy\Bootstrappers\PrefixCacheTenancyBootstrapper::class, // prefix cache keys
        // Stancl\Tenancy\Bootstrappers\RedisTenancyBootstrapper::class, // Note: phpredis is needed
    ],

That's it. Your cache keys are prefixed now.

The cache will behave like this.

cache()->put('key', 'original-value');

tenancy()->initialize($tenant1);
cache('key') // returns null;
cache()->put('key', 'value-for-tenant1');

tenancy()->initialize($tenant2);
cache('key') // returns null;
cache()->put('key', 'value-for-tenant2');

tenancy()->end();
cache('key') // returns 'original-value';

tenancy()->initialize($tenant1);
cache('key') // returns 'value-for-tenant1'

tenancy()->initialize($tenant2);
cache('key') // // returns 'value-for-tenant2'

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.96%. Comparing base (dfd3972) to head (07c1d77).
Report is 6 commits behind head on master.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@             Coverage Diff              @@
##             master    #1014      +/-   ##
============================================
+ Coverage     89.71%   89.96%   +0.25%     
- Complexity      575      591      +16     
============================================
  Files           138      139       +1     
  Lines          1769     1814      +45     
============================================
+ Hits           1587     1632      +45     
  Misses          182      182              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[stancl]

Everything seems to be completed here, so a summary of the changes:

• A new cache bootstrapper is added (prefix). This supports all cache drivers, not just Redis
• The original approach to cache tenancy is completely unchanged, however it is not recommended anymore and will likely be deprecated in the next major version (v5)
• The prefix bootstrapper supports all approaches to dependency injection
  • Injecting CacheManager and manually fetching the cache store/repository every time it needs to be used (this is identical to calling cache() / Cache::)
  • Injecting CacheManager and storing a specific store/repository in a property
    • Tenancy will update the prefix of these repositories even if they're persisted anywhere in memory
• The tags bootstrapper doesn't support any dependency injection properly:
  • The actual tenancy logic is in the CacheManager (__call()), not the repositories, so they cannot be injected. All calls must go through the CacheManager
  • The bootstrapper replaces the CacheManager in the container, so it cannot be injected
    • If a specific request happened entirely in the tenant context, without switching back to the central context, you could in theory inject the CacheManager. It will just not update when you revert back to the central context or switch to another tenant
    • For this reason, it's recommended to avoid using any cache-related dependency injection with the tags approach

[therecluse26]

@stancl does this change fix issues related to why Laravel officially undocumented cache tags (due to memory leaks, according to them)?

[stancl]

No, it just lets us support many more drivers more reliably.