Improve formatting of plugin error reports

Author: ncoghlan

src/lmstudio/plugin/hooks/prompt_preprocessor.py

@@ -225,8 +225,9 @@ async def _invoke_hook(request: PromptPreprocessingRequest) -> None:
                 err_msg = "Error calling prompt preprocessing hook"
                 logger.error(err_msg, exc_info=True, exc=repr(exc))
                 # TODO: Determine if it's practical to emit a stack trace the server can display
+                ui_cause = f"{err_msg}\n({type(exc).__name__}: {exc})"
                 error_details = SerializedLMSExtendedErrorDict(
-                    cause=repr(exc), stack="\n".join(format_tb(exc.__traceback__))
+                    cause=ui_cause, stack="\n".join(format_tb(exc.__traceback__))
                 )
             else:
                 if response is None:
@@ -240,8 +241,8 @@ async def _invoke_hook(request: PromptPreprocessingRequest) -> None:
                         try:
                             parsed_response = load_struct(response, expected_cls)
                         except ValidationError as exc:
-                            err_msg = f"Failed to parse prompt preprocessing response as {expected_cls.__name__}"
-                            logger.error(err_msg, exc_info=True, exc=repr(exc))
+                            err_msg = f"Failed to parse prompt preprocessing response as {expected_cls.__name__}\n({exc})"
+                            logger.error(err_msg)
                             error_details = SerializedLMSExtendedErrorDict(
                                 cause=err_msg
                             )
@@ -255,6 +256,12 @@ async def _invoke_hook(request: PromptPreprocessingRequest) -> None:
                         error_details = SerializedLMSExtendedErrorDict(cause=err_msg)
             channel_message: DictObject
             if error_details is not None:
+                error_title = f"Prompt preprocessing error in plugin {plugin_name!r}"
+                common_error_args: SerializedLMSExtendedErrorDict = {
+                    "title": error_title,
+                    "rootTitle": error_title,
+                }
+                error_details.update(common_error_args)
                 channel_message = PromptPreprocessingErrorDict(
                     type="error",
                     taskId=request.task_id,

src/lmstudio/plugin/runner.py

@@ -31,8 +31,8 @@
     TPluginConfigSchema,
     TGlobalConfigSchema,
     run_prompt_preprocessor,
-    # run_token_generator,
-    # run_tools_provider,
+    run_token_generator,
+    run_tools_provider,
 )
 
 # Available as lmstudio.plugin.*
@@ -63,8 +63,8 @@
 
 _HOOK_RUNNERS: dict[str, HookRunner[Any, Any, Any]] = {
     "preprocess_prompt": run_prompt_preprocessor,
-    # "generate_tokens": run_token_generator,
-    # "list_provided_tools": run_tools_provider,
+    "generate_tokens": run_token_generator,
+    "list_provided_tools": run_tools_provider,
 }
 
 
@@ -213,9 +213,10 @@ async def run_plugin(self, *, allow_local_imports: bool = False) -> int:
             )
         plugin = self.name
         if not implemented_hooks:
+            hook_list = "\n  - ".join(("", *sorted(_HOOK_RUNNERS)))
             print(
                 f"No plugin hooks defined in {plugin!r}, "
-                f"expected at least one of {sorted(_HOOK_RUNNERS)}"
+                f"expected at least one of:{hook_list}"
             )
             return 1
         # Use anyio and exceptiongroup to handle the lack of native task

tests/invalid_plugins/hook_exception/manifest.json

@@ -0,0 +1,7 @@
+{
+  "type": "plugin",
+  "runner": "python",
+  "owner": "lmstudio",
+  "name": "hook-exception",
+  "revision": 1
+}

tests/invalid_plugins/hook_exception/src/plugin.py

@@ -0,0 +1,8 @@
+# Plugin runner doesn't actually care these type hints are incorrect
+# It *does* care that an exception is raised
+class ExampleCustomException(Exception):
+    pass
+
+
+async def preprocess_prompt(_ctl: None, _message: None) -> dict[None, None]:
+    raise ExampleCustomException("Example plugin hook failure")

tests/invalid_plugins/malformed_prompt/manifest.json

@@ -0,0 +1,7 @@
+{
+  "type": "plugin",
+  "runner": "python",
+  "owner": "lmstudio",
+  "name": "malformed-prompt",
+  "revision": 1
+}

tests/invalid_plugins/malformed_prompt/src/plugin.py

@@ -0,0 +1,4 @@
+# Plugin runner doesn't actually care these type hints are incorrect
+# It *does* care that the returned "user message" has no content
+async def preprocess_prompt(_ctl: None, _message: None) -> dict[None, None]:
+    return {}

tests/invalid_plugins/no_hooks/manifest.json

@@ -0,0 +1,7 @@
+{
+  "type": "plugin",
+  "runner": "python",
+  "owner": "lmstudio",
+  "name": "no-hooks",
+  "revision": 1
+}

tests/invalid_plugins/no_hooks/src/plugin.py

@@ -0,0 +1 @@
+# No hooks defined, runner will refuse to execute this plugin