1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
use std::{fmt, mem, sync::Arc};
use actix_web::rt;
use cadence::Timed;
use futures::channel::mpsc;
use uuid::Uuid;
use autoconnect_common::{
broadcast::{Broadcast, BroadcastSubs},
protocol::{ServerMessage, ServerNotification},
};
use autoconnect_settings::{AppState, Settings};
use autopush_common::{
db::User,
notification::Notification,
util::{ms_since_epoch, user_agent::UserAgentInfo},
};
use crate::error::{SMError, SMErrorKind};
mod on_client_msg;
mod on_server_notif;
/// A WebPush Client that's successfully identified itself to the server via a
/// Hello message.
///
/// The `webpush_ws` handler feeds input from both the WebSocket connection
/// (`ClientMessage`) and the `ClientRegistry` (`ServerNotification`)
/// triggered by autoendpoint to this type's `on_client_msg` and
/// `on_server_notif` methods whose impls reside in their own modules.
///
/// Note the `check_storage` method (in the `on_server_notif` module) is
/// triggered by both a `ServerNotification` and also the `new` constructor
pub struct WebPushClient {
/// Push User Agent identifier. Each Push client recieves a unique UAID
pub uaid: Uuid,
/// Unique, local (to each autoconnect instance) identifier
pub uid: Uuid,
/// The User Agent information block derived from the User-Agent header
pub ua_info: UserAgentInfo,
/// Broadcast Subscriptions this Client is subscribed to
broadcast_subs: BroadcastSubs,
/// Set of session specific flags
flags: ClientFlags,
/// Notification Ack(knowledgement) related state
ack_state: AckState,
/// Count of messages sent from storage (for enforcing
/// `settings.msg_limit`). Resets to 0 when storage is emptied
sent_from_storage: u32,
/// Exists for new User records: these are not written to the db during
/// Hello, instead they're lazily added to the db on their first Register
/// message
deferred_add_user: Option<User>,
/// WebPush Session Statistics
stats: SessionStatistics,
/// Timestamp of when the UA connected (used by database lookup, thus u64)
connected_at: u64,
/// Timestamp of the last WebPush Ping message
last_ping: u64,
/// The last notification timestamp.
// TODO: RENAME THIS TO `last_notification_timestamp`
current_timestamp: Option<u64>,
app_state: Arc<AppState>,
}
impl fmt::Debug for WebPushClient {
fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt.debug_struct("WebPushClient")
.field("uaid", &self.uaid)
.field("uid", &self.uid)
.field("ua_info", &self.ua_info)
.field("broadcast_subs", &self.broadcast_subs)
.field("flags", &self.flags)
.field("ack_state", &self.ack_state)
.field("sent_from_storage", &self.sent_from_storage)
.field("deferred_add_user", &self.deferred_add_user)
.field("stats", &self.stats)
.field("connected_at", &self.connected_at)
.field("last_ping", &self.last_ping)
.finish()
}
}
impl WebPushClient {
#[allow(clippy::too_many_arguments)]
pub async fn new(
uaid: Uuid,
ua: String,
broadcast_subs: BroadcastSubs,
flags: ClientFlags,
connected_at: u64,
current_timestamp: Option<u64>,
deferred_add_user: Option<User>,
app_state: Arc<AppState>,
) -> Result<(Self, Vec<ServerMessage>), SMError> {
trace!("👁🗨WebPushClient::new");
let stats = SessionStatistics {
existing_uaid: deferred_add_user.is_none(),
..Default::default()
};
let mut client = WebPushClient {
uaid,
uid: Uuid::new_v4(),
ua_info: UserAgentInfo::from(ua.as_str()),
broadcast_subs,
flags,
ack_state: Default::default(),
sent_from_storage: Default::default(),
connected_at,
current_timestamp,
deferred_add_user,
last_ping: Default::default(),
stats,
app_state,
};
let smsgs = if client.flags.check_storage {
let smsgs = client.check_storage().await?;
debug!(
"WebPushClient::new: check_storage smsgs.len(): {}",
smsgs.len()
);
smsgs
} else {
vec![]
};
Ok((client, smsgs))
}
/// Return a reference to `AppState`'s `Settings`
pub fn app_settings(&self) -> &Settings {
&self.app_state.settings
}
/// Connect this `WebPushClient` to the `ClientRegistry`
///
/// Returning a `Stream` of `ServerNotification`s from the `ClientRegistry`
pub async fn registry_connect(&self) -> mpsc::UnboundedReceiver<ServerNotification> {
self.app_state.clients.connect(self.uaid, self.uid).await
}
/// Disconnect this `WebPushClient` from the `ClientRegistry`
pub async fn registry_disconnect(&self) {
// Ignore disconnect (Client wasn't connected) Errors
let _ = self
.app_state
.clients
.disconnect(&self.uaid, &self.uid)
.await;
}
/// Return the difference between the Client's Broadcast Subscriptions and
/// the this server's Broadcasts
pub async fn broadcast_delta(&mut self) -> Option<Vec<Broadcast>> {
self.app_state
.broadcaster
.read()
.await
.change_count_delta(&mut self.broadcast_subs)
}
/// Cleanup after the session has ended
pub fn shutdown(&mut self, reason: Option<String>) {
trace!("👁🗨WebPushClient::shutdown");
self.save_and_notify_unacked_direct_notifs();
let ua_info = &self.ua_info;
let stats = &self.stats;
let elapsed_sec = (ms_since_epoch() - self.connected_at) / 1_000;
self.app_state
.metrics
.time_with_tags("ua.connection.lifespan", elapsed_sec)
.with_tag("ua_os_family", &ua_info.metrics_os)
.with_tag("ua_browser_family", &ua_info.metrics_browser)
.send();
// Log out the final stats message
info!("Session";
"uaid_hash" => self.uaid.as_simple().to_string(),
"uaid_reset" => self.flags.old_record_version,
"existing_uaid" => stats.existing_uaid,
"connection_type" => "webpush",
"ua_name" => &ua_info.browser_name,
"ua_os_family" => &ua_info.metrics_os,
"ua_os_ver" => &ua_info.os_version,
"ua_browser_family" => &ua_info.metrics_browser,
"ua_browser_ver" => &ua_info.browser_version,
"ua_category" => &ua_info.category,
"connection_time" => elapsed_sec,
"direct_acked" => stats.direct_acked,
"direct_storage" => stats.direct_storage,
"stored_retrieved" => stats.stored_retrieved,
"stored_acked" => stats.stored_acked,
"nacks" => stats.nacks,
"registers" => stats.registers,
"unregisters" => stats.unregisters,
"disconnect_reason" => reason.unwrap_or_else(|| "".to_owned()),
);
}
/// Save any Direct unAck'd messages to the db (on shutdown)
///
/// Direct messages are solely stored in memory until Ack'd by the Client,
/// so on shutdown, any not Ack'd are stored in the db to not be lost
fn save_and_notify_unacked_direct_notifs(&mut self) {
let mut notifs = mem::take(&mut self.ack_state.unacked_direct_notifs);
trace!(
"👁🗨WebPushClient::save_and_notify_unacked_direct_notifs len: {}",
notifs.len()
);
if notifs.is_empty() {
return;
}
self.stats.direct_storage += notifs.len() as i32;
// TODO: clarify this comment re the Python version
// Ensure we don't store these as legacy by setting a 0 as the
// sortkey_timestamp. This ensures the Python side doesn't mark it as
// legacy during conversion and still get the correct default us_time
// when saving
for notif in &mut notifs {
notif.sortkey_timestamp = Some(0);
}
let app_state = Arc::clone(&self.app_state);
let uaid = self.uaid;
let connected_at = self.connected_at;
rt::spawn(async move {
app_state.db.save_messages(&uaid, notifs).await?;
debug!("Finished saving unacked direct notifs, checking for reconnect");
let Some(user) = app_state.db.get_user(&uaid).await? else {
return Err(SMErrorKind::Internal(format!(
"User not found for unacked direct notifs: {uaid}"
)));
};
if connected_at == user.connected_at {
return Ok(());
}
if let Some(node_id) = user.node_id {
app_state
.http
.put(format!("{}/notif/{}", node_id, uaid.as_simple()))
.send()
.await?
.error_for_status()?;
}
Ok(())
});
}
/// Add User information and tags for this Client to a Sentry Event
pub fn add_sentry_info(self, event: &mut sentry::protocol::Event) {
event.user = Some(sentry::User {
id: Some(self.uaid.as_simple().to_string()),
..Default::default()
});
let ua_info = self.ua_info;
event
.tags
.insert("ua_name".to_owned(), ua_info.browser_name);
event
.tags
.insert("ua_os_family".to_owned(), ua_info.metrics_os);
event
.tags
.insert("ua_os_ver".to_owned(), ua_info.os_version);
event
.tags
.insert("ua_browser_family".to_owned(), ua_info.metrics_browser);
event
.tags
.insert("ua_browser_ver".to_owned(), ua_info.browser_version);
}
}
#[derive(Debug)]
pub struct ClientFlags {
/// Whether check_storage queries for topic (not "timestamped") messages
pub include_topic: bool,
/// Flags the need to increment the last read for timestamp for timestamped messages
pub increment_storage: bool,
/// Whether this client needs to check storage for messages
pub check_storage: bool,
/// Flags the need to drop the user record
pub old_record_version: bool,
/// First time a user has connected "today"
pub emit_channel_metrics: bool,
}
impl Default for ClientFlags {
fn default() -> Self {
Self {
include_topic: true,
increment_storage: false,
check_storage: false,
old_record_version: false,
emit_channel_metrics: false,
}
}
}
/// WebPush Session Statistics
///
/// Tracks statistics about the session that are logged when the session's
/// closed
#[derive(Debug, Default)]
pub struct SessionStatistics {
/// Number of acknowledged messages that were sent directly (not via storage)
direct_acked: i32,
/// Number of messages sent to storage
direct_storage: i32,
/// Number of messages taken from storage
stored_retrieved: i32,
/// Number of message pulled from storage and acknowledged
stored_acked: i32,
/// Number of messages total that are not acknowledged.
nacks: i32,
/// Number of unregister requests
unregisters: i32,
/// Number of register requests
registers: i32,
/// Whether this uaid was previously registered
existing_uaid: bool,
}
/// Record of Notifications sent to the Client.
#[derive(Debug, Default)]
struct AckState {
/// List of unAck'd directly sent (never stored) notifications
unacked_direct_notifs: Vec<Notification>,
/// List of unAck'd sent notifications from storage
unacked_stored_notifs: Vec<Notification>,
/// Either the `current_timestamp` value in storage (returned from
/// `fetch_messages`) or the last unAck'd timestamp Message's
/// `sortkey_timestamp` (returned from `fetch_timestamp_messages`).
///
/// This represents the "pointer" to the beginning (more specifically the
/// record preceeding the beginning used in a Greater Than query) of the
/// next batch of timestamp Messages.
///
/// Thus this value is:
///
/// a) initially None, then
///
/// b) retrieved from `current_timestamp` in storage then passed as the
/// `timestamp` to `fetch_timestamp_messages`. When all of those timestamp
/// Messages are Ack'd, this value's then
///
/// c) written back to `current_timestamp` in storage via
/// `increment_storage`
unacked_stored_highest: Option<u64>,
}
impl AckState {
/// Whether the Client has outstanding notifications sent to it that it has
/// yet to Ack
fn unacked_notifs(&self) -> bool {
!self.unacked_stored_notifs.is_empty() || !self.unacked_direct_notifs.is_empty()
}
}
#[cfg(test)]
mod tests {
use std::sync::Arc;
use uuid::Uuid;
use autoconnect_common::{
protocol::{ClientMessage, ServerMessage, ServerNotification},
test_support::{DUMMY_CHID, DUMMY_UAID, UA},
};
use autoconnect_settings::AppState;
use autopush_common::{
db::{client::FetchMessageResponse, mock::MockDbClient},
notification::Notification,
util::{ms_since_epoch, sec_since_epoch},
};
use super::WebPushClient;
async fn wpclient(uaid: Uuid, app_state: AppState) -> (WebPushClient, Vec<ServerMessage>) {
WebPushClient::new(
uaid,
UA.to_owned(),
Default::default(),
Default::default(),
ms_since_epoch(),
None,
None,
Arc::new(app_state),
)
.await
.unwrap()
}
/// Generate a dummy timestamp `Notification`
fn new_timestamp_notif(channel_id: &Uuid, ttl: u64) -> Notification {
Notification {
channel_id: *channel_id,
ttl,
timestamp: sec_since_epoch(),
sortkey_timestamp: Some(ms_since_epoch()),
..Default::default()
}
}
#[actix_rt::test]
async fn webpush_ping() {
let (mut client, _) = wpclient(DUMMY_UAID, Default::default()).await;
let pong = client.on_client_msg(ClientMessage::Ping).await.unwrap();
assert!(matches!(pong.as_slice(), [ServerMessage::Ping]));
}
#[actix_rt::test]
async fn expired_increments_storage() {
let mut db = MockDbClient::new();
let mut seq = mockall::Sequence::new();
let timestamp = sec_since_epoch();
// No topic messages
db.expect_fetch_topic_messages()
.times(1)
.in_sequence(&mut seq)
.return_once(move |_, _| {
Ok(FetchMessageResponse {
timestamp: None,
messages: vec![],
})
});
// Return expired notifs (default ttl of 0)
db.expect_fetch_timestamp_messages()
.times(1)
.in_sequence(&mut seq)
.withf(move |_, ts, _| ts.is_none())
.return_once(move |_, _, _| {
Ok(FetchMessageResponse {
timestamp: Some(timestamp),
messages: vec![
new_timestamp_notif(&DUMMY_CHID, 0),
new_timestamp_notif(&DUMMY_CHID, 0),
],
})
});
// EOF
db.expect_fetch_timestamp_messages()
.times(1)
.in_sequence(&mut seq)
.withf(move |_, ts, _| ts == &Some(timestamp))
.return_once(|_, _, _| {
Ok(FetchMessageResponse {
timestamp: None,
messages: vec![],
})
});
// Ensure increment_storage's called to advance the timestamp messages
// despite check_storage returning nothing (all filtered out as
// expired)
db.expect_increment_storage()
.times(1)
.in_sequence(&mut seq)
.withf(move |_, ts| ts == ×tamp)
.return_once(|_, _| Ok(()));
// No check_storage called here (via default ClientFlags)
let (mut client, _) = wpclient(
DUMMY_UAID,
AppState {
db: db.into_boxed_arc(),
..Default::default()
},
)
.await;
let smsgs = client
.on_server_notif(ServerNotification::CheckStorage)
.await
.expect("CheckStorage failed");
assert!(smsgs.is_empty())
}
}