Features refactor

Features are now *always* bootstrapped, even if Tenancy is not resolved
from the container.

Previous implementations include
tenancy-for-laravel/v4#19
#1021

Bug originally reported here
#949

This implementation is much simpler, we do not distinguish between
features that should be "always bootstrapped" and features that should
only be bootstrapped after Tenancy is resolved. All features should work
without issues if they're bootstrapped when TSP::boot() is called. We
also add a Tenancy::bootstrapFeatures() method that can be used to
bootstrap any features dynamically added at runtime that weren't
bootstrapped in TSP::boot(). The function keeps track of which features
were already bootstrapped so it doesn't bootstrap them again.

The only potentialy risky thing in this implementation is that we're now
resolving Tenancy in TSP::boot() (previously Tenancy was not being
resolved) but that shouldn't be causing any issues.

Author: stancl

src/Contracts/Feature.php

@@ -4,10 +4,8 @@
 
 namespace Stancl\Tenancy\Contracts;
 
-use Stancl\Tenancy\Tenancy;
-
 /** Additional features, like Telescope tags and tenant redirects. */
 interface Feature
 {
-    public function bootstrap(Tenancy $tenancy): void;
+    public function bootstrap(): void;
 }

src/Database/TenantDatabaseManagers/SQLiteDatabaseManager.php

@@ -94,6 +94,7 @@ public function createDatabase(TenantWithDatabase $tenant): bool
                 return false;
             }
 
+            // todo@sqlite we can just respect Laravel config for WAL now
             if (static::$WAL) {
                 $pdo = new PDO('sqlite:' . $path);
                 $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
@@ -123,6 +124,7 @@ public function deleteDatabase(TenantWithDatabase $tenant): bool
         }
 
         try {
+            // todo@sqlite we should also remove any other files for the DB e.g. WAL
             return unlink($this->getPath($name));
         } catch (Throwable) {
             return false;

src/Features/CrossDomainRedirect.php

@@ -6,11 +6,10 @@
 
 use Illuminate\Http\RedirectResponse;
 use Stancl\Tenancy\Contracts\Feature;
-use Stancl\Tenancy\Tenancy;
 
 class CrossDomainRedirect implements Feature
 {
-    public function bootstrap(Tenancy $tenancy): void
+    public function bootstrap(): void
     {
         RedirectResponse::macro('domain', function (string $domain) {
             /** @var RedirectResponse $this */

src/Features/DisallowSqliteAttach.php

@@ -10,14 +10,13 @@
 use Illuminate\Support\Facades\DB;
 use PDO;
 use Stancl\Tenancy\Contracts\Feature;
-use Stancl\Tenancy\Tenancy;
 
 class DisallowSqliteAttach implements Feature
 {
     protected static bool|null $loadExtensionSupported = null;
     public static string|false|null $extensionPath = null;
 
-    public function bootstrap(Tenancy $tenancy): void
+    public function bootstrap(): void
     {
         // Handle any already resolved connections
         foreach (DB::getConnections() as $connection) {
@@ -40,16 +39,20 @@ public function bootstrap(Tenancy $tenancy): void
     protected function loadExtension(PDO $pdo): bool
     {
         if (static::$loadExtensionSupported === null) {
+            // todo@sqlite refactor to local static
             static::$loadExtensionSupported = method_exists($pdo, 'loadExtension');
         }
 
         if (static::$loadExtensionSupported === false) {
             return false;
         }
+
         if (static::$extensionPath === false) {
             return false;
         }
 
+        // todo@sqlite we may want to check for 64 bit
+
         $suffix = match (PHP_OS_FAMILY) {
             'Linux' => 'so',
             'Windows' => 'dll',

src/Features/TelescopeTags.php

@@ -7,11 +7,10 @@
 use Laravel\Telescope\IncomingEntry;
 use Laravel\Telescope\Telescope;
 use Stancl\Tenancy\Contracts\Feature;
-use Stancl\Tenancy\Tenancy;
 
 class TelescopeTags implements Feature
 {
-    public function bootstrap(Tenancy $tenancy): void
+    public function bootstrap(): void
     {
         if (! class_exists(Telescope::class)) {
             return;

src/Features/TenantConfig.php

@@ -12,7 +12,6 @@
 use Stancl\Tenancy\Contracts\Tenant;
 use Stancl\Tenancy\Events\RevertedToCentralContext;
 use Stancl\Tenancy\Events\TenancyBootstrapped;
-use Stancl\Tenancy\Tenancy;
 
 class TenantConfig implements Feature
 {
@@ -27,7 +26,7 @@ public function __construct(
         protected Repository $config,
     ) {}
 
-    public function bootstrap(Tenancy $tenancy): void
+    public function bootstrap(): void
     {
         Event::listen(TenancyBootstrapped::class, function (TenancyBootstrapped $event) {
             /** @var Tenant $tenant */

src/Features/UserImpersonation.php

@@ -17,9 +17,9 @@ class UserImpersonation implements Feature
     /** The lifespan of impersonation tokens (in seconds). */
     public static int $ttl = 60;
 
-    public function bootstrap(Tenancy $tenancy): void
+    public function bootstrap(): void
     {
-        $tenancy->macro('impersonate', function (Tenant $tenant, string $userId, string $redirectUrl, string|null $authGuard = null, bool $remember = false): Model {
+        Tenancy::macro('impersonate', function (Tenant $tenant, string $userId, string $redirectUrl, string|null $authGuard = null, bool $remember = false): Model {
             return UserImpersonation::modelClass()::create([
                 Tenancy::tenantKeyColumn() => $tenant->getTenantKey(),
                 'user_id' => $userId,

src/Features/ViteBundler.php

@@ -7,19 +7,14 @@
 use Illuminate\Foundation\Application;
 use Illuminate\Support\Facades\Vite;
 use Stancl\Tenancy\Contracts\Feature;
-use Stancl\Tenancy\Tenancy;
 
 class ViteBundler implements Feature
 {
-    /** @var Application */
-    protected $app;
+    public function __construct(
+        protected Application $app,
+    ) {}
 
-    public function __construct(Application $app)
-    {
-        $this->app = $app;
-    }
-
-    public function bootstrap(Tenancy $tenancy): void
+    public function bootstrap(): void
     {
         Vite::createAssetPathsUsing(function ($path, $secure = null) {
             return global_asset($path);

src/Tenancy.php

@@ -11,6 +11,7 @@
 use Illuminate\Support\Traits\Macroable;
 use Stancl\Tenancy\Concerns\DealsWithRouteContexts;
 use Stancl\Tenancy\Concerns\ManagesRLSPolicies;
+use Stancl\Tenancy\Contracts\Feature;
 use Stancl\Tenancy\Contracts\TenancyBootstrapper;
 use Stancl\Tenancy\Contracts\Tenant;
 use Stancl\Tenancy\Exceptions\TenantCouldNotBeIdentifiedByIdException;
@@ -40,7 +41,7 @@ class Tenancy
     public static array $findWith = [];
 
     /**
-     * A list of bootstrappers that have been initialized.
+     * List of bootstrappers that have been initialized.
      *
      * This is used when reverting tenancy, mainly if an exception
      * occurs during bootstrapping, to ensure we don't revert
@@ -53,6 +54,23 @@ class Tenancy
      */
     public array $initializedBootstrappers = [];
 
+    /**
+     * List of features that have been bootstrapped.
+     *
+     * Since features may be bootstrapped multiple times during
+     * the request cycle (in TSP::boot() and any other times the user calls
+     * bootstrapFeatures()), we keep track of which features have already
+     * been bootstrapped so we do not bootstrap them again. Features are
+     * bootstrapped once and irreversible.
+     *
+     * The main point of this is that some features *need* to be bootstrapped
+     * very early (see #949), so we bootstrap them directly in TSP, but we
+     * also need the ability to *change* which features are used at runtime
+     * (mainly tests of this package) and bootstrap features again after making
+     * changes to config('tenancy.features').
+     */
+    protected array $bootstrappedFeatures = [];
+
     /** Initialize tenancy for the passed tenant. */
     public function initialize(Tenant|int|string $tenant): void
     {
@@ -154,6 +172,27 @@ public function usingBootstrapper(string $bootstrapper): bool
         return in_array($bootstrapper, static::getBootstrappers(), true);
     }
 
+    /**
+     * Bootstrap configured Tenancy features.
+     *
+     * Normally, features are bootstrapped directly in TSP::boot(). However, if
+     * new features are enabled at runtime (e.g. during tests), this method may
+     * be called to bootstrap new features. It's idempotent and keeps track of
+     * which features have already been bootstrapped. Keep in mind that feature
+     * bootstrapping is irreversible.
+     */
+    public function bootstrapFeatures(): void
+    {
+        foreach (config('tenancy.features') ?? [] as $feature) {
+            /** @var class-string<Feature> $feature */
+
+            if (! in_array($feature, $this->bootstrappedFeatures)) {
+                app($feature)->bootstrap();
+                $this->bootstrappedFeatures[] = $feature;
+            }
+        }
+    }
+
     /**
      * @return Builder<Tenant&Model>
      */

src/TenancyServiceProvider.php

@@ -40,15 +40,6 @@ public function register(): void
         // Make sure Tenancy is stateful.
         $this->app->singleton(Tenancy::class);
 
-        // Make sure features are bootstrapped as soon as Tenancy is instantiated.
-        $this->app->extend(Tenancy::class, function (Tenancy $tenancy) {
-            foreach ($this->app['config']['tenancy.features'] ?? [] as $feature) {
-                $this->app[$feature]->bootstrap($tenancy);
-            }
-
-            return $tenancy;
-        });
-
         // Make it possible to inject the current tenant by type hinting the Tenant contract.
         $this->app->bind(Tenant::class, function ($app) {
             return $app[Tenancy::class]->tenant;
@@ -176,6 +167,11 @@ public function boot(): void
             return $instance;
         });
 
+        // Bootstrap features that are already enabled in the config.
+        // If more features are enabled at runtime, this method may be called
+        // multiple times, it keeps track of which features have already been bootstrapped.
+        $this->app->make(Tenancy::class)->bootstrapFeatures();
+
         Route::middlewareGroup('clone', []);
         Route::middlewareGroup('universal', []);
         Route::middlewareGroup('tenant', []);