[BUGFIX] Do not cache public json endpoint

.github/workflows/continuous-integration.yml

@@ -77,7 +77,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           coverage: none
-          extensions: ctype, iconv, json, sqlit3, tokenizer, zip, zlib
+          extensions: ctype, iconv, json, sqlite3, tokenizer, zip, zlib
           ini-values: memory_limit=-1, error_reporting=E_ALL, display_errors=On
           php-version: latest
           tools: composer:2
@@ -115,7 +115,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           coverage: none
-          extensions: ctype, iconv, json, sqlit3, tokenizer, zip, zlib
+          extensions: ctype, iconv, json, sqlite3, tokenizer, zip, zlib
           ini-values: memory_limit=-1, error_reporting=E_ALL, display_errors=On
           php-version: latest
           tools: composer:2
@@ -166,7 +166,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           coverage: none
-          extensions: ctype, iconv, json, sqlit3, tokenizer, zip, zlib
+          extensions: ctype, iconv, json, sqlite3, tokenizer, zip, zlib
           ini-values: memory_limit=-1, error_reporting=E_ALL, display_errors=On
           php-version: ${{ matrix.php-version }}
           tools: composer:2
@@ -214,7 +214,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           coverage: none
-          extensions: ctype, iconv, json, sqlit3, tokenizer, zip, zlib
+          extensions: ctype, iconv, json, sqlite3, tokenizer, zip, zlib
           ini-values: memory_limit=-1, error_reporting=E_ALL, display_errors=On
           php-version: latest
           tools: composer:2
@@ -254,7 +254,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           coverage: none
-          extensions: ctype, iconv, json, sqlit3, tokenizer, zip, zlib
+          extensions: ctype, iconv, json, sqlite3, tokenizer, zip, zlib
           ini-values: memory_limit=-1, error_reporting=E_ALL, display_errors=On
           php-version: latest
           tools: composer:2
@@ -294,7 +294,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           coverage: none
-          extensions: ctype, iconv, json, sqlit3, tokenizer, zip, zlib
+          extensions: ctype, iconv, json, sqlite3, tokenizer, zip, zlib
           ini-values: memory_limit=-1, error_reporting=E_ALL, display_errors=On
           php-version: latest
           tools: composer:2
@@ -334,7 +334,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           coverage: none
-          extensions: ctype, iconv, json, sqlit3, tokenizer, zip, zlib
+          extensions: ctype, iconv, json, sqlite3, tokenizer, zip, zlib
           ini-values: memory_limit=-1, error_reporting=E_ALL, display_errors=On
           php-version: latest
           tools: composer:2
@@ -398,7 +398,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           coverage: none
-          extensions: ctype, iconv, json, sqlit3, tokenizer, zip, zlib
+          extensions: ctype, iconv, json, sqlite3, tokenizer, zip, zlib
           ini-values: memory_limit=-1
           php-version: ${{ matrix.php-version }}
           tools: composer:2
@@ -487,7 +487,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           coverage: xdebug
-          extensions: ctype, iconv, json, sqlit3, tokenizer, zip, zlib
+          extensions: ctype, iconv, json, sqlite3, tokenizer, zip, zlib
           ini-values: memory_limit=-1, error_reporting=E_ALL, display_errors=On
           php-version: ${{ matrix.php-version }}
           tools: composer:2

composer.json

@@ -54,6 +54,7 @@
         "sensio/framework-extra-bundle": "^6.1",
         "symfony/asset": "5.4.*",
         "symfony/cache": "5.4.*",
+        "symfony/cache-contracts": "^2.5",
         "symfony/console": "5.4.*",
         "symfony/dependency-injection": "5.4.*",
         "symfony/dotenv": "5.4.*",

src/Controller/Api/AbstractController.php

@@ -36,10 +36,12 @@
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\Validator\ConstraintViolationInterface;
+use Symfony\Contracts\Cache\TagAwareCacheInterface;
 
 class AbstractController extends \Symfony\Bundle\FrameworkBundle\Controller\AbstractController
 {
     public function __construct(
+        private readonly TagAwareCacheInterface $cache,
         private readonly \JMS\Serializer\SerializerInterface $serializer,
         private readonly \Doctrine\Persistence\ManagerRegistry $managerRegistry,
         private readonly \App\Repository\MajorVersionRepository $majorVersions,
@@ -49,6 +51,11 @@ public function __construct(
     ) {
     }
 
+    protected function getCache(): TagAwareCacheInterface
+    {
+        return $this->cache;
+    }
+
     protected function getSerializer(): SerializerInterface
     {
         return $this->serializer;

src/Controller/Api/CacheController.php

@@ -26,7 +26,6 @@
 use Nelmio\ApiDocBundle\Annotation\Security as DocSecurity;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\IsGranted;
 use Swagger\Annotations as SWG;
-use Symfony\Component\Cache\Adapter\FilesystemAdapter;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Annotation\Route;
@@ -156,10 +155,7 @@ private function getPurgeUrlsForMajorVersion(float $version): array
      */
     private function deleteReleases(): void
     {
-        $filesystemAdapter = new FilesystemAdapter();
-        if ($filesystemAdapter->hasItem('releases.json')) {
-            $filesystemAdapter->delete('releases.json');
-        }
+        $this->getCache()->invalidateTags(['releases']);
     }
 
     /**

src/Controller/DefaultController.php

@@ -27,7 +27,6 @@
 use App\Entity\Release;
 use App\Utility\VersionUtility;
 use InvalidArgumentException;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Cache;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\RedirectResponse;
@@ -39,8 +38,6 @@
 
 /**
  * Regular content and download pages
- *
- * @Cache(maxage="3600", public=true)
  */
 class DefaultController extends AbstractController
 {
@@ -82,22 +79,6 @@ public function apiDoc(): RedirectResponse
         return $this->redirectToRoute('app.swagger_ui');
     }
 
-    /**
-     * Outputs the JSON file
-     * /json
-     * Legacy end point
-     */
-    #[Route(path: '/json', methods: ['GET'], name: 'legacy-releases-json')]
-    public function releaseJson(): Response
-    {
-        $content = $this->legacyDataService->getReleaseJson();
-        $headers = [
-            'Content-type'                => 'application/json',
-            'Access-Control-Allow-Origin' => '*',
-        ];
-        return new Response($content, \Symfony\Component\HttpFoundation\Response::HTTP_OK, $headers);
-    }
-
     /**
      * Display release notes for a version
      */

src/Controller/JsonController.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the package t3o/get.typo3.org.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace App\Controller;
+
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
+
+#[Route(path: '/json', methods: ['GET'], name: 'json_')]
+class JsonController extends AbstractController
+{
+    public function __construct(
+        private \App\Service\LegacyDataService $legacyDataService,
+    ) {
+    }
+
+    // Route has set a priority to avoid conflicts with `specificversion`
+    #[Route(path: '', methods: ['GET'], name: 'index', priority: 1)]
+    public function index(): Response
+    {
+        $content = $this->legacyDataService->getReleaseJson();
+        $headers = [
+            'Content-type'                => 'application/json',
+            'Access-Control-Allow-Origin' => '*',
+        ];
+        return new Response($content, \Symfony\Component\HttpFoundation\Response::HTTP_OK, $headers);
+    }
+}

src/Service/LegacyDataService.php

@@ -23,43 +23,28 @@
 
 namespace App\Service;
 
-use App\Entity\MajorVersion;
 use App\Repository\MajorVersionRepository;
-use Doctrine\ORM\EntityManagerInterface;
-use Symfony\Component\Cache\Adapter\FilesystemAdapter;
 use Symfony\Contracts\Cache\ItemInterface;
+use Symfony\Contracts\Cache\TagAwareCacheInterface;
 
 class LegacyDataService
 {
-    public function __construct(private readonly EntityManagerInterface $entityManager)
-    {
+    public function __construct(
+        private readonly TagAwareCacheInterface $cache,
+        private readonly MajorVersionRepository $majorVersionRepository,
+    ) {
     }
 
     public function getReleaseJson(): string
     {
-        /*
-        $cache = new FilesystemAdapter();
-        $result = $cache->get('releases.json', function (ItemInterface $item): string {
-            /** @var MajorVersionRepository $majorVersions * /
-            $majorVersions = $this->entityManager->getRepository(MajorVersion::class);
-            $content = json_encode($majorVersions->findAllPreparedForJson(), JSON_THROW_ON_ERROR);
+        $result = $this->cache->get('releases.json', function (ItemInterface $item): string {
+            $item->tag(['releases']);
+            $content = json_encode($this->majorVersionRepository->findAllPreparedForJson(), JSON_THROW_ON_ERROR);
             $content = $content != false ? $content : '';
             // remove version suffix only used for version sorting
             return str_replace('.0000', '', $content);
         });
 
-        if (!is_string($result)) {
-            throw new \RuntimeException(sprintf('String expected but %s given.', gettype($result)));
-        }
-        */
-
-        /** @var MajorVersionRepository $majorVersions */
-        $majorVersions = $this->entityManager->getRepository(MajorVersion::class);
-        $content = json_encode($majorVersions->findAllPreparedForJson(), JSON_THROW_ON_ERROR);
-        $content = $content != false ? $content : '';
-        // remove version suffix only used for version sorting
-        $result = str_replace('.0000', '', $content);
-
         return $result;
     }
 }

tests/Functional/Controller/Web/JsonControllerTest.php

@@ -0,0 +1,65 @@
+<?php
+
+/*
+ * This file is part of the package t3o/get.typo3.org.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace App\Tests\Functional\Controller\Web;
+
+use App\DataFixtures\MajorVersionFixtures;
+use App\DataFixtures\ReleaseFixtures;
+use App\DataFixtures\RequirementFixtures;
+use App\Tests\Functional\AbstractCase;
+use RuntimeException;
+use Symfony\Component\HttpFoundation\Response;
+
+class JsonControllerTest extends AbstractCase
+{
+    public function setUp(): void
+    {
+        parent::setUp();
+        $this->addFixture(new MajorVersionFixtures());
+        $this->addFixture(new ReleaseFixtures());
+        $this->addFixture(new RequirementFixtures());
+        $this->executeFixtures();
+    }
+
+    /**
+     * @test
+     */
+    public function index(): void
+    {
+        $this->client->request('GET', '/json');
+        $response = $this->client->getResponse();
+
+        if (($json = $response->getContent()) === false) {
+            throw new RuntimeException('Error no response content.', 1_657_642_832);
+        }
+
+        if (!\is_array($content = json_decode($json, true, 512, JSON_THROW_ON_ERROR))) {
+            throw new RuntimeException('Error array expected.', 1_657_642_833);
+        }
+
+        self::assertSame(Response::HTTP_OK, $response->getStatusCode());
+        self::assertArrayHasKey('10', $content);
+        self::assertArrayHasKey('latest_stable', $content);
+        self::assertArrayHasKey('latest_old_stable', $content);
+        self::assertArrayHasKey('latest_lts', $content);
+        self::assertArrayHasKey('latest_old_lts', $content);
+    }
+}