fix: correct several PHPStan errors (#56)

FriendsOfShopware · Sep 14, 2023 · 3e2e55e · 3e2e55e
1 parent ac7f524
commit 3e2e55e
Show file tree

Hide file tree

Showing 12 changed files with 128 additions and 12 deletions.
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -0,0 +1,33 @@
+name: Test
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+  pull_request_target:
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+        matrix:
+            shopware-version:
+                - "~6.5.0.0"
+                - "~6.5.1.0"
+                - "~6.5.2.0"
+                - "~6.5.3.0"
+                - "~6.5.4.0"
+                - "~6.5.5.0"
+                - "dev-trunk"
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: 'PHPStan'
+        run: |
+            composer require shopware/core:${{ matrix.shopware-version }} --no-interaction --no-progress --optimize-autoloader
+            composer show shopware/core | grep versions
+            ./vendor/bin/phpstan analyse
diff --git a/composer.json b/composer.json
@@ -47,5 +47,8 @@
         "allow-plugins": {
           "symfony/runtime": true
         }
+    },
+    "require-dev": {
+        "phpstan/phpstan": "^1.10"
     }
 }
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,6 @@
+parameters:
+    checkGenericClassInNonGenericObjectType: false
+    level: max
+    paths:
+        - src
+
diff --git a/src/Command/MigrateMailCommand.php b/src/Command/MigrateMailCommand.php
@@ -47,7 +47,10 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $progressBar->start();
 
         while ($ids = $iterator->fetch()) {
-            $message = new MigrateMailMessage(\array_values($ids));
+            /** @var array<int, string> $ids */
+            $ids = \array_values($ids);
+
+            $message = new MigrateMailMessage($ids);
 
             if ($input->getOption('sync')) {
                 $this->migrateMailHandler->__invoke($message);

diff --git a/src/Content/MailArchive/MailArchiveEntity.php b/src/Content/MailArchive/MailArchiveEntity.php
@@ -12,8 +12,10 @@ class MailArchiveEntity extends Entity
 {
     use EntityIdTrait;
 
+    /** @var array<string, string> */
     protected array $sender;
 
+    /** @var array<string, string> */
     protected array $receiver;
 
     protected string $subject;
@@ -40,21 +42,33 @@ class MailArchiveEntity extends Entity
     /** @var EntityCollection<MailArchiveAttachmentEntity>|null $attachments */
     protected ?EntityCollection $attachments = null;
 
+    /**
+     * @return array<string, string>
+     */
     public function getSender(): array
     {
         return $this->sender;
     }
 
+    /**
+     * @param array<string, string> $sender
+     */
     public function setSender(array $sender): void
     {
         $this->sender = $sender;
     }
 
+    /**
+     * @return array<string, string>
+     */
     public function getReceiver(): array
     {
         return $this->receiver;
     }
 
+    /**
+     * @param array<string, string> $receiver
+     */
     public function setReceiver(array $receiver): void
     {
         $this->receiver = $receiver;

diff --git a/src/Controller/Api/MailArchiveController.php b/src/Controller/Api/MailArchiveController.php
@@ -10,7 +10,6 @@
 use Shopware\Core\Framework\Context;
 use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
 use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
-use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
 use Shopware\Core\PlatformRequest;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\JsonResponse;
@@ -102,12 +101,20 @@ public function download(Request $request): JsonResponse
             throw new \RuntimeException('Cannot read eml file or file is empty');
         }
 
-        $fileName = $mailArchive->getCreatedAt()->format('Y-m-d_H-i-s') . ' ' . $mailArchive->getSubject() . '.eml';
+        $fileNameParts = [];
+
+        if ($mailArchive->getCreatedAt() !== null) {
+            $fileNameParts[] = $mailArchive->getCreatedAt()->format('Y-m-d_H-i-s');
+        }
+
+        $fileNameParts[] = $mailArchive->getSubject();
+
+        $fileName = $this->getFileName($fileNameParts) . '.eml';
 
         return new JsonResponse([
             'success' => true,
             'content' => $content,
-            'fileName' => preg_replace('/[\x00-\x1F\x7F-\xFF]/', '', $fileName),
+            'fileName' => $fileName,
         ]);
     }
 
@@ -128,6 +135,9 @@ public function attachment(Request $request): JsonResponse
         }
 
         $mailArchive = $attachment->getMailArchive();
+        if (!$mailArchive instanceof MailArchiveEntity) {
+            throw MailArchiveException::notFound();
+        }
 
         $emlPath = $mailArchive->getEmlPath();
         $isEml = !empty($emlPath) && \is_string($emlPath);
@@ -156,13 +166,22 @@ public function attachment(Request $request): JsonResponse
             throw new \RuntimeException('Cannot find attachment in eml file');
         }
 
-        $fileName = $mailArchive->getCreatedAt()->format('Y-m-d_H-i-s') . ' ' . $mailArchive->getSubject() . ' ' . $attachment->getFileName();
+        $fileNameParts = [];
+
+        if ($mailArchive->getCreatedAt() !== null) {
+            $fileNameParts[] = $mailArchive->getCreatedAt()->format('Y-m-d_H-i-s');
+        }
+
+        $fileNameParts[] = $mailArchive->getSubject();
+        $fileNameParts[] = $attachment->getFileName();
+
+        $fileName = $this->getFileName($fileNameParts);
 
         return new JsonResponse([
             'success' => true,
             'content' => \base64_encode($content),
             'contentType' => $attachment->getContentType(),
-            'fileName' => preg_replace('/[\x00-\x1F\x7F-\xFF]/', '', $fileName),
+            'fileName' => $fileName,
         ]);
     }
 
@@ -189,6 +208,10 @@ private function enrichFromEml(string $emlPath, Email $email): void
         }
 
         foreach ($message->getAllAttachmentParts() as $attachment) {
+            if ($attachment->getContent() === null) {
+                continue;
+            }
+
             $email->attach($attachment->getContent(), $attachment->getFilename(), $attachment->getContentType());
         }
     }
@@ -209,6 +232,9 @@ private function enrichFromDatabase(MailArchiveEntity $mailArchive, Email $email
         $email->text($mailArchive->getPlainText());
     }
 
+    /**
+     * @return string|array<Address>|\DateTimeImmutable|null
+     */
     private function getHeaderValue(IHeader $header): string|array|null|\DateTimeImmutable
     {
         if ($header instanceof AddressHeader) {
@@ -226,4 +252,16 @@ private function getHeaderValue(IHeader $header): string|array|null|\DateTimeImm
 
         return $header->getValue();
     }
+
+    /**
+     * @param array<string> $fileNameParts
+     */
+    private function getFileName(array $fileNameParts): string
+    {
+        return (string) preg_replace(
+            '/[\x00-\x1F\x7F-\xFF]/',
+            '',
+            \implode(' ', $fileNameParts)
+        );
+    }
 }
diff --git a/src/FroshPlatformMailArchive.php b/src/FroshPlatformMailArchive.php
@@ -14,8 +14,18 @@ public function uninstall(UninstallContext $uninstallContext): void
             return;
         }
 
-        $this->container->get(Connection::class)->executeStatement('DROP TABLE IF EXISTS frosh_mail_archive');
-        $this->container->get(Connection::class)->executeStatement('DROP TABLE IF EXISTS frosh_mail_archive_attachment');       
+        $container = $this->container;
+        if ($container === null) {
+            return;
+        }
+
+        $connection = $container->get(Connection::class);
+        if (!$connection instanceof Connection) {
+           return;
+        }
+
+        $connection->executeStatement('DROP TABLE IF EXISTS frosh_mail_archive');
+        $connection->executeStatement('DROP TABLE IF EXISTS frosh_mail_archive_attachment');
     }
 
     public function executeComposerCommands(): bool

diff --git a/src/MessageQueue/MigrateMailMessage.php b/src/MessageQueue/MigrateMailMessage.php
@@ -7,7 +7,7 @@
 class MigrateMailMessage implements AsyncMessageInterface
 {
     /**
-     * @param string[] $ids
+     * @param array<int, string> $ids
      */
     public function __construct(
         public readonly array $ids

diff --git a/src/Services/EmlFileManager.php b/src/Services/EmlFileManager.php
@@ -20,6 +20,11 @@ public function __construct(
     public function writeFile(string $id, string $content): string
     {
         $content = \gzcompress($content, 9);
+
+        if ($content === false) {
+            throw new \RuntimeException('Cannot compress eml file');
+        }
+
         $emlFilePath = 'mails/' . $id . '.eml.gz';
 
         $this->filesystem->write($emlFilePath, $content);

diff --git a/src/Services/MailSender.php b/src/Services/MailSender.php
@@ -103,6 +103,7 @@ private function getCustomerIdByMail(array $to): ?string
 
     /**
      * @param Address[] $addresses
+     * @return array<string, string>
      */
     private function convertAddress(array $addresses): array
     {

diff --git a/src/Subscriber/MailArchiveDeleteSubscriber.php b/src/Subscriber/MailArchiveDeleteSubscriber.php
@@ -27,7 +27,7 @@ public static function getSubscribedEvents(): array
 
     public function beforeDelete(BeforeDeleteEvent $event): void
     {
-        /** @var list<string> $affected */
+        /** @var array<string> $ids */
         $ids = array_values($event->getIds(MailArchiveDefinition::ENTITY_NAME));
         if (empty($ids)) {
             return;
@@ -40,7 +40,7 @@ public function beforeDelete(BeforeDeleteEvent $event): void
         /** @var PartialEntity $mail */
         foreach ($mails as $mail) {
             $emlPath = $mail->get('emlPath');
-            if (empty($emlPath)) {
+            if (empty($emlPath) || !\is_string($emlPath)) {
                 continue;
             }
 

diff --git a/src/Task/CleanupTaskHandler.php b/src/Task/CleanupTaskHandler.php
@@ -8,7 +8,6 @@
 use Shopware\Core\Defaults;
 use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
 use Shopware\Core\Framework\MessageQueue\ScheduledTask\ScheduledTaskHandler;
-use Shopware\Core\Framework\Uuid\Uuid;
 use Shopware\Core\System\SystemConfig\SystemConfigService;
 use Symfony\Component\Messenger\Attribute\AsMessageHandler;
 
@@ -53,6 +52,10 @@ public function run(): void
         }
 
         foreach ($result as $item) {
+            if (empty($item['eml_path']) || !\is_string($item['eml_path'])) {
+                continue;
+            }
+
             $this->emlFileManager->deleteEmlFile($item['eml_path']);
         }