tauri-plugin-deeprespond-im 1.0.0-alpha

深应智能 IM 的 Tauri 插件:本地存储、安全存储、窗口间的锁与消息、系统事件、通知、角标、文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
//! 引擎窗口(《2.功能概述文档》第 4 节,《4.实现与测试》第 3.1 节):插件在 setup 中创建的不显示的 WebView,
//! 加载 App 的引擎页,固定为“主标签页”。负责:创建与重建(崩溃、重新加载、1 分钟内 3 次后停止)、加载失败的判断(10 秒)、
//! 唤醒检查(每 10 秒)、退出时的收尾(2 秒)、最后一个界面窗口关闭时退出。

use std::collections::{BTreeSet, VecDeque};
use std::sync::{Arc, Mutex};
use std::time::{Duration, Instant};

use serde_json::json;
use tauri::webview::{PageLoadEvent, PageLoadPayload};
use tauri::{AppHandle, ExitRequestApi, Manager, Runtime, Webview, WebviewUrl, WebviewWindowBuilder, WindowEvent};

use crate::hub::ENGINE_LABEL;
use crate::{Callbacks, EngineState, Shared};

const REBUILD_DELAY: Duration = Duration::from_secs(1);
const CRASH_WINDOW: Duration = Duration::from_secs(60);
const MAX_CRASHES: usize = 3;
const LOAD_TIMEOUT: Duration = Duration::from_secs(10);
const WAKE_INTERVAL: Duration = Duration::from_secs(10);
const WINDOW_CHECK_INTERVAL: Duration = Duration::from_secs(2);
const EXIT_WAIT: Duration = Duration::from_secs(2);
/// 引擎页每 3 秒报告一次存活;这么久没有报告的按卡死处理(刚从休眠中唤醒的不算)。
const ALIVE_TIMEOUT: Duration = Duration::from_secs(30);

struct Inner {
    state: EngineState,
    app_keys: BTreeSet<String>,
    signed_in: BTreeSet<String>,
    crashes: VecDeque<Instant>,
    /// 正在重建:引擎窗口的销毁是插件自己做的,不算崩溃,也不触发退出。
    rebuilding: bool,
    loading_since: Option<Instant>,
    last_alive: Instant,
    last_resume: Option<Instant>,
    exiting: bool,
    allow_exit: bool,
}

pub struct EngineCtl {
    inner: Mutex<Inner>,
    exit_done: tokio::sync::Notify,
    /// 各界面窗口最近一次交给页面的可见性和焦点(只在变化时发)
    window_states: Mutex<std::collections::HashMap<String, serde_json::Value>>,
}

impl Default for EngineCtl {
    fn default() -> Self {
        Self {
            inner: Mutex::new(Inner {
                state: EngineState::Starting,
                app_keys: BTreeSet::new(),
                signed_in: BTreeSet::new(),
                crashes: VecDeque::new(),
                rebuilding: false,
                loading_since: None,
                last_alive: Instant::now(),
                last_resume: None,
                exiting: false,
                allow_exit: false,
            }),
            exit_done: tokio::sync::Notify::new(),
            window_states: Mutex::new(std::collections::HashMap::new()),
        }
    }
}

impl EngineCtl {
    pub fn state(&self) -> EngineState {
        self.inner.lock().unwrap().state
    }

    pub fn app_keys(&self) -> Vec<String> {
        self.inner.lock().unwrap().app_keys.iter().cloned().collect()
    }

    /// 引擎为一个 AppKey 创建了客户端(signed_in:这个 AppKey 已登录,macOS 据此阻止 App Nap)。
    pub fn ready(&self, app_key: &str, signed_in: bool) -> bool {
        let mut inner = self.inner.lock().unwrap();
        inner.app_keys.insert(app_key.to_string());
        if signed_in {
            inner.signed_in.insert(app_key.to_string());
        } else {
            inner.signed_in.remove(app_key);
        }
        inner.loading_since = None;
        inner.last_alive = Instant::now();
        let changed = inner.state != EngineState::Ready;
        inner.state = EngineState::Ready;
        changed
    }

    pub fn any_signed_in(&self) -> bool {
        !self.inner.lock().unwrap().signed_in.is_empty()
    }

    pub fn alive(&self) {
        self.inner.lock().unwrap().last_alive = Instant::now();
    }

    /// 系统刚从休眠中唤醒:存活检查从现在重新计时。
    pub fn note_resume(&self) {
        let mut inner = self.inner.lock().unwrap();
        inner.last_resume = Some(Instant::now());
        inner.last_alive = Instant::now();
    }

    pub fn exit_done(&self) {
        self.exit_done.notify_waiters();
        self.exit_done.notify_one();
    }

    pub fn exiting(&self) -> bool {
        self.inner.lock().unwrap().exiting
    }
}

/// 引擎页必须是打包在内的页面(《2.功能概述文档》第 11 节):远程地址在初始化时报错;开发构建允许本机的开发服务器。
pub fn check_engine_url(url: &str) -> Result<(), String> {
    let lower = url.trim().to_ascii_lowercase();
    if lower.starts_with("http://") || lower.starts_with("https://") {
        let local = ["http://localhost", "http://127.0.0.1", "http://[::1]"].iter().any(|p| lower.starts_with(p));
        if cfg!(debug_assertions) && local {
            return Ok(());
        }
        return Err(format!("tauri-plugin-deeprespond-im:engine_url 必须是打包在内的页面,不能是远程地址:{url}"));
    }
    if lower.contains("://") {
        return Err(format!("tauri-plugin-deeprespond-im:engine_url 只能是前端资源中的路径:{url}"));
    }
    Ok(())
}

/// setup:给引擎窗口授权、创建它,启动唤醒检查和存活检查。另一个进程在使用同一份数据时不创建(状态为 failed)。
pub fn start<R: Runtime>(app: &AppHandle<R>, shared: &Arc<Shared>) -> Result<(), Box<dyn std::error::Error>> {
    app.add_capability(
        tauri::ipc::CapabilityBuilder::new("deeprespond-im-engine")
            .window(ENGINE_LABEL)
            .permission("deeprespond-im:engine"),
    )?;
    if shared.another_instance {
        set_state(shared, EngineState::Failed);
        return Ok(());
    }
    // 插件的 setup 中不能创建 WebView:等事件循环开始(RunEvent::Ready)再创建,见 on_ready
    {
        let mut inner = shared.engine.inner.lock().unwrap();
        inner.loading_since = Some(Instant::now());
    }
    watch_windows(app, shared);
    let handle = app.clone();
    let shared = shared.clone();
    tauri::async_runtime::spawn(async move {
        let mut wake = tokio::time::interval(WAKE_INTERVAL);
        wake.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Delay);
        loop {
            wake.tick().await;
            if shared.engine.exiting() {
                continue;
            }
            shared.hub.send_engine(json!({ "t": "wake" }));
            check_health(&handle, &shared);
        }
    });
    Ok(())
}

/// 事件循环开始:创建引擎窗口(另一个进程在使用同一份数据时不创建)。
/// 插件的回调(setup、on_event)执行时 Tauri 持有插件表的锁,创建 WebView 也要取它:从其他线程交给事件循环,在回调之外创建。
pub fn on_ready<R: Runtime>(app: &AppHandle<R>, shared: &Arc<Shared>) {
    if shared.another_instance {
        return;
    }
    let handle = app.clone();
    let shared = shared.clone();
    tauri::async_runtime::spawn(async move {
        let creator = handle.clone();
        let _ = handle.run_on_main_thread(move || {
            if creator.get_webview_window(ENGINE_LABEL).is_some() {
                return;
            }
            if let Err(err) = create_window(&creator, &shared) {
                shared.logs.plugin("error", &format!("创建引擎窗口失败:{err}"));
                set_state(&shared, EngineState::Failed);
            }
        });
    });
}

fn create_window<R: Runtime>(app: &AppHandle<R>, shared: &Arc<Shared>) -> tauri::Result<()> {
    let url = WebviewUrl::App(shared.config.engine_url.clone().into());
    let builder = WebviewWindowBuilder::new(app, ENGINE_LABEL, url)
        .title("deeprespond-im-engine")
        .visible(false)
        .focused(false)
        .skip_taskbar(true)
        .resizable(false)
        .inner_size(320.0, 240.0);
    // macOS 14 以上可以关闭隐藏页面的节流(《2.功能概述文档》第 4.5 节);计时器另外在 Worker 中运行
    #[cfg(target_os = "macos")]
    let builder = builder.background_throttling(tauri::utils::config::BackgroundThrottlingPolicy::Disabled);
    let window = builder.build()?;
    {
        let mut inner = shared.engine.inner.lock().unwrap();
        inner.loading_since = Some(Instant::now());
        inner.last_alive = Instant::now();
        inner.rebuilding = false;
    }
    watch_process(app, shared, &window);
    shared.logs.plugin("info", "引擎窗口已创建");
    Ok(())
}

/// Linux:WebKitGTK 的网页进程终止(崩溃、被结束)时立即重建;其他平台靠存活检查。
#[allow(unused_variables)]
fn watch_process<R: Runtime>(app: &AppHandle<R>, shared: &Arc<Shared>, window: &tauri::WebviewWindow<R>) {
    #[cfg(target_os = "linux")]
    {
        let handle = app.clone();
        let _ = window.with_webview(move |webview| {
            use webkit2gtk::WebViewExt;
            let handle = handle.clone();
            webview.inner().connect_web_process_terminated(move |_, reason| {
                if let Some(shared) = handle.try_state::<Arc<Shared>>() {
                    shared.logs.plugin("error", &format!("引擎窗口的网页进程终止:{reason:?}"));
                    crashed(&handle, &shared);
                }
            });
        });
    }
}

/// 加载失败与卡死的检查(每 10 秒)。
fn check_health<R: Runtime>(app: &AppHandle<R>, shared: &Arc<Shared>) {
    let mut fail = false;
    let mut hung = false;
    {
        let mut inner = shared.engine.inner.lock().unwrap();
        if let Some(since) = inner.loading_since {
            if since.elapsed() >= LOAD_TIMEOUT && inner.state != EngineState::Ready && inner.state != EngineState::Failed {
                inner.loading_since = None;
                fail = true;
            }
        }
        let resumed_recently = inner.last_resume.is_some_and(|t| t.elapsed() < Duration::from_secs(60));
        if inner.state == EngineState::Ready && !inner.rebuilding && !resumed_recently && inner.last_alive.elapsed() >= ALIVE_TIMEOUT {
            hung = true;
        }
    }
    if fail {
        shared.logs.plugin("error", "引擎页在 10 秒内没有创建引擎客户端(engine_url 写错或页面脚本出错),引擎状态置为 failed");
        set_state(shared, EngineState::Failed);
    }
    if hung {
        shared.logs.plugin("error", "引擎页 30 秒没有报告存活,按崩溃处理");
        crashed(app, shared);
    }
}

pub fn set_state(shared: &Shared, state: EngineState) {
    let app_keys = {
        let mut inner = shared.engine.inner.lock().unwrap();
        if inner.state == state {
            return;
        }
        inner.state = state;
        if state != EngineState::Ready {
            inner.app_keys.clear();
        }
        inner.app_keys.iter().cloned().collect::<Vec<_>>()
    };
    shared.hub.broadcast(json!({ "t": "engine", "state": state, "app_keys": app_keys }));
}

pub fn broadcast_state(shared: &Shared) {
    let (state, app_keys) = {
        let inner = shared.engine.inner.lock().unwrap();
        (inner.state, inner.app_keys.iter().cloned().collect::<Vec<_>>())
    };
    shared.hub.broadcast(json!({ "t": "engine", "state": state, "app_keys": app_keys }));
}

/// 引擎崩溃或卡死:回滚它的事务、释放锁(release_instance),1 秒后重建;1 分钟内第 3 次时停止重建。
pub fn crashed<R: Runtime>(app: &AppHandle<R>, shared: &Arc<Shared>) {
    if let Some(old) = shared.hub.detach(ENGINE_LABEL) {
        crate::release_instance(shared, &old);
    }
    let give_up = {
        let mut inner = shared.engine.inner.lock().unwrap();
        if inner.exiting || inner.rebuilding {
            return;
        }
        let now = Instant::now();
        inner.crashes.push_back(now);
        while inner.crashes.front().is_some_and(|t| now.duration_since(*t) > CRASH_WINDOW) {
            inner.crashes.pop_front();
        }
        let give_up = inner.crashes.len() >= MAX_CRASHES;
        if !give_up {
            inner.rebuilding = true;
        }
        give_up
    };
    if give_up {
        shared.logs.plugin("error", "引擎 1 分钟内崩溃 3 次,停止重建");
        set_state(shared, EngineState::Failed);
        return;
    }
    set_state(shared, EngineState::Restarting);
    let handle = app.clone();
    let shared = shared.clone();
    tauri::async_runtime::spawn(async move {
        tokio::time::sleep(REBUILD_DELAY).await;
        if let Some(window) = handle.get_webview_window(ENGINE_LABEL) {
            let _ = window.destroy();
            // 等窗口真正销毁、标签空出来
            for _ in 0..50 {
                if handle.get_webview_window(ENGINE_LABEL).is_none() {
                    break;
                }
                tokio::time::sleep(Duration::from_millis(20)).await;
            }
        }
        let creator = handle.clone();
        let shared2 = shared.clone();
        let _ = handle.run_on_main_thread(move || {
            if let Err(err) = create_window(&creator, &shared2) {
                shared2.logs.plugin("error", &format!("重建引擎窗口失败:{err}"));
                shared2.engine.inner.lock().unwrap().rebuilding = false;
                set_state(&shared2, EngineState::Failed);
            }
        });
    });
}

/// 页面开始加载:引擎页重新加载(开发时的热更新、意外刷新)按重建处理——旧页面的事务回滚、锁释放;
/// 界面窗口重新加载时释放旧页面的资源。
pub fn on_page_load<R: Runtime>(webview: &Webview<R>, payload: &PageLoadPayload<'_>) {
    if payload.event() != PageLoadEvent::Started {
        return;
    }
    let Some(shared) = webview.try_state::<Arc<Shared>>() else { return };
    let label = webview.label();
    if let Some(old) = shared.hub.detach(label) {
        crate::release_instance(&shared, &old);
        if label == ENGINE_LABEL {
            shared.logs.plugin("warn", "引擎页重新加载,按重建处理");
            {
                let mut inner = shared.engine.inner.lock().unwrap();
                inner.loading_since = Some(Instant::now());
            }
            set_state(&shared, EngineState::Restarting);
        }
    }
}

/// 窗口事件:销毁时释放页面的资源;引擎窗口意外销毁时重建;最后一个界面窗口销毁时退出;焦点变化交给那个窗口。
pub fn on_window_event<R: Runtime>(app: &AppHandle<R>, shared: &Arc<Shared>, label: &str, event: &WindowEvent) {
    match event {
        WindowEvent::Destroyed => {
            shared.engine.window_states.lock().unwrap().remove(label);
            if let Some(old) = shared.hub.detach(label) {
                crate::release_instance(shared, &old);
            }
            if label == ENGINE_LABEL {
                let unexpected = {
                    let inner = shared.engine.inner.lock().unwrap();
                    !inner.rebuilding && !inner.exiting && inner.state != EngineState::Failed
                };
                if unexpected {
                    shared.logs.plugin("error", "引擎窗口被意外关闭,重建");
                    crashed(app, shared);
                }
                return;
            }
            crate::badge::window_gone(app, shared, label);
            if shared.config.exit_when_last_window_closed && !shared.engine.exiting() {
                let remaining = app.webview_windows().keys().filter(|l| l.as_str() != ENGINE_LABEL && l.as_str() != label).count();
                if remaining == 0 {
                    shared.logs.plugin("info", "最后一个界面窗口已关闭,退出");
                    begin_exit(app, shared, 0);
                }
            }
        }
        WindowEvent::Focused(_) | WindowEvent::Resized(_) | WindowEvent::Moved(_) => {
            if label == ENGINE_LABEL {
                return;
            }
            if let WindowEvent::Focused(true) = event {
                crate::badge::window_focused(app, shared, label);
            }
            send_window_state(app, shared, label);
        }
        _ => {}
    }
}

/// 窗口的可见性和焦点(《2.功能概述文档》第 5.3 节):最小化、隐藏、锁屏都算不可见。
pub fn window_state<R: Runtime>(app: &AppHandle<R>, shared: &Shared, label: &str) -> serde_json::Value {
    let window = app.get_webview_window(label);
    let visible = window.as_ref().and_then(|w| w.is_visible().ok()).unwrap_or(false);
    let minimized = window.as_ref().and_then(|w| w.is_minimized().ok()).unwrap_or(false);
    let focused = window.as_ref().and_then(|w| w.is_focused().ok()).unwrap_or(false);
    let locked = shared.system.screen_locked();
    json!({ "visible": visible && !minimized && !locked, "focused": focused && !locked, "minimized": minimized, "screen_locked": locked })
}

pub fn send_window_state<R: Runtime>(app: &AppHandle<R>, shared: &Shared, label: &str) {
    let state = window_state(app, shared, label);
    {
        let mut last = shared.engine.window_states.lock().unwrap();
        if last.get(label) == Some(&state) {
            return;
        }
        last.insert(label.to_string(), state.clone());
    }
    let mut event = state;
    event["t"] = json!("window");
    shared.hub.send(label, event);
}

/// 隐藏、显示、由窗口管理器最小化等没有窗口事件:每 2 秒核对一次各界面窗口,变了的交给那个窗口。
fn watch_windows<R: Runtime>(app: &AppHandle<R>, shared: &Arc<Shared>) {
    let handle = app.clone();
    let shared = shared.clone();
    tauri::async_runtime::spawn(async move {
        let mut tick = tokio::time::interval(WINDOW_CHECK_INTERVAL);
        tick.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Delay);
        loop {
            tick.tick().await;
            for instance in shared.hub.windows() {
                send_window_state(&handle, &shared, &instance.label);
            }
        }
    });
}

/// 退出前的收尾(《2.功能概述文档》第 4.3 节):通知引擎,最多等 2 秒,然后退出。
pub fn begin_exit<R: Runtime>(app: &AppHandle<R>, shared: &Arc<Shared>, code: i32) {
    {
        let mut inner = shared.engine.inner.lock().unwrap();
        if inner.exiting {
            return;
        }
        inner.exiting = true;
    }
    let has_engine = shared.hub.send_engine(json!({ "t": "exit" }));
    let handle = app.clone();
    let shared = shared.clone();
    tauri::async_runtime::spawn(async move {
        if has_engine {
            let waited = tokio::time::timeout(EXIT_WAIT, shared.engine.exit_done.notified()).await;
            if waited.is_err() {
                shared.logs.plugin("warn", "引擎 2 秒内没有完成收尾,直接退出");
            }
        }
        shared.store.close_all();
        shared.logs.flush();
        shared.engine.inner.lock().unwrap().allow_exit = true;
        handle.exit(code);
    });
}

/// 关闭最后一个窗口、App 或系统要求退出时,先阻止这次退出,收尾后再退出(《3.接口设计》第 9 节)。
pub fn on_exit_requested<R: Runtime>(app: &AppHandle<R>, shared: &Arc<Shared>, code: Option<i32>, api: &ExitRequestApi) {
    let (allow, rebuilding) = {
        let inner = shared.engine.inner.lock().unwrap();
        (inner.allow_exit, inner.rebuilding)
    };
    if allow {
        return;
    }
    api.prevent_exit();
    // 重建引擎时全部窗口短暂地都不在:不是要退出
    if rebuilding && code.is_none() {
        return;
    }
    begin_exit(app, shared, code.unwrap_or(0));
}

/// 显示并聚焦主窗口;不存在时调用 App 的 on_main_window_missing(通知点击、来电接听没有窗口认领时)。
pub fn show_main_window<R: Runtime>(app: &AppHandle<R>, shared: &Shared) {
    match app.get_webview_window(&shared.config.main_window) {
        Some(window) => {
            let _ = window.unminimize();
            let _ = window.show();
            let _ = window.set_focus();
        }
        None => {
            if let Some(callbacks) = app.try_state::<Callbacks<R>>() {
                if let Some(f) = &callbacks.on_main_window_missing {
                    f(app);
                    return;
                }
            }
            shared.logs.plugin("warn", "主窗口不存在,也没有注册 on_main_window_missing");
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn engine_url_must_be_bundled() {
        assert!(check_engine_url("engine.html").is_ok());
        assert!(check_engine_url("/sub/engine.html").is_ok());
        assert!(check_engine_url("https://example.com/engine.html").is_err());
        assert!(check_engine_url("file:///tmp/engine.html").is_err());
        // 测试构建带 debug_assertions:允许本机的开发服务器
        assert_eq!(check_engine_url("http://localhost:1420/engine.html").is_ok(), cfg!(debug_assertions));
    }
}