fix(laravel): http cache compatibility

Author: soyuka

src/HttpCache/State/AddHeadersProcessor.php

@@ -29,7 +29,16 @@ final class AddHeadersProcessor implements ProcessorInterface
     /**
      * @param ProcessorInterface<T1, T2> $decorated
      */
-    public function __construct(private readonly ProcessorInterface $decorated, 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, private readonly ?int $staleWhileRevalidate = null, private readonly ?int $staleIfError = null)
+    public function __construct(
+        private readonly ProcessorInterface $decorated,
+        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,
+        private readonly ?int $staleWhileRevalidate = null,
+        private readonly ?int $staleIfError = null,
+    )
     {
     }
 

src/Laravel/ApiPlatformProvider.php

@@ -49,6 +49,7 @@
 use ApiPlatform\Hal\Serializer\EntrypointNormalizer as HalEntrypointNormalizer;
 use ApiPlatform\Hal\Serializer\ItemNormalizer as HalItemNormalizer;
 use ApiPlatform\Hal\Serializer\ObjectNormalizer as HalObjectNormalizer;
+use ApiPlatform\HttpCache\State\AddHeadersProcessor;
 use ApiPlatform\Hydra\JsonSchema\SchemaFactory as HydraSchemaFactory;
 use ApiPlatform\Hydra\Serializer\CollectionFiltersNormalizer as HydraCollectionFiltersNormalizer;
 use ApiPlatform\Hydra\Serializer\CollectionNormalizer as HydraCollectionNormalizer;
@@ -403,8 +404,25 @@ public function register(): void
 
         $this->app->bind(ProviderInterface::class, ContentNegotiationProvider::class);
 
-        $this->app->singleton(RespondProcessor::class, function () {
-            return new AddLinkHeaderProcessor(new RespondProcessor(), new HttpHeaderSerializer());
+        $this->app->singleton(RespondProcessor::class, function (Application $app) {
+            $decorated = new RespondProcessor();
+            if (class_exists(AddHeadersProcessor::class)) {
+                /** @var ConfigRepository */
+                $config = $app['config']['http_cache'] ?? [];
+
+                $decorated = new AddHeadersProcessor(
+                    $decorated,
+                    etag: $config['etag'] ?? false,
+                    maxAge: $config['max_age'] ?? null,
+                    sharedMaxAge: $config['shared_max_age'] ?? null,
+                    vary: $config['vary'] ?? null,
+                    public: $config['public'] ?? null,
+                    staleWhileRevalidate: $config['stale_while_revalidate'] ?? null,
+                    staleIfError: $config['stale_if_error']
+                );
+            }
+
+            return new AddLinkHeaderProcessor($decorated, new HttpHeaderSerializer());
         });
 
         $this->app->singleton(SerializeProcessor::class, function (Application $app) {

src/Laravel/composer.json

@@ -74,6 +74,7 @@
     },
     "suggest": {
         "api-platform/graphql": "Enable GraphQl support.",
+        "api-platform/http-cache": "Enable HTTP Cache support.",
         "phpstan/phpdoc-parser": "To support extracting metadata from PHPDoc."
     },
     "extra": {

src/Laravel/config/api-platform.php

@@ -144,4 +144,25 @@
 
     // we recommend using "file" or "acpu"
     'cache' => 'file',
+
+    // 'http_cache' => [
+    //     'etag' => false,
+    //     'max_age' => null,
+    //     'shared_max_age' => null,
+    //     'vary' => null,
+    //     'public' => null,
+    //     'stale_while_revalidate' => null,
+    //     'stale_if_error' => null,
+    //     'invalidation' => [
+    //         'varnish_urls' => [],
+    //         'urls' => [],
+    //         'scoped_clients' => [],
+    //         'max_header_length' => 7500,
+    //         'request_options' => [],
+    //         'purger' => 'api_platform.http_cache.purger.varnish',
+    //         'xkey' => [
+    //             'glue' => ' ',
+    //         ],
+    //     ],
+    // ]
 ];