mirror of
https://github.com/archtechx/tenancy.git
synced 2025-12-12 18:44:03 +00:00
389 lines
14 KiB
PHP
389 lines
14 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
use Illuminate\Support\Facades\Event;
|
|
use Stancl\Tenancy\Tests\Etc\Tenant;
|
|
use Stancl\Tenancy\Events\TenancyEnded;
|
|
use Stancl\Tenancy\Events\TenancyInitialized;
|
|
use Stancl\Tenancy\Listeners\BootstrapTenancy;
|
|
use Stancl\Tenancy\Listeners\RevertToCentralContext;
|
|
use Stancl\Tenancy\Bootstrappers\LogTenancyBootstrapper;
|
|
use Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper;
|
|
|
|
beforeEach(function () {
|
|
config([
|
|
'tenancy.bootstrappers' => [
|
|
// FilesystemTenancyBootstrapper needed for storage path channels (added in tests that check the storage path channel logic)
|
|
LogTenancyBootstrapper::class,
|
|
],
|
|
]);
|
|
|
|
// Reset static properties
|
|
LogTenancyBootstrapper::$channelOverrides = [];
|
|
LogTenancyBootstrapper::$storagePathChannels = ['single', 'daily'];
|
|
|
|
Event::listen(TenancyInitialized::class, BootstrapTenancy::class);
|
|
Event::listen(TenancyEnded::class, RevertToCentralContext::class);
|
|
});
|
|
|
|
afterEach(function () {
|
|
LogTenancyBootstrapper::$channelOverrides = [];
|
|
LogTenancyBootstrapper::$storagePathChannels = ['single', 'daily'];
|
|
});
|
|
|
|
test('storage path channels get tenant-specific paths', function () {
|
|
// Note that for LogTenancyBootstrapper to change the paths correctly,
|
|
// the bootstrapper MUST run after FilesystemTenancyBootstrapper.
|
|
config([
|
|
'tenancy.bootstrappers' => [
|
|
FilesystemTenancyBootstrapper::class,
|
|
LogTenancyBootstrapper::class,
|
|
],
|
|
]);
|
|
|
|
$tenant = Tenant::create();
|
|
|
|
// Storage path channels are 'single' and 'daily' by default.
|
|
// This can be customized via LogTenancyBootstrapper::$storagePathChannels.
|
|
foreach (LogTenancyBootstrapper::$storagePathChannels as $channel) {
|
|
config(['logging.default' => $channel]);
|
|
|
|
$originalPath = config("logging.channels.{$channel}.path");
|
|
|
|
tenancy()->initialize($tenant);
|
|
|
|
// Path should now point to the log in the tenant's storage directory
|
|
$tenantLogPath = "storage/tenant{$tenant->id}/logs/laravel.log";
|
|
expect(config("logging.channels.{$channel}.path"))
|
|
->not()->toBe($originalPath)
|
|
->toEndWith($tenantLogPath);
|
|
|
|
tenancy()->end();
|
|
|
|
// Path should be reverted
|
|
expect(config("logging.channels.{$channel}.path"))->toBe($originalPath);
|
|
}
|
|
});
|
|
|
|
test('all channels included in the log stack get processed', function () {
|
|
config([
|
|
'tenancy.bootstrappers' => [
|
|
FilesystemTenancyBootstrapper::class,
|
|
LogTenancyBootstrapper::class,
|
|
],
|
|
'logging.default' => 'stack',
|
|
'logging.channels.stack' => [
|
|
'driver' => 'stack',
|
|
'channels' => ['single', 'daily'],
|
|
],
|
|
]);
|
|
|
|
$originalSinglePath = config('logging.channels.single.path');
|
|
$originalDailyPath = config('logging.channels.daily.path');
|
|
|
|
$tenant = Tenant::create();
|
|
|
|
tenancy()->initialize($tenant);
|
|
|
|
// Both channels in the stack should be updated
|
|
expect(config('logging.channels.single.path'))->not()->toBe($originalSinglePath);
|
|
expect(config('logging.channels.daily.path'))->not()->toBe($originalDailyPath);
|
|
|
|
tenancy()->end();
|
|
|
|
expect(config('logging.channels.single.path'))->toBe($originalSinglePath);
|
|
expect(config('logging.channels.daily.path'))->toBe($originalDailyPath);
|
|
});
|
|
|
|
test('channel overrides work correctly with both arrays and closures', function () {
|
|
config([
|
|
'logging.default' => 'slack',
|
|
'logging.channels.slack' => [
|
|
'driver' => 'slack',
|
|
'url' => $originalSlackUrl = 'default-webhook',
|
|
'username' => 'Default',
|
|
],
|
|
]);
|
|
|
|
$tenant = Tenant::create(['id' => 'tenant1', 'webhookUrl' => 'tenant-webhook']);
|
|
|
|
// Specify channel override for 'slack' channel using an array
|
|
LogTenancyBootstrapper::$channelOverrides = [
|
|
'slack' => [
|
|
'url' => 'webhookUrl', // $tenant->webhookUrl will be used
|
|
],
|
|
];
|
|
|
|
tenancy()->initialize($tenant);
|
|
|
|
expect(config('logging.channels.slack.url'))->toBe($tenant->webhookUrl);
|
|
expect(config('logging.channels.slack.username'))->toBe('Default'); // Default username -- remains default unless specified
|
|
|
|
tenancy()->end();
|
|
|
|
// After tenancy ends, the original config should be restored
|
|
expect(config('logging.channels.slack.url'))->toBe($originalSlackUrl);
|
|
|
|
// Now, use closure to set the slack username to $tenant->id (tenant1)
|
|
LogTenancyBootstrapper::$channelOverrides['slack'] = function ($config, $tenant) {
|
|
$config->set('logging.channels.slack.username', $tenant->id);
|
|
};
|
|
|
|
tenancy()->initialize($tenant);
|
|
|
|
expect(config('logging.channels.slack.url'))->toBe($originalSlackUrl); // Unchanged
|
|
expect(config('logging.channels.slack.username'))->toBe($tenant->id);
|
|
|
|
tenancy()->end();
|
|
|
|
// Config reverted back to original
|
|
expect(config('logging.channels.slack.username'))->toBe('Default');
|
|
});
|
|
|
|
test('channel overrides take precedence over the default storage path channel updating logic', function () {
|
|
config(['logging.default' => 'single']);
|
|
|
|
$tenant = Tenant::create(['id' => 'tenant1']);
|
|
|
|
LogTenancyBootstrapper::$channelOverrides = [
|
|
'single' => function ($config, $tenant) {
|
|
$config->set('logging.channels.single.path', storage_path("logs/override-{$tenant->id}.log"));
|
|
},
|
|
];
|
|
|
|
tenancy()->initialize($tenant);
|
|
|
|
// Should use override, not the default storage path updating behavior
|
|
expect(config('logging.channels.single.path'))->toEndWith('storage/logs/override-tenant1.log');
|
|
});
|
|
|
|
test('multiple channel overrides work together', function () {
|
|
config([
|
|
'logging.default' => 'stack',
|
|
'logging.channels.stack' => [
|
|
'driver' => 'stack',
|
|
'channels' => ['slack', 'single'],
|
|
],
|
|
]);
|
|
|
|
$originalSinglePath = config('logging.channels.single.path');
|
|
$originalSlackUrl = config('logging.channels.slack.url');
|
|
|
|
$tenant = Tenant::create(['id' => 'tenant1', 'slackUrl' => 'tenant-slack']);
|
|
|
|
LogTenancyBootstrapper::$channelOverrides = [
|
|
'slack' => ['url' => 'slackUrl'],
|
|
'single' => function ($config, $tenant) {
|
|
$config->set('logging.channels.single.path', storage_path("logs/override-{$tenant->id}.log"));
|
|
},
|
|
];
|
|
|
|
tenancy()->initialize($tenant);
|
|
|
|
expect(config('logging.channels.slack.url'))->toBe('tenant-slack');
|
|
expect(config('logging.channels.single.path'))->toEndWith('storage/logs/override-tenant1.log');
|
|
|
|
tenancy()->end();
|
|
|
|
expect(config('logging.channels.slack.url'))->toBe($originalSlackUrl);
|
|
expect(config('logging.channels.single.path'))->toBe($originalSinglePath);
|
|
});
|
|
|
|
test('channels are forgotten and re-resolved during bootstrap and revert', function () {
|
|
config([
|
|
'tenancy.bootstrappers' => [
|
|
FilesystemTenancyBootstrapper::class,
|
|
LogTenancyBootstrapper::class,
|
|
],
|
|
'logging.default' => 'single'
|
|
]);
|
|
|
|
$logManager = app('log');
|
|
$originalChannel = $logManager->channel('single');
|
|
$originalSinglePath = config('logging.channels.single.path');
|
|
|
|
$tenant = Tenant::create();
|
|
|
|
tenancy()->initialize($tenant);
|
|
|
|
// After bootstrap, the channel should be a new instance with the updated config
|
|
$tenantChannel = $logManager->channel('single');
|
|
$tenantSingleChannelPath = $tenantChannel->getLogger()->getHandlers()[0]->getUrl();
|
|
|
|
expect($tenantChannel)->not()->toBe($originalChannel);
|
|
expect($tenantSingleChannelPath)
|
|
->not()->toBe($originalSinglePath)
|
|
->toEndWith("storage/tenant{$tenant->id}/logs/laravel.log");
|
|
|
|
tenancy()->end();
|
|
|
|
// After revert, the channel should get re-resolved with the original config
|
|
$currentChannel = $logManager->channel('single');
|
|
$currentChannelPath = $currentChannel->getLogger()->getHandlers()[0]->getUrl();
|
|
|
|
expect($currentChannel)->not()->toBe($tenantChannel);
|
|
expect($currentChannelPath)->toBe($originalSinglePath);
|
|
});
|
|
|
|
// Test real usage
|
|
test('logs are written to tenant-specific files and do not leak between contexts', function () {
|
|
config([
|
|
'tenancy.bootstrappers' => [
|
|
FilesystemTenancyBootstrapper::class,
|
|
LogTenancyBootstrapper::class,
|
|
],
|
|
'logging.default' => 'single',
|
|
]);
|
|
|
|
$centralLogPath = storage_path('logs/laravel.log');
|
|
|
|
logger('central');
|
|
|
|
expect(file_get_contents($centralLogPath))->toContain('central');
|
|
|
|
[$tenant1, $tenant2] = [Tenant::create(['id' => 'tenant1']), Tenant::create(['id' => 'tenant2'])];
|
|
|
|
tenancy()->runForMultiple([$tenant1, $tenant2], function (Tenant $tenant) use ($centralLogPath) {
|
|
logger($tenant->id);
|
|
|
|
$tenantLogPath = storage_path('logs/laravel.log');
|
|
|
|
// The log gets saved to the tenant's storage directory (default behavior)
|
|
expect($tenantLogPath)
|
|
->not()->toBe($centralLogPath)
|
|
->toEndWith("storage/tenant{$tenant->id}/logs/laravel.log");
|
|
|
|
expect(file_get_contents($tenantLogPath))
|
|
->toContain($tenant->id)
|
|
->not()->toContain('central');
|
|
});
|
|
|
|
// Tenant log messages didn't leak into central log
|
|
expect(file_get_contents($centralLogPath))
|
|
->toContain('central')
|
|
->not()->toContain('tenant1')
|
|
->not()->toContain('tenant2');
|
|
|
|
// Tenant log messages didn't leak to logs of other tenants
|
|
tenancy()->initialize($tenant1);
|
|
|
|
expect(file_get_contents(storage_path('logs/laravel.log')))
|
|
->toContain('tenant1')
|
|
->not()->toContain('central')
|
|
->not()->toContain('tenant2');
|
|
|
|
tenancy()->initialize($tenant2);
|
|
|
|
expect(file_get_contents(storage_path('logs/laravel.log')))
|
|
->toContain('tenant2')
|
|
->not()->toContain('central')
|
|
->not()->toContain('tenant1');
|
|
|
|
// Overriding the channels also works
|
|
// Channel overrides also override the default behavior for the storage path-based channels
|
|
$tenant = Tenant::create(['id' => 'override-tenant']);
|
|
|
|
LogTenancyBootstrapper::$channelOverrides = [
|
|
'single' => function ($config, $tenant) {
|
|
// The tenant log path will be set to storage/tenantoverride-tenant/logs/custom-override-tenant.log
|
|
$config->set('logging.channels.single.path', storage_path("logs/custom-{$tenant->id}.log"));
|
|
},
|
|
];
|
|
|
|
// Tenant context log (should use custom path due to override)
|
|
tenancy()->initialize($tenant);
|
|
|
|
logger('tenant-override');
|
|
|
|
expect(file_get_contents(storage_path('logs/custom-override-tenant.log')))->toContain('tenant-override');
|
|
});
|
|
|
|
test('stack logs are written to all configured channels with tenant-specific paths', function () {
|
|
config([
|
|
'tenancy.bootstrappers' => [
|
|
FilesystemTenancyBootstrapper::class,
|
|
LogTenancyBootstrapper::class,
|
|
],
|
|
'logging.default' => 'stack',
|
|
'logging.channels.stack' => [
|
|
'driver' => 'stack',
|
|
'channels' => ['single', 'daily'],
|
|
],
|
|
]);
|
|
|
|
$tenant = Tenant::create(['id' => 'stack-tenant']);
|
|
$today = now()->format('Y-m-d');
|
|
|
|
// Central context stack log
|
|
logger('central');
|
|
$centralSingleLogPath = storage_path('logs/laravel.log');
|
|
$centralDailyLogPath = storage_path("logs/laravel-{$today}.log");
|
|
|
|
expect(file_get_contents($centralSingleLogPath))->toContain('central');
|
|
expect(file_get_contents($centralDailyLogPath))->toContain('central');
|
|
|
|
// Tenant context stack log
|
|
tenancy()->initialize($tenant);
|
|
logger('tenant');
|
|
$tenantSingleLogPath = storage_path('logs/laravel.log');
|
|
$tenantDailyLogPath = storage_path("logs/laravel-{$today}.log");
|
|
|
|
expect(file_get_contents($tenantSingleLogPath))->toContain('tenant');
|
|
expect(file_get_contents($tenantDailyLogPath))->toContain('tenant');
|
|
|
|
// Verify tenant logs don't contain central messages
|
|
expect(file_get_contents($tenantSingleLogPath))->not()->toContain('central');
|
|
expect(file_get_contents($tenantDailyLogPath))->not()->toContain('central');
|
|
|
|
tenancy()->end();
|
|
|
|
// Verify central logs still only contain the central messages
|
|
expect(file_get_contents($centralSingleLogPath))
|
|
->toContain('central')
|
|
->not()->toContain('tenant');
|
|
|
|
expect(file_get_contents($centralDailyLogPath))
|
|
->toContain('central')
|
|
->not()->toContain('tenant');
|
|
});
|
|
|
|
test('slack channel uses correct webhook urls', function () {
|
|
config([
|
|
'logging.default' => 'slack',
|
|
'logging.channels.slack.url' => 'central-webhook',
|
|
'logging.channels.slack.level' => 'debug', // Set level to debug to keep the tests simple, since the default level here is 'critical'
|
|
]);
|
|
|
|
$tenant1 = Tenant::create(['id' => 'tenant1', 'slackUrl' => 'tenant1-webhook']);
|
|
$tenant2 = Tenant::create(['id' => 'tenant2', 'slackUrl' => 'tenant2-webhook']);
|
|
|
|
LogTenancyBootstrapper::$channelOverrides = [
|
|
'slack' => ['url' => 'slackUrl'],
|
|
];
|
|
|
|
// Test central context - should attempt to use central webhook
|
|
// Because the Slack channel uses cURL to send messages, we cannot use Http::fake() here.
|
|
// Instead, we catch the exception and check the error message which contains the actual webhook URL.
|
|
try {
|
|
logger('central');
|
|
} catch (Exception $e) {
|
|
expect($e->getMessage())->toContain('central-webhook');
|
|
}
|
|
|
|
// Slack channel should attempt to use the tenant-specific webhooks
|
|
tenancy()->runForMultiple([$tenant1, $tenant2], function (Tenant $tenant) {
|
|
try {
|
|
logger($tenant->id);
|
|
} catch (Exception $e) {
|
|
expect($e->getMessage())->toContain($tenant->slackUrl);
|
|
}
|
|
});
|
|
|
|
// Central context, central webhook should be used again
|
|
try {
|
|
logger('central');
|
|
} catch (Exception $e) {
|
|
expect($e->getMessage())->toContain('central-webhook');
|
|
}
|
|
});
|