Featue/1.0/qa

.editorconfig

@@ -0,0 +1,21 @@
+# This file is for unifying the coding style for different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.markdown]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab

.github/workflows/ci.yaml

@@ -23,5 +23,7 @@ jobs:
         run: composer install --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
       - name: Check Code Styles
         run: vendor/bin/ecs
+      - name: PhpStan
+        run: vendor/bin/phpstan analyze
       - name: Execute tests (Unit and Feature tests) via PHPUnit
         run: vendor/bin/simple-phpunit

Makefile

@@ -25,10 +25,18 @@ help:
 install:
 	composer update
 
+test:
+	make ecs
+	make phpstan
+	make phpunit
+
 ## Fix PHP Styles
 ecs:
 	vendor/bin/ecs --fix
 
+phpstan:
+	vendor/bin/phpstan
+
 ## PHP Unit
 phpunit:
 	vendor/bin/simple-phpunit

composer.json

@@ -30,6 +30,7 @@
         "doctrine/orm": "^2.11",
         "doctrine/annotations": "^1.13.2",
         "nyholm/symfony-bundle-test": "^1.8",
+        "phpstan/phpstan": "^1.8",
         "symfony/phpunit-bridge": "~6.0.0",
         "symfony/http-kernel": "~6.0.0",
         "symfony/config": "~6.0.0",

phpstan.neon

@@ -0,0 +1,8 @@
+parameters:
+    level: 6
+    paths:
+        - src
+        - tests
+    parallel:
+        maximumNumberOfProcesses: 2
+    checkGenericClassInNonGenericObjectType: false

src/Command/CleanupCommand.php

@@ -50,7 +50,6 @@ protected function configure(): void
         $this
             ->addOption('max-retention', null, InputOption::VALUE_REQUIRED, 'The maximum retention time (will be parsed by DateTime).', '1 month')
             ->addOption('max-retention-successful', null, InputOption::VALUE_REQUIRED, 'The maximum retention time for succeeded jobs (will be parsed by DateTime).', '7 days')
-            ->addOption('per-call', null, InputOption::VALUE_REQUIRED, 'The maximum number of jobs to clean-up per call.', 1000)
         ;
     }
 
@@ -59,11 +58,8 @@ protected function configure(): void
      */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        $perCall = (int) $input->getOption('per-call');
-
         $deletedSuccessful = $this->executionRepository->deleteSuccessfulJobs(
-            new \DateTimeImmutable('-' . $input->getOption('max-retention-successful')),
-            $perCall
+            new \DateTimeImmutable('-' . $input->getOption('max-retention-successful'))
         );
 
         $output->writeln(sprintf(
@@ -72,8 +68,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         ));
 
         $deletedNotSuccessful = $this->executionRepository->deleteNotSuccessfulJobs(
-            new \DateTimeImmutable('-' . $input->getOption('max-retention')),
-            $perCall
+            new \DateTimeImmutable('-' . $input->getOption('max-retention'))
         );
 
         $output->writeln(sprintf(

src/Command/ExecuteCommand.php

@@ -36,21 +36,15 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
-use Symfony\Component\Process\Process;
-use whatwedo\CronBundle\CronJob\CronInterface;
-use whatwedo\CronBundle\CronJob\CronJobInterface;
-use whatwedo\CronBundle\Entity\Execution;
-use whatwedo\CronBundle\Event\CronErrorEvent;
-use whatwedo\CronBundle\Event\CronFinishEvent;
-use whatwedo\CronBundle\Event\CronStartEvent;
-use whatwedo\CronBundle\Exception\MaxRuntimeReachedException;
 use whatwedo\CronBundle\Manager\CronJobManager;
+use whatwedo\CronBundle\Manager\ExecutionManager;
 
 #[AsCommand(name: 'whatwedo:cron:execute', description: 'Execute cron job')]
 class ExecuteCommand extends Command
 {
     public function __construct(
         protected CronJobManager $cronJobManager,
+        protected ExecutionManager $executionManager,
         protected EntityManagerInterface $entityManager,
         protected EventDispatcherInterface $eventDispatcher,
         protected string $projectDir,
@@ -59,24 +53,6 @@ public function __construct(
         parent::__construct();
     }
 
-    public function checkMaxRuntime(Execution $execution, CronInterface $cronJob, Process $process): void
-    {
-        if (! $cronJob->getMaxRuntime()) {
-            return;
-        }
-        $now = new \DateTime();
-        $diff = $now->getTimestamp() - $execution->getStartedAt()->getTimestamp();
-        if ($diff > $cronJob->getMaxRuntime()) {
-            $execution
-                ->setState(Execution::STATE_TERMINATED)
-                ->setPid(null)
-                ->setStdout($process->getOutput())
-                ->setStderr($process->getErrorOutput());
-            $this->entityManager->flush($execution);
-            throw new MaxRuntimeReachedException($execution);
-        }
-    }
-
     protected function configure(): void
     {
         $this
@@ -88,79 +64,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         // Get job definition
         $cronJob = $this->cronJobManager->getCronJob($input->getArgument('cron_job'));
 
-        // Build command to execute
-        $command = array_merge(['bin/console', $this->getCronCommand($cronJob), '--env=' . $this->environment], $this->getCronArguments($cronJob));
-
-        // Create execution
-        $execution = new Execution();
-        $execution->setJob($cronJob::class)
-            ->setCommand($command);
-        $this->entityManager->persist($execution);
-        $this->entityManager->flush($execution);
-
-        // Run command
-        $process = new Process($command, $this->projectDir);
-        $process->start();
-        $execution->setPid($process->getPid());
-        $this->entityManager->flush($execution);
-        $this->eventDispatcher->dispatch(new CronStartEvent($cronJob), CronStartEvent::NAME);
-
-        // Update command output every 5 seconds
-        while ($process->isRunning()) {
-            $this->checkMaxRuntime($execution, $cronJob, $process);
-            $output->writeln(sprintf('Process %s is running...', $process->getCommandLine()));
-            sleep(5);
-            $execution->setStdout($process->getOutput())
-                ->setStderr($process->getErrorOutput());
-            $this->entityManager->flush($execution);
-        }
-
-        if (! $process->isSuccessful()) {
-            $this->eventDispatcher->dispatch(new CronErrorEvent($cronJob, $process->getErrorOutput()), CronErrorEvent::NAME);
-        }
-
-        // Finish execution
-        $output->writeln('Execution finished with exit code ' . $process->getExitCode());
-        $execution
-            ->setState(Execution::STATE_FINISHED)
-            ->setFinishedAt(new \DateTime())
-            ->setPid(null)
-            ->setStdout($process->getOutput())
-            ->setStderr($process->getErrorOutput())
-            ->setExitCode($process->getExitCode());
-
-        if ($execution->getExitCode() !== 0) {
-            $execution->setState(Execution::STATE_ERROR);
-        }
-
-        $this->entityManager->flush($execution);
-        $this->eventDispatcher->dispatch(new CronFinishEvent($cronJob), CronFinishEvent::NAME);
+        $this->executionManager->execute($cronJob, $output);
 
         return Command::SUCCESS;
     }
-
-    protected function getCronCommand(CronInterface $cron): string
-    {
-        if ($cron instanceof CronJobInterface) {
-            return $cron->getCommand();
-        }
-
-        if ($cron instanceof Command) {
-            return $cron->getDefaultName();
-        }
-
-        return '';
-    }
-
-    /**
-     * @return string[]
-     */
-    protected function getCronArguments(CronInterface $cron): array
-    {
-        if ($cron instanceof CronJobInterface) {
-            return $cron->getArguments();
-        }
-
-        return [];
-    }
 }

src/Command/InfoCommand.php

@@ -139,7 +139,7 @@ protected function getNextExecutionDateString(CronInterface $cronJob): ?string
         return $this->getFormattedDate($nextExecutionDate);
     }
 
-    protected function getFormattedDate(\DateTime $date): ?string
+    protected function getFormattedDate(?\DateTime $date): ?string
     {
         if (! $date) {
             return null;

src/Controller/CronJobController.php

@@ -10,6 +10,7 @@
 use whatwedo\CronBundle\Entity\Execution;
 use whatwedo\CronBundle\Manager\CronJobManager;
 use whatwedo\CronBundle\Manager\ExecutionManager;
+use whatwedo\CronBundle\Model\CronJobActivable;
 use whatwedo\CronBundle\Repository\ExecutionRepository;
 
 class CronJobController extends AbstractController
@@ -139,10 +140,6 @@ public function clean(string $class, string $state): Response
     {
         $cronJob = $this->cronJobManager->getCronJob($class);
 
-        if (! $cronJob) {
-            throw new \Exception('Job not found');
-        }
-
         $this->executionRepository->deleteExecutions($cronJob, $state);
 
         $this->addFlash('success', 'cronjob.cleaned');

src/CronJob/CronJobActivable.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace whatwedo\CronBundle\Model;
+
+class CronJobActivable
+{
+}

src/DependencyInjection/whatwedoCronExtension.php

@@ -38,7 +38,10 @@
 
 class whatwedoCronExtension extends Extension
 {
-    public function load(array $configs, ContainerBuilder $container)
+    /**
+     * @param string[] $configs
+     */
+    public function load(array $configs, ContainerBuilder $container): void
     {
         // Auto tag cron jobs
         $container->registerForAutoconfiguration(CronInterface::class)->addTag('whatwedo.cron.job');

src/Entity/Execution.php

@@ -70,6 +70,7 @@ class Execution
     protected string $job;
 
     /**
+     * @var string[]
      * @ORM\Column(type="json", nullable=false)
      */
     protected ?array $command = [];
@@ -265,6 +266,6 @@ public function setCronJob(?CronInterface $cronJob): self
 
     public function __toString(): string
     {
-        return '#' . str_pad($this->getId(), 6, '0', STR_PAD_LEFT);
+        return '#' . str_pad((string) $this->getId(), 6, '0', STR_PAD_LEFT);
     }
 }

src/Manager/CronJobManager.php

@@ -32,7 +32,7 @@
 use Symfony\Bundle\FrameworkBundle\Console\Application;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\HttpKernel\KernelInterface;
-use whatwedo\CronBundle\CronJob\CronInterface;
+use whatwedo\CronBundle\CronJob\CronJobInterface;
 use whatwedo\CronBundle\Exception\CronJobNotFoundException;
 
 class CronJobManager
@@ -43,7 +43,7 @@ class CronJobManager
     protected $consoleApplication;
 
     /**
-     * @var CronInterface[]
+     * @var CronJobInterface[]
      */
     protected $cronJobs = [];
 
@@ -52,22 +52,22 @@ public function __construct(KernelInterface $kernel)
         $this->consoleApplication = new Application($kernel);
     }
 
-    public function addCronJob(CronInterface $cronJob): self
+    public function addCronJob(CronJobInterface $cronJob): self
     {
         $this->cronJobs[$cronJob::class] = $cronJob;
 
         return $this;
     }
 
     /**
-     * @return CronInterface[]
+     * @return CronJobInterface[]
      */
     public function getCronJobs(): array
     {
         return $this->cronJobs;
     }
 
-    public function getCronJob(string $class): CronInterface
+    public function getCronJob(string $class): CronJobInterface
     {
         foreach ($this->cronJobs as $cronJob) {
             if ($cronJob instanceof $class) {
@@ -77,7 +77,7 @@ public function getCronJob(string $class): CronInterface
         throw new CronJobNotFoundException($class);
     }
 
-    public function getCommandByCronJob(CronInterface $cronJob): Command
+    public function getCommandByCronJob(CronJobInterface $cronJob): Command
     {
         return $this->consoleApplication->find($cronJob->getCommand());
     }