Improve planning performances (#232)

* Store organization/planning in cache based on request filters hash

* Invalidate cache older than lastUpdate planning

* Fix review

* Remove useless author tag

* Fix review

Author: vincentchalamon

composer.json

@@ -29,6 +29,7 @@
     "symfony/validator": "5.*",
     "symfony/webpack-encore-bundle": "^1.7",
     "symfony/yaml": "5.*",
+    "twig/cache-extension": "^1.4",
     "twig/intl-extra": "^3.0"
   },
   "require-dev": {

composer.lock

@@ -1,3 +1,8 @@
+services:
+    cache.adapter.planning:
+        class: App\Twig\Cache\PlanningFilesystemAdapter
+        parent: cache.adapter.filesystem
+
 framework:
     cache:
         # Unique name of your app: used to compute stable namespaces for cache keys.
@@ -15,5 +20,6 @@ framework:
         app: cache.adapter.apcu
 
         # Namespaced pools use the above "app" backend by default
-        #pools:
-            #my.dedicated.cache: null
+        pools:
+            cache.twig:
+                adapter: cache.adapter.planning

config/packages/cache.yaml

@@ -61,3 +61,17 @@ services:
              - !service { class: PDO, factory: ['@database_connection', 'getWrappedConnection'] }
             # If you get transaction issues (e.g. after login) uncomment the line below
              - { lock_mode: 1 }
+
+    # twig/cache-extension
+    Twig\CacheExtension\CacheProvider\PsrCacheAdapter:
+        arguments:
+            $cache: '@cache.twig'
+    Twig\CacheExtension\CacheStrategy\GenerationalCacheStrategy:
+        arguments:
+            $cache: '@Twig\CacheExtension\CacheProvider\PsrCacheAdapter'
+            $keyGenerator: '@App\Twig\Cache\RequestGenerator'
+            $lifetime: 86400 # 1 day
+    Twig\CacheExtension\CacheStrategyInterface: '@Twig\CacheExtension\CacheStrategy\GenerationalCacheStrategy'
+    Twig\CacheExtension\Extension:
+        arguments:
+            $cacheStrategy: '@Twig\CacheExtension\CacheStrategy\GenerationalCacheStrategy'

config/services.yaml

@@ -9,10 +9,13 @@
 use App\Domain\PlanningDomain;
 use App\Domain\SkillSetDomain;
 use App\Entity\CommissionableAsset;
+use Psr\Cache\CacheItemPoolInterface;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\Cache\CacheItem;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Annotation\Route;
+use Twig\CacheExtension\CacheStrategyInterface;
 
 /**
  * @Route("/", name="planning", methods={"GET"})
@@ -21,13 +24,19 @@ class PlanningController extends AbstractController
 {
     private SkillSetDomain $skillSetDomain;
     private PlanningDomain $planningDomain;
+    private CacheStrategyInterface $cacheStrategy;
+    private CacheItemPoolInterface $cacheTwig;
 
     public function __construct(
         SkillSetDomain $skillSetDomain,
-        PlanningDomain $planningDomain
+        PlanningDomain $planningDomain,
+        CacheStrategyInterface $cacheStrategy,
+        CacheItemPoolInterface $cacheTwig
     ) {
         $this->skillSetDomain = $skillSetDomain;
         $this->planningDomain = $planningDomain;
+        $this->cacheStrategy = $cacheStrategy;
+        $this->cacheTwig = $cacheTwig;
     }
 
     public function __invoke(Request $request): Response
@@ -46,12 +55,22 @@ public function __invoke(Request $request): Response
             $filters['to']
         );
 
-        $availabilities = $this->planningDomain->generateAvailabilities($filters, $periodCalculator->getPeriod());
+        $lastUpdate = $this->planningDomain->generateLastUpdateAndCount($filters)['lastUpdate'];
+        $cacheKey = $this->cacheStrategy->generateKey('organization_planning', $filters);
+        /** @var CacheItem $item */
+        $item = $this->cacheTwig->getItem($cacheKey);
+        if ($item->isHit()
+            && isset($item->getMetadata()[CacheItem::METADATA_CTIME])
+            && $item->getMetadata()[CacheItem::METADATA_CTIME] < ceil($lastUpdate / 100)
+        ) {
+            // New availabilities in planning: invalidate planning cache
+            $this->cacheTwig->deleteItem($cacheKey);
+        }
 
         return $this->render('organization/planning/planning.html.twig', [
+            'filters' => $filters,
             'form' => $form->createView(),
             'periodCalculator' => $periodCalculator,
-            'availabilities' => $availabilities,
             'assetsTypes' => CommissionableAsset::TYPES,
             'usersSkills' => $this->skillSetDomain->getSkillSet(),
             'importantSkills' => $this->skillSetDomain->getImportantSkills(),

src/Controller/Organization/Planning/PlanningController.php

@@ -100,7 +100,7 @@ public function generateLastUpdateAndCount(array $filters): array
         $users = $filters['hideUsers'] ?? false ? [] : $this->userRepository->findByFilters($filters, true);
         $assets = $filters['hideAssets'] ?? false ? [] : $this->assetRepository->findByFilters($filters, true);
 
-        // TODO Handle deleted availabities
+        // TODO Handle deleted availabilities
 
         $availabilitiesCount = 0;
         $userLastUpdate = 0;

src/Domain/PlanningDomain.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Twig\Cache;
+
+use Symfony\Component\Cache\Adapter\FilesystemAdapter;
+use Symfony\Component\Cache\Marshaller\MarshallerInterface;
+
+final class PlanningFilesystemAdapter extends FilesystemAdapter
+{
+    private string $cacheDirectory;
+
+    public function __construct(string $namespace = '', int $defaultLifetime = 0, string $directory = null, MarshallerInterface $marshaller = null)
+    {
+        parent::__construct($namespace, $defaultLifetime, $directory, $marshaller);
+
+        $this->cacheDirectory = $directory.\DIRECTORY_SEPARATOR.$namespace.\DIRECTORY_SEPARATOR;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function doFetch(array $ids)
+    {
+        /** @var array $values */
+        $values = parent::doFetch($ids);
+        foreach ($values as $id => $value) {
+            $file = $this->getFile($id);
+            if (!$handle = @fopen($file, 'rb')) {
+                continue;
+            }
+            $values[$id] = [
+                "\x9D".pack('VN', (int) (0.1 + (int) fgets($handle) - 1527506807), ceil(filectime($file) / 100))."\x5F" => $value,
+            ];
+            fclose($handle);
+        }
+
+        return $values;
+    }
+
+    private function getFile(string $id): string
+    {
+        // Use MD5 to favor speed over security, which is not an issue here
+        $hash = str_replace('/', '-', base64_encode(hash('md5', static::class.$id, true)));
+        $dir = $this->cacheDirectory.strtoupper($hash[0].\DIRECTORY_SEPARATOR.$hash[1].\DIRECTORY_SEPARATOR);
+
+        return $dir.substr($hash, 2, 20);
+    }
+}

src/Twig/Cache/PlanningFilesystemAdapter.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Twig\Cache;
+
+use Twig\CacheExtension\CacheStrategy\KeyGeneratorInterface;
+
+final class RequestGenerator implements KeyGeneratorInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function generateKey($filters): string
+    {
+        return sha1(serialize($filters));
+    }
+}

src/Twig/Cache/RequestGenerator.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Twig\Extension;
+
+use App\Domain\DatePeriodCalculator;
+use App\Domain\PlanningDomain;
+use Twig\Extension\AbstractExtension;
+use Twig\TwigFunction;
+
+final class PlanningExtension extends AbstractExtension
+{
+    private PlanningDomain $planningDomain;
+
+    public function __construct(PlanningDomain $planningDomain)
+    {
+        $this->planningDomain = $planningDomain;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getFunctions(): array
+    {
+        return [
+            new TwigFunction('getAvailabilities', [$this, 'getAvailabilities']),
+        ];
+    }
+
+    public function getAvailabilities(DatePeriodCalculator $periodCalculator, array $filters): array
+    {
+        return $this->planningDomain->generateAvailabilities($filters, $periodCalculator->getPeriod());
+    }
+}

src/Twig/Extension/PlanningExtension.php

@@ -631,6 +631,9 @@
     "theseer/tokenizer": {
         "version": "1.1.3"
     },
+    "twig/cache-extension": {
+        "version": "1.4.0"
+    },
     "twig/extra-bundle": {
         "version": "v3.0.3"
     },