Add logging control and improve WebView lifecycle management

kdroidFilter · kdroidFilter · commit 561880ffac96 · 2026-01-02T11:30:29.000+02:00
- Introduce `LOG_ENABLED` and `log_enabled()` for optional debug logging.
- Enhance WebView creation with threading and fallback mechanisms to prevent redundant attempts.
- Add destroy timer and conditional checks for smoother cleanup.
- Refactor composable WebView integration with `movableContentOf` for better state management.
diff --git a/demo-shared/src/commonMain/kotlin/io/github/kdroidfilter/webview/demo/App.kt b/demo-shared/src/commonMain/kotlin/io/github/kdroidfilter/webview/demo/App.kt
@@ -16,8 +16,10 @@ import androidx.compose.material3.VerticalDivider
 import androidx.compose.material3.darkColorScheme
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.DisposableEffect
+import androidx.compose.runtime.ExperimentalComposeApi
 import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.getValue
+import androidx.compose.runtime.movableContentOf
 import androidx.compose.runtime.mutableStateListOf
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.remember
@@ -35,7 +37,7 @@ import io.github.kdroidfilter.webview.web.rememberWebViewState
 import kotlinx.coroutines.launch
 
 @Composable
-@OptIn(ExperimentalMaterial3Api::class)
+@OptIn(ExperimentalMaterial3Api::class, ExperimentalComposeApi::class)
 fun App() {
     BoxWithConstraints(modifier = Modifier.fillMaxSize()) {
         val isCompact = maxWidth < 900.dp
@@ -83,6 +85,17 @@ fun App() {
                 backgroundColor = androidx.compose.ui.graphics.Color.White
             }
         val jsBridge = rememberWebViewJsBridge(navigator)
+        val webViewContent =
+            remember(webViewState, navigator, jsBridge) {
+                movableContentOf<Modifier> { webViewModifier ->
+                    WebView(
+                        state = webViewState,
+                        navigator = navigator,
+                        webViewJsBridge = jsBridge,
+                        modifier = webViewModifier,
+                    )
+                }
+            }
 
         var urlText by remember { mutableStateOf("https://httpbin.org/html") }
 
@@ -192,12 +205,7 @@ fun App() {
 
                     if (isCompact) {
                         Column(modifier = Modifier.fillMaxSize()) {
-                            WebView(
-                                state = webViewState,
-                                navigator = navigator,
-                                webViewJsBridge = jsBridge,
-                                modifier = Modifier.weight(1f, fill = true).fillMaxWidth(),
-                            )
+                            webViewContent(Modifier.weight(1f, fill = true).fillMaxWidth())
 
                             AnimatedVisibility(visible = toolsVisible) {
                                 DemoToolsPanel(
@@ -416,12 +424,7 @@ fun App() {
                                 VerticalDivider(modifier = Modifier.fillMaxHeight())
                             }
 
-                            WebView(
-                                state = webViewState,
-                                navigator = navigator,
-                                webViewJsBridge = jsBridge,
-                                modifier = Modifier.fillMaxSize(),
-                            )
+                            webViewContent(Modifier.fillMaxSize())
                         }
                     }
                 }
diff --git a/wrywebview/src/main/kotlin/io/github/kdroidfilter/webview/wry/WryWebViewPanel.kt b/wrywebview/src/main/kotlin/io/github/kdroidfilter/webview/wry/WryWebViewPanel.kt
@@ -8,6 +8,7 @@ import java.awt.event.MouseEvent
 import javax.swing.JPanel
 import javax.swing.SwingUtilities
 import javax.swing.Timer
+import kotlin.concurrent.thread
 
 
 class WryWebViewPanel(
@@ -24,6 +25,8 @@ class WryWebViewPanel(
     private var pendingHeaders: Map<String, String> = emptyMap()
     private var pendingHtml: String? = null
     private var createTimer: Timer? = null
+    private var destroyTimer: Timer? = null
+    private var createInFlight: Boolean = false
     private var gtkTimer: Timer? = null
     private var windowsTimer: Timer? = null
     private var skikoInitialized: Boolean = false
@@ -45,14 +48,15 @@ class WryWebViewPanel(
 
     override fun addNotify() {
         super.addNotify()
+        stopDestroyTimer()
         log("addNotify displayable=${host.isDisplayable} showing=${host.isShowing} size=${host.width}x${host.height}")
         SwingUtilities.invokeLater { scheduleCreateIfNeeded() }
     }
 
     override fun removeNotify() {
         log("removeNotify")
         stopCreateTimer()
-        destroyIfNeeded()
+        scheduleDestroyIfNeeded()
         super.removeNotify()
     }
 
@@ -282,6 +286,7 @@ class WryWebViewPanel(
 
     private fun createIfNeeded(): Boolean {
         if (webviewId != null) return true
+        if (createInFlight) return false
         if (!host.isDisplayable || !host.isShowing) return false
         if (host.width <= 0 || host.height <= 0) return false
         // On Windows, wait for the window to be fully visible
@@ -306,48 +311,69 @@ class WryWebViewPanel(
         parentHandle = resolved.handle
         parentIsWindow = resolved.isWindow
         log("createIfNeeded handle=$parentHandle parentIsWindow=$parentIsWindow size=${host.width}x${host.height}")
-        return try {
-            val width = host.width.coerceAtLeast(1)
-            val height = host.height.coerceAtLeast(1)
-            val userAgent = customUserAgent
-
-            webviewId =
+        val width = host.width.coerceAtLeast(1)
+        val height = host.height.coerceAtLeast(1)
+        val userAgent = customUserAgent
+        val initialUrl = pendingUrl
+        val handleSnapshot = parentHandle
+        createInFlight = true
+        stopCreateTimer()
+        thread(name = "wry-webview-create", isDaemon = true) {
+            val createdId = try {
                 if (userAgent == null) {
-                    NativeBindings.createWebview(parentHandle, width, height, pendingUrl)
+                    NativeBindings.createWebview(handleSnapshot, width, height, initialUrl)
                 } else {
-                    NativeBindings.createWebviewWithUserAgent(parentHandle, width, height, pendingUrl, userAgent)
+                    NativeBindings.createWebviewWithUserAgent(handleSnapshot, width, height, initialUrl, userAgent)
+                }
+            } catch (e: RuntimeException) {
+                System.err.println("Failed to create Wry webview: ${e.message}")
+                e.printStackTrace()
+                null
+            }
+            SwingUtilities.invokeLater {
+                createInFlight = false
+                if (createdId == null) {
+                    scheduleCreateIfNeeded()
+                    return@invokeLater
+                }
+                if (webviewId != null) {
+                    NativeBindings.destroyWebview(createdId)
+                    return@invokeLater
+                }
+                if (!host.isDisplayable || !host.isShowing) {
+                    NativeBindings.destroyWebview(createdId)
+                    return@invokeLater
                 }
-            updateBounds()
-            startGtkPumpIfNeeded()
-            startWindowsPumpIfNeeded()
-            // Apply any pending content that requires an explicit call after creation.
-            val id = webviewId
-            val html = pendingHtml
-            val urlWithHeaders = pendingUrlWithHeaders
-            val headers = pendingHeaders
-            if (id != null) {
+                webviewId = createdId
+                updateBounds()
+                startGtkPumpIfNeeded()
+                startWindowsPumpIfNeeded()
+                // Apply any pending content that requires an explicit call after creation.
+                val html = pendingHtml
+                val urlWithHeaders = pendingUrlWithHeaders
+                val headers = pendingHeaders
                 when {
                     html != null -> {
                         pendingHtml = null
-                        NativeBindings.loadHtml(id, html)
+                        NativeBindings.loadHtml(createdId, html)
                     }
                     urlWithHeaders != null && headers.isNotEmpty() -> {
                         pendingUrlWithHeaders = null
                         pendingHeaders = emptyMap()
-                        NativeBindings.loadUrlWithHeaders(id, urlWithHeaders, headers)
+                        NativeBindings.loadUrlWithHeaders(createdId, urlWithHeaders, headers)
+                    }
+                    pendingUrl != initialUrl -> {
+                        NativeBindings.loadUrl(createdId, pendingUrl)
                     }
                 }
+                log("createIfNeeded success id=$webviewId")
             }
-            log("createIfNeeded success id=$webviewId")
-            true
-        } catch (e: RuntimeException) {
-            System.err.println("Failed to create Wry webview: ${e.message}")
-            e.printStackTrace()
-            true
         }
+        return true
     }
 
     private fun destroyIfNeeded() {
+        stopDestroyTimer()
         stopGtkPump()
         stopWindowsPump()
         stopBoundsTimer()
@@ -364,7 +390,7 @@ class WryWebViewPanel(
     private fun updateBounds() {
         val id = webviewId ?: return
         val bounds = boundsInParent()
-        if (IS_LINUX) {
+        if (IS_LINUX || IS_MAC) {
             pendingBounds = bounds
             if (boundsTimer == null) {
                 boundsTimer = Timer(16) {
@@ -411,7 +437,7 @@ class WryWebViewPanel(
     }
 
     private fun scheduleCreateIfNeeded() {
-        if (webviewId != null || createTimer != null) return
+        if (webviewId != null || createTimer != null || createInFlight) return
         log("scheduleCreateIfNeeded")
         val delay = if (IS_WINDOWS) 100 else 16
         createTimer = Timer(delay) {
@@ -426,6 +452,25 @@ class WryWebViewPanel(
         createTimer = null
     }
 
+    private fun scheduleDestroyIfNeeded() {
+        if (destroyTimer != null) return
+        if (webviewId == null && !createInFlight) return
+        destroyTimer = Timer(400) {
+            stopDestroyTimer()
+            if (!host.isDisplayable || !host.isShowing) {
+                destroyIfNeeded()
+            }
+        }.apply {
+            isRepeats = false
+            start()
+        }
+    }
+
+    private fun stopDestroyTimer() {
+        destroyTimer?.stop()
+        destroyTimer = null
+    }
+
     private fun stopBoundsTimer() {
         boundsTimer?.stop()
         boundsTimer = null
@@ -442,7 +487,9 @@ class WryWebViewPanel(
     }
 
     private fun log(message: String) {
-        System.err.println("[WryWebViewPanel] $message")
+        if (LOG_ENABLED) {
+            System.err.println("[WryWebViewPanel] $message")
+        }
     }
 
     private fun resolveParentHandle(): ParentHandle? {
@@ -531,6 +578,17 @@ class WryWebViewPanel(
         private val IS_LINUX = OS_NAME.contains("linux")
         private val IS_MAC = OS_NAME.contains("mac")
         private val IS_WINDOWS = OS_NAME.contains("windows")
+        private val LOG_ENABLED = run {
+            val raw = System.getProperty("composewebview.wry.log") ?: System.getenv("WRYWEBVIEW_LOG")
+            when {
+                raw == null -> false
+                raw == "1" -> true
+                raw.equals("true", ignoreCase = true) -> true
+                raw.equals("yes", ignoreCase = true) -> true
+                raw.equals("debug", ignoreCase = true) -> true
+                else -> false
+            }
+        }
     }
 }
 
diff --git a/wrywebview/src/main/rust/lib.rs b/wrywebview/src/main/rust/lib.rs
@@ -11,6 +11,7 @@ mod state;
 use std::str::FromStr;
 use std::sync::atomic::Ordering;
 use std::sync::Arc;
+use std::sync::OnceLock;
 
 use wry::cookie::time::OffsetDateTime;
 use wry::cookie::{Cookie, Expiration, SameSite};
@@ -146,6 +147,18 @@ fn cookie_from_record(cookie: WebViewCookie) -> Result<Cookie<'static>, WebViewE
     Ok(builder.build())
 }
 
+fn log_enabled() -> bool {
+    static LOG_ENABLED: OnceLock<bool> = OnceLock::new();
+    *LOG_ENABLED.get_or_init(|| {
+        std::env::var("WRYWEBVIEW_LOG")
+            .map(|value| {
+                let value = value.trim().to_ascii_lowercase();
+                matches!(value.as_str(), "1" | "true" | "yes" | "debug")
+            })
+            .unwrap_or(false)
+    })
+}
+
 // ============================================================================
 // WebView Creation
 // ============================================================================
@@ -329,10 +342,12 @@ pub fn create_webview_with_user_agent(
 // ============================================================================
 
 fn set_bounds_inner(id: u64, x: i32, y: i32, width: i32, height: i32) -> Result<(), WebViewError> {
-    eprintln!(
-        "[wrywebview] set_bounds id={} pos=({}, {}) size={}x{}",
-        id, x, y, width, height
-    );
+    if log_enabled() {
+        eprintln!(
+            "[wrywebview] set_bounds id={} pos=({}, {}) size={}x{}",
+            id, x, y, width, height
+        );
+    }
     let bounds = make_bounds(x, y, width, height);
     with_webview(id, |webview| webview.set_bounds(bounds).map_err(WebViewError::from))
 }
@@ -778,12 +793,23 @@ fn destroy_webview_inner(id: u64) -> Result<(), WebViewError> {
 
 #[uniffi::export]
 pub fn destroy_webview(id: u64) -> Result<(), WebViewError> {
+    #[cfg(target_os = "macos")]
+    {
+        if MainThreadMarker::new().is_some() {
+            return destroy_webview_inner(id);
+        }
+        DispatchQueue::main().exec_async(move || {
+            let _ = destroy_webview_inner(id);
+        });
+        return Ok(());
+    }
+
     #[cfg(target_os = "linux")]
     {
         return run_on_gtk_thread(move || destroy_webview_inner(id));
     }
 
-    #[cfg(not(target_os = "linux"))]
+    #[cfg(any(target_os = "windows", not(any(target_os = "linux", target_os = "macos"))))]
     run_on_main_thread(move || destroy_webview_inner(id))
 }
 
