diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 5d4d0cb1..aca092db 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -16,8 +16,6 @@ jobs: strategy: matrix: include: - - laravel: "^9.0" - php: "8.0" - laravel: "^10.0" php: "8.2" diff --git a/assets/TenancyServiceProvider.stub.php b/assets/TenancyServiceProvider.stub.php index a2679061..6c916d71 100644 --- a/assets/TenancyServiceProvider.stub.php +++ b/assets/TenancyServiceProvider.stub.php @@ -124,12 +124,12 @@ class TenancyServiceProvider extends ServiceProvider * Example of CLI tenant URL root override: * * UrlTenancyBootstrapper::$rootUrlOverride = function (Tenant $tenant) { - * $baseUrl = url('/'); - * $scheme = str($baseUrl)->before('://'); - * $hostname = str($baseUrl)->after($scheme . '://'); + * $baseUrl = env('APP_URL'); + * $scheme = str($baseUrl)->before('://'); + * $hostname = str($baseUrl)->after($scheme . '://'); * - * return $scheme . '://' . $tenant->getTenantKey() . '.' . $hostname; - *}; + * return $scheme . '://' . $tenant->getTenantKey() . '.' . $hostname; + * }; */ } diff --git a/assets/config.php b/assets/config.php index 7fc6c928..3875aca1 100644 --- a/assets/config.php +++ b/assets/config.php @@ -2,6 +2,7 @@ declare(strict_types=1); +use Stancl\Tenancy\CacheManager; use Stancl\Tenancy\Middleware; use Stancl\Tenancy\Resolvers; @@ -98,10 +99,10 @@ return [ */ 'bootstrappers' => [ Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper::class, - Stancl\Tenancy\Bootstrappers\CacheTenancyBootstrapper::class, Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper::class, Stancl\Tenancy\Bootstrappers\QueueTenancyBootstrapper::class, Stancl\Tenancy\Bootstrappers\BatchTenancyBootstrapper::class, + // Stancl\Tenancy\Bootstrappers\PrefixCacheTenancyBootstrapper::class, // Stancl\Tenancy\Bootstrappers\UrlTenancyBootstrapper::class, // Stancl\Tenancy\Bootstrappers\SessionTenancyBootstrapper::class, // Stancl\Tenancy\Bootstrappers\MailTenancyBootstrapper::class, // Queueing mail requires using QueueTenancyBootstrapper with $forceRefresh set to true @@ -178,7 +179,7 @@ return [ ], /** - * Cache tenancy config. Used by CacheTenancyBootstrapper. + * Cache tenancy config. Used by the custom CacheManager and the PrefixCacheTenancyBootstrapper. * * This works for all Cache facade calls, cache() helper * calls and direct calls to injected cache stores. @@ -190,6 +191,7 @@ 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. ], /** diff --git a/assets/impersonation-migrations/2020_05_15_000010_create_tenant_user_impersonation_tokens_table.php b/assets/impersonation-migrations/2020_05_15_000010_create_tenant_user_impersonation_tokens_table.php index c720160a..88c8fedb 100644 --- a/assets/impersonation-migrations/2020_05_15_000010_create_tenant_user_impersonation_tokens_table.php +++ b/assets/impersonation-migrations/2020_05_15_000010_create_tenant_user_impersonation_tokens_table.php @@ -20,6 +20,7 @@ return new class extends Migration $table->string('token', 128)->primary(); $table->string(Tenancy::tenantKeyColumn()); $table->string('user_id'); + $table->boolean('remember'); $table->string('auth_guard'); $table->string('redirect_url'); $table->timestamp('created_at'); diff --git a/composer.json b/composer.json index b5734c1b..cadd9ee5 100644 --- a/composer.json +++ b/composer.json @@ -17,17 +17,17 @@ "require": { "php": "^8.2", "ext-json": "*", - "illuminate/support": "^9.38|^10.0", + "illuminate/support": "^10.1", "facade/ignition-contracts": "^1.0.2", "spatie/ignition": "^1.4", "ramsey/uuid": "^4.7.3", - "stancl/jobpipeline": "^1.6.2", + "stancl/jobpipeline": "2.0.0-rc1", "stancl/virtualcolumn": "^1.3.1", "spatie/invade": "^1.1" }, "require-dev": { - "laravel/framework": "^9.38|^10.0", - "orchestra/testbench": "^7.0|^8.0", + "laravel/framework": "^10.1", + "orchestra/testbench": "^8.0", "league/flysystem-aws-s3-v3": "^3.12.2", "doctrine/dbal": "^3.6.0", "spatie/valuestore": "^1.2.5", diff --git a/doctum/.gitignore b/doctum/.gitignore new file mode 100644 index 00000000..168c26c8 --- /dev/null +++ b/doctum/.gitignore @@ -0,0 +1,3 @@ +build/ +cache/ +vendor/ diff --git a/doctum/composer.json b/doctum/composer.json new file mode 100644 index 00000000..3e757eeb --- /dev/null +++ b/doctum/composer.json @@ -0,0 +1,8 @@ +{ + "require": { + "code-lts/doctum": "v5.5.x-dev" + }, + "scripts": { + "doctum": "./vendor/bin/doctum.php update doctum.php --output-format=github --force --ignore-parse-errors --no-ansi --no-progress -v" + } +} diff --git a/doctum/doctum.php b/doctum/doctum.php new file mode 100644 index 00000000..41dd1dfe --- /dev/null +++ b/doctum/doctum.php @@ -0,0 +1,30 @@ +files() + ->name('*.php') + ->in($dir = __DIR__ . '/../src'); + +$versions = GitVersionCollection::create($dir) + ->add('1.x', 'Tenancy 1.x') + ->add('2.x', 'Tenancy 2.x') + ->add('3.x', 'Tenancy 3.x') + ->add('master', 'Tenancy Dev'); + +return new Doctum($iterator, [ + 'title' => 'Tenancy for Laravel API Documentation', + 'versions' => $versions, + 'build_dir' => __DIR__ . '/build/%version%', + 'cache_dir' => __DIR__ . '/cache/%version%', + 'default_opened_level' => 2, + 'base_url' => 'https://api.tenancyforlaravel.com/', + 'favicon' => 'https://tenancyforlaravel.com/favicon.ico', + 'remote_repository' => new GitHubRemoteRepository('archtechx/tenancy', dirname($dir)), +]); diff --git a/src/Bootstrappers/CacheTenancyBootstrapper.php b/src/Bootstrappers/CacheTagsBootstrapper.php similarity index 67% rename from src/Bootstrappers/CacheTenancyBootstrapper.php rename to src/Bootstrappers/CacheTagsBootstrapper.php index 29547fae..7ab28c96 100644 --- a/src/Bootstrappers/CacheTenancyBootstrapper.php +++ b/src/Bootstrappers/CacheTagsBootstrapper.php @@ -7,13 +7,20 @@ namespace Stancl\Tenancy\Bootstrappers; use Illuminate\Cache\CacheManager; use Illuminate\Contracts\Foundation\Application; use Illuminate\Support\Facades\Cache; -use Stancl\Tenancy\CacheManager as TenantCacheManager; use Stancl\Tenancy\Contracts\TenancyBootstrapper; use Stancl\Tenancy\Contracts\Tenant; -class CacheTenancyBootstrapper implements TenancyBootstrapper +/** + * todo name. + * + * Separate tenant cache using tagging. + * This is the legacy approach. Some things, like dependency injection, won't work properly with this bootstrapper. + * PrefixCacheTenancyBootstrapper is the recommended bootstrapper for cache separation. + */ +class CacheTagsBootstrapper implements TenancyBootstrapper { protected ?CacheManager $originalCache = null; + public static string $cacheManagerWithTags = \Stancl\Tenancy\CacheManager::class; public function __construct( protected Application $app @@ -24,9 +31,9 @@ class CacheTenancyBootstrapper implements TenancyBootstrapper { $this->resetFacadeCache(); - $this->originalCache = $this->originalCache ?? $this->app['cache']; + $this->originalCache ??= $this->app['cache']; $this->app->extend('cache', function () { - return new TenantCacheManager($this->app); + return new static::$cacheManagerWithTags($this->app); }); } diff --git a/src/Bootstrappers/PrefixCacheTenancyBootstrapper.php b/src/Bootstrappers/PrefixCacheTenancyBootstrapper.php new file mode 100644 index 00000000..ad0ea6f4 --- /dev/null +++ b/src/Bootstrappers/PrefixCacheTenancyBootstrapper.php @@ -0,0 +1,84 @@ +originalPrefix = $this->config->get('cache.prefix'); + + $prefix = $this->generatePrefix($tenant); + + foreach (static::$tenantCacheStores as $store) { + $this->setCachePrefix($store, $prefix); + + // Now that the store uses the passed prefix + // Set the configured prefix back to the default one + $this->config->set('cache.prefix', $this->originalPrefix); + } + } + + public function revert(): void + { + foreach (static::$tenantCacheStores as $store) { + $this->setCachePrefix($store, $this->originalPrefix); + } + } + + protected function setCachePrefix(string $driver, string|null $prefix): void + { + $this->config->set('cache.prefix', $prefix); + + // Refresh driver's store to make the driver use the current prefix + $this->refreshStore($driver); + + // It is needed when a call to the facade has been made before bootstrapping tenancy + // The facade has its own cache, separate from the container + 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; + } + + /** + * Refresh cache driver's store. + */ + protected function refreshStore(string $driver): void + { + $newStore = $this->cacheManager->resolve($driver)->getStore(); + /** @var Repository $repository */ + $repository = $this->cacheManager->driver($driver); + + $repository->setStore($newStore); + } +} diff --git a/src/Bootstrappers/QueueTenancyBootstrapper.php b/src/Bootstrappers/QueueTenancyBootstrapper.php index 92c95ef6..3f46a112 100644 --- a/src/Bootstrappers/QueueTenancyBootstrapper.php +++ b/src/Bootstrappers/QueueTenancyBootstrapper.php @@ -41,7 +41,7 @@ class QueueTenancyBootstrapper implements TenancyBootstrapper */ public static function __constructStatic(Application $app): void { - static::setUpJobListener($app->make(Dispatcher::class), $app->runningUnitTests()); + static::setUpJobListener($app->make(Dispatcher::class)); } public function __construct(Repository $config, QueueManager $queue) @@ -52,7 +52,7 @@ class QueueTenancyBootstrapper implements TenancyBootstrapper $this->setUpPayloadGenerator(); } - protected static function setUpJobListener(Dispatcher $dispatcher, bool $runningTests): void + protected static function setUpJobListener(Dispatcher $dispatcher): void { $previousTenant = null; @@ -69,10 +69,8 @@ class QueueTenancyBootstrapper implements TenancyBootstrapper }); // If we're running tests, we make sure to clean up after any artisan('queue:work') calls - $revertToPreviousState = function ($event) use (&$previousTenant, $runningTests) { - if ($runningTests) { - static::revertToPreviousState($event, $previousTenant); - } + $revertToPreviousState = function ($event) use (&$previousTenant) { + static::revertToPreviousState($event, $previousTenant); }; $dispatcher->listen(JobProcessed::class, $revertToPreviousState); // artisan('queue:work') which succeeds diff --git a/src/Database/Models/ImpersonationToken.php b/src/Database/Models/ImpersonationToken.php index 3d7b595b..6dabbd03 100644 --- a/src/Database/Models/ImpersonationToken.php +++ b/src/Database/Models/ImpersonationToken.php @@ -18,6 +18,7 @@ use Stancl\Tenancy\Exceptions\StatefulGuardRequiredException; * @property string $user_id * @property string $auth_guard * @property string $redirect_url + * @property bool $remember * @property Carbon $created_at */ class ImpersonationToken extends Model diff --git a/src/Exceptions/ModelNotSyncMasterException.php b/src/Exceptions/ModelNotSyncMasterException.php index ee5feb9a..5ae35a68 100644 --- a/src/Exceptions/ModelNotSyncMasterException.php +++ b/src/Exceptions/ModelNotSyncMasterException.php @@ -6,10 +6,12 @@ namespace Stancl\Tenancy\Exceptions; use Exception; +// todo@v4 improve all exception messages + class ModelNotSyncMasterException extends Exception { public function __construct(string $class) { - parent::__construct("Model of $class class is not an SyncMaster model. Make sure you're using the central model to make changes to synced resources when you're in the central context"); + parent::__construct("Model of $class class is not a SyncMaster model. Make sure you're using the central model to make changes to synced resources when you're in the central context"); } } diff --git a/src/Features/UserImpersonation.php b/src/Features/UserImpersonation.php index 280acbc5..44eed78f 100644 --- a/src/Features/UserImpersonation.php +++ b/src/Features/UserImpersonation.php @@ -24,6 +24,7 @@ class UserImpersonation implements Feature 'user_id' => $userId, 'redirect_url' => $redirectUrl, 'auth_guard' => $authGuard, + 'remember' => $remember, ]); }); } @@ -44,7 +45,7 @@ class UserImpersonation implements Feature abort_unless($tokenTenantId === $currentTenantId, 403); - Auth::guard($token->auth_guard)->loginUsingId($token->user_id); + Auth::guard($token->auth_guard)->loginUsingId($token->user_id, $token->remember); $token->delete(); diff --git a/tests/BootstrapperTest.php b/tests/BootstrapperTest.php index 7350f0a8..9260c9c9 100644 --- a/tests/BootstrapperTest.php +++ b/tests/BootstrapperTest.php @@ -28,18 +28,26 @@ use Stancl\Tenancy\Listeners\BootstrapTenancy; use Stancl\Tenancy\Tests\Etc\TestingBroadcaster; use Stancl\Tenancy\Listeners\DeleteTenantStorage; use Stancl\Tenancy\Listeners\RevertToCentralContext; +use Stancl\Tenancy\Bootstrappers\CacheTagsBootstrapper; use Stancl\Tenancy\Bootstrappers\UrlTenancyBootstrapper; use Stancl\Tenancy\Bootstrappers\MailTenancyBootstrapper; -use Stancl\Tenancy\Bootstrappers\CacheTenancyBootstrapper; use Stancl\Tenancy\Bootstrappers\RedisTenancyBootstrapper; use Stancl\Tenancy\Middleware\InitializeTenancyBySubdomain; use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper; use Stancl\Tenancy\Bootstrappers\BroadcastTenancyBootstrapper; use Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper; +use Stancl\Tenancy\Bootstrappers\PrefixCacheTenancyBootstrapper; beforeEach(function () { $this->mockConsoleOutput = false; + config(['cache.default' => $cacheDriver = 'redis']); + PrefixCacheTenancyBootstrapper::$tenantCacheStores = [$cacheDriver]; + // Reset static properties of classes used in this test file to their default values + BroadcastTenancyBootstrapper::$credentialsMap = []; + TenancyBroadcastManager::$tenantBroadcasters = ['pusher', 'ably']; + UrlTenancyBootstrapper::$rootUrlOverride = null; + Event::listen( TenantCreated::class, JobPipeline::make([CreateDatabase::class])->send(function (TenantCreated $event) { @@ -51,6 +59,14 @@ beforeEach(function () { Event::listen(TenancyEnded::class, RevertToCentralContext::class); }); +afterEach(function () { + // Reset static properties of classes used in this test file to their default values + UrlTenancyBootstrapper::$rootUrlOverride = null; + PrefixCacheTenancyBootstrapper::$tenantCacheStores = []; + TenancyBroadcastManager::$tenantBroadcasters = ['pusher', 'ably']; + BroadcastTenancyBootstrapper::$credentialsMap = []; +}); + test('database data is separated', function () { config(['tenancy.bootstrappers' => [ DatabaseTenancyBootstrapper::class, @@ -82,12 +98,9 @@ test('database data is separated', function () { expect(DB::table('users')->first()->name)->toBe('Foo'); }); -test('cache data is separated', function () { +test('cache data is separated', function (string $bootstrapper) { config([ - 'tenancy.bootstrappers' => [ - CacheTenancyBootstrapper::class, - ], - 'cache.default' => 'redis', + 'tenancy.bootstrappers' => [$bootstrapper], ]); $tenant1 = Tenant::create(); @@ -121,7 +134,10 @@ test('cache data is separated', function () { // Asset central is still the same expect(Cache::get('foo'))->toBe('central'); -}); +})->with([ + CacheTagsBootstrapper::class, + PrefixCacheTenancyBootstrapper::class, +]); test('redis data is separated', function () { config(['tenancy.bootstrappers' => [ diff --git a/tests/BroadcastingTest.php b/tests/BroadcastingTest.php index aeb70de2..9505b537 100644 --- a/tests/BroadcastingTest.php +++ b/tests/BroadcastingTest.php @@ -13,12 +13,17 @@ use Stancl\Tenancy\Tests\Etc\TestingBroadcaster; use Stancl\Tenancy\Listeners\RevertToCentralContext; use Illuminate\Contracts\Broadcasting\Broadcaster as BroadcasterContract; -beforeEach(function() { +beforeEach(function () { withTenantDatabases(); + TenancyBroadcastManager::$tenantBroadcasters = ['pusher', 'ably']; Event::listen(TenancyInitialized::class, BootstrapTenancy::class); Event::listen(TenancyEnded::class, RevertToCentralContext::class); }); +afterEach(function () { + TenancyBroadcastManager::$tenantBroadcasters = ['pusher', 'ably']; +}); + test('bound broadcaster instance is the same before initializing tenancy and after ending it', function() { config(['broadcasting.default' => 'null']); TenancyBroadcastManager::$tenantBroadcasters[] = 'null'; diff --git a/tests/CacheManagerTest.php b/tests/CacheManagerTest.php index 03580fe1..744d81d2 100644 --- a/tests/CacheManagerTest.php +++ b/tests/CacheManagerTest.php @@ -2,16 +2,14 @@ declare(strict_types=1); +use Stancl\Tenancy\Tests\Etc\Tenant; use Illuminate\Support\Facades\Event; -use Stancl\Tenancy\Bootstrappers\CacheTenancyBootstrapper; use Stancl\Tenancy\Events\TenancyInitialized; use Stancl\Tenancy\Listeners\BootstrapTenancy; -use Stancl\Tenancy\Tests\Etc\Tenant; +use Stancl\Tenancy\Bootstrappers\CacheTagsBootstrapper; beforeEach(function () { - config(['tenancy.bootstrappers' => [ - CacheTenancyBootstrapper::class, - ]]); + config(['tenancy.bootstrappers' => [CacheTagsBootstrapper::class]]); Event::listen(TenancyInitialized::class, BootstrapTenancy::class); }); @@ -60,7 +58,7 @@ test('tags separate cache well enough', function () { $tenant2 = Tenant::create(); tenancy()->initialize($tenant2); - pest()->assertNotSame('bar', cache()->get('foo')); + expect(cache('foo'))->not()->toBe('bar'); cache()->put('foo', 'xyz', 1); expect(cache()->get('foo'))->toBe('xyz'); @@ -76,7 +74,7 @@ test('invoking the cache helper works', function () { $tenant2 = Tenant::create(); tenancy()->initialize($tenant2); - pest()->assertNotSame('bar', cache('foo')); + expect(cache('foo'))->not()->toBe('bar'); cache(['foo' => 'xyz'], 1); expect(cache('foo'))->toBe('xyz'); diff --git a/tests/DomainTest.php b/tests/DomainTest.php index 02459914..cb104532 100644 --- a/tests/DomainTest.php +++ b/tests/DomainTest.php @@ -12,6 +12,8 @@ use Stancl\Tenancy\Middleware\InitializeTenancyByDomain; use Stancl\Tenancy\Resolvers\DomainTenantResolver; beforeEach(function () { + InitializeTenancyByDomain::$onFail = null; + Route::group([ 'middleware' => InitializeTenancyByDomain::class, ], function () { @@ -23,6 +25,10 @@ beforeEach(function () { config(['tenancy.models.tenant' => DomainTenant::class]); }); +afterEach(function () { + InitializeTenancyByDomain::$onFail = null; +}); + test('tenant can be identified using hostname', function () { $tenant = DomainTenant::create(); @@ -89,9 +95,6 @@ test('onfail logic can be customized', function () { }); test('throw correct exception when onFail is null and universal routes are enabled', function () { - // un-define onFail logic - InitializeTenancyByDomain::$onFail = null; - // Enable UniversalRoute feature Route::middlewareGroup('universal', []); diff --git a/tests/Etc/CacheService.php b/tests/Etc/CacheService.php new file mode 100644 index 00000000..c228d59e --- /dev/null +++ b/tests/Etc/CacheService.php @@ -0,0 +1,24 @@ +initialized) { + $this->cache->put('key', tenant()->getTenantKey()); + } else { + $this->cache->put('key', 'central-value'); + } + } +} diff --git a/tests/Etc/SpecificCacheStoreService.php b/tests/Etc/SpecificCacheStoreService.php new file mode 100644 index 00000000..579e2caa --- /dev/null +++ b/tests/Etc/SpecificCacheStoreService.php @@ -0,0 +1,27 @@ +cache = $cacheManager->store($cacheStoreName); + } + + public function handle(): void + { + if (tenancy()->initialized) { + $this->cache->put('key', tenant()->getTenantKey()); + } else { + $this->cache->put('key', 'central-value'); + } + } +} diff --git a/tests/GlobalCacheTest.php b/tests/GlobalCacheTest.php index ea38341b..22fc2641 100644 --- a/tests/GlobalCacheTest.php +++ b/tests/GlobalCacheTest.php @@ -2,25 +2,32 @@ declare(strict_types=1); +use Stancl\Tenancy\CacheManager; +use Stancl\Tenancy\Tests\Etc\Tenant; use Illuminate\Support\Facades\Event; -use Stancl\Tenancy\Bootstrappers\CacheTenancyBootstrapper; use Stancl\Tenancy\Events\TenancyEnded; -use Stancl\Tenancy\Events\TenancyInitialized; use Stancl\Tenancy\Facades\GlobalCache; +use Stancl\Tenancy\Events\TenancyInitialized; use Stancl\Tenancy\Listeners\BootstrapTenancy; use Stancl\Tenancy\Listeners\RevertToCentralContext; -use Stancl\Tenancy\Tests\Etc\Tenant; +use Stancl\Tenancy\Bootstrappers\CacheTagsBootstrapper; +use Stancl\Tenancy\Bootstrappers\PrefixCacheTenancyBootstrapper; beforeEach(function () { - config(['tenancy.bootstrappers' => [ - CacheTenancyBootstrapper::class, - ]]); + config(['cache.default' => $cacheDriver = 'redis']); + PrefixCacheTenancyBootstrapper::$tenantCacheStores = [$cacheDriver]; Event::listen(TenancyInitialized::class, BootstrapTenancy::class); Event::listen(TenancyEnded::class, RevertToCentralContext::class); }); -test('global cache manager stores data in global cache', function () { +afterEach(function () { + PrefixCacheTenancyBootstrapper::$tenantCacheStores = []; +}); + +test('global cache manager stores data in global cache', function (string $bootstrapper) { + config(['tenancy.bootstrappers' => [$bootstrapper]]); + expect(cache('foo'))->toBe(null); GlobalCache::put(['foo' => 'bar'], 1); expect(GlobalCache::get('foo'))->toBe('bar'); @@ -48,9 +55,14 @@ test('global cache manager stores data in global cache', function () { tenancy()->initialize($tenant1); expect(cache('def'))->toBe('ghi'); -}); +})->with([ + CacheTagsBootstrapper::class, + PrefixCacheTenancyBootstrapper::class, +]); + +test('the global_cache helper supports the same syntax as the cache helper', function (string $bootstrapper) { + config(['tenancy.bootstrappers' => [$bootstrapper]]); -test('the global_cache helper supports the same syntax as the cache helper', function () { $tenant = Tenant::create(); $tenant->enter(); @@ -63,4 +75,7 @@ test('the global_cache helper supports the same syntax as the cache helper', fun expect(global_cache()->get('foo'))->toBe('baz'); expect(cache('foo'))->toBe(null); // tenant cache is not affected -}); +})->with([ + CacheTagsBootstrapper::class, + PrefixCacheTenancyBootstrapper::class, +]); diff --git a/tests/MailTest.php b/tests/MailTest.php index c530b7e8..dc48648a 100644 --- a/tests/MailTest.php +++ b/tests/MailTest.php @@ -12,11 +12,16 @@ use Stancl\Tenancy\Bootstrappers\MailTenancyBootstrapper; beforeEach(function() { config(['mail.default' => 'smtp']); + MailTenancyBootstrapper::$credentialsMap = []; Event::listen(TenancyInitialized::class, BootstrapTenancy::class); Event::listen(TenancyEnded::class, RevertToCentralContext::class); }); +afterEach(function () { + MailTenancyBootstrapper::$credentialsMap = []; +}); + // Initialize tenancy as $tenant and assert that the smtp mailer's transport has the correct password function assertMailerTransportUsesPassword(string|null $password) { $manager = app(MailManager::class); diff --git a/tests/PrefixCacheBootstrapperTest.php b/tests/PrefixCacheBootstrapperTest.php new file mode 100644 index 00000000..68a9d33c --- /dev/null +++ b/tests/PrefixCacheBootstrapperTest.php @@ -0,0 +1,324 @@ + [ + PrefixCacheTenancyBootstrapper::class + ], + 'cache.default' => $cacheDriver = 'redis', + 'cache.stores.' . $secondCacheDriver = 'redis2' => config('cache.stores.redis'), + ]); + + PrefixCacheTenancyBootstrapper::$tenantCacheStores = [$cacheDriver, $secondCacheDriver]; + PrefixCacheTenancyBootstrapper::$prefixGenerator = null; + + Event::listen(TenancyInitialized::class, BootstrapTenancy::class); + Event::listen(TenancyEnded::class, RevertToCentralContext::class); +}); + +afterEach(function () { + PrefixCacheTenancyBootstrapper::$tenantCacheStores = []; + PrefixCacheTenancyBootstrapper::$prefixGenerator = null; +}); + +test('correct cache prefix is used in all contexts', function () { + $originalPrefix = config('cache.prefix'); + $prefixBase = config('tenancy.cache.prefix_base'); + $getDefaultPrefixForTenant = fn (Tenant $tenant) => $originalPrefix . $prefixBase . $tenant->getTenantKey(); + $bootstrapper = app(PrefixCacheTenancyBootstrapper::class); + + $expectCachePrefixToBe = function (string $prefix) { + expect($prefix . ':') // RedisStore suffixes prefix with ':' + ->toBe(app('cache')->getPrefix()) + ->toBe(app('cache.store')->getPrefix()) + ->toBe(cache()->getPrefix()) + ->toBe(cache()->store('redis2')->getPrefix()); // Non-default cache stores specified in $tenantCacheStores are prefixed too + }; + + $expectCachePrefixToBe($originalPrefix); + + $tenant1 = Tenant::create(); + $tenant2 = Tenant::create(); + + tenancy()->initialize($tenant1); + cache()->set('key', 'tenantone-value'); + $tenantOnePrefix = $getDefaultPrefixForTenant($tenant1); + $expectCachePrefixToBe($tenantOnePrefix); + expect($bootstrapper->generatePrefix($tenant1))->toBe($tenantOnePrefix); + + tenancy()->initialize($tenant2); + cache()->set('key', 'tenanttwo-value'); + $tenantTwoPrefix = $getDefaultPrefixForTenant($tenant2); + $expectCachePrefixToBe($tenantTwoPrefix); + expect($bootstrapper->generatePrefix($tenant2))->toBe($tenantTwoPrefix); + + // Prefix gets reverted to default after ending tenancy + tenancy()->end(); + $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 + 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']); + expect(cache('foo'))->toBe('bar'); + + tenancy()->initialize($tenant2); + expect(cache('foo'))->toBeNull(); + 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'); + expect(cache()->get('foo'))->toBe('bar'); + + $tenant2 = Tenant::create(); + tenancy()->initialize($tenant2); + + expect(cache()->get('foo'))->toBeNull(); + + cache()->put('foo', 'xyz'); + expect(cache()->get('foo'))->toBe('xyz'); + + tenancy()->initialize($tenant1); + expect(cache()->get('foo'))->toBe('bar'); +}); + +test('central cache is persisted', function () { + cache()->put('key', 'central'); + + $tenant1 = Tenant::create(); + tenancy()->initialize($tenant1); + + expect(cache('key'))->toBeNull(); + 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'); + + tenancy()->initialize($tenant1); + expect(cache()->get('key'))->toBe('tenant'); + expect(cache()->get('key2'))->toBeNull(); +}); + +test('cache base prefix is customizable', function () { + config([ + 'tenancy.cache.prefix_base' => $prefixBase = 'custom_' + ]); + + $originalPrefix = config('cache.prefix'); + $tenant1 = Tenant::create(); + + tenancy()->initialize($tenant1); + + expect($originalPrefix . $prefixBase . $tenant1->getTenantKey() . ':') + ->toBe(cache()->getPrefix()) + ->toBe(cache()->store('redis2')->getPrefix()) // Non-default store gets prefixed correctly too + ->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); + + expect(cache('key'))->toBeNull(); + + $this->app->make(CacheService::class)->handle(); + + expect(cache('key'))->toBe('central-value'); + + $tenant1 = Tenant::create(); + $tenant2 = Tenant::create(); + tenancy()->initialize($tenant1); + + expect(cache('key'))->toBeNull(); + $this->app->make(CacheService::class)->handle(); + expect(cache('key'))->toBe($tenant1->getTenantKey()); + + tenancy()->initialize($tenant2); + + expect(cache('key'))->toBeNull(); + $this->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 () { + // Make sure 'redis' (the default store) is the only prefixed store + PrefixCacheTenancyBootstrapper::$tenantCacheStores = ['redis']; + // Name of the non-default, central cache store that we'll use using cache()->store($cacheStore) + $cacheStore = 'redis2'; + + // Service uses the 'redis2' store which is central/not prefixed (not present in PrefixCacheTenancyBootstrapper::$tenantCacheStores) + // The service's handle() method sets the value of the cache key 'key' to the current tenant key + // Or to 'central-value' if tenancy isn't initialized + $this->app->singleton(SpecificCacheStoreService::class, function() use ($cacheStore) { + return new SpecificCacheStoreService($this->app->make(CacheManager::class), $cacheStore); + }); + + $this->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 – the values persist from one context to another + // Also assert that the value of 'key' is set correctly inside SpecificCacheStoreService according to the current context + expect(cache()->store($cacheStore)->get('key'))->toBe('central-value'); + $this->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()); + $this->app->make(SpecificCacheStoreService::class)->handle(); + expect(cache()->store($cacheStore)->get('key'))->toBe($tenant2->getTenantKey()); + + tenancy()->end(); + // We last executed handle() in tenant2's context, so the value should persist as tenant2's id + expect(cache()->store($cacheStore)->get('key'))->toBe($tenant2->getTenantKey()); +}); + +test('only the stores specified in tenantCacheStores get prefixed', function () { + // Make sure the currently used store ('redis') is the only store in $tenantCacheStores + PrefixCacheTenancyBootstrapper::$tenantCacheStores = [$prefixedStore = 'redis']; + + $centralValue = 'central-value'; + $assertStoreIsNotPrefixed = function (string $unprefixedStore) use ($prefixedStore, $centralValue) { + // Switch to the unprefixed store + config(['cache.default' => $unprefixedStore]); + expect(cache('key'))->toBe($centralValue); + // Switch back to the prefixed store + config(['cache.default' => $prefixedStore]); + }; + + $this->app->singleton(CacheService::class); + + $this->app->make(CacheService::class)->handle(); + expect(cache('key'))->toBe($centralValue); + + $tenant1 = Tenant::create(); + $tenant2 = Tenant::create(); + + tenancy()->initialize($tenant1); + + expect(cache('key'))->toBeNull(); + $this->app->make(CacheService::class)->handle(); + expect(cache('key'))->toBe($tenant1->getTenantKey()); + + $assertStoreIsNotPrefixed('redis2'); + + tenancy()->initialize($tenant2); + + expect(cache('key'))->toBeNull(); + $this->app->make(CacheService::class)->handle(); + expect(cache('key'))->toBe($tenant2->getTenantKey()); + + $assertStoreIsNotPrefixed('redis2'); + + tenancy()->end(); + expect(cache('key'))->toBe($centralValue); + + $this->app->make(CacheService::class)->handle(); + expect(cache('key'))->toBe($centralValue); +}); + +test('non default stores get prefixed too when specified in tenantCacheStores', function () { + // In beforeEach, we set $tenantCacheStores to ['redis', 'redis2'] + // Make 'redis' the default cache driver + config(['cache.default' => 'redis']); + + $tenant = Tenant::create(); + $defaultPrefix = cache()->store()->getPrefix(); + $bootstrapper = app(PrefixCacheTenancyBootstrapper::class); + + // The prefix is the same for both drivers in the central context + expect(cache()->store('redis')->getPrefix())->toBe($defaultPrefix); + expect(cache()->store('redis2')->getPrefix())->toBe($defaultPrefix); + + tenancy()->initialize($tenant); + + // We didn't add a prefix generator for our 'redis2' driver, so we expect the prefix to be generated using the 'default' generator + expect($bootstrapper->generatePrefix($tenant) . ':') + ->toBe(cache()->getPrefix()) + ->toBe(cache()->store('redis2')->getPrefix()); // Non-default store + + tenancy()->end(); +}); + +test('cache store prefix generation can be customized', function() { + // Use custom prefix generator + PrefixCacheTenancyBootstrapper::generatePrefixUsing($customPrefixGenerator = function (Tenant $tenant) { + return 'redis_tenant_cache_' . $tenant->getTenantKey(); + }); + + expect(PrefixCacheTenancyBootstrapper::$prefixGenerator)->toBe($customPrefixGenerator); + expect(app(PrefixCacheTenancyBootstrapper::class)->generatePrefix($tenant = Tenant::create())) + ->toBe($customPrefixGenerator($tenant)); + + tenancy()->initialize($tenant = Tenant::create()); + + // Expect the 'redis' store to use the prefix generated by the custom generator + expect($customPrefixGenerator($tenant) . ':') + ->toBe(cache()->getPrefix()) + ->toBe(cache()->store('redis2')->getPrefix()) // Non-default cache stores specified in $tenantCacheStores are prefixed too + ->toBe(app('cache')->getPrefix()) + ->toBe(app('cache.store')->getPrefix()); + + tenancy()->end(); +}); + +test('stores get prefixed using the default way if no prefix generator is specified', function() { + $originalPrefix = config('cache.prefix'); + $prefixBase = config('tenancy.cache.prefix_base'); + $tenant = Tenant::create(); + $defaultPrefix = $originalPrefix . $prefixBase . $tenant->getTenantKey(); + + // Don't specify a prefix generator + // Let the prefix get created using the default approach + tenancy()->initialize($tenant); + + // All stores use the default way of generating the prefix when the prefix generator isn't specified + expect($defaultPrefix . ':') + ->toBe(app(PrefixCacheTenancyBootstrapper::class)->generatePrefix($tenant) . ':') + ->toBe(cache()->getPrefix()) // Get prefix of the default store ('redis') + ->toBe(cache()->store('redis2')->getPrefix()); + + tenancy()->end(); +}); diff --git a/tests/QueueTest.php b/tests/QueueTest.php index f88b3934..00678876 100644 --- a/tests/QueueTest.php +++ b/tests/QueueTest.php @@ -110,6 +110,8 @@ test('tenancy is initialized inside queues', function (bool $shouldEndTenancy) { pest()->artisan('queue:work --once'); + expect(! tenancy()->initialized)->toBe($shouldEndTenancy); + expect(DB::connection('central')->table('failed_jobs')->count())->toBe(0); expect(pest()->valuestore->get('tenant_id'))->toBe('The current tenant id is: ' . $tenant->id); @@ -117,7 +119,7 @@ test('tenancy is initialized inside queues', function (bool $shouldEndTenancy) { $tenant->run(function () use ($user) { expect($user->fresh()->name)->toBe('Bar'); }); -})->with([true, false]);; +})->with([true, false]); test('tenancy is initialized when retrying jobs', function (bool $shouldEndTenancy) { withFailedJobs(); @@ -144,12 +146,21 @@ test('tenancy is initialized when retrying jobs', function (bool $shouldEndTenan pest()->artisan('queue:work --once'); + expect(! tenancy()->initialized)->toBe($shouldEndTenancy); + expect(DB::connection('central')->table('failed_jobs')->count())->toBe(1); expect(pest()->valuestore->get('tenant_id'))->toBeNull(); // job failed pest()->artisan('queue:retry all'); + + if ($shouldEndTenancy) { + tenancy()->end(); + } + pest()->artisan('queue:work --once'); + expect(! tenancy()->initialized)->toBe($shouldEndTenancy); + expect(DB::connection('central')->table('failed_jobs')->count())->toBe(0); expect(pest()->valuestore->get('tenant_id'))->toBe('The current tenant id is: ' . $tenant->id); // job succeeded @@ -182,6 +193,22 @@ test('the tenant used by the job doesnt change when the current tenant changes', expect(pest()->valuestore->get('tenant_id'))->toBe('The current tenant id is: acme'); }); +test('tenant connections do not persist after tenant jobs get processed', function() { + withTenantDatabases(); + + $tenant = Tenant::create(); + + tenancy()->initialize($tenant); + + dispatch(new TestJob(pest()->valuestore)); + + tenancy()->end(); + + pest()->artisan('queue:work --once'); + + expect(collect(DB::select('SHOW FULL PROCESSLIST'))->pluck('db'))->not()->toContain($tenant->database()->getName()); +}); + function createValueStore(): void { $valueStorePath = __DIR__ . '/Etc/tmp/queuetest.json'; diff --git a/tests/TestCase.php b/tests/TestCase.php index 20ecdfee..36d5fc9f 100644 --- a/tests/TestCase.php +++ b/tests/TestCase.php @@ -9,6 +9,7 @@ use Dotenv\Dotenv; use Stancl\Tenancy\Facades\Tenancy; use Stancl\Tenancy\Tests\Etc\Tenant; use Illuminate\Support\Facades\Redis; +use Stancl\Tenancy\Bootstrappers\PrefixCacheTenancyBootstrapper; use Illuminate\Foundation\Application; use Stancl\Tenancy\Facades\GlobalCache; use Stancl\Tenancy\TenancyServiceProvider; @@ -118,6 +119,7 @@ abstract class TestCase extends \Orchestra\Testbench\TestCase ]); $app->singleton(RedisTenancyBootstrapper::class); // todo (Samuel) use proper approach eg config for singleton registration + $app->singleton(PrefixCacheTenancyBootstrapper::class); // todo (Samuel) use proper approach eg config for singleton registration $app->singleton(BroadcastTenancyBootstrapper::class); $app->singleton(MailTenancyBootstrapper::class); $app->singleton(UrlTenancyBootstrapper::class);