Keep partial runtime diagnostics available

Author: fabpot

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 
+- Keep diagnostics from healthy runtime metadata sections after a partial bridge failure
 - Add GitLab Code Quality reports to the diagnostics checker
 - Suppress code-qualified diagnostics with source comments
 - Honor router request context parameters in route diagnostics

docs/features/headless-diagnostics.rst

@@ -101,7 +101,10 @@ Reports indicate whether each project used runtime or source-only analysis. If
 invalid application configuration prevents runtime analysis, the report
 identifies the configuration failure and remains incomplete. Other runtime
 failures also exit with status ``12`` instead of silently switching to
-source-only analysis.
+source-only analysis. If one runtime metadata section fails after other sections
+load, diagnostics backed by the healthy sections are still reported. Last
+successful metadata for the failed section remains active when available;
+otherwise diagnostics that need it are omitted.
 
 Configuring the Check
 ---------------------

docs/features/index.rst

@@ -168,7 +168,9 @@ enable it for a project whose code you would not run from the command line.
 Without runtime indexing, Symfony Language Tools continues to provide features
 from project files. Features that need the application's current routes,
 services or other runtime information may be incomplete. Diagnostics that need
-this information are omitted.
+this information are omitted. If one runtime metadata section fails while other
+sections load, features backed by the healthy sections remain available and the
+editor reports the partial failure.
 
 Symfony Version Support
 -----------------------

src/Check/CheckProjectAnalyzer.php

@@ -6,6 +6,7 @@
 use Symfony\Lsp\Feature\Configuration\ConfigurationValidationException;
 use Symfony\Lsp\Index\ApplicationSourceScanner;
 use Symfony\Lsp\Index\ProjectIndexStatusRegistry;
+use Symfony\Lsp\Runtime\PartialRuntimeMetadataException;
 use Symfony\Lsp\Runtime\RuntimeConfiguration;
 use Symfony\Lsp\Runtime\RuntimeInitializerInterface;
 
@@ -102,7 +103,7 @@ public function analyze(CheckPlan $plan, CheckRunCancellation $cancellation): Ch
                             $status['runtime']['error'] ?? 'Runtime indexing did not complete.',
                         );
                         $complete[$root] = false;
-                        if ($runtimeError instanceof ConfigurationValidationException) {
+                        if ($runtimeError instanceof ConfigurationValidationException || $runtimeError instanceof PartialRuntimeMetadataException) {
                             $diagnosable[$root] = true;
                         }
 

src/Runtime/PartialRuntimeMetadataException.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Symfony\Lsp\Runtime;
+
+final class PartialRuntimeMetadataException extends \RuntimeException
+{
+    /** @param non-empty-list<string> $sections */
+    public function __construct(public readonly array $sections)
+    {
+        parent::__construct('The project bridge could not load runtime metadata: '.implode(', ', $sections).'.');
+    }
+}

src/Runtime/ProjectRuntimeInitializer.php

@@ -107,6 +107,15 @@ public function initialize(Project $project, ?RuntimeRefreshPlan $plan = null, ?
             $loadedSections = array_values(array_intersect($sections, array_keys($snapshotSections)));
 
             if (\is_array($errors) && [] !== $errors) {
+                $validation = $snapshot['configurationValidation'] ?? null;
+                $applicationBooted = \is_array($validation) && 'valid' === ($validation['status'] ?? null);
+                if ([] !== $failedSections
+                    && !isset($failedSections['runtime'])
+                    && $applicationBooted
+                    && [] !== $loadedSections
+                ) {
+                    throw new PartialRuntimeMetadataException(array_keys($failedSections));
+                }
                 $detail = [] === $failedSections ? '' : ': '.implode(', ', array_keys($failedSections));
 
                 throw new \RuntimeException('The project bridge could not load runtime metadata'.$detail.'.');

src/Runtime/ReportingRuntimeInitializer.php

@@ -29,7 +29,15 @@ public function initialize(Project $project, ?RuntimeRefreshPlan $plan = null, ?
             $this->logger->error($error);
             $runtimeStatus = $this->statuses->status($project)['runtime'];
             $stale = 'stale' === $runtimeStatus['state'];
-            if ($error instanceof UnsupportedSymfonyVersionException) {
+            if ($error instanceof PartialRuntimeMetadataException) {
+                $message = \sprintf(
+                    'Symfony Language Tools could not load %d runtime metadata section%s for "%s": %s. Other runtime-backed features remain active.',
+                    \count($error->sections),
+                    1 === \count($error->sections) ? '' : 's',
+                    $project->rootPath,
+                    implode(', ', $error->sections),
+                );
+            } elseif ($error instanceof UnsupportedSymfonyVersionException) {
                 $message = \sprintf(
                     $stale
                         ? 'The project "%s" uses Symfony %s, which is not supported by Symfony Language Tools. The last valid runtime metadata remains active.'

tests/Check/CheckExecutableTest.php

@@ -8,6 +8,7 @@
 use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\Filesystem\Path;
 use Symfony\Lsp\Check\CheckCommand;
+use Symfony\Lsp\Runtime\PartialRuntimeMetadataException;
 use Symfony\Lsp\Runtime\UnsupportedSymfonyVersionException;
 use Symfony\Lsp\Server\ServerVersion;
 
@@ -25,7 +26,7 @@
  * @phpstan-type SarifReport array{version: string, runs: list<SarifRun>}
  * @phpstan-type CheckReport array{
  *     complete: bool,
- *     projects: list<array{environment: string, analysis: array{mode: string, reason: string|null}}>,
+ *     projects: list<array{environment: string, analysis: array{mode: string, reason: string|null}, runtime: array{state: string}, complete: bool}>,
  *     diagnostics: list<array{code: string, path: string}>,
  *     summary: array{blocking: int, stale: int},
  *     errors: list<array{category: string, message: string, cause?: array{class: string, message: string}}>
@@ -311,6 +312,65 @@ public static function getPrettyVersion(string $package): ?string { return '5.4.
         self::assertSame(UnsupportedSymfonyVersionException::class, $report['errors'][0]['cause']['class'] ?? null);
     }
 
+    public function testKeepsDiagnosticsBackedByHealthyRuntimeSections(): void
+    {
+        if ('Windows' === \PHP_OS_FAMILY) {
+            self::markTestSkipped('The source executable integration requires Unix executable scripts.');
+        }
+
+        mkdir($this->directory.'/src');
+        file_put_contents($this->directory.'/src/ArticleController.php', <<<'PHP'
+            <?php
+            namespace App\Controller;
+
+            use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+
+            final class ArticleController extends AbstractController
+            {
+                public function show(): void
+                {
+                    $this->generateUrl('article_show');
+                }
+            }
+            PHP);
+        $snapshot = [
+            'schemaVersion' => 1,
+            'project' => ['environment' => 'dev'],
+            'configurationValidation' => ['status' => 'valid'],
+            'sections' => [
+                'routes' => [
+                    'complete' => true,
+                    'items' => [[
+                        'name' => 'article_show',
+                        'path' => '/article/{id}',
+                    ]],
+                ],
+            ],
+            'errors' => [[
+                'section' => 'twig',
+                'message' => 'CANARY_RUNTIME_SECTION_ERROR',
+            ]],
+        ];
+        $symfonyCli = $this->directory.'/partial-runtime';
+        file_put_contents($symfonyCli, "#!/usr/bin/env php\n<?php\nfwrite(STDOUT, json_encode(".var_export($snapshot, true).", JSON_THROW_ON_ERROR).\"\\n\");\n");
+        chmod($symfonyCli, 0700);
+
+        $result = $this->execute(
+            ['check', '--format=json', '--workspace='.$this->directory, 'src/ArticleController.php'],
+            ['SYMFONY_LSP_SYMFONY_CLI' => $symfonyCli],
+        );
+        $report = $this->decodeReport($result['stdout']);
+
+        self::assertSame(CheckCommand::EXIT_OPERATIONAL, $result['exitCode'], $result['stderr']);
+        self::assertFalse($report['complete']);
+        self::assertFalse($report['projects'][0]['complete']);
+        self::assertSame('failed', $report['projects'][0]['runtime']['state']);
+        self::assertSame('route.missing_parameters', $report['diagnostics'][0]['code']);
+        self::assertSame('The project bridge could not load runtime metadata: twig.', $report['errors'][0]['message']);
+        self::assertSame(PartialRuntimeMetadataException::class, $report['errors'][0]['cause']['class'] ?? null);
+        self::assertSame(1, $report['summary']['blocking']);
+    }
+
     public function testDoesNotReportACleanResultWhenRuntimeIndexingFails(): void
     {
         $result = $this->execute(['check', '--format=json', '--workspace='.$this->directory]);

tests/Runtime/ProjectRuntimeInitializerTest.php

@@ -21,6 +21,7 @@
 use Symfony\Lsp\Project\ProjectRegistry;
 use Symfony\Lsp\Runtime\BridgeExecutionException;
 use Symfony\Lsp\Runtime\BridgeInstaller;
+use Symfony\Lsp\Runtime\PartialRuntimeMetadataException;
 use Symfony\Lsp\Runtime\ProcessResult;
 use Symfony\Lsp\Runtime\ProcessRunnerInterface;
 use Symfony\Lsp\Runtime\RuntimeConfiguration;
@@ -328,6 +329,8 @@ public function testLoadsAvailableSectionsBeforeReportingSectionErrors(): void
         $initializer = (new ProjectRuntimeInitializerFixtureBuilder($source))->build(
             new CapturingProcessRunner(new ProcessResult(0, json_encode([
                 'schemaVersion' => 1,
+                'project' => ['environment' => 'dev'],
+                'configurationValidation' => ['status' => 'valid'],
                 'errors' => [['section' => 'routes', 'message' => 'CANARY_RUNTIME_SECTION_ERROR']],
                 'sections' => [
                     'routes' => ['complete' => true, 'items' => [['name' => 'replacement', 'path' => '/replacement']]],
@@ -348,7 +351,8 @@ public function testLoadsAvailableSectionsBeforeReportingSectionErrors(): void
         try {
             $initializer->initialize($project);
             self::fail('The section error was not reported.');
-        } catch (\RuntimeException $error) {
+        } catch (PartialRuntimeMetadataException $error) {
+            self::assertSame(['routes'], $error->sections);
             self::assertSame('The project bridge could not load runtime metadata: routes.', $error->getMessage());
         }
         self::assertSame('app.mailer', $serviceIndexes->forProject($project)->get('app.mailer')?->id);
@@ -382,6 +386,8 @@ public function testRestoresOnlyFailedSectionsAfterAPartialBridgeError(): void
         $initializer = (new ProjectRuntimeInitializerFixtureBuilder($source, $bridgeInstaller))->build(
             new CapturingProcessRunner(new ProcessResult(0, json_encode([
                 'schemaVersion' => 1,
+                'project' => ['environment' => 'dev'],
+                'configurationValidation' => ['status' => 'valid'],
                 'errors' => [['section' => 'container', 'message' => 'CANARY_RUNTIME_SECTION_ERROR']],
                 'sections' => [
                     'routes' => ['complete' => true, 'items' => [['name' => 'new_route', 'path' => '/new']]],
@@ -405,7 +411,8 @@ public function testRestoresOnlyFailedSectionsAfterAPartialBridgeError(): void
         try {
             $initializer->initialize($project);
             self::fail('The section error was not reported.');
-        } catch (\RuntimeException $error) {
+        } catch (PartialRuntimeMetadataException $error) {
+            self::assertSame(['container'], $error->sections);
             self::assertSame('The project bridge could not load runtime metadata: container.', $error->getMessage());
         }
 

tests/Runtime/ReportingRuntimeInitializerTest.php

@@ -8,6 +8,7 @@
 use Symfony\Lsp\Client\ClientInterface;
 use Symfony\Lsp\Index\ProjectIndexStatusRegistry;
 use Symfony\Lsp\Project\Project;
+use Symfony\Lsp\Runtime\PartialRuntimeMetadataException;
 use Symfony\Lsp\Runtime\ReportingRuntimeInitializer;
 use Symfony\Lsp\Runtime\RuntimeInitializerInterface;
 use Symfony\Lsp\Runtime\RuntimeRefreshPlan;
@@ -37,6 +38,27 @@ public function testReportsRefreshFailuresWithoutDiscardingTheServerSession(): v
         ]], $client->notifications);
     }
 
+    public function testReportsPartialRuntimeMetadataWithoutHidingAvailableFeatures(): void
+    {
+        $client = new ReportingClient();
+        $statuses = new ProjectIndexStatusRegistry();
+        $project = new Project('/workspace', 'file:///workspace', '^8.0');
+        $statuses->runtimeFailed($project);
+        $initializer = new ReportingRuntimeInitializer(
+            $this->failingInitializer(new PartialRuntimeMetadataException(['twig'])),
+            $client,
+            $statuses,
+            new ServerLogger(null, new SensitiveDataRedactor()),
+        );
+
+        $initializer->initialize($project);
+
+        self::assertSame(
+            'Symfony Language Tools could not load 1 runtime metadata section for "/workspace": twig. Other runtime-backed features remain active.',
+            $client->notifications[0]['params']['message'],
+        );
+    }
+
     public function testReportsInitialFailureAsStaticOnly(): void
     {
         $client = new ReportingClient();