ISSUE-244 cron-job package

.github/workflows/after_splitting_test.yaml

@@ -18,6 +18,7 @@ jobs:
           - aws-tool-kit
           - console
           - core
+          - cron-job
           - doctrine-extra
           - entity-migrator
           - fixer

composer.json

@@ -126,6 +126,7 @@
         "draw/console": "self.version",
         "draw/contracts": "self.version",
         "draw/core": "self.version",
+        "draw/cron-job": "self.version",
         "draw/doctrine-extra": "self.version",
         "draw/entity-migrator": "self.version",
         "draw/fixer": "self.version",
@@ -172,6 +173,7 @@
             "Draw\\Component\\AwsToolKit\\": "packages/aws-tool-kit/",
             "Draw\\Component\\Console\\": "packages/console/",
             "Draw\\Component\\Core\\": "packages/core/",
+            "Draw\\Component\\CronJob\\": "packages/cron-job/",
             "Draw\\Component\\EntityMigrator\\": "packages/entity-migrator/",
             "Draw\\Component\\Log\\": "packages/log/",
             "Draw\\Component\\Mailer\\": "packages/mailer/",

packages/cron-job/.gitignore

@@ -0,0 +1,8 @@
+/vendor/
+/.idea/
+composer.lock
+
+###> phpunit/phpunit ###
+/phpunit.xml
+.phpunit.result.cache
+###< phpunit/phpunit ###

packages/cron-job/Command/QueueCronJobByNameCommand.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Draw\Component\CronJob\Command;
+
+use Draw\Component\CronJob\CronJobProcessor;
+use Draw\Component\CronJob\Entity\CronJob;
+use Symfony\Bridge\Doctrine\ManagerRegistry;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+#[AsCommand(name: 'draw:cron-job:queue-by-name')]
+class QueueCronJobByNameCommand extends Command
+{
+    public function __construct(
+        private ManagerRegistry $managerRegistry,
+        private CronJobProcessor $cronJobProcessor,
+    ) {
+        parent::__construct();
+    }
+
+    protected function configure(): void
+    {
+        $this
+            ->setDescription('Queues cron job by name')
+            ->addArgument('name', InputArgument::REQUIRED, 'Cron job name');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $io = new SymfonyStyle($input, $output);
+
+        $cronJob = $this->managerRegistry
+            ->getRepository(CronJob::class)
+            ->findOneBy(['name' => $input->getArgument('name')]);
+
+        if (null === $cronJob) {
+            $io->error('Cron job could not be found.');
+
+            return Command::FAILURE;
+        }
+
+        $io->section('Queueing cron job...');
+
+        $this->cronJobProcessor->queue($cronJob, true);
+
+        $io->section('Cron job successfully queued.');
+
+        return Command::SUCCESS;
+    }
+}

packages/cron-job/Command/QueueDueCronJobsCommand.php

@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Draw\Component\CronJob\Command;
+
+use Doctrine\Persistence\ManagerRegistry;
+use Draw\Component\CronJob\CronJobProcessor;
+use Draw\Component\CronJob\Entity\CronJob;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\ProgressBar;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+#[AsCommand(name: 'draw:cron-job:queue-due')]
+class QueueDueCronJobsCommand extends Command
+{
+    public function __construct(
+        private ManagerRegistry $managerRegistry,
+        private CronJobProcessor $cronJobProcessor,
+    ) {
+        parent::__construct();
+    }
+
+    protected function configure(): void
+    {
+        $this
+            ->setDescription('Queues due cron jobs');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $io = new SymfonyStyle($input, $output);
+        $io->section('Queueing cron jobs...');
+
+        $cronJobs = array_map(
+            static fn(CronJob $cronJob): bool => $cronJob->isDue(),
+            $this->managerRegistry
+                ->getRepository(CronJob::class)
+                ->findAll()
+        );
+
+        $progress = $io->createProgressBar(\count($cronJobs));
+        $progress->setFormat(ProgressBar::FORMAT_DEBUG);
+
+        foreach ($cronJobs as $cronJob) {
+            $this->cronJobProcessor->queue($cronJob);
+
+            $progress->advance();
+        }
+
+        $progress->finish();
+
+        $io->newLine(2);
+        $io->success('Cron jobs successfully queued...');
+
+        return Command::SUCCESS;
+    }
+}

packages/cron-job/CronJobExecutionFactory.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Draw\Component\CronJob;
+
+use Draw\Component\CronJob\Entity\CronJob;
+use Draw\Component\CronJob\Entity\CronJobExecution;
+
+class CronJobExecutionFactory
+{
+    public function create(CronJob $cronJob, bool $force = false): CronJobExecution
+    {
+        return (new CronJobExecution())
+            ->setCronJob($cronJob)
+            ->setRequestedAt(new \DateTimeImmutable())
+            ->setForce($force);
+    }
+}

packages/cron-job/CronJobProcessor.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Draw\Component\CronJob;
+
+use Doctrine\Persistence\ManagerRegistry;
+use Draw\Component\CronJob\Entity\CronJob;
+use Draw\Component\CronJob\Entity\CronJobExecution;
+use Draw\Component\CronJob\Message\ExecuteCronJobMessage;
+use Symfony\Component\Messenger\MessageBusInterface;
+use Symfony\Component\Process\Process;
+
+class CronJobProcessor
+{
+    public function __construct(
+        private CronJobExecutionFactory $cronJobExecutionFactory,
+        private ManagerRegistry $managerRegistry,
+        private MessageBusInterface $messageBus,
+    ) {
+    }
+
+    public function queue(CronJob $cronJob, bool $force = false): void
+    {
+        $manager = $this->managerRegistry->getManagerForClass(CronJobExecution::class);
+
+        $manager->persist($execution = $this->cronJobExecutionFactory->create($cronJob, $force));
+        $manager->flush();
+
+        $this->messageBus->dispatch(new ExecuteCronJobMessage($execution));
+    }
+
+    public function process(CronJobExecution $execution): void
+    {
+        $manager = $this->managerRegistry->getManagerForClass(CronJobExecution::class);
+
+        $execution->start();
+        $manager->flush();
+
+        $command = $execution->getCronJob()->getCommand();
+
+        $process = Process::fromShellCommandline($command)
+            ->setTimeout(1800);
+
+        try {
+            $process->run();
+
+            $execution->end($process->getExitCode());
+        } catch (\Throwable $error) {
+            $execution->fail($process->getExitCode(), ['TODO']);
+        } finally {
+            $manager->flush();
+        }
+    }
+}