Add graceful handling of container not being initialized

Author: mglaman

src/Drupal/Bootstrap.php

@@ -2,6 +2,7 @@
 
 namespace PHPStan\Drupal;
 
+use Drupal\Core\DependencyInjection\ContainerNotInitializedException;
 use DrupalFinder\DrupalFinder;
 use Nette\Utils\Finder;
 
@@ -99,12 +100,12 @@ public function register(): void
             if (file_exists($module_dir . '/' . $module_name . '.install')) {
                 $ignored_install_files = ['entity_test', 'entity_test_update', 'update_test_schema'];
                 if (!in_array($module_name, $ignored_install_files, true)) {
-                    require $module_dir . '/' . $module_name . '.install';
+                    $this->loadAndCatchErrors($module_dir . '/' . $module_name . '.install');
                 }
             }
             // Add .post_update.php
             if (file_exists($module_dir . '/' . $module_name . '.post_update.php')) {
-                require $module_dir . '/' . $module_name . '.post_update.php';
+                $this->loadAndCatchErrors($module_dir . '/' . $module_name . '.post_update.php');
             }
             // Add misc .inc that are magically allowed via hook_hook_info.
             $magic_hook_info_includes = [
@@ -116,7 +117,7 @@ public function register(): void
             ];
             foreach ($magic_hook_info_includes as $hook_info_include) {
                 if (file_exists($module_dir . "/$module_name.$hook_info_include.inc")) {
-                    require $module_dir . "/$module_name.$hook_info_include.inc";
+                    $this->loadAndCatchErrors($module_dir . "/$module_name.$hook_info_include.inc");
                 }
             }
         }
@@ -223,4 +224,17 @@ protected function loadExtension(Extension $extension): void
             // This can happen when drupal_get_path or drupal_get_filename are used outside of the scope of a function.
         }
     }
+
+    protected function loadAndCatchErrors(string $path): void
+    {
+        try {
+            require $path;
+        } catch (ContainerNotInitializedException $e) {
+            // This can happen when drupal_get_path or drupal_get_filename are used outside of the scope of a function.
+            @trigger_error("$path invoked the Drupal container outside of the scope of a function or class method. It was skipped for analysis.", E_USER_WARNING);
+        } catch (\Throwable $e) {
+            // Something prevented the extension file from loading.
+            @trigger_error("$path failed loading due to {$e->getMessage()}", E_USER_WARNING);
+        }
+    }
 }

tests/fixtures/drupal/modules/contained_not_initialized/contained_not_initialized.info.yml

@@ -0,0 +1,3 @@
+name: contained_not_initialized
+type: module
+core: 8.x

tests/fixtures/drupal/modules/contained_not_initialized/contained_not_initialized.install

@@ -0,0 +1,5 @@
+<?php
+
+// drupal_get_path calls drupal_get_filename which invokes \Drupal::service("extension.list.$type");
+// this will cause the bootstrap process to always die.
+drupal_get_path('module', 'contained_not_initialized');

tests/fixtures/drupal/modules/contained_not_initialized/contained_not_initialized.module

@@ -0,0 +1,5 @@
+<?php
+
+// drupal_get_path calls drupal_get_filename which invokes \Drupal::service("extension.list.$type");
+// this will cause the bootstrap process to always die.
+drupal_get_path('module', 'contained_not_initialized');

tests/fixtures/drupal/modules/contained_not_initialized/contained_not_initialized.pathauto.inc

@@ -0,0 +1,5 @@
+<?php
+
+// drupal_get_path calls drupal_get_filename which invokes \Drupal::service("extension.list.$type");
+// this will cause the bootstrap process to always die.
+drupal_get_path('module', 'contained_not_initialized');

tests/fixtures/drupal/modules/contained_not_initialized/contained_not_initialized.post_update.php

@@ -0,0 +1,5 @@
+<?php
+
+// drupal_get_path calls drupal_get_filename which invokes \Drupal::service("extension.list.$type");
+// this will cause the bootstrap process to always die.
+drupal_get_path('module', 'contained_not_initialized');

tests/fixtures/drupal/modules/contained_not_initialized/contained_not_initialized.search_api.inc

@@ -0,0 +1,5 @@
+<?php
+
+// drupal_get_path calls drupal_get_filename which invokes \Drupal::service("extension.list.$type");
+// this will cause the bootstrap process to always die.
+drupal_get_path('module', 'contained_not_initialized');

tests/fixtures/drupal/modules/contained_not_initialized/contained_not_initialized.tokens.inc

@@ -0,0 +1,5 @@
+<?php
+
+// drupal_get_path calls drupal_get_filename which invokes \Drupal::service("extension.list.$type");
+// this will cause the bootstrap process to always die.
+drupal_get_path('module', 'contained_not_initialized');

tests/fixtures/drupal/modules/contained_not_initialized/contained_not_initialized.views.inc

@@ -0,0 +1,5 @@
+<?php
+
+// drupal_get_path calls drupal_get_filename which invokes \Drupal::service("extension.list.$type");
+// this will cause the bootstrap process to always die.
+drupal_get_path('module', 'contained_not_initialized');

tests/fixtures/drupal/modules/contained_not_initialized/contained_not_initialized.views_execution.inc

@@ -0,0 +1,5 @@
+<?php
+
+// drupal_get_path calls drupal_get_filename which invokes \Drupal::service("extension.list.$type");
+// this will cause the bootstrap process to always die.
+drupal_get_path('module', 'contained_not_initialized');