feat: add checker of failed mails for FroshTools

Author: tinect

phpstan.neon.dist

@@ -1,5 +1,7 @@
 parameters:
     level: max
+    scanDirectories:
+        - stubs
     paths:
         - src
     type_coverage:

src/Services/FroshToolsChecker.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Frosh\MailArchive\Services;
+
+use Frosh\MailArchive\Content\MailArchive\MailArchiveEntity;
+use Frosh\Tools\Components\Health\Checker\CheckerInterface;
+use Frosh\Tools\Components\Health\HealthCollection;
+use Frosh\Tools\Components\Health\SettingsResult;
+use Shopware\Core\Framework\Api\Context\SystemSource;
+use Shopware\Core\Framework\Context;
+use Shopware\Core\Framework\DataAbstractionLayer\EntityCollection;
+use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
+use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
+use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
+use Symfony\Component\DependencyInjection\Attribute\AutoconfigureTag;
+
+#[AutoconfigureTag('frosh_tools.health_checker')]
+class FroshToolsChecker implements CheckerInterface
+{
+    /**
+     * @param EntityRepository<EntityCollection<MailArchiveEntity>> $froshMailArchiveRepository
+     */
+    public function __construct(
+        private readonly EntityRepository $froshMailArchiveRepository,
+    ) {}
+
+    public function collect(HealthCollection $collection): void
+    {
+        $criteria = new Criteria();
+        $criteria->addFilter(new EqualsFilter('transportState', MailSender::TRANSPORT_STATE_FAILED));
+
+        $count = $this->froshMailArchiveRepository->searchIds($criteria, new Context(new SystemSource()))->getTotal();
+
+        $result = new SettingsResult();
+        $result->assign([
+            'id' => 'frosh_mail_archive_failed',
+            'snippet' => 'Failed mails in MailArchive',
+            'current' => (string) $count,
+            'recommended' => '0',
+            'state' => $count === 0 ? SettingsResult::GREEN : SettingsResult::ERROR,
+        ]);
+
+        $collection->add($result);
+    }
+}

stubs/Frosh/Tools/Components/Health/Checker/CheckerInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Frosh\Tools\Components\Health\Checker;
+
+use Frosh\Tools\Components\Health\HealthCollection;
+
+interface CheckerInterface
+{
+    public function collect(HealthCollection $collection): void;
+}

stubs/Frosh/Tools/Components/Health/HealthCollection.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Frosh\Tools\Components\Health;
+
+use Shopware\Core\Framework\Struct\Collection;
+
+/**
+ * @extends Collection<SettingsResult>
+ */
+class HealthCollection extends Collection
+{
+    protected function getExpectedClass(): ?string {}
+}

stubs/Frosh/Tools/Components/Health/SettingsResult.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Frosh\Tools\Components\Health;
+
+use Shopware\Core\Framework\Struct\Struct;
+
+class SettingsResult extends Struct
+{
+    public const GREEN = 'STATE_OK';
+    public const WARNING = 'STATE_WARNING';
+    public const ERROR = 'STATE_ERROR';
+    public const INFO = 'STATE_INFO';
+
+    public string $current;
+
+    public string $recommended;
+
+    public string $state;
+
+    public ?string $url = null;
+
+    protected string $id;
+
+    protected string $snippet;
+}