[5.x] Nocache database driver (#10671)

Co-authored-by: Duncan McClean <[email protected]>

Author: jasonvarga

config/static_caching.php

@@ -102,6 +102,21 @@
 
     'ignore_query_strings' => false,
 
+    /*
+    |--------------------------------------------------------------------------
+    | Nocache
+    |--------------------------------------------------------------------------
+    |
+    | Here you may define where the nocache data is stored.
+    |
+    | https://statamic.dev/tags/nocache#database
+    |
+    | Supported drivers: "cache", "database"
+    |
+    */
+
+    'nocache' => 'cache',
+
     /*
     |--------------------------------------------------------------------------
     | Replacers

src/Console/Commands/NocacheMigration.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Statamic\Console\Commands;
+
+use Illuminate\Console\Command;
+use Illuminate\Support\Carbon;
+use Illuminate\Support\Composer;
+use Statamic\Console\RunsInPlease;
+use Statamic\Facades\File;
+
+class NocacheMigration extends Command
+{
+    use RunsInPlease;
+
+    protected $composer;
+    protected $signature = 'statamic:nocache:migration {--path=}';
+    protected $description = 'Generate Nocache Migrations';
+
+    public function __construct(Composer $composer)
+    {
+        parent::__construct();
+
+        $this->composer = $composer;
+    }
+
+    public function handle()
+    {
+        $from = __DIR__.'/stubs/statamic_nocache_tables.php.stub';
+        $file = Carbon::now()->format('Y_m_d_His').'_statamic_nocache_tables';
+        $to = ($path = $this->option('path')) ? $path."/{$file}.php" : database_path("migrations/{$file}.php");
+
+        $contents = File::get($from);
+
+        $contents = str_replace('NOCACHE_TABLE', 'nocache_regions', $contents);
+
+        File::put($to, $contents);
+
+        $this->components->info("Migration [$file] created successfully.");
+
+        $this->composer->dumpAutoloads();
+    }
+}

src/Console/Commands/stubs/statamic_nocache_tables.php.stub

@@ -0,0 +1,23 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class StatamicNocacheTables extends Migration
+{
+    public function up()
+    {
+        Schema::create('NOCACHE_TABLE', function (Blueprint $table) {
+            $table->string('key')->index()->primary();
+            $table->string('url')->index();
+            $table->longText('region');
+            $table->timestamps();
+        });
+    }
+
+    public function down()
+    {
+        Schema::dropIfExists('nocache_regions');
+    }
+}

src/Providers/ConsoleServiceProvider.php

@@ -45,6 +45,7 @@ class ConsoleServiceProvider extends ServiceProvider
         Commands\SupportZipBlueprint::class,
         Commands\AuthMigration::class,
         Commands\Multisite::class,
+        Commands\NocacheMigration::class,
         Commands\SiteClear::class,
         Commands\UpdatesRun::class,
         Commands\ImportGroups::class,

src/StaticCaching/NoCache/DatabaseRegion.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Statamic\StaticCaching\NoCache;
+
+use Illuminate\Database\Eloquent\Model;
+
+class DatabaseRegion extends Model
+{
+    protected $table = 'nocache_regions';
+
+    protected $guarded = [];
+
+    protected $primaryKey = 'key';
+
+    protected $casts = [
+        'key' => 'string',
+    ];
+}

src/StaticCaching/NoCache/DatabaseSession.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Statamic\StaticCaching\NoCache;
+
+class DatabaseSession extends Session
+{
+    public function write()
+    {
+        // Nothing to write. Session gets compiled by querying regions.
+    }
+
+    public function restore()
+    {
+        $regions = DatabaseRegion::where('url', $this->url)->get(['key']);
+
+        $this->regions = $regions->map->key;
+
+        $this->cascade = $this->restoreCascade();
+
+        $this->resolvePageAndPathForPagination();
+
+        return $this;
+    }
+
+    public function region(string $key): Region
+    {
+        $region = DatabaseRegion::where('key', $key)->first();
+
+        if (! $region) {
+            throw new RegionNotFound($key);
+        }
+
+        return unserialize($region->region);
+    }
+
+    protected function cacheRegion(Region $region)
+    {
+        DatabaseRegion::updateOrCreate([
+            'key' => $region->key(),
+        ], [
+            'url' => $this->url,
+            'region' => serialize($region),
+        ]);
+    }
+}

src/StaticCaching/NoCache/Session.php

@@ -131,15 +131,15 @@ public function restore()
         return $this;
     }
 
-    private function restoreCascade()
+    protected function restoreCascade()
     {
         return Cascade::instance()
             ->withContent(Data::findByRequestUrl($this->url))
             ->hydrate()
             ->toArray();
     }
 
-    private function resolvePageAndPathForPagination(): void
+    protected function resolvePageAndPathForPagination(): void
     {
         AbstractPaginator::currentPathResolver(fn () => Str::before($this->url, '?'));
 
@@ -148,7 +148,7 @@ private function resolvePageAndPathForPagination(): void
         });
     }
 
-    private function cacheRegion(Region $region)
+    protected function cacheRegion(Region $region)
     {
         StaticCache::cacheStore()->forever('nocache::region.'.$region->key(), $region);
     }

src/StaticCaching/ServiceProvider.php

@@ -7,6 +7,7 @@
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\ServiceProvider as LaravelServiceProvider;
 use Statamic\Facades\Cascade;
+use Statamic\StaticCaching\NoCache\DatabaseSession;
 use Statamic\StaticCaching\NoCache\Session;
 
 class ServiceProvider extends LaravelServiceProvider
@@ -41,7 +42,11 @@ public function register()
                 $uri = explode('?', $uri)[0];
             }
 
-            return new Session($uri);
+            return match ($driver = config('statamic.static_caching.nocache', 'cache')) {
+                'cache' => new Session($uri),
+                'database' => new DatabaseSession($uri),
+                default => throw new \Exception('Nocache driver ['.$driver.'] is not supported.'),
+            };
         });
 
         $this->app->bind(UrlExcluder::class, function ($app) {

src/StaticCaching/StaticCacheManager.php

@@ -10,6 +10,7 @@
 use Statamic\StaticCaching\Cachers\FileCacher;
 use Statamic\StaticCaching\Cachers\NullCacher;
 use Statamic\StaticCaching\Cachers\Writer;
+use Statamic\StaticCaching\NoCache\DatabaseRegion;
 use Statamic\Support\Manager;
 
 class StaticCacheManager extends Manager
@@ -66,11 +67,26 @@ public function flush()
     {
         $this->driver()->flush();
 
+        $this->flushNocache();
+
         if ($this->hasCustomStore()) {
             $this->cacheStore()->flush();
+        }
+
+        StaticCacheCleared::dispatch();
+    }
+
+    private function flushNocache()
+    {
+        if (config('statamic.static_caching.nocache', 'cache') === 'database') {
+            DatabaseRegion::truncate();
 
-            StaticCacheCleared::dispatch();
+            return;
+        }
 
+        // No need to do any looping if there's a custom
+        // store because the entire store will be flushed.
+        if ($this->hasCustomStore()) {
             return;
         }
 
@@ -81,8 +97,6 @@ public function flush()
         });
 
         $this->cacheStore()->forget('nocache::urls');
-
-        StaticCacheCleared::dispatch();
     }
 
     public function nocacheJs(string $js)