feat(NodesSources): Respect user set TTL on nodes-sources during API requests

Author: roadiz-ci

src/Entity/Node.php

@@ -128,10 +128,12 @@ class Node extends AbstractDateTimedPositioned implements LeafInterface, Attribu
 
     #[ORM\Column(type: 'integer', nullable: false, options: ['default' => 0])]
     #[Assert\GreaterThanOrEqual(value: 0)]
+    #[Assert\NotNull]
     #[SymfonySerializer\Ignore]
     #[Serializer\Exclude]
     #[Gedmo\Versioned]
-    private int $ttl = 0;
+    // @phpstan-ignore-next-line
+    private ?int $ttl = 0;
 
     #[ORM\Column(type: 'boolean', nullable: false, options: ['default' => false])]
     #[SymfonySerializer\Groups(['node'])]
@@ -421,15 +423,15 @@ public function setStatus(int|string $status): Node
      */
     public function getTtl(): int
     {
-        return $this->ttl;
+        return $this->ttl ?? 0;
     }
 
     /**
-     * @param int $ttl
+     * @param int|null $ttl
      *
      * @return Node
      */
-    public function setTtl(int $ttl): Node
+    public function setTtl(?int $ttl): Node
     {
         $this->ttl = $ttl;
         return $this;

src/Entity/NodeType.php

@@ -145,9 +145,11 @@ class NodeType extends AbstractEntity implements NodeTypeInterface
         Serializer\Groups(["node_type"]),
         SymfonySerializer\Groups(["node_type"]),
         Serializer\Type("int"),
-        Assert\GreaterThanOrEqual(value: 0)
+        Assert\GreaterThanOrEqual(value: 0),
+        Assert\NotNull
     ]
-    private int $defaultTtl = 0;
+    // @phpstan-ignore-next-line
+    private ?int $defaultTtl = 0;
     /**
      * Define if this node-type title will be indexed during its parent indexation.
      */
@@ -340,15 +342,15 @@ public function setColor(?string $color): NodeType
      */
     public function getDefaultTtl(): int
     {
-        return $this->defaultTtl;
+        return $this->defaultTtl ?? 0;
     }
 
     /**
-     * @param int $defaultTtl
+     * @param int|null $defaultTtl
      *
      * @return NodeType
      */
-    public function setDefaultTtl(int $defaultTtl): NodeType
+    public function setDefaultTtl(?int $defaultTtl): NodeType
     {
         $this->defaultTtl = $defaultTtl;
 

src/EventSubscriber/NodesSourcesAddHeadersSubscriber.php

@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RZ\Roadiz\CoreBundle\EventSubscriber;
+
+use ApiPlatform\Util\RequestAttributesExtractor;
+use RZ\Roadiz\CoreBundle\Entity\NodesSources;
+use RZ\Roadiz\CoreBundle\Preview\PreviewResolverInterface;
+use Symfony\Bundle\SecurityBundle\Security;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\ResponseEvent;
+use Symfony\Component\HttpKernel\KernelEvents;
+
+final class NodesSourcesAddHeadersSubscriber implements EventSubscriberInterface
+{
+    public function __construct(
+        private readonly PreviewResolverInterface $previewResolver,
+        private readonly Security $security
+    ) {
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            KernelEvents::RESPONSE => ['onKernelResponse', 0]
+        ];
+    }
+
+    public function onKernelResponse(ResponseEvent $event): void
+    {
+        $request = $event->getRequest();
+        $response = $event->getResponse();
+
+        if (!$request->isMethodCacheable()) {
+            return;
+        }
+        if (!$response->getContent() || !$response->isSuccessful()) {
+            return;
+        }
+
+        $attributes = RequestAttributesExtractor::extractAttributes($request);
+        if (\count($attributes) < 1) {
+            return;
+        }
+
+        if ($this->previewResolver->isPreview()) {
+            return;
+        }
+
+        if ($this->security->isGranted('IS_AUTHENTICATED')) {
+            return;
+        }
+
+        $resourceCacheHeaders = $attributes['cache_headers'] ?? [];
+        $data = $request->attributes->get('data');
+
+        // if the public-property is defined and not yet set; apply it to the response
+        $public = $resourceCacheHeaders['public'] ?? null;
+        if (null !== $public && !$response->headers->hasCacheControlDirective('public')) {
+            $public ? $response->setPublic() : $response->setPrivate();
+        }
+
+        if (!$data instanceof NodesSources) {
+            return;
+        }
+
+        if ($data->getNode()->getTtl() <= 0) {
+            return;
+        }
+
+        if (null !== ($maxAge = $resourceCacheHeaders['max_age'] ?? $data->getNode()->getTtl()) && !$response->headers->hasCacheControlDirective('max-age')) {
+            $response->setMaxAge($maxAge * 60);
+        }
+        // Cache-Control "s-maxage" is only relevant is resource is not marked as "private"
+        if (false !== $public && null !== ($sharedMaxAge = $resourceCacheHeaders['shared_max_age'] ?? $data->getNode()->getTtl()) && !$response->headers->hasCacheControlDirective('s-maxage')) {
+            $response->setSharedMaxAge($sharedMaxAge * 60);
+        }
+    }
+}

src/Preview/EventSubscriber/PreviewBarSubscriber.php

@@ -10,16 +10,10 @@
 use Symfony\Component\HttpKernel\Event\ResponseEvent;
 use Symfony\Component\HttpKernel\KernelEvents;
 
-class PreviewBarSubscriber implements EventSubscriberInterface
+final class PreviewBarSubscriber implements EventSubscriberInterface
 {
-    protected PreviewResolverInterface $previewResolver;
-
-    /**
-     * @param PreviewResolverInterface $previewResolver
-     */
-    public function __construct(PreviewResolverInterface $previewResolver)
+    public function __construct(private readonly PreviewResolverInterface $previewResolver)
     {
-        $this->previewResolver = $previewResolver;
     }
 
     /**

src/Preview/EventSubscriber/PreviewModeSubscriber.php

@@ -31,7 +31,8 @@ public static function getSubscribedEvents(): array
         return [
             KernelEvents::REQUEST => ['onKernelRequest', 2047],
             KernelEvents::CONTROLLER => ['onControllerMatched', 10],
-            KernelEvents::RESPONSE => 'onResponse',
+            // Must Triggered after API platform AddHeadersListener
+            KernelEvents::RESPONSE => ['onResponse', -255],
         ];
     }
 
@@ -88,10 +89,11 @@ public function onResponse(ResponseEvent $event): void
     {
         if ($this->supports()) {
             $response = $event->getResponse();
-            $response->expire();
+            $response->setMaxAge(0);
+            $response->setSharedMaxAge(0);
             $response->headers->addCacheControlDirective('no-store');
             $response->headers->add(['X-Roadiz-Preview' => true]);
-            $event->setResponse($response);
+            $response->setPrivate();
         }
     }
 }

src/Preview/RequestPreviewRevolver.php

@@ -33,7 +33,7 @@ public function isPreview(): bool
         if (null === $request) {
             return false;
         }
-        return $request->attributes->get('preview', false);
+        return $request->attributes->getBoolean('preview');
     }
 
     public function getRequiredRole(): string