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
// Copyright 2020 - developers of the `grammers` project.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
//! Methods to deal with and offer access to updates.
use super::Client;
use crate::types::{ChatMap, Update};
use futures_util::future::{select, Either};
pub use grammers_mtsender::{AuthorizationError, InvocationError};
use grammers_session::channel_id;
pub use grammers_session::{PrematureEndReason, UpdateState};
use grammers_tl_types as tl;
use log::warn;
use std::pin::pin;
use std::sync::Arc;
use std::time::{Duration, Instant};
use tokio::time::sleep_until;
/// How long to wait after warning the user that the updates limit was exceeded.
const UPDATE_LIMIT_EXCEEDED_LOG_COOLDOWN: Duration = Duration::from_secs(300);
impl Client {
/// Returns the next update from the buffer where they are queued until used.
///
/// Similar using an iterator manually, this method will return `Some` until no more updates
/// are available (e.g. a graceful disconnection occurred).
///
/// # Examples
///
/// ```
/// # async fn f(client: grammers_client::Client) -> Result<(), Box<dyn std::error::Error>> {
/// use grammers_client::Update;
///
/// while let Some(update) = client.next_update().await? {
/// // Echo incoming messages and ignore everything else
/// match update {
/// Update::NewMessage(mut message) if !message.outgoing() => {
/// message.respond(message.text()).await?;
/// }
/// _ => {}
/// }
/// }
/// # Ok(())
/// # }
/// ```
pub async fn next_update(&self) -> Result<Option<Update>, InvocationError> {
loop {
let (deadline, get_diff, get_channel_diff) = {
let state = &mut *self.0.state.write().unwrap();
if let Some(updates) = state.updates.pop_front() {
return Ok(Some(updates));
}
(
state.message_box.check_deadlines(), // first, as it might trigger differences
state.message_box.get_difference(),
state.message_box.get_channel_difference(&state.chat_hashes),
)
};
if let Some(request) = get_diff {
let response = self.invoke(&request).await?;
let (updates, users, chats) = {
let state = &mut *self.0.state.write().unwrap();
state
.message_box
.apply_difference(response, &mut state.chat_hashes)
};
self.extend_update_queue(updates, ChatMap::new(users, chats));
continue;
}
if let Some(request) = get_channel_diff {
let maybe_response = self.invoke(&request).await;
let response = match maybe_response {
Ok(r) => r,
Err(e) if e.is("PERSISTENT_TIMESTAMP_OUTDATED") => {
// According to Telegram's docs:
// "Channel internal replication issues, try again later (treat this like an RPC_CALL_FAIL)."
// We can treat this as "empty difference" and not update the local pts.
// Then this same call will be retried when another gap is detected or timeout expires.
//
// Another option would be to literally treat this like an RPC_CALL_FAIL and retry after a few
// seconds, but if Telegram is having issues it's probably best to wait for it to send another
// update (hinting it may be okay now) and retry then.
//
// This is a bit hacky because MessageBox doesn't really have a way to "not update" the pts.
// Instead we manually extract the previously-known pts and use that.
log::warn!("Getting difference for channel updates caused PersistentTimestampOutdated; ending getting difference prematurely until server issues are resolved");
{
self.0
.state
.write()
.unwrap()
.message_box
.end_channel_difference(
&request,
PrematureEndReason::TemporaryServerIssues,
);
}
continue;
}
Err(e) if e.is("CHANNEL_PRIVATE") => {
log::info!(
"Account is now banned in {} so we can no longer fetch updates from it",
channel_id(&request)
.map(|i| i.to_string())
.unwrap_or_else(|| "empty channel".into())
);
{
self.0
.state
.write()
.unwrap()
.message_box
.end_channel_difference(&request, PrematureEndReason::Banned);
}
continue;
}
Err(InvocationError::Rpc(rpc_error)) if rpc_error.code == 500 => {
log::warn!("Telegram is having internal issues: {:#?}", rpc_error);
{
self.0
.state
.write()
.unwrap()
.message_box
.end_channel_difference(
&request,
PrematureEndReason::TemporaryServerIssues,
);
}
continue;
}
Err(e) => return Err(e),
};
let (updates, users, chats) = {
let state = &mut *self.0.state.write().unwrap();
state.message_box.apply_channel_difference(
request,
response,
&mut state.chat_hashes,
)
};
self.extend_update_queue(updates, ChatMap::new(users, chats));
continue;
}
let step = {
let sleep = pin!(async { sleep_until(deadline.into()).await });
let step = pin!(async { self.step().await });
match select(sleep, step).await {
Either::Left(_) => None,
Either::Right((step, _)) => Some(step),
}
};
if let Some(step) = step {
step?;
}
}
}
pub(crate) fn process_socket_updates(&self, all_updates: Vec<tl::enums::Updates>) {
if all_updates.is_empty() {
return;
}
let mut result = Option::<(Vec<_>, Vec<_>, Vec<_>)>::None;
{
let state = &mut *self.0.state.write().unwrap();
for updates in all_updates {
if state
.message_box
.ensure_known_peer_hashes(&updates, &mut state.chat_hashes)
.is_err()
{
continue;
}
match state
.message_box
.process_updates(updates, &state.chat_hashes)
{
Ok(tup) => {
if let Some(res) = result.as_mut() {
res.0.extend(tup.0);
res.1.extend(tup.1);
res.2.extend(tup.2);
} else {
result = Some(tup);
}
}
Err(_) => return,
}
}
}
if let Some((updates, users, chats)) = result {
self.extend_update_queue(updates, ChatMap::new(users, chats));
}
}
fn extend_update_queue(&self, mut updates: Vec<tl::enums::Update>, chat_map: Arc<ChatMap>) {
let mut state = self.0.state.write().unwrap();
if let Some(limit) = self.0.config.params.update_queue_limit {
if let Some(exceeds) = (state.updates.len() + updates.len()).checked_sub(limit + 1) {
let exceeds = exceeds + 1;
let now = Instant::now();
let notify = match state.last_update_limit_warn {
None => true,
Some(instant) => now - instant > UPDATE_LIMIT_EXCEEDED_LOG_COOLDOWN,
};
updates.truncate(updates.len() - exceeds);
if notify {
warn!(
"{} updates were dropped because the update_queue_limit was exceeded",
exceeds
);
}
state.last_update_limit_warn = Some(now);
}
}
state.updates.extend(
updates
.into_iter()
.flat_map(|u| Update::new(self, u, &chat_map)),
);
}
/// Synchronize the updates state to the session.
pub fn sync_update_state(&self) {
let state = self.0.state.read().unwrap();
self.0
.config
.session
.set_state(state.message_box.session_state());
}
}
#[cfg(test)]
mod tests {
use super::*;
use core::future::Future;
fn get_client() -> Client {
panic!()
}
#[test]
fn ensure_next_update_future_impls_send() {
if false {
// We just want it to type-check, not actually run.
fn typeck(_: impl Future + Send) {}
typeck(get_client().next_update());
}
}
}