Add support for caching the whole scoreboard.

Still WIP.

Author: nickygerritsen

etc/db-config.yaml

@@ -323,6 +323,14 @@
             default_value: true
             public: true
             description: If disabled, no ranking information is shown to contestants.
+        -   name: cache_full_scoreboard
+            type: bool
+            default_value: false
+            public: false
+            description: |
+                If enabled, will cache the whole scoreboard.
+                Make sure to clear the scoreboard cache after making changes to data
+                like teams, categories, affiliations or the contest when enabled.
 -   category: Authentication
     description: Options related to authentication.
     items:

webapp/composer.json

@@ -105,6 +105,7 @@
 		"symfony/web-profiler-bundle": "6.4.*",
 		"symfony/yaml": "6.4.*",
 		"twbs/bootstrap": "^5.2.0",
+		"twig/cache-extra": "^3.11",
 		"twig/extra-bundle": "^3.5",
 		"twig/markdown-extra": "^3.5",
 		"twig/string-extra": "^3.5",

webapp/composer.lock

@@ -95,6 +95,9 @@ public function indexAction(EventLogService $eventLogService, Request $request):
                     if ($category === 'Judging') {
                         $needsRejudging = true;
                     }
+                    if ($key === 'cache_full_scoreboard') {
+                        $needsRefresh = true;
+                    }
                 }
 
                 if ($needsRefresh) {

webapp/src/Controller/Jury/ConfigController.php

@@ -14,6 +14,7 @@
 use App\Service\ConfigurationService;
 use App\Service\DOMJudgeService;
 use App\Service\EventLogService;
+use App\Service\ScoreboardCacheService;
 use App\Service\ScoreboardService;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Query\Expr\Join;
@@ -188,13 +189,16 @@ public function ajaxDataAction(Request $request, string $datatype): JsonResponse
 
     #[IsGranted('ROLE_ADMIN')]
     #[Route(path: '/refresh-cache', name: 'jury_refresh_cache')]
-    public function refreshCacheAction(Request $request, ScoreboardService $scoreboardService): Response
-    {
+    public function refreshCacheAction(
+        Request $request,
+        ScoreboardService $scoreboardService,
+        ScoreboardCacheService $cache,
+    ): Response {
         // Note: we use a XMLHttpRequest here as Symfony does not support
         // streaming Twig output.
 
         $contests = $this->dj->getCurrentContests();
-        if ($cid = $request->request->get('cid')) {
+        if ($cid = $request->get('cid')) {
             if (!isset($contests[$cid])) {
                 throw new BadRequestHttpException(sprintf('Contest %s not found', $cid));
             }
@@ -204,17 +208,29 @@ public function refreshCacheAction(Request $request, ScoreboardService $scoreboa
             $contests = [$contest->getCid() => $contest];
         }
 
+        $onlyFullCache = $request->get('only_full_cache');
+
         if ($request->isXmlHttpRequest() && $request->isMethod('POST')) {
             $progressReporter = function (int $progress, string $log, ?string $message = null) {
                 echo $this->dj->jsonEncode(['progress' => $progress, 'log' => htmlspecialchars($log), 'message' => $message]);
                 ob_flush();
                 flush();
             };
-            return $this->streamResponse($this->requestStack, function () use ($contests, $progressReporter, $scoreboardService) {
+            return $this->streamResponse($this->requestStack, function () use (
+                $contests,
+                $progressReporter,
+                $scoreboardService,
+                $onlyFullCache,
+                $cache
+            ) {
                 $timeStart = microtime(true);
 
                 foreach ($contests as $contest) {
-                    $scoreboardService->refreshCache($contest, $progressReporter);
+                    if ($onlyFullCache) {
+                        $cache->invalidate($contest);
+                    } else {
+                        $scoreboardService->refreshCache($contest, $progressReporter);
+                    }
                 }
 
                 $timeEnd = microtime(true);

webapp/src/Controller/Jury/JuryMiscController.php

@@ -32,7 +32,8 @@ public function __construct(
         protected readonly DOMJudgeService $dj,
         protected readonly ScoreboardService $scoreboardService,
         protected readonly EventLogService $eventLogService,
-        protected readonly BalloonService $balloonService
+        protected readonly BalloonService $balloonService,
+        protected readonly ScoreboardCacheService $cache,
     ) {}
 
     /**
@@ -381,6 +382,7 @@ public function finishRejudging(Rejudging $rejudging, string $action, ?callable
                     }
                     $this->scoreboardService->updateRankCache($contest, $team);
                 }
+                $this->cache->invalidate($contest);
             }
         }
 

webapp/src/Service/RejudgingService.php

@@ -0,0 +1,47 @@
+<?php declare(strict_types=1);
+
+namespace App\Service;
+
+use App\Entity\Contest;
+use Symfony\Contracts\Cache\ItemInterface;
+use Symfony\Contracts\Cache\TagAwareCacheInterface;
+
+class ScoreboardCacheService
+{
+    public function __construct(
+        protected readonly ConfigurationService $config,
+        protected readonly TagAwareCacheInterface $twigCache,
+    ) {}
+
+    /**
+     * @template T
+     * @param Contest $contest
+     * @param string $cacheKey
+     * @param callable(): T $callable
+     *
+     * @return T
+     */
+    public function cacheScoreboardData(
+        Contest $contest,
+        string $cacheKey,
+        callable $callable
+    ): mixed {
+        if (!$this->config->get('cache_full_scoreboard')) {
+            return $callable();
+        }
+
+        return $this->twigCache->get($cacheKey, function (ItemInterface $item) use (
+            $callable,
+            $contest
+        ) {
+            $item->tag('scoreboard_' . $contest->getCid());
+
+            return $callable();
+        });
+    }
+
+    public function invalidate(Contest $contest): void
+    {
+        $this->twigCache->invalidateTags(['scoreboard_' . $contest->getCid()]);
+    }
+}