feat: add cache invalidation by tag

compose.yml

@@ -1,5 +1,3 @@
-version: '3.7'
-
 services:
     web:
         container_name: blog.nginx

composer.json

@@ -11,6 +11,7 @@
         "ext-iconv": "*",
         "ext-intl": "*",
         "league/commonmark": "2.4.*",
+        "symfony/config": "7.0.*",
         "symfony/console": "7.0.*",
         "symfony/dotenv": "7.0.*",
         "symfony/flex": "^2",

config/packages/framework.php

@@ -45,6 +45,9 @@
         ->app('cache.adapter.filesystem')
         ->system('cache.adapter.system');
 
+    $framework->cache()->pool('messenger.cache')
+        ->tags(true);
+
     /**
      * Router Configuration
      * @see \Symfony\Config\Framework\RouterConfig
@@ -125,7 +128,7 @@
             'middleware' => array_filter([
                 $container->env() === 'dev' ? StopwatchMiddleware::class : null,
                 LoggerMiddleware::class,
-                $container->env() === 'dev' ? null : CacheMiddleware::class,
+                CacheMiddleware::class,
             ]),
         ]);
 
@@ -137,8 +140,7 @@
         ->limiter('public')
         ->policy('sliding_window')
         ->limit(1000)
-        ->interval('60 minutes')
-    ;
+        ->interval('60 minutes');
 
     /**
      * Lock Configuration

config/packages/security.php

@@ -17,7 +17,7 @@
         ->security(false);
 
     $adminFirewall = $security->firewall('admin')
-        ->pattern('^/admin/')
+        ->pattern('^/(admin|webhook)/')
         ->security(true)
         ->stateless(true)
         ->provider(ADMIN_USER_PROVIDER);
@@ -34,6 +34,6 @@
         ->lazy(true);
 
     $security->accessControl()
-        ->path('^/admin')
+        ->path('^/(admin|webhook)')
         ->roles(['ROLE_ADMIN']);
 };

config/routes.php

@@ -13,6 +13,10 @@
         ->prefix('/api')
         ->namePrefix('api_');
 
+    $routes->import('../src/Presentation/Webhook/', 'attribute')
+        ->prefix('/webhook')
+        ->namePrefix('webhook_');
+
     if ($routes->env() === 'dev') {
         $routes->import('@WebProfilerBundle/Resources/config/routing/wdt.xml')->prefix('/_wdt');
         $routes->import('@WebProfilerBundle/Resources/config/routing/profiler.xml')->prefix('/_profiler');

http/.gitignore

@@ -0,0 +1 @@
+http-client.private.env.json

http/admin_cache_invalidation.http

@@ -0,0 +1,6 @@
+# @name Cache Invalidation by tag
+GET {{host}}/admin/cache-invalidation?tag[]=article
+Content-Type: application/json
+Authorization: Bearer {{token}}
+
+###

http/api_article.http

@@ -0,0 +1,12 @@
+# @name Get Articles
+GET {{host}}/api/articles
+Content-Type: application/json
+
+###
+
+# @name Get Article By ID
+@id = 6J0hWoFCuiuWQtjp3K1mXn
+GET {{host}}/api/articles/{{id}}
+Content-Type: application/json
+
+###

http/webhook_contentful.http

@@ -0,0 +1,107 @@
+# @name Contentful Webhook : Publish BlogPage
+POST {{host}}/webhook/contentful/publish
+Content-Type: application/json
+Authorization: Bearer {{token}}
+
+{
+    "metadata": {
+        "tags": []
+    },
+    "fields": {
+        "title": {
+            "fr": "Débuter avec Varnish"
+        },
+        "slug": {
+            "fr": "debuter-avec-varnish"
+        },
+        "description": {
+            "fr": "TODO"
+        },
+        "content": {
+            "fr": "TODO"
+        },
+        "categories": {
+            "fr": []
+        }
+    },
+    "sys": {
+        "type": "Entry",
+        "id": "1234",
+        "space": {
+            "sys": {
+                "type": "Link",
+                "linkType": "Space",
+                "id": "1234"
+            }
+        },
+        "environment": {
+            "sys": {
+                "id": "master",
+                "type": "Link",
+                "linkType": "Environment"
+            }
+        },
+        "contentType": {
+            "sys": {
+                "type": "Link",
+                "linkType": "ContentType",
+                "id": "blogPage"
+            }
+        },
+        "createdBy": {
+            "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "1234"
+            }
+        },
+        "updatedBy": {
+            "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "1234"
+            }
+        },
+        "revision": 3,
+        "createdAt": "2023-12-18T19:15:54.485Z",
+        "updatedAt": "2024-01-14T14:48:10.656Z"
+    }
+}
+
+###
+
+# @name Contentful Webhook : Unpublsih BlogPage
+POST {{host}}/webhook/contentful/publish
+Content-Type: application/json
+
+{
+    "sys": {
+        "type": "DeletedEntry",
+        "id": "1234",
+        "space": {
+            "sys": {
+                "type": "Link",
+                "linkType": "Space",
+                "id": "1234"
+            }
+        },
+        "environment": {
+            "sys": {
+                "id": "master",
+                "type": "Link",
+                "linkType": "Environment"
+            }
+        },
+        "contentType": {
+            "sys": {
+                "type": "Link",
+                "linkType": "ContentType",
+                "id": "blogPage"
+            }
+        },
+        "revision": 3,
+        "createdAt": "2024-01-14T14:48:15.803Z",
+        "updatedAt": "2024-01-14T14:48:15.803Z",
+        "deletedAt": "2024-01-14T14:48:15.803Z"
+    }
+}

src/Application/Command/TagCacheInvalidation/TagCacheInvalidationCommand.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Application\Command\TagCacheInvalidation;
+
+final readonly class TagCacheInvalidationCommand
+{
+    public function __construct(
+        public array $tags
+    ) {}
+}

src/Application/Command/TagCacheInvalidation/TagCacheInvalidationCommandHandler.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Application\Command\TagCacheInvalidation;
+
+use Symfony\Component\Messenger\Attribute\AsMessageHandler;
+use Symfony\Contracts\Cache\TagAwareCacheInterface;
+
+#[AsMessageHandler]
+final readonly class TagCacheInvalidationCommandHandler
+{
+    public function __construct(
+        private TagAwareCacheInterface $messengerCache
+    ) {
+    }
+
+    public function __invoke(TagCacheInvalidationCommand $command): void
+    {
+        $this->messengerCache->invalidateTags($command->tags);
+    }
+}

src/Application/Query/GetArticle/GetArticleQuery.php

@@ -4,19 +4,12 @@
 
 namespace App\Application\Query\GetArticle;
 
-use App\Application\Query\CacheableQueryInterface;
+use App\Application\Query\QueryCache;
 
-final readonly class GetArticleQuery implements CacheableQueryInterface
+#[QueryCache(ttl: 3600, tags: ['get_article', 'article'])]
+final class GetArticleQuery
 {
-    public function __construct(public string $identifier, public bool $preview = false) {}
-
-    public function getCacheKey(): string
-    {
-        return sprintf('article_%s', $this->identifier);
-    }
-
-    public function getCacheTtl(): int
-    {
-        return $this->preview ? 0 : 3600;
-    }
+    public function __construct(
+        public string $identifier,
+    ) {}
 }

src/Application/Query/GetArticle/GetArticleQueryHandler.php

@@ -11,10 +11,12 @@
 #[AsMessageHandler]
 final readonly class GetArticleQueryHandler
 {
-    public function __construct(private BlogArticleRepository $blogArticleRepository) {}
+    public function __construct(
+        private BlogArticleRepository $blogArticleRepository,
+    ) {}
 
     public function __invoke(GetArticleQuery $query): ?BlogArticle
     {
-        return $this->blogArticleRepository->getById($query->identifier, $query->preview);
+        return $this->blogArticleRepository->getById($query->identifier);
     }
 }

src/Application/Query/GetArticleByFilter/GetArticleByFilterQuery.php

@@ -4,19 +4,12 @@
 
 namespace App\Application\Query\GetArticleByFilter;
 
-use App\Application\Query\CacheableQueryInterface;
+use App\Application\Query\QueryCache;
 
-final readonly class GetArticleByFilterQuery implements CacheableQueryInterface
+#[QueryCache(ttl: 3600, tags: ['get_article', 'article'])]
+final readonly class GetArticleByFilterQuery
 {
-    public function __construct(public array $filters) {}
-
-    public function getCacheKey(): string
-    {
-        return sprintf('article_filters_%s', md5((string)json_encode($this->filters)));
-    }
-
-    public function getCacheTtl(): int
-    {
-        return 3600;
-    }
+    public function __construct(
+        public array $filters,
+    ) {}
 }

src/Application/Query/GetArticleByFilter/GetArticleByFilterQueryHandler.php

@@ -11,7 +11,9 @@
 #[AsMessageHandler]
 final readonly class GetArticleByFilterQueryHandler
 {
-    public function __construct(private BlogArticleRepository $articleRepository) {}
+    public function __construct(
+        private BlogArticleRepository $articleRepository,
+    ) {}
 
     public function __invoke(GetArticleByFilterQuery $query): ?BlogArticle
     {

src/Application/Query/GetArticleList/GetArticleListQuery.php

@@ -4,21 +4,12 @@
 
 namespace App\Application\Query\GetArticleList;
 
-use App\Application\Query\CacheableQueryInterface;
+use App\Application\Query\QueryCache;
 
-final readonly class GetArticleListQuery implements CacheableQueryInterface
+#[QueryCache(ttl: 3600, tags: ['list_article', 'article'])]
+final readonly class GetArticleListQuery
 {
     public function __construct(
         public ?int $limit = null,
     ) {}
-
-    public function getCacheKey(): string
-    {
-        return sprintf('articles_%s', $this->limit);
-    }
-
-    public function getCacheTtl(): int
-    {
-        return 3600;
-    }
 }