6250499992

Committed 20 Sep 2023 03:04PM UTC coverage: 36.863% (-0.2%) from 37.089%

Build # 6250499992

Build Type

push

github

Committed by

web-flow

Commit Message

fix: errors without compatibility flag (#5841)

Run Details

24 of 24 new or added lines in 8 files covered. (100.0%)

10081 of 27347 relevant lines covered (36.86%)

13.36 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

93.33

/src/Hydra/EventListener/AddLinkHeaderListener.php

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Hydra\EventListener;

use ApiPlatform\Api\UrlGeneratorInterface;
use ApiPlatform\JsonLd\ContextBuilder;
use ApiPlatform\State\Util\CorsTrait;
use Psr\Link\EvolvableLinkProviderInterface;
use Symfony\Component\HttpKernel\Event\ResponseEvent;
use Symfony\Component\WebLink\GenericLinkProvider;
use Symfony\Component\WebLink\Link;

/**
 * Adds the HTTP Link header pointing to the Hydra documentation.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
final class AddLinkHeaderListener
{
    use CorsTrait;

    public function __construct(private readonly UrlGeneratorInterface $urlGenerator)
    {
    }

    /**
     * Sends the Hydra header on each response.
     */
    public function onKernelResponse(ResponseEvent $event): void
    {
        $request = $event->getRequest();
        if (($operation = $request->attributes->get('_api_operation')) && 'api_platform.symfony.main_controller' === $operation->getController()) {
            return;
        }

        // Prevent issues with NelmioCorsBundle
        if ($this->isPreflightRequest($request)) {
            return;
        }

        $apiDocUrl = $this->urlGenerator->generate('api_doc', ['_format' => 'jsonld'], UrlGeneratorInterface::ABS_URL);
        $apiDocLink = new Link(ContextBuilder::HYDRA_NS.'apiDocumentation', $apiDocUrl);
        $linkProvider = $request->attributes->get('_api_platform_links', new GenericLinkProvider());

        if (!$linkProvider instanceof EvolvableLinkProviderInterface) {
            return;
        }

        foreach ($linkProvider->getLinks() as $link) {
            if ($link->getHref() === $apiDocUrl) {
                return;
            }
        }

        $request->attributes->set('_api_platform_links', $linkProvider->withLink($apiDocLink));
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
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 ApiPlatform\Hydra\EventListener;
15
16	use ApiPlatform\Api\UrlGeneratorInterface;
17	use ApiPlatform\JsonLd\ContextBuilder;
18	use ApiPlatform\State\Util\CorsTrait;
19	use Psr\Link\EvolvableLinkProviderInterface;
20	use Symfony\Component\HttpKernel\Event\ResponseEvent;
21	use Symfony\Component\WebLink\GenericLinkProvider;
22	use Symfony\Component\WebLink\Link;
23
24	/**
25	* Adds the HTTP Link header pointing to the Hydra documentation.
26	*
27	* @author Kévin Dunglas <dunglas@gmail.com>
28	*/
29	final class AddLinkHeaderListener
30	{
31	use CorsTrait;
32
33	public function __construct(private readonly UrlGeneratorInterface $urlGenerator)
34	{
35	}	78✔
36
37	/**
38	* Sends the Hydra header on each response.
39	*/
40	public function onKernelResponse(ResponseEvent $event): void
41	{
42	$request = $event->getRequest();	78✔
43	if (($operation = $request->attributes->get('_api_operation')) && 'api_platform.symfony.main_controller' === $operation->getController()) {	78✔
44	return;	28✔
45	}
46
47	// Prevent issues with NelmioCorsBundle
48	if ($this->isPreflightRequest($request)) {	54✔
49	return;	3✔
50	}
51
52	$apiDocUrl = $this->urlGenerator->generate('api_doc', ['_format' => 'jsonld'], UrlGeneratorInterface::ABS_URL);	51✔
53	$apiDocLink = new Link(ContextBuilder::HYDRA_NS.'apiDocumentation', $apiDocUrl);	51✔
54	$linkProvider = $request->attributes->get('_api_platform_links', new GenericLinkProvider());	51✔
55
56	if (!$linkProvider instanceof EvolvableLinkProviderInterface) {	51✔
57	return;	×
58	}
59
60	foreach ($linkProvider->getLinks() as $link) {	51✔
61	if ($link->getHref() === $apiDocUrl) {	30✔
62	return;	30✔
63	}
64	}
65
66	$request->attributes->set('_api_platform_links', $linkProvider->withLink($apiDocLink));	27✔
67	}
68	}

api-platform / core / 6250499992

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous