Files
mnote/rust/crates/mnote-web/src/routes/ws.rs
T
lix-2026 9d8e361e43 feat(mnote-web): replace SSE pollMs=1000 polling with WebSocket push for tree realtime events
## Problem
Convex backend RSS grew to 7.7G due to ~17 HTTP POST /api/query/min
(32K+ in 32h) from the SSE polling loop in /api/tree/events?pollMs=1000.
Each poll triggered a Convex query even when nothing changed.

## Root Cause
The tree live EventSource client polled every 1s via SSE, calling
load_stream_overview() → execute_runtime_query_via_convex() → Convex
POST /api/query on every cycle, regardless of workspace state.

## Solution
Replace polling with push: add a `stream_delta_tx` broadcast channel
that publishes after every Convex mutation, consumed by WebSocket and
SSE endpoints for push-only delivery.

### Server-side
- **app.rs**: Add `stream_delta_tx: broadcast::Sender<Value>` to AppState
- **command_support.rs**: `execute_runtime_command_via_convex_with_artifacts`
  now takes `&AppState` (was `&AppConfig`) and pushes `{"kind":"command_committed",...}`
  to `stream_delta_tx` after every successful mutation
- **ws.rs**: Rewrite `handle_socket` with `tokio::select!` subscribing to
  `stream_delta_tx`; pushes delta events to WS clients on mutation, handles
  client `resync` requests for fresh snapshots
- **sse.rs**: `tree_events` endpoint now subscribes to both `block_delta_tx`
  and `stream_delta_tx`; when broadcast channels are available, runs in
  push-only mode (250ms heartbeat, no Convex query). Polling degrades to
  60s safety net. Keeps backward compatibility for non-WS clients.

### Client-side
- **layout.rs**: Bootstrap JSON now defaults to `transport: "convex-command-log-ws"`
  with `wsEndpoint: "/api/realtime/ws"`. TREE_LIVE_CONTROLLER_JS extended
  with `startWithWebSocket()` supporting snapshot/delta/resync/lagged-hint
  events; auto-fallback to SSE on WS failure after 2s.

### Caller updates (17 call sites)
- documents.rs, mindmap_api.rs, resource_trash.rs, tree.rs
- hermes_tools/{artifact,block,page}.rs
All updated from `state.config()` to `&state` for the new signature.

## Verification
- `cargo build` + `cargo test`: 295/298 passed (3 pre-existing failures)
- Browser smoke: page loaded → transport=convex-command-log-ws, status=connected
- Convex logs: 0 POST /api/query in 2min with page idle (vs ~17/min before)
- Initial burst: 8 queries on page load (normal), then silence
2026-05-17 12:58:27 +08:00

187 lines
7.2 KiB
Rust

use crate::app::AppState;
use crate::context::RequestContext;
use crate::error::WebError;
use crate::routes::stream_support::{load_stream_snapshot, StreamSnapshotQuery};
use axum::extract::ws::{Message, WebSocket, WebSocketUpgrade};
use axum::extract::{Extension, Query, State};
use axum::response::Response;
use futures_util::StreamExt;
use serde_json::{json, Value};
use tokio::sync::broadcast::error::RecvError;
pub async fn socket(
ws: WebSocketUpgrade,
State(state): State<AppState>,
Extension(context): Extension<RequestContext>,
Query(query): Query<StreamSnapshotQuery>,
) -> Result<Response, WebError> {
let snapshot = load_stream_snapshot(state.config(), &context, &query).await?;
let state = state.clone();
let context = context.clone();
let query = query.clone();
Ok(ws.on_upgrade(move |socket| handle_socket(socket, state, context, query, snapshot)))
}
async fn handle_socket(
mut socket: WebSocket,
state: AppState,
context: RequestContext,
query: StreamSnapshotQuery,
payload: Value,
) {
let mut stream_delta_rx = state.stream_delta_tx.subscribe();
let _ = socket.send(serialize_snapshot_message(&payload)).await;
loop {
tokio::select! {
biased;
// 优先处理 broadcast 推送的变更通知
delta_result = stream_delta_rx.recv() => {
match delta_result {
Ok(delta) => {
let notify = json!({
"kind": "delta",
"data": delta,
"requestId": context.trace.request_id,
"traceId": context.trace.trace_id,
"workspaceId": delta.get("workspaceId").and_then(Value::as_str).unwrap_or(""),
});
if socket.send(Message::Text(notify.to_string().into())).await.is_err() {
break;
}
}
Err(RecvError::Lagged(n)) => {
// Lagged: 发送 resync 提示让客户端重新加载
let lagged_hint = json!({
"kind": "resync_hint",
"reason": "stream lagged",
"dropped": n,
"requestId": context.trace.request_id,
"traceId": context.trace.trace_id,
});
let _ = socket.send(Message::Text(lagged_hint.to_string().into())).await;
}
Err(RecvError::Closed) => {
// Broadcast channel closed, WS stays open for client-initiated resync
}
}
}
// 处理客户端消息(resync 请求等)
message = socket.next() => {
match message {
Some(Ok(Message::Text(text))) => {
if is_resync_request(&text) {
match load_stream_snapshot(state.config(), &context, &query).await {
Ok(snapshot) => {
if socket
.send(serialize_resync_message(&snapshot))
.await
.is_err()
{
break;
}
// 重订阅 broadcast(可能丢掉了中间的变更)
stream_delta_rx = state.stream_delta_tx.subscribe();
}
Err(error) => {
let err_payload = json!({
"kind": "error",
"code": "snapshot_reload_failed",
"message": format!("{error:?}"),
"requestId": context.trace.request_id,
"traceId": context.trace.trace_id,
});
if socket
.send(Message::Text(err_payload.to_string().into()))
.await
.is_err()
{
break;
}
}
}
} else {
let ack = json!({
"kind": "ack",
"requestId": context.trace.request_id,
"traceId": context.trace.trace_id,
"accepted": false,
"reason": "unsupported_message",
});
if socket.send(Message::Text(ack.to_string().into())).await.is_err() {
break;
}
}
}
Some(Ok(Message::Close(_))) => break,
Some(Ok(_)) => {} // ignore binary/ping/pong
Some(Err(_)) => break,
None => break,
}
}
}
}
}
fn serialize_snapshot_message(payload: &Value) -> Message {
Message::Text(payload.to_string().into())
}
fn serialize_resync_message(payload: &Value) -> Message {
Message::Text(
json!({
"kind": "resync",
"snapshot": payload,
})
.to_string()
.into(),
)
}
fn is_resync_request(text: &str) -> bool {
let trimmed = text.trim();
if trimmed.eq_ignore_ascii_case("resync") {
return true;
}
serde_json::from_str::<Value>(trimmed)
.ok()
.and_then(|value| value.get("type").and_then(Value::as_str).map(str::to_owned))
.map(|value| value.eq_ignore_ascii_case("resync"))
.unwrap_or(false)
}
#[cfg(test)]
mod tests {
use super::{is_resync_request, serialize_resync_message, serialize_snapshot_message};
use axum::extract::ws::Message;
use serde_json::json;
#[test]
fn ws_resync_detection_accepts_plain_text_and_json() {
assert!(is_resync_request("resync"));
assert!(is_resync_request(r#"{"type":"resync"}"#));
assert!(!is_resync_request("hello"));
}
#[test]
fn ws_snapshot_serializers_emit_text_frames() {
let snapshot = json!({
"kind": "snapshot",
"scope": "workspace",
});
let Message::Text(snapshot_text) = serialize_snapshot_message(&snapshot) else {
panic!("snapshot message 应该是文本帧");
};
assert!(snapshot_text.contains("\"kind\":\"snapshot\""));
let Message::Text(resync_text) = serialize_resync_message(&snapshot) else {
panic!("resync message 应该是文本帧");
};
assert!(resync_text.contains("\"kind\":\"resync\""));
}
}