Accept intermediate Symfony branches

Author: fabpot

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## Unreleased
 
-- Report unsupported Symfony branches from live release metadata
+- Report Symfony branches outside the live supported range
 - Ignore Twig macro declarations that share a name with custom functions
 - Recognize PHP heredoc translation messages and global parameters
 - Buffer persistent source index rewrites

docs/features/index.rst

@@ -174,14 +174,15 @@ Symfony Version Support
 -----------------------
 
 During runtime indexing, Symfony Language Tools checks the installed branch
-against Symfony's `release metadata`_. Each project's metadata cache is
-refreshed at most once per hour under ``var/symfony-lsp/``. If a refresh fails,
-the last cached metadata is used. Without a cache, runtime indexing continues
-without the support check.
-
-If the installed branch isn't supported, the application isn't booted. The
-editor or diagnostics checker reports the detected version and static-only
-features remain active.
+against the range between the oldest and newest branches in Symfony's `release
+metadata`_. Intermediate branches are accepted. Each project's metadata cache
+is refreshed at most once per hour under ``var/symfony-lsp/``. If a refresh
+fails, the last cached metadata is used. Without a cache, runtime indexing
+continues without the support check.
+
+If the installed branch falls outside the supported range, the application
+isn't booted. The editor or diagnostics checker reports the detected version
+and static-only features remain active.
 
 Unsaved Files and Refreshes
 ---------------------------

resources/bridge.php

@@ -108,7 +108,7 @@
     && is_string($releaseMetadataCache) && '' !== $releaseMetadataCache
 ) {
     $supportedVersions = symfonyLspBridgeSupportedVersions($releaseMetadataUrl, $releaseMetadataCache);
-    if (is_array($supportedVersions) && !in_array($matches[1], $supportedVersions, true)) {
+    if (is_array($supportedVersions) && !symfonyLspBridgeSupportsBranch($matches[1], $supportedVersions)) {
         fwrite(STDOUT, json_encode([
             'schemaVersion' => 1,
             'project' => $projectMetadata,

resources/bridge/support.php

@@ -49,6 +49,26 @@ function symfonyLspBridgeSupportedVersions(string $url, string $cache): ?array
     return is_string($cached) ? symfonyLspBridgeDecodeSupportedVersions($cached) : null;
 }
 
+/** @param list<string> $supportedVersions */
+function symfonyLspBridgeSupportsBranch(string $branch, array $supportedVersions): bool
+{
+    if ([] === $supportedVersions) {
+        return false;
+    }
+
+    $oldest = $newest = $supportedVersions[0];
+    foreach ($supportedVersions as $version) {
+        if (version_compare($version, $oldest, '<')) {
+            $oldest = $version;
+        }
+        if (version_compare($version, $newest, '>')) {
+            $newest = $version;
+        }
+    }
+
+    return version_compare($branch, $oldest, '>=') && version_compare($branch, $newest, '<=');
+}
+
 /** @return list<string>|null */
 function symfonyLspBridgeDecodeSupportedVersions(string $metadata): ?array
 {

tests/Runtime/BridgeTest.php

@@ -42,9 +42,10 @@ public function testReportsProjectMetadataWithoutAStaticBranchList(string $versi
         self::assertFalse($result['project']['debug']);
     }
 
-    public function testReportsBranchesMissingFromReleaseMetadataWithoutBootingTheApplication(): void
+    #[DataProvider('unsupportedBranchProvider')]
+    public function testReportsBranchesOutsideTheReleaseMetadataRangeWithoutBootingTheApplication(string $version, string $branch): void
     {
-        (new AutoloaderFixtureBuilder($this->workspace))->writeAutoloader('5.4.45');
+        (new AutoloaderFixtureBuilder($this->workspace))->writeAutoloader($version);
         $metadata = $this->workspace->write('releases.json', json_encode([
             'supported_versions' => ['6.4', '7.4', '8.1'],
         ], \JSON_THROW_ON_ERROR));
@@ -60,11 +61,28 @@ public function testReportsBranchesMissingFromReleaseMetadataWithoutBootingTheAp
         self::assertTrue($process->snapshot['unsupportedSymfonyVersion'] ?? false);
         $project = $process->snapshot['project'] ?? null;
         self::assertIsArray($project);
-        self::assertSame('5.4', $project['symfonyBranch'] ?? null);
+        self::assertSame($branch, $project['symfonyBranch'] ?? null);
         self::assertArrayNotHasKey('configurationValidation', $process->snapshot);
         self::assertSame((string) file_get_contents($metadata), (string) file_get_contents($cache));
     }
 
+    public function testAcceptsIntermediateBranchesWithinTheReleaseMetadataRange(): void
+    {
+        (new AutoloaderFixtureBuilder($this->workspace))->writeAutoloader('8.0.13');
+        $metadata = $this->workspace->write('releases.json', json_encode([
+            'supported_versions' => ['8.1', '6.4', '7.4'],
+        ], \JSON_THROW_ON_ERROR));
+
+        $process = $this->bridge->run([
+            '--release-metadata-url='.$metadata,
+            '--release-metadata-cache='.$this->workspace->path.'/release-metadata-cache.json',
+        ]);
+
+        self::assertSame(0, $process->exitCode, $process->stderr."\n".$process->stdout);
+        self::assertIsArray($process->snapshot);
+        self::assertArrayNotHasKey('unsupportedSymfonyVersion', $process->snapshot);
+    }
+
     public function testUsesStaleReleaseMetadataWhenRefreshFails(): void
     {
         (new AutoloaderFixtureBuilder($this->workspace))->writeAutoloader('5.4.45');
@@ -131,6 +149,13 @@ public static function versionProvider(): iterable
         yield 'prerelease' => ['42.7.0-RC1'];
     }
 
+    /** @return iterable<string, array{string, string}> */
+    public static function unsupportedBranchProvider(): iterable
+    {
+        yield 'older' => ['5.4.45', '5.4'];
+        yield 'newer' => ['8.2.0-BETA1', '8.2'];
+    }
+
     public function testKeepsStrayProjectOutputOffTheStdoutPayload(): void
     {
         (new AutoloaderFixtureBuilder($this->workspace))->writeStrayOutputApplication();

tests/Runtime/ProjectRuntimeInitializerTest.php

@@ -245,16 +245,16 @@ public function testReportsSymfonyBranchesRejectedByReleaseMetadata(): void
         $initializer->initialize($project);
     }
 
-    public function testAcceptsFutureSymfonyBranchesWithoutAStaticBranchList(): void
+    public function testAcceptsIntermediateSymfonyBranchesWithoutAnUnsupportedMarker(): void
     {
         $source = $this->temporaryDirectory.'/source.php';
         file_put_contents($source, '<?php');
         $processRunner = new CapturingProcessRunner(new ProcessResult(0, json_encode([
             'schemaVersion' => 1,
-            'project' => ['symfonyBranch' => '42.7'],
+            'project' => ['symfonyBranch' => '8.0'],
             'sections' => [],
         ], \JSON_THROW_ON_ERROR), ''));
-        $project = new Project($this->temporaryDirectory, 'file://'.$this->temporaryDirectory, '^42.7');
+        $project = new Project($this->temporaryDirectory, 'file://'.$this->temporaryDirectory, '^8.0');
         $initializer = (new ProjectRuntimeInitializerFixtureBuilder($source))->build(
             $processRunner,
             new RuntimeSnapshotLoaderRegistry([]),