ExceptionFormatter.php 2.22 KB
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
declare(strict_types=1);

namespace Magento\Framework\GraphQl\Exception;

use Magento\Framework\App\State;
use Magento\Framework\Webapi\ErrorProcessor;
use Psr\Log\LoggerInterface;

/**
 * Wrapper for GraphQl Exception Formatter
 */
class ExceptionFormatter
{
    const HTTP_GRAPH_QL_SCHEMA_ERROR_STATUS = 500;

    /**
     * @var State
     */
    private $appState;

    /**
     * @var LoggerInterface
     */
    private $logger;

    /**
     * @param State $appState
     * @param ErrorProcessor $errorProcessor
     */
    public function __construct(State $appState, ErrorProcessor $errorProcessor, LoggerInterface $logger)
    {
        $this->appState = $appState;
        $errorProcessor->registerShutdownFunction();
        $this->logger = $logger;
    }

    /**
     * Format a GraphQL error from an exception by converting it to array to conform to GraphQL spec.
     *
     * This method only exposes exception message when exception implements ClientAware interface
     * (or when debug flags are passed).
     *
     * @param \Throwable $exception
     * @param string $internalErrorMessage
     * @return array
     * @throws \Throwable
     */
    public function create(\Throwable $exception, $internalErrorMessage = null) : array
    {
        if (!$this->shouldShowDetail()) {
            $reportId = uniqid("graph-ql-");
            $message = "Report ID: {$reportId}; Message: {$exception->getMessage()}";
            $code = $exception->getCode();
            $loggedException = new \Exception($message, $code, $exception);
            $this->logger->critical($loggedException);
        }

        return \GraphQL\Error\FormattedError::createFromException(
            $exception,
            $this->shouldShowDetail()
                ? \GraphQL\Error\Debug::INCLUDE_DEBUG_MESSAGE | \GraphQL\Error\Debug::INCLUDE_TRACE : false,
            $internalErrorMessage
        );
    }

    /**
     * Return true if detailed error message should be displayed to client, false otherwise.
     *
     * @return bool
     */
    public function shouldShowDetail() : bool
    {
        return $this->appState->getMode() === State::MODE_DEVELOPER;
    }
}