542 lines
23 KiB
HTML
542 lines
23 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en" class="light sidebar-visible" dir="ltr">
|
||
|
|
<head>
|
||
|
|
<!-- Book generated using mdBook -->
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>0021: WebSocket Updates - VAPORA Platform Documentation</title>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- Custom HTML head -->
|
||
|
|
|
||
|
|
<meta name="description" content="Comprehensive documentation for VAPORA, an intelligent development orchestration platform built entirely in Rust.">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<meta name="theme-color" content="#ffffff">
|
||
|
|
|
||
|
|
<link rel="icon" href="../favicon.svg">
|
||
|
|
<link rel="shortcut icon" href="../favicon.png">
|
||
|
|
<link rel="stylesheet" href="../css/variables.css">
|
||
|
|
<link rel="stylesheet" href="../css/general.css">
|
||
|
|
<link rel="stylesheet" href="../css/chrome.css">
|
||
|
|
<link rel="stylesheet" href="../css/print.css" media="print">
|
||
|
|
|
||
|
|
<!-- Fonts -->
|
||
|
|
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
||
|
|
<link rel="stylesheet" href="../fonts/fonts.css">
|
||
|
|
|
||
|
|
<!-- Highlight.js Stylesheets -->
|
||
|
|
<link rel="stylesheet" id="highlight-css" href="../highlight.css">
|
||
|
|
<link rel="stylesheet" id="tomorrow-night-css" href="../tomorrow-night.css">
|
||
|
|
<link rel="stylesheet" id="ayu-highlight-css" href="../ayu-highlight.css">
|
||
|
|
|
||
|
|
<!-- Custom theme stylesheets -->
|
||
|
|
|
||
|
|
|
||
|
|
<!-- Provide site root and default themes to javascript -->
|
||
|
|
<script>
|
||
|
|
const path_to_root = "../";
|
||
|
|
const default_light_theme = "light";
|
||
|
|
const default_dark_theme = "dark";
|
||
|
|
</script>
|
||
|
|
<!-- Start loading toc.js asap -->
|
||
|
|
<script src="../toc.js"></script>
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id="mdbook-help-container">
|
||
|
|
<div id="mdbook-help-popup">
|
||
|
|
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
|
||
|
|
<div>
|
||
|
|
<p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
|
||
|
|
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
|
||
|
|
<p>Press <kbd>?</kbd> to show this help</p>
|
||
|
|
<p>Press <kbd>Esc</kbd> to hide this help</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="body-container">
|
||
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||
|
|
<script>
|
||
|
|
try {
|
||
|
|
let theme = localStorage.getItem('mdbook-theme');
|
||
|
|
let sidebar = localStorage.getItem('mdbook-sidebar');
|
||
|
|
|
||
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
||
|
|
}
|
||
|
|
|
||
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
||
|
|
}
|
||
|
|
} catch (e) { }
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
||
|
|
<script>
|
||
|
|
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
|
||
|
|
let theme;
|
||
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
||
|
|
const html = document.documentElement;
|
||
|
|
html.classList.remove('light')
|
||
|
|
html.classList.add(theme);
|
||
|
|
html.classList.add("js");
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
||
|
|
|
||
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
||
|
|
<script>
|
||
|
|
let sidebar = null;
|
||
|
|
const sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
||
|
|
if (document.body.clientWidth >= 1080) {
|
||
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||
|
|
sidebar = sidebar || 'visible';
|
||
|
|
} else {
|
||
|
|
sidebar = 'hidden';
|
||
|
|
}
|
||
|
|
sidebar_toggle.checked = sidebar === 'visible';
|
||
|
|
html.classList.remove('sidebar-visible');
|
||
|
|
html.classList.add("sidebar-" + sidebar);
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
||
|
|
<!-- populated by js -->
|
||
|
|
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
|
||
|
|
<noscript>
|
||
|
|
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
|
||
|
|
</noscript>
|
||
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
||
|
|
<div class="sidebar-resize-indicator"></div>
|
||
|
|
</div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<div id="page-wrapper" class="page-wrapper">
|
||
|
|
|
||
|
|
<div class="page">
|
||
|
|
<div id="menu-bar-hover-placeholder"></div>
|
||
|
|
<div id="menu-bar" class="menu-bar sticky">
|
||
|
|
<div class="left-buttons">
|
||
|
|
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
||
|
|
<i class="fa fa-bars"></i>
|
||
|
|
</label>
|
||
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
||
|
|
<i class="fa fa-paint-brush"></i>
|
||
|
|
</button>
|
||
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
||
|
|
</ul>
|
||
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="searchbar">
|
||
|
|
<i class="fa fa-search"></i>
|
||
|
|
</button>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h1 class="menu-title">VAPORA Platform Documentation</h1>
|
||
|
|
|
||
|
|
<div class="right-buttons">
|
||
|
|
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
||
|
|
<i id="print-button" class="fa fa-print"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/vapora-platform/vapora" title="Git repository" aria-label="Git repository">
|
||
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/vapora-platform/vapora/edit/main/docs/src/../adrs/0021-websocket-updates.md" title="Suggest an edit" aria-label="Suggest an edit">
|
||
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="search-wrapper" class="hidden">
|
||
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
||
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
||
|
|
</form>
|
||
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
||
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
||
|
|
<ul id="searchresults">
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||
|
|
<script>
|
||
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
||
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<div id="content" class="content">
|
||
|
|
<main>
|
||
|
|
<h1 id="adr-021-real-time-websocket-updates-via-broadcast"><a class="header" href="#adr-021-real-time-websocket-updates-via-broadcast">ADR-021: Real-Time WebSocket Updates via Broadcast</a></h1>
|
||
|
|
<p><strong>Status</strong>: Accepted | Implemented
|
||
|
|
<strong>Date</strong>: 2024-11-01
|
||
|
|
<strong>Deciders</strong>: Frontend Architecture Team
|
||
|
|
<strong>Technical Story</strong>: Enabling real-time workflow progress updates to multiple clients</p>
|
||
|
|
<hr />
|
||
|
|
<h2 id="decision"><a class="header" href="#decision">Decision</a></h2>
|
||
|
|
<p>Implementar <strong>real-time WebSocket updates</strong> usando <code>tokio::sync::broadcast</code> para pub/sub de workflow progress.</p>
|
||
|
|
<hr />
|
||
|
|
<h2 id="rationale"><a class="header" href="#rationale">Rationale</a></h2>
|
||
|
|
<ol>
|
||
|
|
<li><strong>Real-Time UX</strong>: Usuarios ven cambios inmediatos (no polling)</li>
|
||
|
|
<li><strong>Broadcast Efficiency</strong>: <code>broadcast</code> channel permite fan-out a múltiples clientes</li>
|
||
|
|
<li><strong>No State Tracking</strong>: No mantener per-client state, channel maneja distribución</li>
|
||
|
|
<li><strong>Async-Native</strong>: <code>tokio::sync</code> integrado con Tokio runtime</li>
|
||
|
|
</ol>
|
||
|
|
<hr />
|
||
|
|
<h2 id="alternatives-considered"><a class="header" href="#alternatives-considered">Alternatives Considered</a></h2>
|
||
|
|
<h3 id="-http-long-polling"><a class="header" href="#-http-long-polling">❌ HTTP Long-Polling</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><strong>Pros</strong>: Simple, no WebSocket complexity</li>
|
||
|
|
<li><strong>Cons</strong>: High latency, resource-intensive</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="-server-sent-events-sse"><a class="header" href="#-server-sent-events-sse">❌ Server-Sent Events (SSE)</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><strong>Pros</strong>: HTTP-based, simpler than WebSocket</li>
|
||
|
|
<li><strong>Cons</strong>: Unidirectional only (server→client)</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="-websocket--broadcast-chosen"><a class="header" href="#-websocket--broadcast-chosen">✅ WebSocket + Broadcast (CHOSEN)</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li>Bidirectional, low latency, efficient fan-out</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h2 id="trade-offs"><a class="header" href="#trade-offs">Trade-offs</a></h2>
|
||
|
|
<p><strong>Pros</strong>:</p>
|
||
|
|
<ul>
|
||
|
|
<li>✅ Real-time updates (sub-100ms latency)</li>
|
||
|
|
<li>✅ Efficient broadcast (no per-client loops)</li>
|
||
|
|
<li>✅ Bidirectional communication</li>
|
||
|
|
<li>✅ Lower bandwidth than polling</li>
|
||
|
|
</ul>
|
||
|
|
<p><strong>Cons</strong>:</p>
|
||
|
|
<ul>
|
||
|
|
<li>⚠️ Connection state management complex</li>
|
||
|
|
<li>⚠️ Harder to scale beyond single server</li>
|
||
|
|
<li>⚠️ Client reconnection handling needed</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h2 id="implementation"><a class="header" href="#implementation">Implementation</a></h2>
|
||
|
|
<p><strong>Broadcast Channel Setup</strong>:</p>
|
||
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
||
|
|
</span><span class="boring">fn main() {
|
||
|
|
</span>// crates/vapora-backend/src/main.rs
|
||
|
|
|
||
|
|
use tokio::sync::broadcast;
|
||
|
|
|
||
|
|
// Create broadcast channel (buffer size = 100 messages)
|
||
|
|
let (tx, _rx) = broadcast::channel(100);
|
||
|
|
|
||
|
|
// Share broadcaster in app state
|
||
|
|
let app_state = AppState::new(/* ... */)
|
||
|
|
.with_broadcast_tx(tx.clone());
|
||
|
|
<span class="boring">}</span></code></pre></pre>
|
||
|
|
<p><strong>Workflow Progress Event</strong>:</p>
|
||
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
||
|
|
</span><span class="boring">fn main() {
|
||
|
|
</span>// crates/vapora-backend/src/workflow.rs
|
||
|
|
|
||
|
|
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||
|
|
pub struct WorkflowUpdate {
|
||
|
|
pub workflow_id: String,
|
||
|
|
pub status: WorkflowStatus,
|
||
|
|
pub current_step: u32,
|
||
|
|
pub total_steps: u32,
|
||
|
|
pub message: String,
|
||
|
|
pub timestamp: DateTime<Utc>,
|
||
|
|
}
|
||
|
|
|
||
|
|
pub async fn update_workflow_status(
|
||
|
|
db: &Surreal<Ws>,
|
||
|
|
tx: &broadcast::Sender<WorkflowUpdate>,
|
||
|
|
workflow_id: &str,
|
||
|
|
status: WorkflowStatus,
|
||
|
|
) -> Result<()> {
|
||
|
|
// Update database
|
||
|
|
let updated = db
|
||
|
|
.query("UPDATE workflows SET status = $1 WHERE id = $2")
|
||
|
|
.bind((status, workflow_id))
|
||
|
|
.await?;
|
||
|
|
|
||
|
|
// Broadcast update to all subscribers
|
||
|
|
let update = WorkflowUpdate {
|
||
|
|
workflow_id: workflow_id.to_string(),
|
||
|
|
status,
|
||
|
|
current_step: 0, // Fetch from DB if needed
|
||
|
|
total_steps: 0,
|
||
|
|
message: format!("Workflow status changed to {:?}", status),
|
||
|
|
timestamp: Utc::now(),
|
||
|
|
};
|
||
|
|
|
||
|
|
// Ignore if no subscribers (channel will be dropped)
|
||
|
|
let _ = tx.send(update);
|
||
|
|
|
||
|
|
Ok(())
|
||
|
|
}
|
||
|
|
<span class="boring">}</span></code></pre></pre>
|
||
|
|
<p><strong>WebSocket Handler</strong>:</p>
|
||
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
||
|
|
</span><span class="boring">fn main() {
|
||
|
|
</span>// crates/vapora-backend/src/api/websocket.rs
|
||
|
|
|
||
|
|
use axum::extract::ws::{WebSocket, WebSocketUpgrade};
|
||
|
|
use futures::{sink::SinkExt, stream::StreamExt};
|
||
|
|
|
||
|
|
pub async fn websocket_handler(
|
||
|
|
ws: WebSocketUpgrade,
|
||
|
|
State(app_state): State<AppState>,
|
||
|
|
Path(workflow_id): Path<String>,
|
||
|
|
) -> impl IntoResponse {
|
||
|
|
ws.on_upgrade(|socket| handle_socket(socket, app_state, workflow_id))
|
||
|
|
}
|
||
|
|
|
||
|
|
async fn handle_socket(
|
||
|
|
socket: WebSocket,
|
||
|
|
app_state: AppState,
|
||
|
|
workflow_id: String,
|
||
|
|
) {
|
||
|
|
let (mut sender, mut receiver) = socket.split();
|
||
|
|
|
||
|
|
// Subscribe to workflow updates
|
||
|
|
let mut rx = app_state.broadcast_tx.subscribe();
|
||
|
|
|
||
|
|
// Task 1: Forward broadcast updates to WebSocket client
|
||
|
|
let workflow_id_clone = workflow_id.clone();
|
||
|
|
let send_task = tokio::spawn(async move {
|
||
|
|
while let Ok(update) = rx.recv().await {
|
||
|
|
// Filter: only send updates for this workflow
|
||
|
|
if update.workflow_id == workflow_id_clone {
|
||
|
|
if let Ok(msg) = serde_json::to_string(&update) {
|
||
|
|
if sender.send(Message::Text(msg)).await.is_err() {
|
||
|
|
break; // Client disconnected
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
});
|
||
|
|
|
||
|
|
// Task 2: Listen for client messages (if any)
|
||
|
|
let mut recv_task = tokio::spawn(async move {
|
||
|
|
while let Some(Ok(msg)) = receiver.next().await {
|
||
|
|
match msg {
|
||
|
|
Message::Close(_) => break,
|
||
|
|
Message::Ping(data) => {
|
||
|
|
// Respond to ping (keep-alive)
|
||
|
|
let _ = receiver.send(Message::Pong(data)).await;
|
||
|
|
}
|
||
|
|
_ => {}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
});
|
||
|
|
|
||
|
|
// Wait for either task to complete (client disconnect or broadcast end)
|
||
|
|
tokio::select! {
|
||
|
|
_ = &mut send_task => {},
|
||
|
|
_ = &mut recv_task => {},
|
||
|
|
}
|
||
|
|
}
|
||
|
|
<span class="boring">}</span></code></pre></pre>
|
||
|
|
<p><strong>Frontend Integration (Leptos)</strong>:</p>
|
||
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
||
|
|
</span><span class="boring">fn main() {
|
||
|
|
</span>// crates/vapora-frontend/src/api/websocket.rs
|
||
|
|
|
||
|
|
use leptos::*;
|
||
|
|
|
||
|
|
#[component]
|
||
|
|
pub fn WorkflowProgressMonitor(workflow_id: String) -> impl IntoView {
|
||
|
|
let (progress, set_progress) = create_signal::<Option<WorkflowUpdate>>(None);
|
||
|
|
|
||
|
|
create_effect(move |_| {
|
||
|
|
let workflow_id = workflow_id.clone();
|
||
|
|
|
||
|
|
spawn_local(async move {
|
||
|
|
match create_websocket_connection(&format!(
|
||
|
|
"ws://localhost:8001/api/workflows/{}/updates",
|
||
|
|
workflow_id
|
||
|
|
)) {
|
||
|
|
Ok(ws) => {
|
||
|
|
loop {
|
||
|
|
match ws.recv().await {
|
||
|
|
Ok(msg) => {
|
||
|
|
if let Ok(update) = serde_json::from_str::<WorkflowUpdate>(&msg) {
|
||
|
|
set_progress(Some(update));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
Err(_) => break,
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
Err(e) => eprintln!("WebSocket error: {:?}", e),
|
||
|
|
}
|
||
|
|
});
|
||
|
|
});
|
||
|
|
|
||
|
|
view! {
|
||
|
|
<div class="workflow-progress">
|
||
|
|
{move || {
|
||
|
|
progress().map(|update| {
|
||
|
|
view! {
|
||
|
|
<div class="progress-item">
|
||
|
|
<p>{&update.message}</p>
|
||
|
|
<progress
|
||
|
|
value={update.current_step}
|
||
|
|
max={update.total_steps}
|
||
|
|
/>
|
||
|
|
</div>
|
||
|
|
}
|
||
|
|
})
|
||
|
|
}}
|
||
|
|
</div>
|
||
|
|
}
|
||
|
|
}
|
||
|
|
<span class="boring">}</span></code></pre></pre>
|
||
|
|
<p><strong>Connection Management</strong>:</p>
|
||
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
||
|
|
</span><span class="boring">fn main() {
|
||
|
|
</span>pub async fn connection_with_reconnect(
|
||
|
|
ws_url: &str,
|
||
|
|
max_retries: u32,
|
||
|
|
) -> Result<WebSocket> {
|
||
|
|
let mut retries = 0;
|
||
|
|
|
||
|
|
loop {
|
||
|
|
match connect_websocket(ws_url).await {
|
||
|
|
Ok(ws) => return Ok(ws),
|
||
|
|
Err(e) if retries < max_retries => {
|
||
|
|
retries += 1;
|
||
|
|
let backoff_ms = 100 * 2_u64.pow(retries);
|
||
|
|
tokio::time::sleep(Duration::from_millis(backoff_ms)).await;
|
||
|
|
}
|
||
|
|
Err(e) => return Err(e),
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
<span class="boring">}</span></code></pre></pre>
|
||
|
|
<p><strong>Key Files</strong>:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>/crates/vapora-backend/src/api/websocket.rs</code> (WebSocket handler)</li>
|
||
|
|
<li><code>/crates/vapora-backend/src/workflow.rs</code> (broadcast events)</li>
|
||
|
|
<li><code>/crates/vapora-frontend/src/api/websocket.rs</code> (Leptos client)</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h2 id="verification"><a class="header" href="#verification">Verification</a></h2>
|
||
|
|
<pre><code class="language-bash"># Test broadcast channel basic functionality
|
||
|
|
cargo test -p vapora-backend test_broadcast_basic
|
||
|
|
|
||
|
|
# Test multiple subscribers
|
||
|
|
cargo test -p vapora-backend test_broadcast_multiple_subscribers
|
||
|
|
|
||
|
|
# Test filtering (only send relevant updates)
|
||
|
|
cargo test -p vapora-backend test_broadcast_filtering
|
||
|
|
|
||
|
|
# Integration: full WebSocket lifecycle
|
||
|
|
cargo test -p vapora-backend test_websocket_full_lifecycle
|
||
|
|
|
||
|
|
# Connection stability test
|
||
|
|
cargo test -p vapora-backend test_websocket_disconnection_handling
|
||
|
|
|
||
|
|
# Load test: multiple concurrent connections
|
||
|
|
cargo test -p vapora-backend test_websocket_concurrent_connections
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Expected Output</strong>:</p>
|
||
|
|
<ul>
|
||
|
|
<li>Updates broadcast to all subscribers</li>
|
||
|
|
<li>Only relevant workflow updates sent per subscription</li>
|
||
|
|
<li>Client disconnections handled gracefully</li>
|
||
|
|
<li>Reconnection with backoff works</li>
|
||
|
|
<li>Latency < 100ms</li>
|
||
|
|
<li>Scales to 100+ concurrent connections</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h2 id="consequences"><a class="header" href="#consequences">Consequences</a></h2>
|
||
|
|
<h3 id="scalability"><a class="header" href="#scalability">Scalability</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li>Single server: broadcast works well</li>
|
||
|
|
<li>Multiple servers: need message broker (Redis, NATS)</li>
|
||
|
|
<li>Load balancer: sticky sessions or server-wide broadcast</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="connection-management"><a class="header" href="#connection-management">Connection Management</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li>Automatic cleanup on client disconnect</li>
|
||
|
|
<li>Backpressure handling (dropped messages if queue full)</li>
|
||
|
|
<li>Per-connection state minimal</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="frontend"><a class="header" href="#frontend">Frontend</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li>Real-time UX without polling</li>
|
||
|
|
<li>Automatic disconnection handling</li>
|
||
|
|
<li>Graceful degradation if WebSocket unavailable</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="monitoring"><a class="header" href="#monitoring">Monitoring</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li>Track concurrent WebSocket connections</li>
|
||
|
|
<li>Monitor broadcast channel depth</li>
|
||
|
|
<li>Alert on high message loss</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h2 id="references"><a class="header" href="#references">References</a></h2>
|
||
|
|
<ul>
|
||
|
|
<li><a href="https://docs.rs/tokio/latest/tokio/sync/broadcast/index.html">Tokio Broadcast Documentation</a></li>
|
||
|
|
<li><code>/crates/vapora-backend/src/api/websocket.rs</code> (implementation)</li>
|
||
|
|
<li><code>/crates/vapora-frontend/src/api/websocket.rs</code> (client integration)</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<p><strong>Related ADRs</strong>: ADR-003 (Leptos Frontend), ADR-002 (Axum Backend)</p>
|
||
|
|
|
||
|
|
</main>
|
||
|
|
|
||
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
|
|
<!-- Mobile navigation buttons -->
|
||
|
|
<a rel="prev" href="../../adrs/0020-audit-trail.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<a rel="next prefetch" href="../../adrs/0022-error-handling.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<div style="clear: both"></div>
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||
|
|
<a rel="prev" href="../../adrs/0020-audit-trail.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<a rel="next prefetch" href="../../adrs/0022-error-handling.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<script>
|
||
|
|
window.playground_copyable = true;
|
||
|
|
</script>
|
||
|
|
|
||
|
|
|
||
|
|
<script src="../elasticlunr.min.js"></script>
|
||
|
|
<script src="../mark.min.js"></script>
|
||
|
|
<script src="../searcher.js"></script>
|
||
|
|
|
||
|
|
<script src="../clipboard.min.js"></script>
|
||
|
|
<script src="../highlight.js"></script>
|
||
|
|
<script src="../book.js"></script>
|
||
|
|
|
||
|
|
<!-- Custom JS scripts -->
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|