chore: split api-platform/http-cache (api-platform#5531)

Zowac · PierreRebeilleau · soyuka · soyuka · commit 838e76f97dc2 · 2023-08-09T16:38:07.000+02:00
---------

Co-authored-by: PierreRebeilleau &lt;pierre@les-tilleuls.coop&gt;
Co-authored-by: Antoine Bluchet &lt;soyuka@users.noreply.github.com&gt;
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -193,6 +193,7 @@ jobs:
           - OpenApi
           - Metadata
           - Elasticsearch
+          - HttpCache
           - RamseyUuid
       fail-fast: false
     steps:
diff --git a/composer.json b/composer.json
@@ -120,7 +120,10 @@
     "autoload": {
         "psr-4": {
             "ApiPlatform\\": "src/"
-        }
+        },
+        "files": [
+            "src/deprecation.php"
+        ]
     },
     "autoload-dev": {
         "psr-4": {
diff --git a/src/HttpCache/.gitignore b/src/HttpCache/.gitignore
@@ -0,0 +1,3 @@
+/composer.lock
+/vendor
+/.phpunit.result.cache
diff --git a/src/HttpCache/EventListener/AddHeadersListener.php b/src/HttpCache/EventListener/AddHeadersListener.php
@@ -22,6 +22,8 @@
  * Configures cache HTTP headers for the current response.
  *
  * @author Kévin Dunglas <dunglas@gmail.com>
+ *
+ * @deprecated use \Symfony\EventListener\AddHeadersListener.php instead
  */
 final class AddHeadersListener
 {
diff --git a/src/HttpCache/EventListener/AddTagsListener.php b/src/HttpCache/EventListener/AddTagsListener.php
@@ -13,11 +13,11 @@
 
 namespace ApiPlatform\HttpCache\EventListener;
 
-use ApiPlatform\Api\IriConverterInterface;
-use ApiPlatform\Api\UrlGeneratorInterface;
 use ApiPlatform\HttpCache\PurgerInterface;
 use ApiPlatform\Metadata\CollectionOperationInterface;
+use ApiPlatform\Metadata\IriConverterInterface;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
+use ApiPlatform\Metadata\UrlGeneratorInterface;
 use ApiPlatform\State\UriVariablesResolverTrait;
 use ApiPlatform\Util\OperationRequestInitiatorTrait;
 use ApiPlatform\Util\RequestAttributesExtractor;
@@ -34,6 +34,8 @@
  * @see https://docs.varnish-software.com/varnish-cache-plus/vmods/ykey/
  *
  * @author Kévin Dunglas <dunglas@gmail.com>
+ *
+ *  @deprecated use \Symfony\EventListener\AddTagsListener.php instead
  */
 final class AddTagsListener
 {
diff --git a/src/HttpCache/LICENSE b/src/HttpCache/LICENSE
@@ -0,0 +1,21 @@
+The MIT license
+
+Copyright (c) 2015-present Kévin Dunglas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/src/HttpCache/README.md b/src/HttpCache/README.md
@@ -0,0 +1,7 @@
+# API Platform - HTTP Cache
+
+HTTP Cache support.
+
+## Resources
+
+
diff --git a/src/HttpCache/SurrogateKeysPurger.php b/src/HttpCache/SurrogateKeysPurger.php
@@ -13,7 +13,7 @@
 
 namespace ApiPlatform\HttpCache;
 
-use ApiPlatform\Exception\RuntimeException;
+use ApiPlatform\Metadata\Exception\RuntimeException;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
diff --git a/src/HttpCache/Tests/SouinPurgerTest.php b/src/HttpCache/Tests/SouinPurgerTest.php
@@ -11,7 +11,7 @@
 
 declare(strict_types=1);
 
-namespace ApiPlatform\Tests\HttpCache;
+namespace ApiPlatform\HttpCache\Tests;
 
 use ApiPlatform\HttpCache\SouinPurger;
 use GuzzleHttp\ClientInterface;
diff --git a/src/HttpCache/Tests/VarnishPurgerTest.php b/src/HttpCache/Tests/VarnishPurgerTest.php
@@ -11,7 +11,7 @@
 
 declare(strict_types=1);
 
-namespace ApiPlatform\Tests\HttpCache;
+namespace ApiPlatform\HttpCache\Tests;
 
 use ApiPlatform\HttpCache\VarnishPurger;
 use GuzzleHttp\ClientInterface;
@@ -187,4 +187,12 @@ public function testConstructor(): void
 
         $purger->purge(['/foo']);
     }
+
+    public function testGetResponseHeader(): void
+    {
+        $clientProphecy = $this->prophesize(HttpClientInterface::class);
+
+        $purger = new VarnishPurger([$clientProphecy->reveal()]);
+        self::assertSame(['Cache-Tags' => '/foo'], $purger->getResponseHeaders(['/foo']));
+    }
 }
diff --git a/src/HttpCache/Tests/VarnishXKeyPurgerTest.php b/src/HttpCache/Tests/VarnishXKeyPurgerTest.php
@@ -11,7 +11,7 @@
 
 declare(strict_types=1);
 
-namespace ApiPlatform\Tests\HttpCache;
+namespace ApiPlatform\HttpCache\Tests;
 
 use ApiPlatform\HttpCache\VarnishXKeyPurger;
 use GuzzleHttp\ClientInterface;
diff --git a/src/HttpCache/composer.json b/src/HttpCache/composer.json
@@ -0,0 +1,66 @@
+{
+  "name": "api-platform/http-cache",
+  "description": "HttpCache support",
+  "type": "library",
+  "keywords": [
+    "Cache",
+    "Http"
+  ],
+  "homepage": "https://api-platform.com",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Kévin Dunglas",
+      "email": "kevin@dunglas.fr",
+      "homepage": "https://dunglas.fr"
+    },
+    {
+      "name": "API Platform Community",
+      "homepage": "https://api-platform.com/comunnity/contributors"
+    }
+  ],
+  "require": {
+    "php": ">=8.1",
+    "api-platform/metadata": "*@dev || ^3.1",
+    "symfony/http-foundation": "^6.1"
+  },
+  "require-dev": {
+    "guzzlehttp/guzzle": "^6.0 || ^7.0",
+    "symfony/dependency-injection": "^6.1",
+    "phpspec/prophecy-phpunit": "^2.0",
+    "symfony/phpunit-bridge": "^6.1",
+    "symfony/http-client": "^6.1"
+  },
+  "autoload": {
+    "psr-4": {
+      "ApiPlatform\\HttpCache\\": ""
+    },
+    "exclude-from-classmap": [
+      "/Tests/"
+    ]
+  },
+  "config": {
+    "preferred-install": {
+      "*": "dist"
+    },
+    "sort-packages": true,
+    "allow-plugins": {
+      "composer/package-versions-deprecated": true,
+      "phpstan/extension-installer": true
+    }
+  },
+  "extra": {
+    "branch-alias": {
+      "dev-main": "3.2.x-dev"
+    },
+    "symfony": {
+      "require": "^6.1"
+    }
+  },
+  "repositories": [
+    {
+      "type": "path",
+      "url": "../Metadata"
+    }
+  ]
+}
diff --git a/src/HttpCache/phpunit.xml.dist b/src/HttpCache/phpunit.xml.dist
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/9.3/phpunit.xsd"
+         backupGlobals="false"
+         colors="true"
+         bootstrap="vendor/autoload.php"
+         failOnRisky="true"
+         failOnWarning="true"
+>
+    <php>
+        <ini name="error_reporting" value="-1" />
+    </php>
+
+    <testsuites>
+        <testsuite name="Api Platform HTTP Cache Component Test Suite">
+            <directory>./Tests/</directory>
+        </testsuite>
+    </testsuites>
+
+    <coverage>
+        <include>
+            <directory>./</directory>
+        </include>
+        <exclude>
+            <directory>./Tests</directory>
+            <directory>./vendor</directory>
+        </exclude>
+    </coverage>
+</phpunit>
+
diff --git a/src/Symfony/EventListener/AddHeadersListener.php b/src/Symfony/EventListener/AddHeadersListener.php
@@ -0,0 +1,88 @@
+<?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\Symfony\EventListener;
+
+use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
+use ApiPlatform\Util\OperationRequestInitiatorTrait;
+use ApiPlatform\Util\RequestAttributesExtractor;
+use Symfony\Component\HttpKernel\Event\ResponseEvent;
+
+/**
+ * Configures cache HTTP headers for the current response.
+ *
+ * @author Kévin Dunglas <dunglas@gmail.com>
+ */
+final class AddHeadersListener
+{
+    use OperationRequestInitiatorTrait;
+
+    public function __construct(private readonly bool $etag = false, private readonly ?int $maxAge = null, private readonly ?int $sharedMaxAge = null, private readonly ?array $vary = null, private readonly ?bool $public = null, ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null, private readonly ?int $staleWhileRevalidate = null, private readonly ?int $staleIfError = null)
+    {
+        $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
+    }
+
+    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;
+        }
+
+        $operation = $this->initializeOperation($request);
+        $resourceCacheHeaders = $attributes['cache_headers'] ?? $operation?->getCacheHeaders() ?? [];
+
+        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', (string) $staleWhileRevalidate);
+        }
+
+        if (null !== ($staleIfError = $resourceCacheHeaders['stale_if_error'] ?? $this->staleIfError) && !$response->headers->hasCacheControlDirective('stale-if-error')) {
+            $response->headers->addCacheControlDirective('stale-if-error', (string) $staleIfError);
+        }
+    }
+}
diff --git a/src/Symfony/EventListener/AddTagsListener.php b/src/Symfony/EventListener/AddTagsListener.php
diff --git a/src/deprecation.php b/src/deprecation.php
diff --git a/tests/Symfony/EventListener/AddHeadersListenerTest.php b/tests/Symfony/EventListener/AddHeadersListenerTest.php
diff --git a/tests/Symfony/EventListener/AddTagsListenerTest.php b/tests/Symfony/EventListener/AddTagsListenerTest.php

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+/composer.lock`
	`2`	`+/vendor`
	`3`	`+/.phpunit.result.cache`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,8 @@`
`22`	`22`	`* Configures cache HTTP headers for the current response.`
`23`	`23`	`*`
`24`	`24`	`* @author Kévin Dunglas <[email protected]>`
	`25`	`+ *`
	`26`	`+ * @deprecated use \Symfony\EventListener\AddHeadersListener.php instead`
`25`	`27`	`*/`
`26`	`28`	`final class AddHeadersListener`
`27`	`29`	`{`