|
| 1 | +use crate::api::{ServerState, CLIENT_ID_HEADER}; |
| 2 | +use actix_web::{error, get, http::header, web, HttpRequest, HttpResponse, Result}; |
| 3 | +use futures::{ |
| 4 | + channel::mpsc::{unbounded, UnboundedReceiver, UnboundedSender}, |
| 5 | + StreamExt, |
| 6 | +}; |
| 7 | +use serde::Serialize; |
| 8 | +use std::{ |
| 9 | + collections::HashMap, |
| 10 | + sync::{Arc, Mutex}, |
| 11 | +}; |
| 12 | +use taskchampion_sync_server_core::{ClientId, VersionId}; |
| 13 | + |
| 14 | +#[derive(Clone, Debug, Serialize)] |
| 15 | +#[serde(rename_all = "camelCase")] |
| 16 | +pub(crate) struct ChangeEvent { |
| 17 | + pub(crate) client_id: ClientId, |
| 18 | + pub(crate) version_id: VersionId, |
| 19 | +} |
| 20 | + |
| 21 | +#[derive(Clone, Default)] |
| 22 | +pub(crate) struct ChangeNotifier { |
| 23 | + subscribers: Arc<Mutex<HashMap<ClientId, Vec<UnboundedSender<ChangeEvent>>>>>, |
| 24 | +} |
| 25 | + |
| 26 | +impl ChangeNotifier { |
| 27 | + pub(crate) fn subscribe(&self, client_id: ClientId) -> UnboundedReceiver<ChangeEvent> { |
| 28 | + let (tx, rx) = unbounded(); |
| 29 | + self.subscribers |
| 30 | + .lock() |
| 31 | + .expect("change notifier mutex poisoned") |
| 32 | + .entry(client_id) |
| 33 | + .or_default() |
| 34 | + .push(tx); |
| 35 | + rx |
| 36 | + } |
| 37 | + |
| 38 | + pub(crate) fn notify(&self, client_id: ClientId, version_id: VersionId) { |
| 39 | + let event = ChangeEvent { |
| 40 | + client_id, |
| 41 | + version_id, |
| 42 | + }; |
| 43 | + let mut subscribers = self |
| 44 | + .subscribers |
| 45 | + .lock() |
| 46 | + .expect("change notifier mutex poisoned"); |
| 47 | + if let Some(client_subscribers) = subscribers.get_mut(&client_id) { |
| 48 | + client_subscribers |
| 49 | + .retain(|subscriber| subscriber.unbounded_send(event.clone()).is_ok()); |
| 50 | + } |
| 51 | + } |
| 52 | +} |
| 53 | + |
| 54 | +#[get("/v1/client/events")] |
| 55 | +pub(crate) async fn service( |
| 56 | + req: HttpRequest, |
| 57 | + server_state: web::Data<Arc<ServerState>>, |
| 58 | +) -> Result<HttpResponse> { |
| 59 | + if !server_state.web_config.sync_events { |
| 60 | + return Err(error::ErrorNotFound("sync events are not enabled")); |
| 61 | + } |
| 62 | + |
| 63 | + let client_id = server_state.client_id_header(&req)?; |
| 64 | + let stream = server_state.changes.subscribe(client_id).map(|event| { |
| 65 | + let json = serde_json::to_string(&event).expect("change event serializes"); |
| 66 | + Ok::<_, actix_web::Error>(web::Bytes::from(format!( |
| 67 | + "event: version\n\ |
| 68 | + data: {json}\n\ |
| 69 | + \n" |
| 70 | + ))) |
| 71 | + }); |
| 72 | + |
| 73 | + Ok(HttpResponse::Ok() |
| 74 | + .append_header((header::CONTENT_TYPE, "text/event-stream")) |
| 75 | + .append_header((header::CACHE_CONTROL, "no-store, max-age=0")) |
| 76 | + .append_header((header::CONNECTION, "keep-alive")) |
| 77 | + .append_header((CLIENT_ID_HEADER, client_id.to_string())) |
| 78 | + .streaming(stream)) |
| 79 | +} |
| 80 | + |
| 81 | +#[cfg(test)] |
| 82 | +mod test { |
| 83 | + use super::*; |
| 84 | + use crate::web::{WebConfig, WebServer}; |
| 85 | + use actix_web::{http::StatusCode, test, App}; |
| 86 | + use taskchampion_sync_server_core::{InMemoryStorage, ServerConfig}; |
| 87 | + use uuid::Uuid; |
| 88 | + |
| 89 | + #[actix_rt::test] |
| 90 | + async fn notifier_delivers_events_for_matching_client() { |
| 91 | + let notifier = ChangeNotifier::default(); |
| 92 | + let client_id = Uuid::new_v4(); |
| 93 | + let version_id = Uuid::new_v4(); |
| 94 | + let mut rx = notifier.subscribe(client_id); |
| 95 | + |
| 96 | + notifier.notify(client_id, version_id); |
| 97 | + let event = rx.next().await.unwrap(); |
| 98 | + assert_eq!(event.client_id, client_id); |
| 99 | + assert_eq!(event.version_id, version_id); |
| 100 | + } |
| 101 | + |
| 102 | + #[actix_rt::test] |
| 103 | + async fn events_endpoint_uses_client_id_header() { |
| 104 | + let client_id = Uuid::new_v4(); |
| 105 | + let server = WebServer::new( |
| 106 | + ServerConfig::default(), |
| 107 | + WebConfig { |
| 108 | + sync_events: true, |
| 109 | + ..WebConfig::default() |
| 110 | + }, |
| 111 | + InMemoryStorage::new(), |
| 112 | + ); |
| 113 | + let app = App::new().configure(|sc| server.config(sc)); |
| 114 | + let app = test::init_service(app).await; |
| 115 | + |
| 116 | + let req = test::TestRequest::get() |
| 117 | + .uri("/v1/client/events") |
| 118 | + .append_header((CLIENT_ID_HEADER, client_id.to_string())) |
| 119 | + .to_request(); |
| 120 | + let resp = test::call_service(&app, req).await; |
| 121 | + |
| 122 | + assert_eq!(resp.status(), StatusCode::OK); |
| 123 | + assert_eq!( |
| 124 | + resp.headers().get(header::CONTENT_TYPE).unwrap(), |
| 125 | + "text/event-stream" |
| 126 | + ); |
| 127 | + } |
| 128 | + |
| 129 | + #[actix_rt::test] |
| 130 | + async fn events_endpoint_is_disabled_by_default() { |
| 131 | + let client_id = Uuid::new_v4(); |
| 132 | + let server = WebServer::new( |
| 133 | + ServerConfig::default(), |
| 134 | + WebConfig::default(), |
| 135 | + InMemoryStorage::new(), |
| 136 | + ); |
| 137 | + let app = App::new().configure(|sc| server.config(sc)); |
| 138 | + let app = test::init_service(app).await; |
| 139 | + |
| 140 | + let req = test::TestRequest::get() |
| 141 | + .uri("/v1/client/events") |
| 142 | + .append_header((CLIENT_ID_HEADER, client_id.to_string())) |
| 143 | + .to_request(); |
| 144 | + let resp = test::call_service(&app, req).await; |
| 145 | + |
| 146 | + assert_eq!(resp.status(), StatusCode::NOT_FOUND); |
| 147 | + } |
| 148 | +} |
0 commit comments