feat(logging): optional log supression flag

Author: calumbrodie

Publisher/JobPublisher.php

@@ -59,7 +59,7 @@ public function setContainer(ContainerInterface $container = null)
      * @throws MissingTopicException
      * @throws UndefinedProducerException
      */
-    public function publish(Job $job)
+    public function publish(Job $job, $supressLogging = false)
     {
         $job->validate();
 
@@ -82,14 +82,16 @@ public function publish(Job $job)
 
             // log the job as existing
             if ($job instanceof ConsoleCommandJob) {
-                $uuid = Uuid::uuid4()->toString();
-                $log = new JobLog(trim(sprintf('%s %s', $job->getCommand(), implode(' ', $job->getArguments()))), $uuid, $job->getTopic());
+                if (!$supressLogging) {
+                    $uuid = Uuid::uuid4()->toString();
+                    $log = new JobLog(trim(sprintf('%s %s', $job->getCommand(), implode(' ', $job->getArguments()))), $uuid, $job->getTopic());
 
-                $this->jobLogRepository->add($log);
+                    $this->jobLogRepository->add($log);
 
-                // adds the uuid to the published job
-                // which allows the consumer to specify the Uuid when running the command
-                $message['uuid'] = $uuid;
+                    // adds the uuid to the published job
+                    // which allows the consumer to specify the Uuid when running the command
+                    $message['uuid'] = $uuid;
+                }
             }
 
             $producer->publish(json_encode($message));

Service/JobManager.php

@@ -20,27 +20,19 @@ class JobManager
     /**
      * @var ScheduledJobService
      */
-    private $scheduledJob;
+    private $scheduledJobService;
 
     public function __construct(
         JobPublisher $publisher,
         ScheduledJobService $scheduledJobService
     ) {
         $this->publisher = $publisher;
-        $this->scheduledJob = $scheduledJobService;
+        $this->scheduledJobService = $scheduledJobService;
     }
 
-    /**
-     * Adds a job to the resque queue
-     * @param Job $job
-     */
-    public function addJob(Job $job, $dateTime = null)
+    public function addJob(Job $job, $supressLogging = false)
     {
-        if ($dateTime === null) {
-            $this->publisher->publish($job);
-        } elseif ($job instanceof ConsoleCommandJob) {
-            $this->scheduledJob->addScheduledJob($job, $dateTime);
-        }
+        $this->publisher->publish($job, $supressLogging);
     }
 
     /**
@@ -51,8 +43,9 @@ public function addJob(Job $job, $dateTime = null)
      * @param string $topic The name of a valid topic.
      * @param integer $timeout The amount of time to allow the command to run.
      * @param integer $idleTimeout The amount of idle time to allow the command to run. Defaults to the same as timeout.
+     * @param bool $supressLogging Stops the job from being logged by the database
      */
-    public function addConsoleCommandJob(string $command, array $arguments = [], $topic = 'default', $timeout = 60, $idleTimeout = null)
+    public function addConsoleCommandJob(string $command, array $arguments = [], $topic = 'default', $timeout = 60, $idleTimeout = null, $supressLogging = false)
     {
         if (stripos($command, " ") !== false) {
             throw new \InvalidArgumentException('Console command is not expected to have spaces within the name');
@@ -64,7 +57,8 @@ public function addConsoleCommandJob(string $command, array $arguments = [], $to
         $args['timeout'] = $timeout;
         $args['idleTimeout'] = $idleTimeout ?? $timeout;
         $job = new ConsoleCommandJob($args, $topic);
-        $this->addJob($job);
+
+        $this->addJob($job, $supressLogging);
     }
 
     /**
@@ -95,6 +89,7 @@ public function addScheduledConsoleCommandJob(
         $args['timeout'] = $timeout;
         $args['idleTimeout'] = $idleTimeout ?? $timeout;
         $job = new ConsoleCommandJob($args, $topic);
-        $this->addJob($job, $dateTime);
+
+        $this->scheduledJobService->addScheduledJob($job, $dateTime);
     }
 }

Tests/Service/JobManagerTest.php

@@ -51,10 +51,10 @@ public function testCanAddJobWithoutDateTime(): void
 
     public function testCanAddConsoleCommandJobWithDateTime(): void
     {
-        $job = new ConsoleCommandJob();
+        $job = 'muh:console:jerb';
         $scheduledTime = new \DateTime();
-        $this->jobManager->addJob($job, $scheduledTime);
-        $this->assertSame([$job], $this->scheduledJobService->getJobs());
+        $this->jobManager->addScheduledConsoleCommandJob($job, $scheduledTime);
+        $this->assertCount(1, $this->scheduledJobService->getJobs());
     }
 
     public function testCanAddCommandJob(): void
@@ -83,7 +83,7 @@ public function __construct()
                 $this->initializeJobs();
             }
 
-            public function publish(Job $job)
+            public function publish(Job $job, $supressLogging = false)
             {
                 $this->addJob($job);
             }