archtechx/tenancy
1
0
Fork 0
mirror of https://github.com/archtechx/tenancy.git synced 2025-12-13 22:34:04 +00:00
Code Activity

Refactor bootstrapper, provide more info in comments

Browse source
This commit is contained in:
lukinovec 2025-07-31 16:25:40 +02:00
parent 81daa9d054
commit 42c837d967
1 changed files with 38 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

65
src/Bootstrappers/LogTenancyBootstrapper.php
View file

@ -13,12 +13,12 @@ use Stancl\Tenancy\Contracts\Tenant;
/** /**
* This bootstrapper makes it possible to configure tenant-specific logging. * This bootstrapper makes it possible to configure tenant-specific logging.
* *
* By default, the storage path channels ('single' and 'daily' by default, feel free to configure that using the $storagePathChannels property) * By default, the storage path channels ('single' and 'daily' by default,
* are configured to use tenant storage directories. For this to work correctly, * but feel free to customize that using the $storagePathChannels property)
* this bootstrapper must run *after* FilesystemTenancyBootstrapper. * are configured to use tenant storage directories.
* * For this to work correctly, this bootstrapper must run *after* FilesystemTenancyBootstrapper.
* The bootstrapper also supports custom channel overrides via the $channelOverrides property (see the ).
* *
* The bootstrapper also supports custom channel overrides via the $channelOverrides property (see the property's docblock).
* *
* @see Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper * @see Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper
*/ */
@ -26,9 +26,6 @@ class LogTenancyBootstrapper implements TenancyBootstrapper
{ {
protected array $defaultConfig = []; protected array $defaultConfig = [];
/** Channels that were modified during bootstrap (for reverting later) */
protected array $channels = [];
/** /**
* Log channels that use the storage_path() helper for storing the logs. * Log channels that use the storage_path() helper for storing the logs.
* Requires FilesystemTenancyBootstrapper to run before this bootstrapper. * Requires FilesystemTenancyBootstrapper to run before this bootstrapper.
@ -39,7 +36,7 @@ class LogTenancyBootstrapper implements TenancyBootstrapper
* Custom channel configuration overrides. * Custom channel configuration overrides.
* *
* Examples: * Examples:
* - Array mapping: ['slack' => ['url' => 'webhookUrl']] maps $tenant->webhookUrl to slack.url (if $tenant->webhookUrl is set, otherwise, the override is ignored) * - Array mapping (the default approach): ['slack' => ['url' => 'webhookUrl']] maps $tenant->webhookUrl to slack.url (if $tenant->webhookUrl is set, otherwise, the override is ignored)
* - Closure: ['slack' => fn ($config, $tenant) => $config->set('logging.channels.slack.url', $tenant->slackUrl)] * - Closure: ['slack' => fn ($config, $tenant) => $config->set('logging.channels.slack.url', $tenant->slackUrl)]
*/ */
public static array $channelOverrides = []; public static array $channelOverrides = [];
@ -52,36 +49,50 @@ class LogTenancyBootstrapper implements TenancyBootstrapper
public function bootstrap(Tenant $tenant): void public function bootstrap(Tenant $tenant): void
{ {
$this->defaultConfig = $this->config->get('logging.channels'); $this->defaultConfig = $this->config->get('logging.channels');
$this->channels = $this->getChannels(); $channels = $this->getChannels();
$this->configureChannels($this->channels, $tenant); $this->configureChannels($channels, $tenant);
$this->forgetChannels(); $this->forgetChannels($channels);
} }
public function revert(): void public function revert(): void
{ {
$this->config->set('logging.channels', $this->defaultConfig); $this->config->set('logging.channels', $this->defaultConfig);
$this->forgetChannels(); $this->forgetChannels($this->getChannels());
$this->channels = [];
} }
/** Channels to configure (including the channels in the log stack). */ /**
* Channels to configure and re-resolve afterwards (including the channels in the log stack).
*/
protected function getChannels(): array protected function getChannels(): array
{ {
// Get the currently used (default) logging channel // Get the currently used (default) logging channel
$channels = [$this->config->get('logging.default')]; $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 // If the default channel is stack, also get all the channels it contains.
if ($channels[0] === 'stack') { // The stack channel also has to be included in the list of channels
$channels = array_merge($channels, $this->config->get('logging.channels.stack.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; return $channels;
} }
/** Configure channels for the tenant context. */ /**
* 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 protected function configureChannels(array $channels, Tenant $tenant): void
{ {
foreach ($channels as $channel) { foreach ($channels as $channel) {
@ -99,7 +110,7 @@ class LogTenancyBootstrapper implements TenancyBootstrapper
{ {
if (is_array($override)) { if (is_array($override)) {
// Map tenant properties to channel config keys. // Map tenant properties to channel config keys.
// If the tenant property is not set, // If the tenant property is not set (= is null),
// the override is ignored and the channel config key's value remains unchanged. // the override is ignored and the channel config key's value remains unchanged.
foreach ($override as $configKey => $tenantProperty) { foreach ($override as $configKey => $tenantProperty) {
if ($tenant->$tenantProperty) { if ($tenant->$tenantProperty) {
@ -112,12 +123,12 @@ class LogTenancyBootstrapper implements TenancyBootstrapper
} }
/** /**
* Forget channels so they can be re-resolved * Forget all passed channels so they can be re-resolved
* with updated configuration on the next log attempt. * with updated config on the next logging attempt.
*/ */
protected function forgetChannels(): void protected function forgetChannels(array $channels): void
{ {
foreach ($this->channels as $channel) { foreach ($channels as $channel) {
$this->logManager->forgetChannel($channel); $this->logManager->forgetChannel($channel);
} }
} }