Merge pull request #44 from Flowpack/task/neosUiExceptionHandling

TASK: Known exceptions are logged to the Neos.Ui and caught

Author: Sebobo

Classes/NodeCreationHandler/TemplateNodeCreationHandler.php

@@ -2,13 +2,16 @@
 
 namespace Flowpack\NodeTemplates\NodeCreationHandler;
 
-use Neos\Flow\Annotations as Flow;
+use Flowpack\NodeTemplates\Service\EelException;
 use Flowpack\NodeTemplates\Template;
 use Neos\ContentRepository\Domain\Model\NodeInterface;
+use Neos\ContentRepository\Exception\NodeConstraintException;
+use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Property\PropertyMapper;
+use Neos\Neos\Ui\Domain\Model\Feedback\Messages\Error;
+use Neos\Neos\Ui\Domain\Model\FeedbackCollection;
 use Neos\Neos\Ui\NodeCreationHandler\NodeCreationHandlerInterface;
 
-
 class TemplateNodeCreationHandler implements NodeCreationHandlerInterface
 {
     /**
@@ -23,6 +26,12 @@ class TemplateNodeCreationHandler implements NodeCreationHandlerInterface
      */
     protected $nodeCreationDepth;
 
+    /**
+     * @var FeedbackCollection
+     * @Flow\Inject
+     */
+    protected $feedbackCollection;
+
     /**
      * Create child nodes and change properties upon node creation
      *
@@ -47,13 +56,74 @@ public function handle(NodeInterface $node, array $data): void
         }
 
         /** @var Template $template */
-        $template = $this->propertyMapper->convert($templateConfiguration, Template::class,
-            $propertyMappingConfiguration);
+        $template = $this->propertyMapper->convert(
+            $templateConfiguration,
+            Template::class,
+            $propertyMappingConfiguration
+        );
 
         $context = [
             'data' => $data,
             'triggeringNode' => $node,
         ];
-        $template->apply($node, $context);
+
+        try {
+            $template->apply($node, $context);
+        } catch (\Exception $exception) {
+            $this->handleExceptions($node, $exception);
+        }
+    }
+
+    /**
+     * Known exceptions are logged to the Neos.Ui and caught
+     *
+     * @param NodeInterface $node the newly created node
+     * @param \Exception $exception the exception to handle
+     * @throws \Exception in case the exception is unknown and cant be handled
+     */
+    private function handleExceptions(NodeInterface $node, \Exception $exception): void
+    {
+        $nodeTemplateError = new Error();
+        $nodeTemplateError->setMessage(sprintf('Template for "%s" only partially applied. Please check the newly created nodes.', $node->getNodeType()->getLabel()));
+
+        if ($exception instanceof NodeConstraintException) {
+            $this->feedbackCollection->add(
+                $nodeTemplateError
+            );
+
+            $error = new Error();
+            $error->setMessage($exception->getMessage());
+            $this->feedbackCollection->add(
+                $error
+            );
+            return;
+        }
+        if ($exception instanceof EelException) {
+            $this->feedbackCollection->add(
+                $nodeTemplateError
+            );
+
+            $error = new Error();
+            $error->setMessage(
+                $exception->getMessage()
+            );
+            $this->feedbackCollection->add(
+                $error
+            );
+
+            $level = 0;
+            while (($exception = $exception->getPrevious()) && $level <= 8) {
+                $level++;
+                $error = new Error();
+                $error->setMessage(
+                    sprintf('%s [%s(%s)]', $exception->getMessage(), get_class($exception), $exception->getCode())
+                );
+                $this->feedbackCollection->add(
+                    $error
+                );
+            }
+            return;
+        }
+        throw $exception;
     }
 }

Classes/Service/EelEvaluationService.php

@@ -44,9 +44,9 @@ public function evaluateEelExpression(string $expression, array $contextVariable
         try {
             return EelUtility::evaluateEelExpression($expression, $this->eelEvaluator, $contextVariables);
         } catch (ParserException $parserException) {
-            throw new \RuntimeException('EEL Expression in NodeType template could not be parsed.', 1684788574212, $parserException);
+            throw new EelException('EEL Expression in NodeType template could not be parsed.', 1684788574212, $parserException);
         } catch (\Exception $exception) {
-            throw new \RuntimeException(sprintf('EEL Expression "%s" in NodeType template caused an error.', $expression), 1684761760723, $exception);
+            throw new EelException(sprintf('EEL Expression "%s" in NodeType template caused an error.', $expression), 1684761760723, $exception);
         }
     }
 }

Classes/Service/EelException.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Flowpack\NodeTemplates\Service;
+
+class EelException extends \Exception
+{
+}