AddMercureTokenListener::onKernelResponse() - Code Metrics - Inspection of "feat: publish updates to mercure when we clear cac..." - components-web-app/api-components-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — main (#152)

by Daniel

created 2022-10-24 12:22 UTC

AddMercureTokenListener::onKernelResponse() B

↳ Parent: AddMercureTokenListener

Complexity

Conditions	8
Paths	8

Size

Total Lines	52
Code Lines	28

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
cc	8
eloc	28
nc	8
nop	1
dl	0
loc	52
rs	8.4444
c	1
b	1
f	0

How to fix Long Method

<?php

/*
 * This file is part of the Silverback API Components Bundle Project
 *
 * (c) Daniel West <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Silverback\ApiComponentsBundle\EventListener\Mercure;

use ApiPlatform\Exception\OperationNotFoundException;
use ApiPlatform\Metadata\HttpOperation;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
use ApiPlatform\Util\CorsTrait;
use Silverback\ApiComponentsBundle\Annotation\Publishable;
use Silverback\ApiComponentsBundle\Helper\Publishable\PublishableStatusChecker;
use Symfony\Component\HttpFoundation\Cookie;
use Symfony\Component\HttpKernel\Event\ResponseEvent;
use Symfony\Component\Mercure\Jwt\TokenFactoryInterface;
use Symfony\Component\Routing\RequestContext;

class AddMercureTokenListener
{
    use CorsTrait;


    public function __construct(private TokenFactoryInterface $tokenFactory, private ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, private ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, private PublishableStatusChecker $publishableStatusChecker, private RequestContext $requestContext)
    {
    }

    /**
     * Sends the Mercure header on each response.
     * Probably lock this on the "/me" route.
     */
    public function onKernelResponse(ResponseEvent $event): void
    {
        $request = $event->getRequest();
        // Prevent issues with NelmioCorsBundle
        if ($this->isPreflightRequest($request)) {
            return;
        }

        $subscribeIris = [];
        $response = $event->getResponse();

        foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
            $resourceMetadataCollection = $this->resourceMetadataCollectionFactory->create($resourceClass);

            try {
                $operation = $resourceMetadataCollection->getOperation(forceCollection: false, httpOperation: true);
            } catch (OperationNotFoundException $e) {
                continue;
            }

            if (!$operation instanceof HttpOperation) {
                continue;
            }

            $mercure = $operation->getMercure();

            if (!$mercure) {
                continue;
            }

            $refl = new \ReflectionClass($operation->getClass());
            $isPublishable = \count($refl->getAttributes(Publishable::class));

            // TODO: the str_replace thing should be fixed inside API Platform (will be available in next patch)
            $uriTemplate = $this->buildAbsoluteUriTemplate() . $operation->getRoutePrefix() . str_replace('.{_format}', '{._format}', $operation->getUriTemplate());

            if (!$isPublishable) {
                $subscribeIris[] = $uriTemplate;
                continue;
            }

            // Note that `?draft=1` is also hard coded into the PublishableIriConverter, probably make this configurable somewhere
            if ($this->publishableStatusChecker->isGranted($operation->getClass())) {
                $subscribeIris[] = $uriTemplate . '?draft=1';
                $subscribeIris[] = $uriTemplate;
                continue;
            }

            $subscribeIris[] = $uriTemplate;
        }

        $response->headers->setCookie(Cookie::create('mercureAuthorization', $this->tokenFactory->create($subscribeIris, [])));
    }

    /**
     * Mercure subscribe iris should be absolute
     * this code can also be found in Symfony's URL Generator
     * but as we work without a symfony route here (and we would not want to do this as its not spec-compliant)
     * we do it by hand.
     */
    private function buildAbsoluteUriTemplate(): string
    {
        $scheme = $this->requestContext->getScheme();
        $host = $this->requestContext->getHost();
        $port = $this->requestContext->isSecure() ? $this->requestContext->getHttpsPort() : $this->requestContext->getHttpPort();

        if (80 !== $port || 443 !== $port) {
            return sprintf('%s://%s:%d', $scheme, $host, $port);
        }

        return sprintf('%s://%s', $scheme, $host);
    }
}


1			<?php
2
3			/*
4			* This file is part of the Silverback API Components Bundle Project
5			*
6			* (c) Daniel West <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			declare(strict_types=1);
13
14			namespace Silverback\ApiComponentsBundle\EventListener\Mercure;
15
16			use ApiPlatform\Exception\OperationNotFoundException;
17			use ApiPlatform\Metadata\HttpOperation;
18			use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
19			use ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
20			use ApiPlatform\Util\CorsTrait;
21			use Silverback\ApiComponentsBundle\Annotation\Publishable;
22			use Silverback\ApiComponentsBundle\Helper\Publishable\PublishableStatusChecker;
23			use Symfony\Component\HttpFoundation\Cookie;
24			use Symfony\Component\HttpKernel\Event\ResponseEvent;
25			use Symfony\Component\Mercure\Jwt\TokenFactoryInterface;
26			use Symfony\Component\Routing\RequestContext;
27
28			class AddMercureTokenListener
29			{
30			use CorsTrait;
			0 ignored issues – show Bug introduced 2022-10-21 11:30 UTC by Report Bug Copy Issue Report The trait `ApiPlatform\Util\CorsTrait` requires the property `$headers` which is not provided by `Silverback\ApiComponents...AddMercureTokenListener`. Loading history...
31
32			public function __construct(private TokenFactoryInterface $tokenFactory, private ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, private ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, private PublishableStatusChecker $publishableStatusChecker, private RequestContext $requestContext)
33			{
34			}
35
36			/**
37			* Sends the Mercure header on each response.
38			* Probably lock this on the "/me" route.
39			*/
40			public function onKernelResponse(ResponseEvent $event): void
41			{
42			$request = $event->getRequest();
43			// Prevent issues with NelmioCorsBundle
44			if ($this->isPreflightRequest($request)) {
45			return;
46			}
47
48			$subscribeIris = [];
49			$response = $event->getResponse();
50
51			foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
52			$resourceMetadataCollection = $this->resourceMetadataCollectionFactory->create($resourceClass);
53
54			try {
55			$operation = $resourceMetadataCollection->getOperation(forceCollection: false, httpOperation: true);
56			} catch (OperationNotFoundException $e) {
57			continue;
58			}
59
60			if (!$operation instanceof HttpOperation) {
61			continue;
62			}
63
64			$mercure = $operation->getMercure();
65
66			if (!$mercure) {
67			continue;
68			}
69
70			$refl = new \ReflectionClass($operation->getClass());
71			$isPublishable = \count($refl->getAttributes(Publishable::class));
72
73			// TODO: the str_replace thing should be fixed inside API Platform (will be available in next patch)
74			$uriTemplate = $this->buildAbsoluteUriTemplate() . $operation->getRoutePrefix() . str_replace('.{_format}', '{._format}', $operation->getUriTemplate());
75
76			if (!$isPublishable) {
77			$subscribeIris[] = $uriTemplate;
78			continue;
79			}
80
81			// Note that `?draft=1` is also hard coded into the PublishableIriConverter, probably make this configurable somewhere
82			if ($this->publishableStatusChecker->isGranted($operation->getClass())) {
83			$subscribeIris[] = $uriTemplate . '?draft=1';
84			$subscribeIris[] = $uriTemplate;
85			continue;
86			}
87
88			$subscribeIris[] = $uriTemplate;
89			}
90
91			$response->headers->setCookie(Cookie::create('mercureAuthorization', $this->tokenFactory->create($subscribeIris, [])));
92			}
93
94			/**
95			* Mercure subscribe iris should be absolute
96			* this code can also be found in Symfony's URL Generator
97			* but as we work without a symfony route here (and we would not want to do this as its not spec-compliant)
98			* we do it by hand.
99			*/
100			private function buildAbsoluteUriTemplate(): string
101			{
102			$scheme = $this->requestContext->getScheme();
103			$host = $this->requestContext->getHost();
104			$port = $this->requestContext->isSecure() ? $this->requestContext->getHttpsPort() : $this->requestContext->getHttpPort();
105
106			if (80 !== $port \|\| 443 !== $port) {
107			return sprintf('%s://%s:%d', $scheme, $host, $port);
108			}
109
110			return sprintf('%s://%s', $scheme, $host);
111			}
112			}
113

components-web-app / api-components-bundle

Pull Request — main (#152)

AddMercureTokenListener::onKernelResponse() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like