[4.x] Make globalCache always use the central connection with database cache store

src/Bootstrappers/CacheTenancyBootstrapper.php

@@ -16,6 +16,15 @@
 
 /**
  * Makes cache tenant-aware by applying a prefix.
+ *
+ * Using this bootstrapper together with DatabaseTenancyBootstrapper
+ * with a database cache store results in double scoping. The store is scoped by
+ * DB connection (entries go into the tenant's database) *and* by the prefix. This is
+ * harmless for most use cases, but can produce unexpected behavior.
+ *
+ * If you're using a database cache store, use DatabaseCacheBootstrapper instead of this one.
+ *
+ * @see Stancl\Tenancy\Bootstrappers\DatabaseCacheBootstrapper
  */
 class CacheTenancyBootstrapper implements TenancyBootstrapper
 {

src/Bootstrappers/DatabaseCacheBootstrapper.php

@@ -25,7 +25,10 @@
  *
  * Notably, this bootstrapper sets TenancyServiceProvider::$adjustCacheManagerUsing to a callback
  * that ensures all affected stores still use the central connection when accessed via global cache
- * (typicaly the GlobalCache facade or global_cache() helper).
+ * (typically the GlobalCache facade or global_cache() helper), even though this bootstrapper explicitly
+ * sets the connection to tenant for all scoped cache stores. TenancyServiceProvider::makeDatabaseCacheStoresCentral()
+ * cannot fix globalCache on its own because it reads 'tenant' from config (set by this bootstrapper), not null,
+ * so the callback is still needed to correct the connection to central for globalCache.
  */
 class DatabaseCacheBootstrapper implements TenancyBootstrapper
 {

src/TenancyServiceProvider.php

@@ -6,9 +6,11 @@
 
 use Closure;
 use Illuminate\Cache\CacheManager;
+use Illuminate\Cache\DatabaseStore;
 use Illuminate\Contracts\Container\Container;
 use Illuminate\Database\Console\Migrations\FreshCommand;
 use Illuminate\Routing\Events\RouteMatched;
+use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\Route;
 use Illuminate\Support\ServiceProvider;
@@ -86,14 +88,26 @@ public function register(): void
             // This works great for cache stores that are *directly* scoped, like Redis or
             // any other tagged or prefixed stores, but it doesn't work for the database driver.
             //
-            // When we use the DatabaseTenancyBootstrapper, it changes the default connection,
-            // and therefore the connection of the database store that will be created when
-            // this new CacheManager is instantiated again.
+            // When DatabaseTenancyBootstrapper is used, it changes the default DB connection
+            // to 'tenant'. A freshly created CacheManager would therefore instantiate database
+            // stores with the tenant connection.
             //
-            // For that reason, we also adjust the relevant stores on this new CacheManager
-            // using the callback below. It is set by DatabaseCacheBootstrapper.
+            // For that reason, we adjust the relevant stores on this new CacheManager
+            // using the makeDatabaseCacheStoresCentral() method and the $adjustCacheManagerUsing callback below
+            // (set by DatabaseCacheBootstrapper).
             $manager = new CacheManager($app);
 
+            // When DatabaseTenancyBootstrapper is used, database stores whose 'connection'
+            // config is null fall back to the default DB connection ('tenant'). Reset each
+            // such store to its explicitly configured connection, or fall back to central.
+            $this->makeDatabaseCacheStoresCentral($manager);
+
+            // DatabaseCacheBootstrapper explicitly writes 'tenant' into each store's 'connection'
+            // config. makeDatabaseCacheStoresCentral() above would then read 'tenant' as the
+            // configured value (not null) and use it directly, so the central connection fallback
+            // wouldn't be used.
+            //
+            // This callback is used to correct those connections back to central for globalCache.
             if (static::$adjustCacheManagerUsing !== null) {
                 (static::$adjustCacheManagerUsing)($manager);
             }
@@ -102,6 +116,34 @@ public function register(): void
         });
     }
 
+    /**
+     * Ensure globalCache uses the central connection for database cache stores.
+     *
+     * A freshly built CacheManager creates database stores using the current default connection, which
+     * DatabaseTenancyBootstrapper switches to the tenant connection. Since global cache should always be
+     * central, reset those stores back to their configured connection, falling back to the central one.
+     */
+    protected function makeDatabaseCacheStoresCentral(CacheManager $manager): void
+    {
+        $centralConnection = $this->app['config']['tenancy.database.central_connection'];
+
+        foreach ($this->app['config']['cache.stores'] ?? [] as $name => $store) {
+            $notAValidDatabaseStore = ! is_array($store) || ($store['driver'] ?? null) !== 'database';
+
+            if ($notAValidDatabaseStore) {
+                continue;
+            }
+
+            /** @var DatabaseStore $databaseStore */
+            $databaseStore = $manager->store($name)->getStore();
+
+            // If $store['connection'] is null, it defaults to the default DB connection (which may be tenant).
+            // Fall back to the central connection to keep the global cache central.
+            $databaseStore->setConnection(DB::connection($store['connection'] ?? $centralConnection));
+            $databaseStore->setLockConnection(DB::connection($store['lock_connection'] ?? $store['connection'] ?? $centralConnection));
+        }
+    }
+
     /* Bootstrap services. */
     public function boot(): void
     {

tests/CachedTenantResolverTest.php

@@ -165,6 +165,7 @@
     ['redis', [CacheTenancyBootstrapper::class]],
     ['redis', [CacheTagsBootstrapper::class]],
     ['database', [DatabaseTenancyBootstrapper::class, DatabaseCacheBootstrapper::class]],
+    ['database', [DatabaseTenancyBootstrapper::class, CacheTenancyBootstrapper::class]],
 ]);
 
 test('cache is invalidated when the tenant is deleted', function (string $resolver, bool $configureTenantModelColumn) {

tests/GlobalCacheTest.php

@@ -165,6 +165,7 @@
     ['redis', [CacheTagsBootstrapper::class]],
     ['redis', [CacheTenancyBootstrapper::class]],
     ['database', [DatabaseTenancyBootstrapper::class, DatabaseCacheBootstrapper::class]],
+    ['database', [DatabaseTenancyBootstrapper::class, CacheTenancyBootstrapper::class]],
 ])->with([
     'helper',
     'facade',