refactor(overrides): Refactor service overrides to allow for more complexity

.gitignore

@@ -3,3 +3,4 @@ composer.lock
 /wiki/
 /build/
 .phpunit.result.cache
+/tests/_Original

composer.json

@@ -11,7 +11,8 @@
     "phpunit/phpunit"    : "^11.0.1",
     "orchestra/testbench": "^9.4",
     "larastan/larastan"  : "^2.9",
-    "infection/infection": "^0.29.8"
+    "infection/infection": "^0.29.8",
+    "brianium/paratest"  : "^7.7"
   },
   "license"          : "MIT",
   "autoload"         : {
@@ -78,7 +79,7 @@
       "providers": [
         "Sprout\\SproutServiceProvider"
       ],
-      "facades":[
+      "facades"  : [
         "Sprout\\Facades\\Sprout"
       ]
     }

infection.json5

@@ -13,10 +13,16 @@
     "@default"           : true,
     "ProtectedVisibility": {
       "ignore": [
-        "Sprout\\Concerns\\FindsIdentityRouteParameters::initialiseRouteParameter",
-        "Sprout\\Concerns\\FindsIdentityRouteParameters::getParameterPatternMapping",
-        "Sprout\\Concerns\\FindsIdentityRouteParameters::applyParameterMapping",
-        "Sprout\\Support\\BaseFactory::callCustomCreator"
+        "Sprout\\Concerns\\FindsIdentityRouteParameters::*",
+        "Sprout\\Support\\BaseFactory::callCustomCreator",
+        "Sprout\\Overrides\\Auth\\SproutAuthCacheTokenRepository::getTenantedPrefix",
+        "Sprout\\Overrides\\Auth\\SproutAuthDatabaseTokenRepository::*",
+        "Sprout\\Overrides\\Cache\\SproutCacheDriverCreator::*"
+      ]
+    },
+    "PublicVisibility": {
+      "ignore": [
+        "Sprout\\Concerns\\FindsIdentityRouteParameters::*"
       ]
     },
     "UnwrapUcFirst"      : {

phpunit.xml

@@ -15,9 +15,6 @@
         testdox="true"
 >
     <testsuites>
-        <testsuite name="Original">
-            <directory>tests/_Original</directory>
-        </testsuite>
         <testsuite name="Feature">
             <directory>./tests/Feature</directory>
         </testsuite>

resources/config/sprout.php → resources/config/core.php

@@ -40,37 +40,8 @@
         \Sprout\Listeners\CleanupServiceOverrides::class,
         // Sets up service overrides for the current tenancy
         \Sprout\Listeners\SetupServiceOverrides::class,
-    ],
-
-    /*
-    |--------------------------------------------------------------------------
-    | Service Overrides
-    |--------------------------------------------------------------------------
-    |
-    | This is an array of service override classes.
-    | These classes will be instantiated and automatically run when relevant.
-    |
-    */
-
-    'services' => [
-        // This will override the storage by introducing a 'sprout' driver
-        // that wraps any other storage drive in a tenant resource subdirectory.
-        Services::STORAGE => \Sprout\Overrides\StorageOverride::class,
-        // This will hydrate tenants when running jobs, based on the current
-        // context.
-        Services::JOB     => \Sprout\Overrides\JobOverride::class,
-        // This will override the cache by introducing a 'sprout' driver
-        // that adds a prefix to cache stores for the current tenant.
-        Services::CACHE   => \Sprout\Overrides\CacheOverride::class,
-        // This is a simple override that removes all currently resolved
-        // guards to prevent user auth leaking.
-        Services::AUTH    => \Sprout\Overrides\AuthOverride::class,
-        // This will override the cookie settings so that all created cookies
-        // are specific to the tenant.
-        Services::COOKIE  => \Sprout\Overrides\CookieOverride::class,
-        // This will override the session by introducing a 'sprout' driver
-        // that wraps any other session store.
-        Services::SESSION => \Sprout\Overrides\SessionOverride::class,
+        // Refresh anything that's tenant-aware
+        \Sprout\Listeners\RefreshTenantAwareDependencies::class,
     ],
 
 ];

resources/config/multitenancy.php

@@ -50,6 +50,7 @@
             'options'  => [
                 TenancyOptions::hydrateTenantRelation(),
                 TenancyOptions::throwIfNotRelated(),
+                TenancyOptions::allOverrides(),
             ],
         ],
 

resources/config/overrides.php

@@ -0,0 +1,50 @@
+<?php
+
+/*
+|--------------------------------------------------------------------------
+| Service Overrides
+|--------------------------------------------------------------------------
+|
+| This config file provides the config for the different service overrides
+| registered by Sprout.
+| Service overrides are registered against a "service", which is an arbitrary
+| string value, used to prevent multiple overrides for a single service.
+|
+| All services overrides should have a "driver" which should contain an FQN
+| for a class that implements the ServiceOverride interface.
+| Any other config options will depend on the individual service override
+| driver.
+|
+*/
+
+return [
+
+    'filesystem' => [
+        'driver'  => \Sprout\Overrides\FilesystemOverride::class,
+        // This config option defines whether the filesystem override will
+        // override the filesystem manager with a Sprout version.
+        // The default value is 'true'
+        'manager' => true,
+    ],
+
+    'job' => [
+        'driver' => \Sprout\Overrides\JobOverride::class,
+    ],
+
+    'cache' => [
+        'driver' => \Sprout\Overrides\CacheOverride::class,
+    ],
+
+    'auth' => [
+        'driver' => \Sprout\Overrides\AuthOverride::class,
+    ],
+
+    'cookie' => [
+        'driver' => \Sprout\Overrides\CookieOverride::class,
+    ],
+
+    'session' => [
+        'driver'   => \Sprout\Overrides\SessionOverride::class,
+        'database' => false,
+    ],
+];

src/Concerns/AwareOfTenant.php

@@ -0,0 +1,102 @@
+<?php
+declare(strict_types=1);
+
+namespace Sprout\Concerns;
+
+use Sprout\Contracts\Tenancy;
+use Sprout\Contracts\Tenant;
+
+/**
+ * @phpstan-require-implements \Sprout\Contracts\TenantAware
+ */
+trait AwareOfTenant
+{
+    /**
+     * @var \Sprout\Contracts\Tenant|null
+     */
+    private ?Tenant $tenant;
+
+    /**
+     * @var \Sprout\Contracts\Tenancy<*>|null
+     */
+    private ?Tenancy $tenancy;
+
+    /**
+     * Should the tenancy and tenant be refreshed when they change?
+     *
+     * @return bool
+     */
+    public function shouldBeRefreshed(): bool
+    {
+        return true; // @codeCoverageIgnore
+    }
+
+    /**
+     * Get the tenant if there is one
+     *
+     * @return \Sprout\Contracts\Tenant|null
+     */
+    public function getTenant(): ?Tenant
+    {
+        return $this->tenant ?? null;
+    }
+
+    /**
+     * Check if there is a tenant
+     *
+     * @return bool
+     */
+    public function hasTenant(): bool
+    {
+        return $this->getTenant() !== null;
+    }
+
+    /**
+     * Set the tenant
+     *
+     * @param \Sprout\Contracts\Tenant|null $tenant
+     *
+     * @return static
+     */
+    public function setTenant(?Tenant $tenant): static
+    {
+        $this->tenant = $tenant;
+
+        return $this;
+    }
+
+    /**
+     * Get the tenancy if there is one
+     *
+     * @return \Sprout\Contracts\Tenancy<*>|null
+     */
+    public function getTenancy(): ?Tenancy
+    {
+        return $this->tenancy ?? null;
+    }
+
+    /**
+     * Check if there is a tenancy
+     *
+     * @return bool
+     */
+    public function hasTenancy(): bool
+    {
+        return $this->getTenancy() !== null;
+    }
+
+    /**
+     * Set the tenancy
+     *
+     * @template TenantClass of \Sprout\Contracts\Tenant
+     * @param \Sprout\Contracts\Tenancy<TenantClass>|null $tenancy
+     *
+     * @return static
+     */
+    public function setTenancy(?Tenancy $tenancy): static
+    {
+        $this->tenancy = $tenancy;
+
+        return $this;
+    }
+}