feat: add HTTP cache support to RSS feeds (#217)

* feat: add HTTP cache support to RSS feeds
---------

Co-authored-by: Florian ALEXANDRE <f.alexandre@novactive.com>

Author: erdnaxelaweb

components/RssFeedBundle/README.md

@@ -100,4 +100,11 @@ Inside your locale file (example novarss_sites.fr.yaml) put your translation as
 ```yaml
 site_access_identifier: My site
 ```
-Note : This translation is enabled using the default SiteListService
+Note : This translation is enabled using the default SiteListService
+
+### HTTP caching
+
+The `NOVAEZRSSFEED_CACHE_TTL` ENV var control the HTTP cache behavior:
+- `null` => public + expire at 0h00
+- `0` => private
+- `<int>` => public + s-maxage of `<int>`

components/RssFeedBundle/src/bundle/Controller/RssFeedViewController.php

@@ -12,6 +12,8 @@
 
 namespace Novactive\EzRssFeedBundle\Controller;
 
+use DateTime;
+use FOS\HttpCacheBundle\Http\SymfonyResponseTagger;
 use Ibexa\Bundle\Core\Controller;
 use Ibexa\Contracts\Core\Repository\PermissionResolver;
 use Ibexa\Core\Base\Exceptions\UnauthorizedException;
@@ -32,6 +34,15 @@ class RssFeedViewController extends Controller
 {
     use EntityManagerTrait;
 
+    protected SymfonyResponseTagger $responseTagger;
+    protected ?int $cacheTtl = null;
+
+    public function __construct(SymfonyResponseTagger $responseTagger, ?int $cacheTtl)
+    {
+        $this->responseTagger = $responseTagger;
+        $this->cacheTtl = $cacheTtl;
+    }
+
     /**
      * @Route("/{urlSlug}/{site?}", name="rss_feed_view_index")
      */
@@ -76,6 +87,19 @@ public function indexAction(
 
             $response->headers->set('Content-Type', 'application/rss+xml; charset=utf-8');
 
+            $response->setPublic();
+            if (null === $this->cacheTtl) {
+                $expire = (new DateTime())->modify('+1 day')->setTime(0, 0);
+                $response->setExpires($expire);
+                $response->setSharedMaxAge($expire->getTimestamp() - time());
+            } elseif (0 === $this->cacheTtl) {
+                $response->setPrivate();
+            } else {
+                $response->setSharedMaxAge($this->cacheTtl);
+            }
+            $this->responseTagger->addTags(['rssfeed-'.$rssFeed->getId()]);
+            $this->responseTagger->tagSymfonyResponse($response);
+
             return $response;
         }
 
@@ -105,11 +129,20 @@ public function rssHeadLinkTagsAction(SiteAccess $siteAccess, FactoryInterface $
             }
         }
 
-        return $this->render(
+        $response = new Response();
+        $response = $this->render(
             '@ibexadesign/rssfeed/meta_links.html.twig',
             [
                 'links' => $links,
-            ]
+            ],
+            $response
         );
+
+        $response->setPublic();
+        $response->setSharedMaxAge(60 * 60 * 24 * 365);
+        $this->responseTagger->addTags(['rssfeeds']);
+        $this->responseTagger->tagSymfonyResponse($response);
+
+        return $response;
     }
 }

components/RssFeedBundle/src/bundle/DependencyInjection/EzRssFeedExtension.php

@@ -33,6 +33,7 @@ class EzRssFeedExtension extends Extension implements PrependExtensionInterface
     public function load(array $configs, ContainerBuilder $container): void
     {
         $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
+        $loader->load('default_settings.yaml');
         $loader->load('services.yml');
         $loader->load('PlatformAdminUI/services.yml');
     }

components/RssFeedBundle/src/bundle/EventListener/DoctrineEventListener.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Novactive\EzRssFeedBundle\EventListener;
+
+use Doctrine\ORM\Event\LifecycleEventArgs;
+use Ibexa\Contracts\HttpCache\PurgeClient\PurgeClientInterface;
+use Novactive\EzRssFeedBundle\Entity\RssFeeds;
+
+class DoctrineEventListener
+{
+    /** @var PurgeClientInterface */
+    protected $httpCachePurgeClient;
+
+    public function __construct(PurgeClientInterface $httpCachePurgeClient)
+    {
+        $this->httpCachePurgeClient = $httpCachePurgeClient;
+    }
+
+    public function postPersist(LifecycleEventArgs $args)
+    {
+        $this->lifecycleEventHandler($args);
+    }
+
+    public function postUpdate(LifecycleEventArgs $args)
+    {
+        $this->lifecycleEventHandler($args);
+    }
+
+    public function postRemove(LifecycleEventArgs $args)
+    {
+        $this->lifecycleEventHandler($args);
+    }
+
+    /**
+     * @throws \Psr\Cache\InvalidArgumentException
+     */
+    protected function lifecycleEventHandler(LifecycleEventArgs $args): void
+    {
+        $entity = $args->getEntity();
+        if ($entity instanceof RssFeeds) {
+            $tags = ['rssfeed-'.$entity->getId(), 'rssfeeds'];
+            $this->invalidateTags($tags);
+        }
+    }
+
+    /**
+     * @throws \Psr\Cache\InvalidArgumentException
+     */
+    protected function invalidateTags(array $tags): void
+    {
+        if (!empty($tags)) {
+            $this->httpCachePurgeClient->purge($tags);
+        }
+    }
+}

components/RssFeedBundle/src/bundle/Resources/config/default_settings.yaml

@@ -0,0 +1,7 @@
+parameters:
+    # ~ => public + expire at 0h00
+    # 0 => private
+    # <int> => public + s-maxage of `<int>`
+    env(NOVAEZRSSFEED_CACHE_TTL): "3600"
+
+    novaezrssfeed.cache.ttl: '%env(NOVAEZRSSFEED_CACHE_TTL)%'

components/RssFeedBundle/src/bundle/Resources/config/services.yml

@@ -8,6 +8,9 @@ services:
 
   Novactive\EzRssFeedBundle\Controller\RssFeedViewController:
     autowire: true
+    arguments:
+      $cacheTtl: '%novaezrssfeed.cache.ttl%'
+      $responseTagger: '@fos_http_cache.http.symfony_response_tagger'
     tags:
     - { name: controller.service_arguments }
 
@@ -43,3 +46,10 @@ services:
 
   Novactive\EzRssFeedBundle\Services\SiteListServiceInterface: '@Novactive\EzRssFeedBundle\Services\SiteListService'
 
+  Novactive\EzRssFeedBundle\EventListener\DoctrineEventListener:
+    arguments:
+      $httpCachePurgeClient: '@ibexa.http_cache.purge_client'
+    tags:
+      - { name: doctrine.event_listener, event: postPersist, lazy: true }
+      - { name: doctrine.event_listener, event: postUpdate, lazy: true }
+      - { name: doctrine.event_listener, event: postRemove, lazy: true }