feat: added the ultimate logging setup

- ability to control logging level on-boot
- handle logging level in stdout, webview, and to file
- implement 6 levels of logs

Author: ZanzyTHEbar

GUI/ETVR/src-tauri/src/main.rs

@@ -77,7 +77,7 @@ fn main() {
       tauri_commands::do_rest_request,
       tauri_commands::unzip_archive,
       tauri_commands::handle_save_window_state,
-      tauri_commands::handle_load_window_state
+      tauri_commands::handle_load_window_state,
     ])
     // allow only one instance and propagate args and cwd to existing instance
     .plugin(tauri_plugin_single_instance::init(|app, args, cwd| {
@@ -93,21 +93,29 @@ fn main() {
     // save window position and size between sessions
     .plugin(tauri_plugin_window_state::Builder::default().build())
     // log to file, stdout and webview console support
-    .plugin(
-      tauri_plugin_log::Builder::default()
-        .targets([
-          tauri_plugin_log::LogTarget::LogDir,
-          tauri_plugin_log::LogTarget::Stdout,
-          tauri_plugin_log::LogTarget::Webview,
-        ])
-        .build(),
-    )
-    .setup(|app| {
+    .setup(move |app| {
       let window = app
         .get_window("main")
         .unwrap_or_else(|| panic!("Failed to get window {}", "main"));
       //set_shadow(&window, true).expect("Unsupported platform!");
       window.hide().unwrap();
+
+      let app_handle = app.handle();
+
+      app_handle
+        .plugin(
+          tauri_plugin_log::Builder::default()
+            .targets([
+              tauri_plugin_log::LogTarget::LogDir,
+              tauri_plugin_log::LogTarget::Stdout,
+              tauri_plugin_log::LogTarget::Webview,
+            ])
+            .filter(|metadata| metadata.target() != "polling::iocp")
+            .level(tauri_commands::handle_debug(app_handle.clone()).unwrap())
+            .build(),
+        )
+        .expect("Failed to initialize logger");
+
       Ok(())
     })
     .system_tray(tray)

GUI/ETVR/src-tauri/src/modules/m_dnsquery/mod.rs

@@ -1,8 +1,8 @@
 //! A mdns query client.
 
-use log::{error};
+use log::error;
 use mdns_sd::{ServiceDaemon, ServiceEvent};
-use serde::{Serialize};
+use serde::Serialize;
 use std::collections::hash_map::HashMap;
 use std::sync::{Arc, Mutex};
 
@@ -87,7 +87,7 @@ pub async fn run_query(
   let now = std::time::Instant::now();
   //* listen for event then stop the event loop after 5 seconds.
   // while let Ok(event) = receiver.recv() {}
-  while now.elapsed().as_secs() < scan_time {
+  while now.elapsed().as_secs() <= scan_time {
     //* let event = receiver.recv().expect("Failed to receive event");
     if let Ok(event) = receiver.recv_async().await {
       match event {
@@ -137,6 +137,9 @@ pub async fn run_query(
       }
     }
   }
+  std::thread::sleep(std::time::Duration::from_nanos(1));
+  mdns.stop_browse(&service_type).map_err(|e| e.to_string())?;
+  mdns.shutdown().map_err(|e| e.to_string())?;
   Ok(())
 }
 

GUI/ETVR/src-tauri/src/modules/tauri_commands/mod.rs

@@ -1,9 +1,12 @@
+use log::debug;
+use log::{error, info, warn};
 use tauri::{self, Manager};
+
+use tauri_plugin_store::with_store;
+
 use tauri_plugin_window_state::{AppHandleExt, StateFlags, WindowExt};
 use whoami::username;
 
-use log::info;
-
 use crate::modules::m_dnsquery;
 use crate::modules::rest_client;
 
@@ -120,3 +123,48 @@ pub async fn handle_load_window_state<R: tauri::Runtime>(
 
   Ok(())
 }
+
+pub fn handle_debug<R: tauri::Runtime>(
+  app: tauri::AppHandle<R>,
+) -> Result<log::LevelFilter, String> {
+  // read the Store file
+  let stores = app.state::<tauri_plugin_store::StoreCollection<R>>();
+  let path = std::path::PathBuf::from(".app-settings.etvr");
+  // match the store value to a LogFilter
+  let mut debug_state: String = String::new();
+  with_store(app.clone(), stores, path, |store| {
+    let settings = store.get("settings");
+    debug!("Settings: {:?}", settings);
+    if let Some(json) = settings {
+      let _serde_json = serde_json::from_value::<serde_json::Value>(json.clone());
+      debug!("Serde JSON: {:?}", _serde_json);
+      let serde_json_result = match _serde_json {
+        Ok(serde_json) => serde_json,
+        Err(err) => {
+          error!("Error configuring JSON config file: {}", err);
+          return Err(tauri_plugin_store::Error::Json(err));
+        }
+      };
+      let temp = &serde_json_result["debugMode"];
+      debug!("Debug: {:?}", temp);
+      debug_state = serde_json::from_value::<String>(temp.clone()).unwrap();
+    } else {
+      debug_state = serde_json::json!({}).to_string();
+    }
+    info!("Debug state: {}", debug_state);
+    Ok(())
+  })
+  .expect("Failed to get store");
+  // set the log level
+  let log_level = match debug_state.as_str() {
+    "off" => log::LevelFilter::Off,
+    "error" => log::LevelFilter::Error,
+    "warn" => log::LevelFilter::Warn,
+    "info" => log::LevelFilter::Info,
+    "debug" => log::LevelFilter::Debug,
+    "trace" => log::LevelFilter::Trace,
+    _ => log::LevelFilter::Info,
+  };
+  // return the result
+  Ok(log_level)
+}

GUI/ETVR/src/routes/Routes.tsx

@@ -2,6 +2,7 @@ import { useRoutes } from '@solidjs/router'
 import { createEffect, onMount } from 'solid-js'
 import { useEventListener } from 'solidjs-use'
 import { routes } from '.'
+import type { PersistentSettings } from '@src/static/types'
 import Header from '@components/Header'
 import { ENotificationAction } from '@src/static/types/enums'
 import { useAppAPIContext } from '@src/store/context/api'
@@ -68,12 +69,13 @@ const AppRoutes = () => {
     createEffect(() => {
         useEventListener(window, 'blur', () => {
             // save the app settings to the persistent store
-            const settings = {
+            const settings: PersistentSettings = {
                 user: connectedUserName(),
                 enableNotifications: getEnableNotifications(),
                 enableNotificationsSounds: getEnableNotificationsSounds(),
                 globalNotificationsType: getGlobalNotificationsType(),
                 enableMDNS: getEnableMDNS(),
+                debugMode: 'info',
                 scanForCamerasOnStartup: getScanForCamerasOnStartup(),
             }
             console.log('saving settings', settings)

GUI/ETVR/src/static/types/index.d.ts

@@ -54,6 +54,7 @@ type PersistentSettings = {
     enableNotifications?: boolean
     globalNotificationsType?: ENotificationAction
     enableMDNS?: boolean
+    debugMode?: 'off' | 'error' | 'warn' | 'info' | 'debug' | 'trace'
     scanForCamerasOnStartup?: boolean
     cameraSettings?: CameraSettings
     algorithmSettings?: AlgorithmSettings