mirror of
https://github.com/archtechx/tenancy.git
synced 2025-12-12 12:44:02 +00:00
Central routes without Route::domain(), configurable tenant/central routes by default for domain/subdomain identification, allow accessing central routes in early identification for path & request data middleware (#3)
* Update url binding bootstrapper test * Fix parent::temporarySignedRoute() call * Add universal route tests for all identification types * Improve determineContextFromRequest() * Add setting `TenancyUrlGenerator::$prefixRouteNames` to true in TSP stub * Delete seemingly redundant test (making one route universal won't make all routes universal in any case) * Use collection syntax in ReregisterUniversalRoutes * Improve comments * Add domain identification MW annotation * Update condition in GloballyUsable * Set `tenancy.bootstrappers` instead of adding the bootstrappers using `tenancy.bootstrappers.x`, move test * Revert GloballyUsable condition change * Delete assigning bootstrappers to tenancy.bootstrappers.x * Exclude cache prefixing bootstrapper from the initial configuration * Fix test * Unset bypass parameter * Set static kernel identification-related properties in TestCase * Update bootstrapper name in annotation * Move unset() into a condition * Update TenancyUrlGenerator condition * Set static properties without instantiating Tenancy * Fix unsetting bypass parameter * formatting changes * add a comment * improve docblock * add docblock to TenancyUrlGenerator [ci skip] * docblock changes [ci skip] * Update TenancyUrlGenerator (rename variable, allow bypassing prefixing temporarySignedRoute name) * Improve determineContextFromRequest * Only return the new url generator instance when extending 'url' in UrlBindingBootstrapper * Check route's MW groups for the path ID MW * Remove extra imports from config * Rename MiddlewareContext to Context, add condition for skipping ID MW * Set only the needed bootstrappers in TestCase * Fix code style (php-cs-fixer) * Remove condition * Use correct return type * Fix PHPStan issue * Update comment * Check for tenant parameter instead of prefix * Update shouldBeSkipped condition for universal routes * Don't remove the 'universal' MW group after route re-registration, update test * Fix code style (php-cs-fixer) * Fix typo * Add test for mixing placement of access prevention and identification MW * Add test for mixing placement of access prevention and identification MW * Update docblock * Add setting the session and key resolvers in UrlBindingBootstrapper (required with LW file uploads) * Update stub * Update variable name in route reregistering action * Add trailing comma * Fix code style (php-cs-fixer) * Require routes using path identification to be flagged as tenant in order to be recognized as tenant routes * Add tenant flag while re-registering routes * Update determineContextFromRequest condition (wip) * Fix code style (php-cs-fixer) * Update the middleware context logic so that universal routes have to be flagged as tenant instead of just having ID MW * Update path identification condition * Fix re-registering the LW localized route (add 'tenant' MW) * Update docblock * Simplify LW route re-registration * Add comment * Update comment * Simplify determineContextFromRequest, add comment * Improve stub * Add skipRoute method + test * Fix typo * Update assets/TenancyServiceProvider.stub.php * Update src/Concerns/DealsWithEarlyIdentification.php * Fix typo Co-authored-by: Samuel Štancl <samuel.stancl@gmail.com> * Improve comment * Update test structure * Restructure Fortify test * code style * Fix typo * Update ReregisterUniversalRoutes annotation * Only prefix route name if it wasn't already prefixed * Add todo@docs * Delete `Tenancy::$kernelAccessPreventionSkipped` and related logic * Delete test tenant cleanup * Test MW group unpacking, restructure and improve test * Test that tenancy isn't initialized after visiting a central route with the tenant parameter * Delete "in both central and tenant contexts" from test names * Test that re-registering works with controllers too * Set misc route properties during re-registering * Determine context instead of guessing, update universal route tests * Use randomly generated tenant ID instead of hardcoding `acme` * Remove setting route validators * Rename and update determine context method, add comments * Update ForgetTenantParameter annotation * Add comment * Delete comment, delete variable assignment * Update early domain identification test * Improve domain identification tests (test defaulting accurately) * Improve readability * Simplify domain early ID test * Use randomly generated tenant instead of 'acme' * Simplify request data ID test, use random tenant instead of 'acme' * Simplify defaulting domain identification test * Use RouteFacade alias for the Route facade, improve test code * Add defaulting to the request data and path ID tests * Merge path identification tenant parameter removal tests, clean up * Correct wording Co-authored-by: Samuel Štancl <samuel.stancl@gmail.com> * Delete debugging things from UniversalRouteTest * Update annotation * Add `// Creates a matrix` * Improve comment wording * Add MiddlewareUsableWithUniversalRoutes, refactor code accordingly * Fix code style (php-cs-fixer) * Delete debugging leftovers * Delete unused import * Update universal route GloballyUsable condition * Don't implement the universal route interface in access prevention MW * Check if request host is in the central domains in domain ID MW * Test universal routes with domain identification without access prevent MW * Test that universal routes work only with identification MW implementing the universal route interface * Fix code style (php-cs-fixer) * Rename GloballyUsable to UsableWithEarlyIdentification * Fix annotation * Update requestHasTenant annotations * Update comment * Add `with()` comments * Add with() comments where missing * Rename interface, update/add comments * Rename exception, update its default message * Fix code style (php-cs-fixer) * Fix interface name * Delete redundant code from subdomain ID MW * Change domainOrSubdomain ID MW so that instead of passing the identification to other MWs, it happens in the domainOrSubdomain MW * Test domainOrSubdomain identification with universal routes * Fix code style (php-cs-fixer) * Rename universal routes interface * Fix code style (php-cs-fixer) * Try explaining forgetting the tenant parameter better * update interface name reference * uncouple example from query parameters * Update ForgetTenantParameter.php * Update ForgetTenantParameter annotation * Check both routeHasMiddleware and routeHasIdentificationMiddleware in the route MW detection test * Hardcode tenant subdomain * Delete redundant event listening code * Delete unused imports * Delete misuse of `tenancy()->getMiddlewareContext()` from conditions * Delete unused variable * Update comment * Correct request data identification test (defaulting) * Fix defaulting in path id test * Move default route context configuration in domian id test * Rename and update the tenant parameter test * Delete extra tenant parameter test * Use `tenant-domain.test` instead of `127.0.0.2` * Add `default_to_universal_routes` config key * Deal with defaulting to universal routes in the reregistering action * Update logic to make defaulting to universal routes possible * Test defaulting to universal routes * Fix code style (php-cs-fixer) * Delete extra tests * Delete "without access prevention" from datasets * Add defaulting to universal routes to datasets * Override universal flag by central/tenant flag * Add universal flag overriding test * Update "a route can be universal in both route modes" so that the name corresponds with the tested thing * Ignore the PHPStan error * Reset `InitializeTenancyByPath::$onFail` in PathIdentificationTest * Simplify expression * Use 'Tenancy (not) initialized.' in instead of `tenant()?->getTenantKey()` for better assertions * Properly test removing tenant parameter * Reset static properties in tests * Correct comments in EarlyIdentificationTest * Add comment * Add detail to annotation * Throw exception if payload isn't string or null in request data ID MW * Fix code style (php-cs-fixer) * Delete static `$kernelIdentificationSkipped` property, use `$request->attributes` instead * Use 'default_route_mode' instead of 'default_to_tenant/universal_routes' * Fix code style (php-cs-fixer) * Make path identification MW, tenantParameterName and tenantRouteNamePrefix configurable in ReregisterUniversalRoutes * Delete unused import * Add `$passTenantParameterToRoute` to TenancyUrlGenerator * Use `$passTenantParameterToRoute` in BootstrapperTest * Bypass tenant parameter passing * Improve TenancyUrlGenerator so that both ID methods work * Fix code style (php-cs-fixer) * Improve TenancyUrlGenerator readability * Add modifyBehavior() to TenancyUrlGenerator * Fix code style (php-cs-fixer) * Improve comment * Toggle route name prefixing in path/request data ID MW (route-level identification) * Fix code style (php-cs-fixer) * Add path identification MW config key, add `getTenantParameterName()` to ForgetTenantParameter * Fix code style (php-cs-fixer) * Fix modifyBehavior and routeBehaviorModificationBypassed * Add type to `$parameters` parameter * Split modifyBehavior into two methods, don't pass name and parameters by reference * Update UrlBindingBootstrapper annotation * Correct naming in tests (request data -> query string identification) * Add info to annotation * Pass arrays to the behavior modification methods instead of `mixed` * Fix default value of static property in Fortify bootstrapper * Fix code style (php-cs-fixer) * Correct annotation * Enable prefixing routes directly using path identification MW * Test re-registration of routes with path ID MW * Prefix names of routes directly using path ID MW * Fix code style (php-cs-fixer) * Add Livewire v3 integration example to TSP stub * Prefix route name only if it's not prefixed already * Rename ReregisterUniversalRoutes to ReregisterRoutesAsTenant * Fix code style (php-cs-fixer) * Improve ReregisterRoutesAsTenant * Add/update TenancyUrlGenerator docblocks * Update action name in comments/test names * Update reregister action annotation * Delete unused imports * Improve comments * Make method protected * Improve TenancyUrlGenerator code * Test bypass parameter removal * Fix comment * Update annotation * Improve shouldReregisterRoute * Fix typo, delete redundant comment * Improve skipRoute * Improve shouldBeSkipped * Add and test `$passTenantParameterToRoutes` * add a comment * Fix typo in comment * Pass array as $parameters in prepareRouteInputs * Make path_identification_middleware an array * Fix code style (php-cs-fixer) * Fix ReregisterRouteAsTenant * Move tenantParameterName and tenantRouteNamePrefix getting to PathIdentificationManager * Make PathIdentificationManager properties `Closure|null` * Fix code style (php-cs-fixer) * Fix PathIdentificationManager * Update comments * Use foreach for dataset definition * Extract repetitive inGlobalStack and routeHasMiddleware calls * Refactor PathIdentificationManager * Update TenancyUrlGenerator annotation * Add $skippedRoutes, refactor ReregisterRoutesAsTenant * Improve reregisterRoute * Update re-register action annotation * update test name * Make PathIdentificationManager methods static again, update comments * Add test comment * Update ForgetTenantParameter annotation * Improve route re-registration condition, add comment * Change "re-register" to "clone" * minor code improvements --------- Co-authored-by: lukinovec <lukinovec@gmail.com> Co-authored-by: Samuel Štancl <samuel.stancl@gmail.com> Co-authored-by: PHP CS Fixer <phpcsfixer@example.com>
This commit is contained in:
parent
bd9bbe8b41
commit
1d0ca27bc8
53 changed files with 2668 additions and 271 deletions
|
|
@ -37,7 +37,7 @@ test('create storage symlinks action works', function() {
|
|||
|
||||
$this->assertDirectoryDoesNotExist($publicPath = public_path("public-$tenantKey"));
|
||||
|
||||
CreateStorageSymlinksAction::handle($tenant);
|
||||
(new CreateStorageSymlinksAction)($tenant);
|
||||
|
||||
$this->assertDirectoryExists($publicPath);
|
||||
$this->assertEquals(storage_path("app/public/"), readlink($publicPath));
|
||||
|
|
@ -59,11 +59,11 @@ test('remove storage symlinks action works', function() {
|
|||
|
||||
tenancy()->initialize($tenant);
|
||||
|
||||
CreateStorageSymlinksAction::handle($tenant);
|
||||
(new CreateStorageSymlinksAction)($tenant);
|
||||
|
||||
$this->assertDirectoryExists($publicPath = public_path("public-$tenantKey"));
|
||||
|
||||
RemoveStorageSymlinksAction::handle($tenant);
|
||||
(new RemoveStorageSymlinksAction)($tenant);
|
||||
|
||||
$this->assertDirectoryDoesNotExist($publicPath);
|
||||
});
|
||||
|
|
|
|||
|
|
@ -15,6 +15,7 @@ use Illuminate\Support\Facades\Route;
|
|||
use Illuminate\Support\Facades\Storage;
|
||||
use Stancl\Tenancy\Events\TenancyEnded;
|
||||
use Stancl\Tenancy\Jobs\CreateDatabase;
|
||||
use Stancl\Tenancy\TenancyUrlGenerator;
|
||||
use Stancl\Tenancy\Events\TenantCreated;
|
||||
use Stancl\Tenancy\Events\TenantDeleted;
|
||||
use Stancl\Tenancy\Events\DeletingTenant;
|
||||
|
|
@ -22,6 +23,7 @@ use Stancl\Tenancy\TenancyBroadcastManager;
|
|||
use Illuminate\Filesystem\FilesystemAdapter;
|
||||
use Illuminate\Broadcasting\BroadcastManager;
|
||||
use Stancl\Tenancy\Events\TenancyInitialized;
|
||||
use Illuminate\Contracts\Routing\UrlGenerator;
|
||||
use Stancl\Tenancy\Jobs\CreateStorageSymlinks;
|
||||
use Stancl\Tenancy\Jobs\RemoveStorageSymlinks;
|
||||
use Stancl\Tenancy\Listeners\BootstrapTenancy;
|
||||
|
|
@ -31,12 +33,16 @@ use Stancl\Tenancy\Listeners\RevertToCentralContext;
|
|||
use Stancl\Tenancy\Bootstrappers\CacheTagsBootstrapper;
|
||||
use Stancl\Tenancy\Bootstrappers\UrlTenancyBootstrapper;
|
||||
use Stancl\Tenancy\Bootstrappers\MailTenancyBootstrapper;
|
||||
use Stancl\Tenancy\Bootstrappers\UrlBindingBootstrapper;
|
||||
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;
|
||||
use Stancl\Tenancy\Bootstrappers\Integrations\FortifyRouteTenancyBootstrapper;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyByPath;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyByRequestData;
|
||||
|
||||
beforeEach(function () {
|
||||
$this->mockConsoleOutput = false;
|
||||
|
|
@ -65,12 +71,11 @@ afterEach(function () {
|
|||
PrefixCacheTenancyBootstrapper::$tenantCacheStores = [];
|
||||
TenancyBroadcastManager::$tenantBroadcasters = ['pusher', 'ably'];
|
||||
BroadcastTenancyBootstrapper::$credentialsMap = [];
|
||||
TenancyUrlGenerator::$prefixRouteNames = false;
|
||||
});
|
||||
|
||||
test('database data is separated', function () {
|
||||
config(['tenancy.bootstrappers' => [
|
||||
DatabaseTenancyBootstrapper::class,
|
||||
]]);
|
||||
config(['tenancy.bootstrappers' => [DatabaseTenancyBootstrapper::class]]);
|
||||
|
||||
$tenant1 = Tenant::create();
|
||||
$tenant2 = Tenant::create();
|
||||
|
|
@ -352,6 +357,8 @@ test('local storage public urls are generated correctly', function() {
|
|||
});
|
||||
|
||||
test('BroadcastTenancyBootstrapper binds TenancyBroadcastManager to BroadcastManager and reverts the binding when tenancy is ended', function() {
|
||||
config(['tenancy.bootstrappers' => [BroadcastTenancyBootstrapper::class]]);
|
||||
|
||||
expect(app(BroadcastManager::class))->toBeInstanceOf(BroadcastManager::class);
|
||||
|
||||
tenancy()->initialize(Tenant::create());
|
||||
|
|
@ -367,6 +374,7 @@ test('BroadcastTenancyBootstrapper maps tenant broadcaster credentials to config
|
|||
config([
|
||||
'broadcasting.connections.testing.driver' => 'testing',
|
||||
'broadcasting.connections.testing.message' => $defaultMessage = 'default',
|
||||
'tenancy.bootstrappers' => [BroadcastTenancyBootstrapper::class],
|
||||
]);
|
||||
|
||||
BroadcastTenancyBootstrapper::$credentialsMap = [
|
||||
|
|
@ -395,6 +403,7 @@ test('BroadcastTenancyBootstrapper makes the app use broadcasters with the corre
|
|||
'broadcasting.default' => 'testing',
|
||||
'broadcasting.connections.testing.driver' => 'testing',
|
||||
'broadcasting.connections.testing.message' => $defaultMessage = 'default',
|
||||
'tenancy.bootstrappers' => [BroadcastTenancyBootstrapper::class],
|
||||
]);
|
||||
|
||||
TenancyBroadcastManager::$tenantBroadcasters[] = 'testing';
|
||||
|
|
@ -436,7 +445,8 @@ test('MailTenancyBootstrapper maps tenant mail credentials to config as specifie
|
|||
config([
|
||||
'mail.default' => 'smtp',
|
||||
'mail.mailers.smtp.username' => $defaultUsername = 'default username',
|
||||
'mail.mailers.smtp.password' => 'no password'
|
||||
'mail.mailers.smtp.password' => 'no password',
|
||||
'tenancy.bootstrappers' => [MailTenancyBootstrapper::class],
|
||||
]);
|
||||
|
||||
$tenant = Tenant::create(['smtp_password' => $password = 'testing password']);
|
||||
|
|
@ -454,7 +464,11 @@ test('MailTenancyBootstrapper maps tenant mail credentials to config as specifie
|
|||
|
||||
test('MailTenancyBootstrapper reverts the config and mailer credentials to default when tenancy ends', function() {
|
||||
MailTenancyBootstrapper::$credentialsMap = ['mail.mailers.smtp.password' => 'smtp_password'];
|
||||
config(['mail.default' => 'smtp', 'mail.mailers.smtp.password' => $defaultPassword = 'no password']);
|
||||
config([
|
||||
'mail.default' => 'smtp',
|
||||
'mail.mailers.smtp.password' => $defaultPassword = 'no password',
|
||||
'tenancy.bootstrappers' => [MailTenancyBootstrapper::class],
|
||||
]);
|
||||
|
||||
tenancy()->initialize(Tenant::create(['smtp_password' => $tenantPassword = 'testing password']));
|
||||
|
||||
|
|
@ -470,18 +484,8 @@ test('MailTenancyBootstrapper reverts the config and mailer credentials to defau
|
|||
assertMailerTransportUsesPassword($defaultPassword);
|
||||
});
|
||||
|
||||
function getDiskPrefix(string $disk): string
|
||||
{
|
||||
/** @var FilesystemAdapter $disk */
|
||||
$disk = Storage::disk($disk);
|
||||
$adapter = $disk->getAdapter();
|
||||
$prefix = invade(invade($adapter)->prefixer)->prefix;
|
||||
|
||||
return $prefix;
|
||||
}
|
||||
|
||||
test('url bootstrapper overrides the root url when tenancy gets initialized and reverts the url to the central one after tenancy ends', function() {
|
||||
config(['tenancy.bootstrappers.url' => UrlTenancyBootstrapper::class]);
|
||||
config(['tenancy.bootstrappers' => [UrlTenancyBootstrapper::class]]);
|
||||
|
||||
Route::group([
|
||||
'middleware' => InitializeTenancyBySubdomain::class,
|
||||
|
|
@ -524,3 +528,106 @@ test('url bootstrapper overrides the root url when tenancy gets initialized and
|
|||
expect(URL::to('/'))->toBe($baseUrl);
|
||||
expect(config('app.url'))->toBe($baseUrl);
|
||||
});
|
||||
|
||||
test('url binding tenancy bootstrapper swaps the url generator instance correctly', function() {
|
||||
config(['tenancy.bootstrappers' => [UrlBindingBootstrapper::class]]);
|
||||
|
||||
tenancy()->initialize(Tenant::create());
|
||||
expect(app('url'))->toBeInstanceOf(TenancyUrlGenerator::class);
|
||||
expect(url())->toBeInstanceOf(TenancyUrlGenerator::class);
|
||||
|
||||
tenancy()->end();
|
||||
expect(app('url'))->toBeInstanceOf(UrlGenerator::class);
|
||||
expect(url())->toBeInstanceOf(UrlGenerator::class);
|
||||
});
|
||||
|
||||
test('url binding tenancy bootstrapper changes route helper behavior correctly', function() {
|
||||
Route::get('/central/home', fn () => route('home'))->name('home');
|
||||
// Tenant route name prefix is 'tenant.' by default
|
||||
Route::get('/{tenant}/home', fn () => route('tenant.home'))->name('tenant.home')->middleware(['tenant', InitializeTenancyByPath::class]);
|
||||
Route::get('/query-string', fn () => route('query-string'))->name('query-string')->middleware(['tenant', InitializeTenancyByRequestData::class]);
|
||||
|
||||
$tenant = Tenant::create();
|
||||
$tenantKey = $tenant->getTenantKey();
|
||||
$centralRouteUrl = route('home');
|
||||
$tenantRouteUrl = route('tenant.home', ['tenant' => $tenantKey]);
|
||||
$queryStringCentralUrl = route('query-string');
|
||||
$queryStringTenantUrl = route('query-string', ['tenant' => $tenantKey]);
|
||||
TenancyUrlGenerator::$bypassParameter = 'bypassParameter';
|
||||
$bypassParameter = TenancyUrlGenerator::$bypassParameter;
|
||||
|
||||
config(['tenancy.bootstrappers' => [UrlBindingBootstrapper::class]]);
|
||||
TenancyUrlGenerator::$prefixRouteNames = true;
|
||||
|
||||
tenancy()->initialize($tenant);
|
||||
// The $prefixRouteNames property is true
|
||||
// The route name passed to the route() helper ('home') gets prefixed prefixed with 'tenant.' automatically
|
||||
expect(route('home'))->toBe($tenantRouteUrl);
|
||||
|
||||
// The 'tenant.home' route name doesn't get prefixed because it is already prefixed with 'tenant.'
|
||||
// Also, the route receives the tenant parameter automatically
|
||||
expect(route('tenant.home'))->toBe($tenantRouteUrl);
|
||||
|
||||
// The $bypassParameter parameter ('central' by default) can bypass the route name prefixing
|
||||
// When the bypass parameter is true, the generated route URL points to the route named 'home'
|
||||
// Also, check if the bypass parameter gets removed from the generated URL query string
|
||||
expect(route('home', [$bypassParameter => true]))->toBe($centralRouteUrl)
|
||||
->not()->toContain($bypassParameter);
|
||||
// When the bypass parameter is false, the generated route URL points to the prefixed route ('tenant.home')
|
||||
expect(route('home', [$bypassParameter => false]))->toBe($tenantRouteUrl)
|
||||
->not()->toContain($bypassParameter);
|
||||
|
||||
TenancyUrlGenerator::$prefixRouteNames = false;
|
||||
// Route names don't get prefixed – TenancyUrlGenerator::$prefixRouteNames is false
|
||||
expect(route('home', [$bypassParameter => true]))->toBe($centralRouteUrl);
|
||||
expect(route('query-string'))->toBe($queryStringTenantUrl);
|
||||
|
||||
TenancyUrlGenerator::$passTenantParameterToRoutes = false;
|
||||
expect(route('query-string'))->toBe($queryStringCentralUrl);
|
||||
|
||||
TenancyUrlGenerator::$passTenantParameterToRoutes = true;
|
||||
expect(route('query-string'))->toBe($queryStringTenantUrl);
|
||||
|
||||
// Ending tenancy reverts route() behavior changes
|
||||
tenancy()->end();
|
||||
|
||||
expect(route('home'))->toBe($centralRouteUrl);
|
||||
expect(route('query-string'))->toBe($queryStringCentralUrl);
|
||||
expect(route('tenant.home', ['tenant' => $tenantKey]))->toBe($tenantRouteUrl);
|
||||
|
||||
// Route-level identification
|
||||
pest()->get("http://localhost/central/home")->assertSee($centralRouteUrl);
|
||||
pest()->get("http://localhost/$tenantKey/home")->assertSee($tenantRouteUrl);
|
||||
pest()->get("http://localhost/query-string?tenant=$tenantKey")->assertSee($queryStringTenantUrl);
|
||||
})->group('string');
|
||||
|
||||
test('fortify route tenancy bootstrapper updates fortify config correctly', function() {
|
||||
config(['tenancy.bootstrappers' => [FortifyRouteTenancyBootstrapper::class]]);
|
||||
|
||||
Route::get('/', function () {
|
||||
return true;
|
||||
})->name($tenantHomeRouteName = 'tenant.home');
|
||||
|
||||
FortifyRouteTenancyBootstrapper::$fortifyHome = $tenantHomeRouteName;
|
||||
FortifyRouteTenancyBootstrapper::$fortifyRedirectTenantMap = ['logout' => FortifyRouteTenancyBootstrapper::$fortifyHome];
|
||||
$originalFortifyHome = config('fortify.home');
|
||||
$originalFortifyRedirects = config('fortify.redirects');
|
||||
|
||||
tenancy()->initialize(Tenant::create());
|
||||
expect(config('fortify.home'))->toBe($homeUrl = route($tenantHomeRouteName));
|
||||
expect(config('fortify.redirects'))->toBe(['logout' => $homeUrl]);
|
||||
|
||||
tenancy()->end();
|
||||
expect(config('fortify.home'))->toBe($originalFortifyHome);
|
||||
expect(config('fortify.redirects'))->toBe($originalFortifyRedirects);
|
||||
});
|
||||
|
||||
function getDiskPrefix(string $disk): string
|
||||
{
|
||||
/** @var FilesystemAdapter $disk */
|
||||
$disk = Storage::disk($disk);
|
||||
$adapter = $disk->getAdapter();
|
||||
$prefix = invade(invade($adapter)->prefixer)->prefix;
|
||||
|
||||
return $prefix;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -12,9 +12,11 @@ use Stancl\Tenancy\Listeners\BootstrapTenancy;
|
|||
use Stancl\Tenancy\Tests\Etc\TestingBroadcaster;
|
||||
use Stancl\Tenancy\Listeners\RevertToCentralContext;
|
||||
use Illuminate\Contracts\Broadcasting\Broadcaster as BroadcasterContract;
|
||||
use Stancl\Tenancy\Bootstrappers\BroadcastTenancyBootstrapper;
|
||||
|
||||
beforeEach(function () {
|
||||
withTenantDatabases();
|
||||
config(['tenancy.bootstrappers' => [BroadcastTenancyBootstrapper::class]]);
|
||||
TenancyBroadcastManager::$tenantBroadcasters = ['pusher', 'ably'];
|
||||
Event::listen(TenancyInitialized::class, BootstrapTenancy::class);
|
||||
Event::listen(TenancyEnded::class, RevertToCentralContext::class);
|
||||
|
|
|
|||
|
|
@ -25,6 +25,13 @@ beforeEach(function () {
|
|||
'tenancy.database.template_tenant_connection' => 'mysql',
|
||||
]);
|
||||
|
||||
// Reset static property
|
||||
PermissionControlledMySQLDatabaseManager::$grants = [
|
||||
'ALTER', 'ALTER ROUTINE', 'CREATE', 'CREATE ROUTINE', 'CREATE TEMPORARY TABLES', 'CREATE VIEW',
|
||||
'DELETE', 'DROP', 'EVENT', 'EXECUTE', 'INDEX', 'INSERT', 'LOCK TABLES', 'REFERENCES', 'SELECT',
|
||||
'SHOW VIEW', 'TRIGGER', 'UPDATE',
|
||||
];
|
||||
|
||||
Event::listen(TenantCreated::class, JobPipeline::make([CreateDatabase::class])->send(function (TenantCreated $event) {
|
||||
return $event->tenant;
|
||||
})->toListener());
|
||||
|
|
@ -82,6 +89,13 @@ test('correct grants are given to users', function () {
|
|||
|
||||
$query = DB::connection('mysql')->select("SHOW GRANTS FOR `{$tenant->database()->getUsername()}`@`%`")[1];
|
||||
expect($query->{"Grants for {$user}@%"})->toStartWith('GRANT CREATE, ALTER, ALTER ROUTINE ON'); // @mysql because that's the hostname within the docker network
|
||||
|
||||
// Reset static property
|
||||
PermissionControlledMySQLDatabaseManager::$grants = [
|
||||
'ALTER', 'ALTER ROUTINE', 'CREATE', 'CREATE ROUTINE', 'CREATE TEMPORARY TABLES', 'CREATE VIEW',
|
||||
'DELETE', 'DROP', 'EVENT', 'EXECUTE', 'INDEX', 'INSERT', 'LOCK TABLES', 'REFERENCES', 'SELECT',
|
||||
'SHOW VIEW', 'TRIGGER', 'UPDATE',
|
||||
];
|
||||
});
|
||||
|
||||
test('having existing databases without users and switching to permission controlled mysql manager doesnt break existing dbs', function () {
|
||||
|
|
|
|||
|
|
@ -2,83 +2,214 @@
|
|||
|
||||
declare(strict_types=1);
|
||||
|
||||
use Illuminate\Support\Arr;
|
||||
use Illuminate\Routing\Route;
|
||||
use Stancl\Tenancy\RouteMode;
|
||||
use Stancl\Tenancy\Tests\Etc\Tenant;
|
||||
use Illuminate\Contracts\Http\Kernel;
|
||||
use Illuminate\Support\Facades\Event;
|
||||
use Illuminate\Support\Facades\Route;
|
||||
use Stancl\Tenancy\Events\TenancyInitialized;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyByDomain;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyByDomainOrSubdomain;
|
||||
use Illuminate\Support\Facades\Route as RouteFacade;
|
||||
use Stancl\Tenancy\Actions\CloneRoutesAsTenant;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyByPath;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyByRequestData;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyByDomain;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyBySubdomain;
|
||||
use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyByRequestData;
|
||||
use Stancl\Tenancy\Tests\Etc\EarlyIdentification\Models\Post;
|
||||
use Stancl\Tenancy\Middleware\PreventAccessFromUnwantedDomains;
|
||||
use Stancl\Tenancy\Tests\Etc\EarlyIdentification\Controller;
|
||||
use Stancl\Tenancy\Tests\Etc\Tenant;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyByDomainOrSubdomain;
|
||||
use Stancl\Tenancy\Tests\Etc\EarlyIdentification\ControllerWithMiddleware;
|
||||
use Stancl\Tenancy\Tests\Etc\EarlyIdentification\ControllerWithRouteMiddleware;
|
||||
|
||||
beforeEach(function () {
|
||||
config()->set([
|
||||
'tenancy.token' => 'central-abc123',
|
||||
'tenancy.test_service_token' => 'token:central',
|
||||
]);
|
||||
|
||||
Event::listen(TenancyInitialized::class, function (TenancyInitialized $event) {
|
||||
config()->set([
|
||||
'tenancy.token' => $event->tenancy->tenant->getTenantKey() . '-abc123',
|
||||
'tenancy.test_service_token' => 'token:' . $event->tenancy->tenant->getTenantKey(),
|
||||
]);
|
||||
});
|
||||
});
|
||||
|
||||
test('early identification works with path identification', function () {
|
||||
app(Kernel::class)->pushMiddleware(InitializeTenancyByPath::class);
|
||||
test('early identification works with path identification', function (bool $useKernelIdentification, RouteMode $defaultRouteMode) {
|
||||
$identificationMiddleware = InitializeTenancyByPath::class;
|
||||
|
||||
Route::group([
|
||||
'prefix' => '/{tenant}',
|
||||
], function () {
|
||||
Route::get('/foo', [Controller::class, 'index'])->name('foo');
|
||||
});
|
||||
|
||||
Tenant::create([
|
||||
'id' => 'acme',
|
||||
]);
|
||||
|
||||
$response = pest()->get('/acme/foo')->assertOk();
|
||||
|
||||
assertTenancyInitializedInEarlyIdentificationRequest($response->getContent());
|
||||
|
||||
// check if default parameter feature is working fine by asserting that the route WITHOUT the tenant parameter
|
||||
// matches the route WITH the tenant parameter
|
||||
expect(route('foo'))->toBe(route('foo', ['tenant' => 'acme']));
|
||||
});
|
||||
|
||||
test('early identification works with request data identification', function (string $type) {
|
||||
app(Kernel::class)->pushMiddleware(InitializeTenancyByRequestData::class);
|
||||
|
||||
Route::get('/foo', [Controller::class, 'index'])->name('foo');
|
||||
|
||||
$tenant = Tenant::create([
|
||||
'id' => 'acme',
|
||||
]);
|
||||
|
||||
if ($type === 'header') {
|
||||
$response = pest()->get('/foo', ['X-Tenant' => $tenant->id])->assertOk();
|
||||
} elseif ($type === 'queryParameter') {
|
||||
$response = pest()->get("/foo?tenant=$tenant->id")->assertOk();
|
||||
if ($useKernelIdentification) {
|
||||
$controller = ControllerWithMiddleware::class;
|
||||
app(Kernel::class)->pushMiddleware($identificationMiddleware);
|
||||
} else {
|
||||
$controller = ControllerWithRouteMiddleware::class;
|
||||
RouteFacade::middlewareGroup('tenant', [$identificationMiddleware]);
|
||||
}
|
||||
|
||||
assertTenancyInitializedInEarlyIdentificationRequest($response->getContent());
|
||||
config(['tenancy.bootstrappers' => [DatabaseTenancyBootstrapper::class]]);
|
||||
config(['tenancy.default_route_mode' => $defaultRouteMode]);
|
||||
|
||||
// Migrate users and comments tables on central connection
|
||||
pest()->artisan('migrate', [
|
||||
'--path' => __DIR__ . '/Etc/EarlyIdentification/path/migrations',
|
||||
'--realpath' => true,
|
||||
])->assertExitCode(0);
|
||||
|
||||
$centralPost = Post::create(['title' => 'central post']);
|
||||
$centralComment = $centralPost->comments()->create(['comment' => 'central comment']);
|
||||
|
||||
/**
|
||||
* @var Route $tenantRoute
|
||||
* @var Route $commentTenantRoute
|
||||
*
|
||||
* The Route instance is always assigned to this variable
|
||||
*/
|
||||
$tenantRoute = null;
|
||||
$commentTenantRoute = null;
|
||||
$tenantRouteMiddleware = ['tenant', 'web'];
|
||||
|
||||
// If defaulting to tenant routes
|
||||
// With kernel identification, we make the tenant route have no MW (except 'web')
|
||||
// And with route-level identification, we make the route have only the identification middleware + 'web'
|
||||
if ($defaultRouteMode === RouteMode::TENANT) {
|
||||
$tenantRouteMiddleware = $useKernelIdentification ? ['web'] : [$identificationMiddleware, 'web'];
|
||||
}
|
||||
|
||||
RouteFacade::group([
|
||||
'middleware' => $tenantRouteMiddleware,
|
||||
'prefix' => '/{tenant}',
|
||||
], function () use ($controller, &$tenantRoute, &$commentTenantRoute) {
|
||||
$tenantRoute = RouteFacade::get('/tenant-route', [$controller, 'index'])->name('tenant-route');
|
||||
$commentTenantRoute = RouteFacade::get('/{post}/comment/{comment}/edit', [$controller, 'computePost'])->name('comment-tenant-route');
|
||||
});
|
||||
|
||||
RouteFacade::group([
|
||||
'middleware' => ['central', 'web'],
|
||||
], function () use ($controller) {
|
||||
RouteFacade::get('/central/home', function () {
|
||||
return 'central-home';
|
||||
});
|
||||
RouteFacade::get('/{post}/edit', [$controller, 'computePost']);
|
||||
RouteFacade::get('/{post}/comment/{comment}/edit', [$controller, 'computePost']);
|
||||
});
|
||||
|
||||
$tenant = Tenant::create(['tenancy_db_name' => pest()->randomString()]);
|
||||
|
||||
// Migrate users and comments tables on tenant connection
|
||||
pest()->artisan('tenants:migrate', [
|
||||
'--path' => __DIR__ . '/Etc/EarlyIdentification/path/migrations',
|
||||
'--realpath' => true,
|
||||
])->assertExitCode(0);
|
||||
|
||||
tenancy()->initialize($tenant);
|
||||
$tenantPost = Post::create(['title' => 'tenant post']);
|
||||
$tenantComment = $tenantPost->comments()->create(['comment' => 'tenant comment']);
|
||||
tenancy()->end();
|
||||
|
||||
// Central routes are accessible and tenancy doesn't get initialized in early identification when the routes get accessed
|
||||
pest()->get('/central/home')->assertOk();
|
||||
pest()->get("/{$centralPost->id}/edit")->assertOk()->assertContent('central post');
|
||||
pest()->get("/{$centralPost->id}/comment/{$centralComment->id}/edit")->assertOk()->assertContent($centralPost->title . '-' . $centralComment->comment);
|
||||
assertTenancyInitializedInEarlyIdentificationRequest(false);
|
||||
|
||||
// Tenant routes are accessible and tenancy gets initialized in early identification when the routes get accessed
|
||||
pest()->get("/{$tenant->id}/{$tenantPost->id}/comment/{$tenantComment->id}/edit")
|
||||
->assertOk()
|
||||
->assertContent($tenantPost->title . '-' . $tenantComment->comment);
|
||||
assertTenancyInitializedInEarlyIdentificationRequest();
|
||||
|
||||
// Tenant routes that use path identification receive the tenant parameter automatically
|
||||
// (setDefaultTenantForRouteParametersWhenInitializingTenancy() in Stancl\Tenancy\Middleware\InitializeTenancyByPath)
|
||||
expect(route('tenant-route'))->toBe(route('tenant-route', ['tenant' => $tenant->getTenantKey()]));
|
||||
})->with([
|
||||
'using request header parameter' => 'header',
|
||||
'using request query parameter' => 'queryParameter'
|
||||
'route-level identification' => false,
|
||||
'kernel identification' => true,
|
||||
// Creates a matrix (multiple with())
|
||||
])->with([
|
||||
'default to tenant routes' => RouteMode::TENANT,
|
||||
'default to central routes' => RouteMode::CENTRAL,
|
||||
]);
|
||||
|
||||
// The name of this test is suffixed by the dataset — domain / subdomain / domainOrSubdomain identification
|
||||
test('early identification works', function (string $middleware, string $domain, string $url) {
|
||||
app(Kernel::class)->pushMiddleware($middleware);
|
||||
test('early identification works with request data identification', function (string $type, bool $useKernelIdentification, RouteMode $defaultRouteMode) {
|
||||
$identificationMiddleware = InitializeTenancyByRequestData::class;
|
||||
|
||||
if ($useKernelIdentification) {
|
||||
$controller = ControllerWithMiddleware::class;
|
||||
app(Kernel::class)->pushMiddleware($identificationMiddleware);
|
||||
} else {
|
||||
$controller = ControllerWithRouteMiddleware::class;
|
||||
RouteFacade::middlewareGroup('tenant', [$identificationMiddleware]);
|
||||
}
|
||||
|
||||
config(['tenancy.default_route_mode' => $defaultRouteMode]);
|
||||
|
||||
$tenantRouteMiddleware = 'tenant';
|
||||
|
||||
// If defaulting to tenant routes
|
||||
// With kernel identification, we make the tenant route have no MW
|
||||
// And with route-level identification, we make the route have only the identification middleware
|
||||
if ($defaultRouteMode === RouteMode::TENANT) {
|
||||
$tenantRouteMiddleware = $useKernelIdentification ? null : $identificationMiddleware;
|
||||
}
|
||||
|
||||
RouteFacade::get('/tenant-route', [$controller, 'index'])->middleware($tenantRouteMiddleware);
|
||||
RouteFacade::get('/central-route', fn () => 'central route')->middleware($defaultRouteMode === RouteMode::TENANT ? 'central' : null);
|
||||
|
||||
$tenantKey = Tenant::create()->getTenantKey();
|
||||
|
||||
// Central route is accessible for every $type
|
||||
pest()->get('/central-route')->assertOk()->assertContent('central route');
|
||||
|
||||
$response = match ($type) {
|
||||
'header' => pest()->get('/tenant-route', ['X-Tenant' => $tenantKey]),
|
||||
'queryParameter' => pest()->get("/tenant-route?tenant={$tenantKey}"),
|
||||
'cookie' => pest()->withUnencryptedCookie('X-Tenant', $tenantKey)
|
||||
->get('/tenant-route'),
|
||||
};
|
||||
|
||||
$response->assertOk()->assertSee('token:' . $tenantKey);
|
||||
})->with([
|
||||
'using request header parameter' => 'header',
|
||||
'using request query parameter' => 'queryParameter',
|
||||
'using request cookie parameter' => 'cookie',
|
||||
// Creates a matrix (multiple with())
|
||||
])->with([
|
||||
'route-level identification' => false,
|
||||
'kernel identification' => true,
|
||||
])->with([
|
||||
'default to tenant routes' => RouteMode::TENANT,
|
||||
'default to central routes' => RouteMode::CENTRAL,
|
||||
]);
|
||||
|
||||
test('early identification works with domain identification', function (string $middleware, string $domain, bool $useKernelIdentification, RouteMode $defaultRouteMode) {
|
||||
config(['tenancy.tenant_model' => Tenant::class]);
|
||||
config(['tenancy.default_route_mode' => $defaultRouteMode]);
|
||||
|
||||
Route::get('/foo', [Controller::class, 'index'])
|
||||
->middleware(PreventAccessFromUnwantedDomains::class)
|
||||
->name('foo');
|
||||
if ($useKernelIdentification) {
|
||||
$controller = ControllerWithMiddleware::class;
|
||||
app(Kernel::class)->pushMiddleware($middleware);
|
||||
app(Kernel::class)->pushMiddleware(PreventAccessFromUnwantedDomains::class);
|
||||
} else {
|
||||
$controller = ControllerWithRouteMiddleware::class;
|
||||
RouteFacade::middlewareGroup('tenant', [$middleware, PreventAccessFromUnwantedDomains::class]);
|
||||
}
|
||||
|
||||
// Tenant route
|
||||
$tenantRoute = RouteFacade::get('/tenant-route', [$controller, 'index']);
|
||||
|
||||
// Central route
|
||||
$centralRoute = RouteFacade::get('/central-route', function () {
|
||||
return 'central route';
|
||||
});
|
||||
|
||||
$defaultToTenantRoutes = $defaultRouteMode === RouteMode::TENANT;
|
||||
|
||||
// Test defaulting to route mode (central/tenant context)
|
||||
if ($useKernelIdentification) {
|
||||
$routeThatShouldReceiveMiddleware = $defaultToTenantRoutes ? $centralRoute : $tenantRoute;
|
||||
$routeThatShouldReceiveMiddleware->middleware($defaultToTenantRoutes ? 'central' : 'tenant');
|
||||
} elseif (! $defaultToTenantRoutes) {
|
||||
$tenantRoute->middleware('tenant');
|
||||
}
|
||||
|
||||
$tenant = Tenant::create();
|
||||
|
||||
|
|
@ -86,19 +217,173 @@ test('early identification works', function (string $middleware, string $domain,
|
|||
'domain' => $domain,
|
||||
]);
|
||||
|
||||
$response = pest()->get($url)->assertOk();
|
||||
if ($domain === 'foo') {
|
||||
$domain = 'foo.localhost';
|
||||
}
|
||||
|
||||
assertTenancyInitializedInEarlyIdentificationRequest($response->getContent());
|
||||
pest()->get('http://localhost/central-route')->assertOk()->assertContent('central route'); // Central route is accessible
|
||||
|
||||
$response = pest()->get("http://{$domain}/tenant-route");
|
||||
|
||||
if ($defaultToTenantRoutes === $useKernelIdentification || $useKernelIdentification) {
|
||||
$response->assertOk();
|
||||
assertTenancyInitializedInEarlyIdentificationRequest();
|
||||
} elseif (! $defaultToTenantRoutes) {
|
||||
$response->assertNotFound();
|
||||
assertTenancyInitializedInEarlyIdentificationRequest(false);
|
||||
}
|
||||
|
||||
// Expect tenancy is initialized (or not) for the right tenant at the tenant route
|
||||
expect($response->getContent())->toBe('token:' . (tenant()?->getTenantKey() ?? 'central'));
|
||||
})->with([
|
||||
'domain identification' => ['middleware' => InitializeTenancyByDomain::class, 'domain' => 'foo.test', 'url' => 'http://foo.test/foo'],
|
||||
'subdomain identification' => ['middleware' => InitializeTenancyBySubdomain::class, 'domain' => 'foo', 'url' => 'http://foo.localhost/foo'],
|
||||
'domainOrSubdomain identification using domain' => ['middleware' => InitializeTenancyByDomainOrSubdomain::class, 'domain' => 'foo.test', 'url' => 'http://foo.test/foo'],
|
||||
'domainOrSubdomain identification using subdomain' => ['middleware' => InitializeTenancyByDomainOrSubdomain::class, 'domain' => 'foo', 'url' => 'http://foo.localhost/foo'],
|
||||
'domain identification' => ['middleware' => InitializeTenancyByDomain::class, 'domain' => 'foo.test'],
|
||||
'subdomain identification' => ['middleware' => InitializeTenancyBySubdomain::class, 'domain' => 'foo'],
|
||||
'domainOrSubdomain identification using domain' => ['middleware' => InitializeTenancyByDomainOrSubdomain::class, 'domain' => 'foo.test'],
|
||||
'domainOrSubdomain identification using subdomain' => ['middleware' => InitializeTenancyByDomainOrSubdomain::class, 'domain' => 'foo'],
|
||||
// Creates a matrix (multiple with())
|
||||
])->with([
|
||||
'route-level identification' => false,
|
||||
'kernel identification' => true,
|
||||
])->with([
|
||||
'default to tenant routes' => RouteMode::TENANT,
|
||||
'default to central routes' => RouteMode::CENTRAL,
|
||||
]);
|
||||
|
||||
function assertTenancyInitializedInEarlyIdentificationRequest(string|false $string): void
|
||||
test('the tenant parameter is only removed from tenant routes when using path identification', function (bool $kernelIdentification, bool $pathIdentification) {
|
||||
if ($kernelIdentification) {
|
||||
$middleware = $pathIdentification ? InitializeTenancyByPath::class : InitializeTenancyByDomain::class;
|
||||
|
||||
app(Kernel::class)->pushMiddleware($middleware);
|
||||
|
||||
RouteFacade::get('/{tenant}/central-route', [ControllerWithMiddleware::class, 'routeHasTenantParameter'])
|
||||
->middleware('central')
|
||||
->name('central-route');
|
||||
|
||||
RouteFacade::get('/{tenant}/tenant-route', [ControllerWithMiddleware::class, 'routeHasTenantParameter'])
|
||||
->middleware('tenant')
|
||||
->name('tenant-route');
|
||||
|
||||
$tenant = Tenant::create();
|
||||
$tenantKey = $tenant->getTenantKey();
|
||||
|
||||
// Expect route to receive the tenant parameter
|
||||
$response = pest()->get($tenantKey . '/central-route')->assertOk();
|
||||
expect((bool) $response->getContent())->toBeTrue();
|
||||
|
||||
if ($pathIdentification) {
|
||||
// Tenant parameter is removed from tenant routes using kernel path identification (Stancl\Tenancy\Listeners\ForgetTenantParameter)
|
||||
$response = pest()->get($tenantKey . '/tenant-route')->assertOk();
|
||||
expect((bool) $response->getContent())->toBeFalse();
|
||||
} else {
|
||||
// Tenant parameter is not removed from tenant routes using other kernel identification MW
|
||||
$tenant->domains()->create(['domain' => $domain = $tenantKey . '.localhost']);
|
||||
|
||||
$response = pest()->get("http://{$domain}/{$tenantKey}/tenant-route")->assertOk();
|
||||
expect((bool) $response->getContent())->toBeTrue();
|
||||
}
|
||||
} else {
|
||||
RouteFacade::middlewareGroup('tenant', [$pathIdentification ? InitializeTenancyByPath::class : InitializeTenancyByDomain::class]);
|
||||
|
||||
// Route-level identification
|
||||
RouteFacade::get('/{tenant}/central-route', [ControllerWithMiddleware::class, 'routeHasTenantParameter'])
|
||||
->middleware('central')
|
||||
->name('central-route');
|
||||
|
||||
RouteFacade::get('/{tenant}/tenant-route', [ControllerWithMiddleware::class, 'routeHasTenantParameter'])
|
||||
->middleware('tenant')
|
||||
->name('tenant-route');
|
||||
|
||||
$tenant = Tenant::create();
|
||||
$tenantKey = $tenant->getTenantKey();
|
||||
|
||||
if ($pathIdentification) {
|
||||
// Tenant parameter isn't removed from central routes
|
||||
$response = pest()->get("http://localhost/{$tenantKey}/central-route")->assertOk();
|
||||
expect((bool) $response->getContent())->toBeTrue();
|
||||
|
||||
// Tenant parameter is removed from tenant routes that are using kernel path identification (in PathTenantResolver)
|
||||
$response = pest()->get("http://localhost/{$tenantKey}/tenant-route")->assertOk();
|
||||
expect((bool) $response->getContent())->toBeFalse();
|
||||
} else {
|
||||
$tenant->domains()->create(['domain' => $domain = $tenantKey . '.localhost']);
|
||||
|
||||
// Tenant parameter is not removed from tenant routes that are using other identification MW
|
||||
$response = pest()->get("http://{$domain}/{$tenantKey}/tenant-route")->assertOk();
|
||||
expect((bool) $response->getContent())->toBeTrue();
|
||||
}
|
||||
}
|
||||
})->with([
|
||||
'kernel path identification' => ['kernelIdentification' => true, 'pathIdentification' => true],
|
||||
'route-level path identification' => ['kernelIdentification' => false, 'pathIdentification' => true],
|
||||
'kernel domain identification' => ['kernelIdentification' => true, 'pathIdentification' => false],
|
||||
'route-level domain identification' => ['kernelIdentification' => false, 'pathIdentification' => false],
|
||||
]);
|
||||
|
||||
test('route level identification is prioritized over kernel identification', function (
|
||||
string|array $kernelIdentificationMiddleware,
|
||||
string|array $routeIdentificationMiddleware,
|
||||
string $routeUri,
|
||||
string $domainToVisit,
|
||||
string|null $domain = null,
|
||||
RouteMode $defaultRouteMode,
|
||||
) {
|
||||
$tenant = Tenant::create();
|
||||
$domainToVisit = str_replace('{tenantKey}', $tenant->getTenantKey(), $domainToVisit);
|
||||
|
||||
config(['tenancy.default_route_mode' => $defaultRouteMode]);
|
||||
|
||||
if ($domain) {
|
||||
$tenant->domains()->create(['domain' => str_replace('{tenantKey}', $tenant->getTenantKey(), $domain)]);
|
||||
}
|
||||
|
||||
foreach (Arr::wrap($kernelIdentificationMiddleware) as $identificationMiddleware) {
|
||||
app(Kernel::class)->pushMiddleware($identificationMiddleware);
|
||||
}
|
||||
|
||||
// We're testing *non-early* route-level identification so that we can assert that early kernel identification got skipped
|
||||
// Also, ignore the defaulting when the identification MW is applied directly on the route
|
||||
// The route is automatically considered tenant if it has identification middleware (unless it also has the 'universal' middleware)
|
||||
RouteFacade::get($routeUri, [ControllerWithMiddleware::class, 'index'])->middleware($routeIdentificationMiddleware);
|
||||
|
||||
pest()->get($domainToVisit)->assertOk();
|
||||
|
||||
// Kernel (early) identification skipped
|
||||
expect(app()->make('controllerRunsInTenantContext'))->toBeFalse();
|
||||
})->with([
|
||||
'kernel request data identification mw' => ['kernelMiddleware' => InitializeTenancyByRequestData::class],
|
||||
'kernel path identification mw' => ['kernelMiddleware' => InitializeTenancyByPath::class],
|
||||
'kernel domain identification mw' => ['kernelMiddleware' => [PreventAccessFromUnwantedDomains::class, InitializeTenancyByDomain::class]],
|
||||
'kernel subdomain identification mw' => ['kernelMiddleware' => [PreventAccessFromUnwantedDomains::class, InitializeTenancyBySubdomain::class]],
|
||||
'kernel domainOrSubdomain identification mw using domain' => ['kernelMiddleware' => [PreventAccessFromUnwantedDomains::class, InitializeTenancyByDomainOrSubdomain::class]],
|
||||
'kernel domainOrSubdomain identification mw using subdomain' => ['kernelMiddleware' => [PreventAccessFromUnwantedDomains::class, InitializeTenancyByDomainOrSubdomain::class]],
|
||||
// Creates a matrix (multiple with())
|
||||
])->with([
|
||||
'route level request data identification mw' => ['routeLevelMiddleware' => InitializeTenancyByRequestData::class, 'routeUri' => '/tenant-route', 'domainToVisit' => 'http://localhost/tenant-route?tenant={tenantKey}', 'domain' => null],
|
||||
'route level path identification mw' => ['routeLevelMiddleware' => InitializeTenancyByPath::class, 'routeUri' => '/{tenant}/tenant-route', 'domainToVisit' => 'http://localhost/{tenantKey}/tenant-route', 'domain' => null],
|
||||
'route level domain identification mw' => ['routeLevelMiddleware' => [PreventAccessFromUnwantedDomains::class, InitializeTenancyByDomain::class], 'routeUri' => '/tenant-route', 'domainToVisit' => 'http://{tenantKey}.test/tenant-route', 'domain' => '{tenantKey}.test'],
|
||||
'route level subdomain identification mw' => ['routeLevelMiddleware' => [PreventAccessFromUnwantedDomains::class, InitializeTenancyBySubdomain::class], 'routeUri' => '/tenant-route', 'domainToVisit' => 'http://{tenantKey}.localhost/tenant-route', 'domain' => '{tenantKey}'],
|
||||
'route level domainOrSubdomain identification mw using domain' => ['routeLevelMiddleware' => [PreventAccessFromUnwantedDomains::class, InitializeTenancyByDomainOrSubdomain::class], 'routeUri' => '/tenant-route', 'domainToVisit' => 'http://{tenantKey}.test/tenant-route', 'domain' => '{tenantKey}.test'],
|
||||
'route level domainOrSubdomain identification mw using subdomain' => ['routeLevelMiddleware' => [PreventAccessFromUnwantedDomains::class, InitializeTenancyByDomainOrSubdomain::class], 'routeUri' => '/tenant-route', 'domainToVisit' => 'http://{tenantKey}.localhost/tenant-route', 'domain' => '{tenantKey}'],
|
||||
])
|
||||
->with([
|
||||
'default to tenant routes' => RouteMode::TENANT,
|
||||
'default to central routes' => RouteMode::CENTRAL,
|
||||
]);
|
||||
|
||||
test('routes with path identification middleware can get prefixed using the reregister action', function() {
|
||||
$tenantKey = Tenant::create()->getTenantKey();
|
||||
|
||||
RouteFacade::get('/home', fn () => tenant()?->getTenantKey())->name('home')->middleware(InitializeTenancyByPath::class);
|
||||
|
||||
pest()->get("http://localhost/$tenantKey/home")->assertNotFound();
|
||||
|
||||
app(CloneRoutesAsTenant::class)->handle();
|
||||
|
||||
pest()->get("http://localhost/$tenantKey/home")->assertOk();
|
||||
});
|
||||
|
||||
function assertTenancyInitializedInEarlyIdentificationRequest(bool $expect = true): void
|
||||
{
|
||||
expect($string)->toBe(tenant()->getTenantKey() . '-abc123'); // Assert that the service class returns tenant value
|
||||
expect(app()->make('additionalMiddlewareRunsInTenantContext'))->toBeTrue(); // Assert that middleware added in the controller constructor runs in tenant context
|
||||
expect(app()->make('controllerRunsInTenantContext'))->toBeTrue(); // Assert that tenancy is initialized in the controller constructor
|
||||
expect(app()->make('additionalMiddlewareRunsInTenantContext'))->toBe($expect); // Assert that middleware added in the controller constructor runs in tenant context
|
||||
expect(app()->make('controllerRunsInTenantContext'))->toBe($expect); // Assert that tenancy is initialized in the controller constructor
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,19 +0,0 @@
|
|||
<?php
|
||||
|
||||
namespace Stancl\Tenancy\Tests\Etc\EarlyIdentification;
|
||||
|
||||
use Illuminate\Routing\Controller as BaseController;
|
||||
|
||||
class Controller extends BaseController
|
||||
{
|
||||
public function __construct(public Service $service)
|
||||
{
|
||||
app()->instance('controllerRunsInTenantContext', tenancy()->initialized);
|
||||
$this->middleware(AdditionalMiddleware::class);
|
||||
}
|
||||
|
||||
public function index(): string
|
||||
{
|
||||
return $this->service->token;
|
||||
}
|
||||
}
|
||||
37
tests/Etc/EarlyIdentification/ControllerWithMiddleware.php
Normal file
37
tests/Etc/EarlyIdentification/ControllerWithMiddleware.php
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
<?php
|
||||
|
||||
namespace Stancl\Tenancy\Tests\Etc\EarlyIdentification;
|
||||
|
||||
use Illuminate\Http\Request;
|
||||
use Stancl\Tenancy\Resolvers\PathTenantResolver;
|
||||
use Illuminate\Routing\Controller as BaseController;
|
||||
use Stancl\Tenancy\Tests\Etc\EarlyIdentification\Models\Post;
|
||||
use Stancl\Tenancy\Tests\Etc\EarlyIdentification\Models\Comment;
|
||||
|
||||
class ControllerWithMiddleware extends BaseController
|
||||
{
|
||||
public function __construct(
|
||||
public Service $service,
|
||||
) {
|
||||
app()->instance('controllerRunsInTenantContext', tenancy()->initialized);
|
||||
$this->middleware(AdditionalMiddleware::class);
|
||||
}
|
||||
|
||||
public function computePost(Post $post, Comment|null $comment = null): string
|
||||
{
|
||||
$post = $post->title;
|
||||
$comment = $comment ? '-' . $comment->comment : '';
|
||||
|
||||
return $post . $comment;
|
||||
}
|
||||
|
||||
public function index(): string
|
||||
{
|
||||
return $this->service->token;
|
||||
}
|
||||
|
||||
public function routeHasTenantParameter(Request $request): bool
|
||||
{
|
||||
return $request->route()->hasParameter(PathTenantResolver::tenantParameterName());
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
<?php
|
||||
|
||||
namespace Stancl\Tenancy\Tests\Etc\EarlyIdentification;
|
||||
|
||||
use Illuminate\Http\Request;
|
||||
use Illuminate\Routing\Controllers\Middleware;
|
||||
use Stancl\Tenancy\Resolvers\PathTenantResolver;
|
||||
use Illuminate\Routing\Controllers\HasMiddleware;
|
||||
use Stancl\Tenancy\Tests\Etc\EarlyIdentification\Models\Post;
|
||||
use Stancl\Tenancy\Tests\Etc\EarlyIdentification\Models\Comment;
|
||||
|
||||
class ControllerWithRouteMiddleware implements HasMiddleware
|
||||
{
|
||||
public function __construct(
|
||||
public Service $service,
|
||||
) {
|
||||
app()->instance('controllerRunsInTenantContext', tenancy()->initialized);
|
||||
}
|
||||
|
||||
public static function middleware()
|
||||
{
|
||||
return [
|
||||
new Middleware(AdditionalMiddleware::class)
|
||||
];
|
||||
}
|
||||
|
||||
public function computePost(Post $post, Comment|null $comment = null): string
|
||||
{
|
||||
$post = $post->title;
|
||||
$comment = $comment ? '-' . $comment->comment : '';
|
||||
|
||||
return $post . $comment;
|
||||
}
|
||||
|
||||
public function index(): string
|
||||
{
|
||||
return $this->service->token;
|
||||
}
|
||||
|
||||
public function routeHasTenantParameter(Request $request): bool
|
||||
{
|
||||
return $request->route()->hasParameter(PathTenantResolver::tenantParameterName());
|
||||
}
|
||||
}
|
||||
17
tests/Etc/EarlyIdentification/Models/Comment.php
Normal file
17
tests/Etc/EarlyIdentification/Models/Comment.php
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
<?php
|
||||
|
||||
namespace Stancl\Tenancy\Tests\Etc\EarlyIdentification\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
class Comment extends Model
|
||||
{
|
||||
protected $guarded = [];
|
||||
protected $table = 'comments';
|
||||
public $timestamps = false;
|
||||
|
||||
public function post()
|
||||
{
|
||||
return $this->belongsTo(Post::class, 'post_id');
|
||||
}
|
||||
}
|
||||
17
tests/Etc/EarlyIdentification/Models/Post.php
Normal file
17
tests/Etc/EarlyIdentification/Models/Post.php
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
<?php
|
||||
|
||||
namespace Stancl\Tenancy\Tests\Etc\EarlyIdentification\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
class Post extends Model
|
||||
{
|
||||
protected $guarded = [];
|
||||
protected $table = 'posts';
|
||||
public $timestamps = false;
|
||||
|
||||
public function comments()
|
||||
{
|
||||
return $this->hasMany(Comment::class, 'post_id');
|
||||
}
|
||||
}
|
||||
|
|
@ -10,6 +10,6 @@ class Service
|
|||
|
||||
public function __construct()
|
||||
{
|
||||
$this->token = config('tenancy.token');
|
||||
$this->token = config('tenancy.test_service_token');
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,29 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use Illuminate\Database\Migrations\Migration;
|
||||
use Illuminate\Database\Schema\Blueprint;
|
||||
use Illuminate\Support\Facades\Schema;
|
||||
|
||||
class CreateCommentsTable extends Migration
|
||||
{
|
||||
/**
|
||||
* Run the migrations.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function up()
|
||||
{
|
||||
Schema::create('comments', function (Blueprint $table) {
|
||||
$table->increments('id');
|
||||
$table->string('comment');
|
||||
$table->unsignedInteger('post_id');
|
||||
});
|
||||
}
|
||||
|
||||
public function down()
|
||||
{
|
||||
Schema::drop('comments');
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use Illuminate\Database\Migrations\Migration;
|
||||
use Illuminate\Database\Schema\Blueprint;
|
||||
use Illuminate\Support\Facades\Schema;
|
||||
|
||||
class CreatePostsTable extends Migration
|
||||
{
|
||||
/**
|
||||
* Run the migrations.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function up()
|
||||
{
|
||||
Schema::create('posts', function (Blueprint $table) {
|
||||
$table->increments('id');
|
||||
$table->string('title');
|
||||
});
|
||||
}
|
||||
|
||||
public function down()
|
||||
{
|
||||
Schema::drop('posts');
|
||||
}
|
||||
}
|
||||
|
|
@ -20,6 +20,10 @@ use Stancl\Tenancy\Listeners\BootstrapTenancy;
|
|||
use Stancl\Tenancy\Listeners\QueueableListener;
|
||||
use Stancl\Tenancy\Tests\Etc\Tenant;
|
||||
|
||||
beforeEach(function () {
|
||||
FooListener::$shouldQueue = false;
|
||||
});
|
||||
|
||||
test('listeners can be synchronous', function () {
|
||||
Queue::fake();
|
||||
Event::listen(TenantCreated::class, FooListener::class);
|
||||
|
|
@ -44,6 +48,9 @@ test('listeners can be queued by setting a static property', function () {
|
|||
});
|
||||
|
||||
expect(app()->bound('foo'))->toBeFalse();
|
||||
|
||||
// Reset static property
|
||||
FooListener::$shouldQueue = false;
|
||||
});
|
||||
|
||||
test('ing events can be used to cancel tenant model actions', function () {
|
||||
|
|
|
|||
|
|
@ -12,6 +12,7 @@ use Stancl\Tenancy\Bootstrappers\MailTenancyBootstrapper;
|
|||
|
||||
beforeEach(function() {
|
||||
config(['mail.default' => 'smtp']);
|
||||
config(['tenancy.bootstrappers' => [MailTenancyBootstrapper::class]]);
|
||||
MailTenancyBootstrapper::$credentialsMap = [];
|
||||
|
||||
Event::listen(TenancyInitialized::class, BootstrapTenancy::class);
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
|
||||
declare(strict_types=1);
|
||||
|
||||
use Illuminate\Contracts\Http\Kernel;
|
||||
use Illuminate\Support\Facades\Route;
|
||||
use Stancl\Tenancy\Exceptions\RouteIsMissingTenantParameterException;
|
||||
use Stancl\Tenancy\Exceptions\TenantCouldNotBeIdentifiedByPathException;
|
||||
|
|
@ -10,6 +11,11 @@ use Stancl\Tenancy\Resolvers\PathTenantResolver;
|
|||
use Stancl\Tenancy\Tests\Etc\Tenant;
|
||||
|
||||
beforeEach(function () {
|
||||
// Make sure the tenant parameter is set to 'tenant'
|
||||
config(['tenancy.identification.resolvers.' . PathTenantResolver::class . '.tenant_parameter_name' => 'tenant']);
|
||||
|
||||
InitializeTenancyByPath::$onFail = null;
|
||||
|
||||
Route::group([
|
||||
'prefix' => '/{tenant}',
|
||||
'middleware' => InitializeTenancyByPath::class,
|
||||
|
|
@ -70,9 +76,11 @@ test('onfail logic can be customized', function () {
|
|||
pest()
|
||||
->get('/acme/foo/abc/xyz')
|
||||
->assertContent('foo');
|
||||
|
||||
InitializeTenancyByPath::$onFail = null;
|
||||
});
|
||||
|
||||
test('an exception is thrown when the routes first parameter is not tenant', function () {
|
||||
test('an exception is thrown when the route does not have the tenant parameter', function () {
|
||||
Route::group([
|
||||
// 'prefix' => '/{tenant}', -- intentionally commented
|
||||
'middleware' => InitializeTenancyByPath::class,
|
||||
|
|
@ -140,3 +148,35 @@ test('tenant parameter is set for all routes as the default parameter once the t
|
|||
expect(route('baz', ['a' => 1, 'b' => 2]))->toBe('http://localhost/acme/baz/1/2'); // assert the full route string
|
||||
pest()->get(route('baz', ['a' => 1, 'b' => 2]))->assertOk(); // Assert route don't need tenant parameter
|
||||
});
|
||||
|
||||
test('tenant parameter does not have to be the first in order to initialize tenancy', function() {
|
||||
Tenant::create([
|
||||
'id' => $tenantId = 'another-tenant',
|
||||
]);
|
||||
|
||||
Route::get('/another/route/{a}/{tenant}/{b}', function ($a, $b) {
|
||||
return "$a + $b + " . tenant()->getTenantKey();
|
||||
})->middleware(InitializeTenancyByPath::class)->name('tenant-parameter-is-second');
|
||||
|
||||
pest()->get("/another/route/foo/$tenantId/bar")->assertSee("foo + bar + $tenantId");
|
||||
});
|
||||
|
||||
test('central route can have a parameter with the same name as the tenant parameter', function() {
|
||||
config(['tenancy.identification.resolvers.' . PathTenantResolver::class . '.tenant_parameter_name' => 'team']);
|
||||
$tenantKey = Tenant::create()->getTenantKey();
|
||||
|
||||
Route::get('/central/route/{team}/{a}/{b}', function ($team, $a, $b) {
|
||||
return "$a + $b + $team";
|
||||
})->middleware('central')->name('central-route');
|
||||
|
||||
pest()->get("/central/route/{$tenantKey}/foo/bar")->assertSee("foo + bar + {$tenantKey}");
|
||||
|
||||
expect(tenancy()->initialized)->toBeFalse();
|
||||
|
||||
// With kernel path identification
|
||||
app(Kernel::class)->pushMiddleware(InitializeTenancyByPath::class);
|
||||
|
||||
pest()->get("/central/route/{$tenantKey}/foo/bar")->assertSee("foo + bar + {$tenantKey}");
|
||||
|
||||
expect(tenancy()->initialized)->toBeFalse();
|
||||
});
|
||||
|
|
|
|||
235
tests/PreventAccessFromUnwantedDomainsTest.php
Normal file
235
tests/PreventAccessFromUnwantedDomainsTest.php
Normal file
|
|
@ -0,0 +1,235 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use Stancl\Tenancy\RouteMode;
|
||||
use Illuminate\Contracts\Http\Kernel;
|
||||
use Illuminate\Support\Facades\Route;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyByDomain;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyBySubdomain;
|
||||
use Stancl\Tenancy\Middleware\PreventAccessFromUnwantedDomains;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyByDomainOrSubdomain;
|
||||
use Stancl\Tenancy\Tests\Etc\EarlyIdentification\ControllerWithMiddleware;
|
||||
|
||||
test('correct routes are accessible in route-level identification', function (RouteMode $defaultRouteMode) {
|
||||
config()->set([
|
||||
'tenancy.default_route_mode' => $defaultRouteMode,
|
||||
]);
|
||||
|
||||
if ($defaultRouteMode === RouteMode::TENANT) {
|
||||
// Apply `central` middleware to central routes if routes default to `tenant`
|
||||
$centralMiddleware = ['central', PreventAccessFromUnwantedDomains::class];
|
||||
$tenantMiddleware = [PreventAccessFromUnwantedDomains::class, InitializeTenancyByDomain::class];
|
||||
} else {
|
||||
// Apply `tenant` middleware to `tenant` routes if routes default to `central`
|
||||
$centralMiddleware = [PreventAccessFromUnwantedDomains::class];
|
||||
$tenantMiddleware = ['tenant', PreventAccessFromUnwantedDomains::class, InitializeTenancyByDomain::class];
|
||||
}
|
||||
|
||||
// Central route
|
||||
Route::get('central-route', function () {
|
||||
return 'central-route';
|
||||
})->middleware($centralMiddleware);
|
||||
|
||||
// Tenant route
|
||||
Route::get('tenant-route', function () {
|
||||
return 'tenant-route';
|
||||
})->middleware($tenantMiddleware);
|
||||
|
||||
$tenant = Tenant::create();
|
||||
$tenant->domains()->create([
|
||||
'domain' => 'foo.localhost',
|
||||
]);
|
||||
|
||||
// Accessing tenant routes on central domains and vice versa is not allowed
|
||||
pest()->get('http://localhost/tenant-route')->assertNotFound();
|
||||
pest()->get('http://foo.localhost/central-route')->assertNotFound();
|
||||
|
||||
// Accessing central routes from central domains and vice versa is allowed
|
||||
pest()->get('http://localhost/central-route')->assertOk();
|
||||
pest()->get('http://foo.localhost/tenant-route')->assertOk();
|
||||
})->with([
|
||||
'default to tenant routes' => RouteMode::TENANT,
|
||||
'default to central routes' => RouteMode::CENTRAL,
|
||||
]);
|
||||
|
||||
test('correct routes are accessible in kernel identification', function (RouteMode $defaultRouteMode) {
|
||||
// Defaulting to tenant routes only works when using identification middleware globally
|
||||
app(Kernel::class)->pushMiddleware(PreventAccessFromUnwantedDomains::class);
|
||||
app(Kernel::class)->pushMiddleware(InitializeTenancyByDomain::class);
|
||||
|
||||
config()->set([
|
||||
'tenancy.default_route_mode' => $defaultRouteMode,
|
||||
]);
|
||||
|
||||
$defaultToTenantRoutes = $defaultRouteMode === RouteMode::TENANT;
|
||||
|
||||
// Test that if we're defaulting to a route mode, we don't have to specify the mode middleware ('tenant'/'central') explicitly
|
||||
if ($defaultToTenantRoutes) {
|
||||
// Apply `central` middleware to central routes if routes default to tenant context
|
||||
$centralMiddleware = ['central'];
|
||||
$tenantMiddleware = [];
|
||||
} else {
|
||||
// Apply `tenant` middleware to tenant routes if routes default to `central`
|
||||
$centralMiddleware = [];
|
||||
$tenantMiddleware = ['tenant'];
|
||||
}
|
||||
|
||||
// Central route
|
||||
Route::get('central-route', function () {
|
||||
return 'central-route';
|
||||
})->middleware($centralMiddleware);
|
||||
|
||||
// Tenant route
|
||||
Route::get('tenant-route', function () {
|
||||
return 'tenant-route';
|
||||
})->middleware($tenantMiddleware);
|
||||
|
||||
// Route without the mode middleware
|
||||
Route::get('package-route', function () {
|
||||
return 'package-route';
|
||||
});
|
||||
|
||||
$tenant = Tenant::create();
|
||||
$tenant->domains()->create([
|
||||
'domain' => 'foo.localhost',
|
||||
]);
|
||||
|
||||
// Central route on central domain is accessible
|
||||
pest()->get('http://localhost/central-route')->assertOk();
|
||||
expect(tenancy()->initialized)->toBeFalse();
|
||||
|
||||
// Central route on tenant domain is not accessible
|
||||
pest()->get('http://foo.localhost/central-route')->assertNotFound();
|
||||
expect(tenancy()->initialized)->toBeFalse();
|
||||
|
||||
// Tenant route on tenant domain is accessible
|
||||
pest()->get('http://foo.localhost/tenant-route')->assertOk();
|
||||
expect(tenancy()->initialized)->toBeTrue();
|
||||
tenancy()->end();
|
||||
|
||||
// Tenant route on central domain is not accessible
|
||||
pest()->get('http://localhost/tenant-route')->assertNotFound();
|
||||
expect(tenancy()->initialized)->toBeFalse();
|
||||
|
||||
if ($defaultToTenantRoutes) {
|
||||
// Routes default to tenant – package route is accessible from `tenant` domains
|
||||
pest()->get('http://foo.localhost/package-route')->assertOk();
|
||||
expect(tenancy()->initialized)->toBeTrue();
|
||||
tenancy()->end();
|
||||
|
||||
// Package route isn't accessible from `central` domains
|
||||
pest()->get('http://localhost/package-route')->assertNotFound();
|
||||
} else {
|
||||
// Routes default to central – package route is accessible from `central` domains
|
||||
pest()->get('http://localhost/package-route')->assertOk();
|
||||
expect(tenancy()->initialized)->toBeFalse();
|
||||
|
||||
// Package route isn't accessible from `tenant` domains
|
||||
pest()->get('http://foo.localhost/package-route')->assertNotFound();
|
||||
}
|
||||
})->with([
|
||||
'default to tenant routes' => RouteMode::TENANT,
|
||||
'default to central routes' => RouteMode::CENTRAL,
|
||||
]);
|
||||
|
||||
test('kernel PreventAccessFromUnwantedDomains does not get skipped when route level domain identification is used', function (string $domainIdentificationMiddleware, string $domain) {
|
||||
// With route-level *domain identification* MW (without PreventAccessFromUnwantedDomains)
|
||||
// PreventAccessFromUnwantedDomains shouldn't be skipped
|
||||
config([
|
||||
'tenancy.test_service_token' => 'token:central',
|
||||
]);
|
||||
|
||||
app(Kernel::class)->pushMiddleware(PreventAccessFromUnwantedDomains::class);
|
||||
Route::middlewareGroup('tenant', [$domainIdentificationMiddleware]);
|
||||
|
||||
Route::get('tenant-route', [ControllerWithMiddleware::class, 'index'])->middleware('tenant')->name('tenant-route');
|
||||
Route::get('central-route', [ControllerWithMiddleware::class, 'index'])->middleware('central')->name('central-route');
|
||||
|
||||
$tenant = Tenant::create();
|
||||
$tenant->domains()->create([
|
||||
'domain' => $domain,
|
||||
]);
|
||||
|
||||
if ($domain === 'foo') {
|
||||
$domain = 'foo.localhost';
|
||||
}
|
||||
|
||||
// Tenant route is not accessible on central domain
|
||||
pest()->get('http://localhost/tenant-route')->assertNotFound();
|
||||
expect(tenancy()->initialized)->toBeFalse();
|
||||
|
||||
// Central route is not accessible on tenant domain
|
||||
pest()->get("http://$domain/central-route")->assertNotFound();
|
||||
expect(tenancy()->initialized)->toBeFalse();
|
||||
|
||||
// Tenant route is accessible on tenant domain
|
||||
pest()->get("http://$domain/tenant-route")->assertOk();
|
||||
expect(tenancy()->initialized)->toBeTrue();
|
||||
tenancy()->end();
|
||||
|
||||
// Central route is accessible on central domain
|
||||
pest()->get('http://localhost/central-route')->assertOk();
|
||||
expect(tenancy()->initialized)->toBeFalse();
|
||||
})->with([
|
||||
'domain identification mw' => [InitializeTenancyByDomain::class, 'foo.test'],
|
||||
'subdomain identification mw' => [InitializeTenancyBySubdomain::class, 'foo'],
|
||||
'domainOrSubdomain identification mw using domain' => [InitializeTenancyByDomainOrSubdomain::class, 'foo.test'],
|
||||
'domainOrSubdomain identification mw using subdomain' => [InitializeTenancyByDomainOrSubdomain::class, 'foo'],
|
||||
]);
|
||||
|
||||
test('placement of domain identification and access prevention middleware can get mixed', function (
|
||||
array $globalMiddleware,
|
||||
array $routeMiddleware,
|
||||
array $centralRouteMiddleware
|
||||
) {
|
||||
config([
|
||||
'tenancy.test_service_token' => 'token:central',
|
||||
]);
|
||||
|
||||
foreach ($globalMiddleware as $middleware) {
|
||||
app(Kernel::class)->pushMiddleware($middleware);
|
||||
}
|
||||
|
||||
// Make sure the central route has the prevention MW
|
||||
// If it isn't used globally and it's not passed in $centralRouteMiddleware
|
||||
if (! in_array(PreventAccessFromUnwantedDomains::class, array_merge($centralRouteMiddleware, $globalMiddleware))) {
|
||||
$centralRouteMiddleware[] = PreventAccessFromUnwantedDomains::class;
|
||||
}
|
||||
|
||||
$tenant = Tenant::create();
|
||||
$subdomain = $tenant->domains()->create(['domain' => 'foo'])->domain;
|
||||
|
||||
Route::get('tenant-route', fn () => 'tenant route')->middleware(['tenant', ...$routeMiddleware]);
|
||||
Route::get('central-route', fn () => 'central route')->middleware($centralRouteMiddleware);
|
||||
|
||||
pest()->get("http://$subdomain.localhost/tenant-route")->assertOk();
|
||||
expect(tenancy()->initialized)->toBeTrue();
|
||||
tenancy()->end();
|
||||
pest()->get("http://$subdomain.localhost/central-route")->assertNotFound();
|
||||
|
||||
pest()->get("http://localhost/tenant-route")->assertNotFound();
|
||||
pest()->get("http://localhost/central-route")->assertOk();
|
||||
expect(tenancy()->initialized)->toBeFalse();
|
||||
})->with([
|
||||
'kernel identification, route-level access prevention' => [
|
||||
'global_middleware' => [InitializeTenancyBySubdomain::class],
|
||||
'route_middleware' => [PreventAccessFromUnwantedDomains::class],
|
||||
],
|
||||
'route-level identification, kernel access prevention' => [
|
||||
'global_middleware' => [PreventAccessFromUnwantedDomains::class],
|
||||
'route_middleware' => [InitializeTenancyBySubdomain::class],
|
||||
],
|
||||
'kernel identification, kernel access prevention' => [
|
||||
'global_middleware' => [PreventAccessFromUnwantedDomains::class, InitializeTenancyBySubdomain::class],
|
||||
'route_middleware' => [],
|
||||
],
|
||||
'route-level identification, route-level access prevention' => [
|
||||
'global_middleware' => [],
|
||||
'route_middleware' => [PreventAccessFromUnwantedDomains::class, InitializeTenancyBySubdomain::class],
|
||||
],
|
||||
// Creates a matrix (multiple with())
|
||||
])->with([
|
||||
'central route middleware' => [['central']],
|
||||
'central route middleware with access prevention' => [['central', PreventAccessFromUnwantedDomains::class]],
|
||||
]);
|
||||
|
|
@ -3,6 +3,7 @@
|
|||
declare(strict_types=1);
|
||||
|
||||
use Illuminate\Support\Facades\Route;
|
||||
use Stancl\Tenancy\Exceptions\TenantCouldNotBeIdentifiedByRequestDataException;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyByRequestData;
|
||||
use Stancl\Tenancy\Tests\Etc\Tenant;
|
||||
|
||||
|
|
@ -13,19 +14,16 @@ beforeEach(function () {
|
|||
],
|
||||
]);
|
||||
|
||||
Route::middleware(InitializeTenancyByRequestData::class)->get('/test', function () {
|
||||
InitializeTenancyByRequestData::$header = 'X-Tenant';
|
||||
InitializeTenancyByRequestData::$cookie = 'X-Tenant';
|
||||
InitializeTenancyByRequestData::$queryParameter = 'tenant';
|
||||
|
||||
Route::middleware(['tenant', InitializeTenancyByRequestData::class])->get('/test', function () {
|
||||
return 'Tenant id: ' . tenant('id');
|
||||
});
|
||||
});
|
||||
|
||||
afterEach(function () {
|
||||
InitializeTenancyByRequestData::$header = 'X-Tenant';
|
||||
InitializeTenancyByRequestData::$cookie = 'X-Tenant';
|
||||
InitializeTenancyByRequestData::$queryParameter = 'tenant';
|
||||
});
|
||||
|
||||
test('header identification works', function () {
|
||||
InitializeTenancyByRequestData::$header = 'X-Tenant';
|
||||
$tenant = Tenant::create();
|
||||
|
||||
$this
|
||||
|
|
@ -36,8 +34,6 @@ test('header identification works', function () {
|
|||
});
|
||||
|
||||
test('query parameter identification works', function () {
|
||||
InitializeTenancyByRequestData::$queryParameter = 'tenant';
|
||||
|
||||
$tenant = Tenant::create();
|
||||
|
||||
$this
|
||||
|
|
@ -47,12 +43,16 @@ test('query parameter identification works', function () {
|
|||
});
|
||||
|
||||
test('cookie identification works', function () {
|
||||
InitializeTenancyByRequestData::$cookie = 'X-Tenant';
|
||||
$tenant = Tenant::create();
|
||||
|
||||
$this
|
||||
->withoutExceptionHandling()
|
||||
->withUnencryptedCookie('X-Tenant', $tenant->id)
|
||||
->get('test',)
|
||||
->get('test')
|
||||
->assertSee($tenant->id);
|
||||
});
|
||||
|
||||
test('middleware throws exception when tenant data is not provided in the request', function () {
|
||||
pest()->expectException(TenantCouldNotBeIdentifiedByRequestDataException::class);
|
||||
$this->withoutExceptionHandling()->get('test');
|
||||
});
|
||||
|
|
|
|||
|
|
@ -631,6 +631,8 @@ test('the listener can be queued', function () {
|
|||
Queue::assertPushed(CallQueuedListener::class, function (CallQueuedListener $job) {
|
||||
return $job->class === UpdateSyncedResource::class;
|
||||
});
|
||||
|
||||
UpdateSyncedResource::$shouldQueue = false;
|
||||
});
|
||||
|
||||
test('an event is fired for all touched resources', function () {
|
||||
|
|
|
|||
|
|
@ -44,6 +44,7 @@ beforeEach(function () {
|
|||
Event::listen(TenancyInitialized::class, BootstrapTenancy::class);
|
||||
Event::listen(TenancyEnded::class, RevertToCentralContext::class);
|
||||
|
||||
// todo1 Is this cleanup needed?
|
||||
UpdateSyncedResource::$shouldQueue = false; // Global state cleanup
|
||||
Event::listen(SyncedResourceSaved::class, UpdateSyncedResource::class);
|
||||
|
||||
|
|
@ -395,4 +396,3 @@ class TenantCompanyUsingPolymorphic extends Model implements Syncable
|
|||
];
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
87
tests/RouteMiddlewareTest.php
Normal file
87
tests/RouteMiddlewareTest.php
Normal file
|
|
@ -0,0 +1,87 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use Illuminate\Contracts\Http\Kernel;
|
||||
use Illuminate\Support\Facades\Route;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyByPath;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyByDomain;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyBySubdomain;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyByRequestData;
|
||||
use Stancl\Tenancy\Middleware\PreventAccessFromUnwantedDomains;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyByDomainOrSubdomain;
|
||||
use Stancl\Tenancy\Tests\Etc\EarlyIdentification\AdditionalMiddleware;
|
||||
|
||||
test('tenancy gets the route middleware correctly', function () {
|
||||
// Kernel middleware should get ignored
|
||||
app(Kernel::class)->pushMiddleware($kernelMiddleware = InitializeTenancyByRequestData::class);
|
||||
Route::middlewareGroup('additional', [AdditionalMiddleware::class, $duplicateMiddleware = InitializeTenancyByDomain::class]);
|
||||
Route::middlewareGroup('tenant', [$duplicateMiddleware, 'additional']);
|
||||
Route::middlewareGroup('middleware', ['tenant']);
|
||||
|
||||
$route = Route::get('/testing-route', function () {
|
||||
return 'testing route';
|
||||
})->middleware([PreventAccessFromUnwantedDomains::class, 'middleware']);
|
||||
|
||||
$expectedRouteMiddleware = [PreventAccessFromUnwantedDomains::class, AdditionalMiddleware::class, InitializeTenancyByDomain::class];
|
||||
|
||||
$routeMiddleware = tenancy()->getRouteMiddleware($route);
|
||||
|
||||
expect($routeMiddleware)->toContain(...$expectedRouteMiddleware);
|
||||
|
||||
// Assert that there's no duplicate middleware
|
||||
expect(array_filter($routeMiddleware, fn ($middleware) => $middleware === $duplicateMiddleware))
|
||||
->toContain($duplicateMiddleware)->toHaveCount(1);
|
||||
|
||||
expect($routeMiddleware)->not()->toContain($kernelMiddleware);
|
||||
});
|
||||
|
||||
test('tenancy detects presence of route middleware correctly', function (string $identificationMiddleware) {
|
||||
// Kernel middleware should get ignored
|
||||
app(Kernel::class)->pushMiddleware(InitializeTenancyByRequestData::class);
|
||||
|
||||
// The 'second-level' group has the identification middleware
|
||||
// The 'surface' group has a 'first-level' group, and that group has a 'second-level' group (three middleware group layers)
|
||||
// Test that the identification middleware is detected even when packed in a middleware group three layers deep
|
||||
Route::middlewareGroup($middlewareGroup = 'surface', ['first-level']);
|
||||
Route::middlewareGroup('first-level', ['second-level']);
|
||||
Route::middlewareGroup('second-level', [$identificationMiddleware]);
|
||||
|
||||
$routeWithIdentificationMiddleware = Route::get('/tenant-route', function () {
|
||||
return 'tenant route';
|
||||
})->middleware($middlewareGroup);
|
||||
|
||||
$route = Route::get('/central-route', function () {
|
||||
return 'central route';
|
||||
});
|
||||
|
||||
expect(tenancy()->routeHasMiddleware($routeWithIdentificationMiddleware, $identificationMiddleware))->toBeTrue();
|
||||
expect(tenancy()->routeHasMiddleware($route, $identificationMiddleware))->toBeFalse();
|
||||
|
||||
// Look specifically for identification middleware
|
||||
expect(tenancy()->routeHasIdentificationMiddleware($routeWithIdentificationMiddleware))->toBeTrue();
|
||||
expect(tenancy()->routeHasIdentificationMiddleware($route))->toBeFalse();
|
||||
})->with([
|
||||
InitializeTenancyByPath::class,
|
||||
InitializeTenancyByRequestData::class,
|
||||
InitializeTenancyByDomain::class,
|
||||
InitializeTenancyBySubdomain::class,
|
||||
InitializeTenancyByDomainOrSubdomain::class,
|
||||
]);
|
||||
|
||||
test('domain identification middleware is configurable', function() {
|
||||
$route = Route::get('/welcome-route', fn () => 'welcome')->middleware([InitializeTenancyByDomain::class]);
|
||||
|
||||
config(['tenancy.identification.domain_identification_middleware' => []]);
|
||||
|
||||
expect(tenancy()->routeHasDomainIdentificationMiddleware($route))->toBeFalse();
|
||||
|
||||
// Set domain identification middleware list back to default
|
||||
config(['tenancy.identification.domain_identification_middleware' => [
|
||||
InitializeTenancyByDomain::class,
|
||||
InitializeTenancyBySubdomain::class,
|
||||
InitializeTenancyByDomainOrSubdomain::class,
|
||||
]]);
|
||||
|
||||
expect(tenancy()->routeHasDomainIdentificationMiddleware($route))->toBeTrue();
|
||||
});
|
||||
|
|
@ -26,6 +26,10 @@ use Stancl\Tenancy\Database\TenantDatabaseManagers\PostgreSQLSchemaManager;
|
|||
use Stancl\Tenancy\Database\TenantDatabaseManagers\SQLiteDatabaseManager;
|
||||
use Stancl\Tenancy\Tests\Etc\Tenant;
|
||||
|
||||
beforeEach(function () {
|
||||
SQLiteDatabaseManager::$path = null;
|
||||
});
|
||||
|
||||
test('databases can be created and deleted', function ($driver, $databaseManager) {
|
||||
Event::listen(TenantCreated::class, JobPipeline::make([CreateDatabase::class])->send(function (TenantCreated $event) {
|
||||
return $event->tenant;
|
||||
|
|
@ -388,6 +392,8 @@ test('path used by sqlite manager can be customized', function () {
|
|||
]);
|
||||
|
||||
expect(file_exists($customPath . '/' . $name))->toBeTrue();
|
||||
|
||||
SQLiteDatabaseManager::$path = null;
|
||||
});
|
||||
|
||||
test('the tenant connection template can be specified either by name or as a connection array', function () {
|
||||
|
|
|
|||
|
|
@ -6,17 +6,20 @@ namespace Stancl\Tenancy\Tests;
|
|||
|
||||
use PDO;
|
||||
use Dotenv\Dotenv;
|
||||
use Stancl\Tenancy\Facades\Tenancy;
|
||||
use Stancl\Tenancy\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;
|
||||
use Stancl\Tenancy\Bootstrappers\RedisTenancyBootstrapper;
|
||||
use Stancl\Tenancy\Bootstrappers\BroadcastTenancyBootstrapper;
|
||||
use Stancl\Tenancy\Facades\Tenancy as TenancyFacade;
|
||||
use Stancl\Tenancy\Bootstrappers\UrlTenancyBootstrapper;
|
||||
use Stancl\Tenancy\Bootstrappers\MailTenancyBootstrapper;
|
||||
use Stancl\Tenancy\Bootstrappers\RedisTenancyBootstrapper;
|
||||
use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper;
|
||||
use Stancl\Tenancy\Bootstrappers\BroadcastTenancyBootstrapper;
|
||||
use Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper;
|
||||
use Stancl\Tenancy\Bootstrappers\PrefixCacheTenancyBootstrapper;
|
||||
|
||||
abstract class TestCase extends \Orchestra\Testbench\TestCase
|
||||
{
|
||||
|
|
@ -106,10 +109,11 @@ abstract class TestCase extends \Orchestra\Testbench\TestCase
|
|||
'--realpath' => true,
|
||||
'--force' => true,
|
||||
],
|
||||
'tenancy.bootstrappers.redis' => RedisTenancyBootstrapper::class, // todo1 change this to []? two tests in TenantDatabaseManagerTest are failing with that
|
||||
'tenancy.bootstrappers.broadcast' => BroadcastTenancyBootstrapper::class, // todo1 change this to []? two tests in TenantDatabaseManagerTest are failing with that
|
||||
'tenancy.bootstrappers.mail' => MailTenancyBootstrapper::class,
|
||||
'tenancy.bootstrappers.url' => UrlTenancyBootstrapper::class,
|
||||
'tenancy.bootstrappers' => [
|
||||
DatabaseTenancyBootstrapper::class,
|
||||
FilesystemTenancyBootstrapper::class,
|
||||
UrlTenancyBootstrapper::class,
|
||||
],
|
||||
'queue.connections.central' => [
|
||||
'driver' => 'sync',
|
||||
'central' => true,
|
||||
|
|
@ -135,7 +139,7 @@ abstract class TestCase extends \Orchestra\Testbench\TestCase
|
|||
protected function getPackageAliases($app)
|
||||
{
|
||||
return [
|
||||
'Tenancy' => Tenancy::class,
|
||||
'Tenancy' => TenancyFacade::class,
|
||||
'GlobalCache' => GlobalCache::class,
|
||||
];
|
||||
}
|
||||
|
|
|
|||
|
|
@ -2,119 +2,532 @@
|
|||
|
||||
declare(strict_types=1);
|
||||
|
||||
use Illuminate\Support\Facades\Route;
|
||||
use Stancl\Tenancy\Exceptions\TenantCouldNotBeIdentifiedOnDomainException;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyByDomain;
|
||||
use Stancl\Tenancy\Middleware\PreventAccessFromUnwantedDomains;
|
||||
use Stancl\Tenancy\Tenancy;
|
||||
use Illuminate\Http\Request;
|
||||
use Illuminate\Routing\Route;
|
||||
use Stancl\Tenancy\Tests\Etc\Tenant;
|
||||
use Illuminate\Contracts\Http\Kernel;
|
||||
use Stancl\Tenancy\Resolvers\PathTenantResolver;
|
||||
use Illuminate\Routing\Controller as BaseController;
|
||||
use Illuminate\Support\Facades\Route as RouteFacade;
|
||||
use Stancl\Tenancy\Actions\CloneRoutesAsTenant;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyByPath;
|
||||
use Stancl\Tenancy\Middleware\IdentificationMiddleware;
|
||||
use Stancl\Tenancy\Resolvers\RequestDataTenantResolver;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyByDomain;
|
||||
use Stancl\Tenancy\Concerns\UsableWithEarlyIdentification;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyBySubdomain;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyByRequestData;
|
||||
use Stancl\Tenancy\Middleware\PreventAccessFromUnwantedDomains;
|
||||
use Stancl\Tenancy\Middleware\InitializeTenancyByDomainOrSubdomain;
|
||||
use Stancl\Tenancy\Exceptions\TenantCouldNotBeIdentifiedByPathException;
|
||||
use Stancl\Tenancy\Exceptions\TenantCouldNotBeIdentifiedOnDomainException;
|
||||
use Stancl\Tenancy\Exceptions\MiddlewareNotUsableWithUniversalRoutesException;
|
||||
use Stancl\Tenancy\Exceptions\TenantCouldNotBeIdentifiedByRequestDataException;
|
||||
use Stancl\Tenancy\RouteMode;
|
||||
|
||||
test('a route can work in both central and tenant context', function (array $routeMiddleware, string|null $globalMiddleware) {
|
||||
if ($globalMiddleware) {
|
||||
app(Kernel::class)->pushMiddleware($globalMiddleware);
|
||||
test('a route can be universal using domain identification', function (array $routeMiddleware, array $globalMiddleware) {
|
||||
foreach ($globalMiddleware as $middleware) {
|
||||
// Instead of a global 'universal' MW, we use the default_route_mode config key to make routes universal by default
|
||||
if ($middleware === 'universal') {
|
||||
config(['tenancy.default_route_mode' => RouteMode::UNIVERSAL]);
|
||||
} else {
|
||||
app(Kernel::class)->pushMiddleware($middleware);
|
||||
}
|
||||
}
|
||||
|
||||
Route::middlewareGroup('universal', []);
|
||||
|
||||
Route::get('/foo', function () {
|
||||
RouteFacade::get('/foo', function () {
|
||||
return tenancy()->initialized
|
||||
? 'Tenancy is initialized.'
|
||||
: 'Tenancy is not initialized.';
|
||||
})->middleware($routeMiddleware);
|
||||
|
||||
$tenant = Tenant::create([
|
||||
'id' => 'acme',
|
||||
]);
|
||||
$tenant = Tenant::create();
|
||||
|
||||
$tenant->domains()->create([
|
||||
'domain' => 'acme.localhost',
|
||||
'domain' => $tenantDomain = $tenant->getTenantKey() . '.localhost',
|
||||
]);
|
||||
|
||||
pest()->get("http://localhost/foo")
|
||||
->assertSuccessful()
|
||||
->assertSee('Tenancy is not initialized.');
|
||||
|
||||
pest()->get("http://acme.localhost/foo")
|
||||
pest()->get("http://{$tenantDomain}/foo")
|
||||
->assertSuccessful()
|
||||
->assertSee('Tenancy is initialized.');
|
||||
})->with('identification types');
|
||||
})->with('domain identification types');
|
||||
|
||||
test('making one route universal doesnt make all routes universal', function (array $routeMiddleware, string|null $globalMiddleware) {
|
||||
if ($globalMiddleware) {
|
||||
app(Kernel::class)->pushMiddleware($globalMiddleware);
|
||||
test('a route can be universal using subdomain identification', function (array $routeMiddleware, array $globalMiddleware) {
|
||||
foreach ($globalMiddleware as $middleware) {
|
||||
if ($middleware === 'universal') {
|
||||
config(['tenancy.default_route_mode' => RouteMode::UNIVERSAL]);
|
||||
} else {
|
||||
app(Kernel::class)->pushMiddleware($middleware);
|
||||
}
|
||||
}
|
||||
|
||||
Route::middlewareGroup('universal', []);
|
||||
RouteFacade::get('/foo', function () {
|
||||
return tenancy()->initialized
|
||||
? 'Tenancy is initialized.'
|
||||
: 'Tenancy is not initialized.';
|
||||
})->middleware($routeMiddleware);
|
||||
|
||||
Route::middleware($routeMiddleware)->group(function () {
|
||||
Route::get('/nonuniversal', function () {
|
||||
return tenant('id');
|
||||
});
|
||||
$tenant = Tenant::create();
|
||||
$tenantKey = $tenant->getTenantKey();
|
||||
|
||||
Route::get('/universal', function () {
|
||||
return tenancy()->initialized
|
||||
? 'Tenancy is initialized.'
|
||||
: 'Tenancy is not initialized.';
|
||||
})->middleware('universal');
|
||||
});
|
||||
|
||||
$tenant = Tenant::create([
|
||||
'id' => 'acme',
|
||||
]);
|
||||
$tenant->domains()->create([
|
||||
'domain' => 'acme.localhost',
|
||||
'domain' => $tenantKey,
|
||||
]);
|
||||
|
||||
pest()->get("http://localhost/universal")
|
||||
pest()->get("http://localhost/foo")
|
||||
->assertSuccessful()
|
||||
->assertSee('Tenancy is not initialized.');
|
||||
|
||||
pest()->get("http://acme.localhost/universal")
|
||||
pest()->get("http://{$tenantKey}.localhost/foo")
|
||||
->assertSuccessful()
|
||||
->assertSee('Tenancy is initialized.');
|
||||
})->with('subdomain identification types');
|
||||
|
||||
test('a route can be universal using domainOrSubdomain identification', function (array $routeMiddleware, array $globalMiddleware) {
|
||||
foreach ($globalMiddleware as $middleware) {
|
||||
if ($middleware === 'universal') {
|
||||
config(['tenancy.default_route_mode' => RouteMode::UNIVERSAL]);
|
||||
} else {
|
||||
app(Kernel::class)->pushMiddleware($middleware);
|
||||
}
|
||||
}
|
||||
|
||||
RouteFacade::get('/foo', function () {
|
||||
return tenancy()->initialized
|
||||
? 'Tenancy is initialized.'
|
||||
: 'Tenancy is not initialized.';
|
||||
})->middleware($routeMiddleware);
|
||||
|
||||
$tenant = Tenant::create();
|
||||
|
||||
$tenant->domains()->create([
|
||||
'domain' => $tenantDomain = 'tenant-domain.test',
|
||||
]);
|
||||
|
||||
$tenant->domains()->create([
|
||||
'domain' => $tenantSubdomain = 'tenant-subdomain',
|
||||
]);
|
||||
|
||||
pest()->get("http://localhost/foo")
|
||||
->assertSuccessful()
|
||||
->assertSee('Tenancy is not initialized.');
|
||||
|
||||
// Domain identification
|
||||
pest()->get("http://{$tenantDomain}/foo")
|
||||
->assertSuccessful()
|
||||
->assertSee('Tenancy is initialized.');
|
||||
|
||||
tenancy()->end();
|
||||
|
||||
pest()->get('http://localhost/nonuniversal')
|
||||
->assertStatus(404);
|
||||
|
||||
pest()->get('http://acme.localhost/nonuniversal')
|
||||
// Subdomain identification
|
||||
pest()->get("http://{$tenantSubdomain}.localhost/foo")
|
||||
->assertSuccessful()
|
||||
->assertSee('acme');
|
||||
})->with([
|
||||
'early identification' => [
|
||||
'route_middleware' => [PreventAccessFromUnwantedDomains::class],
|
||||
'global_middleware' => InitializeTenancyByDomain::class,
|
||||
],
|
||||
'route-level identification' => [
|
||||
'route_middleware' => [PreventAccessFromUnwantedDomains::class, InitializeTenancyByDomain::class],
|
||||
'global_middleware' => null,
|
||||
]
|
||||
]);
|
||||
->assertSee('Tenancy is initialized.');
|
||||
})->with('domainOrSubdomain identification types');
|
||||
|
||||
test('it throws correct exception when route is universal and tenant does not exist', function (array $routeMiddleware, string|null $globalMiddleware) {
|
||||
if ($globalMiddleware) {
|
||||
app(Kernel::class)->pushMiddleware($globalMiddleware);
|
||||
test('a route can be universal using request data identification', function (array $routeMiddleware, array $globalMiddleware) {
|
||||
foreach ($globalMiddleware as $middleware) {
|
||||
if ($middleware === 'universal') {
|
||||
config(['tenancy.default_route_mode' => RouteMode::UNIVERSAL]);
|
||||
} else {
|
||||
app(Kernel::class)->pushMiddleware($middleware);
|
||||
}
|
||||
}
|
||||
|
||||
Route::middlewareGroup('universal', []);
|
||||
RouteFacade::get('/foo', function () {
|
||||
return tenancy()->initialized
|
||||
? 'Tenancy is initialized.'
|
||||
: 'Tenancy is not initialized.';
|
||||
})->middleware($routeMiddleware);
|
||||
|
||||
Route::get('/foo', function () {
|
||||
$tenantKey = Tenant::create()->getTenantKey();
|
||||
|
||||
pest()->get("http://localhost/foo")
|
||||
->assertSuccessful()
|
||||
->assertSee('Tenancy is not initialized.');
|
||||
|
||||
pest()->get("http://localhost/foo?tenant={$tenantKey}")
|
||||
->assertSuccessful()
|
||||
->assertSee('Tenancy is initialized.');
|
||||
})->with('request data identification types');
|
||||
|
||||
test('a route can be universal using path identification', function (array $routeMiddleware, array $globalMiddleware) {
|
||||
foreach ($globalMiddleware as $middleware) {
|
||||
if ($middleware === 'universal') {
|
||||
config(['tenancy.default_route_mode' => RouteMode::UNIVERSAL]);
|
||||
} else {
|
||||
app(Kernel::class)->pushMiddleware($middleware);
|
||||
}
|
||||
}
|
||||
|
||||
RouteFacade::get('/foo', function () {
|
||||
return tenancy()->initialized
|
||||
? 'Tenancy is initialized.'
|
||||
: 'Tenancy is not initialized.';
|
||||
})->middleware($routeMiddleware);
|
||||
|
||||
/** @var CloneRoutesAsTenant $reregisterRoutesAction */
|
||||
$reregisterRoutesAction = app(CloneRoutesAsTenant::class);
|
||||
|
||||
$reregisterRoutesAction->handle();
|
||||
|
||||
$tenantKey = Tenant::create()->getTenantKey();
|
||||
|
||||
pest()->get("http://localhost/foo")
|
||||
->assertSuccessful()
|
||||
->assertSee('Tenancy is not initialized.');
|
||||
|
||||
pest()->get("http://localhost/{$tenantKey}/foo")
|
||||
->assertSuccessful()
|
||||
->assertSee('Tenancy is initialized.');
|
||||
})->with('path identification types');
|
||||
|
||||
test('correct exception is thrown when route is universal and tenant could not be identified using domain identification', function (array $routeMiddleware, array $globalMiddleware) {
|
||||
foreach ($globalMiddleware as $middleware) {
|
||||
if ($middleware === 'universal') {
|
||||
config(['tenancy.default_route_mode' => RouteMode::UNIVERSAL]);
|
||||
} else {
|
||||
app(Kernel::class)->pushMiddleware($middleware);
|
||||
}
|
||||
}
|
||||
|
||||
RouteFacade::get('/foo', function () {
|
||||
return tenancy()->initialized
|
||||
? 'Tenancy is initialized.'
|
||||
: 'Tenancy is not initialized.';
|
||||
})->middleware($routeMiddleware);
|
||||
|
||||
pest()->expectException(TenantCouldNotBeIdentifiedOnDomainException::class);
|
||||
$this->withoutExceptionHandling()->get('http://acme.localhost/foo');
|
||||
})->with('identification types');
|
||||
$this->withoutExceptionHandling()->get('http://nonexistent_domain.localhost/foo');
|
||||
})->with('domain identification types');
|
||||
|
||||
dataset('identification types', [
|
||||
'early identification' => [
|
||||
'route_middleware' => ['universal', PreventAccessFromUnwantedDomains::class],
|
||||
'global_middleware' => InitializeTenancyByDomain::class,
|
||||
],
|
||||
'route-level identification' => [
|
||||
'route_middleware' => ['universal', PreventAccessFromUnwantedDomains::class, InitializeTenancyByDomain::class],
|
||||
'global_middleware' => null,
|
||||
]
|
||||
test('correct exception is thrown when route is universal and tenant could not be identified using subdomain identification', function (array $routeMiddleware, array $globalMiddleware) {
|
||||
foreach ($globalMiddleware as $middleware) {
|
||||
if ($middleware === 'universal') {
|
||||
config(['tenancy.default_route_mode' => RouteMode::UNIVERSAL]);
|
||||
} else {
|
||||
app(Kernel::class)->pushMiddleware($middleware);
|
||||
}
|
||||
}
|
||||
|
||||
RouteFacade::get('/foo', function () {
|
||||
return tenancy()->initialized
|
||||
? 'Tenancy is initialized.'
|
||||
: 'Tenancy is not initialized.';
|
||||
})->middleware($routeMiddleware);
|
||||
|
||||
pest()->expectException(TenantCouldNotBeIdentifiedOnDomainException::class);
|
||||
$this->withoutExceptionHandling()->get('http://nonexistent_subdomain.localhost/foo');
|
||||
})->with('subdomain identification types');
|
||||
|
||||
test('correct exception is thrown when route is universal and tenant could not be identified using path identification', function (array $routeMiddleware, array $globalMiddleware) {
|
||||
foreach ($globalMiddleware as $middleware) {
|
||||
if ($middleware === 'universal') {
|
||||
config(['tenancy.default_route_mode' => RouteMode::UNIVERSAL]);
|
||||
} else {
|
||||
app(Kernel::class)->pushMiddleware($middleware);
|
||||
}
|
||||
}
|
||||
|
||||
RouteFacade::get('/foo', fn () => tenant() ? 'Tenancy is initialized.' : 'Tenancy is not initialized.')->middleware($routeMiddleware)->name('foo');
|
||||
|
||||
/** @var CloneRoutesAsTenant $reregisterRoutesAction */
|
||||
$reregisterRoutesAction = app(CloneRoutesAsTenant::class);
|
||||
|
||||
$reregisterRoutesAction->handle();
|
||||
|
||||
pest()->expectException(TenantCouldNotBeIdentifiedByPathException::class);
|
||||
$this->withoutExceptionHandling()->get('http://localhost/non_existent/foo');
|
||||
})->with('path identification types');
|
||||
|
||||
test('correct exception is thrown when route is universal and tenant could not be identified using request data identification', function (array $routeMiddleware, array $globalMiddleware) {
|
||||
foreach ($globalMiddleware as $middleware) {
|
||||
if ($middleware === 'universal') {
|
||||
config(['tenancy.default_route_mode' => RouteMode::UNIVERSAL]);
|
||||
} else {
|
||||
app(Kernel::class)->pushMiddleware($middleware);
|
||||
}
|
||||
}
|
||||
|
||||
RouteFacade::get('/foo', function () {
|
||||
return tenancy()->initialized
|
||||
? 'Tenancy is initialized.'
|
||||
: 'Tenancy is not initialized.';
|
||||
})->middleware($routeMiddleware);
|
||||
|
||||
pest()->expectException(TenantCouldNotBeIdentifiedByRequestDataException::class);
|
||||
$this->withoutExceptionHandling()->get('http://localhost/foo?tenant=nonexistent_tenant');
|
||||
})->with('request data identification types');
|
||||
|
||||
test('tenant and central flags override the universal flag', function () {
|
||||
app(Kernel::class)->pushMiddleware(InitializeTenancyByRequestData::class);
|
||||
$tenant = Tenant::create();
|
||||
|
||||
$route = RouteFacade::get('/route', fn () => tenant() ? 'Tenancy initialized.' : 'Tenancy not initialized.')->middleware('universal');
|
||||
|
||||
// Route is universal
|
||||
pest()->get('/route')->assertOk()->assertSee('Tenancy not initialized.');
|
||||
pest()->get('/route?tenant=' . $tenant->getTenantKey())->assertOk()->assertSee('Tenancy initialized.');
|
||||
tenancy()->end();
|
||||
|
||||
// Route is in tenant context
|
||||
$route->action['middleware'] = ['universal', 'tenant'];
|
||||
|
||||
pest()->get('/route')->assertServerError(); // "Tenant could not be identified by request data with payload..."
|
||||
pest()->get('/route?tenant=' . $tenant->getTenantKey())->assertOk()->assertSee('Tenancy initialized.');
|
||||
tenancy()->end();
|
||||
|
||||
// Route is in central context
|
||||
$route->action['middleware'] = ['universal', 'central'];
|
||||
|
||||
pest()->get('/route')->assertOk()->assertSee('Tenancy not initialized.');
|
||||
pest()->get('/route?tenant=' . $tenant->getTenantKey())->assertOk()->assertSee('Tenancy not initialized.'); // Route is accessible, but the context is central
|
||||
});
|
||||
|
||||
test('a route can be flagged as universal in both route modes', function (RouteMode $defaultRouteMode) {
|
||||
app(Kernel::class)->pushMiddleware(InitializeTenancyBySubdomain::class);
|
||||
app(Kernel::class)->pushMiddleware(PreventAccessFromUnwantedDomains::class);
|
||||
|
||||
config(['tenancy.default_route_mode' => $defaultRouteMode]);
|
||||
|
||||
RouteFacade::get('/universal', fn () => tenant() ? 'Tenancy is initialized.' : 'Tenancy is not initialized.')->middleware('universal');
|
||||
|
||||
Tenant::create()->domains()->create(['domain' => $tenantSubdomain = 'tenant-subdomain']);
|
||||
|
||||
pest()->get("http://localhost/universal")
|
||||
->assertSuccessful()
|
||||
->assertSee('Tenancy is not initialized.');
|
||||
|
||||
pest()->get("http://{$tenantSubdomain}.localhost/universal")
|
||||
->assertSuccessful()
|
||||
->assertSee('Tenancy is initialized.');
|
||||
})->with([
|
||||
'default to tenant routes' => RouteMode::TENANT,
|
||||
'default to central routes' => RouteMode::CENTRAL,
|
||||
]);
|
||||
|
||||
test('ReregisterRoutesAsTenant registers prefixed duplicates of universal routes correctly', function (bool $kernelIdentification, bool $useController) {
|
||||
$routeMiddleware = ['universal'];
|
||||
|
||||
if ($kernelIdentification) {
|
||||
app(Kernel::class)->pushMiddleware(InitializeTenancyByPath::class);
|
||||
} else {
|
||||
$routeMiddleware[] = InitializeTenancyByPath::class;
|
||||
}
|
||||
|
||||
config(['tenancy.identification.resolvers.' . PathTenantResolver::class . '.tenant_parameter_name' => $tenantParameterName = 'team']);
|
||||
config(['tenancy.identification.resolvers.' . PathTenantResolver::class . '.tenant_route_name_prefix' => $tenantRouteNamePrefix = 'team-route.']);
|
||||
|
||||
// Test that routes with controllers as well as routes with closure actions get re-registered correctly
|
||||
$universalRoute = RouteFacade::get('/home', $useController ? Controller::class : fn () => tenant() ? 'Tenancy initialized.' : 'Tenancy not initialized.')->middleware($routeMiddleware)->name('home');
|
||||
$centralRoute = RouteFacade::get('/central', fn () => true)->name('central');
|
||||
|
||||
expect($routes = RouteFacade::getRoutes()->get())->toContain($universalRoute);
|
||||
expect($routes)->toContain($centralRoute);
|
||||
|
||||
/** @var CloneRoutesAsTenant $reregisterRoutesAction */
|
||||
$reregisterRoutesAction = app(CloneRoutesAsTenant::class);
|
||||
|
||||
$reregisterRoutesAction->handle();
|
||||
|
||||
expect($routesAfterRegisteringDuplicates = RouteFacade::getRoutes()->get())
|
||||
->toContain($universalRoute)
|
||||
->toContain($centralRoute);
|
||||
|
||||
$newRoute = collect($routesAfterRegisteringDuplicates)->filter(fn ($route) => ! in_array($route, $routes))->first();
|
||||
|
||||
expect($newRoute->uri())->toBe('{' . $tenantParameterName . '}' . '/' . $universalRoute->uri());
|
||||
expect(tenancy()->getRouteMiddleware($newRoute))->toBe(array_merge(tenancy()->getRouteMiddleware($universalRoute), ['tenant']));
|
||||
|
||||
$tenant = Tenant::create();
|
||||
|
||||
pest()->get(route($centralRouteName = $universalRoute->getName()))->assertSee('Tenancy not initialized.');
|
||||
pest()->get(route($tenantRouteName = $newRoute->getName(), [$tenantParameterName => $tenant->getTenantKey()]))->assertSee('Tenancy initialized.');
|
||||
|
||||
expect($tenantRouteName)->toBe($tenantRouteNamePrefix . $universalRoute->getName());
|
||||
expect($centralRouteName)->toBe($universalRoute->getName());
|
||||
})->with([
|
||||
'kernel identification' => true,
|
||||
'route-level identification' => false,
|
||||
// Creates a matrix (multiple with())
|
||||
])->with([
|
||||
'use controller' => true,
|
||||
'use closure' => false
|
||||
]);
|
||||
|
||||
test('tenant resolver methods return the correct names for configured values', function (string $configurableParameter, string $value) {
|
||||
$configurableParameterConfigKey = 'tenancy.identification.resolvers.' . PathTenantResolver::class . '.' . $configurableParameter;
|
||||
|
||||
config([$configurableParameterConfigKey => $value]);
|
||||
|
||||
// Note: The names of the methods are NOT dynamic (PathTenantResolver::tenantParameterName(), PathTenantResolver::tenantRouteNamePrefix())
|
||||
$resolverMethodName = str($configurableParameter)->camel()->toString();
|
||||
|
||||
expect(PathTenantResolver::$resolverMethodName())->toBe($value);
|
||||
})->with([
|
||||
['tenant_parameter_name', 'parameter'],
|
||||
['tenant_route_name_prefix', 'prefix']
|
||||
]);
|
||||
|
||||
test('ReregisterRoutesAsTenant only re-registers routes with path identification by default', function () {
|
||||
app(Kernel::class)->pushMiddleware(InitializeTenancyByPath::class);
|
||||
|
||||
$currentRouteCount = fn () => count(RouteFacade::getRoutes()->get());
|
||||
|
||||
$initialRouteCount = $currentRouteCount();
|
||||
|
||||
// Path identification is used globally, and this route doesn't use a specific identification middleware, meaning path identification is used and the route should get re-registered
|
||||
RouteFacade::get('/home', fn () => tenant() ? 'Tenancy initialized.' : 'Tenancy not initialized.')->middleware('universal')->name('home');
|
||||
// The route uses a specific identification middleware other than InitializeTenancyByPath – the route shouldn't get re-registered
|
||||
RouteFacade::get('/home-domain-id', fn () => tenant() ? 'Tenancy initialized.' : 'Tenancy not initialized.')->middleware(['universal', InitializeTenancyByDomain::class])->name('home-domain-id');
|
||||
|
||||
expect($currentRouteCount())->toBe($newRouteCount = $initialRouteCount + 2);
|
||||
|
||||
/** @var CloneRoutesAsTenant $reregisterRoutesAction */
|
||||
$reregisterRoutesAction = app(CloneRoutesAsTenant::class);
|
||||
|
||||
$reregisterRoutesAction->handle();
|
||||
|
||||
// Only one of the two routes gets re-registered
|
||||
expect($currentRouteCount())->toBe($newRouteCount + 1);
|
||||
});
|
||||
|
||||
test('custom callbacks can be used for reregistering universal routes', function () {
|
||||
RouteFacade::get('/home', fn () => tenant() ? 'Tenancy initialized.' : 'Tenancy not initialized.')->middleware('universal')->name($routeName = 'home');
|
||||
|
||||
/** @var CloneRoutesAsTenant $reregisterRoutesAction */
|
||||
$reregisterRoutesAction = app(CloneRoutesAsTenant::class);
|
||||
$currentRouteCount = fn () => count(RouteFacade::getRoutes()->get());
|
||||
$initialRouteCount = $currentRouteCount();
|
||||
|
||||
// Skip re-registering the 'home' route
|
||||
$reregisterRoutesAction->cloneUsing($routeName, function (Route $route) {
|
||||
return;
|
||||
})->handle();
|
||||
|
||||
// Expect route count to stay the same because the 'home' route re-registration gets skipped
|
||||
expect($initialRouteCount)->toEqual($currentRouteCount());
|
||||
|
||||
// Modify the 'home' route re-registration so that a different route is registered
|
||||
$reregisterRoutesAction->cloneUsing($routeName, function (Route $route) {
|
||||
RouteFacade::get('/newly-registered-route', fn() => true)->name('new.home');
|
||||
})->handle();
|
||||
|
||||
expect($currentRouteCount())->toEqual($initialRouteCount + 1);
|
||||
});
|
||||
|
||||
test('reregistration of specific routes can get skipped', function () {
|
||||
RouteFacade::get('/home', fn () => tenant() ? 'Tenancy initialized.' : 'Tenancy not initialized.')->middleware('universal')->name($routeName = 'home');
|
||||
|
||||
/** @var CloneRoutesAsTenant $reregisterRoutesAction */
|
||||
$reregisterRoutesAction = app(CloneRoutesAsTenant::class);
|
||||
$currentRouteCount = fn () => count(RouteFacade::getRoutes()->get());
|
||||
$initialRouteCount = $currentRouteCount();
|
||||
|
||||
// Skip re-registering the 'home' route
|
||||
$reregisterRoutesAction->skipRoute($routeName)->handle();
|
||||
|
||||
// Expect route count to stay the same because the 'home' route re-registration gets skipped
|
||||
expect($initialRouteCount)->toEqual($currentRouteCount());
|
||||
});
|
||||
|
||||
|
||||
test('identification middleware works with universal routes only when it implements MiddlewareUsableWithUniversalRoutes', function () {
|
||||
$tenantKey = Tenant::create()->getTenantKey();
|
||||
$routeAction = fn () => tenancy()->initialized ? $tenantKey : 'Tenancy is not initialized.';
|
||||
|
||||
// Route with the package's request data identification middleware – implements MiddlewareUsableWithUniversalRoutes
|
||||
RouteFacade::get('/universal-route', $routeAction)->middleware(['universal', InitializeTenancyByRequestData::class]);
|
||||
|
||||
// Routes with custom request data identification middleware – does not implement MiddlewareUsableWithUniversalRoutes
|
||||
RouteFacade::get('/custom-mw-universal-route', $routeAction)->middleware(['universal', CustomMiddleware::class]);
|
||||
RouteFacade::get('/custom-mw-tenant-route', $routeAction)->middleware(['tenant', CustomMiddleware::class]);
|
||||
|
||||
// Ensure the custom identification middleware works with non-universal routes
|
||||
// This is tested here because this is the only test where the custom MW is used
|
||||
// No exception is thrown for this request since the route uses the TENANT middleware, not the UNIVERSAL middleware
|
||||
pest()->get('http://localhost/custom-mw-tenant-route?tenant=' . $tenantKey)->assertOk()->assertSee($tenantKey);
|
||||
|
||||
pest()->get('http://localhost/universal-route')->assertOk();
|
||||
pest()->get('http://localhost/universal-route?tenant=' . $tenantKey)->assertOk()->assertSee($tenantKey);
|
||||
|
||||
pest()->expectException(MiddlewareNotUsableWithUniversalRoutesException::class);
|
||||
$this->withoutExceptionHandling()->get('http://localhost/custom-mw-universal-route');
|
||||
});
|
||||
|
||||
foreach ([
|
||||
'domain identification types' => [PreventAccessFromUnwantedDomains::class, InitializeTenancyByDomain::class],
|
||||
'subdomain identification types' => [PreventAccessFromUnwantedDomains::class, InitializeTenancyBySubdomain::class],
|
||||
'domainOrSubdomain identification types' => [PreventAccessFromUnwantedDomains::class, InitializeTenancyByDomainOrSubdomain::class],
|
||||
'path identification types' => [InitializeTenancyByPath::class],
|
||||
'request data identification types' => [InitializeTenancyByRequestData::class],
|
||||
] as $datasetName => $middleware) {
|
||||
dataset($datasetName, [
|
||||
'kernel identification' => [
|
||||
'route_middleware' => ['universal'],
|
||||
'global_middleware' => $middleware,
|
||||
],
|
||||
'route-level identification' => [
|
||||
'route_middleware' => ['universal', ...$middleware],
|
||||
'global_middleware' => [],
|
||||
],
|
||||
'kernel identification + defaulting to universal routes' => [
|
||||
'route_middleware' => [],
|
||||
'global_middleware' => ['universal', ...$middleware],
|
||||
],
|
||||
'route-level identification + defaulting to universal routes' => [
|
||||
'route_middleware' => $middleware,
|
||||
'global_middleware' => ['universal'],
|
||||
],
|
||||
]);
|
||||
}
|
||||
|
||||
class Controller extends BaseController
|
||||
{
|
||||
public function __invoke()
|
||||
{
|
||||
return tenant() ? 'Tenancy initialized.' : 'Tenancy not initialized.';
|
||||
}
|
||||
}
|
||||
|
||||
class CustomMiddleware extends IdentificationMiddleware
|
||||
{
|
||||
use UsableWithEarlyIdentification;
|
||||
|
||||
public static string $header = 'X-Tenant';
|
||||
public static string $cookie = 'X-Tenant';
|
||||
public static string $queryParameter = 'tenant';
|
||||
|
||||
public function __construct(
|
||||
protected Tenancy $tenancy,
|
||||
protected RequestDataTenantResolver $resolver,
|
||||
) {
|
||||
}
|
||||
|
||||
/** @return \Illuminate\Http\Response|mixed */
|
||||
public function handle(Request $request, Closure $next): mixed
|
||||
{
|
||||
if ($this->shouldBeSkipped(tenancy()->getRoute($request))) {
|
||||
// Allow accessing central route in kernel identification
|
||||
return $next($request);
|
||||
}
|
||||
|
||||
return $this->initializeTenancy($request, $next, $this->getPayload($request));
|
||||
}
|
||||
|
||||
protected function getPayload(Request $request): string|array|null
|
||||
{
|
||||
if (static::$header && $request->hasHeader(static::$header)) {
|
||||
return $request->header(static::$header);
|
||||
} elseif (static::$queryParameter && $request->has(static::$queryParameter)) {
|
||||
return $request->get(static::$queryParameter);
|
||||
} elseif (static::$cookie && $request->hasCookie(static::$cookie)) {
|
||||
return $request->cookie(static::$cookie);
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue