Abstract Storage

Api/QueueInterface.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SamJUK\CacheDebounce\Api;
+
+interface QueueInterface
+{
+    /**
+     * Add new tags to the purge queue
+     */
+    public function add(array $tags) : void;
+
+    /**
+     * Get all tags from the purge queue
+     */
+    public function get() : array;
+
+    /**
+     * Purge all queued tags, and clear the queue
+     */
+    public function flush() : void;
+}

Console/Command/Flush.php

@@ -8,21 +8,21 @@
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
-use SamJUK\CacheDebounce\Model\Entries as CacheDebouncedEntries;
+use SamJUK\CacheDebounce\Api\QueueInterface;
 
 class Flush extends Command
 {
-    private $cacheDebouncedEntries;
+    private $queue;
 
     /**
-     * @param CacheDebouncedEntries $cacheDebouncedEntries
+     * @param QueueInterface $queue
      * @param string|null $name
      */
     public function __construct(
-        CacheDebouncedEntries $cacheDebouncedEntries,
+        QueueInterface $queue,
         $name = null
     ) {
-        $this->cacheDebouncedEntries = $cacheDebouncedEntries;
+        $this->queue = $queue;
         parent::__construct($name);
     }
 
@@ -37,7 +37,7 @@ protected function configure(): void
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         try {
-            $this->cacheDebouncedEntries->flush();
+            $this->queue->flush();
             $output->writeln('<info>Flushed Debounced Cache Purges.</info>');
             return 0;
         } catch (LocalizedException $e) {

Cron/Flush.php

@@ -4,21 +4,21 @@
 
 namespace SamJUK\CacheDebounce\Cron;
 
-use SamJUK\CacheDebounce\Model\Entries as CacheDebouncedEntries;
+use SamJUK\CacheDebounce\Api\QueueInterface;
 
 class Flush
 {
-    /** @var CacheDebouncedEntries $cacheDebouncedEntries */
-    private $cacheDebouncedEntries;
+    /** @var QueueInterface $queue */
+    private $queue;
 
     public function __construct(
-        CacheDebouncedEntries $cacheDebouncedEntries
+        QueueInterface $queue
     ) {
-        $this->cacheDebouncedEntries = $cacheDebouncedEntries;
+        $this->queue = $queue;
     }
 
     public function execute() : void
     {
-        $this->cacheDebouncedEntries->flush();
+        $this->queue->flush();
     }
 }

Model/Entries.php → Model/Queue/Database.php

@@ -2,14 +2,15 @@
 
 declare(strict_types=1);
 
-namespace SamJUK\CacheDebounce\Model;
+namespace SamJUK\CacheDebounce\Model\Queue;
 
+use SamJUK\CacheDebounce\Api\QueueInterface;
 use SamJUK\CacheDebounce\Model\Config;
 use Magento\CacheInvalidate\Model\PurgeCache;
 use Magento\Framework\App\ResourceConnection;
 use Psr\Log\LoggerInterface;
 
-class Entries
+class Database implements QueueInterface
 {
     /** @var string $tableName */
     private $tableName;
@@ -40,7 +41,7 @@ public function __construct(
     }
 
     /**
-     * Add new tags to the purge queue
+     * {@inheritDoc}
      */
     public function add(array $tags) : void
     {
@@ -49,7 +50,7 @@ public function add(array $tags) : void
     }
 
     /**
-     * Get all tags from the purge queue
+     * {@inheritDoc}
      */
     public function get() : array
     {
@@ -59,7 +60,7 @@ public function get() : array
     }
 
     /**
-     * Purge all queued tags, and clear the queue
+     * {@inheritDoc}
      */
     public function flush() : void
     {

Plugin/PurgeCache.php

@@ -5,23 +5,23 @@
 namespace SamJUK\CacheDebounce\Plugin;
 
 use SamJUK\CacheDebounce\Model\Config;
-use SamJUK\CacheDebounce\Model\Entries as CacheDebounceEntries;
+use SamJUK\CacheDebounce\Api\QueueInterface;
 use Magento\CacheInvalidate\Model\PurgeCache as Subject;
 
 class PurgeCache
 {
     /** @var Config $config **/
     private $config;
 
-    /** @var CacheDebounceEntries $cacheDebouncedEntries */
-    private $cacheDebouncedEntries;
+    /** @var QueueInterface $queue */
+    private $queue;
 
     public function __construct(
         Config $config,
-        CacheDebounceEntries $cacheDebounceEntries
+        QueueInterface $queue
     ) {
         $this->config = $config;
-        $this->cacheDebouncedEntries = $cacheDebounceEntries;
+        $this->queue = $queue;
     }
 
     /**
@@ -42,7 +42,7 @@ public function aroundSendPurgeRequest(Subject $subject, callable $proceed, $tag
             $tags = [$tags];
         }
 
-        $this->cacheDebouncedEntries->add($tags);
+        $this->queue->add($tags);
         return true;
     }
 }

README.md

@@ -40,6 +40,9 @@ Option | Config Path | Default | Description
 Enabled | `samjuk_cache_debounce/general/enabled` | `0` | Feature flag to toggle functionality of the module
 Flush Schedule | `samjuk_cache_debounce/cron/flush_schedule` | `*/5 0 0 0 0` | Cron schedule to run the scheduled flush
 
+## Extension
+Additional datastores can be implemented by updating the `QueueInterface` preference in `di.xml`. 
+
 ## Will this help my store?
 
 The performance improvement comes from improving cache performance by reducing the amount of cache purge requests in turn reducing system load.

Test/Integration/Model/Queue/DatabaseTest.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SamJUK\CacheDebounce\Test\Integration\Model\Queue;
+
+use PHPUnit\Framework\TestCase;
+use Magento\TestFramework\ObjectManager;
+
+class DatabaseTest extends TestCase
+{
+    private const CACHE_TAGS = ['cat_c_1', 'cat_c_2', 'cat_c_p_1'];
+
+    protected $objectManager;
+    private $queue;
+
+    protected function setUp(): void
+    {
+        $this->objectManager = ObjectManager::getInstance();
+        $this->queue = $this->objectManager->get(\SamJUK\CacheDebounce\Api\QueueInterface::class);
+    }
+
+    public function testDatabaseStorage()
+    {
+        $this->queue->add(self::CACHE_TAGS);
+        $this->assertEquals(self::CACHE_TAGS, $this->queue->get());
+
+        $this->queue->flush();
+        $this->assertEquals([], $this->queue->get());
+    }
+}

Test/Unit/Model/ConfigTest.php

@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace SamJUK\CacheDebounce\Test\Unit\Model;
 

Test/Unit/Model/EntriesTest.php → Test/Unit/Model/Queue/DatabaseTest.php

@@ -1,11 +1,13 @@
-<?php declare(strict_types=1);
+<?php
 
-namespace SamJUK\CacheDebounce\Test\Unit\Model;
+declare(strict_types=1);
+
+namespace SamJUK\CacheDebounce\Test\Unit\Model\Queue;
 
 use PHPUnit\Framework\TestCase;
-use SamJUK\CacheDebounce\Model\Entries as CacheDebounceEntries;
+use SamJUK\CacheDebounce\Model\Queue\Database as DatabaseQueue;
 
-class EntriesTest extends TestCase
+class DatabaseTest extends TestCase
 {
     private const CACHE_TAGS = ['cat_c_1', 'cat_c_2', 'cat_c_p_1'];
 
@@ -14,7 +16,7 @@ class EntriesTest extends TestCase
     private $connection;
     private $resourceConnection;
     private $loggerInterface;
-    private $cacheDebounceEntries;
+    private $databaseQueue;
     private $select;
 
     protected function setUp(): void
@@ -29,7 +31,7 @@ protected function setUp(): void
         $this->resourceConnection->method('getConnection')->willReturn($this->connection);
         $this->purgeCacheModel = $this->createMock(\Magento\CacheInvalidate\Model\PurgeCache::class);
         $this->loggerInterface = $this->createMock(\Psr\Log\LoggerInterface::class);
-        $this->cacheDebounceEntries = new CacheDebounceEntries(
+        $this->databaseQueue = new DatabaseQueue(
             $this->cacheDebounceConfig,
             $this->purgeCacheModel,
             $this->resourceConnection,
@@ -47,6 +49,6 @@ public function testFlushTags()
             ->method('sendPurgeRequest')
             ->with([self::CACHE_TAGS]);
 
-        $this->cacheDebounceEntries->flush();
+        $this->databaseQueue->flush();
     }
 }

Test/Unit/Plugin/PurgeCacheTest.php

@@ -1,10 +1,12 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace SamJUK\CacheDebounce\Test\Unit\Plugin;
 
 use PHPUnit\Framework\TestCase;
 use SamJUK\CacheDebounce\Model\Config as CacheDebounceConfig;
-use SamJUK\CacheDebounce\Model\Entries as CacheDebounceEntries;
+use SamJUK\CacheDebounce\Api\QueueInterface;
 use SamJUK\CacheDebounce\Plugin\PurgeCache as PurgeCachePlugin;
 use Magento\CacheInvalidate\Model\PurgeCache as PurgeCacheModel;
 
@@ -14,8 +16,8 @@ public function testPluginDebouncesPurgeRequest()
     {
         $purgeCacheModel = $this->createMock(PurgeCacheModel::class);
         $cacheDebounceConfig = $this->createMock(CacheDebounceConfig::class);
-        $cacheDebounceEntries = $this->createMock(CacheDebounceEntries::class);
-        $purgeCachePlugin = new PurgeCachePlugin($cacheDebounceConfig, $cacheDebounceEntries);
+        $queue = $this->createMock(QueueInterface::class);
+        $purgeCachePlugin = new PurgeCachePlugin($cacheDebounceConfig, $queue);
 
         $cacheDebounceConfig->method('shouldDebouncePurgeRequest')
             ->willReturn(true);
@@ -34,8 +36,8 @@ public function testPluginSkipsDebouncePurgeRequest()
     {
         $purgeCacheModel = $this->createMock(PurgeCacheModel::class);
         $cacheDebounceConfig = $this->createMock(CacheDebounceConfig::class);
-        $cacheDebounceEntries = $this->createMock(CacheDebounceEntries::class);
-        $purgeCachePlugin = new PurgeCachePlugin($cacheDebounceConfig, $cacheDebounceEntries);
+        $queue = $this->createMock(QueueInterface::class);
+        $purgeCachePlugin = new PurgeCachePlugin($cacheDebounceConfig, $queue);
 
         $cacheDebounceConfig->method('shouldDebouncePurgeRequest')
             ->willReturn(false);

etc/di.xml

@@ -1,5 +1,7 @@
 <?xml version="1.0"?>
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
+    <preference for="SamJUK\CacheDebounce\Api\QueueInterface" type="SamJUK\CacheDebounce\Model\Queue\Database" />
+
     <type name="Magento\CacheInvalidate\Model\PurgeCache">
         <plugin name="samjuk_cachedebounce_purge_cache" type="SamJUK\CacheDebounce\Plugin\PurgeCache" />
     </type>
@@ -11,5 +13,4 @@
             </argument>
         </arguments>
     </type>
-
 </config>