refactor(web): iron_init/setup logic (#763)

- `iron_init` is renamed to `setup`, so that
  - `init` is the function for initializing the WASM module.
- `setup` is the function taking parameters for logger and performing
other setting up operations.
- Since `setup` may be called after `init` is called, it’s possible to
use some functions of the WASM module before calling `setup` if
necessity arises.

- Common initializion code is moved to an hidden "internal" module of
iron-remote-desktop crate, that is thus not part of the public API.

- Restored the "IronRDP is ready" debug log when `setup` is called.

Author: CBenoit

crates/iron-remote-desktop/src/lib.rs

@@ -25,41 +25,6 @@ impl DesktopSize {
     }
 }
 
-pub fn iron_init(log_level: &str) {
-    // When the `console_error_panic_hook` feature is enabled, we can call the
-    // `set_panic_hook` function at least once during initialization, and then
-    // we will get better error messages if our code ever panics.
-    //
-    // For more details see
-    // https://github.com/rustwasm/console_error_panic_hook#readme
-    #[cfg(feature = "panic_hook")]
-    console_error_panic_hook::set_once();
-
-    if let Ok(level) = log_level.parse::<tracing::Level>() {
-        set_logger_once(level);
-    }
-}
-
-fn set_logger_once(level: tracing::Level) {
-    use tracing_subscriber::filter::LevelFilter;
-    use tracing_subscriber::fmt::time::UtcTime;
-    use tracing_subscriber::prelude::*;
-    use tracing_web::MakeConsoleWriter;
-
-    static INIT: std::sync::Once = std::sync::Once::new();
-
-    INIT.call_once(|| {
-        let fmt_layer = tracing_subscriber::fmt::layer()
-            .with_ansi(false)
-            .with_timer(UtcTime::rfc_3339()) // std::time is not available in browsers
-            .with_writer(MakeConsoleWriter);
-
-        let level_filter = LevelFilter::from_level(level);
-
-        tracing_subscriber::registry().with(fmt_layer).with(level_filter).init();
-    })
-}
-
 pub trait RemoteDesktopApi {
     type Session: Session;
     type SessionBuilder: SessionBuilder;
@@ -71,10 +36,10 @@ pub trait RemoteDesktopApi {
     type Error: IronError;
 
     /// Called before the logger is set.
-    fn pre_init() {}
+    fn pre_setup() {}
 
     /// Called after the logger is set.
-    fn post_init() {}
+    fn post_setup() {}
 }
 
 #[macro_export]
@@ -89,10 +54,10 @@ macro_rules! export {
             };
 
             #[wasm_bindgen]
-            pub fn iron_init(log_level: &str) {
-                <$api as RemoteDesktopApi>::pre_init();
-                $crate::iron_init(log_level);
-                <$api as RemoteDesktopApi>::post_init();
+            pub fn setup(log_level: &str) {
+                <$api as RemoteDesktopApi>::pre_setup();
+                $crate::internal::setup(log_level);
+                <$api as RemoteDesktopApi>::post_setup();
             }
 
             #[wasm_bindgen]
@@ -364,3 +329,42 @@ macro_rules! export {
         }
     };
 }
+
+#[doc(hidden)]
+pub mod internal {
+    #[doc(hidden)]
+    pub fn setup(log_level: &str) {
+        // When the `console_error_panic_hook` feature is enabled, we can call the
+        // `set_panic_hook` function at least once during initialization, and then
+        // we will get better error messages if our code ever panics.
+        //
+        // For more details see
+        // https://github.com/rustwasm/console_error_panic_hook#readme
+        #[cfg(feature = "panic_hook")]
+        console_error_panic_hook::set_once();
+
+        if let Ok(level) = log_level.parse::<tracing::Level>() {
+            set_logger_once(level);
+        }
+    }
+
+    fn set_logger_once(level: tracing::Level) {
+        use tracing_subscriber::filter::LevelFilter;
+        use tracing_subscriber::fmt::time::UtcTime;
+        use tracing_subscriber::prelude::*;
+        use tracing_web::MakeConsoleWriter;
+
+        static INIT: std::sync::Once = std::sync::Once::new();
+
+        INIT.call_once(|| {
+            let fmt_layer = tracing_subscriber::fmt::layer()
+                .with_ansi(false)
+                .with_timer(UtcTime::rfc_3339()) // std::time is not available in browsers
+                .with_writer(MakeConsoleWriter);
+
+            let level_filter = LevelFilter::from_level(level);
+
+            tracing_subscriber::registry().with(fmt_layer).with(level_filter).init();
+        })
+    }
+}

crates/ironrdp-web/src/lib.rs

@@ -33,14 +33,8 @@ impl RemoteDesktopApi for Api {
     type ClipboardTransaction = clipboard::RdpClipboardTransaction;
     type ClipboardContent = clipboard::RdpClipboardContent;
     type Error = error::IronError;
-}
-
-#[doc(hidden)]
-pub mod internal {
-    #[allow(dead_code)]
-    fn iron_init(log_level: &str) {
-        iron_remote_desktop::iron_init(log_level);
 
+    fn post_setup() {
         debug!("IronRDP is ready");
     }
 }

web-client/iron-remote-desktop-rdp/src/main.ts

@@ -1,5 +1,5 @@
 import init, {
-    iron_init,
+    setup,
     DesktopSize,
     DeviceEvent,
     InputTransaction,
@@ -14,7 +14,7 @@ import { Extension } from './interfaces/Extension';
 
 export default {
     init,
-    iron_init,
+    setup,
     DesktopSize,
     DeviceEvent,
     InputTransaction,

web-client/iron-remote-desktop/src/interfaces/RemoteDesktopModule.ts

@@ -11,7 +11,7 @@ import type { Extension } from './Extension';
 
 export interface RemoteDesktopModule {
     init: () => Promise<unknown>;
-    iron_init: (logLevel: string) => void;
+    setup: (logLevel: string) => void;
     DesktopSize: DesktopSize;
     DeviceEvent: DeviceEvent;
     InputTransaction: InputTransaction;

web-client/iron-remote-desktop/src/iron-remote-desktop.svelte

@@ -655,7 +655,7 @@
     }
 
     async function initcanvas() {
-        loggingService.info('Start canvas initialization.');
+        loggingService.info('Start canvas initialization...');
 
         // Set a default canvas size. Need more test to know if i can remove it.
         canvas.width = 800;
@@ -671,6 +671,7 @@
 
         loggingService.info('Component ready');
         loggingService.info('Dispatching ready event');
+
         // bubbles:true is significant here, all our consumer code expect this specific event
         // but they only listen to the event on the custom element itself, not on the inner div
         // in Svelte 3, we had direct access to the customelement, but now in Svelte5, we have to

web-client/iron-remote-desktop/src/services/remote-desktop.service.ts

@@ -78,10 +78,10 @@ export class RemoteDesktopService {
     }
 
     async init(debug: LogType) {
-        loggingService.info('Loading wasm file.');
+        loggingService.info('Load wasm file...');
         await this.module.init();
-        loggingService.info('Initializing IronRDP.');
-        this.module.iron_init(LogType[debug]);
+        loggingService.info('Initialize the remote desktop module...');
+        this.module.setup(LogType[debug]);
     }
 
     // If set to false, the clipboard will not be enabled and the callbacks will not be registered to the Rust side