Merge pull request #24 from jmsche/cache-latest-version

Author: Kocal

composer.json

@@ -22,6 +22,7 @@
     ],
     "require": {
         "php": ">=8.1",
+        "symfony/cache": "^6.4|^7.0",
         "symfony/console": "^6.4|^7.0",
         "symfony/http-client": "^6.4|^7.0",
         "symfony/process": "^6.4|^7.0"

config/services.php

@@ -12,11 +12,17 @@
 
 return static function (ContainerConfigurator $container): void {
     $container->services()
+        ->set('.biomejs.cache')
+            ->parent('cache.system')
+            ->private()
+            ->tag('cache.pool')
+
         ->set('biomejs.binary', BiomeJsBinary::class)
         ->args([
             param('kernel.project_dir'),
             param('kernel.project_dir').'/var/biomejs',
             abstract_arg('Biome.js binary version'),
+            service('.biomejs.cache'),
         ])
         ->alias(BiomeJsBinaryInterface::class, 'biomejs.binary')
 

src/BiomeJsBinary.php

@@ -4,6 +4,7 @@
 
 namespace Kocal\BiomeJsBundle;
 
+use Psr\Cache\CacheItemPoolInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Symfony\Component\HttpClient\HttpClient;
 use Symfony\Component\HttpClient\RetryableHttpClient;
@@ -29,6 +30,7 @@ public function __construct(
         private readonly string $cwd,
         private readonly string $binaryDownloadDir,
         private readonly ?string $binaryVersion,
+        private readonly CacheItemPoolInterface $cache,
         ?HttpClientInterface $httpClient = null,
     ) {
         if (null === $this->binaryVersion) {
@@ -121,6 +123,20 @@ private function getLatestVersion(): string
     {
         $useStable = null === $this->binaryVersion || 'latest_stable' === $this->binaryVersion;
         $useNightly = 'latest_nightly' === $this->binaryVersion;
+        $cacheKey = sprintf(
+            'binary.latest_version.%s.%s',
+            match (true) {
+                $useStable => 'stable',
+                $useNightly => 'nightly',
+                default => throw new \LogicException('Invalid configuration'),
+            },
+            self::getBinaryName(),
+        );
+        $cacheItem = $this->cache->getItem($cacheKey);
+
+        if (($cachedLatestVersion = $cacheItem->get()) && is_string($cachedLatestVersion)) {
+            return $cachedLatestVersion;
+        }
 
         try {
             $response = $this->httpClient->request('GET', 'https://api.github.com/repos/biomejs/biome/releases');
@@ -138,7 +154,13 @@ private function getLatestVersion(): string
                     continue;
                 }
 
-                return str_replace('cli/', '', $release['tag_name']);
+                $latestVersion = str_replace('cli/', '', $release['tag_name']);
+
+                $cacheItem->set($latestVersion);
+                $cacheItem->expiresAfter(new \DateInterval('P1W'));
+                $this->cache->save($cacheItem);
+
+                return $latestVersion;
             }
 
             throw new \Exception('Unable to find the latest Biome.js CLI release.');

tests/BiomeJsBinaryTest.php

@@ -7,17 +7,19 @@
 use Kocal\BiomeJsBundle\BiomeJsBinary;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Cache\Adapter\ArrayAdapter;
 use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\HttpClient\MockHttpClient;
 use Symfony\Component\HttpClient\Response\JsonMockResponse;
 use Symfony\Component\HttpClient\Response\MockResponse;
-use Symfony\Contracts\HttpClient\HttpClientInterface;
 
 final class BiomeJsBinaryTest extends TestCase
 {
     private const BINARY_DOWNLOAD_DIR = __DIR__ . '/fixtures/var/download';
 
-    private HttpClientInterface $httpClient;
+    private MockHttpClient $httpClient;
+
+    private ArrayAdapter $cache;
 
     protected function setUp(): void
     {
@@ -51,6 +53,8 @@ protected function setUp(): void
 
             return new MockResponse('Not Found', ['http_code' => 404]);
         });
+
+        $this->cache = new ArrayAdapter();
     }
 
     /**
@@ -71,6 +75,7 @@ public function testBinaryIsDownloadedIfNotExists(?string $passedVersion, string
             __DIR__,
             self::BINARY_DOWNLOAD_DIR,
             $passedVersion,
+            $this->cache,
             $this->httpClient,
         );
         $process = $binary->createProcess(['check', '--apply', '*.{js,ts}']);
@@ -83,5 +88,34 @@ public function testBinaryIsDownloadedIfNotExists(?string $passedVersion, string
             sprintf($expectedTemplate, self::BINARY_DOWNLOAD_DIR . '/' . $expectedVersion . '/' . BiomeJsBinary::getBinaryName()),
             $process->getCommandLine()
         );
+
+        $cacheValues = $this->cache->getValues();
+        if (null !== $passedVersion && str_starts_with($passedVersion, 'v')) {
+            // A specific version was passed, so no HTTP call expected and no cache call
+            self::assertCount(0, $cacheValues);
+        } else {
+            // No specific version was passed, so an HTTP call expected and cache should be set
+            self::assertCount(1, $cacheValues);
+            self::assertSame($expectedVersion, unserialize($cacheValues[array_key_first($cacheValues)]));
+
+            // Check that the binary is not downloaded again, but the cache is used
+            $binary = $this->cloneAndResetBinary($binary);
+            $this->httpClient->setResponseFactory(fn () => throw new \LogicException('No HTTP request should be made'));
+            $binary->createProcess(['check', '--apply', '*.{js,ts}']);
+
+            $cacheValues = $this->cache->getValues();
+            self::assertCount(1, $cacheValues);
+            self::assertSame($expectedVersion, unserialize($cacheValues[array_key_first($cacheValues)]));
+        }
+    }
+
+    private function cloneAndResetBinary(BiomeJsBinary $binary): BiomeJsBinary
+    {
+        $binary = clone $binary;
+
+        $reflProperty = new \ReflectionProperty($binary, 'cachedVersion');
+        $reflProperty->setValue($binary, null);
+
+        return clone $binary;
     }
 }