Enable automated payment reminders for groups

Dorazil · Dorazil · commit 152e32371a1a · 2025-10-20T16:09:33.000+02:00
Adds functionality to send automated payment reminders for groups with the option to enable or disable this feature. Implements repository queries, CLI support, UI updates, and relevant database changes including a new `is_reminders_enabled` column.
diff --git a/app/AccountancyModule/PaymentModule/components/GroupForm.php b/app/AccountancyModule/PaymentModule/components/GroupForm.php
@@ -179,6 +179,7 @@ private function formSucceeded(BaseForm $form): void
                 $emails,
                 $oAuthId,
                 $v->bankAccount,
+                $v->emails[EmailType::PAYMENT_REMINDER]?->remindersEnabled ?? false,
             );
 
             $this->flashMessage('Skupina byla upravena');
@@ -191,6 +192,7 @@ private function formSucceeded(BaseForm $form): void
                 $emails,
                 $oAuthId,
                 $v->bankAccount,
+                $v->emails[EmailType::PAYMENT_REMINDER]?->remindersEnabled ?? false,
             );
 
             $this->flashMessage('Skupina byla založena');
@@ -219,6 +221,11 @@ private function buildDefaultsFromGroup(): array
 
         foreach (EmailType::getAvailableEnums() as $emailType) {
             $emails[$emailType->toString()] = $this->getEmailDefaults($this->groupId, $emailType);
+            if ($emailType->toString() !== EmailType::PAYMENT_REMINDER) {
+                continue;
+            }
+
+            $emails[$emailType->toString()]['remindersEnabled'] = $group->isRemindersEnabled();
         }
 
         return [
@@ -250,16 +257,23 @@ private function addEmailsToForm(BaseForm $form): void
             $container = $emailsContainer->addContainer($type);
             $container->setCurrentGroup($group);
 
-            $subjectId = $type . '_subject';
-            $bodyId    = $type . '_body';
+            $subjectId   = $type . '_subject';
+            $bodyId      = $type . '_body';
+            $remindersId = $type . '_reminders';
 
             // Only payment info email is always saved
             if ($type !== EmailType::PAYMENT_INFO) {
                 $container->addCheckbox('enabled', 'Aktivní')
                     ->setOption('class', 'form-check')
                     ->addCondition($form::FILLED)
                     ->toggle($subjectId)
-                    ->toggle($bodyId);
+                    ->toggle($bodyId)
+                    ->toggle($remindersId);
+            }
+
+            if ($type === EmailType::PAYMENT_REMINDER) {
+                $container->addCheckbox('remindersEnabled', 'Automaticky odeslat email po splatnosti')
+                    ->setOption('id', $remindersId);
             }
 
             $container->addText('subject', 'Předmět e-mailu')
diff --git a/app/config/config.neon b/app/config/config.neon
@@ -151,6 +151,9 @@ services:
 
     - Model\Services\PdfRenderer(%tempDir%)
 
+    group:
+        factory: Model\GroupService
+
     - Model\PaymentService
     - Model\Payment\BankAccountService(fioCache: @fio.cache)
 
@@ -242,7 +245,8 @@ services:
 scheduler:
 	jobs:
 		# stats must be registered as service and have method calculate
-		- { cron: '* * * * *', callback: [ @fio.client, get ] }
+		#- { cron: '* * * * *', callback: [ @fio.client, get ] }
+		- { cron: '* * * * *', callback: [ @group, reminder ] }
 
 
 decorator:
diff --git a/app/model/DTO/Payment/Group.php b/app/model/DTO/Payment/Group.php
@@ -21,6 +21,7 @@
  * @property-read int|NULL $constantSymbol
  * @property-read VariableSymbol|NULL $nextVariableSymbol
  * @property-read string $state
+ * @property-read bool $isRemindersEnabled
  * @property-read OAuthId|NULL $oAuthId
  * @property-read string $note
  */
@@ -43,6 +44,7 @@ public function __construct(
         private OAuthId|null $oAuthId = null,
         private string $note,
         private int|null $bankAccountId = null,
+        private bool $isRemindersEnabled = false,
     ) {
     }
 
@@ -116,4 +118,9 @@ public function getBankAccountId(): int|null
     {
         return $this->bankAccountId;
     }
+
+    public function isRemindersEnabled(): bool
+    {
+        return $this->isRemindersEnabled;
+    }
 }
diff --git a/app/model/DTO/Payment/GroupFactory.php b/app/model/DTO/Payment/GroupFactory.php
@@ -26,6 +26,7 @@ public static function create(GroupEntity $group): Group
             $group->getOauthId(),
             $group->getNote(),
             $group->getBankAccountId(),
+            $group->isRemindersEnabled(),
         );
     }
 }
diff --git a/app/model/Infrastructure/Repositories/Payment/GroupRepository.php b/app/model/Infrastructure/Repositories/Payment/GroupRepository.php
@@ -10,6 +10,7 @@
 use Model\Common\Services\EventBus;
 use Model\Google\OAuthId;
 use Model\Payment\DomainEvents\GroupWasRemoved;
+use Model\Payment\EmailType;
 use Model\Payment\Group;
 use Model\Payment\Group\Type;
 use Model\Payment\GroupNotFound;
@@ -58,6 +59,23 @@ public function findByIds(array $ids): array
         return $groups;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function findByReminder(): array
+    {
+        return $this->em->createQueryBuilder()
+            ->select('g')
+            ->from(Group::class, 'g', 'g.id')
+            ->leftJoin(Group\Email::class, 'e', Join::WITH, 'e.group = g')
+            ->where('g.isRemindersEnabled = 1')
+            ->andWhere('e.type = :reminder')
+            ->andWhere('e.enabled = 1')
+            ->setParameter('reminder', EmailType::PAYMENT_REMINDER)
+            ->getQuery()
+            ->getResult();
+    }
+
     /**
      * {@inheritDoc}
      */
diff --git a/app/model/Infrastructure/Repositories/Payment/PaymentRepository.php b/app/model/Infrastructure/Repositories/Payment/PaymentRepository.php
@@ -5,7 +5,9 @@
 namespace Model\Infrastructure\Repositories\Payment;
 
 use Assert\Assert;
+use DateTimeImmutable;
 use Model\Infrastructure\Repositories\AggregateRepository;
+use Model\Payment\EmailType;
 use Model\Payment\Payment;
 use Model\Payment\Payment\State;
 use Model\Payment\PaymentNotFound;
@@ -104,6 +106,37 @@ public function findByMultipleGroups(array $groupIds): array
             ->getResult();
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function findByReminder(array $groupIds): array
+    {
+        Assert::thatAll($groupIds)->integer();
+
+        if (empty($groupIds)) {
+            return [];
+        }
+
+        return $this->getEntityManager()->createQueryBuilder()
+            ->select('p, e')
+            ->from(Payment::class, 'p')
+            ->leftJoin('p.sentEmails', 'e')
+            ->where('p.groupId IN (:groupIds)')
+            ->andWhere('p.state = :state')
+            ->andWhere('p.dueDate <= :dueDate')
+            ->andWhere(
+                'NOT EXISTS (
+            SELECT 1 FROM ' . Payment\SentEmail::class . ' se
+            WHERE se.payment = p AND se.type = :reminderType)',
+            )
+            ->setParameter('groupIds', $groupIds)
+            ->setParameter('state', State::PREPARING)
+            ->setParameter('dueDate', (new DateTimeImmutable())->format('Y-m-d'))
+            ->setParameter('reminderType', EmailType::PAYMENT_REMINDER)
+
+            ->getQuery()->getResult();
+    }
+
     public function save(Payment $payment): void
     {
         $this->saveAndDispatchEvents($payment);
diff --git a/app/model/Payment/Commands/Mailing/SendPaymentReminder.php b/app/model/Payment/Commands/Mailing/SendPaymentReminder.php
@@ -9,12 +9,17 @@
 /** @see SendPaymentReminderHandler */
 final class SendPaymentReminder
 {
-    public function __construct(private int $paymentId)
+    public function __construct(private int $paymentId, private bool $cli = false)
     {
     }
 
     public function getPaymentId(): int
     {
         return $this->paymentId;
     }
+
+    public function isCli(): bool
+    {
+        return $this->cli;
+    }
 }
diff --git a/app/model/Payment/Group.php b/app/model/Payment/Group.php
@@ -68,6 +68,9 @@ class Group
     /** @ORM\Column(type="datetime_immutable", nullable=true) */
     private DateTimeImmutable|null $createdAt = null;
 
+    /** @ORM\Column(type="boolean", options={"default"=0}) */
+    private bool $isRemindersEnabled = false;
+
     /**
      * @ORM\Embedded(class=Group\BankAccount::class, columnPrefix=false)
      *
@@ -109,6 +112,7 @@ public function __construct(
         BankAccount|null $bankAccount,
         IBankAccountAccessChecker $bankAccountAccessChecker,
         IOAuthAccessChecker $oAuthAccessChecker,
+        bool $isRemindersEnabled = false,
     ) {
         Assertion::notEmpty($unitIds);
         $this->object          = $object;
@@ -133,6 +137,7 @@ public function __construct(
 
         $this->changeBankAccount($bankAccount, $bankAccountAccessChecker);
         $this->changeOAuth($oAuthId, $oAuthAccessChecker);
+        $this->isRemindersEnabled = $isRemindersEnabled;
     }
 
     public function update(
@@ -142,13 +147,15 @@ public function update(
         BankAccount|null $bankAccount,
         IBankAccountAccessChecker $bankAccountAccessChecker,
         IOAuthAccessChecker $oAuthAccessChecker,
+        bool $isRemindersEnabled = false,
     ): void {
         $this->changeBankAccount($bankAccount, $bankAccountAccessChecker);
         $this->changeOAuth($oAuthId, $oAuthAccessChecker);
 
-        $this->name            = $name;
-        $this->paymentDefaults = $paymentDefaults;
-        $this->oauthId         = $oAuthId;
+        $this->name               = $name;
+        $this->paymentDefaults    = $paymentDefaults;
+        $this->oauthId            = $oAuthId;
+        $this->isRemindersEnabled = $isRemindersEnabled;
     }
 
     public function open(string $note): void
@@ -250,6 +257,11 @@ public function getState(): string
         return $this->state;
     }
 
+    public function isRemindersEnabled(): bool
+    {
+        return $this->isRemindersEnabled;
+    }
+
     public function getCreatedAt(): DateTimeImmutable|null
     {
         return $this->createdAt;
diff --git a/app/model/Payment/GroupService.php b/app/model/Payment/GroupService.php
@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Model;
+
+use App\AccountancyModule\PaymentModule\Components\EmailButton;
+use Model\Common\Services\CommandBus;
+use Model\Google\Exception\OAuthNotSet;
+use Model\Google\InvalidOAuth;
+use Model\Payment\Commands\Mailing\SendPaymentReminder;
+use Model\Payment\EmailTemplateNotSet;
+use Model\Payment\InvalidBankAccount;
+use Model\Payment\PaymentHasNoEmails;
+use Model\Payment\Repositories\IGroupRepository;
+use Model\Payment\Repositories\IPaymentRepository;
+use Psr\Log\LoggerInterface;
+
+use function array_map;
+
+class GroupService
+{
+    public function __construct(
+        private IGroupRepository $groups,
+        private IPaymentRepository $payments,
+        private CommandBus $commandBus,
+        private LoggerInterface $logger,
+    ) {
+    }
+
+    public function reminder(): void
+    {
+        $count            = 0;
+        $reminderGroups   = $this->groups->findByReminder();
+        $reminderPayments = $this->payments->findByReminder(array_map(function ($group) {
+            return (int) $group->getId();
+        }, $reminderGroups));
+
+        foreach ($reminderPayments as $payment) {
+            try {
+                $this->commandBus->handle(new SendPaymentReminder($payment->getId(), true));
+                $count++;
+            } catch (OAuthNotSet) {
+                $this->logger->error('OAuth not set');
+            } catch (InvalidBankAccount) {
+                $this->logger->error(EmailButton::NO_BANK_ACCOUNT_MESSAGE);
+            } catch (InvalidOAuth) {
+                $this->logger->error('Invalid OAuth');
+            } catch (EmailTemplateNotSet) {
+                $this->logger->error(EmailButton::NO_TEMPLATE_ASSIGNED);
+            } catch (PaymentHasNoEmails) {
+                $this->logger->error('Payment has no emails');
+            }
+        }
+
+        $this->logger->info('Sent reminders for ' . $count . ' payments');
+    }
+}
diff --git a/app/model/Payment/Handlers/Mailing/SendPaymentReminderHandler.php b/app/model/Payment/Handlers/Mailing/SendPaymentReminderHandler.php
@@ -26,6 +26,6 @@ public function __invoke(SendPaymentReminder $command): void
             throw PaymentClosed::withName($payment->getName());
         }
 
-        $this->mailingService->sendEmail($payment->getId(), EmailType::get(EmailType::PAYMENT_REMINDER));
+        $this->mailingService->sendEmail($payment->getId(), EmailType::get(EmailType::PAYMENT_REMINDER), $command->isCli());
     }
 }
diff --git a/app/model/Payment/MailingService.php b/app/model/Payment/MailingService.php
diff --git a/app/model/Payment/PaymentService.php b/app/model/Payment/PaymentService.php
diff --git a/app/model/Payment/Repositories/IGroupRepository.php b/app/model/Payment/Repositories/IGroupRepository.php
diff --git a/app/model/Payment/Repositories/IPaymentRepository.php b/app/model/Payment/Repositories/IPaymentRepository.php
diff --git a/migrations/2025/Version20251019194523.php b/migrations/2025/Version20251019194523.php

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@`
`21`	`21`	`* @property-read int\|NULL $constantSymbol`
`22`	`22`	`* @property-read VariableSymbol\|NULL $nextVariableSymbol`
`23`	`23`	`* @property-read string $state`
	`24`	`+ * @property-read bool $isRemindersEnabled`
`24`	`25`	`* @property-read OAuthId\|NULL $oAuthId`
`25`	`26`	`* @property-read string $note`
`26`	`27`	`*/`
`@@ -43,6 +44,7 @@ public function __construct(`
`43`	`44`	`private OAuthId\|null $oAuthId = null,`
`44`	`45`	`private string $note,`
`45`	`46`	`private int\|null $bankAccountId = null,`
	`47`	`+ private bool $isRemindersEnabled = false,`
`46`	`48`	`) {`
`47`	`49`	`}`
`48`	`50`
`@@ -116,4 +118,9 @@ public function getBankAccountId(): int\|null`
`116`	`118`	`{`
`117`	`119`	`return $this->bankAccountId;`
`118`	`120`	`}`
	`121`	`+`
	`122`	`+ public function isRemindersEnabled(): bool`
	`123`	`+ {`
	`124`	`+ return $this->isRemindersEnabled;`
	`125`	`+ }`
`119`	`126`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ public static function create(GroupEntity $group): Group`
`26`	`26`	`$group->getOauthId(),`
`27`	`27`	`$group->getNote(),`
`28`	`28`	`$group->getBankAccountId(),`
	`29`	`+ $group->isRemindersEnabled(),`
`29`	`30`	`);`
`30`	`31`	`}`
`31`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,12 +9,17 @@`
`9`	`9`	`/** @see SendPaymentReminderHandler */`
`10`	`10`	`final class SendPaymentReminder`
`11`	`11`	`{`
`12`		`- public function __construct(private int $paymentId)`
	`12`	`+ public function __construct(private int $paymentId, private bool $cli = false)`
`13`	`13`	`{`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`public function getPaymentId(): int`
`17`	`17`	`{`
`18`	`18`	`return $this->paymentId;`
`19`	`19`	`}`
	`20`	`+`
	`21`	`+ public function isCli(): bool`
	`22`	`+ {`
	`23`	`+ return $this->cli;`
	`24`	`+ }`
`20`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,6 @@ public function __invoke(SendPaymentReminder $command): void`
`26`	`26`	`throw PaymentClosed::withName($payment->getName());`
`27`	`27`	`}`
`28`	`28`
`29`		`- $this->mailingService->sendEmail($payment->getId(), EmailType::get(EmailType::PAYMENT_REMINDER));`
	`29`	`+ $this->mailingService->sendEmail($payment->getId(), EmailType::get(EmailType::PAYMENT_REMINDER), $command->isCli());`
`30`	`30`	`}`
`31`	`31`	`}`