Catch \Throwable when utilizing hooks

nilmerg · nilmerg · commit 6f44fb113913 · 2024-07-25T09:23:08.000+02:00
Hooks shouldn't be able to fatally end
execution.
diff --git a/library/Icingadb/Hook/ActionsHook/ObjectActionsHook.php b/library/Icingadb/Hook/ActionsHook/ObjectActionsHook.php
@@ -4,7 +4,6 @@
 
 namespace Icinga\Module\Icingadb\Hook\ActionsHook;
 
-use Exception;
 use Icinga\Application\Hook;
 use Icinga\Application\Logger;
 use Icinga\Exception\IcingaException;
@@ -20,6 +19,7 @@
 use ipl\Html\Text;
 use ipl\Orm\Model;
 use ipl\Web\Widget\Link;
+use Throwable;
 
 use function ipl\Stdlib\get_php_type;
 
@@ -72,7 +72,7 @@ final public static function loadActions(Model $object): HtmlElement
                         'data-icinga-module' => $moduleName
                     ]), HtmlString::create($renderedLink)));
                 }
-            } catch (Exception $e) {
+            } catch (Throwable $e) {
                 Logger::error("Failed to load object actions: %s\n%s", $e, $e->getTraceAsString());
                 $list->addHtml(new HtmlElement('li', null, Text::create(IcingaException::describe($e))));
             }
diff --git a/library/Icingadb/Hook/CustomVarRendererHook.php b/library/Icingadb/Hook/CustomVarRendererHook.php
@@ -5,11 +5,11 @@
 namespace Icinga\Module\Icingadb\Hook;
 
 use Closure;
-use Exception;
 use Icinga\Application\Hook;
 use Icinga\Application\Logger;
 use Icinga\Module\Icingadb\Hook\Common\HookUtils;
 use ipl\Orm\Model;
+use Throwable;
 
 abstract class CustomVarRendererHook
 {
@@ -68,7 +68,7 @@ final public static function prepareForObject(Model $object): Closure
                 if ($hook->prefetchForObject($object)) {
                     $hooks[] = $hook;
                 }
-            } catch (Exception $e) {
+            } catch (Throwable $e) {
                 Logger::error('Failed to load hook %s:', get_class($hook), $e);
             }
         }
@@ -84,7 +84,7 @@ final public static function prepareForObject(Model $object): Closure
                     $renderedKey = $hook->renderCustomVarKey($key);
                     $renderedValue = $hook->renderCustomVarValue($key, $value);
                     $group = $hook->identifyCustomVarGroup($key);
-                } catch (Exception $e) {
+                } catch (Throwable $e) {
                     Logger::error('Failed to use hook %s:', get_class($hook), $e);
                     continue;
                 }
diff --git a/library/Icingadb/Hook/ExtensionHook/ObjectDetailExtensionHook.php b/library/Icingadb/Hook/ExtensionHook/ObjectDetailExtensionHook.php
@@ -4,7 +4,6 @@
 
 namespace Icinga\Module\Icingadb\Hook\ExtensionHook;
 
-use Exception;
 use Icinga\Application\Hook;
 use Icinga\Application\Logger;
 use Icinga\Exception\IcingaException;
@@ -25,6 +24,7 @@
 use ipl\Html\Text;
 use ipl\Html\ValidHtml;
 use ipl\Orm\Model;
+use Throwable;
 
 use function ipl\Stdlib\get_php_type;
 
@@ -110,7 +110,7 @@ final public static function loadExtensions(Model $object): array
                     ]),
                     HtmlString::create($extension)
                 );
-            } catch (Exception $e) {
+            } catch (Throwable $e) {
                 Logger::error("Failed to load detail extension: %s\n%s", $e, $e->getTraceAsString());
                 $extensions[$location] = Text::create(IcingaException::describe($e));
             }
diff --git a/library/Icingadb/Hook/ExtensionHook/ObjectsDetailExtensionHook.php b/library/Icingadb/Hook/ExtensionHook/ObjectsDetailExtensionHook.php
@@ -4,7 +4,6 @@
 
 namespace Icinga\Module\Icingadb\Hook\ExtensionHook;
 
-use Exception;
 use Icinga\Application\Hook;
 use Icinga\Application\Logger;
 use Icinga\Exception\IcingaException;
@@ -19,6 +18,7 @@
 use ipl\Orm\Query;
 use ipl\Stdlib\BaseFilter;
 use ipl\Stdlib\Filter;
+use Throwable;
 
 abstract class ObjectsDetailExtensionHook extends BaseExtensionHook
 {
@@ -90,7 +90,7 @@ final public static function loadExtensions(string $objectType, Query $query, Fi
                     ]),
                     HtmlString::create($extension)
                 );
-            } catch (Exception $e) {
+            } catch (Throwable $e) {
                 Logger::error("Failed to load details extension: %s\n%s", $e, $e->getTraceAsString());
                 $extensions[$location] = Text::create(IcingaException::describe($e));
             }
diff --git a/library/Icingadb/Hook/PluginOutputHook.php b/library/Icingadb/Hook/PluginOutputHook.php
@@ -4,10 +4,10 @@
 
 namespace Icinga\Module\Icingadb\Hook;
 
-use Exception;
 use Icinga\Application\Hook;
 use Icinga\Application\Logger;
 use Icinga\Module\Icingadb\Hook\Common\HookUtils;
+use Throwable;
 
 abstract class PluginOutputHook
 {
@@ -53,7 +53,7 @@ final public static function processOutput(string $output, string $commandName,
                 if ($hook->isSupportedCommand($commandName)) {
                     $output = $hook->render($output, $commandName, $enrichOutput);
                 }
-            } catch (Exception $e) {
+            } catch (Throwable $e) {
                 Logger::error("Unable to process plugin output: %s\n%s", $e, $e->getTraceAsString());
             }
         }
diff --git a/library/Icingadb/Hook/TabHook/HookActions.php b/library/Icingadb/Hook/TabHook/HookActions.php
@@ -4,14 +4,14 @@
 
 namespace Icinga\Module\Icingadb\Hook\TabHook;
 
-use Exception;
 use Generator;
 use Icinga\Application\Hook;
 use Icinga\Application\Logger;
 use Icinga\Module\Icingadb\Hook\TabHook;
 use ipl\Html\ValidHtml;
 use ipl\Orm\Model;
 use ipl\Stdlib\Str;
+use Throwable;
 
 /**
  * Trait HookActions
@@ -78,7 +78,7 @@ protected function loadTabHooks(): array
                 if ($hook->shouldBeShown($this->objectToLoadTabsFor)) {
                     $this->tabHooks[Str::camel($hook->getName())] = $hook;
                 }
-            } catch (Exception $e) {
+            } catch (Throwable $e) {
                 Logger::error("Failed to load tab hook: %s\n%s", $e, $e->getTraceAsString());
             }
         }
diff --git a/library/Icingadb/Widget/Detail/ObjectDetail.php b/library/Icingadb/Widget/Detail/ObjectDetail.php
@@ -4,7 +4,6 @@
 
 namespace Icinga\Module\Icingadb\Widget\Detail;
 
-use Exception;
 use Icinga\Application\ClassLoader;
 use Icinga\Application\Config;
 use Icinga\Application\Hook;
@@ -53,6 +52,7 @@
 use ipl\Stdlib\Filter;
 use ipl\Web\Widget\Icon;
 use ipl\Web\Widget\StateBall;
+use Throwable;
 
 class ObjectDetail extends BaseHtmlElement
 {
@@ -172,7 +172,7 @@ protected function createActions()
                 if (! isset($nativeExtensionProviders[$moduleName])) {
                     try {
                         $navigation->merge($hook->getNavigation($this->compatObject()));
-                    } catch (Exception $e) {
+                    } catch (Throwable $e) {
                         Logger::error("Failed to load legacy action hook: %s\n%s", $e, $e->getTraceAsString());
                         $navigation->addItem($moduleName, ['label' => IcingaException::describe($e), 'url' => '#']);
                     }
@@ -475,7 +475,7 @@ protected function createExtensions(): array
 
             try {
                 $graph = HtmlString::create($grapher->getPreviewHtml($this->compatObject()));
-            } catch (Exception $e) {
+            } catch (Throwable $e) {
                 Logger::error("Failed to load legacy grapher: %s\n%s", $e, $e->getTraceAsString());
                 $graph = Text::create(IcingaException::describe($e));
             }
@@ -511,7 +511,7 @@ protected function createExtensions(): array
                     ]),
                     HtmlString::create($renderedExtension)
                 );
-            } catch (Exception $e) {
+            } catch (Throwable $e) {
                 Logger::error("Failed to load legacy detail extension: %s\n%s", $e, $e->getTraceAsString());
                 $extensionHtml = Text::create(IcingaException::describe($e));
             }

Original file line number	Diff line number	Diff line change
`@@ -5,11 +5,11 @@`
`5`	`5`	`namespace Icinga\Module\Icingadb\Hook;`
`6`	`6`
`7`	`7`	`use Closure;`
`8`		`-use Exception;`
`9`	`8`	`use Icinga\Application\Hook;`
`10`	`9`	`use Icinga\Application\Logger;`
`11`	`10`	`use Icinga\Module\Icingadb\Hook\Common\HookUtils;`
`12`	`11`	`use ipl\Orm\Model;`
	`12`	`+use Throwable;`
`13`	`13`
`14`	`14`	`abstract class CustomVarRendererHook`
`15`	`15`	`{`
`@@ -68,7 +68,7 @@ final public static function prepareForObject(Model $object): Closure`
`68`	`68`	`if ($hook->prefetchForObject($object)) {`
`69`	`69`	`$hooks[] = $hook;`
`70`	`70`	`}`
`71`		`- } catch (Exception $e) {`
	`71`	`+ } catch (Throwable $e) {`
`72`	`72`	`Logger::error('Failed to load hook %s:', get_class($hook), $e);`
`73`	`73`	`}`
`74`	`74`	`}`
`@@ -84,7 +84,7 @@ final public static function prepareForObject(Model $object): Closure`
`84`	`84`	`$renderedKey = $hook->renderCustomVarKey($key);`
`85`	`85`	`$renderedValue = $hook->renderCustomVarValue($key, $value);`
`86`	`86`	`$group = $hook->identifyCustomVarGroup($key);`
`87`		`- } catch (Exception $e) {`
	`87`	`+ } catch (Throwable $e) {`
`88`	`88`	`Logger::error('Failed to use hook %s:', get_class($hook), $e);`
`89`	`89`	`continue;`
`90`	`90`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,10 +4,10 @@`
`4`	`4`
`5`	`5`	`namespace Icinga\Module\Icingadb\Hook;`
`6`	`6`
`7`		`-use Exception;`
`8`	`7`	`use Icinga\Application\Hook;`
`9`	`8`	`use Icinga\Application\Logger;`
`10`	`9`	`use Icinga\Module\Icingadb\Hook\Common\HookUtils;`
	`10`	`+use Throwable;`
`11`	`11`
`12`	`12`	`abstract class PluginOutputHook`
`13`	`13`	`{`
`@@ -53,7 +53,7 @@ final public static function processOutput(string $output, string $commandName,`
`53`	`53`	`if ($hook->isSupportedCommand($commandName)) {`
`54`	`54`	`$output = $hook->render($output, $commandName, $enrichOutput);`
`55`	`55`	`}`
`56`		`- } catch (Exception $e) {`
	`56`	`+ } catch (Throwable $e) {`
`57`	`57`	`Logger::error("Unable to process plugin output: %s\n%s", $e, $e->getTraceAsString());`
`58`	`58`	`}`
`59`	`59`	`}`