setup using different config values for different tenants when using multiple databases per tenant

[MattWiseParking]

I have figured away to create different config values for each tenant when using a multiple database setup per tenant.

Here is the process:

1. create the below migration file

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    /**
     * Run the migrations.
     */
    public function up(): void
    {
        Schema::create('config', function (Blueprint $table) {
            $table->id('config_id');
            $table->string('config_group',100)->default('global');
            $table->char('config_key',50)->nullable(false)->unique();
            $table->char('config_value',100)->nullable(false);
            $table->char('config_description', 200)->nullable(true);
            $table->index('config_group');
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     */
    public function down(): void
    {
        Schema::dropIfExists('config');
    }
};

The config_group represents the config file, the config_key represents the array within (you use dot notation for a specific array value for nested arrays), and the config_value represents the value you want to change against the key.

Run php artisan tenants:artisan "migrate"

2. Create a new SwitchTenantTask, i store this in the App\Multitenancy folder but you can store it where ever you like (just change the name space to match your folder location)

<?php

namespace App\Multitenancy;

use App\Models\Config;
use Illuminate\Database\QueryException;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Schema;
use Spatie\Multitenancy\Contracts\IsTenant;
use Spatie\Multitenancy\Tasks\SwitchTenantTask;

class SwitchTenantConfigTask implements SwitchTenantTask
{
    protected array $overriddenGroups = [];
    public function makeCurrent(IsTenant $tenant): void
    {
        $this->loadConfig();
    }

    public function forgetCurrent(): void
    {
        // Optionally clear config overrides between tenants
        // if you're running in a long-lived process (e.g. Octane)
        foreach ($this->overriddenGroups as $group => $originalValue) {
            config()->set($group, $originalValue);
        }
        $this->overriddenGroups = [];
    }

    protected function loadConfig(): void
    {
        try {
            if (strlen(DB::connection()->getDatabaseName()) === 0) {
                return;
            }

            if (!Schema::hasTable('config')) {
                return;
            }

            $configs = Cache::rememberForever('config_' . config('cache')['prefix'], function () {
                $data = Config::all()->toArray();
                $newArray = [];
                foreach ($data as $arr) {
                    if (!isset($newArray[$arr['config_group']])) {
                        $newArray[$arr['config_group']] = [];
                    }
                    $newArray[$arr['config_group']][$arr['config_key']] = $arr['config_value'];
                }
                return $newArray;
            });

            foreach ($configs as $configGroup => $configKey) {
                $originalConfigArray = config($configGroup);
                $this->overriddenGroups[$configGroup] = $originalConfigArray;

                if (!is_null($originalConfigArray) && count($originalConfigArray) > 0) {
                    foreach ($configKey as $dotKey => $value) {
                        $originalValue = data_get($originalConfigArray, $dotKey);
                        $castedValue = match (true) {
                            is_bool($originalValue)  => filter_var($value, FILTER_VALIDATE_BOOLEAN),
                            is_float($originalValue) => (float) $value,
                            is_int($originalValue)   => (int) $value,
                            is_null($originalValue)  => $value === '' || $value === 'null' ? null : $value,
                            default                  => (string) $value,
                        };
                        data_set($originalConfigArray, $dotKey, $castedValue);
                    }
                    config()->set($configGroup, $originalConfigArray);
                } else {
                    config()->set($configGroup, Arr::undot($configs[$configGroup]));
                }
            }

        } catch (QueryException $e) {
            Log::error('SwitchTenantConfigTask failed: ' . $e->getMessage());
        }
    }
}

As you can see it uses cache to cache the original data, then stores the config cache, so instead if reading the table every request, it checks the cache first, if exists then uses that. this essentially saves thousdands of un necessary requests being sent to the database server.

3. add the above file to your config/multitenancy.php file

'switch_tenant_tasks' => [
        \Spatie\Multitenancy\Tasks\PrefixCacheTask::class,
        \Spatie\Multitenancy\Tasks\SwitchTenantDatabaseTask::class,
        \Spatie\Multitenancy\Tasks\SwitchRouteCacheTask::class,
        \App\Multitenancy\PrefixStorageTask::class,
        \App\Multitenancy\LaravelDailyInvoice::class,
        \App\Multitenancy\SwitchRootUrlTask::class,
        \App\Multitenancy\PrefixPrivateStorageTask::class,
        \App\Multitenancy\SwitchTenantConfigTask::class, // add this line to the array
    ],

You will of course need to create your own CRUD against the table. It now means that you can interact with stripe and use different API keys for different tenants, plus change the config for each tenant. When you do create your own CRUD using a Config model, ensure that you create an observer ConfigObserver then create the link in the EventServiceProvider. Most importantly you will need to clear the cache after every change/update/delete.

Here is a copy of the observer:

<?php

namespace App\Observers;

use App\Models\Config;
use Illuminate\Support\Facades\Cache;

class ConfigObserver
{
    /**
     * Handle the Config "created" event.
     */
    public function created(Config $config): void
    {
        if(Cache::has('config_'.config('cache')['prefix'])) {
            Cache::forget('config_'.config('cache')['prefix']);
        }
    }

    /**
     * Handle the Config "updated" event.
     */
    public function updated(Config $config): void
    {
        if(Cache::has('config_'.config('cache')['prefix'])) {
            Cache::forget('config_'.config('cache')['prefix']);
        }
    }

    /**
     * Handle the Config "deleted" event.
     */
    public function deleted(Config $config): void
    {
        if(Cache::has('config_'.config('cache')['prefix'])) {
            Cache::forget('config_'.config('cache')['prefix']);
        }
    }
}

Hope you like this :)