feat(langserver): implemented window/logMessage to log output directly to the language server protocol client

Author: d-biehl

packages/jsonrpc2/src/robotcode/jsonrpc2/protocol.py

@@ -550,11 +550,14 @@ def send_message(self, message: JsonRPCMessage) -> None:
         if self.write_transport is not None:
             msg = header + body
 
-            self._data_logger.trace(lambda: f"JSON send: {msg.decode()!r}")
+            self._do_trace_message(message, msg)
 
             if self._loop:
                 self._loop.call_soon_threadsafe(self.write_transport.write, msg)
 
+    def _do_trace_message(self, message: JsonRPCMessage, msg: bytes) -> None:
+        self._data_logger.trace(lambda: f"JSON send: {msg.decode()!r}")
+
     @__logger.call
     def send_request(
         self,

packages/language_server/src/robotcode/language_server/common/protocol.py

@@ -1,4 +1,5 @@
 import asyncio
+import logging
 import threading
 from threading import Event
 from typing import Any, ClassVar, Final, List, Optional, Set, Union
@@ -15,6 +16,9 @@
     InitializeParamsClientInfoType,
     InitializeResult,
     InitializeResultServerInfoType,
+    LogMessageParams,
+    LogTraceParams,
+    MessageType,
     PositionEncodingKind,
     ProgressToken,
     Registration,
@@ -29,12 +33,13 @@
     UnregistrationParams,
     WorkspaceFolder,
 )
-from robotcode.core.utils.logging import LoggingDescriptor
+from robotcode.core.utils.logging import TRACE, LoggingDescriptor
 from robotcode.core.utils.process import pid_exists
 from robotcode.jsonrpc2.protocol import (
     JsonRPCErrorException,
     JsonRPCErrors,
     JsonRPCException,
+    JsonRPCMessage,
     JsonRPCProtocol,
     ProtocolPartDescriptor,
     rpc_method,
@@ -74,6 +79,34 @@ class LanguageServerException(JsonRPCException):
     pass
 
 
+class LanguageServerLogHandler(logging.Handler):
+    MAPPING = {
+        logging.INFO: MessageType.INFO,
+        logging.WARNING: MessageType.WARNING,
+        logging.ERROR: MessageType.ERROR,
+        TRACE: MessageType.LOG,
+    }
+
+    def __init__(self, protocol: "LanguageServerProtocol"):
+        super().__init__()
+        self.protocol = protocol
+        self.trace: TraceValues = TraceValues.OFF
+
+    def emit(self, record: logging.LogRecord) -> None:
+        if record.levelno == TRACE:
+            if self.trace != TraceValues.OFF:
+                self.protocol.log_trace(record.getMessage())
+
+        type = self.MAPPING.get(record.levelno, None)
+        if type is None:
+            type = MessageType.LOG
+
+        self.protocol.window_log_message(
+            type=type,
+            message=record.getMessage(),
+        )
+
+
 class LanguageServerProtocol(JsonRPCProtocol):
     __logger = LoggingDescriptor()
 
@@ -131,8 +164,13 @@ def __init__(self, server: JsonRPCServer[Any]):
         )
 
         self._trace = TraceValues.OFF
+        self._trace_loghandler: Optional[LanguageServerLogHandler] = None
+
         self.is_initialized = Event()
 
+    def __del__(self) -> None:
+        self.trace = TraceValues.OFF
+
     @event
     def on_shutdown(sender) -> None:  # pragma: no cover, NOSONAR
         ...
@@ -149,6 +187,9 @@ def trace(self) -> TraceValues:
     def trace(self, value: TraceValues) -> None:
         self._trace = value
 
+        if self._trace_loghandler:
+            self._trace_loghandler.trace = value
+
     @property
     def workspace(self) -> Workspace:
         if self._workspace is None:
@@ -210,7 +251,14 @@ def _initialize(
         if self.parent_process_id and pid_exists(self.parent_process_id):
             self.start_parent_process_watcher()
 
+        logger = logging.getLogger()
+
+        if self._trace_loghandler is None:
+            self._trace_loghandler = LanguageServerLogHandler(self)
+            logger.addHandler(self._trace_loghandler)
+
         self.trace = trace or TraceValues.OFF
+
         self.client_info = client_info
 
         self.client_capabilities = capabilities
@@ -292,6 +340,13 @@ def _shutdown(self, *args: Any, **kwargs: Any) -> None:
 
         self.shutdown_received = True
 
+        logger = logging.getLogger()
+
+        if self._trace_loghandler in logger.handlers:
+            logging.getLogger().removeHandler(self._trace_loghandler)
+            del self._trace_loghandler
+            self._trace_loghandler = None
+
         try:
             self.cancel_all_received_request()
         except BaseException as e:
@@ -311,6 +366,16 @@ def _exit(self, *args: Any, **kwargs: Any) -> None:
     def _set_trace(self, value: TraceValues, *args: Any, **kwargs: Any) -> None:
         self.trace = value
 
+    def window_log_message(self, type: MessageType, message: str) -> None:
+        self.send_notification("window/logMessage", LogMessageParams(type=type, message=message))
+
+    def log_trace(self, message: str, verbose: Optional[str] = None) -> None:
+        self.send_notification("$/logTrace", LogTraceParams(message=message, verbose=verbose))
+
+    def _do_trace_message(self, message: JsonRPCMessage, msg: bytes) -> None:
+        if getattr(message, "method", None) not in ["$/logTrace", "window/logMessage"]:
+            self._data_logger.trace(lambda: f"JSON send: {msg.decode()!r}")
+
     @rpc_method(name="$/cancelRequest", param_type=CancelParams)
     @__logger.call
     def _cancel_request(self, id: Union[int, str], **kwargs: Any) -> None:

vscode-client/extension/languageclientsmanger.ts

@@ -536,10 +536,7 @@ export class LanguageClientsManager {
         return undefined;
       }
 
-      const name = `RobotCode Language Server mode=${mode} for folder '${workspaceFolder.name}'`;
-
-      const outputChannel = this.outputChannels.get(name) ?? vscode.window.createOutputChannel(name);
-      this.outputChannels.set(name, outputChannel);
+      const name = `RobotCode Language Server for folder ${workspaceFolder.name}`;
 
       let closeHandlerAction = CloseAction.DoNotRestart;
 
@@ -565,7 +562,6 @@ export class LanguageClientsManager {
           env: config.get<object>("robot.env", []),
           settings: { robotcode: config },
         },
-        revealOutputChannelOn: RevealOutputChannelOn.Never, // TODO: should we make this configurable?
         initializationFailedHandler: (error: ResponseError<InitializeError> | Error | undefined) => {
           if (error)
             void vscode.window // NOSONAR
@@ -593,7 +589,8 @@ export class LanguageClientsManager {
         },
         // TODO: how we can start a language client on workspace level, not on folder level
         workspaceFolder,
-        outputChannel,
+        revealOutputChannelOn: RevealOutputChannelOn.Error, // TODO: should we make this configurable?
+        outputChannelName: name,
         markdown: {
           isTrusted: true,
           supportHtml: true,