Add the ability to cache installed version

Author: msmakouz

psalm.xml

@@ -4,6 +4,8 @@
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns="https://getpsalm.org/schema/config"
         xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+        findUnusedCode="false"
+        findUnusedBaselineEntry="true"
 >
     <projectFiles>
         <directory name="src" />

src/Environment/EnvironmentInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RoadRunner\VersionChecker\Environment;
+
+interface EnvironmentInterface
+{
+    /**
+     * @param non-empty-string $name
+     */
+    public function get(string $name, mixed $default = null): mixed;
+}

src/Environment/Native.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RoadRunner\VersionChecker\Environment;
+
+final class Native implements EnvironmentInterface
+{
+    public function __construct(
+        private array $values = []
+    ) {
+        $this->values = $values + $_ENV + $_SERVER;
+    }
+
+    /**
+     * @param non-empty-string $name
+     */
+    public function get(string $name, mixed $default = null): mixed
+    {
+        return $this->values[$name] ?? $default;
+    }
+}

src/Version/Installed.php

@@ -4,18 +4,28 @@
 
 namespace RoadRunner\VersionChecker\Version;
 
+use RoadRunner\VersionChecker\Environment\EnvironmentInterface;
+use RoadRunner\VersionChecker\Environment\Native;
 use RoadRunner\VersionChecker\Exception\RoadrunnerNotInstalledException;
 use RoadRunner\VersionChecker\Process\Process;
 use RoadRunner\VersionChecker\Process\ProcessInterface;
 use Symfony\Component\Process\Exception\ProcessFailedException;
 
 final class Installed implements InstalledInterface
 {
+    private const ENV_VARIABLE = 'RR_VERSION';
+
+    /**
+     * @var non-empty-string|null
+     */
+    private static ?string $cachedVersion = null;
+
     /**
      * @param non-empty-string $executablePath
      */
     public function __construct(
         private readonly ProcessInterface $process = new Process(),
+        private readonly EnvironmentInterface $environment = new Native(),
         private readonly string $executablePath = './rr'
     ) {
     }
@@ -26,6 +36,42 @@ public function __construct(
      * @throws RoadrunnerNotInstalledException
      */
     public function getInstalledVersion(): string
+    {
+        if (!empty(self::$cachedVersion)) {
+            return self::$cachedVersion;
+        }
+
+        if (!empty(self::$cachedVersion = $this->getVersionFromEnv())) {
+            return self::$cachedVersion;
+        }
+
+        if (!empty(self::$cachedVersion = $this->getVersionFromConsoleCommand())) {
+            return self::$cachedVersion;
+        }
+
+        throw new RoadrunnerNotInstalledException('Unable to determine RoadRunner version.');
+    }
+
+    /**
+     * @return non-empty-string|null
+     */
+    private function getVersionFromEnv(): ?string
+    {
+        /** @var string|null $version */
+        $version = $this->environment->get(self::ENV_VARIABLE);
+
+        if (\is_string($version) && !empty($version)) {
+            return $version;
+        }
+
+        return null;
+    }
+
+    /**
+     * @return non-empty-string|null
+     * @throws RoadrunnerNotInstalledException
+     */
+    private function getVersionFromConsoleCommand(): ?string
     {
         try {
             $output = $this->process->exec([$this->executablePath, '--version']);
@@ -35,10 +81,10 @@ public function getInstalledVersion(): string
 
         \preg_match('/\bversion (\d+\.\d+\.\d+[\w.-]*)/', $output, $matches);
 
-        if (!empty($matches[1])) {
+        if (isset($matches[1]) && !empty($matches[1])) {
             return $matches[1];
         }
 
-        throw new RoadrunnerNotInstalledException('Unable to determine RoadRunner version.');
+        return null;
     }
 }

tests/src/Unit/Environment/NativeTest.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RoadRunner\VersionChecker\Tests\Unit\Environment;
+
+use PHPUnit\Framework\TestCase;
+use RoadRunner\VersionChecker\Environment\Native;
+
+final class NativeTest extends TestCase
+{
+    /**
+     * @dataProvider valuesDataProvider
+     */
+    public function testGet(mixed $value, mixed $expected, string $key): void
+    {
+        $native = new Native([
+            '1' => '2.12.3',
+            '2' => 1,
+            '3' => true,
+        ]);
+
+        $this->assertSame($expected, $native->get($key));
+    }
+
+
+    public static function valuesDataProvider(): \Traversable
+    {
+        yield ['2.12.3', '2.12.3', '1'];
+        yield [1, 1, '2'];
+        yield [true, true, '3'];
+    }
+}

tests/src/Unit/Version/ComparatorTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace RoadRunner\VersionChecker\Tests\Unit;
+namespace RoadRunner\VersionChecker\Tests\Unit\Version;
 
 use PHPUnit\Framework\TestCase;
 use RoadRunner\VersionChecker\Version\Comparator;

tests/src/Unit/Version/InstalledTest.php

@@ -2,16 +2,23 @@
 
 declare(strict_types=1);
 
-namespace RoadRunner\VersionChecker\Tests\Unit;
+namespace RoadRunner\VersionChecker\Tests\Unit\Version;
 
 use PHPUnit\Framework\TestCase;
+use RoadRunner\VersionChecker\Environment\EnvironmentInterface;
 use RoadRunner\VersionChecker\Exception\RoadrunnerNotInstalledException;
 use RoadRunner\VersionChecker\Process\ProcessInterface;
 use RoadRunner\VersionChecker\Version\Installed;
 use Symfony\Component\Process\Exception\ProcessFailedException;
 
 final class InstalledTest extends TestCase
 {
+    protected function tearDown(): void
+    {
+        // clean the cache
+        (new \ReflectionProperty(Installed::class, 'cachedVersion'))->setValue(null);
+    }
+
     /**
      * @dataProvider outputDataProvider
      */
@@ -29,6 +36,63 @@ public function testGetInstalledVersion(string $version, string $output): void
         $this->assertSame($version, $installed->getInstalledVersion());
     }
 
+    public function testCachedVersion(): void
+    {
+        $env = $this->createMock(EnvironmentInterface::class);
+        $env
+            // $this->once() is important for this test!
+            ->expects($this->once())
+            ->method('get')
+            ->with('RR_VERSION')
+            ->willReturn('2023.1.0');
+
+        $installed = new Installed(environment: $env);
+
+        $version = $installed->getInstalledVersion();
+        $version2 = $installed->getInstalledVersion();
+
+        $this->assertSame('2023.1.0', $version);
+        $this->assertSame('2023.1.0', $version2);
+    }
+
+    public function getVersionFromEnv(): void
+    {
+        $env = $this->createMock(EnvironmentInterface::class);
+        $env
+            ->expects($this->once())
+            ->method('get')
+            ->with('RR_VERSION')
+            ->willReturn('2023.1.0');
+
+        $process = $this->createMock(ProcessInterface::class);
+        $process->expects($this->never());
+
+        $installed = new Installed($process, $env);
+
+        $this->assertSame('2023.1.0', $installed->getInstalledVersion());
+    }
+
+    public function getVersionFromConsoleCommand(): void
+    {
+        $env = $this->createMock(EnvironmentInterface::class);
+        $env
+            ->expects($this->once())
+            ->method('get')
+            ->with('RR_VERSION')
+            ->willReturn(null);
+
+        $process = $this->createMock(ProcessInterface::class);
+        $process
+            ->expects($this->once())
+            ->method('exec')
+            ->with(['./rr', '--version'])
+            ->willReturn('version 2023.1.0');
+
+        $installed = new Installed($process, $env);
+
+        $this->assertSame('2023.1.0', $installed->getInstalledVersion());
+    }
+
     public function testGetInstalledVersionRoadRunnerIsNotInstalled(): void
     {
         $process = $this->createMock(ProcessInterface::class);