Introduce Output Workflow Signal Event (#321)

* implement output workflow signal event, keep attachment in multiple channels, fixes #311

Author: solverat

UPGRADE.md

@@ -4,6 +4,7 @@
 - **[NEW FEATURE]**: API Output channel [#290](https://github.com/dachcom-digital/pimcore-formbuilder/issues/301)
 - **[NEW FEATURE]**: API Output channel field transformer
 - **[BUGFIX]**: ensure migration of form configs will be symfony5 compatible [@grizzlydotweb](https://github.com/dachcom-digital/pimcore-formbuilder/pull/310)
+- **[BUGFIX]**: introduce output workflow signals: attachments not working with multiple channels [#311](https://github.com/dachcom-digital/pimcore-formbuilder/issues/311) 
 - **[BUGFIX]**: fix typo in translation [#312](https://github.com/dachcom-digital/pimcore-formbuilder/issues/312)
 - **[BUGFIX]**: disable `selectOnFocus` [#315](https://github.com/dachcom-digital/pimcore-formbuilder/issues/315)
 - **[BUGFIX]**: ⚠️ multi file upload: hidden type `_data` not in form row. touched view: `form/theme/type/dynamic_multi_file.html.twig` [#316](https://github.com/dachcom-digital/pimcore-formbuilder/issues/316) 

src/FormBuilderBundle/Event/OutputWorkflow/OutputWorkflowSignalEvent.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace FormBuilderBundle\Event\OutputWorkflow;
+
+use Symfony\Contracts\EventDispatcher\Event;
+
+class OutputWorkflowSignalEvent extends Event
+{
+    public const NAME = 'form_builder.output_workflow.signal';
+
+    protected string $name;
+    protected mixed $data;
+
+    public function __construct(string $name, mixed $data)
+    {
+        $this->name = $name;
+        $this->data = $data;
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    public function getData(): mixed
+    {
+        return $this->data;
+    }
+}

src/FormBuilderBundle/Event/OutputWorkflow/OutputWorkflowSignalsEvent.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace FormBuilderBundle\Event\OutputWorkflow;
+
+use FormBuilderBundle\Exception\OutputWorkflow;
+use Symfony\Contracts\EventDispatcher\Event;
+
+class OutputWorkflowSignalsEvent extends Event
+{
+    protected array $signals;
+    protected ?\Exception $exception;
+
+    public function __construct(array $signals, ?\Exception $exception)
+    {
+        $this->signals = $signals;
+        $this->exception = $exception;
+    }
+
+    public function hasException(): bool
+    {
+        return $this->exception instanceof \Exception;
+    }
+
+    public function hasGuardException(): bool
+    {
+        return $this->exception instanceof OutputWorkflow\GuardChannelException ||
+            $this->exception instanceof OutputWorkflow\GuardOutputWorkflowException ||
+            $this->exception instanceof OutputWorkflow\GuardStackedException;
+    }
+
+    public function getException(): ?\Exception
+    {
+        return $this->exception;
+    }
+
+    /**
+     * @return array<int, OutputWorkflowSignalEvent>
+     */
+    public function getAllSignals(): array
+    {
+        return $this->signals;
+    }
+
+    /**
+     * @return array<int, OutputWorkflowSignalEvent>
+     */
+    public function getSignalsByName(string $name): array
+    {
+        return array_values(
+            array_filter($this->signals, static function (OutputWorkflowSignalEvent $signal) use ($name) {
+                return $signal->getName() === $name;
+            })
+        );
+    }
+}

src/FormBuilderBundle/EventSubscriber/OutputWorkflowSignalSubscriber.php

@@ -0,0 +1,28 @@
+<?php declare(strict_types=1);
+
+namespace FormBuilderBundle\EventSubscriber;
+
+use FormBuilderBundle\Event\OutputWorkflow\OutputWorkflowSignalEvent;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+class OutputWorkflowSignalSubscriber implements EventSubscriberInterface
+{
+    protected array $signals = [];
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            OutputWorkflowSignalEvent::NAME => 'addSignal',
+        ];
+    }
+
+    public function addSignal(OutputWorkflowSignalEvent $signalEvent): void
+    {
+        $this->signals[] = $signalEvent;
+    }
+
+    public function getSignals(): array
+    {
+        return $this->signals;
+    }
+}

src/FormBuilderBundle/Form/Data/FormData.php

@@ -3,6 +3,7 @@
 namespace FormBuilderBundle\Form\Data;
 
 use FormBuilderBundle\Model\FormDefinitionInterface;
+use FormBuilderBundle\Stream\File;
 
 class FormData implements FormDataInterface
 {
@@ -32,12 +33,16 @@ public function hasAttachments(): bool
 
     public function getAttachments(): array
     {
-        return $this->attachments;
+        return array_values($this->attachments);
     }
 
-    public function addAttachment(array $attachmentFileInfo): void
+    public function addAttachment(File $attachmentFile): void
     {
-        $this->attachments[] = $attachmentFileInfo;
+        if (array_key_exists($attachmentFile->getId(), $this->attachments)) {
+            return;
+        }
+
+        $this->attachments[$attachmentFile->getId()] = $attachmentFile;
     }
 
     public function getFieldValue(string $name): mixed

src/FormBuilderBundle/Form/Data/FormDataInterface.php

@@ -3,6 +3,7 @@
 namespace FormBuilderBundle\Form\Data;
 
 use FormBuilderBundle\Model\FormDefinitionInterface;
+use FormBuilderBundle\Stream\File;
 
 interface FormDataInterface
 {
@@ -16,7 +17,10 @@ public function setFieldValue(string $name, mixed $value);
 
     public function hasAttachments(): bool;
 
+    /**
+     * @return array<int, File>
+     */
     public function getAttachments(): array;
 
-    public function addAttachment(array $attachmentFileInfo): void;
+    public function addAttachment(File $attachmentFile): void;
 }

src/FormBuilderBundle/FormBuilderEvents.php

@@ -52,4 +52,9 @@ final class FormBuilderEvents
      * @see \FormBuilderBundle\Event\OutputWorkflow\ChannelSubjectGuardEvent
      */
     public const OUTPUT_WORKFLOW_GUARD_SUBJECT_PRE_DISPATCH = 'form_builder.output_workflow.guard.subject.pre_dispatch';
+
+    /**
+     * @see \FormBuilderBundle\Event\OutputWorkflow\OutputWorkflowSignalsEvent
+     */
+    public const OUTPUT_WORKFLOW_SIGNALS = 'form_builder.output_workflow.signals';
 }

src/FormBuilderBundle/OutputWorkflow/Channel/Email/EmailOutputChannel.php

@@ -28,11 +28,10 @@ public function isLocalizedConfiguration(): bool
         return true;
     }
 
-    /**
-     * Currently unsupported for EmailOutputChanel.
-     */
     public function getUsedFormFieldNames(array $channelConfiguration): array
     {
+        // Unsupported for EmailOutputChanel
+
         return [];
     }
 

src/FormBuilderBundle/OutputWorkflow/Channel/Email/Parser/MailParser.php

@@ -2,33 +2,30 @@
 
 namespace FormBuilderBundle\OutputWorkflow\Channel\Email\Parser;
 
+use FormBuilderBundle\Stream\File;
 use Pimcore\Mail;
 use Pimcore\Model\Document\Email;
 use Symfony\Component\Form\FormInterface;
 use Symfony\Component\Templating\EngineInterface;
 use FormBuilderBundle\Form\Data\FormDataInterface;
 use FormBuilderBundle\Form\FormValuesOutputApplierInterface;
 use FormBuilderBundle\MailEditor\Parser\PlaceholderParserInterface;
-use FormBuilderBundle\Stream\AttachmentStreamInterface;
 
 class MailParser
 {
     protected EngineInterface $templating;
     protected Email $mailTemplate;
     protected FormValuesOutputApplierInterface $formValuesOutputApplier;
     protected PlaceholderParserInterface $placeholderParser;
-    protected AttachmentStreamInterface $attachmentStream;
 
     public function __construct(
         EngineInterface $templating,
         FormValuesOutputApplierInterface $formValuesOutputApplier,
-        PlaceholderParserInterface $placeholderParser,
-        AttachmentStreamInterface $attachmentStream
+        PlaceholderParserInterface $placeholderParser
     ) {
         $this->templating = $templating;
         $this->formValuesOutputApplier = $formValuesOutputApplier;
         $this->placeholderParser = $placeholderParser;
-        $this->attachmentStream = $attachmentStream;
     }
 
     /**
@@ -154,14 +151,13 @@ protected function setMailBodyPlaceholder(Mail $mail, FormInterface $form, array
 
     protected function parseMailAttachment(Mail $mail, array $attachments): void
     {
-        foreach ($attachments as $attachmentFileInfo) {
+        /** @var File $attachmentFile */
+        foreach ($attachments as $attachmentFile) {
             try {
-                $mail->attach(file_get_contents($attachmentFileInfo['path']), $attachmentFileInfo['name']);
+                $mail->attach(file_get_contents($attachmentFile->getPath()), $attachmentFile->getName());
             } catch (\Exception $e) {
                 // fail silently.
             }
-
-            $this->attachmentStream->removeAttachmentByFileInfo($attachmentFileInfo);
         }
     }
 

src/FormBuilderBundle/OutputWorkflow/OutputWorkflowDispatcher.php

@@ -3,23 +3,33 @@
 namespace FormBuilderBundle\OutputWorkflow;
 
 use FormBuilderBundle\Event\SubmissionEvent;
+use FormBuilderBundle\Event\OutputWorkflow\OutputWorkflowSignalsEvent;
+use FormBuilderBundle\EventSubscriber\OutputWorkflowSignalSubscriber;
 use FormBuilderBundle\Exception\OutputWorkflow\GuardChannelException;
 use FormBuilderBundle\Exception\OutputWorkflow\GuardOutputWorkflowException;
 use FormBuilderBundle\Exception\OutputWorkflow\GuardStackedException;
+use FormBuilderBundle\FormBuilderEvents;
 use FormBuilderBundle\Model\OutputWorkflowInterface;
 use FormBuilderBundle\Registry\OutputWorkflowChannelRegistry;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 
 class OutputWorkflowDispatcher implements OutputWorkflowDispatcherInterface
 {
+    protected EventDispatcherInterface $eventDispatcher;
     protected OutputWorkflowChannelRegistry $channelRegistry;
+    protected OutputWorkflowSignalSubscriber $subscriber;
 
-    public function __construct(OutputWorkflowChannelRegistry $channelRegistry)
+    public function __construct(EventDispatcherInterface $eventDispatcher, OutputWorkflowChannelRegistry $channelRegistry)
     {
+        $this->eventDispatcher = $eventDispatcher;
         $this->channelRegistry = $channelRegistry;
     }
 
     public function dispatch(OutputWorkflowInterface $outputWorkflow, SubmissionEvent $submissionEvent): void
     {
+        $this->subscriber = new OutputWorkflowSignalSubscriber();
+        $this->eventDispatcher->addSubscriber($this->subscriber);
+
         $exceptionStack = [];
         foreach ($outputWorkflow->getChannels() as $index => $channel) {
             try {
@@ -28,8 +38,15 @@ public function dispatch(OutputWorkflowInterface $outputWorkflow, SubmissionEven
             } catch (GuardChannelException $e) {
                 $exceptionStack[] = $e;
             } catch (GuardOutputWorkflowException $e) {
+
+                $this->dispatchSignalsEvent($e);
+
                 throw $e;
+
             } catch (\Throwable $e) {
+
+                $this->dispatchSignalsEvent($e);
+
                 throw new \Exception(
                     sprintf(
                         '"%s" workflow channel "%s" errored at step %d: %s',
@@ -43,7 +60,20 @@ public function dispatch(OutputWorkflowInterface $outputWorkflow, SubmissionEven
         }
 
         if (count($exceptionStack) > 0) {
-            throw new GuardStackedException($exceptionStack);
+
+            $exception = new GuardStackedException($exceptionStack);
+            $this->dispatchSignalsEvent($exception);
+
+            throw $exception;
         }
+
+        $this->dispatchSignalsEvent();
+    }
+
+    protected function dispatchSignalsEvent(?\Exception $exception = null): void
+    {
+        $signals = $this->subscriber->getSignals();
+        $this->eventDispatcher->removeSubscriber($this->subscriber);
+        $this->eventDispatcher->dispatch(new OutputWorkflowSignalsEvent($signals, $exception), FormBuilderEvents::OUTPUT_WORKFLOW_SIGNALS);
     }
 }