ENGCOM-5818: GraphQl-220: Implement exception logging #355

Author: lenaorobei

app/etc/graphql/di.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
+    <preference for="Magento\Framework\GraphQl\Query\ErrorHandlerInterface" type="Magento\Framework\GraphQl\Query\ErrorHandler"/>
+</config>

lib/internal/Magento/Framework/GraphQl/Query/ErrorHandler.php

@@ -0,0 +1,48 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Framework\GraphQl\Query;
+
+use GraphQL\Error\ClientAware;
+use Psr\Log\LoggerInterface;
+
+/**
+ * @inheritDoc
+ *
+ * @package Magento\Framework\GraphQl\Query
+ */
+class ErrorHandler implements ErrorHandlerInterface
+{
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    /**
+     * @param LoggerInterface $logger
+     */
+    public function __construct(
+        LoggerInterface $logger
+    ) {
+        $this->logger = $logger;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function handle(array $errors, callable $formatter): array
+    {
+        return array_map(
+            function (ClientAware $error) use ($formatter) {
+                $this->logger->error($error);
+
+                return $formatter($error);
+            },
+            $errors
+        );
+    }
+}

lib/internal/Magento/Framework/GraphQl/Query/ErrorHandlerInterface.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Framework\GraphQl\Query;
+
+use GraphQL\Error\Error;
+
+/**
+ * Interface ErrorHandlerInterface
+ *
+ * GraphQL error handler
+ *
+ * @see \Magento\Framework\GraphQl\Query\QueryProcessor
+ *
+ * @api
+ */
+interface ErrorHandlerInterface
+{
+    /**
+     * Handle errors
+     *
+     * @param Error[] $errors
+     * @param callable $formatter
+     *
+     * @return array
+     */
+    public function handle(array $errors, callable $formatter): array;
+}

lib/internal/Magento/Framework/GraphQl/Query/QueryProcessor.php

@@ -8,8 +8,8 @@
 namespace Magento\Framework\GraphQl\Query;
 
 use Magento\Framework\GraphQl\Exception\ExceptionFormatter;
-use Magento\Framework\GraphQl\Schema;
 use Magento\Framework\GraphQl\Query\Resolver\ContextInterface;
+use Magento\Framework\GraphQl\Schema;
 
 /**
  * Wrapper for GraphQl execution of a schema
@@ -27,15 +27,25 @@ class QueryProcessor
     private $queryComplexityLimiter;
 
     /**
-     * @param ExceptionFormatter $exceptionFormatter
-     * @param QueryComplexityLimiter $queryComplexityLimiter
+     * @var \Magento\Framework\GraphQl\Query\ErrorHandlerInterface
+     */
+    private $errorHandler;
+
+    /**
+     * @param ExceptionFormatter                                     $exceptionFormatter
+     * @param QueryComplexityLimiter                                 $queryComplexityLimiter
+     *
+     * @param \Magento\Framework\GraphQl\Query\ErrorHandlerInterface $errorHandler
+     * @SuppressWarnings(PHPMD.LongVariable)
      */
     public function __construct(
         ExceptionFormatter $exceptionFormatter,
-        QueryComplexityLimiter $queryComplexityLimiter
+        QueryComplexityLimiter $queryComplexityLimiter,
+        ErrorHandlerInterface $errorHandler
     ) {
         $this->exceptionFormatter = $exceptionFormatter;
         $this->queryComplexityLimiter = $queryComplexityLimiter;
+        $this->errorHandler = $errorHandler;
     }
 
     /**
@@ -67,6 +77,8 @@ public function process(
             $contextValue,
             $variableValues,
             $operationName
+        )->setErrorsHandler(
+            [$this->errorHandler, 'handle']
         )->toArray(
             $this->exceptionFormatter->shouldShowDetail() ?
                 \GraphQL\Error\Debug::INCLUDE_DEBUG_MESSAGE : false