Prevent third-party plugins with faulty hooks to crash the server

ccordoba12 · ccordoba12 · commit d4baee3adedf · 2022-02-01T19:27:04.000-05:00
diff --git a/pylsp/config/config.py b/pylsp/config/config.py
@@ -4,9 +4,11 @@
 
 import logging
 from functools import lru_cache
-import pkg_resources
+from typing import List, Mapping, Sequence, Union
 
+import pkg_resources
 import pluggy
+from pluggy._hooks import HookImpl
 
 from pylsp import _utils, hookspecs, uris, PYLSP
 
@@ -16,6 +18,24 @@
 DEFAULT_CONFIG_SOURCES = ['pycodestyle']
 
 
+class PluginManager(pluggy.PluginManager):
+
+    def _hookexec(
+        self,
+        hook_name: str,
+        methods: Sequence[HookImpl],
+        kwargs: Mapping[str, object],
+        firstresult: bool,
+    ) -> Union[object, List[object]]:
+        # called from all hookcaller instances.
+        # enable_tracing will set its own wrapping function at self._inner_hookexec
+        try:
+            return self._inner_hookexec(hook_name, methods, kwargs, firstresult)
+        except Exception as e:  # pylint: disable=broad-except
+            log.warning(f"Failed to load hook {hook_name}: {e}")
+            return []
+
+
 class Config:
     def __init__(self, root_uri, init_opts, process_id, capabilities):
         self._root_path = uris.to_fs_path(root_uri)
@@ -39,7 +59,7 @@ def __init__(self, root_uri, init_opts, process_id, capabilities):
         except ImportError:
             pass
 
-        self._pm = pluggy.PluginManager(PYLSP)
+        self._pm = PluginManager(PYLSP)
         self._pm.trace.root.setwriter(log.debug)
         self._pm.enable_tracing()
         self._pm.add_hookspecs(hookspecs)
