#28249

pending completion

Build # #28249

Build Type

push

github

Committed by

web-flow

Commit Message

<a href="https://github.com/api-platform/core/commit/<a class=hub.com/api-platform/core/commit/<a class="double-link" href="https://git"><a class=hub.com/api-platform/core/commit/<a class="double-link" href="https://git"><a class=hub.com/api-platform/core/commit/ef183271777ee618ced623bf509f6356bb5179a2">ef1832717<a href="https://github.com/api-platform/core/commit/ef183271777ee618ced623bf509f6356bb5179a2">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/api-platform/core/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/api-platform/core/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/api-platform/core/commit/ef183271777ee618ced623bf509f6356bb5179a2&quot;&gt;ef1832717&lt;/a&gt;&lt;a href=&quot;https://github.com/api-platform/core/commit/ef183271777ee618ced623bf509f6356bb5179a2&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/api-platform/core/commit/ef183271777ee618ced623bf509f6356&lt;/a&gt;bb5179a2">&quot;&gt;Merge &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/api-platform/core/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/1d9bc5aa00bc2db9fe7a955bee2d8ad4f957ada7">1d9bc5aa0</a><a href="https://github.com/api-platform/core/commit/ef183271777ee618ced623bf509f6356bb5179a2">&amp;quot;&amp;gt;1d9bc5aa0&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;1d9bc5aa0&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/api-platform/core/commit/ef183271777ee618ced623bf509f6356bb517&lt;/a&gt;9a2&quot;&gt; into &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/b733ebcec">b733ebcec">b733ebcec</a>

Run Details

26 of 26 new or added lines in 9 files covered. (100.0%)

7573 of 11666 relevant lines covered (64.92%)

88.36 hits per line

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

94.87

/src/HttpCache/EventListener/AddHeadersListener.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\Core\HttpCache\EventListener;

use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Util\RequestAttributesExtractor;
use Symfony\Component\HttpKernel\Event\ResponseEvent;

/**
 * Configures cache HTTP headers for the current response.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 *
 * @experimental
 */
final class AddHeadersListener
{
    private $etag;
    private $maxAge;
    private $sharedMaxAge;
    private $vary;
    private $public;
    private $resourceMetadataFactory;
    private $staleWhileRevalidate;
    private $staleIfError;

    public function __construct(bool $etag = false, int $maxAge = null, int $sharedMaxAge = null, array $vary = null, bool $public = null, ResourceMetadataFactoryInterface $resourceMetadataFactory = null, int $staleWhileRevalidate = null, int $staleIfError = null)
    {
        $this->etag = $etag;
        $this->maxAge = $maxAge;
        $this->sharedMaxAge = $sharedMaxAge;
        $this->vary = $vary;
        $this->public = $public;
        $this->resourceMetadataFactory = $resourceMetadataFactory;
        $this->staleWhileRevalidate = $staleWhileRevalidate;
        $this->staleIfError = $staleIfError;
    }

    public function onKernelResponse(ResponseEvent $event): void
    {
        $request = $event->getRequest();
        if (!$request->isMethodCacheable()) {
            return;
        }

        $attributes = RequestAttributesExtractor::extractAttributes($request);
        if (\count($attributes) < 1) {
            return;
        }

        $response = $event->getResponse();

        if (!$response->getContent() || !$response->isSuccessful()) {
            return;
        }

        $resourceCacheHeaders = [];

        if ($this->resourceMetadataFactory) {
            $resourceMetadata = $this->resourceMetadataFactory->create($attributes['resource_class']);
            $resourceCacheHeaders = $resourceMetadata->getOperationAttribute($attributes, 'cache_headers', [], true);
        }

        if ($this->etag && !$response->getEtag()) {
            $response->setEtag(md5((string) $response->getContent()));
        }

        if (null !== ($maxAge = $resourceCacheHeaders['max_age'] ?? $this->maxAge) && !$response->headers->hasCacheControlDirective('max-age')) {
            $response->setMaxAge($maxAge);
        }

        $vary = $resourceCacheHeaders['vary'] ?? $this->vary;
        if (null !== $vary) {
            $response->setVary(array_diff($vary, $response->getVary()), false);
        }

        // if the public-property is defined and not yet set; apply it to the response
        $public = ($resourceCacheHeaders['public'] ?? $this->public);
        if (null !== $public && !$response->headers->hasCacheControlDirective('public')) {
            $public ? $response->setPublic() : $response->setPrivate();
        }

        // Cache-Control "s-maxage" is only relevant is resource is not marked as "private"
        if (false !== $public && null !== ($sharedMaxAge = $resourceCacheHeaders['shared_max_age'] ?? $this->sharedMaxAge) && !$response->headers->hasCacheControlDirective('s-maxage')) {
            $response->setSharedMaxAge($sharedMaxAge);
        }

        if (null !== ($staleWhileRevalidate = $resourceCacheHeaders['stale_while_revalidate'] ?? $this->staleWhileRevalidate) && !$response->headers->hasCacheControlDirective('stale-while-revalidate')) {
            $response->headers->addCacheControlDirective('stale-while-revalidate', $staleWhileRevalidate);
        }

        if (null !== ($staleIfError = $resourceCacheHeaders['stale_if_error'] ?? $this->staleIfError) && !$response->headers->hasCacheControlDirective('stale-if-error')) {
            $response->headers->addCacheControlDirective('stale-if-error', $staleIfError);
        }
    }
}

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\Core\HttpCache\EventListener;
15
16	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
17	use ApiPlatform\Core\Util\RequestAttributesExtractor;
18	use Symfony\Component\HttpKernel\Event\ResponseEvent;
19
20	/**
21	* Configures cache HTTP headers for the current response.
22	*
23	* @author Kévin Dunglas <dunglas@gmail.com>
24	*
25	* @experimental
26	*/
27	final class AddHeadersListener
28	{
29	private $etag;
30	private $maxAge;
31	private $sharedMaxAge;
32	private $vary;
33	private $public;
34	private $resourceMetadataFactory;
35	private $staleWhileRevalidate;
36	private $staleIfError;
37
38	public function __construct(bool $etag = false, int $maxAge = null, int $sharedMaxAge = null, array $vary = null, bool $public = null, ResourceMetadataFactoryInterface $resourceMetadataFactory = null, int $staleWhileRevalidate = null, int $staleIfError = null)
39	{
40	$this->etag = $etag;	665✔
41	$this->maxAge = $maxAge;	665✔
42	$this->sharedMaxAge = $sharedMaxAge;	665✔
43	$this->vary = $vary;	665✔
44	$this->public = $public;	665✔
45	$this->resourceMetadataFactory = $resourceMetadataFactory;	665✔
46	$this->staleWhileRevalidate = $staleWhileRevalidate;	665✔
47	$this->staleIfError = $staleIfError;	665✔
48	}	665✔
49
50	public function onKernelResponse(ResponseEvent $event): void
51	{
52	$request = $event->getRequest();	665✔
53	if (!$request->isMethodCacheable()) {	665✔
54	return;	201✔
55	}
56
57	$attributes = RequestAttributesExtractor::extractAttributes($request);	496✔
58	if (\count($attributes) < 1) {	496✔
59	return;	175✔
60	}
61
62	$response = $event->getResponse();	340✔
63
64	if (!$response->getContent() \|\| !$response->isSuccessful()) {	340✔
65	return;	39✔
66	}
67
68	$resourceCacheHeaders = [];	317✔
69
70	if ($this->resourceMetadataFactory) {	317✔
71	$resourceMetadata = $this->resourceMetadataFactory->create($attributes['resource_class']);	317✔
72	$resourceCacheHeaders = $resourceMetadata->getOperationAttribute($attributes, 'cache_headers', [], true);	317✔
73	}
74
75	if ($this->etag && !$response->getEtag()) {	317✔
76	$response->setEtag(md5((string) $response->getContent()));	317✔
77	}
78
79	if (null !== ($maxAge = $resourceCacheHeaders['max_age'] ?? $this->maxAge) && !$response->headers->hasCacheControlDirective('max-age')) {	317✔
80	$response->setMaxAge($maxAge);	317✔
81	}
82
83	$vary = $resourceCacheHeaders['vary'] ?? $this->vary;	317✔
84	if (null !== $vary) {	317✔
85	$response->setVary(array_diff($vary, $response->getVary()), false);	317✔
86	}
87
88	// if the public-property is defined and not yet set; apply it to the response
89	$public = ($resourceCacheHeaders['public'] ?? $this->public);	317✔
90	if (null !== $public && !$response->headers->hasCacheControlDirective('public')) {	317✔
91	$public ? $response->setPublic() : $response->setPrivate();	317✔
92	}
93
94	// Cache-Control "s-maxage" is only relevant is resource is not marked as "private"
95	if (false !== $public && null !== ($sharedMaxAge = $resourceCacheHeaders['shared_max_age'] ?? $this->sharedMaxAge) && !$response->headers->hasCacheControlDirective('s-maxage')) {	317✔
96	$response->setSharedMaxAge($sharedMaxAge);	317✔
97	}
98
99	if (null !== ($staleWhileRevalidate = $resourceCacheHeaders['stale_while_revalidate'] ?? $this->staleWhileRevalidate) && !$response->headers->hasCacheControlDirective('stale-while-revalidate')) {	317✔
100	$response->headers->addCacheControlDirective('stale-while-revalidate', $staleWhileRevalidate);	×
101	}
102
103	if (null !== ($staleIfError = $resourceCacheHeaders['stale_if_error'] ?? $this->staleIfError) && !$response->headers->hasCacheControlDirective('stale-if-error')) {	317✔
104	$response->headers->addCacheControlDirective('stale-if-error', $staleIfError);	×
105	}
106	}	317✔
107	}

api-platform / core / #28249

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