From 8178c91842fbedceb714d98a3c8b850de89fa45a Mon Sep 17 00:00:00 2001 From: lukinovec Date: Thu, 20 Apr 2023 16:35:29 +0200 Subject: [PATCH] Revert "Use `$addTags` approach again" This reverts commit 8f5a4e4eb64fa2107a0bb65c94dbea0c7de6c473. --- assets/config.php | 1 - src/Bootstrappers/CacheTagsBootstrapper.php | 39 ++++++++++++++++++--- src/CacheManager.php | 26 ++++++-------- src/TenancyServiceProvider.php | 8 ----- tests/PrefixCacheBootstrapperTest.php | 27 -------------- 5 files changed, 45 insertions(+), 56 deletions(-) diff --git a/assets/config.php b/assets/config.php index 4d1241ba..3875aca1 100644 --- a/assets/config.php +++ b/assets/config.php @@ -192,7 +192,6 @@ return [ 'cache' => [ 'tag_base' => 'tenant', // This tag_base, followed by the tenant_id, will form a tag that will be applied on each cache call. 'prefix_base' => 'tenant_', // This prefix_base, followed by the tenant_id, will form a cache prefix that will be used for every cache key. - 'override_manager' => false, ], /** diff --git a/src/Bootstrappers/CacheTagsBootstrapper.php b/src/Bootstrappers/CacheTagsBootstrapper.php index eb46d938..2a2efa32 100644 --- a/src/Bootstrappers/CacheTagsBootstrapper.php +++ b/src/Bootstrappers/CacheTagsBootstrapper.php @@ -4,9 +4,11 @@ declare(strict_types=1); namespace Stancl\Tenancy\Bootstrappers; -use Stancl\Tenancy\CacheManager; -use Stancl\Tenancy\Contracts\Tenant; +use Illuminate\Cache\CacheManager; +use Illuminate\Contracts\Foundation\Application; +use Illuminate\Support\Facades\Cache; use Stancl\Tenancy\Contracts\TenancyBootstrapper; +use Stancl\Tenancy\Contracts\Tenant; /** * todo name. @@ -15,13 +17,42 @@ use Stancl\Tenancy\Contracts\TenancyBootstrapper; */ class CacheTagsBootstrapper implements TenancyBootstrapper { + protected ?CacheManager $originalCache = null; + public static string $cacheManagerWithTags = \Stancl\Tenancy\CacheManager::class; + + public function __construct( + protected Application $app + ) { + } + public function bootstrap(Tenant $tenant): void { - CacheManager::$addTags = true; + $this->resetFacadeCache(); + + $this->originalCache ??= $this->app['cache']; + $this->app->extend('cache', function () { + return new static::$cacheManagerWithTags($this->app); + }); } public function revert(): void { - CacheManager::$addTags = false; + $this->resetFacadeCache(); + + $this->app->extend('cache', function () { + return $this->originalCache; + }); + + $this->originalCache = null; + } + + /** + * This wouldn't be necessary, but is needed when a call to the + * facade has been made prior to bootstrapping tenancy. The + * facade has its own cache, separate from the container. + */ + public function resetFacadeCache(): void + { + Cache::clearResolvedInstances(); } } diff --git a/src/CacheManager.php b/src/CacheManager.php index d343ac52..292d9813 100644 --- a/src/CacheManager.php +++ b/src/CacheManager.php @@ -10,8 +10,6 @@ use Illuminate\Cache\CacheManager as BaseCacheManager; class CacheManager extends BaseCacheManager { - public static bool $addTags = false; - /** * Add tags and forward the call to the inner cache store. * @@ -20,25 +18,21 @@ class CacheManager extends BaseCacheManager */ public function __call($method, $parameters) { - if (tenancy()->initialized && static::$addTags) { - $tags = [config('tenancy.cache.tag_base') . tenant()?->getTenantKey()]; + $tags = [config('tenancy.cache.tag_base') . tenant()?->getTenantKey()]; - if ($method === 'tags') { - $count = count($parameters); + if ($method === 'tags') { + $count = count($parameters); - if ($count !== 1) { - throw new \Exception("Method tags() takes exactly 1 argument. $count passed."); - } - - $names = $parameters[0]; - $names = (array) $names; // cache()->tags('foo') https://laravel.com/docs/9.x/cache#removing-tagged-cache-items - - return $this->store()->tags(array_merge($tags, $names)); + if ($count !== 1) { + throw new \Exception("Method tags() takes exactly 1 argument. $count passed."); } - return $this->store()->tags($tags)->$method(...$parameters); + $names = $parameters[0]; + $names = (array) $names; // cache()->tags('foo') https://laravel.com/docs/9.x/cache#removing-tagged-cache-items + + return $this->store()->tags(array_merge($tags, $names)); } - return parent::__call($method, $parameters); + return $this->store()->tags($tags)->$method(...$parameters); } } diff --git a/src/TenancyServiceProvider.php b/src/TenancyServiceProvider.php index 4e5adaba..bde37055 100644 --- a/src/TenancyServiceProvider.php +++ b/src/TenancyServiceProvider.php @@ -8,7 +8,6 @@ use Illuminate\Cache\CacheManager; use Illuminate\Database\Console\Migrations\FreshCommand; use Illuminate\Support\ServiceProvider; use Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper; -use Stancl\Tenancy\CacheManager as TenancyCacheManager; use Stancl\Tenancy\Contracts\Domain; use Stancl\Tenancy\Contracts\Tenant; use Stancl\Tenancy\Resolvers\DomainTenantResolver; @@ -134,12 +133,5 @@ class TenancyServiceProvider extends ServiceProvider return $instance; }); - - if (! $this->app['config']['tenancy.cache.override_manager']) { - // todo https://discord.com/channels/976506366502006874/976513756576243733/1097778320692740096 - $this->app->singleton('cache', function ($app) { - return new TenancyCacheManager($app); - }); - } } } diff --git a/tests/PrefixCacheBootstrapperTest.php b/tests/PrefixCacheBootstrapperTest.php index 7f0eac97..89a1cc68 100644 --- a/tests/PrefixCacheBootstrapperTest.php +++ b/tests/PrefixCacheBootstrapperTest.php @@ -11,7 +11,6 @@ use Stancl\Tenancy\Listeners\BootstrapTenancy; use Stancl\Tenancy\Listeners\RevertToCentralContext; use Stancl\Tenancy\Tests\Etc\SpecificCacheStoreService; use Stancl\Tenancy\Bootstrappers\PrefixCacheTenancyBootstrapper; -use Stancl\Tenancy\CacheManager as TenancyCacheManager; beforeEach(function () { config([ @@ -22,7 +21,6 @@ beforeEach(function () { 'cache.stores.' . $secondCacheDriver = 'redis2' => config('cache.stores.redis'), ]); - TenancyCacheManager::$addTags = false; PrefixCacheTenancyBootstrapper::$tenantCacheStores = [$cacheDriver, $secondCacheDriver]; PrefixCacheTenancyBootstrapper::$prefixGenerator = null; @@ -31,35 +29,10 @@ beforeEach(function () { }); afterEach(function () { - TenancyCacheManager::$addTags = false; PrefixCacheTenancyBootstrapper::$tenantCacheStores = []; PrefixCacheTenancyBootstrapper::$prefixGenerator = null; }); -test('Tenancy overrides CacheManager', function () { - // todo Change this to 'Tenancy overrides CacheManager only if configured to do so' after changing TenancyServiceProvider structure - // Since we override the manager in TSP by default, we can't test if the overriding is disabled by changing the override_manager config key - $tenancyCacheManager = TenancyCacheManager::class; - - expect(app('cache')::class)->toBe($tenancyCacheManager); - expect(app(CacheManager::class)::class)->toBe($tenancyCacheManager); - - tenancy()->initialize(Tenant::create(['id' => 'first'])); - - expect(app('cache')::class)->toBe($tenancyCacheManager); - expect(app(CacheManager::class)::class)->toBe($tenancyCacheManager); - - tenancy()->initialize(Tenant::create(['id' => 'second'])); - - expect(app('cache')::class)->toBe($tenancyCacheManager); - expect(app(CacheManager::class)::class)->toBe($tenancyCacheManager); - - tenancy()->end(); - - expect(app('cache')::class)->toBe($tenancyCacheManager); - expect(app(CacheManager::class)::class)->toBe($tenancyCacheManager); -}); - test('correct cache prefix is used in all contexts', function () { $originalPrefix = config('cache.prefix'); $prefixBase = config('tenancy.cache.prefix_base');