Added backup custom periodicity support (#73)

* Added backup custom periodicity support

* Updated migration file

* Update migrations/Version20220801120509.php

Co-authored-by: jmsche <[email protected]>

* Updated BackupTask.php asserts

* Fixed review

* Updated migration

* Updated migration

Co-authored-by: jmsche <[email protected]>

Author: bastien70

.gitignore

@@ -15,11 +15,6 @@
 /phpunit.xml
 ###< symfony/phpunit-bridge ###
 
-###> phpunit/phpunit ###
-/phpunit.xml
-.phpunit.result.cache
-###< phpunit/phpunit ###
-
 ###> friendsofphp/php-cs-fixer ###
 /.php-cs-fixer.php
 /.php-cs-fixer.cache

migrations/Version20220801120509.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoctrineMigrations;
+
+use App\Entity\Enum\BackupTaskPeriodicity;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20220801120509 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'Added backup custom periodicity support';
+    }
+
+    public function up(Schema $schema): void
+    {
+        $this->addSql('ALTER TABLE `database` ADD backup_task_periodicity VARCHAR(255) NOT NULL, ADD backup_task_periodicity_number INT NOT NULL, ADD backup_task_start_from DATETIME NOT NULL, ADD backup_task_next_iteration DATETIME NOT NULL');
+        $this->addSql('UPDATE `database` SET backup_task_periodicity = :periodicity, backup_task_periodicity_number = :periodicity_number, backup_task_start_from = :start_from, backup_task_next_iteration = :next_iteration;', [
+            'periodicity_number' => 1,
+            'periodicity' => BackupTaskPeriodicity::WEEK->value,
+            'start_from' => (new \DateTime())->format('Y-m-d'),
+            'next_iteration' => (new \DateTime('+1 week'))->format('Y-m-d'),
+        ]);
+    }
+
+    public function down(Schema $schema): void
+    {
+        $this->addSql('ALTER TABLE `database` DROP backup_task_periodicity, DROP backup_task_periodicity_number, DROP backup_task_start_from, DROP backup_task_next_iteration');
+    }
+
+    public function isTransactional(): bool
+    {
+        return false;
+    }
+}

src/Command/BackupCommand.php

@@ -32,7 +32,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
 
-        $databases = $this->backupService->getDatabases();
+        $databases = $this->databaseRepository->getDatabasesToBackup();
         $databasesCount = \count($databases);
 
         if ($databasesCount > 0) {
@@ -44,6 +44,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $backupStatus = $this->backupService->backup($database, Backup::CONTEXT_AUTOMATIC);
                 if (BackupStatus::STATUS_OK === $backupStatus->getStatus()) {
                     $database->setStatus(Database::STATUS_OK);
+                    $backupTask = $database->getBackupTask();
+                    $backupTask->setNextIteration($backupTask->calculateNextIteration());
                 } else {
                     $database->setStatus(Database::STATUS_ERROR);
                     $errors[] = [

src/Controller/Admin/DatabaseCrudController.php

@@ -8,11 +8,14 @@
 use App\Entity\AdapterConfig;
 use App\Entity\Backup;
 use App\Entity\Database;
+use App\Entity\Embed\BackupTask;
+use App\Entity\Enum\BackupTaskPeriodicity;
 use App\Entity\User;
 use App\Helper\DatabaseHelper;
 use App\Security\Voter\DatabaseVoter;
 use App\Service\BackupService;
 use App\Service\BackupStatus;
+use DateTime;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\QueryBuilder;
 use EasyCorp\Bundle\EasyAdminBundle\Collection\FieldCollection;
@@ -27,7 +30,9 @@
 use EasyCorp\Bundle\EasyAdminBundle\Dto\SearchDto;
 use EasyCorp\Bundle\EasyAdminBundle\Field\AssociationField;
 use EasyCorp\Bundle\EasyAdminBundle\Field\ChoiceField;
-use EasyCorp\Bundle\EasyAdminBundle\Field\DateTimeField;
+use EasyCorp\Bundle\EasyAdminBundle\Field\DateField;
+use EasyCorp\Bundle\EasyAdminBundle\Field\FormField;
+use EasyCorp\Bundle\EasyAdminBundle\Field\IntegerField;
 use EasyCorp\Bundle\EasyAdminBundle\Field\NumberField;
 use EasyCorp\Bundle\EasyAdminBundle\Field\TextField;
 use EasyCorp\Bundle\EasyAdminBundle\Filter\ChoiceFilter;
@@ -36,8 +41,10 @@
 use EasyCorp\Bundle\EasyAdminBundle\Filter\TextFilter;
 use EasyCorp\Bundle\EasyAdminBundle\Orm\EntityRepository;
 use EasyCorp\Bundle\EasyAdminBundle\Router\AdminUrlGenerator;
+use function sprintf;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Translation\TranslatableMessage;
+use Symfony\Contracts\Translation\TranslatorInterface;
 
 /**
  * @method User|null getUser()
@@ -49,6 +56,7 @@ public function __construct(
         private readonly AdminUrlGenerator $adminUrlGenerator,
         private readonly DatabaseHelper $databaseHelper,
         private readonly EntityManagerInterface $em,
+        private readonly TranslatorInterface $translator,
     ) {
     }
 
@@ -212,6 +220,7 @@ public function configureCrud(Crud $crud): Crud
 
     public function configureFields(string $pageName): iterable
     {
+        yield FormField::addPanel('database.panel.main_info', 'fas fa-info-circle');
         yield TextField::new('name', 'database.field.name')
             ->hideOnIndex()
             ->setColumns(4);
@@ -244,8 +253,26 @@ public function configureFields(string $pageName): iterable
             })
             ->hideOnForm();
 
-        yield DateTimeField::new('createdAt', 'database.field.created_at')
-            ->setFormat('dd-MM-Y HH:mm')
+        yield BadgeField::new('backupTask', 'database.field.backup_task.periodicity')
+            ->formatValue(function (BackupTask $backupTask) {
+                $plural = $backupTask->getPeriodicityNumber() > 1;
+
+                return sprintf(
+                    '%s %s %s',
+                    $this->translator->trans($backupTask->getDescriptionPrefixTranslation()),
+                    $plural ? $backupTask->getPeriodicityNumber() : null,
+                    $this->translator->trans($backupTask->getDescriptionSuffixTranslation())
+                );
+            })
+            ->hideOnForm();
+        yield BadgeField::new('backupTask.nextIteration', 'database.field.backup_task.next_iteration')
+            ->formatValue(function ($value) {
+                return $value->format($this->translator->trans('global.date_format'));
+            })
+            ->hideOnForm();
+
+        yield DateField::new('createdAt', 'database.field.created_at')
+            ->setFormat($this->translator->trans('global.easy_admin_date_format'))
             ->hideOnForm();
         yield ChoiceField::new('status', 'database.field.status')
             ->setChoices(array_combine(
@@ -258,5 +285,24 @@ public function configureFields(string $pageName): iterable
                 Database::STATUS_UNKNOWN => 'secondary',
             ])
             ->hideOnForm();
+
+        if (Crud::PAGE_INDEX !== $pageName) {
+            yield FormField::addPanel('database.panel.task_configuration', 'fa-solid fa-calendar');
+            yield IntegerField::new('backupTask.periodicityNumber', 'database.field.backup_task.periodicity_number')
+                ->setFormTypeOption('attr', ['min' => 1, 'step' => 1])
+                ->setColumns(4);
+            yield ChoiceField::new('backupTask.periodicity', 'database.field.backup_task.periodicity')
+                ->setChoices(BackupTaskPeriodicity::cases())
+                ->setFormTypeOption('choice_label', function (?BackupTaskPeriodicity $periodicity) {
+                    return $this->translator->trans($periodicity?->formLabel());
+                })
+                ->setFormTypeOption('choice_value', function (?BackupTaskPeriodicity $periodicity) {
+                    return $periodicity?->value;
+                })
+                ->setColumns(4);
+            yield DateField::new('backupTask.startFrom', 'database.field.backup_task.start_from')
+                ->setFormTypeOption('attr', ['min' => (new DateTime('tomorrow'))->format('Y-m-d')])
+                ->setColumns(4);
+        }
     }
 }

src/Entity/Database.php

@@ -4,6 +4,7 @@
 
 namespace App\Entity;
 
+use App\Entity\Embed\BackupTask;
 use App\Entity\Traits\PrimaryKeyTrait;
 use App\Repository\DatabaseRepository;
 use DateTimeImmutable;
@@ -71,8 +72,12 @@ class Database implements \Stringable
     #[Assert\NotBlank]
     private ?AdapterConfig $adapter = null;
 
+    #[ORM\Embedded(class: BackupTask::class)]
+    private BackupTask $backupTask;
+
     public function __construct()
     {
+        $this->backupTask = new BackupTask();
         $this->backups = new ArrayCollection();
         $this->createdAt = new DateTimeImmutable();
     }
@@ -288,4 +293,16 @@ public function setAdapter(?AdapterConfig $adapter): self
 
         return $this;
     }
+
+    public function getBackupTask(): BackupTask
+    {
+        return $this->backupTask;
+    }
+
+    public function setBackupTask(BackupTask $backupTask): self
+    {
+        $this->backupTask = $backupTask;
+
+        return $this;
+    }
 }

src/Entity/Embed/BackupTask.php

@@ -0,0 +1,124 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Entity\Embed;
+
+use App\Entity\Enum\BackupTaskPeriodicity;
+use DateTime;
+use DateTimeInterface;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\ORM\Mapping as ORM;
+use Doctrine\ORM\Mapping\Embeddable;
+use function sprintf;
+use Symfony\Component\Validator\Constraints as Assert;
+
+#[Embeddable]
+class BackupTask
+{
+    #[ORM\Column(type: Types::STRING, length: 255, enumType: BackupTaskPeriodicity::class)]
+    #[Assert\NotBlank]
+    private ?BackupTaskPeriodicity $periodicity = null;
+
+    #[ORM\Column(type: Types::INTEGER)]
+    #[Assert\Type(type: 'integer')]
+    #[Assert\Range(min: 1)]
+    #[Assert\NotBlank]
+    private ?int $periodicityNumber = null;
+
+    #[ORM\Column(type: Types::DATETIME_MUTABLE)]
+    #[Assert\GreaterThanOrEqual(value: 'tomorrow')]
+    #[Assert\NotBlank]
+    private ?DateTimeInterface $startFrom = null;
+
+    #[ORM\Column(type: Types::DATETIME_MUTABLE)]
+    private ?DateTimeInterface $nextIteration = null;
+
+    public function getPeriodicity(): ?BackupTaskPeriodicity
+    {
+        return $this->periodicity;
+    }
+
+    public function setPeriodicity(BackupTaskPeriodicity $periodicity): self
+    {
+        $this->periodicity = $periodicity;
+
+        return $this;
+    }
+
+    public function getPeriodicityNumber(): ?int
+    {
+        return $this->periodicityNumber;
+    }
+
+    public function setPeriodicityNumber(int $periodicityNumber): self
+    {
+        $this->periodicityNumber = $periodicityNumber;
+
+        return $this;
+    }
+
+    public function getStartFrom(): ?DateTimeInterface
+    {
+        return $this->startFrom;
+    }
+
+    public function setStartFrom(DateTimeInterface $startFrom): self
+    {
+        $this->startFrom = $startFrom;
+
+        return $this;
+    }
+
+    public function getNextIteration(): ?DateTimeInterface
+    {
+        return $this->nextIteration;
+    }
+
+    public function setNextIteration(?DateTimeInterface $nextIteration): self
+    {
+        $this->nextIteration = $nextIteration;
+
+        return $this;
+    }
+
+    public function calculateNextIteration(): DateTime|bool
+    {
+        $currentIteration = new DateTime();
+        $currentIteration->setTime(0, 0);
+
+        return $currentIteration->modify(
+            $this->getNextIterationStringAdd(
+                $this->getPeriodicityNumber(),
+                $this->getPeriodicity()->value
+            )
+        );
+    }
+
+    public function getDescriptionPrefixTranslation(): string
+    {
+        if (1 === $this->periodicityNumber) {
+            return 'enum.backup_task_periodicity.prefix.singular';
+        }
+
+        return match ($this->periodicity) {
+            BackupTaskPeriodicity::DAY, BackupTaskPeriodicity::MONTH => 'enum.backup_task_periodicity.prefix.masculine_plural',
+            BackupTaskPeriodicity::WEEK, BackupTaskPeriodicity::YEAR => 'enum.backup_task_periodicity.prefix.feminine_plural',
+            null => throw new \LogicException('Periodicity is not set'),
+        };
+    }
+
+    public function getDescriptionSuffixTranslation(): string
+    {
+        if (1 === $this->periodicityNumber) {
+            return sprintf('enum.backup_task_periodicity.suffix.singular.%s', $this->periodicity->value);
+        }
+
+        return sprintf('enum.backup_task_periodicity.suffix.plural.%s', $this->periodicity->value);
+    }
+
+    private function getNextIterationStringAdd(float $value, string $string): string
+    {
+        return sprintf('+ %s %s', $value, $string);
+    }
+}

src/Entity/Enum/BackupTaskPeriodicity.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Entity\Enum;
+
+enum BackupTaskPeriodicity: string
+{
+    case DAY = 'day';
+    case WEEK = 'week';
+    case MONTH = 'month';
+    case YEAR = 'year';
+    public function formLabel(): string
+    {
+        return match ($this) {
+            self::DAY => 'enum.backup_task_periodicity.select.day',
+            self::WEEK => 'enum.backup_task_periodicity.select.week',
+            self::MONTH => 'enum.backup_task_periodicity.select.month',
+            self::YEAR => 'enum.backup_task_periodicity.select.year',
+        };
+    }
+}

src/EventSubscriber/DatabaseSubscriber.php

@@ -38,6 +38,9 @@ public function beforePersistedEvent(BeforeEntityPersistedEvent $event): void
 
         $this->handleDatabasePasswordChange($entity);
 
+        $backupTask = $entity->getBackupTask();
+        $backupTask->setNextIteration($backupTask->getStartFrom());
+
         $user = $this->security->getUser();
         \assert($user instanceof User);
         $entity->setOwner($user);