Issue #3330140 by omkar.podey, tedbow, Wim Leers: Update...

Issue #3330140 by omkar.podey, tedbow, Wim Leers: Update StatusCheckTrait::runStatusCheck() to reorder/avoid dispatching CollectIgnoredPathsEvent earlier than StatusCheckEvent

package_manager/src/StatusCheckTrait.php

@@ -36,9 +36,14 @@ trait StatusCheckTrait {
    */
   protected function runStatusCheck(Stage $stage, EventDispatcherInterface $event_dispatcher = NULL, bool $do_readiness_check = FALSE): array {
     $event_dispatcher ??= \Drupal::service('event_dispatcher');
-
-    $ignored_paths = new CollectIgnoredPathsEvent($stage);
-    $event_dispatcher->dispatch($ignored_paths);
+    try {
+      $ignored_paths = new CollectIgnoredPathsEvent($stage);
+      $event_dispatcher->dispatch($ignored_paths);
+    }
+    catch (\Exception $e) {
+      // We can't dispatch the status check event without the ignored paths.
+      return [ValidationResult::createErrorFromThrowable($e, t("Unable to collect ignored paths, therefore can't perform status checks."))];
+    }
 
     $event = new StatusCheckEvent($stage, $ignored_paths->getAll());
     $event_dispatcher->dispatch($event);

package_manager/tests/src/Kernel/StatusCheckTraitTest.php

@@ -7,6 +7,7 @@ namespace Drupal\Tests\package_manager\Kernel;
 use Drupal\package_manager\Event\CollectIgnoredPathsEvent;
 use Drupal\package_manager\Event\StatusCheckEvent;
 use Drupal\package_manager\StatusCheckTrait;
+use Drupal\package_manager\ValidationResult;
 
 /**
  * @covers \Drupal\package_manager\StatusCheckTrait
@@ -34,4 +35,25 @@ class StatusCheckTraitTest extends PackageManagerKernelTestBase {
     $this->assertTrue($status_check_called);
   }
 
+  /**
+   * Tests StatusCheckTrait returns an error when unable to get ignored paths.
+   */
+  public function testErrorIgnoredPathsCollected(): void {
+    $composer_json_path = $this->container->get('package_manager.path_locator')->getProjectRoot() . '/composer.json';
+    // Delete composer.json, so we won't be able to get excluded paths.
+    unlink($composer_json_path);
+    $this->addEventTestListener(function (CollectIgnoredPathsEvent $event): void {
+      // Try to get composer.
+      $event->getStage()->getActiveComposer();
+    }, CollectIgnoredPathsEvent::class);
+    $results = $this->runStatusCheck($this->createStage(), $this->container->get('event_dispatcher'));
+    $expected_results = [
+      ValidationResult::createErrorFromThrowable(
+        new \Exception("Composer could not find the config file: $composer_json_path\n"),
+        t("Unable to collect ignored paths, therefore can't perform status checks."),
+      ),
+    ];
+    $this->assertValidationResultsEqual($expected_results, $results);
+  }
+
 }