feat(storage): Add support for tenant-aware storage

composer.json

@@ -4,7 +4,8 @@
   "type"             : "library",
   "require"          : {
     "php"              : "^8.2",
-    "laravel/framework": "^11.0"
+    "laravel/framework": "^11.0",
+    "league/flysystem-path-prefixing": "^3.0"
   },
   "require-dev"      : {
     "phpunit/phpunit"    : "^11.0.1",

resources/config/sprout.php

@@ -4,4 +4,8 @@
 
     'listen_for_routing' => true,
 
+    'services' => [
+        'storage' => true,
+    ],
+
 ];

src/Contracts/TenantHasResources.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Sprout\Contracts;
+
+/**
+ * Tenant Has Resources Contract
+ *
+ * This contract marks an implementation of {@see \Sprout\Contracts\Tenant} as
+ * having their own tenant-specific resources.
+ */
+interface TenantHasResources
+{
+    /**
+     * Get the resource key used to identify the tenants resources
+     *
+     * @return string
+     */
+    public function getTenantResourceKey(): string;
+
+    /**
+     * Gets the name of the resource key used to identify the tenants resources
+     *
+     * @return string
+     */
+    public function getTenantResourceKeyName(): string;
+}

src/Database/Eloquent/Concerns/HasTenantResources.php

@@ -0,0 +1,48 @@
+<?php
+declare(strict_types=1);
+
+namespace Sprout\Database\Eloquent\Concerns;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Str;
+use Sprout\Contracts\TenantHasResources;
+
+/**
+ * @phpstan-require-implements \Sprout\Contracts\Tenant
+ * @phpstan-require-implements \Sprout\Contracts\TenantHasResources
+ * @phpstan-require-extends \Illuminate\Database\Eloquent\Model
+ */
+trait HasTenantResources
+{
+    public static function bootHasTenantResources(): void
+    {
+        static::creating(static function (Model&TenantHasResources $model) {
+            if ($model->getAttribute($model->getTenantResourceKeyName()) === null) {
+                $model->setAttribute(
+                    $model->getTenantResourceKeyName(),
+                    Str::uuid()
+                );
+            }
+        });
+    }
+
+    /**
+     * Get the resource key used to identify the tenants resources
+     *
+     * @return string
+     */
+    public function getTenantResourceKey(): string
+    {
+        return (string)$this->getAttribute($this->getTenantResourceKeyName());
+    }
+
+    /**
+     * Gets the name of the resource key used to identify the tenants resources
+     *
+     * @return string
+     */
+    public function getTenantResourceKeyName(): string
+    {
+        return 'resource_key';
+    }
+}

src/Database/Eloquent/Observers/BelongsToManyTenantsObserver.php

@@ -88,7 +88,7 @@ private function passesInitialChecks(Model $model, Tenancy $tenancy, BelongsToMa
 
             // If we hit here then there's no tenant, and the model isn't
             // marked as tenant being optional, so we throw an exception
-            throw TenantMissing::make($model::class, $tenancy->getName());
+            throw TenantMissing::make($tenancy->getName());
         }
 
         /**

src/Database/Eloquent/Observers/BelongsToTenantObserver.php

@@ -71,7 +71,7 @@ private function passesInitialChecks(Model $model, Tenancy $tenancy, BelongsTo $
 
             // If we hit here then there's no tenant, and the model isn't
             // marked as tenant being optional, so we throw an exception
-            throw TenantMissing::make($model::class, $tenancy->getName());
+            throw TenantMissing::make($tenancy->getName());
         }
 
         /**

src/Database/Eloquent/Scopes/BelongsToManyTenantsScope.php

@@ -38,7 +38,7 @@ public function apply(Builder $builder, Model $model): void
             }
 
             // We should throw an exception because the tenant is missing
-            throw TenantMissing::make($model::class, $tenancy->getName());
+            throw TenantMissing::make($tenancy->getName());
         }
 
         // Finally, add the clause so that all queries are scoped to the

src/Database/Eloquent/Scopes/BelongsToTenantScope.php

@@ -38,7 +38,7 @@ public function apply(Builder $builder, Model $model): void
             }
 
             // We should throw an exception because the tenant is missing
-            throw TenantMissing::make($model::class, $tenancy->getName());
+            throw TenantMissing::make($tenancy->getName());
         }
 
         // Finally, add the clause so that all queries are scoped to the

src/Exceptions/TenantMissing.php

@@ -5,12 +5,10 @@
 
 final class TenantMissing extends SproutException
 {
-    public static function make(string $model, ?string $tenancy): self
+    public static function make(string $tenancy): self
     {
         return new self(
-            'Model [' . $model . '] requires a tenant, and the tenancy'
-            . ($tenancy ? ' [' . $tenancy . '] ' : ' ')
-            . 'does not have one'
+            'There is no current tenant for tenancy [' . $tenancy . ']'
         );
     }
 }

src/Listeners/CleanupLaravelServices.php

@@ -0,0 +1,51 @@
+<?php
+declare(strict_types=1);
+
+namespace Sprout\Listeners;
+
+use Illuminate\Filesystem\FilesystemManager;
+use Sprout\Events\CurrentTenantChanged;
+
+final class CleanupLaravelServices
+{
+    /**
+     * @var \Illuminate\Filesystem\FilesystemManager
+     */
+    private FilesystemManager $filesystemManager;
+
+    public function __construct(FilesystemManager $filesystemManager)
+    {
+        $this->filesystemManager = $filesystemManager;
+    }
+
+    /**
+     * @template TenantClass of \Sprout\Contracts\Tenant
+     *
+     * @param \Sprout\Events\CurrentTenantChanged<TenantClass> $event
+     *
+     * @return void
+     */
+    public function handle(CurrentTenantChanged $event): void
+    {
+        $this->purgeFilesystemDisks();
+    }
+
+    private function purgeFilesystemDisks(): void
+    {
+        // If we're not overriding the storage service we can exit early
+        if (config('sprout.services.storage', false) === false) {
+            return;
+        }
+
+        /** @var array<string, array<string, mixed>> $diskConfig */
+        $diskConfig = config('filesystems.disks', []);
+
+        // If any of the disks have the 'sprout' driver we need to purge them,
+        // if they exist, so we don't end up leaking tenant information
+        foreach ($diskConfig as $disk => $config) {
+            if (($config['driver'] ?? null) === 'sprout') {
+                $this->filesystemManager->forgetDisk($disk);
+            }
+        }
+    }
+}

src/SproutServiceProvider.php

@@ -4,20 +4,26 @@
 namespace Sprout;
 
 use Illuminate\Contracts\Events\Dispatcher;
+use Illuminate\Filesystem\FilesystemManager;
+use Illuminate\Foundation\Application;
 use Illuminate\Queue\Events\JobProcessing;
 use Illuminate\Routing\Events\RouteMatched;
 use Illuminate\Routing\Router;
 use Illuminate\Support\ServiceProvider;
+use RuntimeException;
+use Sprout\Contracts\TenantHasResources;
 use Sprout\Events\CurrentTenantChanged;
 use Sprout\Http\Middleware\TenantRoutes;
 use Sprout\Http\RouterMethods;
+use Sprout\Listeners\CleanupLaravelServices;
 use Sprout\Listeners\IdentifyTenantOnRouting;
 use Sprout\Listeners\PerformIdentityResolverSetup;
 use Sprout\Listeners\SetCurrentTenantContext;
 use Sprout\Listeners\SetCurrentTenantForJob;
 use Sprout\Managers\IdentityResolverManager;
 use Sprout\Managers\ProviderManager;
 use Sprout\Managers\TenancyManager;
+use Sprout\Support\StorageHelper;
 
 class SproutServiceProvider extends ServiceProvider
 {
@@ -86,6 +92,7 @@ public function boot(): void
     {
         $this->publishConfig();
         $this->registerEventListeners();
+        $this->registerServiceOverrides();
     }
 
     private function publishConfig(): void
@@ -105,6 +112,17 @@ private function registerEventListeners(): void
 
         $events->listen(CurrentTenantChanged::class, SetCurrentTenantContext::class);
         $events->listen(CurrentTenantChanged::class, PerformIdentityResolverSetup::class);
+        $events->listen(CurrentTenantChanged::class, CleanupLaravelServices::class);
         $events->listen(JobProcessing::class, SetCurrentTenantForJob::class);
     }
+
+    private function registerServiceOverrides(): void
+    {
+        // If we're providing a tenanted override for Laravels filesystem/storage
+        // service, we'll do that here
+        if ($this->sprout->config('services.storage', false)) {
+            $filesystemManager = $this->app->make(FilesystemManager::class);
+            $filesystemManager->extend('sprout', StorageHelper::creator($this->sprout, $filesystemManager));
+        }
+    }
 }

src/Support/StorageHelper.php

@@ -0,0 +1,98 @@
+<?php
+declare(strict_types=1);
+
+namespace Sprout\Support;
+
+use Closure;
+use Illuminate\Contracts\Filesystem\Filesystem;
+use Illuminate\Filesystem\FilesystemManager;
+use Illuminate\Foundation\Application;
+use RuntimeException;
+use Sprout\Contracts\TenantHasResources;
+use Sprout\Exceptions\TenantMissing;
+use Sprout\Sprout;
+
+final class StorageHelper
+{
+    public static function creator(Sprout $sprout, FilesystemManager $manager): Closure
+    {
+        return static function (Application $app, array $config) use ($sprout, $manager): ?Filesystem {
+            if ($sprout->config('services.storage', false) === false) {
+                return null;
+            }
+
+            $tenancy = $sprout->tenancies()->get($config['tenancy'] ?? null);
+
+            // If there's no tenant, error out
+            if (! $tenancy->check()) {
+                throw TenantMissing::make($tenancy->getName());
+            }
+
+            $tenant = $tenancy->tenant();
+
+            // If the tenant isn't configured for resources, also error out
+            if (! ($tenant instanceof TenantHasResources)) {
+                // TODO: Better exception
+                throw new RuntimeException('Current tenant isn\t configured for resources');
+            }
+
+            $tenantConfig = self::getTenantStorageConfig($manager, $tenant, $config);
+
+            // Create a scoped driver for the new path
+            return $manager->createScopedDriver($tenantConfig);
+        };
+    }
+
+    /**
+     * @param \Illuminate\Filesystem\FilesystemManager $manager
+     * @param \Sprout\Contracts\TenantHasResources     $tenant
+     * @param array<string, mixed>                     $config
+     *
+     * @return array<string, mixed>
+     */
+    private static function getTenantStorageConfig(FilesystemManager $manager, TenantHasResources $tenant, array $config): array
+    {
+        /** @var string $pathPrefix */
+        $pathPrefix = $config['path'] ?? '{tenant}';
+
+        // Create the empty tenant config
+        $tenantConfig = [];
+
+        // Build up the path prefix with the tenant resource key
+        $tenantConfig['prefix'] = self::createTenantedPrefix($tenant, $pathPrefix);
+
+        // Set the disk config on the newly created tenant config, so that the
+        // filesystem manager uses this, rather gets it straight from the config
+        $tenantConfig['disk'] = self::getDiskConfig($config);
+
+        return $tenantConfig;
+    }
+
+    private static function createTenantedPrefix(TenantHasResources $tenant, string $pathPrefix): string
+    {
+        return str_replace('{tenant}', $tenant->getTenantResourceKey(), $pathPrefix);
+    }
+
+    /**
+     * @param array<string, mixed> $config
+     *
+     * @return array<string, mixed>
+     */
+    private static function getDiskConfig(array $config): array
+    {
+        if (is_array($config['disk'])) {
+            $diskConfig = $config['disk'];
+        } else {
+            /** @var string $diskName */
+            $diskName   = $config['disk'] ?? config('filesystems.default');
+            $diskConfig = config('filesystems.disks.' . $diskName);
+        }
+
+        /** @var array<string, mixed> $diskConfig */
+
+        // This is where we'd do anything like load config overrides for
+        // the tenant, like say they have their own S3 setup, etc.
+
+        return $diskConfig;
+    }
+}

tests/Database/Eloquent/BelongsToManyTenantsTest.php

@@ -87,10 +87,7 @@ public function throwsAnExceptionIfTheresNoTenantAndTheTenantIsNotOptionalWhenCr
     {
         $this->expectException(TenantMissing::class);
         $this->expectExceptionMessage(
-            'Model ['
-            . TenantChildren::class
-            . '] requires a tenant, and the tenancy'
-            . ' [tenants] does not have one'
+            'There is no current tenant for tenancy [tenants]'
         );
 
         TenantChildren::factory()->create();
@@ -169,10 +166,7 @@ public function throwsAnExceptionIfTheresNoTenantAndTheTenantIsNotOptionalWhenHy
 
         $this->expectException(TenantMissing::class);
         $this->expectExceptionMessage(
-            'Model ['
-            . TenantChildren::class
-            . '] requires a tenant, and the tenancy'
-            . ' [tenants] does not have one'
+            'There is no current tenant for tenancy [tenants]'
         );
 
         TenantChildren::query()->find($child->getKey());

tests/Database/Eloquent/BelongsToTenantTest.php

@@ -85,10 +85,7 @@ public function throwsAnExceptionIfTheresNoTenantAndTheTenantIsNotOptionalWhenCr
     {
         $this->expectException(TenantMissing::class);
         $this->expectExceptionMessage(
-            'Model ['
-            . TenantChild::class
-            . '] requires a tenant, and the tenancy'
-            . ' [tenants] does not have one'
+            'There is no current tenant for tenancy [tenants]'
         );
 
         TenantChild::factory()->create();
@@ -201,10 +198,7 @@ public function throwsAnExceptionIfTheresNoTenantAndTheTenantIsNotOptionalWhenHy
 
         $this->expectException(TenantMissing::class);
         $this->expectExceptionMessage(
-            'Model ['
-            . TenantChild::class
-            . '] requires a tenant, and the tenancy'
-            . ' [tenants] does not have one'
+            'There is no current tenant for tenancy [tenants]'
         );
 
         TenantChild::query()->find($child->getKey());