Add logger to optimize image handler and fix infinite loop where an image is being tried indefinitely

Author: loevgaard

.github/workflows/build.yaml

@@ -194,9 +194,8 @@ jobs:
                 with:
                     dependency-versions: "${{ matrix.dependencies }}"
 
-            # Removed linting until this issue is fixed: https://github.com/symfony/symfony/issues/38056
-            #-   name: "Lint container"
-            #    run: "(cd tests/Application && bin/console lint:container)"
+            -   name: "Lint container"
+                run: "(cd tests/Application && bin/console lint:container)"
 
             -   name: "Create database"
                 run: "(cd tests/Application && bin/console doctrine:database:create -vvv)"

src/Message/Handler/OptimizeImageHandler.php

@@ -8,6 +8,7 @@
 use Doctrine\ORM\NonUniqueResultException;
 use Doctrine\Persistence\ManagerRegistry;
 use Liip\ImagineBundle\Service\FilterService;
+use Psr\Log\LoggerInterface;
 use function Safe\sprintf;
 use Setono\SyliusImageOptimizerPlugin\Factory\ImageFileFactoryInterface;
 use Setono\SyliusImageOptimizerPlugin\ImageFile\ImageFile;
@@ -46,20 +47,25 @@ final class OptimizeImageHandler implements MessageHandlerInterface
     /** @var MessageBusInterface */
     private $eventBus;
 
+    /** @var LoggerInterface */
+    private $logger;
+
     public function __construct(
         OptimizerInterface $optimizer,
         ManagerRegistry $managerRegistry,
         FilterService $filterService,
         OptimizedImageWriterInterface $optimizedImageWriter,
         ImageFileFactoryInterface $imageFileFactory,
-        MessageBusInterface $eventBus
+        MessageBusInterface $eventBus,
+        LoggerInterface $logger
     ) {
         $this->optimizer = $optimizer;
         $this->managerRegistry = $managerRegistry;
         $this->filterService = $filterService;
         $this->optimizedImageWriter = $optimizedImageWriter;
         $this->imageFileFactory = $imageFileFactory;
         $this->eventBus = $eventBus;
+        $this->logger = $logger;
     }
 
     public function __invoke(OptimizeImage $message): void
@@ -73,23 +79,46 @@ public function __invoke(OptimizeImage $message): void
             ));
         }
 
-        foreach ($message->getFilterSets() as $filterSet) {
-            $url = $this->filterService->getUrlOfFilteredImage($message->getPath(), $filterSet);
-            $imageFile = $this->imageFileFactory->createFromUrl($url);
-
-            $result = $this->optimizer->optimize($imageFile);
-            $this->handleOptimizationResult($message->getImageResource(), $result, $imageFile, $message->getPath(), $filterSet);
+        $exceptions = [];
 
-            if ($this->optimizer instanceof WebPOptimizerInterface) {
-                $result = $this->optimizer->optimizeAndConvertToWebP($imageFile);
-                $this->handleOptimizationResult($message->getImageResource(), $result, $imageFile, $message->getPath(), $filterSet);
+        foreach ($message->getFilterSets() as $filterSet) {
+            try {
+                $url = $this->filterService->getUrlOfFilteredImage($message->getPath(), $filterSet);
+                $imageFile = $this->imageFileFactory->createFromUrl($url);
+
+                $result = $this->optimizer->optimize($imageFile);
+                $this->handleOptimizationResult(
+                    $message->getImageResource(), $result, $imageFile, $message->getPath(), $filterSet
+                );
+
+                if ($this->optimizer instanceof WebPOptimizerInterface) {
+                    $result = $this->optimizer->optimizeAndConvertToWebP($imageFile);
+                    $this->handleOptimizationResult(
+                        $message->getImageResource(), $result, $imageFile, $message->getPath(), $filterSet
+                    );
+                }
+            } catch (\Throwable $e) {
+                $exceptions[] = $e;
             }
         }
 
+        // todo notice we are catching exceptions above meaning that an image can fail in optimization, but still be marked as optimized
+        // todo this is done as an easy fix right now to solve the problem where a command keeps trying to optimize an image that fails
         $image->setOptimized();
 
         $manager = $this->getManager($message->getClass());
         $manager->flush();
+
+        if (count($exceptions) > 0) {
+            $errors = array_map(static function (\Throwable $e): string {
+                return $e->getMessage();
+            }, $exceptions);
+
+            $this->logger->error(sprintf(
+                "An error occurred during optimization of image %s with id %s. Errors:\n%s",
+                $message->getClass(), $message->getId(), '- ' . implode("\n- ", $errors)
+            ));
+        }
     }
 
     private function handleOptimizationResult(

src/Resources/config/services/message.xml

@@ -38,6 +38,7 @@
             <argument type="service" id="setono_sylius_image_optimizer.writer.optimized_image"/>
             <argument type="service" id="setono_sylius_image_optimizer.factory.image_file"/>
             <argument type="service" id="setono_sylius_image_optimizer.event_bus"/>
+            <argument type="service" id="logger"/>
 
             <tag name="messenger.message_handler"/>
         </service>