send(function (TenantCreated $event) { return $event->tenant; })->toListener() ); Event::listen(TenancyInitialized::class, BootstrapTenancy::class); Event::listen(TenancyEnded::class, RevertToCentralContext::class); config([ 'cache.stores.database.connection' => 'central', // Explicitly set cache DB connection name in config 'cache.stores.database.lock_connection' => 'central', // Also set lock connection name 'cache.default' => 'database', 'tenancy.bootstrappers' => [ DatabaseTenancyBootstrapper::class, DatabaseCacheBootstrapper::class, // Used instead of CacheTenancyBootstrapper ], ]); }); test('DatabaseCacheBootstrapper switches the database cache store connections correctly', function () { // Original connections (store and lock) are 'central' in the config expect(config('cache.stores.database.connection'))->toBe('central'); expect(config('cache.stores.database.lock_connection'))->toBe('central'); // The actual connection used by the cache store is 'central' expect(Cache::store()->getConnection()->getName())->toBe('central'); // Cache locks also use the 'central' connection expect(Cache::lock('foo')->getConnectionName())->toBe('central'); tenancy()->initialize(Tenant::create()); // Initializing tenancy should make both connections 'tenant' expect(config('cache.stores.database.connection'))->toBe('tenant'); expect(config('cache.stores.database.lock_connection'))->toBe('tenant'); // The actual connection used by the cache store and locks is now 'tenant' // Purging the database cache store forces the CacheManager to resolve a new instance of // the database store, using the connection names specified in the config ('tenant') expect(Cache::store()->getConnection()->getName())->toBe('tenant'); expect(Cache::lock('foo')->getConnectionName())->toBe('tenant'); tenancy()->end(); // Ending tenancy should change both connections back to the original ('central') expect(config('cache.stores.database.connection'))->toBe('central'); expect(config('cache.stores.database.lock_connection'))->toBe('central'); // The actual connection used by the cache store and the cache locks is now 'central' again expect(Cache::store()->getConnection()->getName())->toBe('central'); expect(Cache::lock('foo')->getConnectionName())->toBe('central'); }); test('cache is separated correctly when using DatabaseCacheBootstrapper', function() { // DB query for verifying that the cache is stored // in the cache table of the current DB connection // under the passed key (the key in the DB is prefixed by the default cache prefix). $getCacheUsingDbQuery = function (string $cacheKey) { // Prefix the cache key with the default cache prefix $databaseCacheKey = config('cache.prefix') . $cacheKey; return DB::selectOne("SELECT * FROM `cache` WHERE `key` = '{$databaseCacheKey}'")?->value; }; // Create the cache table in the central DB Schema::create('cache', function (Blueprint $table) { $table->string('key')->primary(); $table->mediumText('value'); $table->integer('expiration'); }); $tenant = Tenant::create(); $tenant2 = Tenant::create(); // Create the cache table in tenant DBs // With DatabaseCacheBootstrapper, cache will be saved in these tenant DBs instead of the central DB tenancy()->runForMultiple([$tenant, $tenant2], function () { Schema::create('cache', function (Blueprint $table) { $table->string('key')->primary(); $table->mediumText('value'); $table->integer('expiration'); }); }); // Write to cache in central context cache()->set('foo', 'central'); expect(Cache::get('foo'))->toBe('central'); // The value retrieved by the DB query is formatted like "s:7:"central";". // We use toContain() because of this formatting instead of just toBe(). expect($getCacheUsingDbQuery('foo'))->toContain('central'); tenancy()->initialize($tenant); // Central cache doesn't leak to tenant context expect(Cache::has('foo'))->toBeFalse(); // Verify that the 'foo' cache key doesn't exist in the tenant's DB using a direct DB query expect($getCacheUsingDbQuery('foo'))->toBeNull(); cache()->set('foo', 'bar'); expect(Cache::get('foo'))->toBe('bar'); // Verify that the 'foo' cache key is 'bar' using a direct DB query expect($getCacheUsingDbQuery('foo'))->toContain('bar'); tenancy()->initialize($tenant2); // Assert one tenant's cache doesn't leak to another tenant expect(Cache::has('foo'))->toBeFalse(); // The 'foo' cache key in another tenant's database shouldn't exist expect($getCacheUsingDbQuery('foo'))->toBeNull(); cache()->set('foo', 'xyz'); expect(Cache::get('foo'))->toBe('xyz'); expect($getCacheUsingDbQuery('foo'))->toContain('xyz'); tenancy()->initialize($tenant); // Assert cache didn't leak to the original tenant expect(Cache::get('foo'))->toBe('bar'); expect($getCacheUsingDbQuery('foo'))->toContain('bar'); tenancy()->end(); // Assert central 'foo' cache is still the same ('central') expect(Cache::get('foo'))->toBe('central'); expect($getCacheUsingDbQuery('foo'))->toContain('central'); });