Add tenant caching

config/multitenancy.php

@@ -19,7 +19,7 @@
      * This class should extend `Spatie\Multitenancy\TenantFinder\TenantFinder`
      *
      */
-    'tenant_finder' => null,
+    'tenant_finder' => \Spatie\Multitenancy\TenantFinder\DomainTenantFinder::class,
 
     /*
      * These fields are used by tenant:artisan command to match one or more tenant.
@@ -70,6 +70,20 @@
      */
     'current_tenant_container_key' => 'currentTenant',
 
+    /**
+     * This key specifies the name of a cache store. When set to `null`
+     * the default cache store will be used. If you do not want to use
+     * caching set this value to `false`.
+     */
+    'cache_store' => false,
+
+    /*
+     * When cache_store is set to `true`, this value will be used to determine
+     * how long the cache will be valid. If you set this to `null` the
+     * cache will never expire.
+     */
+    'cache_duration' => null,
+
     /**
      * Set it to `true` if you like to cache the tenant(s) routes
      * in a shared file using the `SwitchRouteCacheTask`.

docs/advanced-usage/caching-tenants.md

@@ -0,0 +1,23 @@
+---
+title: Caching tenants
+weight: 10
+---
+
+When using many tenants, each tenant retrieval can have a performance impact on the database.
+It is possible to cache the tenants to reduce the number of requests to the database.
+
+To configure the cache store to use, or to disable caching, change the value of the `cache_store` in the `multitenancy` config file.
+
+## Using cache
+
+To build the tenant cache using the configured store:
+
+```bash
+php artisan tenants:cache
+```
+
+To clear the tenant cache using the configured store:
+
+```bash
+php artisan tenants:refresh
+```

src/Commands/TenantsCacheCommand.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Spatie\Multitenancy\Commands;
+
+use Illuminate\Console\Command;
+use Spatie\Multitenancy\Concerns\UsesMultitenancyCaching;
+
+class TenantsCacheCommand extends Command
+{
+    use UsesMultitenancyCaching;
+
+    protected $signature = 'tenants:cache';
+
+    protected $description = 'Cache tenant models';
+
+    public function handle()
+    {
+        $this->info('Caching tenants...');
+
+        $this->createTenantCache();
+    }
+}

src/Commands/TenantsRefreshCommand.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Spatie\Multitenancy\Commands;
+
+use Illuminate\Console\Command;
+use Spatie\Multitenancy\Concerns\UsesMultitenancyCaching;
+
+class TenantsRefreshCommand extends Command
+{
+    use UsesMultitenancyCaching;
+
+    protected $signature = 'tenants:refresh';
+
+    protected $description = 'Refresh tenant cache';
+
+    public function handle()
+    {
+        $this->info('Clearing tenant caches...');
+
+        $this->clearTenantCache();
+    }
+}

src/Concerns/UsesMultitenancyCaching.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace Spatie\Multitenancy\Concerns;
+
+use Illuminate\Support\Collection;
+
+trait UsesMultitenancyCaching
+{
+    protected function createTenantCache(): void
+    {
+        $cacheStore = $this->getTenantCacheStore();
+
+        if ($cacheStore === false) {
+            return;
+        }
+
+        $cacheKey = $this->getTenantCacheKey();
+
+        $cacheDuration = $this->getTenantCacheDuration();
+
+        if ($cacheDuration === null) {
+            cache()
+                ->store($cacheStore)
+                ->rememberForever($cacheKey, fn () => $this->getTenantCollection());
+
+            return;
+        }
+
+        cache()
+            ->store($cacheStore)
+            ->remember($cacheKey, $cacheDuration, fn () => $this->getTenantCollection());
+    }
+
+    protected function clearTenantCache(): void
+    {
+        cache()
+            ->store($this->getTenantCacheStore())
+            ->delete($this->getTenantCacheKey());
+    }
+
+    protected function getTenantCache(): Collection
+    {
+        return cache()
+            ->store($this->getTenantCacheStore())
+            ->get($this->getTenantCacheKey(), collect());
+    }
+
+    protected function getTenantCollection(): Collection
+    {
+        $tenantModelClass = config('multitenancy.tenant_model');
+
+        return app($tenantModelClass)::all();
+    }
+
+    protected function getTenantCacheKey(): string
+    {
+        return config('multitenancy.cache_key', 'multitenancy');
+    }
+
+    protected function getTenantCacheDuration(): ?int
+    {
+        return config('multitenancy.cache_duration');
+    }
+
+    protected function getTenantCacheStore(): mixed
+    {
+        return config('multitenancy.cache_store');
+    }
+}

src/MultitenancyServiceProvider.php

@@ -8,6 +8,8 @@
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 use Spatie\Multitenancy\Commands\TenantsArtisanCommand;
+use Spatie\Multitenancy\Commands\TenantsCacheCommand;
+use Spatie\Multitenancy\Commands\TenantsRefreshCommand;
 use Spatie\Multitenancy\Concerns\UsesMultitenancyConfig;
 use Spatie\Multitenancy\Models\Concerns\UsesTenantModel;
 
@@ -22,7 +24,11 @@ public function configurePackage(Package $package): void
             ->name('laravel-multitenancy')
             ->hasConfigFile()
             ->hasMigration('landlord/create_landlord_tenants_table')
-            ->hasCommand(TenantsArtisanCommand::class);
+            ->hasCommands([
+                  TenantsArtisanCommand::class,
+                  TenantsCacheCommand::class,
+                  TenantsRefreshCommand::class,
+             ]);
     }
 
     public function packageBooted(): void

src/TenantFinder/DomainTenantFinder.php

@@ -3,17 +3,30 @@
 namespace Spatie\Multitenancy\TenantFinder;
 
 use Illuminate\Http\Request;
+use Spatie\Multitenancy\Concerns\UsesMultitenancyCaching;
 use Spatie\Multitenancy\Models\Concerns\UsesTenantModel;
 use Spatie\Multitenancy\Models\Tenant;
 
 class DomainTenantFinder extends TenantFinder
 {
+    use UsesMultitenancyCaching;
     use UsesTenantModel;
 
     public function findForRequest(Request $request): ?Tenant
     {
         $host = $request->getHost();
 
-        return $this->getTenantModel()::whereDomain($host)->first();
+        if ($this->getTenantCacheStore() === false) {
+            return $this->findTenantByDomain($host);
+        }
+
+        $cache = $this->getTenantCache();
+
+        return $cache->firstWhere('domain', $host) ?? $this->findTenantByDomain($host);
+    }
+
+    protected function findTenantByDomain(string $domain): ?Tenant
+    {
+        return $this->getTenantModel()::firstWhere('domain', $domain);
     }
 }

tests/Feature/Commands/TenantsCacheCommandTest

@@ -0,0 +1,13 @@
+<?php
+
+it('can cache tenants', function () {
+    $this
+        ->artisan('tenants:cache')
+        ->assertExitCode(0);
+});
+
+it('can refresh tenants', function () {
+    $this
+        ->artisan('tenants:refresh')
+        ->assertExitCode(0);
+});