Session scoping (cache bootstrapper): throw on incompatible driver

Author: stancl

src/Bootstrappers/CacheTenancyBootstrapper.php

@@ -99,10 +99,20 @@ protected function getCacheStores(): array
     {
         $names = $this->config->get('tenancy.cache.stores');
 
-        if (
-            $this->config->get('tenancy.cache.scope_sessions', true) &&
-            in_array($this->config->get('session.driver'), ['redis', 'memcached', 'dynamodb', 'apc'], true)
-        ) {
+        if ($this->config->get('tenancy.cache.scope_sessions', true)) {
+            // These are the only cache driven session backends (see Laravel's config/session.php)
+            if (! in_array($this->config->get('session.driver'), ['redis', 'memcached', 'dynamodb', 'apc'], true)
+                && ! app()->environment('local')
+            ) {
+                // We only throw this exception in prod to make configuration a little easier. Developers
+                // may have scope_sessions set to true while using different session drivers e.g. in tests.
+                // Previously we just silently ignored this, however since session scoping is of high importance
+                // in production, we make sure to notify the developer, by throwing an exception, that session
+                // scoping isn't happening as expected/configured due to an incompatible session driver.
+                throw new Exception('Session driver [' . $name . '] cannot be scoped by tenancy.cache.scope_session');
+            }
+
+            // Scoping sessions using this bootstrapper implicitly adds the session store to $names
             $names[] = $this->getSessionCacheStoreName();
         }
 
@@ -112,6 +122,7 @@ protected function getCacheStores(): array
             $store = $this->config->get("cache.stores.{$name}");
 
             if ($store === null || $store['driver'] === 'file') {
+                // 'file' stores are ignored here and instead handled by FilesystemTenancyBootstrapper
                 return false;
             }