Use unique names for queue unique cache configurations

Author: sheldonreiff

src/Command/WorkerCommand.php

@@ -130,10 +130,12 @@ protected function getQueueExtension(Arguments $args, LoggerInterface $logger):
 
         $limitAttempsExtension->getEventManager()->on(new FailedJobsListener());
 
+        $configKey = (string)$args->getOption('config');
+        $config = QueueManager::getConfig($configKey);
+
         $extensions = [
             new LoggerExtension($logger),
             $limitAttempsExtension,
-            new RemoveUniqueJobIdFromCacheExtension('Cake/Queue.queueUnique'),
         ];
 
         if (!is_null($args->getOption('max-jobs'))) {
@@ -146,6 +148,10 @@ protected function getQueueExtension(Arguments $args, LoggerInterface $logger):
             $extensions[] = new LimitConsumptionTimeExtension($endTime);
         }
 
+        if (isset($config['uniqueCacheKey'])) {
+            $extensions[] = new RemoveUniqueJobIdFromCacheExtension($config['uniqueCacheKey']);
+        }
+
         return new ChainExtension($extensions);
     }
 
@@ -172,16 +178,16 @@ protected function getLogger(Arguments $args): LoggerInterface
      */
     public function execute(Arguments $args, ConsoleIo $io)
     {
-        $logger = $this->getLogger($args);
-        $processor = new Processor($logger, $this->container);
-        $extension = $this->getQueueExtension($args, $logger);
-
         $config = (string)$args->getOption('config');
         if (!Configure::check(sprintf('Queue.%s', $config))) {
             $io->error(sprintf('Configuration key "%s" was not found', $config));
             $this->abort();
         }
 
+        $logger = $this->getLogger($args);
+        $processor = new Processor($logger, $this->container);
+        $extension = $this->getQueueExtension($args, $logger);
+
         $hasListener = Configure::check(sprintf('Queue.%s.listener', $config));
         if ($hasListener) {
             $listenerClassName = Configure::read(sprintf('Queue.%s.listener', $config));

src/QueueManager.php

@@ -127,7 +127,9 @@ public static function setConfig($key, $config = null): void
 
             $cacheConfig = array_merge($cacheDefaults, $config['uniqueCache']);
 
-            Cache::setConfig('Cake/Queue.queueUnique', $cacheConfig);
+            $config['uniqueCacheKey'] = "Cake/Queue.queueUnique.{$key}";
+
+            Cache::setConfig($config['uniqueCacheKey'], $cacheConfig);
         }
 
         /** @psalm-suppress InvalidPropertyAssignmentValue */
@@ -228,15 +230,15 @@ public static function push($className, array $data = [], array $options = []):
 
         /** @psalm-suppress InvalidPropertyFetch */
         if (!empty($class::$shouldBeUnique)) {
-            if (!Cache::getConfig('Cake/Queue.queueUnique')) {
+            if (empty($config['uniqueCache'])) {
                 throw new InvalidArgumentException(
                     "$class::\$shouldBeUnique is set to `true` but `uniqueCache` configuration is missing."
                 );
             }
 
             $uniqueId = static::getUniqueId($class, $method, $data);
 
-            if (Cache::read($uniqueId, 'Cake/Queue.queueUnique')) {
+            if (Cache::read($uniqueId, $config['uniqueCacheKey'])) {
                 if ($logger) {
                     $logger->debug(
                         "An identical instance of $class already exists on the queue. This push will be ignored."
@@ -279,7 +281,7 @@ public static function push($className, array $data = [], array $options = []):
         if (!empty($class::$shouldBeUnique)) {
             $uniqueId = static::getUniqueId($class, $method, $data);
 
-            Cache::add($uniqueId, true, 'Cake/Queue.queueUnique');
+            Cache::add($uniqueId, true, $config['uniqueCacheKey']);
         }
     }
 

tests/TestCase/Consumption/RemoveUniqueJobIdFromCacheExtensionTest.php

@@ -26,9 +26,10 @@ public static function dropConfigs()
 
         QueueManager::drop('default');
 
-        if (Cache::getConfig('Cake/Queue.queueUnique')) {
-            Cache::clear('Cake/Queue.queueUnique');
-            Cache::drop('Cake/Queue.queueUnique');
+        $cacheKey = QueueManager::getConfig('default')['uniqueCacheKey'] ?? null;
+        if ($cacheKey) {
+            Cache::clear($cacheKey);
+            Cache::drop($cacheKey);
         }
     }
 
@@ -39,14 +40,14 @@ public function testJobIsRemovedFromCacheAfterProcessing()
         QueueManager::push(UniqueJob::class, []);
 
         $uniqueId = QueueManager::getUniqueId(UniqueJob::class, 'execute', []);
-        $this->assertTrue(Cache::read($uniqueId, 'Cake/Queue.queueUnique'));
+        $this->assertTrue(Cache::read($uniqueId, 'Cake/Queue.queueUnique.default'));
 
         $consume();
 
-        $this->assertNull(Cache::read($uniqueId, 'Cake/Queue.queueUnique'));
+        $this->assertNull(Cache::read($uniqueId, 'Cake/Queue.queueUnique.default'));
     }
 
-    protected function setupQueue($extensionArgs = [])
+    protected function setupQueue()
     {
         Log::setConfig('debug', [
             'className' => 'Array',
@@ -68,7 +69,7 @@ protected function setupQueue($extensionArgs = [])
 
         $extension = new ChainExtension([
             new LimitConsumedMessagesExtension(1),
-            new RemoveUniqueJobIdFromCacheExtension('Cake/Queue.queueUnique'),
+            new RemoveUniqueJobIdFromCacheExtension('Cake/Queue.queueUnique.default'),
         ]);
 
         return function () use ($client, $extension) {

tests/TestCase/QueueManagerTest.php

@@ -44,29 +44,56 @@ public function tearDown(): void
     {
         parent::tearDown();
 
+        $cacheKey = QueueManager::getConfig('test')['uniqueCacheKey'] ?? null;
+        if ($cacheKey) {
+            Cache::clear($cacheKey);
+            Cache::drop($cacheKey);
+        }
+
         QueueManager::drop('test');
         Log::drop('test');
 
         // delete file based queues
         array_map('unlink', glob($this->fsQueuePath . DS . '*'));
-
-        if (Cache::getConfig('Cake/Queue.queueUnique')) {
-            Cache::clear('Cake/Queue.queueUnique');
-            Cache::drop('Cake/Queue.queueUnique');
-        }
     }
 
     public function testSetConfig()
     {
-        $result = QueueManager::setConfig('test', [
+        QueueManager::setConfig('test', [
             'url' => 'null:',
         ]);
-        $this->assertNull($result);
 
         $config = QueueManager::getConfig('test');
         $this->assertSame('null:', $config['url']);
     }
 
+    public function testSetMultipleConfigs()
+    {
+        QueueManager::setConfig('test', [
+            'url' => 'null:',
+            'uniqueCache' => [
+                'engine' => 'File',
+            ],
+            'logger' => 'debug',
+        ]);
+
+        QueueManager::setConfig('other', [
+            'url' => 'null:',
+            'uniqueCache' => [
+                'engine' => 'File',
+            ],
+            'logger' => 'debug',
+        ]);
+
+        $testConfig = QueueManager::getConfig('test');
+        $this->assertSame('null:', $testConfig['url']);
+
+        $otherConfig = QueueManager::getConfig('other');
+        $this->assertSame('null:', $otherConfig['url']);
+
+        QueueManager::drop('other');
+    }
+
     public function testSetConfigInvalidValue()
     {
         $this->expectException(LogicException::class);