Merge pull request #2 from CakeDC/feature/disable-option

added support for disabling queue monitor commands

Author: arusinowski

src/Command/NotifyCommand.php

@@ -18,6 +18,7 @@
 use Cake\Console\ConsoleOptionParser;
 use Cake\Core\Configure;
 use Cake\Log\LogTrait;
+use CakeDC\QueueMonitor\Core\DisableTrait;
 use CakeDC\QueueMonitor\Service\QueueMonitoringService;
 use Exception;
 
@@ -26,6 +27,7 @@
  */
 final class NotifyCommand extends Command
 {
+    use DisableTrait;
     use LogTrait;
 
     private const DEFAULT_LONG_JOB_IN_MINUTES = 30;
@@ -61,6 +63,12 @@ public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionPar
      */
     public function execute(Arguments $args, ConsoleIo $io)
     {
+        if ($this->isDisabled()) {
+            $this->log('Notification were not sent because Queue Monitor is disabled.');
+
+            return self::CODE_SUCCESS;
+        }
+
         try {
             $this->queueMonitoringService->notifyAboutLongRunningJobs(
                 (int)Configure::read(

src/Command/PurgeCommand.php

@@ -18,6 +18,7 @@
 use Cake\Console\ConsoleOptionParser;
 use Cake\Core\Configure;
 use Cake\Log\LogTrait;
+use CakeDC\QueueMonitor\Core\DisableTrait;
 use CakeDC\QueueMonitor\Service\QueueMonitoringService;
 use Exception;
 use Psr\Log\LogLevel;
@@ -27,6 +28,7 @@
  */
 final class PurgeCommand extends Command
 {
+    use DisableTrait;
     use LogTrait;
 
     private const DEFAULT_PURGE_DAYS_OLD = 30;
@@ -62,6 +64,12 @@ public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionPar
      */
     public function execute(Arguments $args, ConsoleIo $io)
     {
+        if ($this->isDisabled()) {
+            $this->log('Logs were not purged because Queue Monitor is disabled.');
+
+            return self::CODE_SUCCESS;
+        }
+
         $purgeToDate = $this->queueMonitoringService->getPurgeToDate(
             (int)Configure::read(
                 'QueueMonitor.purgeLogsOlderThanDays',

src/Core/DisableTrait.php

@@ -0,0 +1,20 @@
+<?php
+declare(strict_types=1);
+
+namespace CakeDC\QueueMonitor\Core;
+
+use Cake\Core\Configure;
+
+/**
+ * Disable trait
+ */
+trait DisableTrait
+{
+    /**
+     * Check if queue monitoring is disabled by configuration
+     */
+    protected function isDisabled(): bool
+    {
+        return (bool)Configure::read('QueueMonitor.disabled', false);
+    }
+}

src/Listener/QueueMonitorListener.php

@@ -12,7 +12,6 @@
  */
 namespace CakeDC\QueueMonitor\Listener;
 
-use Cake\Core\Configure;
 use Cake\Event\EventInterface;
 use Cake\Event\EventListenerInterface;
 use Cake\I18n\FrozenTime;
@@ -22,6 +21,7 @@
 use Cake\ORM\Table;
 use Cake\Queue\Job\Message;
 use Cake\Utility\Hash;
+use CakeDC\QueueMonitor\Core\DisableTrait;
 use CakeDC\QueueMonitor\Exception\QueueMonitorException;
 use CakeDC\QueueMonitor\Model\Status\MessageEvent;
 use CakeDC\QueueMonitor\Model\Table\LogsTable;
@@ -36,6 +36,7 @@
  */
 final class QueueMonitorListener implements EventListenerInterface
 {
+    use DisableTrait;
     use LocatorAwareTrait;
     use LogTrait;
 
@@ -226,12 +227,4 @@ public function validateInteropQueueMessage(?QueueMessage $queueMessage): QueueM
 
         return $queueMessage;
     }
-
-    /**
-     * Check if queue monitoring is disabled by configuration
-     */
-    private function isDisabled(): bool
-    {
-        return (bool)Configure::read('QueueMonitor.disabled', false);
-    }
 }