feat: implement proper WebSocket handler with actix-web-actors
- Replace stub websocket_handler with proper actix_web_actors::ws::start() - Add WsJobActor that subscribes to JobManager broadcast channel - Add broadcast::Sender/Receiver to JobManager for real-time status updates - Emit JobStatusEvent on job state changes (create, update, complete, fail) - Handle subscribe/unsubscribe client messages for per-job filtering - Add 5-second heartbeat ping/pong for connection keepalive - Properly compute Sec-WebSocket-Accept header per RFC 6455
This commit is contained in:
2
Cargo.lock
generated
2
Cargo.lock
generated
@ -1859,7 +1859,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "linux-patch-api"
|
name = "linux-patch-api"
|
||||||
version = "0.3.2"
|
version = "0.3.5"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"actix",
|
"actix",
|
||||||
"actix-rt",
|
"actix-rt",
|
||||||
|
|||||||
@ -15,4 +15,5 @@ pub mod websocket;
|
|||||||
|
|
||||||
// Re-export commonly used types
|
// Re-export commonly used types
|
||||||
pub use packages::{ApiError, ApiResponse};
|
pub use packages::{ApiError, ApiResponse};
|
||||||
pub use websocket::{WsClientMessage, WsServerMessage};
|
// WebSocket message types are now in crate::jobs::websocket
|
||||||
|
pub use crate::jobs::websocket::{WsClientMessage, WsServerMessage};
|
||||||
|
|||||||
@ -3,128 +3,34 @@
|
|||||||
//! Implements WebSocket endpoint for real-time job status updates:
|
//! Implements WebSocket endpoint for real-time job status updates:
|
||||||
//! - WS /api/v1/ws/jobs - Real-time job status streaming
|
//! - WS /api/v1/ws/jobs - Real-time job status streaming
|
||||||
//!
|
//!
|
||||||
//! Note: Full WebSocket implementation requires actix-web-actors compatibility.
|
//! Uses actix-web-actors for proper WebSocket handshake and protocol handling.
|
||||||
//! This stub provides the endpoint structure for future enhancement.
|
//! The actual actor logic lives in crate::jobs::websocket::WsJobActor.
|
||||||
|
|
||||||
use actix_web::{http::StatusCode, web, Error, HttpRequest, HttpResponse};
|
use actix_web::{web, Error, HttpRequest, HttpResponse};
|
||||||
use chrono::Utc;
|
|
||||||
use serde::{Deserialize, Serialize};
|
|
||||||
use tracing::info;
|
use tracing::info;
|
||||||
use uuid::Uuid;
|
|
||||||
|
|
||||||
use crate::jobs::manager::JobManager;
|
use crate::jobs::manager::JobManager;
|
||||||
|
use crate::jobs::websocket::WsJobActor;
|
||||||
/// WebSocket message from client
|
|
||||||
#[derive(Debug, Deserialize, Clone)]
|
|
||||||
#[serde(tag = "action")]
|
|
||||||
pub enum WsClientMessage {
|
|
||||||
#[serde(rename = "subscribe")]
|
|
||||||
Subscribe {
|
|
||||||
#[serde(default)]
|
|
||||||
job_id: Option<String>,
|
|
||||||
},
|
|
||||||
#[serde(rename = "unsubscribe")]
|
|
||||||
Unsubscribe { job_id: String },
|
|
||||||
}
|
|
||||||
|
|
||||||
/// WebSocket message to client
|
|
||||||
#[derive(Debug, Serialize, Clone)]
|
|
||||||
pub struct WsServerMessage {
|
|
||||||
pub event: String,
|
|
||||||
pub job_id: String,
|
|
||||||
pub status: String,
|
|
||||||
pub progress: u8,
|
|
||||||
pub message: String,
|
|
||||||
pub timestamp: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl WsServerMessage {
|
|
||||||
pub fn job_status(job_id: &str, status: &str, progress: u8, message: &str) -> Self {
|
|
||||||
Self {
|
|
||||||
event: "job_status".to_string(),
|
|
||||||
job_id: job_id.to_string(),
|
|
||||||
status: status.to_string(),
|
|
||||||
progress,
|
|
||||||
message: message.to_string(),
|
|
||||||
timestamp: Utc::now().to_rfc3339(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn job_complete(job_id: &str, status: &str, message: &str) -> Self {
|
|
||||||
Self {
|
|
||||||
event: "job_complete".to_string(),
|
|
||||||
job_id: job_id.to_string(),
|
|
||||||
status: status.to_string(),
|
|
||||||
progress: 100,
|
|
||||||
message: message.to_string(),
|
|
||||||
timestamp: Utc::now().to_rfc3339(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Handle WebSocket connection request
|
/// Handle WebSocket connection request
|
||||||
/// Returns upgrade response for WebSocket handshake
|
/// Performs the WebSocket handshake and spawns a WsJobActor
|
||||||
|
/// that streams job status events to the connected client.
|
||||||
pub async fn websocket_handler(
|
pub async fn websocket_handler(
|
||||||
req: HttpRequest,
|
req: HttpRequest,
|
||||||
_job_manager: web::Data<JobManager>,
|
stream: web::Payload,
|
||||||
|
job_manager: web::Data<JobManager>,
|
||||||
) -> Result<HttpResponse, Error> {
|
) -> Result<HttpResponse, Error> {
|
||||||
let ws_id = Uuid::new_v4();
|
info!("WebSocket connection request received");
|
||||||
info!(ws_id = %ws_id, "WebSocket connection request");
|
|
||||||
|
|
||||||
// Check if this is a WebSocket upgrade request
|
// Subscribe to job status events from the JobManager broadcast channel
|
||||||
if req
|
let event_rx = job_manager.subscribe();
|
||||||
.headers()
|
|
||||||
.get("upgrade")
|
|
||||||
.and_then(|v| v.to_str().ok())
|
|
||||||
.map(|v| v.eq_ignore_ascii_case("websocket"))
|
|
||||||
.unwrap_or(false)
|
|
||||||
{
|
|
||||||
// WebSocket upgrade requested
|
|
||||||
// In full implementation, this would use actix-web-actors::ws::start()
|
|
||||||
// For now, return a response indicating WebSocket support
|
|
||||||
|
|
||||||
let response_msg = serde_json::json!({
|
// Create the WebSocket actor with the broadcast receiver
|
||||||
"event": "connected",
|
let actor = WsJobActor::new(event_rx);
|
||||||
"ws_id": ws_id.to_string(),
|
|
||||||
"timestamp": Utc::now().to_rfc3339(),
|
|
||||||
"message": "WebSocket endpoint ready. Full implementation requires actix-web-actors compatibility.",
|
|
||||||
"polling_alternative": "Use GET /api/v1/jobs/{id} for job status polling"
|
|
||||||
});
|
|
||||||
|
|
||||||
// Return HTTP 101 Switching Protocols for WebSocket upgrade
|
// Perform the WebSocket handshake and start the actor
|
||||||
// In production, this would be handled by actix-web-actors
|
// This computes the proper Sec-WebSocket-Accept header and upgrades the connection
|
||||||
Ok(HttpResponse::build(StatusCode::SWITCHING_PROTOCOLS)
|
actix_web_actors::ws::start(actor, &req, stream)
|
||||||
.insert_header(("upgrade", "websocket"))
|
|
||||||
.insert_header(("connection", "upgrade"))
|
|
||||||
.json(response_msg))
|
|
||||||
} else {
|
|
||||||
// Not a WebSocket request - return info about the endpoint
|
|
||||||
let info_msg = serde_json::json!({
|
|
||||||
"endpoint": "/api/v1/ws/jobs",
|
|
||||||
"method": "GET",
|
|
||||||
"upgrade_required": "websocket",
|
|
||||||
"headers": {
|
|
||||||
"upgrade": "websocket",
|
|
||||||
"connection": "Upgrade",
|
|
||||||
"sec-websocket-key": "<base64-key>",
|
|
||||||
"sec-websocket-version": "13"
|
|
||||||
},
|
|
||||||
"alternative": "Use GET /api/v1/jobs/{id} for job status polling"
|
|
||||||
});
|
|
||||||
|
|
||||||
Ok(HttpResponse::Ok().json(info_msg))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Broadcast job status update to subscribed WebSocket clients
|
|
||||||
pub async fn broadcast_job_update(
|
|
||||||
job_id: &Uuid,
|
|
||||||
status: &crate::jobs::manager::JobStatus,
|
|
||||||
progress: u8,
|
|
||||||
_message: &str,
|
|
||||||
) {
|
|
||||||
info!(job_id = %job_id, status = ?status, progress = progress, "Job status update available for broadcast");
|
|
||||||
// In production, would use a broadcast channel to notify all subscribed WebSocket clients
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Configure WebSocket route
|
/// Configure WebSocket route
|
||||||
@ -134,7 +40,7 @@ pub fn configure_routes(cfg: &mut web::ServiceConfig) {
|
|||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use crate::jobs::websocket::{WsClientMessage, WsServerMessage};
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_ws_server_message_serialization() {
|
fn test_ws_server_message_serialization() {
|
||||||
|
|||||||
@ -1,13 +1,14 @@
|
|||||||
//! Job Manager - Async job queue management
|
//! Job Manager - Async job queue management
|
||||||
//!
|
//!
|
||||||
//! Manages async job execution with concurrency limits and timeout enforcement.
|
//! Manages async job execution with concurrency limits and timeout enforcement.
|
||||||
|
//! Broadcasts job status events via tokio broadcast channel for WebSocket streaming.
|
||||||
|
|
||||||
use anyhow::Result;
|
use anyhow::Result;
|
||||||
use chrono::{DateTime, Utc};
|
use chrono::{DateTime, Utc};
|
||||||
use std::collections::HashMap;
|
use std::collections::HashMap;
|
||||||
use std::sync::Arc;
|
use std::sync::Arc;
|
||||||
use std::time::Duration;
|
use std::time::Duration;
|
||||||
use tokio::sync::RwLock;
|
use tokio::sync::{RwLock, broadcast};
|
||||||
use uuid::Uuid;
|
use uuid::Uuid;
|
||||||
|
|
||||||
/// Job status
|
/// Job status
|
||||||
@ -21,6 +22,20 @@ pub enum JobStatus {
|
|||||||
TimedOut,
|
TimedOut,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Convert JobStatus to lowercase string for WebSocket events
|
||||||
|
impl JobStatus {
|
||||||
|
pub fn as_str(&self) -> &'static str {
|
||||||
|
match self {
|
||||||
|
JobStatus::Pending => "pending",
|
||||||
|
JobStatus::Running => "running",
|
||||||
|
JobStatus::Completed => "completed",
|
||||||
|
JobStatus::Failed => "failed",
|
||||||
|
JobStatus::Cancelled => "cancelled",
|
||||||
|
JobStatus::TimedOut => "timed_out",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/// Job operation type
|
/// Job operation type
|
||||||
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
|
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
|
||||||
pub enum JobOperation {
|
pub enum JobOperation {
|
||||||
@ -110,20 +125,35 @@ impl Job {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Job Manager - handles async job queue with limits
|
/// Job status event broadcast to WebSocket clients
|
||||||
|
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
|
||||||
|
pub struct JobStatusEvent {
|
||||||
|
pub event: String,
|
||||||
|
pub job_id: Uuid,
|
||||||
|
pub status: String,
|
||||||
|
pub progress: u8,
|
||||||
|
pub message: String,
|
||||||
|
pub timestamp: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Job Manager - handles async job queue with limits and WebSocket broadcast
|
||||||
pub struct JobManager {
|
pub struct JobManager {
|
||||||
max_concurrent: usize,
|
max_concurrent: usize,
|
||||||
timeout_minutes: u64,
|
timeout_minutes: u64,
|
||||||
jobs: Arc<RwLock<HashMap<Uuid, Job>>>,
|
jobs: Arc<RwLock<HashMap<Uuid, Job>>>,
|
||||||
|
/// Broadcast sender for job status events
|
||||||
|
event_sender: broadcast::Sender<JobStatusEvent>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl JobManager {
|
impl JobManager {
|
||||||
/// Create a new job manager
|
/// Create a new job manager
|
||||||
pub fn new(max_concurrent: usize, timeout_minutes: u64) -> Result<Self> {
|
pub fn new(max_concurrent: usize, timeout_minutes: u64) -> Result<Self> {
|
||||||
|
let (event_sender, _) = broadcast::channel(256);
|
||||||
Ok(Self {
|
Ok(Self {
|
||||||
max_concurrent,
|
max_concurrent,
|
||||||
timeout_minutes,
|
timeout_minutes,
|
||||||
jobs: Arc::new(RwLock::new(HashMap::new())),
|
jobs: Arc::new(RwLock::new(HashMap::new())),
|
||||||
|
event_sender,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -137,13 +167,46 @@ impl JobManager {
|
|||||||
self.max_concurrent
|
self.max_concurrent
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Subscribe to job status events
|
||||||
|
/// Returns a broadcast receiver that will receive JobStatusEvent messages
|
||||||
|
pub fn subscribe(&self) -> broadcast::Receiver<JobStatusEvent> {
|
||||||
|
self.event_sender.subscribe()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Emit a job status event to all subscribers
|
||||||
|
fn emit_event(
|
||||||
|
&self,
|
||||||
|
event_type: &str,
|
||||||
|
job_id: &Uuid,
|
||||||
|
status: &JobStatus,
|
||||||
|
progress: u8,
|
||||||
|
message: &str,
|
||||||
|
) {
|
||||||
|
let event = JobStatusEvent {
|
||||||
|
event: event_type.to_string(),
|
||||||
|
job_id: *job_id,
|
||||||
|
status: status.as_str().to_string(),
|
||||||
|
progress,
|
||||||
|
message: message.to_string(),
|
||||||
|
timestamp: Utc::now().to_rfc3339(),
|
||||||
|
};
|
||||||
|
// Ignore send errors (no receivers is fine)
|
||||||
|
let _ = self.event_sender.send(event);
|
||||||
|
}
|
||||||
|
|
||||||
/// Create a new job and return its ID
|
/// Create a new job and return its ID
|
||||||
pub async fn create_job(&self, operation: JobOperation, packages: Vec<String>) -> Result<Uuid> {
|
pub async fn create_job(&self, operation: JobOperation, packages: Vec<String>) -> Result<Uuid> {
|
||||||
let job = Job::new(operation, packages);
|
let job = Job::new(operation, packages);
|
||||||
let job_id = job.id;
|
let job_id = job.id;
|
||||||
|
let status = job.status.clone();
|
||||||
|
let progress = job.progress;
|
||||||
|
let message = job.message.clone();
|
||||||
|
|
||||||
let mut jobs = self.jobs.write().await;
|
let mut jobs = self.jobs.write().await;
|
||||||
jobs.insert(job_id, job);
|
jobs.insert(job_id, job);
|
||||||
|
drop(jobs); // Release lock before emitting event
|
||||||
|
|
||||||
|
self.emit_event("job_status", &job_id, &status, progress, &message);
|
||||||
|
|
||||||
Ok(job_id)
|
Ok(job_id)
|
||||||
}
|
}
|
||||||
@ -162,17 +225,28 @@ impl JobManager {
|
|||||||
progress: Option<u8>,
|
progress: Option<u8>,
|
||||||
message: Option<String>,
|
message: Option<String>,
|
||||||
) -> Result<()> {
|
) -> Result<()> {
|
||||||
let mut jobs = self.jobs.write().await;
|
let event_data;
|
||||||
|
{
|
||||||
|
let mut jobs = self.jobs.write().await;
|
||||||
|
|
||||||
if let Some(job) = jobs.get_mut(job_id) {
|
if let Some(job) = jobs.get_mut(job_id) {
|
||||||
job.status = status;
|
job.status = status;
|
||||||
if let Some(p) = progress {
|
if let Some(p) = progress {
|
||||||
job.progress = p;
|
job.progress = p;
|
||||||
|
}
|
||||||
|
if let Some(m) = message {
|
||||||
|
job.message = m;
|
||||||
|
}
|
||||||
|
job.updated_at = Utc::now();
|
||||||
|
|
||||||
|
event_data = Some((job.status.clone(), job.progress, job.message.clone()));
|
||||||
|
} else {
|
||||||
|
event_data = None;
|
||||||
}
|
}
|
||||||
if let Some(m) = message {
|
} // Write lock dropped here
|
||||||
job.message = m;
|
|
||||||
}
|
if let Some((status, progress, message)) = event_data {
|
||||||
job.updated_at = Utc::now();
|
self.emit_event("job_status", job_id, &status, progress, &message);
|
||||||
}
|
}
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
@ -191,10 +265,24 @@ impl JobManager {
|
|||||||
|
|
||||||
/// Mark a job as completed
|
/// Mark a job as completed
|
||||||
pub async fn complete_job(&self, job_id: &Uuid) -> Result<()> {
|
pub async fn complete_job(&self, job_id: &Uuid) -> Result<()> {
|
||||||
let mut jobs = self.jobs.write().await;
|
let event_data;
|
||||||
|
{
|
||||||
|
let mut jobs = self.jobs.write().await;
|
||||||
|
|
||||||
if let Some(job) = jobs.get_mut(job_id) {
|
if let Some(job) = jobs.get_mut(job_id) {
|
||||||
job.complete();
|
job.complete();
|
||||||
|
event_data = Some((
|
||||||
|
job.status.clone(),
|
||||||
|
job.progress,
|
||||||
|
job.message.clone(),
|
||||||
|
));
|
||||||
|
} else {
|
||||||
|
event_data = None;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some((status, progress, message)) = event_data {
|
||||||
|
self.emit_event("job_status", job_id, &status, progress, &message);
|
||||||
}
|
}
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
@ -202,10 +290,24 @@ impl JobManager {
|
|||||||
|
|
||||||
/// Mark a job as failed
|
/// Mark a job as failed
|
||||||
pub async fn fail_job(&self, job_id: &Uuid, error: String) -> Result<()> {
|
pub async fn fail_job(&self, job_id: &Uuid, error: String) -> Result<()> {
|
||||||
let mut jobs = self.jobs.write().await;
|
let event_data;
|
||||||
|
{
|
||||||
|
let mut jobs = self.jobs.write().await;
|
||||||
|
|
||||||
if let Some(job) = jobs.get_mut(job_id) {
|
if let Some(job) = jobs.get_mut(job_id) {
|
||||||
job.fail(error);
|
job.fail(error);
|
||||||
|
event_data = Some((
|
||||||
|
job.status.clone(),
|
||||||
|
job.progress,
|
||||||
|
job.message.clone(),
|
||||||
|
));
|
||||||
|
} else {
|
||||||
|
event_data = None;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some((status, progress, message)) = event_data {
|
||||||
|
self.emit_event("job_status", job_id, &status, progress, &message);
|
||||||
}
|
}
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
@ -308,6 +410,7 @@ impl Clone for JobManager {
|
|||||||
max_concurrent: self.max_concurrent,
|
max_concurrent: self.max_concurrent,
|
||||||
timeout_minutes: self.timeout_minutes,
|
timeout_minutes: self.timeout_minutes,
|
||||||
jobs: self.jobs.clone(),
|
jobs: self.jobs.clone(),
|
||||||
|
event_sender: self.event_sender.clone(),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,3 +1,425 @@
|
|||||||
//! Job WebSocket Handler
|
//! Job WebSocket Actor
|
||||||
//!
|
//!
|
||||||
//! Placeholder - implementation in future phases
|
//! Implements real-time WebSocket streaming for job status updates using
|
||||||
|
//! actix-web-actors. Each connected client gets a WsJobActor that:
|
||||||
|
//! - Subscribes to JobManager broadcast channel for job status events
|
||||||
|
//! - Filters events based on client subscribe/unsubscribe messages
|
||||||
|
//! - Forwards matching events as JSON to the WebSocket client
|
||||||
|
//! - Handles ping/pong heartbeat for connection keep-alive
|
||||||
|
//! - Cleans up on disconnect
|
||||||
|
|
||||||
|
use actix::prelude::*;
|
||||||
|
use actix_web_actors::ws;
|
||||||
|
use chrono::Utc;
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
use std::collections::HashSet;
|
||||||
|
use std::time::{Duration, Instant};
|
||||||
|
use tokio::sync::broadcast;
|
||||||
|
use tracing::{debug, error, info, warn};
|
||||||
|
use uuid::Uuid;
|
||||||
|
|
||||||
|
use super::manager::JobStatusEvent;
|
||||||
|
|
||||||
|
/// How often heartbeat pings are sent (seconds)
|
||||||
|
const HEARTBEAT_INTERVAL: Duration = Duration::from_secs(5);
|
||||||
|
/// How long before lack of client response causes a disconnect (seconds)
|
||||||
|
const CLIENT_TIMEOUT: Duration = Duration::from_secs(10);
|
||||||
|
|
||||||
|
/// Client-to-server WebSocket message
|
||||||
|
#[derive(Debug, Deserialize, Clone)]
|
||||||
|
#[serde(tag = "action")]
|
||||||
|
pub enum WsClientMessage {
|
||||||
|
/// Subscribe to events for a specific job, or all jobs if job_id is None
|
||||||
|
#[serde(rename = "subscribe")]
|
||||||
|
Subscribe {
|
||||||
|
#[serde(default)]
|
||||||
|
job_id: Option<String>,
|
||||||
|
},
|
||||||
|
/// Unsubscribe from events for a specific job
|
||||||
|
#[serde(rename = "unsubscribe")]
|
||||||
|
Unsubscribe { job_id: String },
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Server-to-client WebSocket message
|
||||||
|
#[derive(Debug, Serialize, Clone)]
|
||||||
|
pub struct WsServerMessage {
|
||||||
|
pub event: String,
|
||||||
|
pub job_id: String,
|
||||||
|
pub status: String,
|
||||||
|
pub progress: u8,
|
||||||
|
pub message: String,
|
||||||
|
pub timestamp: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl WsServerMessage {
|
||||||
|
/// Create a job status message from a JobStatusEvent
|
||||||
|
pub fn from_job_status_event(event: &JobStatusEvent) -> Self {
|
||||||
|
Self {
|
||||||
|
event: event.event.clone(),
|
||||||
|
job_id: event.job_id.to_string(),
|
||||||
|
status: event.status.clone(),
|
||||||
|
progress: event.progress,
|
||||||
|
message: event.message.clone(),
|
||||||
|
timestamp: event.timestamp.clone(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Create a connection established message
|
||||||
|
pub fn connected(ws_id: &Uuid) -> Self {
|
||||||
|
Self {
|
||||||
|
event: "connected".to_string(),
|
||||||
|
job_id: String::new(),
|
||||||
|
status: "connected".to_string(),
|
||||||
|
progress: 0,
|
||||||
|
message: format!("WebSocket connected: {}", ws_id),
|
||||||
|
timestamp: Utc::now().to_rfc3339(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Create a subscription confirmation message
|
||||||
|
pub fn subscribed(job_id: &Option<String>) -> Self {
|
||||||
|
match job_id {
|
||||||
|
Some(id) => Self {
|
||||||
|
event: "subscribed".to_string(),
|
||||||
|
job_id: id.clone(),
|
||||||
|
status: "subscribed".to_string(),
|
||||||
|
progress: 0,
|
||||||
|
message: format!("Subscribed to job: {}", id),
|
||||||
|
timestamp: Utc::now().to_rfc3339(),
|
||||||
|
},
|
||||||
|
None => Self {
|
||||||
|
event: "subscribed".to_string(),
|
||||||
|
job_id: "all".to_string(),
|
||||||
|
status: "subscribed".to_string(),
|
||||||
|
progress: 0,
|
||||||
|
message: "Subscribed to all job events".to_string(),
|
||||||
|
timestamp: Utc::now().to_rfc3339(),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Create an unsubscription confirmation message
|
||||||
|
pub fn unsubscribed(job_id: &str) -> Self {
|
||||||
|
Self {
|
||||||
|
event: "unsubscribed".to_string(),
|
||||||
|
job_id: job_id.to_string(),
|
||||||
|
status: "unsubscribed".to_string(),
|
||||||
|
progress: 0,
|
||||||
|
message: format!("Unsubscribed from job: {}", job_id),
|
||||||
|
timestamp: Utc::now().to_rfc3339(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Create an error message
|
||||||
|
pub fn error(code: &str, message: &str) -> Self {
|
||||||
|
Self {
|
||||||
|
event: "error".to_string(),
|
||||||
|
job_id: String::new(),
|
||||||
|
status: code.to_string(),
|
||||||
|
progress: 0,
|
||||||
|
message: message.to_string(),
|
||||||
|
timestamp: Utc::now().to_rfc3339(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Create a job status message (convenience constructor)
|
||||||
|
pub fn job_status(job_id: &str, status: &str, progress: u8, message: &str) -> Self {
|
||||||
|
Self {
|
||||||
|
event: "job_status".to_string(),
|
||||||
|
job_id: job_id.to_string(),
|
||||||
|
status: status.to_string(),
|
||||||
|
progress,
|
||||||
|
message: message.to_string(),
|
||||||
|
timestamp: Utc::now().to_rfc3339(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Internal message for broadcasting a job status event to the actor
|
||||||
|
#[derive(Message)]
|
||||||
|
#[rtype(result = "()")]
|
||||||
|
pub struct BroadcastEvent(pub JobStatusEvent);
|
||||||
|
|
||||||
|
/// WebSocket actor for streaming job status updates
|
||||||
|
pub struct WsJobActor {
|
||||||
|
/// Unique ID for this WebSocket connection
|
||||||
|
ws_id: Uuid,
|
||||||
|
/// Broadcast receiver for job status events from JobManager
|
||||||
|
event_rx: Option<broadcast::Receiver<JobStatusEvent>>,
|
||||||
|
/// Set of specific job IDs this client is subscribed to
|
||||||
|
subscribed_jobs: HashSet<String>,
|
||||||
|
/// Whether the client is subscribed to all job events
|
||||||
|
subscribed_all: bool,
|
||||||
|
/// Last time we heard from the client (ping/pong or message)
|
||||||
|
last_heartbeat: Instant,
|
||||||
|
/// The actor's own address for the broadcast listener
|
||||||
|
addr: Option<Addr<WsJobActor>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl WsJobActor {
|
||||||
|
/// Create a new WebSocket actor with a broadcast receiver
|
||||||
|
pub fn new(event_rx: broadcast::Receiver<JobStatusEvent>) -> Self {
|
||||||
|
Self {
|
||||||
|
ws_id: Uuid::new_v4(),
|
||||||
|
event_rx: Some(event_rx),
|
||||||
|
subscribed_jobs: HashSet::new(),
|
||||||
|
subscribed_all: true, // Default: subscribe to all events
|
||||||
|
last_heartbeat: Instant::now(),
|
||||||
|
addr: None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Start the heartbeat check interval
|
||||||
|
fn start_heartbeat(&self, ctx: &mut ws::WebsocketContext<Self>) {
|
||||||
|
ctx.run_interval(HEARTBEAT_INTERVAL, |act, ctx| {
|
||||||
|
if Instant::now().duration_since(act.last_heartbeat) > CLIENT_TIMEOUT {
|
||||||
|
// Heartbeat timed out, disconnect
|
||||||
|
warn!(
|
||||||
|
ws_id = %act.ws_id,
|
||||||
|
"WebSocket heartbeat timeout, disconnecting"
|
||||||
|
);
|
||||||
|
ctx.stop();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
// Send ping
|
||||||
|
ctx.ping(b"");
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Start listening to the broadcast channel in a background task
|
||||||
|
fn start_broadcast_listener(&mut self, ctx: &mut <Self as Actor>::Context) {
|
||||||
|
let addr = ctx.address();
|
||||||
|
self.addr = Some(addr.clone());
|
||||||
|
|
||||||
|
// Take ownership of the receiver
|
||||||
|
let mut rx = self.event_rx.take().expect("event_rx already taken");
|
||||||
|
|
||||||
|
// Spawn a task that forwards broadcast events to this actor
|
||||||
|
actix::spawn(async move {
|
||||||
|
loop {
|
||||||
|
match rx.recv().await {
|
||||||
|
Ok(event) => {
|
||||||
|
// Send the event to the actor
|
||||||
|
if addr.try_send(BroadcastEvent(event)).is_err() {
|
||||||
|
// Actor is dead, stop listening
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Err(broadcast::error::RecvError::Lagged(n)) => {
|
||||||
|
// We fell behind, but can continue
|
||||||
|
debug!("WebSocket broadcast receiver lagged by {} events", n);
|
||||||
|
}
|
||||||
|
Err(broadcast::error::RecvError::Closed) => {
|
||||||
|
// Channel closed, stop listening
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Actor for WsJobActor {
|
||||||
|
type Context = ws::WebsocketContext<Self>;
|
||||||
|
|
||||||
|
fn started(&mut self, ctx: &mut Self::Context) {
|
||||||
|
info!(ws_id = %self.ws_id, "WebSocket actor started");
|
||||||
|
|
||||||
|
// Start heartbeat monitoring
|
||||||
|
self.start_heartbeat(ctx);
|
||||||
|
|
||||||
|
// Start listening to broadcast events
|
||||||
|
self.start_broadcast_listener(ctx);
|
||||||
|
|
||||||
|
// Send connection established message
|
||||||
|
let msg = WsServerMessage::connected(&self.ws_id);
|
||||||
|
if let Ok(json) = serde_json::to_string(&msg) {
|
||||||
|
ctx.text(json);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn stopping(&mut self, _ctx: &mut Self::Context) -> Running {
|
||||||
|
info!(ws_id = %self.ws_id, "WebSocket actor stopping");
|
||||||
|
Running::Stop
|
||||||
|
}
|
||||||
|
|
||||||
|
fn stopped(&mut self, _ctx: &mut Self::Context) {
|
||||||
|
info!(ws_id = %self.ws_id, "WebSocket actor stopped");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Handle broadcast events from the JobManager channel
|
||||||
|
impl Handler<BroadcastEvent> for WsJobActor {
|
||||||
|
type Result = ();
|
||||||
|
|
||||||
|
fn handle(&mut self, msg: BroadcastEvent, ctx: &mut Self::Context) {
|
||||||
|
let event = msg.0;
|
||||||
|
|
||||||
|
// Check if this client should receive this event
|
||||||
|
let should_forward = self.subscribed_all
|
||||||
|
|| self
|
||||||
|
.subscribed_jobs
|
||||||
|
.contains(&event.job_id.to_string());
|
||||||
|
|
||||||
|
if should_forward {
|
||||||
|
let server_msg = WsServerMessage::from_job_status_event(&event);
|
||||||
|
match serde_json::to_string(&server_msg) {
|
||||||
|
Ok(json) => ctx.text(json),
|
||||||
|
Err(e) => {
|
||||||
|
error!(ws_id = %self.ws_id, error = %e, "Failed to serialize job status event");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Handle WebSocket protocol messages (ping/pong, text, close, etc.)
|
||||||
|
impl StreamHandler<Result<ws::Message, ws::ProtocolError>> for WsJobActor {
|
||||||
|
fn handle(&mut self, msg: Result<ws::Message, ws::ProtocolError>, ctx: &mut Self::Context) {
|
||||||
|
let msg = match msg {
|
||||||
|
Ok(msg) => msg,
|
||||||
|
Err(e) => {
|
||||||
|
error!(ws_id = %self.ws_id, error = %e, "WebSocket protocol error");
|
||||||
|
ctx.stop();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
match msg {
|
||||||
|
ws::Message::Ping(msg) => {
|
||||||
|
self.last_heartbeat = Instant::now();
|
||||||
|
ctx.pong(&msg);
|
||||||
|
}
|
||||||
|
ws::Message::Pong(_) => {
|
||||||
|
self.last_heartbeat = Instant::now();
|
||||||
|
}
|
||||||
|
ws::Message::Text(text) => {
|
||||||
|
let text = text.to_string();
|
||||||
|
debug!(ws_id = %self.ws_id, text = %text, "Received WebSocket text message");
|
||||||
|
|
||||||
|
// Parse as client message
|
||||||
|
match serde_json::from_str::<WsClientMessage>(&text) {
|
||||||
|
Ok(client_msg) => match client_msg {
|
||||||
|
WsClientMessage::Subscribe { job_id } => {
|
||||||
|
match job_id {
|
||||||
|
Some(id) => {
|
||||||
|
self.subscribed_jobs.insert(id.clone());
|
||||||
|
let msg = WsServerMessage::subscribed(&Some(id));
|
||||||
|
if let Ok(json) = serde_json::to_string(&msg) {
|
||||||
|
ctx.text(json);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
None => {
|
||||||
|
self.subscribed_all = true;
|
||||||
|
let msg = WsServerMessage::subscribed(&None);
|
||||||
|
if let Ok(json) = serde_json::to_string(&msg) {
|
||||||
|
ctx.text(json);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
WsClientMessage::Unsubscribe { job_id } => {
|
||||||
|
self.subscribed_jobs.remove(&job_id);
|
||||||
|
let msg = WsServerMessage::unsubscribed(&job_id);
|
||||||
|
if let Ok(json) = serde_json::to_string(&msg) {
|
||||||
|
ctx.text(json);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
Err(e) => {
|
||||||
|
warn!(
|
||||||
|
ws_id = %self.ws_id,
|
||||||
|
error = %e,
|
||||||
|
text = %text,
|
||||||
|
"Invalid WebSocket client message"
|
||||||
|
);
|
||||||
|
let msg = WsServerMessage::error("invalid_message", &format!("Invalid message: {}", e));
|
||||||
|
if let Ok(json) = serde_json::to_string(&msg) {
|
||||||
|
ctx.text(json);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
ws::Message::Binary(_) => {
|
||||||
|
// We don't handle binary messages
|
||||||
|
warn!(ws_id = %self.ws_id, "Received binary message, ignoring");
|
||||||
|
}
|
||||||
|
ws::Message::Close(reason) => {
|
||||||
|
info!(ws_id = %self.ws_id, reason = ?reason, "WebSocket close received");
|
||||||
|
ctx.close(reason);
|
||||||
|
ctx.stop();
|
||||||
|
}
|
||||||
|
ws::Message::Continuation(_) => {
|
||||||
|
// Continuation frames not expected for our use case
|
||||||
|
ctx.stop();
|
||||||
|
}
|
||||||
|
ws::Message::Nop => (),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_ws_server_message_from_event() {
|
||||||
|
let event = JobStatusEvent {
|
||||||
|
event: "job_status".to_string(),
|
||||||
|
job_id: Uuid::new_v4(),
|
||||||
|
status: "running".to_string(),
|
||||||
|
progress: 50,
|
||||||
|
message: "Processing...".to_string(),
|
||||||
|
timestamp: "2026-01-01T00:00:00Z".to_string(),
|
||||||
|
};
|
||||||
|
let msg = WsServerMessage::from_job_status_event(&event);
|
||||||
|
assert_eq!(msg.event, "job_status");
|
||||||
|
assert_eq!(msg.status, "running");
|
||||||
|
assert_eq!(msg.progress, 50);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_ws_server_message_serialization() {
|
||||||
|
let msg = WsServerMessage::job_status("test-uuid", "running", 50, "Processing...");
|
||||||
|
let json = serde_json::to_string(&msg).unwrap();
|
||||||
|
assert!(json.contains("job_status"));
|
||||||
|
assert!(json.contains("running"));
|
||||||
|
assert!(json.contains("50"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_ws_client_message_subscribe() {
|
||||||
|
let json = r#"{"action": "subscribe", "job_id": "test-uuid"}"#;
|
||||||
|
let msg: WsClientMessage = serde_json::from_str(json).unwrap();
|
||||||
|
match msg {
|
||||||
|
WsClientMessage::Subscribe { job_id } => {
|
||||||
|
assert_eq!(job_id, Some("test-uuid".to_string()));
|
||||||
|
}
|
||||||
|
_ => panic!("Expected Subscribe message"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_ws_client_message_subscribe_all() {
|
||||||
|
let json = r#"{"action": "subscribe"}"#;
|
||||||
|
let msg: WsClientMessage = serde_json::from_str(json).unwrap();
|
||||||
|
match msg {
|
||||||
|
WsClientMessage::Subscribe { job_id } => {
|
||||||
|
assert!(job_id.is_none());
|
||||||
|
}
|
||||||
|
_ => panic!("Expected Subscribe message"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_ws_client_message_unsubscribe() {
|
||||||
|
let json = r#"{"action": "unsubscribe", "job_id": "test-uuid"}"#;
|
||||||
|
let msg: WsClientMessage = serde_json::from_str(json).unwrap();
|
||||||
|
match msg {
|
||||||
|
WsClientMessage::Unsubscribe { job_id } => {
|
||||||
|
assert_eq!(job_id, "test-uuid");
|
||||||
|
}
|
||||||
|
_ => panic!("Expected Unsubscribe message"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user