archtechx/tenancy
1
0
Fork 0
mirror of https://github.com/archtechx/tenancy.git synced 2025-12-13 03:14:03 +00:00
Code Activity

Update cache prefixing and tests

Browse source
This commit is contained in:
lukinovec 2023-04-17 14:34:54 +02:00
parent 13b85a2d3b
commit 52d9643535
2 changed files with 32 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

16
src/Bootstrappers/PrefixCacheTenancyBootstrapper.php
View file

@ -28,12 +28,7 @@ class PrefixCacheTenancyBootstrapper implements TenancyBootstrapper
{
$this->originalPrefix = $this->config->get('cache.prefix');
// Use default prefix generator if the prefix generator isn't set
static::$prefixGenerator ??= function (Tenant $tenant) {
return $this->originalPrefix . $this->config->get('tenancy.cache.prefix_base') . $tenant->getTenantKey();
};
$prefix = (static::$prefixGenerator)($tenant);
$prefix = $this->generatePrefix($tenant);
foreach (static::$tenantCacheStores as $store) {
$this->setCachePrefix($store, $prefix);
@ -49,8 +44,6 @@ class PrefixCacheTenancyBootstrapper implements TenancyBootstrapper
foreach (static::$tenantCacheStores as $store) {
$this->setCachePrefix($store, $this->originalPrefix);
}
static::$prefixGenerator = null;
}
protected function setCachePrefix(string $driver, string|null $prefix): void
@ -65,6 +58,13 @@ class PrefixCacheTenancyBootstrapper implements TenancyBootstrapper
Cache::clearResolvedInstances();
}
public function generatePrefix(Tenant $tenant): string
{
$defaultPrefix = $this->originalPrefix . $this->config->get('tenancy.cache.prefix_base') . $tenant->getTenantKey();
return static::$prefixGenerator ? (static::$prefixGenerator)($tenant) : $defaultPrefix;
}
public static function generatePrefixUsing(Closure $prefixGenerator): void
{
static::$prefixGenerator = $prefixGenerator;

46
tests/PrefixCacheBootstrapperTest.php
View file

@ -33,8 +33,6 @@ beforeEach(function () {
afterEach(function () {
PrefixCacheTenancyBootstrapper::$tenantCacheStores = [];
PrefixCacheTenancyBootstrapper::$prefixGenerator = null;
TenancyCacheManager::$addTags = false;
});
test('Tenancy overrides CacheManager', function() {
@ -60,38 +58,35 @@ test('Tenancy overrides CacheManager', function() {
test('correct cache prefix is used in all contexts', function () {
$originalPrefix = config('cache.prefix');
$prefixBase = config('tenancy.cache.prefix_base');
$expectPrefixToBe = function(string $prefix) {
$getDefaultPrefixForTenant = fn (Tenant $tenant) => $originalPrefix . $prefixBase . $tenant->getTenantKey();
$generatePrefixForTenant = function (Tenant $tenant) {
return app(PrefixCacheTenancyBootstrapper::class)->generatePrefix($tenant);
};
$expectCachePrefixToBe = function (string $prefix) {
expect($prefix . ':') // RedisStore suffixes prefix with ':'
->toBe(app('cache')->getPrefix())
->toBe(app('cache.store')->getPrefix());
};
$expectPrefixToBe($originalPrefix);
$expectCachePrefixToBe($originalPrefix);
$tenant1 = Tenant::create();
$tenant2 = Tenant::create();
$tenantOnePrefix = $originalPrefix . $prefixBase . $tenant1->getTenantKey();
tenancy()->initialize($tenant1);
// Default prefix generator
$prefixGenerator = PrefixCacheTenancyBootstrapper::$prefixGenerator;
cache()->set('key', 'tenantone-value');
$expectPrefixToBe($prefixGenerator($tenant1));
$tenantTwoPrefix = $originalPrefix . $prefixBase . $tenant2->getTenantKey();
expect($generatePrefixForTenant($tenant1))->toBe($tenantOnePrefix = $getDefaultPrefixForTenant($tenant1));
$expectCachePrefixToBe($tenantOnePrefix);
tenancy()->initialize($tenant2);
cache()->set('key', 'tenanttwo-value');
$expectPrefixToBe($prefixGenerator($tenant2));
expect($generatePrefixForTenant($tenant2))->toBe($tenantTwoPrefix = $getDefaultPrefixForTenant($tenant2));
$expectCachePrefixToBe($tenantTwoPrefix);
// Prefix gets reverted to default after ending tenancy
tenancy()->end();
$expectPrefixToBe($originalPrefix);
$expectCachePrefixToBe($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
@ -282,6 +277,10 @@ test('stores not specified in tenantCacheStores do not get prefixed', function()
});
test('non default stores get prefixed too', function () {
$generatePrefixForTenant = function (Tenant $tenant) {
return app(PrefixCacheTenancyBootstrapper::class)->generatePrefix($tenant);
};
config(['cache.stores.redis2' => config('cache.stores.redis')]);
// Make 'redis2' the default cache driver
config(['cache.default' => 'redis2']);
@ -294,7 +293,8 @@ test('non default stores get prefixed too', function () {
expect(cache()->store('redis')->getPrefix())->toBe($defaultPrefix);
tenancy()->initialize($tenant);
$expectedPrefix = (PrefixCacheTenancyBootstrapper::$prefixGenerator)($tenant);
$expectedPrefix = $generatePrefixForTenant($tenant);
// 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($expectedPrefix . ':');
@ -327,7 +327,11 @@ test('stores get prefixed using the default way if the store does not have a cor
config(['cache.stores.redis2' => config('cache.stores.redis')]);
// Make 'redis2' the default cache driver
config(['cache.default' => 'redis2']);
$originalPrefix = config('cache.prefix');
$prefixBase = config('tenancy.cache.prefix_base');
$tenant = Tenant::create();
$defaultPrefix = $originalPrefix . $prefixBase . $tenant->getTenantKey();
PrefixCacheTenancyBootstrapper::$tenantCacheStores = ['redis', 'redis2'];
@ -335,11 +339,9 @@ test('stores get prefixed using the default way if the store does not have a cor
// Let the prefix get created using the default approach
tenancy()->initialize($tenant);
$expectedPrefix = (PrefixCacheTenancyBootstrapper::$prefixGenerator)($tenant);
expect(cache()->store()->getPrefix())->toBe($expectedPrefix . ':');
expect(cache()->store()->getPrefix())->toBe($defaultPrefix . ':');
// Other stores without a prefix generator use the default generator too
expect(cache()->store('redis')->getPrefix())->toBe($expectedPrefix . ':');
expect(cache()->store('redis')->getPrefix())->toBe($defaultPrefix . ':');
tenancy()->end();
});