Skip to content

Commit

Permalink
Use $addTags approach again
Browse files Browse the repository at this point in the history
  • Loading branch information
lukinovec committed Apr 20, 2023
1 parent 58e008a commit 8f5a4e4
Show file tree
Hide file tree
Showing 5 changed files with 56 additions and 45 deletions.
1 change: 1 addition & 0 deletions assets/config.php
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,7 @@
'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,
],

/**
Expand Down
39 changes: 4 additions & 35 deletions src/Bootstrappers/CacheTagsBootstrapper.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@

namespace Stancl\Tenancy\Bootstrappers;

use Illuminate\Cache\CacheManager;
use Illuminate\Contracts\Foundation\Application;
use Illuminate\Support\Facades\Cache;
use Stancl\Tenancy\Contracts\TenancyBootstrapper;
use Stancl\Tenancy\CacheManager;
use Stancl\Tenancy\Contracts\Tenant;
use Stancl\Tenancy\Contracts\TenancyBootstrapper;

/**
* todo name.
Expand All @@ -17,42 +15,13 @@
*/
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
{
$this->resetFacadeCache();

$this->originalCache ??= $this->app['cache'];
$this->app->extend('cache', function () {
return new static::$cacheManagerWithTags($this->app);
});
CacheManager::$addTags = true;
}

public function revert(): void
{
$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();
CacheManager::$addTags = false;
}
}
26 changes: 16 additions & 10 deletions src/CacheManager.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
class CacheManager extends BaseCacheManager
{
public static bool $addTags = false;

/**
* Add tags and forward the call to the inner cache store.
*
Expand All @@ -18,21 +20,25 @@ class CacheManager extends BaseCacheManager
*/
public function __call($method, $parameters)
{
$tags = [config('tenancy.cache.tag_base') . tenant()?->getTenantKey()];
if (tenancy()->initialized && static::$addTags) {
$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.");
}
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
$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 $this->store()->tags(array_merge($tags, $names));
return $this->store()->tags($tags)->$method(...$parameters);
}

return $this->store()->tags($tags)->$method(...$parameters);
return parent::__call($method, $parameters);
}
}
8 changes: 8 additions & 0 deletions src/TenancyServiceProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
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;
Expand Down Expand Up @@ -133,5 +134,12 @@ public function boot(): void

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);
});
}
}
}
27 changes: 27 additions & 0 deletions tests/PrefixCacheBootstrapperTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
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([
Expand All @@ -21,6 +22,7 @@
'cache.stores.' . $secondCacheDriver = 'redis2' => config('cache.stores.redis'),
]);

TenancyCacheManager::$addTags = false;
PrefixCacheTenancyBootstrapper::$tenantCacheStores = [$cacheDriver, $secondCacheDriver];
PrefixCacheTenancyBootstrapper::$prefixGenerator = null;

Expand All @@ -29,10 +31,35 @@
});

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');
Expand Down

0 comments on commit 8f5a4e4

Please sign in to comment.