Stream events via a watch channel (#128)

This squashed commit makes a fairly significant structural change to significantly reduce Flodgatt's CPU usage.

Flodgatt connects to Redis in a single (green) thread, and then creates a new thread to handle each WebSocket/SSE connection. Previously, each thread was responsible for polling the Redis thread to determine whether it had a message relevant to the connected client. I initially selected this structure both because it was simple and because it minimized memory overhead – no messages are sent to a particular thread unless they are relevant to the client connected to the thread. However, I recently ran some load tests that show this approach to have unacceptable CPU costs when 300+ clients are simultaneously connected.

Accordingly, Flodgatt now uses a different structure: the main Redis thread now announces each incoming message via a watch channel connected to every client thread, and each client thread filters out irrelevant messages. In theory, this could lead to slightly higher memory use, but tests I have run so far have not found a measurable increase. On the other hand, Flodgatt's CPU use is now an order of magnitude lower in tests I've run.

This approach does run a (very slight) risk of dropping messages under extremely heavy load: because a watch channel only stores the most recent message transmitted, if Flodgatt adds a second message before the thread can read the first message, the first message will be overwritten and never transmitted. This seems unlikely to happen in practice, and we can avoid the issue entirely by changing to a broadcast channel when we upgrade to the most recent Tokio version (see #75).

Cargo.lock

@@ -453,7 +453,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 
 [[package]]
 name = "flodgatt"
-version = "0.7.1"
+version = "0.8.0"
 dependencies = [
  "criterion 0.3.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "dotenv 0.14.0 (registry+https://github.com/rust-lang/crates.io-index)",

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "flodgatt"
 description = "A blazingly fast drop-in replacement for the Mastodon streaming api server"
-version = "0.7.1"
+version = "0.8.0"
 authors = ["Daniel Long Sockwell <daniel@codesections.com", "Julian Laubstein <contact@julianlaubstein.de>"]
 edition = "2018"
 
@@ -43,8 +43,9 @@ stub_status = []
 production = []
 
 [profile.release]
-lto = "fat"
+#lto = "fat"
-panic = "abort"
+#panic = "abort"
-codegen-units = 1
+#codegen-units = 1
+
 
 

src/lib.rs

@@ -34,6 +34,9 @@
 //! most important settings for performance control the frequency with which the `ClientAgent`
 //! polls the `Receiver` and the frequency with which the `Receiver` polls Redis.
 //!
+
+#![allow(clippy::try_err, clippy::match_bool)]
+
 pub mod config;
 pub mod err;
 pub mod messages;

src/main.rs

@@ -1,10 +1,14 @@
 use flodgatt::{
     config::{DeploymentConfig, EnvVar, PostgresConfig, RedisConfig},
-    parse_client_request::{PgPool, Subscription},
+    messages::Event,
-    redis_to_client_stream::{ClientAgent, EventStream, Receiver},
+    parse_client_request::{PgPool, Subscription, Timeline},
+    redis_to_client_stream::{Receiver, SseStream, WsStream},
 };
 use std::{env, fs, net::SocketAddr, os::unix::fs::PermissionsExt};
-use tokio::net::UnixListener;
+use tokio::{
+    net::UnixListener,
+    sync::{mpsc, watch},
+};
 use warp::{http::StatusCode, path, ws::Ws2, Filter, Rejection};
 
 fn main() {
@@ -23,8 +27,10 @@ fn main() {
     let cfg = DeploymentConfig::from_env(env_vars);
 
     let pg_pool = PgPool::new(postgres_cfg);
-
+    let (event_tx, event_rx) = watch::channel((Timeline::empty(), Event::Ping));
-    let receiver = Receiver::try_from(redis_cfg)
+    let (cmd_tx, cmd_rx) = mpsc::unbounded_channel();
+    let poll_freq = *redis_cfg.polling_interval;
+    let receiver = Receiver::try_from(redis_cfg, event_tx, cmd_rx)
         .unwrap_or_else(|e| {
             log::error!("{}\nFlodgatt shutting down...", e);
             std::process::exit(1);
@@ -34,38 +40,57 @@ fn main() {
 
     // Server Sent Events
     let sse_receiver = receiver.clone();
-    let (sse_interval, whitelist_mode) = (*cfg.sse_interval, *cfg.whitelist_mode);
+    let (sse_rx, sse_cmd_tx) = (event_rx.clone(), cmd_tx.clone());
+    let whitelist_mode = *cfg.whitelist_mode;
     let sse_routes = Subscription::from_sse_query(pg_pool.clone(), whitelist_mode)
         .and(warp::sse())
         .map(
             move |subscription: Subscription, sse_connection_to_client: warp::sse::Sse| {
                 log::info!("Incoming SSE request for {:?}", subscription.timeline);
-                let mut client_agent = ClientAgent::new(sse_receiver.clone(), &subscription);
+                {
-                client_agent.subscribe();
+                    let mut receiver = sse_receiver.lock().expect("TODO");
-
+                    receiver.subscribe(&subscription).unwrap_or_else(|e| {
+                        log::error!("Could not subscribe to the Redis channel: {}", e)
+                    });
+                }
+                let cmd_tx = sse_cmd_tx.clone();
+                let sse_rx = sse_rx.clone();
+                // self.sse.reply(
+                //     warp::sse::keep_alive()
+                //         .interval(Duration::from_secs(30))
+                //         .text("thump".to_string())
+                //         .stream(event_stream),
+                // )
                 // send the updates through the SSE connection
-                EventStream::send_to_sse(client_agent, sse_connection_to_client, sse_interval)
+                SseStream::send_events(sse_connection_to_client, cmd_tx, subscription, sse_rx)
             },
         )
         .with(warp::reply::with::header("Connection", "keep-alive"));
 
     // WebSocket
     let ws_receiver = receiver.clone();
-    let (ws_update_interval, whitelist_mode) = (*cfg.ws_interval, *cfg.whitelist_mode);
+    let whitelist_mode = *cfg.whitelist_mode;
     let ws_routes = Subscription::from_ws_request(pg_pool, whitelist_mode)
         .and(warp::ws::ws2())
         .map(move |subscription: Subscription, ws: Ws2| {
             log::info!("Incoming websocket request for {:?}", subscription.timeline);
-            let mut client_agent = ClientAgent::new(ws_receiver.clone(), &subscription);
+            {
-            client_agent.subscribe();
+                let mut receiver = ws_receiver.lock().expect("TODO");
+                receiver.subscribe(&subscription).unwrap_or_else(|e| {
+                    log::error!("Could not subscribe to the Redis channel: {}", e)
+                });
+            }
+            let cmd_tx = cmd_tx.clone();
+            let ws_rx = event_rx.clone();
+            let token = subscription
+                .clone()
+                .access_token
+                .unwrap_or_else(String::new);
 
-            // send the updates through the WS connection
+            // send the updates through the WS connection (along with the access_token, for security)
-            // (along with the User's access_token which is sent for security)
             (
-                ws.on_upgrade(move |s| {
+                ws.on_upgrade(move |ws| WsStream::new(ws, cmd_tx, subscription).send_events(ws_rx)),
-                    EventStream::send_to_ws(s, client_agent, ws_update_interval)
+                token,
-                }),
-                subscription.access_token.unwrap_or_else(String::new),
             )
         })
         .map(|(reply, token)| warp::reply::with_header(reply, "sec-websocket-protocol", token));
@@ -77,14 +102,12 @@ fn main() {
 
     #[cfg(feature = "stub_status")]
     let status_endpoints = {
-        let (r1, r2, r3) = (receiver.clone(), receiver.clone(), receiver.clone());
+        let (r1, r3) = (receiver.clone(), receiver.clone());
         warp::path!("api" / "v1" / "streaming" / "health")
             .map(|| "OK")
             .or(warp::path!("api" / "v1" / "streaming" / "status")
                 .and(warp::path::end())
                 .map(move || r1.lock().expect("TODO").count_connections()))
-            .or(warp::path!("api" / "v1" / "streaming" / "status" / "queue")
-                .map(move || r2.lock().expect("TODO").queue_length()))
             .or(
                 warp::path!("api" / "v1" / "streaming" / "status" / "per_timeline")
                     .map(move || r3.lock().expect("TODO").list_connections()),
@@ -119,7 +142,24 @@ fn main() {
         )
         .run_incoming(incoming);
     } else {
+        use futures::{future::lazy, stream::Stream as _Stream};
+        use std::time::Instant;
+
         let server_addr = SocketAddr::new(*cfg.address, *cfg.port);
-        warp::serve(ws_routes.or(sse_routes).with(cors).or(status_endpoints)).run(server_addr);
+
+        tokio::run(lazy(move || {
+            let receiver = receiver.clone();
+            warp::spawn(lazy(move || {
+                tokio::timer::Interval::new(Instant::now(), poll_freq)
+                    .map_err(|e| log::error!("{}", e))
+                    .for_each(move |_| {
+                        let receiver = receiver.clone();
+                        receiver.lock().expect("TODO").poll_broadcast();
+                        Ok(())
+                    })
+            }));
+
+            warp::serve(ws_routes.or(sse_routes).with(cors).or(status_endpoints)).bind(server_addr)
+        }));
     };
 }

src/messages/event/checked_event/status/mod.rs

@@ -40,6 +40,7 @@ pub struct Status {
     poll: Option<Poll>,
     card: Option<Card>,
     language: Option<String>,
+
     text: Option<String>,
     // ↓↓↓ Only for authorized users
     favourited: Option<bool>,
@@ -85,16 +86,14 @@ impl Status {
     pub fn involves_any(&self, blocks: &Blocks) -> bool {
         const ALLOW: bool = false;
         const REJECT: bool = true;
-
         let Blocks {
             blocked_users,
             blocking_users,
             blocked_domains,
         } = blocks;
+        let user_id = &self.account.id.parse().expect("TODO");
 
-        if !self.calculate_involved_users().is_disjoint(blocked_users) {
+        if blocking_users.contains(user_id) || self.involves(blocked_users) {
-            REJECT
-        } else if blocking_users.contains(&self.account.id.parse().expect("TODO")) {
             REJECT
         } else {
             let full_username = &self.account.acct;
@@ -105,7 +104,7 @@ impl Status {
         }
     }
 
-    fn calculate_involved_users(&self) -> HashSet<i64> {
+    fn involves(&self, blocked_users: &HashSet<i64>) -> bool {
         // TODO replace vvvv with error handling
         let err = |_| log_fatal!("Could not process an `id` field in {:?}", &self);
 
@@ -126,6 +125,6 @@ impl Status {
         if let Some(boosted_status) = self.reblog.clone() {
             involved_users.insert(boosted_status.account.id.parse().unwrap_or_else(err));
         }
-        involved_users
+        !involved_users.is_disjoint(blocked_users)
     }
 }

src/messages/event/dynamic_event.rs

@@ -23,7 +23,7 @@ impl DynamicEvent {
         match self.payload["language"].as_str() {
             Some(toot_language) if allowed_langs.contains(toot_language) => ALLOW,
             None => ALLOW, // If toot language is unknown, toot is always allowed
-            Some(empty) if empty == &String::new() => ALLOW,
+            Some(empty) if empty == String::new() => ALLOW,
             Some(_toot_language) => REJECT,
         }
     }
@@ -45,12 +45,10 @@ impl DynamicEvent {
             blocked_domains,
         } = blocks;
 
-        let user_id = self.payload["account"]["id"].as_str().expect("TODO");
+        let id = self.payload["account"]["id"].as_str().expect("TODO");
         let username = self.payload["account"]["acct"].as_str().expect("TODO");
 
-        if !self.calculate_involved_users().is_disjoint(blocked_users) {
+        if self.involves(blocked_users) || blocking_users.contains(&id.parse().expect("TODO")) {
-            REJECT
-        } else if blocking_users.contains(&user_id.parse().expect("TODO")) {
             REJECT
         } else {
             let full_username = &username;
@@ -60,9 +58,11 @@ impl DynamicEvent {
             }
         }
     }
-    fn calculate_involved_users(&self) -> HashSet<i64> {
+
+    // involved_users = mentioned_users + author + replied-to user + boosted user
+    fn involves(&self, blocked_users: &HashSet<i64>) -> bool {
+        // mentions
         let mentions = self.payload["mentions"].as_array().expect("TODO");
-        // involved_users = mentioned_users + author + replied-to user + boosted user
         let mut involved_users: HashSet<i64> = mentions
             .iter()
             .map(|mention| mention["id"].as_str().expect("TODO").parse().expect("TODO"))
@@ -73,16 +73,15 @@ impl DynamicEvent {
         involved_users.insert(author_id.parse::<i64>().expect("TODO"));
         // replied-to user
         let replied_to_user = self.payload["in_reply_to_account_id"].as_str();
-        if let Some(user_id) = replied_to_user.clone() {
+        if let Some(user_id) = replied_to_user {
             involved_users.insert(user_id.parse().expect("TODO"));
         }
         // boosted user
-
         let id_of_boosted_user = self.payload["reblog"]["account"]["id"]
             .as_str()
             .expect("TODO");
         involved_users.insert(id_of_boosted_user.parse().expect("TODO"));
 
-        involved_users
+        !involved_users.is_disjoint(blocked_users)
     }
 }

src/messages/event/mod.rs

@@ -11,6 +11,7 @@ use std::string::String;
 pub enum Event {
     TypeSafe(CheckedEvent),
     Dynamic(DynamicEvent),
+    Ping,
 }
 
 impl Event {
@@ -37,6 +38,7 @@ impl Event {
                 CheckedEvent::FiltersChanged => "filters_changed",
             },
             Self::Dynamic(dyn_event) => &dyn_event.event,
+            Self::Ping => panic!("event_name() called on EventNotReady"),
         })
     }
 
@@ -54,6 +56,7 @@ impl Event {
                 FiltersChanged => None,
             },
             Self::Dynamic(dyn_event) => Some(dyn_event.payload.to_string()),
+            Self::Ping => panic!("payload() called on EventNotReady"),
         }
     }
 }

src/parse_client_request/subscription.rs

@@ -218,7 +218,7 @@ impl Timeline {
         };
 
         use {Content::*, Reach::*, Stream::*};
-        Ok(match &timeline.split(":").collect::<Vec<&str>>()[..] {
+        Ok(match &timeline.split(':').collect::<Vec<&str>>()[..] {
             ["public"] => Timeline(Public, Federated, All),
             ["public", "local"] => Timeline(Public, Local, All),
             ["public", "media"] => Timeline(Public, Federated, Media),

src/redis_to_client_stream/client_agent.rs

@@ -1,127 +0,0 @@
-//! Provides an interface between the `Warp` filters and the underlying
-//! mechanics of talking with Redis/managing multiple threads.
-//!
-//! The `ClientAgent`'s interface is very simple.  All you can do with it is:
-//!  * Create a totally new `ClientAgent` with no shared data;
-//!  * Clone an existing `ClientAgent`, sharing the `Receiver`;
-//!  * Manage an new timeline/user pair; or
-//!  * Poll an existing `ClientAgent` to see if there are any new messages
-//!    for clients
-//!
-//! When you poll the `ClientAgent`, it is responsible for polling internal data
-//! structures, getting any updates from Redis, and then filtering out any updates
-//! that should be excluded by relevant filters.
-//!
-//! Because `StreamManagers` are lightweight data structures that do not directly
-//! communicate with Redis, it we create a new `ClientAgent` for
-//! each new client connection (each in its own thread).use super::{message::Message, receiver::Receiver}
-use super::receiver::{Receiver, ReceiverErr};
-use crate::{
-    messages::Event,
-    parse_client_request::{Stream::Public, Subscription, Timeline},
-};
-use futures::{
-    Async::{self, NotReady, Ready},
-    Poll,
-};
-use std::sync::{Arc, Mutex, MutexGuard};
-
-/// Struct for managing all Redis streams.
-#[derive(Clone, Debug)]
-pub struct ClientAgent {
-    receiver: Arc<Mutex<Receiver>>,
-    pub subscription: Subscription,
-}
-
-impl ClientAgent {
-    pub fn new(receiver: Arc<Mutex<Receiver>>, subscription: &Subscription) -> Self {
-        ClientAgent {
-            receiver,
-            subscription: subscription.clone(),
-        }
-    }
-
-    /// Initializes the `ClientAgent` with a unique ID associated with a specific user's
-    /// subscription.  Also passes values to the `Receiver` for it's initialization.
-    ///
-    /// Note that this *may or may not* result in a new Redis connection.
-    /// If the server has already subscribed to the timeline on behalf of
-    /// a different user, the `Receiver` is responsible for figuring
-    /// that out and avoiding duplicated connections.  Thus, it is safe to
-    /// use this method for each new client connection.
-    pub fn subscribe(&mut self) {
-        let mut receiver = self.lock_receiver();
-        receiver
-            .add_subscription(&self.subscription)
-            .unwrap_or_else(|e| log::error!("Could not subscribe to the Redis channel: {}", e))
-    }
-
-    pub fn disconnect(&self) -> futures::future::FutureResult<bool, tokio::timer::Error> {
-        let mut receiver = self.lock_receiver();
-        receiver
-            .remove_subscription(&self.subscription)
-            .unwrap_or_else(|e| log::error!("Could not unsubscribe from: {}", e));
-        futures::future::ok(false)
-    }
-
-    fn lock_receiver(&self) -> MutexGuard<Receiver> {
-        match self.receiver.lock() {
-            Ok(inner) => inner,
-            Err(e) => {
-                log::error!(
-                    "Another thread crashed: {}\n
-                     Attempting to continue, possibly with invalid data",
-                    e
-                );
-                e.into_inner()
-            }
-        }
-    }
-}
-
-/// The stream that the `ClientAgent` manages.  `Poll` is the only method implemented.
-impl futures::stream::Stream for ClientAgent {
-    type Item = Event;
-    type Error = ReceiverErr;
-
-    /// Checks for any new messages that should be sent to the client.
-    ///
-    /// The `ClientAgent` polls the `Receiver` and replies
-    /// with `Ok(Ready(Some(Value)))` if there is a new message to send to
-    /// the client.  If there is no new message or if the new message should be
-    /// filtered out based on one of the user's filters, then the `ClientAgent`
-    /// replies with `Ok(NotReady)`.  The `ClientAgent` bubles up any
-    /// errors from the underlying data structures.
-    fn poll(&mut self) -> Poll<Option<Self::Item>, Self::Error> {
-        let result = {
-            let mut receiver = self.lock_receiver();
-            receiver.poll_for(self.subscription.id)
-        };
-
-        let timeline = &self.subscription.timeline;
-        let allowed_langs = &self.subscription.allowed_langs;
-        let blocks = &self.subscription.blocks;
-        let (send, block) = (|msg| Ok(Ready(Some(msg))), Ok(NotReady));
-
-        use crate::messages::{CheckedEvent::Update, Event::*};
-        match result {
-            Ok(NotReady) => Ok(NotReady),
-            Ok(Ready(None)) => Ok(Ready(None)),
-            Ok(Async::Ready(Some(event))) => match event {
-                TypeSafe(Update { payload, queued_at }) => match timeline {
-                    Timeline(Public, _, _) if payload.language_not(allowed_langs) => block,
-                    _ if payload.involves_any(blocks) => block,
-                    _ => send(TypeSafe(Update { payload, queued_at })),
-                },
-                TypeSafe(non_update) => send(Event::TypeSafe(non_update)),
-                Dynamic(event) if event.event == "update" => match timeline {
-                    Timeline(Public, _, _) if event.language_not(allowed_langs) => block,
-                    _ if event.involves_any(blocks) => block,
-                    _ => send(Dynamic(event)),
-                },
-                Dynamic(non_update) => send(Dynamic(non_update)),
-            },
-            Err(e) => Err(e),
-        }
-    }
-}

src/redis_to_client_stream/event_stream.rs

@@ -1,32 +1,37 @@
-use super::ClientAgent;
+use crate::messages::Event;
+use crate::parse_client_request::{Subscription, Timeline};
 
-use futures::{future::Future, stream::Stream, Async};
+use futures::{future::Future, stream::Stream};
 use log;
-use std::time::{Duration, Instant};
+use std::time::Duration;
+use tokio::sync::{mpsc, watch};
 use warp::{
     reply::Reply,
-    sse::Sse,
+    sse::{ServerSentEvent, Sse},
     ws::{Message, WebSocket},
 };
-pub struct EventStream;
 
-impl EventStream {
+pub struct WsStream {
-    /// Send a stream of replies to a WebSocket client.
+    ws_tx: mpsc::UnboundedSender<Message>,
-    pub fn send_to_ws(
+    unsubscribe_tx: mpsc::UnboundedSender<Timeline>,
+    subscription: Subscription,
+}
+
+impl WsStream {
+    pub fn new(
         ws: WebSocket,
-        mut client_agent: ClientAgent,
+        unsubscribe_tx: mpsc::UnboundedSender<Timeline>,
-        interval: Duration,
+        subscription: Subscription,
-    ) -> impl Future<Item = (), Error = ()> {
+    ) -> Self {
         let (transmit_to_ws, _receive_from_ws) = ws.split();
-        let timeline = client_agent.subscription.timeline;
-
         // Create a pipe
-        let (tx, rx) = futures::sync::mpsc::unbounded();
+        let (ws_tx, ws_rx) = mpsc::unbounded_channel();
 
-        // Send one end of it to a different thread and tell that end to forward whatever it gets
+        // Send one end of it to a different green thread and tell that end to forward
-        // on to the WebSocket client
+        // whatever it gets on to the WebSocket client
         warp::spawn(
-            rx.map_err(|()| -> warp::Error { unreachable!() })
+            ws_rx
+                .map_err(|_| -> warp::Error { unreachable!() })
                 .forward(transmit_to_ws)
                 .map(|_r| ())
                 .map_err(|e| match e.to_string().as_ref() {
@@ -34,70 +39,119 @@ impl EventStream {
                     _ => log::warn!("WebSocket send error: {}", e),
                 }),
         );
-
+        Self {
-        let mut last_ping_time = Instant::now();
+            ws_tx,
-        tokio::timer::Interval::new(Instant::now(), interval)
+            unsubscribe_tx,
-            .take_while(move |_| {
+            subscription,
-                // Right now, we do not need to see if we have any messages _from_ the
+        }
-                // WebSocket connection because the API doesn't support clients sending
-                // commands via the WebSocket.  However, if the [stream multiplexing API
-                // change](github.com/tootsuite/flodgatt/issues/121) is implemented, we'll
-                // need to receive messages from the client.  If so, we'll need a
-                // `receive_from_ws.poll() call here (or later)`
-                match client_agent.poll() {
-                    Ok(Async::NotReady) => {
-                        if last_ping_time.elapsed() > Duration::from_secs(30) {
-                            last_ping_time = Instant::now();
-                            match tx.unbounded_send(Message::text("{}")) {
-                                Ok(_) => futures::future::ok(true),
-                                Err(_) => client_agent.disconnect(),
-                            }
-                        } else {
-                            futures::future::ok(true)
-                        }
-                    }
-                    Ok(Async::Ready(Some(msg))) => {
-                        match tx.unbounded_send(Message::text(msg.to_json_string())) {
-                            Ok(_) => futures::future::ok(true),
-                            Err(_) => client_agent.disconnect(),
-                        }
-                    }
-                    Err(e) => {
-                        log::error!("{}\n Dropping WebSocket message and continuing.", e);
-                        futures::future::ok(true)
-                    }
-                    Ok(Async::Ready(None)) => {
-                        log::info!("WebSocket ClientAgent got Ready(None)");
-                        futures::future::ok(true)
-                    }
-                }
-            })
-            .for_each(move |_instant| Ok(()))
-            .then(move |result| {
-                log::info!("WebSocket connection for {:?} closed.", timeline);
-                result
-            })
-            .map_err(move |e| log::warn!("Error sending to {:?}: {}", timeline, e))
     }
 
-    pub fn send_to_sse(mut client_agent: ClientAgent, sse: Sse, interval: Duration) -> impl Reply {
+    pub fn send_events(
-        let event_stream =
+        mut self,
-            tokio::timer::Interval::new(Instant::now(), interval).filter_map(move |_| {
+        event_rx: watch::Receiver<(Timeline, Event)>,
-                match client_agent.poll() {
+    ) -> impl Future<Item = (), Error = ()> {
-                    Ok(Async::Ready(Some(event))) => Some((
+        let target_timeline = self.subscription.timeline;
-                        warp::sse::event(event.event_name()),
+
-                        warp::sse::data(event.payload().unwrap_or_else(String::new)),
+        event_rx.map_err(|_| ()).for_each(move |(tl, event)| {
-                    )),
+            if matches!(event, Event::Ping) {
-                    Ok(Async::Ready(None)) => {
+                self.send_ping()
-                        log::info!("SSE ClientAgent got Ready(None)");
+            } else if target_timeline == tl {
-                        None
+                use crate::messages::{CheckedEvent::Update, Event::*};
-                    }
+                use crate::parse_client_request::Stream::Public;
-                    Ok(Async::NotReady) => None,
+                let blocks = &self.subscription.blocks;
-                    Err(e) => {
+                let allowed_langs = &self.subscription.allowed_langs;
-                        log::error!("{}\n Dropping SSE message and continuing.", e);
+
-                        None
+                match event {
-                    }
+                    TypeSafe(Update { payload, queued_at }) => match tl {
+                        Timeline(Public, _, _) if payload.language_not(allowed_langs) => Ok(()),
+                        _ if payload.involves_any(&blocks) => Ok(()),
+                        _ => self.send_msg(TypeSafe(Update { payload, queued_at })),
+                    },
+                    TypeSafe(non_update) => self.send_msg(TypeSafe(non_update)),
+                    Dynamic(event) if event.event == "update" => match tl {
+                        Timeline(Public, _, _) if event.language_not(allowed_langs) => Ok(()),
+                        _ if event.involves_any(&blocks) => Ok(()),
+                        _ => self.send_msg(Dynamic(event)),
+                    },
+                    Dynamic(non_update) => self.send_msg(Dynamic(non_update)),
+                    Ping => unreachable!(), // handled pings above
                 }
+            } else {
+                Ok(())
+            }
+        })
+    }
+
+    fn send_ping(&mut self) -> Result<(), ()> {
+        self.send_txt("{}")
+    }
+
+    fn send_msg(&mut self, event: Event) -> Result<(), ()> {
+        self.send_txt(&event.to_json_string())
+    }
+
+    fn send_txt(&mut self, txt: &str) -> Result<(), ()> {
+        let tl = self.subscription.timeline;
+        match self.ws_tx.try_send(Message::text(txt)) {
+            Ok(_) => Ok(()),
+            Err(_) => {
+                self.unsubscribe_tx.try_send(tl).expect("TODO");
+                Err(())
+            }
+        }
+    }
+}
+
+pub struct SseStream {}
+
+impl SseStream {
+    fn reply_with(event: Event) -> Option<(impl ServerSentEvent, impl ServerSentEvent)> {
+        Some((
+            warp::sse::event(event.event_name()),
+            warp::sse::data(event.payload().unwrap_or_else(String::new)),
+        ))
+    }
+
+    pub fn send_events(
+        sse: Sse,
+        mut unsubscribe_tx: mpsc::UnboundedSender<Timeline>,
+        subscription: Subscription,
+        sse_rx: watch::Receiver<(Timeline, Event)>,
+    ) -> impl Reply {
+        let target_timeline = subscription.timeline;
+        let allowed_langs = subscription.allowed_langs;
+        let blocks = subscription.blocks;
+
+        let event_stream = sse_rx
+            .filter_map(move |(timeline, event)| {
+                if target_timeline == timeline {
+                    use crate::messages::{CheckedEvent, CheckedEvent::Update, Event::*};
+                    use crate::parse_client_request::Stream::Public;
+                    match event {
+                        TypeSafe(Update { payload, queued_at }) => match timeline {
+                            Timeline(Public, _, _) if payload.language_not(&allowed_langs) => None,
+                            _ if payload.involves_any(&blocks) => None,
+                            _ => Self::reply_with(Event::TypeSafe(CheckedEvent::Update {
+                                payload,
+                                queued_at,
+                            })),
+                        },
+                        TypeSafe(non_update) => Self::reply_with(Event::TypeSafe(non_update)),
+                        Dynamic(event) if event.event == "update" => match timeline {
+                            Timeline(Public, _, _) if event.language_not(&allowed_langs) => None,
+                            _ if event.involves_any(&blocks) => None,
+                            _ => Self::reply_with(Event::Dynamic(event)),
+                        },
+                        Dynamic(non_update) => Self::reply_with(Event::Dynamic(non_update)),
+                        Ping => None, // pings handled automatically
+                    }
+                } else {
+                    None
+                }
+            })
+            .then(move |res| {
+                unsubscribe_tx.try_send(target_timeline).expect("TODO");
+                res
             });
 
         sse.reply(

src/redis_to_client_stream/mod.rs

@@ -1,10 +1,12 @@
 //! Stream the updates appropriate for a given `User`/`timeline` pair from Redis.
-mod client_agent;
 mod event_stream;
 mod receiver;
 mod redis;
 
-pub use {client_agent::ClientAgent, event_stream::EventStream, receiver::Receiver};
+pub use {
+    event_stream::{SseStream, WsStream},
+    receiver::Receiver,
+};
 
 #[cfg(feature = "bench")]
 pub use redis::redis_msg::{RedisMsg, RedisParseOutput};

src/redis_to_client_stream/receiver/message_queues.rs

@@ -1,53 +0,0 @@
-use crate::messages::Event;
-use crate::parse_client_request::Timeline;
-
-use hashbrown::HashMap;
-use std::{collections::VecDeque, fmt};
-use uuid::Uuid;
-
-#[derive(Clone)]
-pub struct MsgQueue {
-    pub timeline: Timeline,
-    pub messages: VecDeque<Event>,
-}
-
-impl MsgQueue {
-    pub fn new(timeline: Timeline) -> Self {
-        MsgQueue {
-            messages: VecDeque::new(),
-
-            timeline,
-        }
-    }
-}
-
-#[derive(Debug)]
-pub struct MessageQueues(pub HashMap<Uuid, MsgQueue>);
-
-impl MessageQueues {}
-
-impl fmt::Debug for MsgQueue {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(
-            f,
-            "\
-MsgQueue {{
-    timeline: {:?},
-    messages: {:?},    
-}}",
-            self.timeline, self.messages,
-        )
-    }
-}
-
-impl std::ops::Deref for MessageQueues {
-    type Target = HashMap<Uuid, MsgQueue>;
-    fn deref(&self) -> &Self::Target {
-        &self.0
-    }
-}
-impl std::ops::DerefMut for MessageQueues {
-    fn deref_mut(&mut self) -> &mut Self::Target {
-        &mut self.0
-    }
-}

src/redis_to_client_stream/receiver/mod.rs

@@ -2,10 +2,7 @@
 //! polled by the correct `ClientAgent`.  Also manages sububscriptions and
 //! unsubscriptions to/from Redis.
 mod err;
-mod message_queues;
-
 pub use err::ReceiverErr;
-pub use message_queues::{MessageQueues, MsgQueue};
 
 use super::redis::{redis_connection::RedisCmd, RedisConn};
 
@@ -15,11 +12,9 @@ use crate::{
     parse_client_request::{Stream, Subscription, Timeline},
 };
 
-use {
+use futures::{Async, Stream as _Stream};
-    futures::{Async, Poll},
+use hashbrown::HashMap;
-    hashbrown::HashMap,
+use tokio::sync::{mpsc, watch};
-    uuid::Uuid,
-};
 
 use std::{
     result,
@@ -33,25 +28,28 @@ type Result<T> = result::Result<T, ReceiverErr>;
 #[derive(Debug)]
 pub struct Receiver {
     redis_connection: RedisConn,
-    redis_poll_interval: Duration,
-    redis_polled_at: Instant,
-    pub msg_queues: MessageQueues,
     clients_per_timeline: HashMap<Timeline, i32>,
+    tx: watch::Sender<(Timeline, Event)>,
+    rx: mpsc::UnboundedReceiver<Timeline>,
+    ping_time: Instant,
 }
 
 impl Receiver {
     /// Create a new `Receiver`, with its own Redis connections (but, as yet, no
     /// active subscriptions).
-    pub fn try_from(redis_cfg: config::RedisConfig) -> Result<Self> {
-        let redis_poll_interval = *redis_cfg.polling_interval;
-        let redis_connection = RedisConn::new(redis_cfg)?;
 
+    pub fn try_from(
+        redis_cfg: config::RedisConfig,
+        tx: watch::Sender<(Timeline, Event)>,
+        rx: mpsc::UnboundedReceiver<Timeline>,
+    ) -> Result<Self> {
         Ok(Self {
-            redis_polled_at: Instant::now(),
+            redis_connection: RedisConn::new(redis_cfg)?,
-            redis_poll_interval,
+
-            redis_connection,
-            msg_queues: MessageQueues(HashMap::new()),
             clients_per_timeline: HashMap::new(),
+            tx,
+            rx,
+            ping_time: Instant::now(),
         })
     }
 
@@ -59,15 +57,12 @@ impl Receiver {
         Arc::new(Mutex::new(self))
     }
 
-    /// Assigns the `Receiver` a new timeline to monitor and runs other
+    pub fn subscribe(&mut self, subscription: &Subscription) -> Result<()> {
-    /// first-time setup.
-    pub fn add_subscription(&mut self, subscription: &Subscription) -> Result<()> {
         let (tag, tl) = (subscription.hashtag_name.clone(), subscription.timeline);
 
         if let (Some(hashtag), Timeline(Stream::Hashtag(id), _, _)) = (tag, tl) {
             self.redis_connection.update_cache(hashtag, id);
         };
-        self.msg_queues.insert(subscription.id, MsgQueue::new(tl));
 
         let number_of_subscriptions = self
             .clients_per_timeline
@@ -79,13 +74,11 @@ impl Receiver {
         if *number_of_subscriptions == 1 {
             self.redis_connection.send_cmd(Subscribe, &tl)?
         };
-
+        log::info!("Started stream for {:?}", tl);
         Ok(())
     }
 
-    pub fn remove_subscription(&mut self, subscription: &Subscription) -> Result<()> {
+    pub fn unsubscribe(&mut self, tl: Timeline) -> Result<()> {
-        let tl = subscription.timeline;
-        self.msg_queues.remove(&subscription.id);
         let number_of_subscriptions = self
             .clients_per_timeline
             .entry(tl)
@@ -102,48 +95,30 @@ impl Receiver {
             self.redis_connection.send_cmd(Unsubscribe, &tl)?;
             self.clients_per_timeline.remove_entry(&tl);
         };
-
+        log::info!("Ended stream for {:?}", tl);
         Ok(())
     }
 
-    /// Returns the oldest message in the `ClientAgent`'s queue (if any).
+    pub fn poll_broadcast(&mut self) {
-    ///
+        while let Ok(Async::Ready(Some(tl))) = self.rx.poll() {
-    /// Note: This method does **not** poll Redis every time, because polling
+            self.unsubscribe(tl).expect("TODO");
-    /// Redis is significantly more time consuming that simply returning the
-    /// message already in a queue.  Thus, we only poll Redis if it has not
-    /// been polled lately.
-    pub fn poll_for(&mut self, id: Uuid) -> Poll<Option<Event>, ReceiverErr> {
-        //        let (t1, mut polled_redis) = (Instant::now(), false);
-        if self.redis_polled_at.elapsed() > self.redis_poll_interval {
-            loop {
-                match self.redis_connection.poll_redis() {
-                    Ok(Async::NotReady) => break,
-                    Ok(Async::Ready(Some((timeline, event)))) => {
-                        self.msg_queues
-                            .values_mut()
-                            .filter(|msg_queue| msg_queue.timeline == timeline)
-                            .for_each(|msg_queue| {
-                                msg_queue.messages.push_back(event.clone());
-                            });
-                    }
-                    Ok(Async::Ready(None)) => (), // subscription cmd or msg for other namespace
-                    Err(err) => Err(err)?,
-                }
-            }
-            //          polled_redis = true;
-            self.redis_polled_at = Instant::now();
         }
 
-        // If the `msg_queue` being polled has any new messages, return the first (oldest) one
+        if self.ping_time.elapsed() > Duration::from_secs(30) {
-        let msg_q = self.msg_queues.get_mut(&id).ok_or(ReceiverErr::InvalidId)?;
+            self.ping_time = Instant::now();
-        let res = match msg_q.messages.pop_front() {
+            self.tx
-            Some(event) => Ok(Async::Ready(Some(event))),
+                .broadcast((Timeline::empty(), Event::Ping))
-            None => Ok(Async::NotReady),
+                .expect("TODO");
-        };
+        } else {
-        // if !polled_redis {
+            match self.redis_connection.poll_redis() {
-        //     log::info!("poll_for in {:?}", t1.elapsed());
+                Ok(Async::NotReady) => (),
-        // }
+                Ok(Async::Ready(Some((timeline, event)))) => {
-        res
+                    self.tx.broadcast((timeline, event)).expect("TODO");
+                }
+                Ok(Async::Ready(None)) => (), // subscription cmd or msg for other namespace
+                Err(_err) => panic!("TODO"),
+            }
+        }
     }
 
     pub fn count_connections(&self) -> String {
@@ -166,14 +141,4 @@ impl Receiver {
             })
             .collect()
     }
-
-    pub fn queue_length(&self) -> String {
-        format!(
-            "Longest MessageQueue: {}",
-            self.msg_queues
-                .0
-                .values()
-                .fold(0, |acc, el| acc.max(el.messages.len()))
-        )
-    }
 }

src/redis_to_client_stream/redis/redis_connection/mod.rs

@@ -80,7 +80,7 @@ impl RedisConn {
         self.redis_input.clear();
 
         let (input, invalid_bytes) = str::from_utf8(&input)
-            .map(|input| (input, "".as_bytes()))
+            .map(|input| (input, &b""[..]))
             .unwrap_or_else(|e| {
                 let (valid, invalid) = input.split_at(e.valid_up_to());
                 (str::from_utf8(valid).expect("Guaranteed by ^^^^"), invalid)