[ PrefixCacheTenancyBootstrapper::class ], 'cache.default' => $cacheDriver = 'redis', ]); PrefixCacheTenancyBootstrapper::$tenantCacheStores = [$cacheDriver]; PrefixCacheTenancyBootstrapper::$prefixGenerators = []; TenancyCacheManager::$addTags = false; Event::listen(TenancyInitialized::class, BootstrapTenancy::class); Event::listen(TenancyEnded::class, RevertToCentralContext::class); }); afterEach(function () { PrefixCacheTenancyBootstrapper::$tenantCacheStores = []; }); test('Tenancy overrides CacheManager', function() { expect(app('cache')::class)->toBe(TenancyCacheManager::class); expect(app(CacheManager::class)::class)->toBe(TenancyCacheManager::class); tenancy()->initialize(Tenant::create(['id' => 'first'])); expect(app('cache')::class)->toBe(TenancyCacheManager::class); expect(app(CacheManager::class)::class)->toBe(TenancyCacheManager::class); tenancy()->initialize(Tenant::create(['id' => 'second'])); expect(app('cache')::class)->toBe(TenancyCacheManager::class); expect(app(CacheManager::class)::class)->toBe(TenancyCacheManager::class); tenancy()->end(); expect(app('cache')::class)->toBe(TenancyCacheManager::class); expect(app(CacheManager::class)::class)->toBe(TenancyCacheManager::class); }); test('correct cache prefix is used in all contexts', function () { $originalPrefix = config('cache.prefix'); $prefixBase = config('tenancy.cache.prefix_base'); $expectPrefixToBe = function(string $prefix) { expect($prefix . ':') // RedisStore suffixes prefix with ':' ->toBe(app('cache')->getPrefix()) ->toBe(app('cache.store')->getPrefix()); }; $expectPrefixToBe($originalPrefix); $tenant1 = Tenant::create(); $tenant2 = Tenant::create(); $tenantOnePrefix = $originalPrefix . $prefixBase . $tenant1->getTenantKey(); tenancy()->initialize($tenant1); cache()->set('key', 'tenantone-value'); $expectPrefixToBe($tenantOnePrefix); $tenantTwoPrefix = $originalPrefix . $prefixBase . $tenant2->getTenantKey(); tenancy()->initialize($tenant2); cache()->set('key', 'tenanttwo-value'); $expectPrefixToBe($tenantTwoPrefix); // Prefix gets reverted to default after ending tenancy tenancy()->end(); $expectPrefixToBe($originalPrefix); // Assert tenant's data is accessible using the prefix from the central context config(['cache.prefix' => null]); // stop prefixing cache keys in central so we can provide prefix manually app('cache')->forgetDriver(config('cache.default')); expect(cache($tenantOnePrefix . ':key'))->toBe('tenantone-value'); expect(cache($tenantTwoPrefix . ':key'))->toBe('tenanttwo-value'); }); test('cache is persisted when reidentification is used', function () { $tenant1 = Tenant::create(); $tenant2 = Tenant::create(); tenancy()->initialize($tenant1); cache(['foo' => 'bar'], 10); expect(cache('foo'))->toBe('bar'); tenancy()->initialize($tenant2); tenancy()->end(); tenancy()->initialize($tenant1); expect(cache('foo'))->toBe('bar'); }); test('prefixing separates the cache', function () { $tenant1 = Tenant::create(); tenancy()->initialize($tenant1); cache()->put('foo', 'bar', 1); expect(cache()->get('foo'))->toBe('bar'); $tenant2 = Tenant::create(); tenancy()->initialize($tenant2); pest()->assertNotSame('bar', cache()->get('foo')); cache()->put('foo', 'xyz', 1); expect(cache()->get('foo'))->toBe('xyz'); }); test('central cache is persisted', function () { cache()->put('key', 'central'); $tenant1 = Tenant::create(); tenancy()->initialize($tenant1); cache()->put('key', 'tenant'); expect(cache()->get('key'))->toBe('tenant'); tenancy()->end(); cache()->put('key2', 'central-two'); expect(cache()->get('key'))->toBe('central'); expect(cache()->get('key2'))->toBe('central-two'); }); test('cache base prefix is customizable', function () { $originalPrefix = config('cache.prefix'); $prefixBase = 'custom_'; config([ 'tenancy.cache.prefix_base' => $prefixBase ]); $tenant1 = Tenant::create(); tenancy()->initialize($tenant1); expect($originalPrefix . $prefixBase . $tenant1->getTenantKey() . ':') ->toBe(app('cache')->getPrefix()) ->toBe(app('cache.store')->getPrefix()); }); test('cache is prefixed correctly when using a repository injected in a singleton', function () { $this->app->singleton(CacheService::class); app()->make(CacheService::class)->handle(); expect(cache('key'))->toBe('central-value'); $tenant1 = Tenant::create(); $tenant2 = Tenant::create(); tenancy()->initialize($tenant1); expect(cache('key'))->toBeNull(); app()->make(CacheService::class)->handle(); expect(cache('key'))->toBe($tenant1->getTenantKey()); tenancy()->initialize($tenant2); expect(cache('key'))->toBeNull(); app()->make(CacheService::class)->handle(); expect(cache('key'))->toBe($tenant2->getTenantKey()); tenancy()->end(); expect(cache('key'))->toBe('central-value'); }); test('specific central cache store can be used inside a service', function () { config(['cache.default' => 'redis']); config(['cache.stores.redis2' => config('cache.stores.redis')]); $cacheStore = 'redis2'; // Name of the non-default, central cache store that we'll use using cache()->store($cacheStore) // Service uses the 'redis2' store which is central/not prefixed (not present in PrefixCacheTenancyBootstrapper::$tenantCacheStores) $this->app->singleton(SpecificCacheStoreService::class, function() use ($cacheStore) { return new SpecificCacheStoreService($this->app->make(CacheManager::class), $cacheStore); }); app()->make(SpecificCacheStoreService::class)->handle(); expect(cache()->store($cacheStore)->get('key'))->toBe('central-value'); $tenant1 = Tenant::create(); $tenant2 = Tenant::create(); tenancy()->initialize($tenant1); // The store isn't prefixed, so the cache isn't separated expect(cache()->store($cacheStore)->get('key'))->toBe('central-value'); app()->make(SpecificCacheStoreService::class)->handle(); expect(cache()->store($cacheStore)->get('key'))->toBe($tenant1->getTenantKey()); tenancy()->initialize($tenant2); expect(cache()->store($cacheStore)->get('key'))->toBe($tenant1->getTenantKey()); app()->make(SpecificCacheStoreService::class)->handle(); expect(cache()->store($cacheStore)->get('key'))->toBe($tenant2->getTenantKey()); tenancy()->end(); expect(cache()->store($cacheStore)->get('key'))->toBe($tenant2->getTenantKey()); }); test('stores specified in tenantCacheStores get prefixed', function() { // Make the currently used store ('redis') the only store in $tenantCacheStores PrefixCacheTenancyBootstrapper::$tenantCacheStores = ['redis']; $this->app->singleton(CacheService::class); app()->make(CacheService::class)->handle(); expect(cache('key'))->toBe($centralValue = 'central-value'); $tenant1 = Tenant::create(); $tenant2 = Tenant::create(); tenancy()->initialize($tenant1); expect(cache('key'))->toBeNull(); app()->make(CacheService::class)->handle(); expect(cache('key'))->toBe($tenant1->getTenantKey()); tenancy()->initialize($tenant2); expect(cache('key'))->toBeNull(); app()->make(CacheService::class)->handle(); expect(cache('key'))->toBe($tenant2->getTenantKey()); tenancy()->end(); expect(cache('key'))->toBe($centralValue); }); test('stores not specified in tenantCacheStores do not get prefixed', function() { config(['cache.stores.redis2' => config('cache.stores.redis')]); config(['cache.default' => 'redis2']); // Make 'redis' the only store in $tenantCacheStores so that the current store ('redis2') doesn't get prefixed PrefixCacheTenancyBootstrapper::$tenantCacheStores = ['redis']; $this->app->singleton(CacheService::class); app()->make(CacheService::class)->handle(); expect(cache('key'))->toBe('central-value'); $tenant1 = Tenant::create(); $tenant2 = Tenant::create(); tenancy()->initialize($tenant1); // The cache isn't prefixed, so it isn't separated expect(cache('key'))->toBe('central-value'); app()->make(CacheService::class)->handle(); expect(cache('key'))->toBe($tenant1->getTenantKey()); tenancy()->initialize($tenant2); expect(cache('key'))->toBe($tenant1->getTenantKey()); app()->make(CacheService::class)->handle(); expect(cache('key'))->toBe($tenant2->getTenantKey()); tenancy()->end(); expect(cache('key'))->toBe($tenant2->getTenantKey()); }); test('non default stores get prefixed too', function () { config(['cache.stores.redis2' => config('cache.stores.redis')]); // Make 'redis2' the default cache driver config(['cache.default' => 'redis2']); PrefixCacheTenancyBootstrapper::$tenantCacheStores = ['redis', 'redis2']; // The prefix is the same for both drivers in the central context $originalConfigPrefix = config('cache.prefix'); $defaultPrefix = cache()->store()->getPrefix(); expect(cache()->store('redis')->getPrefix())->toBe($defaultPrefix); tenancy()->initialize($tenant = Tenant::create()); // We didn't add a prefix generator for our 'redis' driver, so we expect the prefix to be generated using the 'default' generator expect(cache()->store()->getPrefix())->toBe($prefix = PrefixCacheTenancyBootstrapper::defaultPrefixGenerator($originalConfigPrefix)($tenant) . ':'); // Non-default store expect(cache()->store('redis')->getPrefix())->toBe($prefix); tenancy()->end(); }); test('cache store prefix generation can be customized', function() { config(['cache.default' => 'redis']); PrefixCacheTenancyBootstrapper::$tenantCacheStores = ['redis']; expect(PrefixCacheTenancyBootstrapper::$prefixGenerators)->not()->toHaveKey('redis'); // Add custom prefix generator for the 'redis' store PrefixCacheTenancyBootstrapper::generatePrefixUsing('redis', $generateTenantPrefix = function (Tenant $tenant) { return 'redis_tenant_cache_' . $tenant->getTenantKey(); }); expect(PrefixCacheTenancyBootstrapper::$prefixGenerators)->toHaveKey('redis'); tenancy()->initialize($tenant = Tenant::create()); // Expect the 'redis' store to use the prefix generated by the custom generator expect(cache()->store('redis')->getPrefix())->toBe($generateTenantPrefix($tenant) . ':'); tenancy()->end(); }); test('stores get prefixed by the default prefix generator if the store does not have a corresponding generator', function() { config(['cache.stores.redis2' => config('cache.stores.redis')]); // Make 'redis2' the default cache driver config(['cache.default' => 'redis2']); PrefixCacheTenancyBootstrapper::$tenantCacheStores = ['redis', 'redis2']; // Don't add a generator for 'redis2' // Let the default generator generate the prefix // The default generator is created for you in bootstrap() tenancy()->initialize($tenant = Tenant::create()); $defaultGenerator = PrefixCacheTenancyBootstrapper::$prefixGenerators['default']; expect(cache()->store()->getPrefix())->toBe($defaultGenerator($tenant) . ':'); // Other stores without a prefix generator use the default generator too expect(cache()->store('redis')->getPrefix())->toBe($defaultGenerator($tenant) . ':'); tenancy()->end(); // You can override the default prefix generator PrefixCacheTenancyBootstrapper::generatePrefixUsing('default', $newDefaultGenerator = function (Tenant $tenant) { return 'new_' . $tenant->getTenantKey(); }); tenancy()->initialize($tenant = Tenant::create()); // The store gets prefixed using the new default generator expect(cache()->store()->getPrefix())->toBe($newDefaultGenerator($tenant) . ':'); expect(cache()->store('redis')->getPrefix())->toBe($newDefaultGenerator($tenant) . ':'); tenancy()->end(); });