Implement tag-based cache invalidation, and apply to Gedcom Records.

fisharebest · Mar 13, 2021 · 7acddc2 · 7acddc2
1 parent 9028837
commit 7acddc2
Show file tree

Hide file tree

Showing 21 changed files with 256 additions and 44 deletions.
diff --git a/app/Cache.php b/app/Cache.php
@@ -20,44 +20,73 @@
 namespace Fisharebest\Webtrees;
 
 use Closure;
-use Symfony\Contracts\Cache\CacheInterface;
 use Symfony\Contracts\Cache\ItemInterface;
+use Symfony\Contracts\Cache\TagAwareCacheInterface;
 
 /**
  * Wrapper around the symfony PSR6 cache library.
  * Hash the keys to protect against characters that are not allowed in PSR6.
  */
 class Cache
 {
-    /** @var CacheInterface */
+    /** @var TagAwareCacheInterface */
     private $cache;
 
     /**
      * Cache constructor.
      *
-     * @param CacheInterface $cache
+     * @param TagAwareCacheInterface $cache
      */
-    public function __construct(CacheInterface $cache)
+    public function __construct(TagAwareCacheInterface $cache)
     {
         $this->cache = $cache;
     }
 
+    /**
+     * Generate a key compatible with PSR-6 requirements
+     * @see https://www.php-fig.org/psr/psr-6/
+     *
+     * @param string $key
+     * @return string
+     */
+    public function safeKey(string $key): string
+    {
+        return md5($key);
+    }
+
     /**
      * Fetch an item from the cache - or create it where it does not exist.
      *
      * @param string   $key
      * @param Closure  $closure
      * @param int|null $ttl
+     * @param string[] $tags
      *
      * @return mixed
      */
-    public function remember(string $key, Closure $closure, int $ttl = null)
+    public function remember(string $key, Closure $closure, int $ttl = null, array $tags = [])
     {
-        return $this->cache->get(md5($key), static function (ItemInterface $item) use ($closure, $ttl) {
-            $item->expiresAfter($ttl);
+        $tags = array_map([$this, 'safeKey'], $tags);
+        return $this->cache->get(
+            $this->safeKey($key),
+            static function (ItemInterface $item) use ($closure, $tags, $ttl) {
+                $item->expiresAfter($ttl);
+                $item->tag($tags);
 
-            return $closure();
-        });
+                return $closure();
+            }
+        );
+    }
+
+    /**
+     * Invalidate cache items based on tags.
+     *
+     * @param string[] $tags
+     * @return bool
+     */
+    public function invalidateTags(array $tags): bool
+    {
+        return $this->cache->invalidateTags(array_map([$this, 'safeKey'], $tags));
     }
 
     /**
@@ -67,6 +96,6 @@ public function remember(string $key, Closure $closure, int $ttl = null)
      */
     public function forget(string $key): void
     {
-        $this->cache->delete(md5($key));
+        $this->cache->delete($this->safeKey($key));
     }
 }
diff --git a/app/Factories/AbstractGedcomRecordFactory.php b/app/Factories/AbstractGedcomRecordFactory.php
@@ -45,7 +45,7 @@ protected function pendingChanges(Tree $tree): Collection
                 ->where('status', '=', 'pending')
                 ->orderBy('change_id')
                 ->pluck('new_gedcom', 'xref');
-        });
+        }, null, ['pending-t-' . $tree->id()]);
     }
 
     /**

diff --git a/app/Factories/CacheFactory.php b/app/Factories/CacheFactory.php
@@ -23,7 +23,8 @@
 use Fisharebest\Webtrees\Contracts\CacheFactoryInterface;
 use Fisharebest\Webtrees\Webtrees;
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
-use Symfony\Component\Cache\Adapter\FilesystemAdapter;
+use Symfony\Component\Cache\Adapter\FilesystemTagAwareAdapter;
+use Symfony\Component\Cache\Adapter\TagAwareAdapter;
 
 use function random_int;
 
@@ -39,19 +40,19 @@ class CacheFactory implements CacheFactoryInterface
     private const FILES_TTL = 8640000;
     private const FILES_DIR = Webtrees::DATA_DIR . 'cache/';
 
-    /** @var ArrayAdapter */
+    /** @var TagAwareAdapter */
     private $array_adapter;
 
-    /** @var FilesystemAdapter */
+    /** @var FilesystemTagAwareAdapter */
     private $filesystem_adapter;
 
     /**
      * CacheFactory constructor.
      */
     public function __construct()
     {
-        $this->array_adapter      = new ArrayAdapter(0, false);
-        $this->filesystem_adapter = new FilesystemAdapter('', self::FILES_TTL, self::FILES_DIR);
+        $this->array_adapter      = new TagAwareAdapter(new ArrayAdapter(0, false));
+        $this->filesystem_adapter = new FilesystemTagAwareAdapter('', self::FILES_TTL, self::FILES_DIR);
     }
 
     /**

diff --git a/app/Factories/FamilyFactory.php b/app/Factories/FamilyFactory.php
@@ -68,7 +68,7 @@ public function make(string $xref, Tree $tree, string $gedcom = null): ?Family
                 ->map(Registry::individualFactory()->mapper($tree));
 
             return new Family($xref, $gedcom ?? '', $pending, $tree);
-        });
+        }, null, ['gedrec-' . $xref . '@' . $tree->id()]);
     }
 
     /**

diff --git a/app/Factories/GedcomRecordFactory.php b/app/Factories/GedcomRecordFactory.php
@@ -108,7 +108,7 @@ public function make(string $xref, Tree $tree, string $gedcom = null): ?GedcomRe
                 $type = $this->extractType($gedcom ?? $pending);
 
                 return $this->newGedcomRecord($type, $xref, $gedcom ?? '', $pending, $tree);
-            });
+            }, null, ['gedrec-' . $xref . '@' . $tree->id()]);
     }
 
     /**

diff --git a/app/Factories/HeaderFactory.php b/app/Factories/HeaderFactory.php
@@ -59,7 +59,7 @@ public function make(string $xref, Tree $tree, string $gedcom = null): ?Header
             $xref = $this->extractXref($gedcom ?? $pending, $xref);
 
             return new Header($xref, $gedcom ?? '', $pending, $tree);
-        });
+        }, null, ['gedrec-' . $xref . '@' . $tree->id()]);
     }
 
     /**

diff --git a/app/Factories/IndividualFactory.php b/app/Factories/IndividualFactory.php
@@ -58,7 +58,7 @@ public function make(string $xref, Tree $tree, string $gedcom = null): ?Individu
             $xref = $this->extractXref($gedcom ?? $pending, $xref);
 
             return new Individual($xref, $gedcom ?? '', $pending, $tree);
-        });
+        }, null, ['gedrec-' . $xref . '@' . $tree->id()]);
     }
 
     /**

diff --git a/app/Factories/LocationFactory.php b/app/Factories/LocationFactory.php
@@ -59,7 +59,7 @@ public function make(string $xref, Tree $tree, string $gedcom = null): ?Location
             $xref = $this->extractXref($gedcom ?? $pending, $xref);
 
             return new Location($xref, $gedcom ?? '', $pending, $tree);
-        });
+        }, null, ['gedrec-' . $xref . '@' . $tree->id()]);
     }
 
     /**

diff --git a/app/Factories/MediaFactory.php b/app/Factories/MediaFactory.php
@@ -59,7 +59,7 @@ public function make(string $xref, Tree $tree, string $gedcom = null): ?Media
             $xref = $this->extractXref($gedcom ?? $pending, $xref);
 
             return new Media($xref, $gedcom ?? '', $pending, $tree);
-        });
+        }, null, ['gedrec-' . $xref . '@' . $tree->id()]);
     }
 
     /**

diff --git a/app/Factories/NoteFactory.php b/app/Factories/NoteFactory.php
@@ -59,7 +59,7 @@ public function make(string $xref, Tree $tree, string $gedcom = null): ?Note
             $xref = $this->extractXref($gedcom ?? $pending, $xref);
 
             return new Note($xref, $gedcom ?? '', $pending, $tree);
-        });
+        }, null, ['gedrec-' . $xref . '@' . $tree->id()]);
     }
 
     /**

diff --git a/app/Factories/RepositoryFactory.php b/app/Factories/RepositoryFactory.php
@@ -59,7 +59,7 @@ public function make(string $xref, Tree $tree, string $gedcom = null): ?Reposito
             $xref = $this->extractXref($gedcom ?? $pending, $xref);
 
             return new Repository($xref, $gedcom ?? '', $pending, $tree);
-        });
+        }, null, ['gedrec-' . $xref . '@' . $tree->id()]);
     }
 
     /**

diff --git a/app/Factories/SourceFactory.php b/app/Factories/SourceFactory.php
@@ -60,7 +60,7 @@ public function make(string $xref, Tree $tree, string $gedcom = null): ?Source
             $xref = $this->extractXref($gedcom ?? $pending, $xref);
 
             return new Source($xref, $gedcom ?? '', $pending, $tree);
-        });
+        }, null, ['gedrec-' . $xref . '@' . $tree->id()]);
     }
 
     /**

diff --git a/app/Factories/SubmissionFactory.php b/app/Factories/SubmissionFactory.php
@@ -59,7 +59,7 @@ public function make(string $xref, Tree $tree, string $gedcom = null): ?Submissi
             $xref = $this->extractXref($gedcom ?? $pending, $xref);
 
             return new Submission($xref, $gedcom ?? '', $pending, $tree);
-        });
+        }, null, ['gedrec-' . $xref . '@' . $tree->id()]);
     }
 
     /**

diff --git a/app/Factories/SubmitterFactory.php b/app/Factories/SubmitterFactory.php
@@ -59,7 +59,7 @@ public function make(string $xref, Tree $tree, string $gedcom = null): ?Submitte
             $xref = $this->extractXref($gedcom ?? $pending, $xref);
 
             return new Submitter($xref, $gedcom ?? '', $pending, $tree);
-        });
+        }, null, ['gedrec-' . $xref . '@' . $tree->id()]);
     }
 
     /**

diff --git a/app/GedcomRecord.php b/app/GedcomRecord.php
@@ -283,7 +283,7 @@ public function canShow(int $access_level = null): bool
 
         return Registry::cache()->array()->remember($cache_key, function () use ($access_level) {
             return $this->canShowRecord($access_level);
-        });
+        }, null, ['gedrec-' . $this->tree->id() . '-' . $this->xref]);
     }
 
     /**
@@ -973,6 +973,7 @@ public function updateFact(string $fact_id, string $gedcom, bool $update_chan):
             ]);
 
             $this->pending = $new_gedcom;
+            $this->invalidateInCache();
 
             if (Auth::user()->getPreference(UserInterface::PREF_AUTO_ACCEPT_EDITS) === '1') {
                 app(PendingChangesService::class)->acceptRecord($this);
@@ -1019,6 +1020,7 @@ public function updateRecord(string $gedcom, bool $update_chan): void
 
         // Clear the cache
         $this->pending = $gedcom;
+        $this->invalidateInCache();
 
         // Accept this pending change
         if (Auth::user()->getPreference(UserInterface::PREF_AUTO_ACCEPT_EDITS) === '1') {
@@ -1050,6 +1052,8 @@ public function deleteRecord(): void
             ]);
         }
 
+        $this->invalidateInCache();
+
         // Auto-accept this pending change
         if (Auth::user()->getPreference(UserInterface::PREF_AUTO_ACCEPT_EDITS) === '1') {
             app(PendingChangesService::class)->acceptRecord($this);
@@ -1058,6 +1062,20 @@ public function deleteRecord(): void
         Log::addEditLog('Delete: ' . static::RECORD_TYPE . ' ' . $this->xref, $this->tree);
     }
 
+    /**
+     * Invalidate this record in the caches
+     * Only the array cache is invalidated
+     *
+     * @return bool
+     */
+    public function invalidateInCache(): bool
+    {
+        return Registry::cache()->array()->invalidateTags([
+            'gedrec-' . $this->xref . '@' . $this->tree()->id() . '',
+            'pending-t-' . $this->tree->id()
+        ]);
+    }
+
     /**
      * Remove all links from this record to $xref
      *

diff --git a/app/Module/MediaTabModule.php b/app/Module/MediaTabModule.php
@@ -132,21 +132,27 @@ public function getTabContent(Individual $individual): string
      */
     protected function getFactsWithMedia(Individual $individual): Collection
     {
-        return Registry::cache()->array()->remember(__CLASS__ . ':' . __METHOD__, static function () use ($individual): Collection {
-            $facts = $individual->facts();
-
-            foreach ($individual->spouseFamilies() as $family) {
-                if ($family->canShow()) {
-                    $facts = $facts->concat($family->facts());
+        $cacheTag = $individual->xref() . '@' . $individual->tree()->id();
+        return Registry::cache()->array()->remember(
+            __CLASS__ . ':' . __METHOD__ . '-' . $cacheTag,
+            static function () use ($individual): Collection {
+                $facts = $individual->facts();
+
+                foreach ($individual->spouseFamilies() as $family) {
+                    if ($family->canShow()) {
+                        $facts = $facts->concat($family->facts());
+                    }
                 }
-            }
 
-            $facts = $facts->filter(static function (Fact $fact): bool {
-                return preg_match('/(?:^1|\n\d) OBJE @' . Gedcom::REGEX_XREF . '@/', $fact->gedcom()) === 1;
-            });
+                $facts = $facts->filter(static function (Fact $fact): bool {
+                    return preg_match('/(?:^1|\n\d) OBJE @' . Gedcom::REGEX_XREF . '@/', $fact->gedcom()) === 1;
+                });
 
-            return Fact::sortFacts($facts);
-        });
+                return Fact::sortFacts($facts);
+            },
+            null,
+            ['gedrec-' . $cacheTag]
+        );
     }
 
     /**
-Original file line number
+Diff line change
@@ Expand Up @@
                     ->map(Registry::individualFactory()->mapper($tree));
                 return new Family($xref, $gedcom ?? '', $pending, $tree);
-            });
+            }, null, ['gedrec-' . $xref . '@' . $tree->id()]);
         }
         /**
@@ Expand Down @@