Use logger formatter to send log msgs via json rpc (#23405)

Author: DonJayamanne

native_locator/Cargo.toml

@@ -11,6 +11,8 @@ serde = { version = "1.0.152", features = ["derive"] }
 serde_json = "1.0.93"
 serde_repr = "0.1.10"
 regex = "1.10.4"
+log = "0.4.21"
+env_logger = "0.11.3"
 
 [lib]
 doctest = false

native_locator/src/main.rs

@@ -4,9 +4,12 @@
 use global_virtualenvs::list_global_virtual_envs;
 use known::EnvironmentApi;
 use locator::Locator;
+use log::LevelFilter;
 use messaging::{create_dispatcher, MessageDispatcher};
 use std::time::SystemTime;
 
+use crate::messaging::initialize_logger;
+
 mod common_python;
 mod conda;
 mod global_virtualenvs;
@@ -26,8 +29,9 @@ mod windows_python;
 fn main() {
     let mut dispatcher = create_dispatcher();
     let environment = EnvironmentApi {};
+    initialize_logger(LevelFilter::Debug);
 
-    dispatcher.log_info("Starting Native Locator");
+    log::info!("Starting Native Locator");
     let now = SystemTime::now();
 
     let mut virtualenv_locator = virtualenv::VirtualEnv::new();
@@ -106,13 +110,10 @@ fn main() {
 
     match now.elapsed() {
         Ok(elapsed) => {
-            dispatcher.log_info(&format!(
-                "Native Locator took {} milliseconds.",
-                elapsed.as_millis()
-            ));
+            log::info!("Native Locator took {} milliseconds.", elapsed.as_millis());
         }
         Err(e) => {
-            dispatcher.log_error(&format!("Error getting elapsed time: {:?}", e));
+            log::error!("Error getting elapsed time: {:?}", e);
         }
     }
 

native_locator/src/messaging.rs

@@ -2,17 +2,15 @@
 // Licensed under the MIT License.
 
 use crate::logging::{LogLevel, LogMessage};
+use env_logger::Builder;
+use log::LevelFilter;
 use serde::{Deserialize, Serialize};
 use std::path::PathBuf;
 
 pub trait MessageDispatcher {
     fn report_environment_manager(&mut self, env: EnvManager) -> ();
     fn report_environment(&mut self, env: PythonEnvironment) -> ();
     fn exit(&mut self) -> ();
-    fn log_debug(&mut self, message: &str) -> ();
-    fn log_info(&mut self, message: &str) -> ();
-    fn log_warning(&mut self, message: &str) -> ();
-    fn log_error(&mut self, message: &str) -> ();
 }
 
 #[derive(Serialize, Deserialize, Copy, Clone)]
@@ -185,14 +183,34 @@ impl ExitMessage {
 }
 
 pub struct JsonRpcDispatcher {}
-fn send_message<T: serde::Serialize>(message: T) -> () {
+pub fn send_message<T: serde::Serialize>(message: T) -> () {
     let message = serde_json::to_string(&message).unwrap();
     print!(
         "Content-Length: {}\r\nContent-Type: application/vscode-jsonrpc; charset=utf-8\r\n\r\n{}",
         message.len(),
         message
     );
 }
+
+pub fn initialize_logger(log_level: LevelFilter) {
+    Builder::new()
+        .format(|_, record| {
+            let level = match record.level() {
+                log::Level::Debug => LogLevel::Debug,
+                log::Level::Error => LogLevel::Error,
+                log::Level::Info => LogLevel::Info,
+                log::Level::Warn => LogLevel::Warning,
+                _ => LogLevel::Debug,
+            };
+            send_message(LogMessage::new(
+                format!("{}", record.args()).to_string(),
+                level,
+            ));
+            Ok(())
+        })
+        .filter(None, log_level)
+        .init();
+}
 impl MessageDispatcher for JsonRpcDispatcher {
     fn report_environment_manager(&mut self, env: EnvManager) -> () {
         send_message(EnvManagerMessage::new(env));
@@ -203,18 +221,6 @@ impl MessageDispatcher for JsonRpcDispatcher {
     fn exit(&mut self) -> () {
         send_message(ExitMessage::new());
     }
-    fn log_debug(&mut self, message: &str) -> () {
-        send_message(LogMessage::new(message.to_string(), LogLevel::Debug));
-    }
-    fn log_error(&mut self, message: &str) -> () {
-        send_message(LogMessage::new(message.to_string(), LogLevel::Error));
-    }
-    fn log_info(&mut self, message: &str) -> () {
-        send_message(LogMessage::new(message.to_string(), LogLevel::Info));
-    }
-    fn log_warning(&mut self, message: &str) -> () {
-        send_message(LogMessage::new(message.to_string(), LogLevel::Warning));
-    }
 }
 
 pub fn create_dispatcher() -> JsonRpcDispatcher {

native_locator/tests/common.rs

@@ -43,10 +43,6 @@ pub fn create_test_dispatcher() -> TestDispatcher {
         fn exit(&mut self) -> () {
             //
         }
-        fn log_debug(&mut self, _message: &str) -> () {}
-        fn log_error(&mut self, _message: &str) -> () {}
-        fn log_info(&mut self, _message: &str) -> () {}
-        fn log_warning(&mut self, _message: &str) -> () {}
     }
     impl TestMessages for TestDispatcher {
         fn get_messages(&self) -> Vec<String> {