feat: Moved all document processes from event-subscribers to async me…

…ssenger, read AV media size and duration

composer.json

@@ -30,6 +30,7 @@
         "doctrine/orm": "^2.12.2",
         "gedmo/doctrine-extensions": "^2.4 || ^3.0.0",
         "inlinestyle/inlinestyle": "~1.2.7",
+        "james-heinrich/getid3": "^1.9",
         "jms/serializer": "^3.1.1",
         "jms/serializer-bundle": "^3.10.0",
         "lexik/jwt-authentication-bundle": "^2.13",

config/services.yaml

@@ -102,10 +102,68 @@ services:
         autowire: true
         autoconfigure: false
 
-    RZ\Roadiz\Document\EventSubscriber\:
-        resource: '%kernel.project_dir%/vendor/roadiz/documents/src/Roadiz/Document/EventSubscriber/'
-        autowire: true
-        autoconfigure: true
+    # Do not register roadiz/document packages event-subscribers
+    # They've been replaced with MessageHandlers
+
+    RZ\Roadiz\CoreBundle\Document\MessageHandler\AbstractDocumentMessageHandler:
+        autoconfigure: false
+        abstract: true
+
+    RZ\Roadiz\CoreBundle\Document\MessageHandler\AbstractLockingDocumentMessageHandler:
+        autoconfigure: false
+        abstract: true
+
+    RZ\Roadiz\CoreBundle\Document\MessageHandler\DocumentAverageColorMessageHandler:
+        autoconfigure: false
+        tags:
+            -   name: messenger.message_handler
+                handles: RZ\Roadiz\CoreBundle\Document\Message\DocumentAverageColorMessage
+            - { name: monolog.logger, channel: messenger }
+
+    RZ\Roadiz\CoreBundle\Document\MessageHandler\DocumentExifMessageHandler:
+        autoconfigure: false
+        tags:
+            -   name: messenger.message_handler
+                handles: RZ\Roadiz\CoreBundle\Document\Message\DocumentExifMessage
+            - { name: monolog.logger, channel: messenger }
+
+    RZ\Roadiz\CoreBundle\Document\MessageHandler\DocumentFilesizeMessageHandler:
+        autoconfigure: false
+        tags:
+            -   name: messenger.message_handler
+                handles: RZ\Roadiz\CoreBundle\Document\Message\DocumentFilesizeMessage
+            - { name: monolog.logger, channel: messenger }
+
+    RZ\Roadiz\CoreBundle\Document\MessageHandler\DocumentRawMessageHandler:
+        autoconfigure: false
+        tags:
+            -   name: messenger.message_handler
+                handles: RZ\Roadiz\CoreBundle\Document\Message\DocumentRawMessage
+                priority: -100
+            - { name: monolog.logger, channel: messenger }
+
+    RZ\Roadiz\CoreBundle\Document\MessageHandler\DocumentSizeMessageHandler:
+        autoconfigure: false
+        tags:
+            -   name: messenger.message_handler
+                handles: RZ\Roadiz\CoreBundle\Document\Message\DocumentSizeMessage
+            - { name: monolog.logger, channel: messenger }
+
+    RZ\Roadiz\CoreBundle\Document\MessageHandler\DocumentSvgMessageHandler:
+        autoconfigure: false
+        tags:
+            -   name: messenger.message_handler
+                handles: RZ\Roadiz\CoreBundle\Document\Message\DocumentSvgMessage
+                priority: -100
+            - { name: monolog.logger, channel: messenger }
+
+    RZ\Roadiz\CoreBundle\Document\MessageHandler\DocumentAudioVideoMessageHandler:
+        autoconfigure: false
+        tags:
+            -   name: messenger.message_handler
+                handles: RZ\Roadiz\CoreBundle\Document\Message\DocumentAudioVideoMessage
+                priority: -100
+            - { name: monolog.logger, channel: messenger }
 
     RZ\Roadiz\CoreBundle\SearchEngine\Indexer\:
         resource: '../src/SearchEngine/Indexer/'

src/Document/EventSubscriber/DocumentMessageDispatchSubscriber.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RZ\Roadiz\CoreBundle\Document\EventSubscriber;
+
+use RZ\Roadiz\Core\Events\DocumentCreatedEvent;
+use RZ\Roadiz\Core\Events\DocumentUpdatedEvent;
+use RZ\Roadiz\Core\Events\FilterDocumentEvent;
+use RZ\Roadiz\CoreBundle\Document\Message\DocumentAudioVideoMessage;
+use RZ\Roadiz\CoreBundle\Document\Message\DocumentAverageColorMessage;
+use RZ\Roadiz\CoreBundle\Document\Message\DocumentExifMessage;
+use RZ\Roadiz\CoreBundle\Document\Message\DocumentFilesizeMessage;
+use RZ\Roadiz\CoreBundle\Document\Message\DocumentRawMessage;
+use RZ\Roadiz\CoreBundle\Document\Message\DocumentSizeMessage;
+use RZ\Roadiz\CoreBundle\Document\Message\DocumentSvgMessage;
+use RZ\Roadiz\CoreBundle\Entity\Document;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\MessageBusInterface;
+
+final class DocumentMessageDispatchSubscriber implements EventSubscriberInterface
+{
+    private MessageBusInterface $bus;
+
+    /**
+     * @param MessageBusInterface $bus
+     */
+    public function __construct(MessageBusInterface $bus)
+    {
+        $this->bus = $bus;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public static function getSubscribedEvents(): array
+    {
+        return [
+             DocumentCreatedEvent::class => ['onFilterDocumentEvent', 0],
+             DocumentUpdatedEvent::class => ['onFilterDocumentEvent', 0],
+        ];
+    }
+
+    public function onFilterDocumentEvent(FilterDocumentEvent $event)
+    {
+        $document = $event->getDocument();
+        if (
+            $document instanceof Document &&
+            null !== $document->getId() &&
+            $document->isLocal() &&
+            null !== $document->getRelativePath()
+        ) {
+            $this->bus->dispatch(new Envelope(new DocumentRawMessage($document->getId())));
+            $this->bus->dispatch(new Envelope(new DocumentFilesizeMessage($document->getId())));
+            $this->bus->dispatch(new Envelope(new DocumentSizeMessage($document->getId())));
+            $this->bus->dispatch(new Envelope(new DocumentAverageColorMessage($document->getId())));
+            $this->bus->dispatch(new Envelope(new DocumentExifMessage($document->getId())));
+            $this->bus->dispatch(new Envelope(new DocumentSvgMessage($document->getId())));
+            $this->bus->dispatch(new Envelope(new DocumentAudioVideoMessage($document->getId())));
+        }
+    }
+}

src/Document/Message/AbstractDocumentMessage.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RZ\Roadiz\CoreBundle\Document\Message;
+
+use RZ\Roadiz\CoreBundle\Message\AsyncMessage;
+
+abstract class AbstractDocumentMessage implements AsyncMessage
+{
+    private int $documentId;
+
+    /**
+     * @param int $documentId
+     */
+    public function __construct(int $documentId)
+    {
+        $this->documentId = $documentId;
+    }
+
+    /**
+     * @return int
+     */
+    public function getDocumentId(): int
+    {
+        return $this->documentId;
+    }
+}

src/Document/Message/DocumentAudioVideoMessage.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RZ\Roadiz\CoreBundle\Document\Message;
+
+class DocumentAudioVideoMessage extends AbstractDocumentMessage
+{
+
+}

src/Document/Message/DocumentAverageColorMessage.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RZ\Roadiz\CoreBundle\Document\Message;
+
+class DocumentAverageColorMessage extends AbstractDocumentMessage
+{
+
+}

src/Document/Message/DocumentExifMessage.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RZ\Roadiz\CoreBundle\Document\Message;
+
+class DocumentExifMessage extends AbstractDocumentMessage
+{
+
+}

src/Document/Message/DocumentFilesizeMessage.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RZ\Roadiz\CoreBundle\Document\Message;
+
+class DocumentFilesizeMessage extends AbstractDocumentMessage
+{
+
+}

src/Document/Message/DocumentRawMessage.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RZ\Roadiz\CoreBundle\Document\Message;
+
+class DocumentRawMessage extends AbstractDocumentMessage
+{
+
+}

src/Document/Message/DocumentSizeMessage.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RZ\Roadiz\CoreBundle\Document\Message;
+
+class DocumentSizeMessage extends AbstractDocumentMessage
+{
+
+}

src/Document/Message/DocumentSvgMessage.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RZ\Roadiz\CoreBundle\Document\Message;
+
+class DocumentSvgMessage extends AbstractDocumentMessage
+{
+
+}

src/Document/MessageHandler/AbstractDocumentMessageHandler.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RZ\Roadiz\CoreBundle\Document\MessageHandler;
+
+use Doctrine\Persistence\ManagerRegistry;
+use Psr\Log\LoggerInterface;
+use RZ\Roadiz\Core\Models\DocumentInterface;
+use RZ\Roadiz\CoreBundle\Document\Message\AbstractDocumentMessage;
+use RZ\Roadiz\CoreBundle\Entity\Document;
+use RZ\Roadiz\Utils\Asset\Packages;
+use Symfony\Component\Messenger\Handler\MessageHandlerInterface;
+
+abstract class AbstractDocumentMessageHandler implements MessageHandlerInterface
+{
+    protected ManagerRegistry $managerRegistry;
+    protected LoggerInterface $logger;
+    protected Packages $packages;
+
+    /**
+     * @param ManagerRegistry $managerRegistry
+     * @param LoggerInterface $messengerLogger
+     * @param Packages $packages
+     */
+    public function __construct(ManagerRegistry $managerRegistry, LoggerInterface $messengerLogger, Packages $packages)
+    {
+        $this->managerRegistry = $managerRegistry;
+        $this->logger = $messengerLogger;
+        $this->packages = $packages;
+    }
+
+    abstract protected function supports(DocumentInterface $document): bool;
+
+    abstract protected function processMessage(AbstractDocumentMessage $message, Document $document): void;
+
+    public function __invoke(AbstractDocumentMessage $message): void
+    {
+        $document = $this->managerRegistry->getRepository(Document::class)->find($message->getDocumentId());
+
+        if ($document instanceof Document && $this->supports($document)) {
+            $this->processMessage($message, $document);
+            $this->managerRegistry->getManager()->flush();
+        }
+    }
+}

src/Document/MessageHandler/AbstractLockingDocumentMessageHandler.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RZ\Roadiz\CoreBundle\Document\MessageHandler;
+
+use RZ\Roadiz\CoreBundle\Document\Message\AbstractDocumentMessage;
+use RZ\Roadiz\CoreBundle\Entity\Document;
+use Symfony\Component\Messenger\Exception\RecoverableMessageHandlingException;
+
+/**
+ * Use file locking system to ensure only one async operation is done on each document file.
+ */
+abstract class AbstractLockingDocumentMessageHandler extends AbstractDocumentMessageHandler
+{
+    public function __invoke(AbstractDocumentMessage $message): void
+    {
+        $document = $this->managerRegistry->getRepository(Document::class)->find($message->getDocumentId());
+
+        if ($document instanceof Document && $this->supports($document)) {
+            $documentPath = $this->packages->getDocumentFilePath($document);
+            $resource = \fopen($documentPath, "r+");
+
+            if (false === $resource) {
+                throw new RecoverableMessageHandlingException(sprintf(
+                    '%s file does not exist',
+                    $documentPath
+                ));
+            }
+
+            if (\flock($resource, \LOCK_EX)) {
+                $this->processMessage($message, $document);
+                $this->managerRegistry->getManager()->flush();
+                \flock($resource, \LOCK_UN);
+            } else {
+                throw new RecoverableMessageHandlingException(sprintf(
+                    '%s file is currently locked',
+                    $documentPath
+                ));
+            }
+        }
+    }
+}