v9 is loading config file from disk

[razvan-p]

Hi! We have a multitenancy app which runs a backup every day. After updating from v8 to v9 we remarked that config is always loaded from config.php file from disk. This way we can't configure dynamically the config options according to each tenant. This is our code for changing the config dynamically which is working in v8, but not in v9:

<?php

namespace App\Tasks;

use Spatie\Multitenancy\Contracts\IsTenant;
use Spatie\Multitenancy\Tasks\SwitchTenantTask;

class SwitchBackupDatabaseTask implements SwitchTenantTask
{
    public function __construct(protected ?array $originalBackupDatabase = null, protected ?string $originalBackupFilenamePrefix = null)
    {
        $this->originalBackupDatabase ??= config('backup.backup.source.databases');
        $this->originalBackupFilenamePrefix ??= config('backup.backup.destination.filename_prefix');
    }

    public function makeCurrent(IsTenant $tenant): void
    {
        config()->set('backup.backup.source.databases', ['tenant']);
        config()->set('backup.backup.destination.filename_prefix', $tenant->database . '-');
    }

    public function forgetCurrent(): void
    {
        config()->set('backup.backup.source.databases', $this->originalBackupDatabase);
        config()->set('backup.backup.destination.filename_prefix', $this->originalBackupFilenamePrefix);
    }
}

[chrisk-7777]

I've just hit the same thing. The closest I could get is to keep a full list of tenants in the backup config:

'databases' => [
  'tenant_1',
  'tenant_2',
  'tenant_3',
  ...
],

Then in the schedule, pass in the database(s) that need backing up:

    protected function schedule(Schedule $schedule): void
    {
        $schedule->command('backup:run', [
            '--only-db',
            '--db-name' => [
              'tenant_1' // can be generated dynamically 
            ],
        ])
            ->dailyAt('13:00');

        $schedule->command('monitor:check-uptime')->everyMinute();
    }

This isn't super practical, and is a bit prone to error.

I've attempted to extend the BackupCommand class, passing in my own Config instance, but it always seems to revert to the original config from the backup config file.

I'm probably just misunderstanding the flow, but I can't seem to crack how to set the config dynamically.

[inserve-paul]

@razvan-p @chrisk-7777 I've created a PR for this issue: #1905

[steffensatrapa]

I have the same issue. As a workaround I created these comands:

For the backup:

namespace App\Console\Commands;

use Illuminate\Contracts\Console\Isolatable;
use Spatie\Backup\Commands\BackupCommand;
use Spatie\Backup\Config\Config;

class ConfigurableBackupCommand extends BackupCommand implements Isolatable
{
    protected $signature = 'configurable-backup:run {--filename=} {--only-db} {--db-name=*} {--only-files} {--only-to-disk=} {--disable-notifications} {--timeout=} {--tries=} {--reload-config=}';

    public function handle(): int
    {
        if ($this->option('reload-config')) {
            $this->config = Config::fromArray(config($this->option('reload-config') ?? 'backup'));
        }
        return parent::handle();
    }
}

For cleanup:

namespace App\Console\Commands;

use Illuminate\Contracts\Console\Isolatable;
use Spatie\Backup\Commands\CleanupCommand;
use Spatie\Backup\Config\Config;

class ConfigurableBackupCleanupCommand extends CleanupCommand implements Isolatable
{
    /** @var string */
    protected $signature = 'configurable-backup:clean {--disable-notifications} {--tries=} {--reload-config=}';

    public function handle(): int
    {
        if ($this->option('reload-config')) {
            $this->config = Config::fromArray(config($this->option('reload-config') ?? 'backup'));
        }

        return parent::handle();
    }
}

registering these comands:

class AppServiceProvider extends ServiceProvider
{
  ..
    public function boot(): void
    {
     ...

        $this->commands([
            ConfigurableBackupCommand::class,
            ConfigurableBackupCleanupCommand::class,
        ]);
    }
...

and using it in my backup job:

namespace App\Jobs;

use App\Traits\LogsEmailOutput;
...
class BackupJob implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels, LogsEmailOutput;

    protected array $backupConfigs = [
        'backup_database',
        'backup_invoices',
        'backup_marketing',
    ];
  ...
    public function handle(): void
    {
        foreach ($this->backupConfigs as $configName) {
            Artisan::call('configurable-backup:run --reload-config=' . $configName);
            foreach (explode("\n", Artisan::output()) as $line) {
                $this->log("[$configName] $line");
            }

            Artisan::call('configurable-backup:clean --reload-config=' . $configName);
            foreach (explode("\n", Artisan::output()) as $line) {
                $this->log("[$configName] $line");
            }
        }

        if ($this->sendEmail) {
            $this->sendLogEmail();
        }
    }
}

[julesjanssen]

My solution:
Create a custom app:backup command, in which you inject the Spatie\Backup\Config\Config object & then:

Tenant::all()->eachCurrent(function (Tenant $tenant) use ($config) {
    $config->backup->source->databases = ['tenant'];
    $config->backup->destination->disks = ['tenant-backup-disk-name'];

    Artisan::call('backup:run', [], $this->output);
});

[imhayatunnabi]

Use @julesjanssen 's approach - it's the cleanest and works with v9's architecture:

use Spatie\Backup\Config\Config;

// In your command/job
public function handle(Config $config)
{
    Tenant::all()->eachCurrent(function (Tenant $tenant) use ($config) {
        $config->backup->source->databases = ['tenant'];
        $config->backup->destination->filenamePrefix = $tenant->database . '-';
        
        Artisan::call('backup:run', ['--only-db'], $this->output);
    });
}

if you need complete isolation use steffensatrapa's custom command approach with --reload-config