Endpoint::logError() - Code Metrics - Inspection of "Add a test for psr17 factory autodetection" - usox/json-schema-api - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( d2741b...430ca3 )

by Daniel

created 2022-01-18 20:31 UTC

Endpoint::logError() A

↳ Parent: Endpoint

Complexity

Conditions	1
Paths	1

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	6
nc	1
nop	3
dl	0
loc	12
ccs	7
cts	7
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Usox\JsonSchemaApi;

use Http\Discovery\Psr17FactoryDiscovery;
use Opis\JsonSchema\Errors\ErrorFormatter;
use Opis\JsonSchema\Validator;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\StreamFactoryInterface;
use Psr\Http\Server\RequestHandlerInterface;
use Psr\Log\LoggerInterface;
use Ramsey\Uuid\UuidFactory;
use Ramsey\Uuid\UuidFactoryInterface;
use Ramsey\Uuid\UuidInterface;
use Teapot\StatusCode;
use Throwable;
use Usox\JsonSchemaApi\Contract\MethodProviderInterface;
use Usox\JsonSchemaApi\Exception\ApiException;
use Usox\JsonSchemaApi\Exception\InternalException;
use Usox\JsonSchemaApi\Dispatch\MethodDispatcher;
use Usox\JsonSchemaApi\Dispatch\MethodDispatcherInterface;
use Usox\JsonSchemaApi\Dispatch\MethodValidator;
use Usox\JsonSchemaApi\Dispatch\RequestValidator;
use Usox\JsonSchemaApi\Dispatch\RequestValidatorInterface;
use Usox\JsonSchemaApi\Dispatch\SchemaLoader;
use Usox\JsonSchemaApi\Response\ResponseBuilder;
use Usox\JsonSchemaApi\Response\ResponseBuilderInterface;

/**
 * @see Endpoint::factory()
 */
final class Endpoint implements
    EndpointInterface
{
    public function __construct(
        private RequestValidatorInterface $inputValidator,
        private MethodDispatcherInterface $methodRetriever,
        private ResponseBuilderInterface $responseBuilder,
        private UuidFactoryInterface $uuidFactory,
        private StreamFactoryInterface $streamFactory,
        private ?LoggerInterface $logger = null
    ) {
    }

    /**
     * Try to execute the api handler and build the response
     */
    public function serve(
        ServerRequestInterface $request,
        ResponseInterface $response
    ): ResponseInterface {
        $statusCode = StatusCode::OK;
        $responseData = null;


        try {
            // Process and build the response
            $responseData = $this->responseBuilder->buildResponse(
                $this->methodRetriever->dispatch(
                    $request,
                    $this->inputValidator->validate($request)
                )
            );
        } catch (ApiException $e) {
            $uuid = $this->uuidFactory->uuid4();

            $this->logError($e, $uuid);

            // Build an error response
            $responseData = $this->responseBuilder->buildErrorResponse($e, $uuid);

            $statusCode = StatusCode::BAD_REQUEST;
        } catch (InternalException $e) {
            $this->logError(
                $e,
                $this->uuidFactory->uuid4(),
                $e->getContext()
            );

            $statusCode = StatusCode::INTERNAL_SERVER_ERROR;
        } catch (Throwable $e) {
            $this->logError(
                $e,
                $this->uuidFactory->uuid4()
            );

            $statusCode = StatusCode::INTERNAL_SERVER_ERROR;
        }

        if ($responseData !== null) {

            $response = $response->withBody(
                $this->streamFactory->createStream(
                    (string) json_encode($responseData)
                )
            );
        }

        return $response
            ->withHeader('Content-Type', 'application/json')
            ->withStatus($statusCode);
    }

    /**
     * @param array<mixed, mixed> $context
     */
    private function logError(
        Throwable $e,
        UuidInterface $uuid,
        array $context = []
    ): void {
        $this->logger?->error(
            sprintf('%s (%d)', $e->getMessage(), $e->getCode()),
            [
                'id' => $uuid->toString(),
                'file' => $e->getFile(),
                'line' => $e->getLine(),
                'context' => $context
            ]
        );
    }

    /**
     * Builds the endpoint.
     * The StreamFactory may be omitted, the endpoint will try to autodetect
     * an existing PSR17 implementations
     */
    public static function factory(
        MethodProviderInterface $methodProvider,
        ?StreamFactoryInterface $streamFactory = null,
        ?LoggerInterface $logger = null
    ): EndpointInterface {
        $schemaValidator = new Validator();
        $schemaLoader = new SchemaLoader();

        if ($streamFactory === null) {
            $streamFactory = Psr17FactoryDiscovery::findStreamFactory();
        }

        return new self(
            new RequestValidator(
                $schemaLoader,
                $schemaValidator
            ),
            new MethodDispatcher(
                $schemaLoader,
                new MethodValidator(
                    $schemaValidator,
                    new ErrorFormatter()
                ),
                $methodProvider,
                $logger,
            ),
            new ResponseBuilder(),
            new UuidFactory(),
            $streamFactory,
            $logger
        );
    }

    public function process(
        ServerRequestInterface $request,
        RequestHandlerInterface $handler
    ): ResponseInterface {
        return $this->serve(
            $request,
            $handler->handle($request)
        );
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Usox\JsonSchemaApi;
6
7		use Http\Discovery\Psr17FactoryDiscovery;
8		use Opis\JsonSchema\Errors\ErrorFormatter;
9		use Opis\JsonSchema\Validator;
10		use Psr\Http\Message\ResponseInterface;
11		use Psr\Http\Message\ServerRequestInterface;
12		use Psr\Http\Message\StreamFactoryInterface;
13		use Psr\Http\Server\RequestHandlerInterface;
14		use Psr\Log\LoggerInterface;
15		use Ramsey\Uuid\UuidFactory;
16		use Ramsey\Uuid\UuidFactoryInterface;
17		use Ramsey\Uuid\UuidInterface;
18		use Teapot\StatusCode;
19		use Throwable;
20		use Usox\JsonSchemaApi\Contract\MethodProviderInterface;
21		use Usox\JsonSchemaApi\Exception\ApiException;
22		use Usox\JsonSchemaApi\Exception\InternalException;
23		use Usox\JsonSchemaApi\Dispatch\MethodDispatcher;
24		use Usox\JsonSchemaApi\Dispatch\MethodDispatcherInterface;
25		use Usox\JsonSchemaApi\Dispatch\MethodValidator;
26		use Usox\JsonSchemaApi\Dispatch\RequestValidator;
27		use Usox\JsonSchemaApi\Dispatch\RequestValidatorInterface;
28		use Usox\JsonSchemaApi\Dispatch\SchemaLoader;
29		use Usox\JsonSchemaApi\Response\ResponseBuilder;
30		use Usox\JsonSchemaApi\Response\ResponseBuilderInterface;
31
32		/**
33		* @see Endpoint::factory()
34		*/
35		final class Endpoint implements
36		EndpointInterface
37		{
38	8	public function __construct(
39		private RequestValidatorInterface $inputValidator,
40		private MethodDispatcherInterface $methodRetriever,
41		private ResponseBuilderInterface $responseBuilder,
42		private UuidFactoryInterface $uuidFactory,
43		private StreamFactoryInterface $streamFactory,
44		private ?LoggerInterface $logger = null
45		) {
46	8	}
47
48		/**
49		* Try to execute the api handler and build the response
50		*/
51	6	public function serve(
52		ServerRequestInterface $request,
53		ResponseInterface $response
54		): ResponseInterface {
55	6	$statusCode = StatusCode::OK;
56	6	$responseData = null;
		0 ignored issues – show Unused Code introduced 2021-11-04 17:11 UTC by Report Bug Copy Issue Report The assignment to `$responseData` is dead and can be removed. Loading history...
57
58		try {
59		// Process and build the response
60	6	$responseData = $this->responseBuilder->buildResponse(
61	6	$this->methodRetriever->dispatch(
62	6	$request,
63	6	$this->inputValidator->validate($request)
64		)
65		);
66	4	} catch (ApiException $e) {
67	2	$uuid = $this->uuidFactory->uuid4();
68
69	2	$this->logError($e, $uuid);
70
71		// Build an error response
72	2	$responseData = $this->responseBuilder->buildErrorResponse($e, $uuid);
73
74	2	$statusCode = StatusCode::BAD_REQUEST;
75	2	} catch (InternalException $e) {
76	1	$this->logError(
77	1	$e,
78	1	$this->uuidFactory->uuid4(),
79	1	$e->getContext()
80		);
81
82	1	$statusCode = StatusCode::INTERNAL_SERVER_ERROR;
83	1	} catch (Throwable $e) {
84	1	$this->logError(
85	1	$e,
86	1	$this->uuidFactory->uuid4()
87		);
88
89	1	$statusCode = StatusCode::INTERNAL_SERVER_ERROR;
90		}
91
92	6	if ($responseData !== null) {
		0 ignored issues – show introduced 2021-11-04 17:11 UTC by Report Bug Copy Issue Report The condition `$responseData !== null` is always `true`. Loading history...
93	4	$response = $response->withBody(
94	4	$this->streamFactory->createStream(
95	4	(string) json_encode($responseData)
96		)
97		);
98		}
99
100		return $response
101	6	->withHeader('Content-Type', 'application/json')
102	6	->withStatus($statusCode);
103		}
104
105		/**
106		* @param array<mixed, mixed> $context
107		*/
108	4	private function logError(
109		Throwable $e,
110		UuidInterface $uuid,
111		array $context = []
112		): void {
113	4	$this->logger?->error(
114	4	sprintf('%s (%d)', $e->getMessage(), $e->getCode()),
115		[
116	4	'id' => $uuid->toString(),
117	4	'file' => $e->getFile(),
118	4	'line' => $e->getLine(),
119	4	'context' => $context
120		]
121		);
122	4	}
123
124		/**
125		* Builds the endpoint.
126		* The StreamFactory may be omitted, the endpoint will try to autodetect
127		* an existing PSR17 implementations
128		*/
129	2	public static function factory(
130		MethodProviderInterface $methodProvider,
131		?StreamFactoryInterface $streamFactory = null,
132		?LoggerInterface $logger = null
133		): EndpointInterface {
134	2	$schemaValidator = new Validator();
135	2	$schemaLoader = new SchemaLoader();
136
137	2	if ($streamFactory === null) {
138	1	$streamFactory = Psr17FactoryDiscovery::findStreamFactory();
139		}
140
141	2	return new self(
142	2	new RequestValidator(
143	2	$schemaLoader,
144		$schemaValidator
145		),
146	2	new MethodDispatcher(
147	2	$schemaLoader,
148	2	new MethodValidator(
149	2	$schemaValidator,
150	2	new ErrorFormatter()
151		),
152		$methodProvider,
153		$logger,
154		),
155	2	new ResponseBuilder(),
156	2	new UuidFactory(),
157		$streamFactory,
158		$logger
159		);
160		}
161
162	1	public function process(
163		ServerRequestInterface $request,
164		RequestHandlerInterface $handler
165		): ResponseInterface {
166	1	return $this->serve(
167	1	$request,
168	1	$handler->handle($request)
169		);
170		}
171		}
172

usox / json-schema-api

Push — master ( d2741b...430ca3 )

Endpoint::logError() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like