setting up multiple database tenancy with AWS S3 using Cloudfront together with spatie/media-library

[MattWiseParking]

Lets say you have a multi tenancy database setup in laravel 10 and you want to store all your assets on a s3 bucket utilising cloudfront and spatie/media-library setup. One approach would be to manually setup a disk in the config/filesystems.php file for each tenant, which would be a bit too cumbersome.

The approach I took, was to use the same s3 bucket for all tenants, setting up a new disk and to prefix the path of the new disk with 'tenant_{id}' where id is the tenant id of the table tenants. Let me show you the process and code I used:

Prerequisites

I assume that you have the following setup/installed:

• S3 bucket with Cloudfront (including permissions setup correctly and public read is enabled)
• DNS setup for your domain (assets.mydomain.com) as a CNAME to point to the cloudfront url
• a laravel app with this package installed and fully working in a multiple database environment
• the s3 disk setup and fully working
• spatie/media-library composer package setup and installed
• you have the composer require league/flysystem-path-prefixing "^3.0" installed

The Process

1. create a new disk in config/filesystems.php lets call this s3-tenant

's3-tenant' => [
            'driver' => 'scoped',
            'disk' => 's3',
            'prefix' => 'tenant'
        ],

2. Create a new Class which extends SwitchTenantTask (I store this in app\Multitenancy folder) dont forget to replace any instance of "s3-tenant" below with the disk name you created in step 1..

<?php

namespace App\Multitenancy;

use Spatie\Multitenancy\Models\Tenant;
use Spatie\Multitenancy\Tasks\SwitchTenantTask;

class PrefixStorageTask implements SwitchTenantTask
{
    /**
     * @param string|null $originalPrefix
     */
    public function __construct(protected ?string $originalPrefix = null,
                                protected ?string $originalDisk = null,
                                protected ?string $originalSpatieMediaLibraryDisk = null)
    {
        $this->originalPrefix ??= config('filesystems.disks.s3-tenant.prefix');
        $this->originalDisk ??= config('filesystems.default');
        $this->originalSpatieMediaLibraryDisk ??= config('media-library.disk_name');
    }

    /**
     * set the current tenant
     * @param Tenant $tenant
     * @return void
     */
    public function makeCurrent(Tenant $tenant): void
    {
        $str = str($this->originalPrefix)->append('_'.$tenant->id);
        $this->setStoragePrefix($str);
        $this->setDefaultDisk('s3-tenant');
        $this->setSpatieMediaLibraryDisk('s3-tenant');
    }

    /**
     * forget current tenant
     * @return void
     */
    public function forgetCurrent(): void
    {
        $this->setStoragePrefix($this->originalPrefix);
        $this->setDefaultDisk($this->originalDisk);
        $this->setSpatieMediaLibraryDisk($this->originalSpatieMediaLibraryDisk);
    }

    /**
     * set storage prefix
     * @param string $prefix
     * @return void
     */
    protected function setStoragePrefix(string $prefix): void
    {
        config()->set('filesystems.disks.s3-tenant.prefix',$prefix);
    }

    /**
     * set default disk
     * @param string $disk
     * @return void
     */
    public function setDefaultDisk(string $disk): void
    {
        config()->set('filesystems.disks.default',"{$disk}");
    }

    /**
     * sets the spatie media library disk
     * @param string $disk
     * @return void
     */
    public function setSpatieMediaLibraryDisk(string $disk): void
    {
        config()->set('media-library.disk_name',"{$disk}");
    }
}

3. Add the new class to config/multitenancy.php (if you have enabled other classes then add the below line at the bottom of the array

'switch_tenant_tasks' => [
        \App\Multitenancy\PrefixStorageTask::class,
    ],

refresh the config

php artisan config:cache

That should now set you up with all the assets pointing to the s3 bucket. When you add any files using spatie/media-library, the root of the s3 bucket should be: tenant_1/{id}/...

The Landlord will automatically default back to its original settings, if the original settings are the s3 bucket then it will add the folders as {id}/... as usual

I hope this document helps out somebody. The only thing I have not mentioned is the same assets url will be used as you setup against the dns/cloudfront. for example: assets.my-domain.com would point to all s3 buckets. If you wanted the AWS_URL to change then I guess you could manipulate the above class we created in step 2 to include this.

[MattWiseParking]

currently receive the following error when I run

sudo php artisan tenants:artisan "migrate:refresh --database=tenant --force" --tenant=1

App\Multitenancy\PrefixStorageTask::setDefaultDisk(): Argument #1 ($disk) must be of type string, null given, called in /var/app/current/app/Multitenancy/PrefixStorageTask.php on line 42

[MattWiseParking]

fixed, change line 18 from

$this->originalDisk ??= config('filesystems.disks.default');

to

$this->originalDisk ??= config('filesystems.default');