archtechx/tenancy
1
0
Fork 0
mirror of https://github.com/archtechx/tenancy.git synced 2026-08-06 06:54:03 +00:00
Code Activity

Improve comments in the FS bootstrapper test file (delete notes about regression)

Browse source
This commit is contained in:
lukinovec 2026-08-03 13:24:03 +02:00
parent be1e8aa8d4
commit aabba924ff
1 changed files with 10 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

25
tests/Bootstrappers/FilesystemTenancyBootstrapperTest.php
View file

@ -301,13 +301,12 @@ test('scoped disks are scoped per tenant', function () {
}); });
test('file cache stores are separated per tenant', function () { test('file cache stores are separated per tenant', function () {
// NOTE ABOUT REGRESSION: this is not a regression test,
// this just covers what wasn't covered before.
config([ config([
'tenancy.bootstrappers' => [ 'tenancy.bootstrappers' => [
FilesystemTenancyBootstrapper::class, FilesystemTenancyBootstrapper::class,
], ],
'tenancy.cache.stores' => ['file'], 'tenancy.cache.stores' => ['file'],
// Laravel's default 'file' store config (set explicitly here just for clarity).
'cache.stores.file' => [ 'cache.stores.file' => [
'driver' => 'file', 'driver' => 'file',
'path' => storage_path('framework/cache/data'), 'path' => storage_path('framework/cache/data'),
@ -369,8 +368,7 @@ test('central cache is not lost when tenancy ends', function () {
tenancy()->end(); tenancy()->end();
// Nothing deleted the 'foo' entry, so its value should stay 'central' even after reverting tenancy. // Nothing deleted the 'foo' entry, so its value should stay 'central' even after reverting tenancy.
// NOTE ABOUT REGRESSION: revert() sets the store to the hardcoded storage/framework/cache/data instead of // FilesystemTenancyBootstrapper::revert() makes the store use its original configured path.
// setting it to whatever it was before initializing tenancy. So the central 'foo' entry is null.
expect(Cache::store('foo_file')->get('foo'))->toBe('central'); expect(Cache::store('foo_file')->get('foo'))->toBe('central');
File::deleteDirectory($path); File::deleteDirectory($path);
@ -405,9 +403,8 @@ test('file cache stores with different configured paths do not share a directory
Cache::store('foo_file')->put('key', 'foo'); Cache::store('foo_file')->put('key', 'foo');
Cache::store('bar_file')->put('key', 'bar'); Cache::store('bar_file')->put('key', 'bar');
// NOTE ABOUT REGRESSION: both stores are pointed at the same path, // Each store uses its own directory in the tenant's context, so they don't read or overwrite
// so they overwrite and read each other's entries. // each other's entries, and flushing one doesn't empty the other.
// For the same reason, flushing one of them empties the other.
expect(Cache::store('foo_file')->get('key'))->toBe('foo'); expect(Cache::store('foo_file')->get('key'))->toBe('foo');
expect(Cache::store('bar_file')->get('key'))->toBe('bar'); expect(Cache::store('bar_file')->get('key'))->toBe('bar');
@ -455,8 +452,8 @@ test('a configured lock_path is scoped separately from path', function () {
$tenantPath = "{$centralStoragePath}/tenant{$tenant->id}/framework/cache/foo"; $tenantPath = "{$centralStoragePath}/tenant{$tenant->id}/framework/cache/foo";
$tenantLockPath = "{$centralStoragePath}/tenant{$tenant->id}/framework/cache/foo_locks"; $tenantLockPath = "{$centralStoragePath}/tenant{$tenant->id}/framework/cache/foo_locks";
// NOTE ABOUT REGRESSION: path and lock_path both get hardcoded to the same default directory // Taking the lock creates the tenant's scoped lock_path directory.
// instead of the ones configured here, so this lock directory never gets created. // Nothing wrote a cache entry, so the tenant's scoped path directory doesn't exist (path and lock_path are scoped separately).
expect(File::isDirectory($tenantLockPath))->toBeTrue(); expect(File::isDirectory($tenantLockPath))->toBeTrue();
expect(File::isDirectory($tenantPath))->toBeFalse(); expect(File::isDirectory($tenantPath))->toBeFalse();
@ -464,8 +461,7 @@ test('a configured lock_path is scoped separately from path', function () {
expect(Cache::store('foo_file')->lock('foo')->get())->toBeTrue(); expect(Cache::store('foo_file')->lock('foo')->get())->toBeTrue();
// NOTE ABOUT REGRESSION: revert() has the same hardcoding bug, so lock_path is never restored // After reverting, locks go back to the configured central lock_path.
// to what it was configured with either.
expect(File::isDirectory($lockPath))->toBeTrue(); expect(File::isDirectory($lockPath))->toBeTrue();
File::deleteDirectory($path); File::deleteDirectory($path);
@ -537,10 +533,9 @@ test('a cache store using a path not based on storage_path() is suffixed in plac
expect(File::isDirectory("{$path}/tenant{$tenant1->id}"))->toBeTrue(); expect(File::isDirectory("{$path}/tenant{$tenant1->id}"))->toBeTrue();
// NOTE ABOUT REGRESSION: storage_path() is already scoped to tenant1 here (storagePath() runs // storage_path() is already scoped to tenant1 here (storagePath() runs before scopeCache() in
// before scopeCache() in bootstrap()), so this is the tenant's default cache directory // bootstrap()), so this is the tenant's default cache directory. Nothing should be there, since
// the code points every store's cache at, regardless of its configured path. It should stay // foo_file is configured with its own $path that isn't storage_path()-based.
// empty here, since foo_file is configured with its own $path that's not storage_path()-based.
expect(File::isDirectory(storage_path('framework/cache/data')))->toBeFalse(); expect(File::isDirectory(storage_path('framework/cache/data')))->toBeFalse();
tenancy()->end(); tenancy()->end();