Add UserErrors to help sending multiple errors to user

Author: Jeremiah VALERIE

Error/ErrorHandler.php

@@ -44,30 +44,45 @@ public function __construct($internalErrorMessage = null, LoggerInterface $logge
      */
     private function getDefaultErrorHandler()
     {
-        return function (Error $error, $throwRawException) {
-            $rawException = $error->getPrevious();
-
-            if (null === $rawException) {
-                return $error;
-            }
-            if ($rawException instanceof UserError) {
-                return $error;
-            }
-
-            // if is a try catch exception wrapped in Error
-            if ($throwRawException) {
-                throw $rawException;
+        return function (array $errors, $throwRawException) {
+            $clean = [];
+
+            /** @var Error $error */
+            foreach($errors as $error) {
+                $rawException = $error->getPrevious();
+
+                // Parse error or user error
+                if (null === $rawException || $rawException instanceof UserError) {
+                    $clean[] = $error;
+                    continue;
+                }
+
+                // multiple errors
+                if ($rawException instanceof UserErrors) {
+                    $rawExceptions = $rawException;
+                    foreach($rawExceptions->getErrors() as $rawException) {
+                        $clean[] = Error::createLocatedError($rawException, $error->nodes);
+                    }
+                    continue;
+                }
+
+                // if is a try catch exception wrapped in Error
+                if ($throwRawException) {
+                    throw $rawException;
+                }
+
+                $this->logException($rawException);
+
+                $clean[] = new Error(
+                    $this->internalErrorMessage,
+                    $error->nodes,
+                    $rawException,
+                    $error->getSource(),
+                    $error->getPositions()
+                );
             }
 
-            $this->logException($rawException);
-
-            return new Error(
-                $this->internalErrorMessage,
-                $error->nodes,
-                $rawException,
-                $error->getSource(),
-                $error->getPositions()
-            );
+            return $clean;
         };
     }
 
@@ -101,8 +116,6 @@ public function setErrorHandler(callable $errorHandler)
 
     public function handleErrors(ExecutionResult $executionResult, $throwRawException = false)
     {
-        foreach ($executionResult->errors as $i => $error) {
-            $executionResult->errors[$i] = call_user_func_array($this->errorHandler, [$error, $throwRawException]);
-        }
+        $executionResult->errors = call_user_func_array($this->errorHandler, [$executionResult->errors, $throwRawException]);
     }
 }

Error/UserErrors.php

@@ -0,0 +1,64 @@
+<?php
+
+/*
+ * This file is part of the OverblogGraphQLBundle package.
+ *
+ * (c) Overblog <http://github.com/overblog/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Overblog\GraphQLBundle\Error;
+
+/**
+ * Class UserErrors.
+ */
+class UserErrors extends \Exception
+{
+    /**
+     * @var UserError[]
+     */
+    private $errors = [];
+
+    public function __construct(array $errors, $message = "", $code = 0, \Exception $previous = null)
+    {
+        $this->setErrors($errors);
+        parent::__construct($message, $code, $previous);
+    }
+
+    /**
+     * @param UserError[]|string[] $errors
+     */
+    public function setErrors(array $errors)
+    {
+        foreach ($errors as $error) {
+            $this->addError($error);
+        }
+    }
+
+    /**
+     * @param string|UserError $error
+     * @return                 $this
+     */
+    public function addError($error)
+    {
+        if (is_string($error)) {
+            $error = new UserError($error);
+        } elseif(!is_object($error) || !$error instanceof UserError) {
+            throw new \InvalidArgumentException('Error must be string or instance of Overblog\\GraphQLBundle\\Error\\UserError.');
+        }
+
+        $this->errors[] = $error;
+
+        return $this;
+    }
+
+    /**
+     * @return UserError[]
+     */
+    public function getErrors()
+    {
+        return $this->errors;
+    }
+}

Tests/Error/ErrorHandlerTest.php

@@ -15,6 +15,7 @@
 use GraphQL\Executor\ExecutionResult;
 use Overblog\GraphQLBundle\Error\ErrorHandler;
 use Overblog\GraphQLBundle\Error\UserError;
+use Overblog\GraphQLBundle\Error\UserErrors;
 
 class ErrorHandlerTest extends \PHPUnit_Framework_TestCase
 {
@@ -34,6 +35,7 @@ public function testMaskErrorWithThrowExceptionSetToFalse()
                 new Error('Error without wrapped exception'),
                 new Error('Error with wrapped exception', null, new \Exception('My Exception message')),
                 new Error('Error with wrapped user error', null, new UserError('My User Error')),
+                new Error('', null, new UserErrors(['My User Error 1', 'My User Error 2', new UserError('My User Error 3')])),
             ]
         );
 
@@ -51,6 +53,15 @@ public function testMaskErrorWithThrowExceptionSetToFalse()
                 [
                     'message' => 'Error with wrapped user error',
                 ],
+                [
+                    'message' => 'My User Error 1',
+                ],
+                [
+                    'message' => 'My User Error 2',
+                ],
+                [
+                    'message' => 'My User Error 3',
+                ],
             ],
         ];
 
@@ -129,7 +140,7 @@ public function testMaskErrorOverrideErrorHandle()
         );
 
         $this->errorHandler->setErrorHandler(function () {
-            return new Error('Override Error');
+            return [new Error('Override Error')];
         });
 
         $this->errorHandler->handleErrors($executionResult);