Merge ae39e4dfd4 into 37b2a91aa9

src/Bootstrappers/LogTenancyBootstrapper.php

@@ -0,0 +1,140 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Bootstrappers;
+
+use Closure;
+use Illuminate\Contracts\Config\Repository as Config;
+use Illuminate\Log\LogManager;
+use Stancl\Tenancy\Contracts\TenancyBootstrapper;
+use Stancl\Tenancy\Contracts\Tenant;
+
+/**
+ * This bootstrapper makes it possible to configure tenant-specific logging.
+ *
+ * By default, the storage path channels ('single' and 'daily' by default,
+ * but feel free to customize that using the $storagePathChannels property)
+ * are configured to use tenant storage directories.
+ * For this to work correctly, this bootstrapper must run *after* FilesystemTenancyBootstrapper.
+ * FilesystemTenancyBootstrapper alters how storage_path() works in the tenant context.
+ *
+ * The bootstrapper also supports custom channel overrides via the $channelOverrides property (see the property's docblock).
+ *
+ * @see Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper
+ */
+class LogTenancyBootstrapper implements TenancyBootstrapper
+{
+    protected array $defaultConfig = [];
+
+    /**
+     * Log channels that use the storage_path() helper for storing the logs. Requires FilesystemTenancyBootstrapper to run before this bootstrapper.
+     * Or you can bypass this default behavior by using overrides, since they take precedence over the default behavior.
+     */
+    public static array $storagePathChannels = ['single', 'daily'];
+
+    /**
+     * Custom channel configuration overrides.
+     *
+     * Examples:
+     * - Array mapping (the default approach): ['slack' => ['url' => 'webhookUrl']] maps $tenant->webhookUrl to slack.url (if $tenant->webhookUrl is not null, otherwise, the override is ignored)
+     * - Closure: ['slack' => fn (Tenant $tenant, array $channel) => array_merge($channel, ['url' => $tenant->slackUrl])]
+     */
+    public static array $channelOverrides = [];
+
+    public function __construct(
+        protected Config $config,
+        protected LogManager $logManager,
+    ) {}
+
+    public function bootstrap(Tenant $tenant): void
+    {
+        $this->defaultConfig = $this->config->get('logging.channels');
+        $channels = $this->getChannels();
+
+        $this->configureChannels($channels, $tenant);
+        $this->forgetChannels($channels);
+    }
+
+    public function revert(): void
+    {
+        $this->config->set('logging.channels', $this->defaultConfig);
+
+        $this->forgetChannels($this->getChannels());
+    }
+
+    /**
+     * Channels to configure and re-resolve afterwards (including the channels in the log stack).
+     */
+    protected function getChannels(): array
+    {
+        // Get the currently used (default) logging channel
+        $defaultChannel = $this->config->get('logging.default');
+        $channelIsStack = $this->config->get("logging.channels.{$defaultChannel}.driver") === 'stack';
+
+        // If the default channel is stack, also get all the channels it contains.
+        // The stack channel also has to be included in the list of channels
+        // since the channel will be resolved and saved in the log manager,
+        // and its config could accidentally be used instead of the underlying channels.
+        //
+        // For example, when you use 'stack' with the 'slack' channel and you want to configure the webhook URL,
+        // both the 'stack' and the 'slack' must be re-resolved after updating the config for the channels to use the correct webhook URLs.
+        // If only one of the mentioned channels would be re-resolved, the other's webhook URL would be used for logging.
+        $channels = $channelIsStack
+            ? [$defaultChannel, ...$this->config->get("logging.channels.{$defaultChannel}.channels")]
+            : [$defaultChannel];
+
+        return $channels;
+    }
+
+    /**
+     * Configure channels for the tenant context.
+     *
+     * Only the channels that are in the $storagePathChannels array
+     * or have custom overrides in the $channelOverrides property
+     * will be configured.
+     */
+    protected function configureChannels(array $channels, Tenant $tenant): void
+    {
+        foreach ($channels as $channel) {
+            if (isset(static::$channelOverrides[$channel])) {
+                $this->overrideChannelConfig($channel, static::$channelOverrides[$channel], $tenant);
+            } elseif (in_array($channel, static::$storagePathChannels)) {
+                // Set storage path channels to use tenant-specific directory (default behavior)
+                // The tenant log will be located at e.g. "storage/tenant{$tenantKey}/logs/laravel.log" (assuming FilesystemTenancyBootstrapper is used before this bootstrapper)
+                $this->config->set("logging.channels.{$channel}.path", storage_path('logs/laravel.log'));
+            }
+        }
+    }
+
+    protected function overrideChannelConfig(string $channel, array|Closure $override, Tenant $tenant): void
+    {
+        if (is_array($override)) {
+            // Map tenant attributes to channel config keys.
+            // If the tenant attribute is null,
+            // the override is ignored and the channel config key's value remains unchanged.
+            foreach ($override as $configKey => $tenantAttributeName) {
+                $tenantAttribute = $tenant->getAttribute($tenantAttributeName);
+
+                if ($tenantAttribute !== null) {
+                    $this->config->set("logging.channels.{$channel}.{$configKey}", $tenantAttribute);
+                }
+            }
+        } elseif ($override instanceof Closure) {
+            $channelConfigKey = "logging.channels.{$channel}";
+
+            $this->config->set($channelConfigKey, $override($tenant, $this->config->get($channelConfigKey)));
+        }
+    }
+
+    /**
+     * Forget all passed channels so they can be re-resolved
+     * with updated config on the next logging attempt.
+     */
+    protected function forgetChannels(array $channels): void
+    {
+        foreach ($channels as $channel) {
+            $this->logManager->forgetChannel($channel);
+        }
+    }
+}

tests/Bootstrappers/LogTenancyBootstrapperTest.php

@@ -0,0 +1,382 @@
+<?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 LogTenancyBootstrapper to work with storage path channels BY DEFAULT (note that this can be completely overridden)
+            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 by default', function () {
+    // Note that for LogTenancyBootstrapper to change the paths correctly by default,
+    // the bootstrapper MUST run after FilesystemTenancyBootstrapper.
+    config([
+        'tenancy.bootstrappers' => [
+            FilesystemTenancyBootstrapper::class,
+            LogTenancyBootstrapper::class,
+        ],
+    ]);
+
+    $centralStoragePath = storage_path();
+    $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 = "{$centralStoragePath}/tenant{$tenant->id}/logs/laravel.log";
+        expect(config("logging.channels.{$channel}.path"))
+            ->not()->toBe($originalPath)
+            ->toBe($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 correctly', function () {
+    config([
+        'tenancy.bootstrappers' => [
+            FilesystemTenancyBootstrapper::class,
+            LogTenancyBootstrapper::class,
+        ],
+        'logging.default' => 'stack',
+        'logging.channels.stack' => [
+            'driver' => 'stack',
+            'channels' => ['single', 'daily'],
+        ],
+    ]);
+
+    $centralStoragePath = storage_path();
+    $centralLogPath = $centralStoragePath . '/logs/laravel.log';
+    $originalSinglePath = config('logging.channels.single.path');
+    $originalDailyPath = config('logging.channels.daily.path');
+
+    // By default, both paths are the same in the config.
+    // Note that in actual usage, the daily log file name is parsed differently from the path in the config,
+    // but the paths *in the config* are the same.
+    expect($centralLogPath)
+        ->toBe($centralStoragePath . '/logs/laravel.log')
+        ->toBe($originalSinglePath)
+        ->toBe($originalDailyPath);
+
+    $tenant = Tenant::create();
+
+    tenancy()->initialize($tenant);
+
+    // Both channels in the stack are updated correctly
+    expect("{$centralStoragePath}/tenant{$tenant->id}/logs/laravel.log")
+        ->not()->toBe($originalSinglePath)
+        ->not()->toBe($originalDailyPath)
+        ->toBe(config('logging.channels.single.path'))
+        ->toBe(config('logging.channels.daily.path'));
+
+    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' => 'stack',
+        'logging.channels.stack.channels' => ['slack', 'single'],
+        'logging.channels.slack' => [
+            'url' => $originalSlackUrl = 'default-webhook',
+            'username' => 'Default',
+        ],
+    ]);
+
+    $centralStoragePath = storage_path();
+    $originalSinglePath = config('logging.channels.single.path');
+
+    $tenant = Tenant::create(['webhookUrl' => 'tenant-webhook']);
+
+    // Test both array mapping and closure-based overrides
+    LogTenancyBootstrapper::$channelOverrides = [
+        'slack' => ['url' => 'webhookUrl'], // slack.url will be mapped to $tenant->webhookUrl
+        'single' => function (Tenant $tenant, array $channel) use ($centralStoragePath) {
+            return array_merge($channel, ['path' => $centralStoragePath . "/logs/override-{$tenant->id}.log"]);
+        },
+    ];
+
+    tenancy()->initialize($tenant);
+
+    // Array mapping overrides work
+    expect(config('logging.channels.slack.url'))->toBe($tenant->webhookUrl);
+    expect(config('logging.channels.slack.username'))->toBe('Default'); // Default username, remains default unless overridden
+
+    // Closure overrides work
+    expect(config('logging.channels.single.path'))->toBe("{$centralStoragePath}/logs/override-{$tenant->id}.log");
+
+    tenancy()->end();
+
+    // After tenancy ends, the original config should be restored
+    expect(config('logging.channels.slack.url'))->toBe($originalSlackUrl);
+    expect(config('logging.channels.single.path'))->toBe($originalSinglePath);
+    expect(config('logging.channels.slack.username'))->toBe('Default'); // Not changed at all
+});
+
+test('channel config keys remain unchanged if the specified tenant override attribute is null', function() {
+    config(['logging.default' => 'slack']);
+    config(['logging.channels.slack.username' => 'Default username']);
+
+    LogTenancyBootstrapper::$channelOverrides = [
+        'slack' => ['username' => 'nonExistentAttribute'], // $tenant->nonExistentAttribute
+    ];
+
+    tenancy()->initialize(Tenant::create());
+
+    // The username should remain unchanged since the tenant attribute is null
+    expect(config('logging.channels.slack.username'))->toBe('Default username');
+});
+
+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 (Tenant $tenant, array $channel) {
+            return array_merge($channel, ['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('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 (Tenant $tenant, array $channel) {
+            // The tenant log path will be set to storage/tenantoverride-tenant/logs/custom-override-tenant.log
+            return array_merge($channel, ['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');
+
+    // The single and daily channels have the same path in the config, but the daily driver parses the file name so that the date is included in the file name
+    $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');
+    }
+});

tests/TestCase.php

@@ -23,10 +23,12 @@ use Stancl\Tenancy\Bootstrappers\UrlGeneratorBootstrapper;
 use Stancl\Tenancy\Bootstrappers\BroadcastingConfigBootstrapper;
 use Stancl\Tenancy\Bootstrappers\BroadcastChannelPrefixBootstrapper;
 use Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper;
-use function Stancl\Tenancy\Tests\pest;
+use Stancl\Tenancy\Bootstrappers\LogTenancyBootstrapper;
 use Stancl\Tenancy\Bootstrappers\DatabaseCacheBootstrapper;
 use Stancl\Tenancy\Bootstrappers\TenantConfigBootstrapper;
 
+use function Stancl\Tenancy\Tests\pest;
+
 abstract class TestCase extends \Orchestra\Testbench\TestCase
 {
     /**
@@ -191,6 +193,7 @@ abstract class TestCase extends \Orchestra\Testbench\TestCase
         $app->singleton(RootUrlBootstrapper::class);
         $app->singleton(UrlGeneratorBootstrapper::class);
         $app->singleton(FilesystemTenancyBootstrapper::class);
+        $app->singleton(LogTenancyBootstrapper::class);
         $app->singleton(TenantConfigBootstrapper::class);
     }