fix: refactor job status

Author: danieloraca

Command/AddRecurringConsoleJobToQueueCommand.php

@@ -2,7 +2,7 @@
 
 namespace Markup\JobQueueBundle\Command;
 
-use Markup\JobQueueBundle\Factory\JobStatusFactory;
+use Markup\JobQueueBundle\Repository\JobStatusRepository;
 use Markup\JobQueueBundle\Model\RecurringConsoleCommandConfiguration;
 use Markup\JobQueueBundle\Repository\CronHealthRepository;
 use Markup\JobQueueBundle\Repository\JobLogRepository;
@@ -48,22 +48,22 @@ class AddRecurringConsoleJobToQueueCommand extends Command
      */
     private $environment;
 
-    /** @var JobStatusFactory */
-    private $jobStatusFactory;
+    /** @var JobStatusRepository */
+    private $jobStatusRepository;
 
     public function __construct(
         RecurringConsoleCommandReader $recurringConsoleCommandReader,
         JobManager $jobManager,
         CronHealthRepository $cronHealthRepository,
         JobLogRepository $jobLogRepository,
-        JobStatusFactory $jobStatusFactory,
+        JobStatusRepository $jobStatusRepository,
         string $environment
     ) {
         $this->recurringConsoleCommandReader = $recurringConsoleCommandReader;
         $this->jobManager = $jobManager;
         $this->cronHealthRepository = $cronHealthRepository;
         $this->jobLogRepository = $jobLogRepository;
-        $this->jobStatusFactory = $jobStatusFactory;
+        $this->jobStatusRepository = $jobStatusRepository;
         $this->environment = $environment;
 
         parent::__construct(null);
@@ -133,8 +133,12 @@ private function addRecurringJobs(OutputInterface $output)
                 }
             }
 
-            if ($configuration->getUserManaged() && !$this->jobStatusFactory->isUserEnabledJob($configuration->getCommand(), $configuration->getArguments())) {
-                continue;
+            if ($configuration->isUserManaged()) {
+                $arguments = $configuration->getArguments() ? json_encode($configuration->getArguments()) : null;
+
+                if (!$this->jobStatusRepository->isStatusEnabled($command, $arguments)) {
+                    continue;
+                }
             }
 
             $this->jobManager->addConsoleCommandJob(

Factory/JobStatusFactory.php

@@ -45,7 +45,7 @@ class RecurringConsoleCommandConfiguration
      */
     private $arguments;
 
-    /** @var bool */
+    /** @var ?bool */
     private $userManaged;
 
     /** @var ?bool */
@@ -59,7 +59,7 @@ class RecurringConsoleCommandConfiguration
      * @param string|null $description
      * @param integer|null $timeout
      * @param array|null $envs
-     * @param bool $userManaged
+     * @param ?bool $userManaged
      * @param ?bool $jobStatusEnabled
      */
     public function __construct(
@@ -70,7 +70,7 @@ public function __construct(
         $description = null,
         $timeout = 60,
         $envs = null,
-        $userManaged = false,
+        $userManaged = null,
         $jobStatusEnabled = null
     ) {
         $this->command = $command;
@@ -110,7 +110,7 @@ public function getArguments(): array
         return $this->arguments;
     }
 
-    public function getUserManaged(): ?bool
+    public function isUserManaged(): ?bool
     {
         return $this->userManaged;
     }

Model/RecurringConsoleCommandConfiguration.php

@@ -20,19 +20,18 @@ public function __construct(ManagerRegistry $doctrine)
         $this->doctrine = $doctrine;
     }
 
-    public function isUserEnabled(string $command, array $arguments): bool
+    public function isStatusEnabled(string $command, ?string $arguments): bool
     {
-        /** @var JobStatus $jobStatus */
-        $jobStatus = $this->getEntityRepository()->findOneBy([
+        $jobStatus = $this->findBy([
             'command' => $command,
-            'arguments' => ($arguments) ? json_encode($arguments) : null
+            'arguments' => $arguments ?? '[]'
         ]);
 
-        if ($jobStatus instanceof JobStatus) {
-            return $jobStatus->getEnabled();
+        if (!$jobStatus) {
+            return true;
         }
 
-        return true;
+        return $jobStatus->getEnabled();
     }
 
     public function findBy(array $arguments): ?JobStatus
@@ -46,7 +45,17 @@ public function findBy(array $arguments): ?JobStatus
         return null;
     }
 
-    public function store(JobStatus $jobStatus): void
+    public function fetchOrCreateJobStatus(string $command, string $arguments): JobStatus
+    {
+        $jobStatus = $this->findBy([
+            'command' => $command,
+            'arguments' => ($arguments) ?? null
+        ]);
+
+        return $jobStatus ?? new JobStatus(null, $command, $arguments, true);
+    }
+
+    public function save(JobStatus $jobStatus): void
     {
         $this->getEntityManager()->persist($jobStatus);
         $this->getEntityManager()->flush($jobStatus);

Repository/JobStatusRepository.php

@@ -13,7 +13,7 @@ services:
             $jobManager: '@jobby'
             $cronHealthRepository: '@markup_job_queue.repository.cron_health'
             $jobLogRepository: '@markup_job_queue.repository.job_log'
-            $jobStatusFactory: '@Markup\JobQueueBundle\Factory\JobStatusFactory'
+            $jobStatusRepository: '@Markup\JobQueueBundle\Repository\JobStatusRepository'
             $environment: '%kernel.environment%'
         tags:
             - { name: console.command, command: 'markup:job_queue:recurring:add' }

Resources/config/commands.yml

@@ -10,8 +10,6 @@ Markup\JobQueueBundle\Entity\JobStatus:
   indexes:
     id:
       columns: [ id ]
-    enabled:
-      columns: [ enabled ]
   fields:
     command:
       type: string

Resources/config/doctrine/JobStatus.orm.yml

@@ -23,7 +23,7 @@ services:
         class: Markup\JobQueueBundle\Service\RecurringConsoleCommandReader
         arguments:
             - '%kernel.root_dir%'
-            - '@Markup\JobQueueBundle\Factory\JobStatusFactory'
+            - '@Markup\JobQueueBundle\Repository\JobStatusRepository'
     markup_job_queue.writer.supervisord_config_file:
         class: Markup\JobQueueBundle\Service\SupervisordConfigFileWriter
         arguments:
@@ -57,9 +57,7 @@ services:
 
     Markup\JobQueueBundle\Repository\JobStatusRepository:
         autowire: true
-
-    Markup\JobQueueBundle\Factory\JobStatusFactory:
-        autowire: true
+        public: false
 
     markup_job_queue.repository.job_log:
         class: Markup\JobQueueBundle\Repository\JobLogRepository

Resources/config/services.yml

@@ -6,7 +6,7 @@
 use Markup\JobQueueBundle\Exception\InvalidConfigurationException;
 use Markup\JobQueueBundle\Exception\MissingScheduleException;
 use Markup\JobQueueBundle\Exception\MissingConfigurationException;
-use Markup\JobQueueBundle\Factory\JobStatusFactory;
+use Markup\JobQueueBundle\Repository\JobStatusRepository;
 use Markup\JobQueueBundle\Model\RecurringConsoleCommandConfiguration;
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\Finder\SplFileInfo;
@@ -38,15 +38,15 @@ class RecurringConsoleCommandReader
      * @param string $kernelPath
      */
 
-    /** @var JobStatusFactory */
-    private $jobStatusFactory;
+    /** @var JobStatusRepository */
+    private $jobStatusRepository;
 
     public function __construct(
         string $kernelPath,
-        JobStatusFactory $jobStatusFactory
+        JobStatusRepository $jobStatusRepository
     ) {
         $this->kernelPath = $kernelPath;
-        $this->jobStatusFactory = $jobStatusFactory;
+        $this->jobStatusRepository = $jobStatusRepository;
     }
 
     public function setConfigurationFileName($name)
@@ -149,7 +149,7 @@ private function parseConfiguration(array $config)
                 isset($group['timeout']) ? $group['timeout'] : null,
                 isset($group['envs']) ? $group['envs'] : null,
                 isset($group['user_managed']) ? $group['user_managed'] : null,
-                isset($group['user_managed']) ? $this->jobStatusFactory->isStatusEnabled($group['command'], isset($group['arguments']) ? json_encode($group['arguments']) : null) : null
+                isset($group['user_managed']) ? $this->jobStatusEnabled($group) : null
             );
 
             $configurations->add($recurringConsoleCommandConfiguration);
@@ -158,6 +158,13 @@ private function parseConfiguration(array $config)
         return $configurations;
     }
 
+    private function jobStatusEnabled(array $group): bool
+    {
+        $arguments = isset($group['arguments']) ? json_encode($group['arguments']) : null;
+
+        return $this->jobStatusRepository->isStatusEnabled($group['command'], $arguments);
+    }
+
     /**
      * Reads the configuration file using the yml component and returns an array
      * @return array