From 123c550c6ceec6c2bd5944c7f2f56f27390b051b Mon Sep 17 00:00:00 2001 From: Maybe Waffle Date: Mon, 18 Jul 2022 15:56:25 +0400 Subject: [PATCH 01/26] Add a test for `discussion_648` Former-commit-id: 56f8ef90ecd9405ab6aa1e900652ec1ad1676137 --- src/dispatching/handler_description.rs | 34 ++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/src/dispatching/handler_description.rs b/src/dispatching/handler_description.rs index cf3b4e4f..5ee6cffa 100644 --- a/src/dispatching/handler_description.rs +++ b/src/dispatching/handler_description.rs @@ -59,3 +59,37 @@ impl HandlerDescription for DpHandlerDescription { Self { allowed: self.allowed.merge_branch(&other.allowed) } } } +#[cfg(test)] +mod tests { + use crate::{ + dispatching::{HandlerExt, UpdateFilterExt}, + types::{AllowedUpdate::*, Update}, + utils::command::BotCommands, + }; + + use crate as teloxide; // fixup for the `BotCommands` macro + + #[derive(BotCommands, Clone)] + #[command(rename = "lowercase")] + enum Cmd { + B, + } + + // + #[test] + fn discussion_648() { + let h = + dptree::entry().branch(Update::filter_my_chat_member().endpoint(|| async {})).branch( + Update::filter_message() + .branch(dptree::entry().filter_command::().endpoint(|| async {})) + .endpoint(|| async {}), + ); + + let mut v = h.description().allowed_updates(); + + // Hash set randomizes element order, so to compare we need to sort + v.sort_by_key(|&a| a as u8); + + assert_eq!(v, [Message, MyChatMember]) + } +} From f6e7c01a45948c3561d2efc6e2413888c737b214 Mon Sep 17 00:00:00 2001 From: Maybe Waffle Date: Mon, 18 Jul 2022 15:56:45 +0400 Subject: [PATCH 02/26] Update dptree Former-commit-id: eb8b384f464df974c9c9d144c3374d18e2f60c43 --- Cargo.toml | 3 +- src/dispatching/handler_description.rs | 66 ++++++++++++++++---------- 2 files changed, 43 insertions(+), 26 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 5dfc708b..d3226640 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -64,7 +64,8 @@ teloxide-macros = { version = "0.6.2", optional = true } serde_json = "1.0" serde = { version = "1.0", features = ["derive"] } -dptree = "0.2.1" +#dptree = "0.2.1" +dptree = { git = "https://github.com/teloxide/dptree.git", rev = "df578e4" } tokio = { version = "1.8", features = ["fs"] } tokio-util = "0.6" diff --git a/src/dispatching/handler_description.rs b/src/dispatching/handler_description.rs index 5ee6cffa..3ed2f621 100644 --- a/src/dispatching/handler_description.rs +++ b/src/dispatching/handler_description.rs @@ -1,44 +1,27 @@ use std::collections::HashSet; -use dptree::{description::EventKind, HandlerDescription}; +use dptree::{ + description::{EventKind, InterestSet}, + HandlerDescription, +}; use teloxide_core::types::AllowedUpdate; /// Handler description that is used by [`Dispatcher`]. /// /// [`Dispatcher`]: crate::dispatching::Dispatcher pub struct DpHandlerDescription { - allowed: EventKind, + allowed: InterestSet, } impl DpHandlerDescription { pub(crate) fn of(allowed: AllowedUpdate) -> Self { let mut set = HashSet::with_capacity(1); - set.insert(allowed); - Self { allowed: EventKind::InterestList(set) } + set.insert(Kind(allowed)); + Self { allowed: InterestSet::new_filter(set) } } pub(crate) fn allowed_updates(&self) -> Vec { - use AllowedUpdate::*; - - match &self.allowed { - EventKind::InterestList(set) => set.iter().copied().collect(), - EventKind::Entry => panic!("No updates were allowed"), - EventKind::UserDefined => vec![ - Message, - EditedMessage, - ChannelPost, - EditedChannelPost, - InlineQuery, - ChosenInlineResult, - CallbackQuery, - ShippingQuery, - PreCheckoutQuery, - Poll, - PollAnswer, - MyChatMember, - ChatMember, - ], - } + self.allowed.observed.iter().map(|Kind(x)| x).copied().collect() } } @@ -59,6 +42,39 @@ impl HandlerDescription for DpHandlerDescription { Self { allowed: self.allowed.merge_branch(&other.allowed) } } } + +#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)] +struct Kind(AllowedUpdate); + +impl EventKind for Kind { + fn full_set() -> HashSet { + use AllowedUpdate::*; + + [ + Message, + EditedMessage, + ChannelPost, + EditedChannelPost, + InlineQuery, + ChosenInlineResult, + CallbackQuery, + ShippingQuery, + PreCheckoutQuery, + Poll, + PollAnswer, + MyChatMember, + ChatMember, + ] + .into_iter() + .map(Kind) + .collect() + } + + fn empty_set() -> HashSet { + HashSet::new() + } +} + #[cfg(test)] mod tests { use crate::{ From cc74e7517d8ba1f182c7008b0d3be458f08739f9 Mon Sep 17 00:00:00 2001 From: Maybe Waffle Date: Tue, 19 Jul 2022 14:30:18 +0400 Subject: [PATCH 03/26] Update deps Former-commit-id: ed88e43afa87842e52b42f688c8ab94875809494 --- Cargo.toml | 20 +++++++++---------- .../update_listeners/webhooks/axum.rs | 2 +- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index d3226640..d5786657 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -57,18 +57,18 @@ full = [ ] [dependencies] -#teloxide-core = { version = "0.6.0", default-features = false } -teloxide-core = { git = "https://github.com/teloxide/teloxide-core", rev = "b13393d", default-features = false } +teloxide-core = { version = "0.7.0", default-features = false } +#teloxide-core = { git = "https://github.com/teloxide/teloxide-core", rev = "b13393d", default-features = false } teloxide-macros = { version = "0.6.2", optional = true } serde_json = "1.0" serde = { version = "1.0", features = ["derive"] } -#dptree = "0.2.1" -dptree = { git = "https://github.com/teloxide/dptree.git", rev = "df578e4" } +dptree = "0.3.0" +#dptree = { git = "https://github.com/teloxide/dptree.git", rev = "df578e4" } tokio = { version = "1.8", features = ["fs"] } -tokio-util = "0.6" +tokio-util = "0.7" tokio-stream = "0.1.8" url = "2.2.2" @@ -83,17 +83,17 @@ pin-project = "1.0" serde_with_macros = "1.4" aquamarine = "0.1.11" -sqlx = { version = "0.5", optional = true, default-features = false, features = [ +sqlx = { version = "0.6", optional = true, default-features = false, features = [ "runtime-tokio-native-tls", "macros", "sqlite", ] } -redis = { version = "0.20", features = ["tokio-comp"], optional = true } +redis = { version = "0.21", features = ["tokio-comp"], optional = true } serde_cbor = { version = "0.11", optional = true } bincode = { version = "1.3", optional = true } -axum = { version = "0.4.8", optional = true } +axum = { version = "0.5.13", optional = true } tower = { version = "0.4.12", optional = true } -tower-http = { version = "0.2.5", features = ["trace"], optional = true } +tower-http = { version = "0.3.4", features = ["trace"], optional = true } rand = { version = "0.8.5", optional = true } [dev-dependencies] @@ -102,7 +102,7 @@ pretty_env_logger = "0.4.0" serde = "1" serde_json = "1" tokio = { version = "1.8", features = ["fs", "rt-multi-thread", "macros"] } -reqwest = "0.10.4" +reqwest = "0.11.11" chrono = "0.4" tokio-stream = "0.1" diff --git a/src/dispatching/update_listeners/webhooks/axum.rs b/src/dispatching/update_listeners/webhooks/axum.rs index ab08cd92..6c16bdf0 100644 --- a/src/dispatching/update_listeners/webhooks/axum.rs +++ b/src/dispatching/update_listeners/webhooks/axum.rs @@ -272,7 +272,7 @@ impl FromRequest for XTelegramBotApiSecretToken { let res = req .headers_mut() - .and_then(|map| map.remove("x-telegram-bot-api-secret-token")) + .remove("x-telegram-bot-api-secret-token") .map(|header| { check_secret(header.as_bytes()) .map(<_>::to_owned) From a7eff7192b33dcaf4afb2920022507b7e54d466b Mon Sep 17 00:00:00 2001 From: Maybe Waffle Date: Tue, 19 Jul 2022 14:49:15 +0400 Subject: [PATCH 04/26] bump version Former-commit-id: 6996c7ff87a964efdfd5ee1649d2f89e535495af --- CHANGELOG.md | 3 +++ Cargo.toml | 2 +- MIGRATION_GUIDE.md | 41 ++++++++++++++++++++++++++++++++++++++++- README.md | 6 ++---- 4 files changed, 46 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 67ef18dd..4fe36a67 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Add the `Key: Clone` requirement for `impl Dispatcher` [**BC**]. - `dispatching::update_listeners::{polling_default, polling}` now return a named, `Polling<_>` type + - Update teloxide-core to v0.7.0 with Bot API 6.1 support, see [its changelog][core07c] for more [**BC**] + +[core07c]: https://github.com/teloxide/teloxide-core/blob/master/CHANGELOG.md#070---2022-07-19 ### Deprecated diff --git a/Cargo.toml b/Cargo.toml index d5786657..aa08091a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "teloxide" -version = "0.9.2" +version = "0.10.0" edition = "2021" description = "An elegant Telegram bots framework for Rust" repository = "https://github.com/teloxide/teloxide" diff --git a/MIGRATION_GUIDE.md b/MIGRATION_GUIDE.md index 315cd9f1..dd1af6eb 100644 --- a/MIGRATION_GUIDE.md +++ b/MIGRATION_GUIDE.md @@ -1,6 +1,45 @@ This document describes breaking changes of `teloxide` crate, as well as the ways to update code. Note that the list of required changes is not fully exhaustive and it may lack something in rare cases. +## 0.9 -> 0.10 + +### core + +We've added some convenience functions to `InlineKeyboardButton` so it's easier to construct it. Consider using them instead of variants: +```diff +-InlineKeyboardButton::new("text", InlineKeyboardButtonKind::Url(url)) ++InlineKeyboardButton::url("text", url) +``` + +`file_size` fields are now `u32`, you may need to update your code accordingly: + +```diff +-let file_size: u64 = audio.file_size?; ++let file_size: u32 = audio.file_size; +``` + +Some places now use `FileMeta` instead of `File`, you may need to change types. + +`Sticker` and `StickerSet` now has a `kind` field instead of `is_animated` and `is_video`: + +```diff ++use teloxide::types::StickerKind::*; +-match () { ++match sticker.kind { +- _ if sticker.is_animated => /* handle animated */, ++ Animated => /* handle animated */, +- _ if sticker.is_video => /* handle video */, ++ Video => /* handle video */, +- _ => /* handle normal */, ++ Webp => /* handle normal */, +} +``` + +### teloxide + +Teloxide itself doesn't have any major API changes. +Note however that `dispatching::update_listeners::polling` function was deprecated, use `polling_builder` instead. + ## 0.7 -> 0.8 ### core @@ -8,7 +47,7 @@ Note that the list of required changes is not fully exhaustive and it may lack s `user.id` now uses `UserId` type, `ChatId` now represents only _chat id_, not channel username, all `chat_id` function parameters now accept `Recipient` (if they allow for channel usernames). If you used to work with chat/user ids (for example saving them to a database), you may need to change your code to account for new types. Some examples how that may look like: -```diff, +```diff -let user_id: i64 = user.id; +let UserId(user_id) = user.id; db.save(user_id, ...); diff --git a/README.md b/README.md index 8a5e386d..7e849ec7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,4 @@ -> [v0.7 -> v0.8 migration guide >>](MIGRATION_GUIDE.md#07---08) - -> `teloxide-core` versions less that `0.4.5` (`teloxide` versions less than 0.7.3) have a low-severity security vulnerability, [learn more >>](https://github.com/teloxide/teloxide/discussions/574) +> [v0.9 -> v0.10 migration guide >>](MIGRATION_GUIDE.md#09---010)
@@ -72,7 +70,7 @@ $ rustup override set nightly 5. Run `cargo new my_bot`, enter the directory and put these lines into your `Cargo.toml`: ```toml [dependencies] -teloxide = { version = "0.9", features = ["macros", "auto-send"] } +teloxide = { version = "0.10", features = ["macros", "auto-send"] } log = "0.4" pretty_env_logger = "0.4" tokio = { version = "1.8", features = ["rt-multi-thread", "macros"] } From 1b2b1ee30ceebb599d3c7f8d7c4a9c56e58cc003 Mon Sep 17 00:00:00 2001 From: Maybe Waffle Date: Tue, 19 Jul 2022 14:51:25 +0400 Subject: [PATCH 05/26] update faq Former-commit-id: 4af32d21ebe1198b8481ea64c7274498b3618a2b --- README.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index 7e849ec7..b8bb377c 100644 --- a/README.md +++ b/README.md @@ -319,11 +319,7 @@ A: No, only the bots API. **Q: Can I use webhooks?** -A: teloxide doesn't provide a special API for working with webhooks due to their nature with lots of subtle settings. Instead, you should setup your webhook by yourself, as shown in [`examples/ngrok_ping_pong_bot`](examples/ngrok_ping_pong.rs) and [`examples/heroku_ping_pong_bot`](examples/heroku_ping_pong.rs). - -Associated links: - - [Marvin's Marvellous Guide to All Things Webhook](https://core.telegram.org/bots/webhooks) - - [Using self-signed certificates](https://core.telegram.org/bots/self-signed) +A: You can! Teloxide has a built-in support for webhooks in `dispatching::update_listeners::webhooks` module. See how it's used in [`examples/ngrok_ping_pong_bot`](examples/ngrok_ping_pong.rs) and [`examples/heroku_ping_pong_bot`](examples/heroku_ping_pong.rs) **Q: Can I handle both callback queries and messages within a single dialogue?** From 4262175be24b096c65f1d192cf07e57aa620b0c4 Mon Sep 17 00:00:00 2001 From: Hirrolot Date: Tue, 19 Jul 2022 19:34:14 +0600 Subject: [PATCH 06/26] Remove commented dependencies in `Cargo.toml` Former-commit-id: ce40f04ebd9bc0505e4c7e06cba1e43e39b61f11 --- Cargo.toml | 2 -- 1 file changed, 2 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index aa08091a..9c702774 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -58,14 +58,12 @@ full = [ [dependencies] teloxide-core = { version = "0.7.0", default-features = false } -#teloxide-core = { git = "https://github.com/teloxide/teloxide-core", rev = "b13393d", default-features = false } teloxide-macros = { version = "0.6.2", optional = true } serde_json = "1.0" serde = { version = "1.0", features = ["derive"] } dptree = "0.3.0" -#dptree = { git = "https://github.com/teloxide/dptree.git", rev = "df578e4" } tokio = { version = "1.8", features = ["fs"] } tokio-util = "0.7" From 411c851a2f2e0ed8a90cbbc055e137831f3fbed5 Mon Sep 17 00:00:00 2001 From: Hirrolot Date: Tue, 19 Jul 2022 19:34:35 +0600 Subject: [PATCH 07/26] Update the dispatching example explanation Former-commit-id: bc8b86181fd6e39f01a66627a767effcbb9b8e8d --- examples/purchase.rs | 9 +- src/dispatching.rs | 213 ++++++++++++++++++++++++++---------- src/dispatching/dialogue.rs | 24 ++-- 3 files changed, 172 insertions(+), 74 deletions(-) diff --git a/examples/purchase.rs b/examples/purchase.rs index 74a0cd6d..cbe4bfe6 100644 --- a/examples/purchase.rs +++ b/examples/purchase.rs @@ -13,10 +13,7 @@ // ``` use teloxide::{ - dispatching::{ - dialogue::{self, InMemStorage}, - UpdateHandler, - }, + dispatching::{dialogue::InMemStorage, UpdateHandler}, prelude::*, types::{InlineKeyboardButton, InlineKeyboardMarkup}, utils::command::BotCommands, @@ -75,12 +72,12 @@ fn schema() -> UpdateHandler> .branch(dptree::case![State::ReceiveFullName].endpoint(receive_full_name)) .branch(dptree::endpoint(invalid_state)); - let callback_query_handler = Update::filter_callback_query().chain( + let callback_query_handler = Update::filter_callback_query().branch( dptree::case![State::ReceiveProductChoice { full_name }] .endpoint(receive_product_selection), ); - dialogue::enter::, State, _>() + teloxide::dispatching::dialogue::enter::, State, _>() .branch(message_handler) .branch(callback_query_handler) } diff --git a/src/dispatching.rs b/src/dispatching.rs index 1c093048..042870e8 100644 --- a/src/dispatching.rs +++ b/src/dispatching.rs @@ -1,76 +1,175 @@ //! An update dispatching model based on [`dptree`]. //! -//! In teloxide, updates are dispatched by a pipeline. The central type is -//! [`dptree::Handler`] -- it represents a handler of an update; since the API -//! is highly declarative, you can combine handlers with each other via such -//! methods as [`dptree::Handler::chain`] and [`dptree::Handler::branch`]. The -//! former method pipes one handler to another one, whilst the latter creates a -//! new node, as communicated by the name. For more information, please refer to -//! the documentation of [`dptree`]. +//! In teloxide, update dispatching is declarative: it takes the form of a +//! [chain of responsibility] pattern enriched with a number of combinator +//! functions, which together form an instance of the [`dptree::Handler`] type. //! -//! The pattern itself is called [chain of responsibility], a well-known design -//! technique across OOP developers. But unlike typical object-oriented design, -//! we employ declarative FP-style functions like [`dptree::filter`], -//! [`dptree::filter_map`], and [`dptree::endpoint`]; these functions create -//! special forms of [`dptree::Handler`]; for more information, please refer to -//! their respective documentation. Each of these higher-order functions accept -//! a closure that is made into a handler -- this closure can take any -//! additional parameters, which must be supplied while creating [`Dispatcher`] -//! (see [`DispatcherBuilder::dependencies`]). -//! -//! The [`Dispatcher`] type puts all these things together: it only provides -//! [`Dispatcher::dispatch`] and a handful of other methods. Once you call -//! `.dispatch()`, it will retrieve updates from the Telegram server and pass -//! them to your handler, which is a parameter of [`Dispatcher::builder`]. -//! -//! Let us look at a simple example: -//! -//! -//! ([Full](https://github.com/teloxide/teloxide/blob/master/examples/shared_state.rs)) +//! Let us look at this simple example: //! +//! [[`examples/purchase.rs`](https://github.com/teloxide/teloxide/blob/master/examples/purchase.rs)] //! ```no_run -//! // TODO: examples/purchase.rs -//! fn main() {} +//! // Imports omitted... +//! # use teloxide::{ +//! # dispatching::{dialogue::InMemStorage, UpdateHandler}, +//! # prelude::*, +//! # types::{InlineKeyboardButton, InlineKeyboardMarkup}, +//! # utils::command::BotCommands, +//! # }; +//! +//! type MyDialogue = Dialogue>; +//! type HandlerResult = Result<(), Box>; +//! +//! #[derive(Clone, Default)] +//! pub enum State { +//! #[default] +//! Start, +//! ReceiveFullName, +//! ReceiveProductChoice { +//! full_name: String, +//! }, +//! } +//! +//! #[derive(BotCommands, Clone)] +//! #[command(rename = "lowercase", description = "These commands are supported:")] +//! enum Command { +//! #[command(description = "display this text.")] +//! Help, +//! #[command(description = "start the purchase procedure.")] +//! Start, +//! #[command(description = "cancel the purchase procedure.")] +//! Cancel, +//! } +//! +//! #[tokio::main] +//! async fn main() { +//! // Setup is omitted... +//! # pretty_env_logger::init(); +//! # log::info!("Starting purchase bot..."); +//! # +//! # let bot = Bot::from_env().auto_send(); +//! # +//! # Dispatcher::builder(bot, schema()) +//! # .dependencies(dptree::deps![InMemStorage::::new()]) +//! # .build() +//! # .setup_ctrlc_handler() +//! # .dispatch() +//! # .await; +//! } +//! +//! fn schema() -> UpdateHandler> { +//! let command_handler = teloxide::filter_command::() +//! .branch( +//! dptree::case![State::Start] +//! .branch(dptree::case![Command::Help].endpoint(help)) +//! .branch(dptree::case![Command::Start].endpoint(start)), +//! ) +//! .branch(dptree::case![Command::Cancel].endpoint(cancel)); +//! +//! let message_handler = Update::filter_message() +//! .branch(command_handler) +//! .branch(dptree::case![State::ReceiveFullName].endpoint(receive_full_name)) +//! .branch(dptree::endpoint(invalid_state)); +//! +//! let callback_query_handler = Update::filter_callback_query().branch( +//! dptree::case![State::ReceiveProductChoice { full_name }] +//! .endpoint(receive_product_selection), +//! ); +//! +//! teloxide::dispatching::dialogue::enter::, State, _>() +//! .branch(message_handler) +//! .branch(callback_query_handler) +//! } +//! +//! // Handler definitions omitted... +//! +//! async fn start(bot: AutoSend, msg: Message, dialogue: MyDialogue) -> HandlerResult { +//! todo!() +//! } +//! +//! async fn help(bot: AutoSend, msg: Message) -> HandlerResult { +//! todo!() +//! } +//! +//! async fn cancel(bot: AutoSend, msg: Message, dialogue: MyDialogue) -> HandlerResult { +//! todo!() +//! } +//! +//! async fn invalid_state(bot: AutoSend, msg: Message) -> HandlerResult { +//! todo!() +//! } +//! +//! async fn receive_full_name( +//! bot: AutoSend, +//! msg: Message, +//! dialogue: MyDialogue, +//! ) -> HandlerResult { +//! todo!() +//! } +//! +//! async fn receive_product_selection( +//! bot: AutoSend, +//! q: CallbackQuery, +//! dialogue: MyDialogue, +//! full_name: String, +//! ) -> HandlerResult { +//! todo!() +//! } //! ``` //! -//! 1. First, we create the bot: `let bot = Bot::from_env().auto_send()`. -//! 2. Then we construct an update handler. While it is possible to handle all -//! kinds of [`crate::types::Update`], here we are only interested in -//! [`crate::types::Message`]: [`UpdateFilterExt::filter_message`] create a -//! handler object which filters all messages out of a generic update. -//! 3. By doing `.endpoint(...)` we set up a custom handling closure that -//! receives `msg: Message` and `bot: AutoSend`. There are -//! called dependencies: `msg` is supplied by -//! [`UpdateFilterExt::filter_message`], while `bot` is supplied by -//! [`Dispatcher`]. +//! The above code shows how to dispatch on different combinations of a state +//! and command _elegantly_. We give a top-bottom explanation of the function +//! `schema`, which constructs the main update handler: //! -//! That being said, if we receive a message, the dispatcher will call our -//! handler, but if we receive something other than a message (e.g., a channel -//! post), you will see an unhandled update notice in your terminal. +//! - We call the [`dialogue::enter`] function to initiate dialogue +//! interaction. Then we call [`dptree::Handler::branch`] two times to form a +//! tree of responsibility of `message_handler` and `callback_query_handler`. +//! - Inside `message_handler`, we use [`Update::filter_message`] as a filter +//! for incoming messages. Then we create a tree of responsibility again, +//! consisting of three branches with a similar structure. +//! - Inside `callback_query_handler`, we use +//! [`Update::filter_callback_query`] as a filter and create one branch for +//! handling product selection. //! -//! This is a very limited example of update pipelining facilities. In more -//! involved scenarios, there are multiple branches and chains; if one element -//! of a chain fails to handle an update, the update will be passed forwards; if -//! no handler succeeds at handling the update, [`Dispatcher`] will invoke a -//! default handler set up via [`DispatcherBuilder::default_handler`]. +//! `a.branch(b)` roughly means "try to handle an update with `a`, then, if it +//! fails, try `b`". We use branching multiple times here, which is a natural +//! pattern for describing dispatching logic. We also use the [`dptree::case!`] +//! macro extensively, which acts as a filter on an enumeration: if it is of a +//! certain variant, it passes the variant's payload down the handler chain; +//! otherwise, it neglects an update. Note how we utilise this macro both for +//! `State` and `Command` in the same way! //! -//! Update pipelining provides several advantages over the typical `match -//! (update.kind) { ... }` approach: +//! Finally, we plug the schema into [`Dispatcher`] like this: //! -//! 1. It supports _extension_: e.g., you -//! can define extension filters or some other handlers and then combine them in -//! a single place, thus facilitating loose coupling. -//! 2. Pipelining exhibits a natural syntax for expressing message processing. -//! 3. Lastly, it provides a primitive form of [dependency injection (DI)], -//! which allows you to deal with such objects as a bot and various update types -//! easily. +//! ```no_run +//! # #[tokio::main] +//! # async fn main() { +//! let bot = Bot::from_env().auto_send(); //! -//! For a more involved example, see [`examples/dispatching_features.rs`](https://github.com/teloxide/teloxide/blob/master/examples/dispatching_features.rs). +//! Dispatcher::builder(bot, schema()) +//! .dependencies(dptree::deps![InMemStorage::::new()]) +//! .build() +//! .setup_ctrlc_handler() +//! .dispatch() +//! .await; +//! # } +//! ``` //! -//! TODO: explain a more involved example with multiple branches. +//! In a call to [`DispatcherBuilder::dependencies`], we specify a list of +//! dependencies that all handlers will receive as parameters. Here, we only +//! specify an in-memory storage of dialogues needed for [`dialogue::enter`]. +//! However, in production bots, you normally also pass a database connection, +//! configuration, and other stuff. //! +//! All in all, [`dptree`] can be seen as an extensible alternative to pattern +//! matching, with support for [dependency injection (DI)] and a few other +//! useful features. See [`examples/dispatching_features.rs`] as a more involved +//! example. +//! +//! [`Update::filter_message`]: crate::types::Update::filter_message +//! [`Update::filter_callback_query`]: crate::types::Update::filter_callback_query //! [chain of responsibility]: https://en.wikipedia.org/wiki/Chain-of-responsibility_pattern //! [dependency injection (DI)]: https://en.wikipedia.org/wiki/Dependency_injection +//! [`examples/dispatching_features.rs`]: https://github.com/teloxide/teloxide/blob/master/examples/dispatching_features.rs #[cfg(all(feature = "ctrlc_handler"))] pub mod repls; diff --git a/src/dispatching/dialogue.rs b/src/dispatching/dialogue.rs index 83b0239d..3af1ecc0 100644 --- a/src/dispatching/dialogue.rs +++ b/src/dispatching/dialogue.rs @@ -4,10 +4,11 @@ //! wrapper over [`Storage`] and a chat ID. All it does is provides convenient //! method for manipulating the dialogue state. [`Storage`] is where all //! dialogue states are stored; it can be either [`InMemStorage`], which is a -//! simple hash map, or database wrappers such as [`SqliteStorage`]. In the -//! latter case, your dialogues are _persistent_, meaning that you can safely -//! restart your bot and all dialogues will remain in the database -- this is a -//! preferred method for production bots. +//! simple hash map from [`std::collections`], or an advanced database wrapper +//! such as [`SqliteStorage`]. In the latter case, your dialogues are +//! _persistent_, meaning that you can safely restart your bot and all ongoing +//! dialogues will remain in the database -- this is a preferred method for +//! production bots. //! //! [`examples/dialogue.rs`] clearly demonstrates the typical usage of //! dialogues. Your dialogue state can be represented as an enumeration: @@ -31,8 +32,8 @@ //! bot: AutoSend, //! msg: Message, //! dialogue: MyDialogue, -//! (full_name,): (String,), // Available from `State::ReceiveAge`. -//! ) -> anyhow::Result<()> { +//! full_name: String, // Available from `State::ReceiveAge`. +//! ) -> HandlerResult { //! match msg.text().map(|text| text.parse::()) { //! Some(Ok(age)) => { //! bot.send_message(msg.chat.id, "What's your location?").await?; @@ -47,11 +48,12 @@ //! } //! ``` //! -//! Variant's fields are passed to state handlers as tuples: `(full_name,): -//! (String,)`. Using [`Dialogue::update`], you can update the dialogue with a -//! new state, in our case -- `State::ReceiveLocation { full_name, age }`. To -//! exit the dialogue, just call [`Dialogue::exit`] and it will be removed from -//! the inner storage: +//! Variant's fields are passed to state handlers as single arguments like +//! `full_name: String` or tuples in case of two or more variant parameters (see +//! below). Using [`Dialogue::update`], you can update the dialogue with a new +//! state, in our case -- `State::ReceiveLocation { full_name, age }`. To exit +//! the dialogue, just call [`Dialogue::exit`] and it will be removed from the +//! underlying storage: //! //! ```ignore //! async fn receive_location( From db5747eb4e2bc99f4cad7078215b5d9fe295e6aa Mon Sep 17 00:00:00 2001 From: Hirrolot Date: Tue, 19 Jul 2022 19:39:25 +0600 Subject: [PATCH 08/26] Ignore one doc example Former-commit-id: b48f87573a6d1e3e943ae0e1005303788b233eae --- src/dispatching.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/dispatching.rs b/src/dispatching.rs index 042870e8..e35d6b9d 100644 --- a/src/dispatching.rs +++ b/src/dispatching.rs @@ -140,7 +140,7 @@ //! //! Finally, we plug the schema into [`Dispatcher`] like this: //! -//! ```no_run +//! ```ignore //! # #[tokio::main] //! # async fn main() { //! let bot = Bot::from_env().auto_send(); From 6c7f17b07080f49f699169716411cf76ec440f2c Mon Sep 17 00:00:00 2001 From: Hirrolot Date: Tue, 19 Jul 2022 19:43:02 +0600 Subject: [PATCH 09/26] Retain consistency in `CHANGELOG.md` Former-commit-id: 82c7923dea46061c0cbd691b0ace757ddde879f3 --- CHANGELOG.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4fe36a67..92916a97 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,8 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added -- Security checks based on `secret_token` param of `set_webhook` to built-in webhooks -- `dispatching::update_listeners::{PollingBuilder, Polling, PollingStream}` + - Security checks based on `secret_token` param of `set_webhook` to built-in webhooks. + - `dispatching::update_listeners::{PollingBuilder, Polling, PollingStream}`. ### Fixed @@ -18,14 +18,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed - Add the `Key: Clone` requirement for `impl Dispatcher` [**BC**]. - - `dispatching::update_listeners::{polling_default, polling}` now return a named, `Polling<_>` type - - Update teloxide-core to v0.7.0 with Bot API 6.1 support, see [its changelog][core07c] for more [**BC**] + - `dispatching::update_listeners::{polling_default, polling}` now return a named, `Polling<_>` type. + - Update teloxide-core to v0.7.0 with Bot API 6.1 support, see [its changelog][core07c] for more information [**BC**]. [core07c]: https://github.com/teloxide/teloxide-core/blob/master/CHANGELOG.md#070---2022-07-19 ### Deprecated -- `dispatching::update_listeners::polling` +- The `dispatching::update_listeners::polling` function. ## 0.9.2 - 2022-06-07 From a27799e098a4ed6e1281c6963af314ef877f7462 Mon Sep 17 00:00:00 2001 From: Waffle Maybe Date: Tue, 19 Jul 2022 18:01:25 +0400 Subject: [PATCH 10/26] attempt to fix ci Former-commit-id: 9f1d0d7dd88b66fe28c76c93d405a475c8c1630d --- .github/workflows/ci.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index dba02ce0..54ae77ee 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -123,6 +123,7 @@ jobs: args: --tests --verbose ${{ matrix.features }} - name: Test documentation tests + if: ${{ matrix.rust != "msrv" }} uses: actions-rs/cargo@v1 with: command: test From 6c0e7f814fdcf7d9f00159dae4abf85d6f836efd Mon Sep 17 00:00:00 2001 From: Waffle Maybe Date: Tue, 19 Jul 2022 18:12:45 +0400 Subject: [PATCH 11/26] use different quotes?... Former-commit-id: d9a7c265f97d734fa50306d5f6682dbeb6db130a --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 54ae77ee..c2ccac7e 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -123,7 +123,7 @@ jobs: args: --tests --verbose ${{ matrix.features }} - name: Test documentation tests - if: ${{ matrix.rust != "msrv" }} + if: ${{ matrix.rust != 'msrv' }} uses: actions-rs/cargo@v1 with: command: test From f2cf85d9ce9232603bb80c86e2c50e98c36a3b2e Mon Sep 17 00:00:00 2001 From: Hirrolot Date: Tue, 19 Jul 2022 20:16:08 +0600 Subject: [PATCH 12/26] Leave `teloxide-core` and `dptree` as GitHub deps (dev) Former-commit-id: d6d819afb8f951f21592eb64081743a70cf779c5 --- Cargo.toml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Cargo.toml b/Cargo.toml index 9c702774..e5f1364b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -65,6 +65,10 @@ serde = { version = "1.0", features = ["derive"] } dptree = "0.3.0" +# These lines are used only for development. +# teloxide-core = { git = "https://github.com/teloxide/teloxide-core", rev = "b13393d", default-features = false } +# dptree = { git = "https://github.com/teloxide/dptree", rev = "df578e4" } + tokio = { version = "1.8", features = ["fs"] } tokio-util = "0.7" tokio-stream = "0.1.8" From ad87f6e63c26963cc7b5db8a8d9d2412a8fefa67 Mon Sep 17 00:00:00 2001 From: Hirrolot Date: Tue, 19 Jul 2022 21:47:09 +0600 Subject: [PATCH 13/26] Test teloxide-macros with a `parse_with` bug fix Former-commit-id: 78afa99b794d72405566b4ce120005630a6796f6 --- Cargo.toml | 3 ++- tests/command.rs | 35 +++++++++++++++++++++++++---------- 2 files changed, 27 insertions(+), 11 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index e5f1364b..d7b160ca 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -58,7 +58,7 @@ full = [ [dependencies] teloxide-core = { version = "0.7.0", default-features = false } -teloxide-macros = { version = "0.6.2", optional = true } +# teloxide-macros = { version = "0.6.2", optional = true } serde_json = "1.0" serde = { version = "1.0", features = ["derive"] } @@ -67,6 +67,7 @@ dptree = "0.3.0" # These lines are used only for development. # teloxide-core = { git = "https://github.com/teloxide/teloxide-core", rev = "b13393d", default-features = false } +teloxide-macros = { git = "https://github.com/teloxide/teloxide-macros", rev = "44d91c5", optional = true } # dptree = { git = "https://github.com/teloxide/dptree", rev = "df578e4" } tokio = { version = "1.8", features = ["fs"] } diff --git a/tests/command.rs b/tests/command.rs index b3e6609e..4b59ac48 100644 --- a/tests/command.rs +++ b/tests/command.rs @@ -2,7 +2,7 @@ #![allow(clippy::nonstandard_macro_braces)] #[cfg(feature = "macros")] -use teloxide::utils::command::{BotCommands, ParseError}; +use teloxide::utils::command::BotCommands; // We put tests here because macro expand in unit tests in module // teloxide::utils::command was a failure @@ -141,22 +141,33 @@ fn parse_with_split2() { #[test] #[cfg(feature = "macros")] fn parse_custom_parser() { - fn custom_parse_function(s: String) -> Result<(u8, String), ParseError> { - let vec = s.split_whitespace().collect::>(); - let (left, right) = match vec.as_slice() { - [l, r] => (l, r), - _ => return Err(ParseError::IncorrectFormat("might be 2 arguments!".into())), - }; - left.parse::() - .map(|res| (res, (*right).to_string())) - .map_err(|_| ParseError::Custom("First argument must be a integer!".to_owned().into())) + mod parser { + use teloxide::utils::command::ParseError; + + pub fn custom_parse_function(s: String) -> Result<(u8, String), ParseError> { + let vec = s.split_whitespace().collect::>(); + let (left, right) = match vec.as_slice() { + [l, r] => (l, r), + _ => return Err(ParseError::IncorrectFormat("might be 2 arguments!".into())), + }; + left.parse::().map(|res| (res, (*right).to_string())).map_err(|_| { + ParseError::Custom("First argument must be a integer!".to_owned().into()) + }) + } } + use parser::custom_parse_function; + #[derive(BotCommands, Debug, PartialEq)] #[command(rename = "lowercase")] enum DefaultCommands { #[command(parse_with = "custom_parse_function")] Start(u8, String), + + // Test . + #[command(parse_with = "parser::custom_parse_function")] + TestPath(u8, String), + Help, } @@ -164,6 +175,10 @@ fn parse_custom_parser() { DefaultCommands::Start(10, "hello".to_string()), DefaultCommands::parse("/start 10 hello", "").unwrap() ); + assert_eq!( + DefaultCommands::TestPath(10, "hello".to_string()), + DefaultCommands::parse("/testpath 10 hello", "").unwrap() + ); } #[test] From fb5b64bff96e7b5c2ed626fe0aa00940b1828b64 Mon Sep 17 00:00:00 2001 From: Hirrolot Date: Tue, 19 Jul 2022 22:02:44 +0600 Subject: [PATCH 14/26] Update teloxide-macros to v0.6.3 Former-commit-id: 3d9f4ef2b0b84a517bb77d9a4b5e6093eb86c339 --- CHANGELOG.md | 1 + Cargo.toml | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 92916a97..8681abe3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed - `Dispatcher` no longer "leaks" memory for every inactive user ([PR 657](https://github.com/teloxide/teloxide/pull/657)). + - Allow specifying a path to a custom command parser in `parse_with` ([issue 668](https://github.com/teloxide/teloxide/issues/668)). ### Changed diff --git a/Cargo.toml b/Cargo.toml index d7b160ca..df04f34e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -58,7 +58,7 @@ full = [ [dependencies] teloxide-core = { version = "0.7.0", default-features = false } -# teloxide-macros = { version = "0.6.2", optional = true } +teloxide-macros = { version = "0.6.3", optional = true } serde_json = "1.0" serde = { version = "1.0", features = ["derive"] } @@ -67,7 +67,7 @@ dptree = "0.3.0" # These lines are used only for development. # teloxide-core = { git = "https://github.com/teloxide/teloxide-core", rev = "b13393d", default-features = false } -teloxide-macros = { git = "https://github.com/teloxide/teloxide-macros", rev = "44d91c5", optional = true } +# teloxide-macros = { git = "https://github.com/teloxide/teloxide-macros", rev = "44d91c5", optional = true } # dptree = { git = "https://github.com/teloxide/dptree", rev = "df578e4" } tokio = { version = "1.8", features = ["fs"] } From d919c99b69ca6bc5ae2aaa48d02fe226f9b0990d Mon Sep 17 00:00:00 2001 From: Hirrolot Date: Wed, 20 Jul 2022 17:44:39 +0600 Subject: [PATCH 15/26] Improve the dispatching explanation (docs) Former-commit-id: 9ab3b3a1c5ab6ebbfce82b027cf50d2f961d87ba --- src/dispatching.rs | 130 +++++++++++++++++++++------------------------ 1 file changed, 62 insertions(+), 68 deletions(-) diff --git a/src/dispatching.rs b/src/dispatching.rs index e35d6b9d..ce939b28 100644 --- a/src/dispatching.rs +++ b/src/dispatching.rs @@ -4,31 +4,23 @@ //! [chain of responsibility] pattern enriched with a number of combinator //! functions, which together form an instance of the [`dptree::Handler`] type. //! -//! Let us look at this simple example: -//! -//! [[`examples/purchase.rs`](https://github.com/teloxide/teloxide/blob/master/examples/purchase.rs)] -//! ```no_run -//! // Imports omitted... -//! # use teloxide::{ -//! # dispatching::{dialogue::InMemStorage, UpdateHandler}, -//! # prelude::*, -//! # types::{InlineKeyboardButton, InlineKeyboardMarkup}, -//! # utils::command::BotCommands, -//! # }; -//! -//! type MyDialogue = Dialogue>; -//! type HandlerResult = Result<(), Box>; +//! Take [`examples/purchase.rs`] as an example of dispatching logic. First, we +//! define a type named `State` to represent the current state of a dialogue: //! +//! ```ignore //! #[derive(Clone, Default)] //! pub enum State { //! #[default] //! Start, //! ReceiveFullName, -//! ReceiveProductChoice { -//! full_name: String, -//! }, +//! ReceiveProductChoice { full_name: String }, //! } +//! ``` //! +//! Then, we define a type `Command` to represent user commands such as +//! `/start` or `/help`: +//! +//! ```ignore //! #[derive(BotCommands, Clone)] //! #[command(rename = "lowercase", description = "These commands are supported:")] //! enum Command { @@ -39,23 +31,15 @@ //! #[command(description = "cancel the purchase procedure.")] //! Cancel, //! } +//! ``` //! -//! #[tokio::main] -//! async fn main() { -//! // Setup is omitted... -//! # pretty_env_logger::init(); -//! # log::info!("Starting purchase bot..."); -//! # -//! # let bot = Bot::from_env().auto_send(); -//! # -//! # Dispatcher::builder(bot, schema()) -//! # .dependencies(dptree::deps![InMemStorage::::new()]) -//! # .build() -//! # .setup_ctrlc_handler() -//! # .dispatch() -//! # .await; -//! } +//! Now the key question: how to elegantly dispatch on different combinations of +//! `State`, `Command`, and Telegram updates? -- i.e., we may want to execute +//! specific endpoints only in response to specific user commands and while we +//! are in a given dialogue state (and possibly under other circumstances!). The +//! solution is to use [`dptree`]: //! +//! ```ignore //! fn schema() -> UpdateHandler> { //! let command_handler = teloxide::filter_command::() //! .branch( @@ -79,7 +63,30 @@ //! .branch(message_handler) //! .branch(callback_query_handler) //! } +//! ``` //! +//! The overall logic should be clear. Throughout the above example, we use +//! several techniques: +//! +//! - **Branching:** `a.branch(b)` roughly means "try to handle an update with +//! `a`, then, if it +//! neglects the update, try `b`". +//! - **Pattern matching:** We also use the [`dptree::case!`] macro +//! extensively, which acts as a filter on an enumeration: if it is of a +//! certain variant, it passes the variant's payload down the handler chain; +//! otherwise, it neglects an update. +//! - **Endpoints:** To specify the final function to handle an update, we use +//! [`dptree::Handler::endpoint`]. +//! +//! Notice the clear and uniform code structure: regardless of the dispatch +//! criteria, we use the same program constructions. In future, you may want to +//! introduce your application-specific filters or data structures to match upon +//! -- no problem, reuse [`dptree::Handler::filter`], [`dptree::case!`], and +//! other combinators in the same way! +//! +//! Finally, we define our endpoints like this: +//! +//! ```ignore //! // Handler definitions omitted... //! //! async fn start(bot: AutoSend, msg: Message, dialogue: MyDialogue) -> HandlerResult { @@ -116,55 +123,42 @@ //! } //! ``` //! -//! The above code shows how to dispatch on different combinations of a state -//! and command _elegantly_. We give a top-bottom explanation of the function -//! `schema`, which constructs the main update handler: +//! Each parameter is supplied as a dependency by teloxide. In particular: +//! - `bot: AutoSend` comes from the dispatcher (see below); +//! - `msg: Message` comes from [`Update::filter_message`]; +//! - `q: CallbackQuery` comes from [`Update::filter_callback_query`]; +//! - `dialogue: MyDialogue` comes from [`dialogue::enter`]; +//! - `full_name: String` comes from `dptree::case![State::ReceiveProductChoice +//! { full_name }]`. //! -//! - We call the [`dialogue::enter`] function to initiate dialogue -//! interaction. Then we call [`dptree::Handler::branch`] two times to form a -//! tree of responsibility of `message_handler` and `callback_query_handler`. -//! - Inside `message_handler`, we use [`Update::filter_message`] as a filter -//! for incoming messages. Then we create a tree of responsibility again, -//! consisting of three branches with a similar structure. -//! - Inside `callback_query_handler`, we use -//! [`Update::filter_callback_query`] as a filter and create one branch for -//! handling product selection. -//! -//! `a.branch(b)` roughly means "try to handle an update with `a`, then, if it -//! fails, try `b`". We use branching multiple times here, which is a natural -//! pattern for describing dispatching logic. We also use the [`dptree::case!`] -//! macro extensively, which acts as a filter on an enumeration: if it is of a -//! certain variant, it passes the variant's payload down the handler chain; -//! otherwise, it neglects an update. Note how we utilise this macro both for -//! `State` and `Command` in the same way! -//! -//! Finally, we plug the schema into [`Dispatcher`] like this: +//! Inside `main`, we plug the schema into [`Dispatcher`] like this: //! //! ```ignore -//! # #[tokio::main] -//! # async fn main() { -//! let bot = Bot::from_env().auto_send(); +//! #[tokio::main] +//! async fn main() { +//! let bot = Bot::from_env().auto_send(); //! -//! Dispatcher::builder(bot, schema()) -//! .dependencies(dptree::deps![InMemStorage::::new()]) -//! .build() -//! .setup_ctrlc_handler() -//! .dispatch() -//! .await; -//! # } +//! Dispatcher::builder(bot, schema()) +//! .dependencies(dptree::deps![InMemStorage::::new()]) +//! .build() +//! .setup_ctrlc_handler() +//! .dispatch() +//! .await; +//! } //! ``` //! //! In a call to [`DispatcherBuilder::dependencies`], we specify a list of -//! dependencies that all handlers will receive as parameters. Here, we only -//! specify an in-memory storage of dialogues needed for [`dialogue::enter`]. -//! However, in production bots, you normally also pass a database connection, -//! configuration, and other stuff. +//! additional dependencies that all handlers will receive as parameters. Here, +//! we only specify an in-memory storage of dialogues needed for +//! [`dialogue::enter`]. However, in production bots, you normally also pass a +//! database connection, configuration, and other stuff. //! //! All in all, [`dptree`] can be seen as an extensible alternative to pattern //! matching, with support for [dependency injection (DI)] and a few other //! useful features. See [`examples/dispatching_features.rs`] as a more involved //! example. //! +//! [`examples/purchase.rs`]: https://github.com/teloxide/teloxide/blob/master/examples/purchase.rs //! [`Update::filter_message`]: crate::types::Update::filter_message //! [`Update::filter_callback_query`]: crate::types::Update::filter_callback_query //! [chain of responsibility]: https://en.wikipedia.org/wiki/Chain-of-responsibility_pattern From ac3a42ff0a4f07e77526db12b17c6c8240dad0ba Mon Sep 17 00:00:00 2001 From: Hirrolot Date: Wed, 20 Jul 2022 19:40:32 +0600 Subject: [PATCH 16/26] Link `Dispatcher` from the docs of REPLs Former-commit-id: 4fb8a120ea9f23a9774597c08fdb8dc3e054e25f --- src/dispatching/repls/commands_repl.rs | 10 ++++++++++ src/dispatching/repls/repl.rs | 12 +++++++++++- 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/src/dispatching/repls/commands_repl.rs b/src/dispatching/repls/commands_repl.rs index fd04964a..c5669e29 100644 --- a/src/dispatching/repls/commands_repl.rs +++ b/src/dispatching/repls/commands_repl.rs @@ -14,7 +14,12 @@ use teloxide_core::requests::Requester; /// /// All errors from an update listener and handler will be logged. /// +/// REPLs are meant only for simple bots and rapid prototyping. If you need to +/// supply dependencies or describe more complex dispatch logic, please use +/// [`Dispatcher`]. +/// /// ## Caution +/// /// **DO NOT** use this function together with [`Dispatcher`] and other REPLs, /// because Telegram disallow multiple requests at the same time from the same /// bot. @@ -49,7 +54,12 @@ where /// /// All errors from an update listener and handler will be logged. /// +/// REPLs are meant only for simple bots and rapid prototyping. If you need to +/// supply dependencies or describe more complex dispatch logic, please use +/// [`Dispatcher`]. +/// /// ## Caution +/// /// **DO NOT** use this function together with [`Dispatcher`] and other REPLs, /// because Telegram disallow multiple requests at the same time from the same /// bot. diff --git a/src/dispatching/repls/repl.rs b/src/dispatching/repls/repl.rs index eec73f1f..509525d4 100644 --- a/src/dispatching/repls/repl.rs +++ b/src/dispatching/repls/repl.rs @@ -11,7 +11,12 @@ use teloxide_core::requests::Requester; /// /// All errors from an update listener and a handler will be logged. /// -/// # Caution +/// REPLs are meant only for simple bots and rapid prototyping. If you need to +/// supply dependencies or describe more complex dispatch logic, please use +/// [`Dispatcher`]. +/// +/// ## Caution +/// /// **DO NOT** use this function together with [`Dispatcher`] and other REPLs, /// because Telegram disallow multiple requests at the same time from the same /// bot. @@ -35,7 +40,12 @@ where /// /// All errors from an update listener and handler will be logged. /// +/// REPLs are meant only for simple bots and rapid prototyping. If you need to +/// supply dependencies or describe more complex dispatch logic, please use +/// [`Dispatcher`]. +/// /// # Caution +/// /// **DO NOT** use this function together with [`Dispatcher`] and other REPLs, /// because Telegram disallow multiple requests at the same time from the same /// bot. From e2127658477992167bf9ae4070d6517ae1e3c493 Mon Sep 17 00:00:00 2001 From: Hirrolot Date: Wed, 20 Jul 2022 20:11:55 +0600 Subject: [PATCH 17/26] Drop community bots using old versions of teloxide Also, prettify the list representation a little bit. Former-commit-id: d2cb46382cea83f1aa5d9b9dfd317c47a585ef36 --- README.md | 41 ++++++++++++++--------------------------- 1 file changed, 14 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index b8bb377c..ee55388e 100644 --- a/README.md +++ b/README.md @@ -319,7 +319,7 @@ A: No, only the bots API. **Q: Can I use webhooks?** -A: You can! Teloxide has a built-in support for webhooks in `dispatching::update_listeners::webhooks` module. See how it's used in [`examples/ngrok_ping_pong_bot`](examples/ngrok_ping_pong.rs) and [`examples/heroku_ping_pong_bot`](examples/heroku_ping_pong.rs) +A: You can! Teloxide has a built-in support for webhooks in `dispatching::update_listeners::webhooks` module. See how it's used in [`examples/ngrok_ping_pong_bot`](examples/ngrok_ping_pong.rs) and [`examples/heroku_ping_pong_bot`](examples/heroku_ping_pong.rs). **Q: Can I handle both callback queries and messages within a single dialogue?** @@ -329,32 +329,19 @@ A: Yes, see [`examples/purchase.rs`](examples/purchase.rs). Feel free to propose your own bot to our collection! - - [WaffleLapkin/crate_upd_bot](https://github.com/WaffleLapkin/crate_upd_bot) — A bot that notifies about crate updates. - - [mxseev/logram](https://github.com/mxseev/logram) — Utility that takes logs from anywhere and sends them to Telegram. - - [alexkonovalov/PedigreeBot](https://github.com/alexkonovalov/PedigreeBot) — A Telegram bot for building family trees. - - [Hermitter/tepe](https://github.com/Hermitter/tepe) — A CLI to command a bot to send messages and files over Telegram. - - [mattrighetti/GroupActivityBot](https://github.com/mattrighetti/group-activity-bot-rs) — Telegram bot that keeps track of user activity in groups. - - [mattrighetti/libgen-bot-rs](https://github.com/mattrighetti/libgen-bot-rs) — Telgram bot to interface with libgen - - [dracarys18/grpmr-rs](https://github.com/dracarys18/grpmr-rs) — A Telegram group manager bot with variety of extra features. - - [steadylearner/subreddit_reader](https://github.com/steadylearner/Rust-Full-Stack/tree/master/commits/teloxide/subreddit_reader) — A bot that shows the latest posts at Rust subreddit. - - [myblackbeard/basketball-betting-bot](https://github.com/myblackbeard/basketball-betting-bot) — The bot lets you bet on NBA games against your buddies. - - [ArtHome12/vzmuinebot](https://github.com/ArtHome12/vzmuinebot) — Telegram bot for food menu navigate. - - [ArtHome12/cognito_bot](https://github.com/ArtHome12/cognito_bot) — The bot is designed to anonymize messages to a group. - - [pro-vim/tg-vimhelpbot](https://github.com/pro-vim/tg-vimhelpbot) — Link `:help` for Vim in Telegram. - - [sschiz/janitor-bot](https://github.com/sschiz/janitor-bot) — A bot that removes users trying to join to a chat that is designed for comments. - - [slondr/BeerHolderBot](https://gitlab.com/slondr/BeerHolderBot) — A bot that holds your beer. - - [MustafaSalih1993/Miss-Vodka-Telegram-Bot](https://github.com/MustafaSalih1993/Miss-Vodka-Telegram-Bot) — A Telegram bot written in rust using "Teloxide" library. - - [x13a/tg-prompt](https://github.com/x13a/tg-prompt) — Telegram prompt. - - [magnickolas/remindee-bot](https://github.com/magnickolas/remindee-bot) — Telegram bot for managing reminders. - - [cyberknight777/knight-bot](https://gitlab.com/cyberknight777/knight-bot) — A Telegram bot with variety of fun features. - - [wa7sa34cx/the-black-box-bot](https://github.com/wa7sa34cx/the-black-box-bot) — This is the Black Box Telegram bot. You can hold any items in it. - - [crapstone/hsctt](https://codeberg.org/crapstones-bots/hsctt) — A Telegram bot that searches for HTTP status codes in all messages and replies with the text form. - - [alenpaul2001/AurSearchBot](https://gitlab.com/alenpaul2001/aursearchbot) — Telegram bot for searching AUR in inline mode. - - [studiedlist/EddieBot](https://gitlab.com/studiedlist/eddie-bot) — Chatting bot with several entertainment features. - - [modos189/tg_blackbox_bot](https://gitlab.com/modos189/tg_blackbox_bot) — Anonymous feedback for your Telegram project. This bot in Docker from scratch container. - - [0xNima/spacecraft](https://github.com/0xNima/spacecraft) — Yet another telegram bot to downloading Twitter spaces. - - [0xNima/Twideo](https://github.com/0xNima/Twideo) — Telegram Bot for downloading videos from Twitter via their links, as well as converting tweets to telegram messages. - - [raine/tgreddit](https://github.com/raine/tgreddit) — A bot that sends the top posts of your favorite subreddits to Telegram. + - [`raine/tgreddit`](https://github.com/raine/tgreddit) — A bot that sends the top posts of your favorite subreddits to Telegram. + - [`magnickolas/remindee-bot`](https://github.com/magnickolas/remindee-bot) — Telegram bot for managing reminders. + - [`WaffleLapkin/crate_upd_bot`](https://github.com/WaffleLapkin/crate_upd_bot) — A bot that notifies about crate updates. + - [`mattrighetti/GroupActivityBot`](https://github.com/mattrighetti/group-activity-bot-rs) — Telegram bot that keeps track of user activity in groups. + - [`alenpaul2001/AurSearchBot`](https://gitlab.com/alenpaul2001/aursearchbot) — Telegram bot for searching in Arch User Repository (AUR). + - [`ArtHome12/vzmuinebot`](https://github.com/ArtHome12/vzmuinebot) — Telegram bot for food menu navigate. + - [`studiedlist/EddieBot`](https://gitlab.com/studiedlist/eddie-bot) — Chatting bot with several entertainment features. + - [`modos189/tg_blackbox_bot`](https://gitlab.com/modos189/tg_blackbox_bot) — Anonymous feedback for your Telegram project. + - [`0xNima/spacecraft`](https://github.com/0xNima/spacecraft) — Yet another telegram bot to downloading Twitter spaces. + - [`0xNima/Twideo`](https://github.com/0xNima/Twideo) — Simple Telegram Bot for downloading videos from Twitter via their links. + - [`mattrighetti/libgen-bot-rs`](https://github.com/mattrighetti/libgen-bot-rs) — Telgram bot to interface with libgen. + +(Only bots using teloxide v0.6.0 or higher are listed.) ## Contributing From 31cfca1615451459602a3ada7da1dbef0d329dae Mon Sep 17 00:00:00 2001 From: Hirrolot Date: Wed, 20 Jul 2022 20:13:44 +0600 Subject: [PATCH 18/26] Update the API coverage badge Former-commit-id: 7e6c04643f81df692ddc23bc660f5162bb402f51 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ee55388e..b3fd1bd2 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ - + From b6c6e3e1eea6b95b40eef1651a780e9908a236a4 Mon Sep 17 00:00:00 2001 From: Hirrolot Date: Thu, 21 Jul 2022 14:28:26 +0600 Subject: [PATCH 19/26] Add `zamazan4ik/npaperbot-telegram` to community bots Former-commit-id: ca85dfff166f2bc7acab3bd22990ed2bf2d19e47 --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index b3fd1bd2..fed1aa26 100644 --- a/README.md +++ b/README.md @@ -340,6 +340,7 @@ Feel free to propose your own bot to our collection! - [`0xNima/spacecraft`](https://github.com/0xNima/spacecraft) — Yet another telegram bot to downloading Twitter spaces. - [`0xNima/Twideo`](https://github.com/0xNima/Twideo) — Simple Telegram Bot for downloading videos from Twitter via their links. - [`mattrighetti/libgen-bot-rs`](https://github.com/mattrighetti/libgen-bot-rs) — Telgram bot to interface with libgen. + - [`zamazan4ik/npaperbot-telegram`](https://github.com/zamazan4ik/npaperbot-telegram) — Telegram bot for searching via C++ proposals. (Only bots using teloxide v0.6.0 or higher are listed.) From 378acfc17a76a4df6939cec0668ec9f6291a8ba0 Mon Sep 17 00:00:00 2001 From: Hirrolot Date: Thu, 21 Jul 2022 14:51:22 +0600 Subject: [PATCH 20/26] Put community bots with old teloxide into a hidden section Former-commit-id: 92abc22613738c995f1d6bcf4f0c6ce3e3d92557 --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fed1aa26..12663bea 100644 --- a/README.md +++ b/README.md @@ -342,7 +342,19 @@ Feel free to propose your own bot to our collection! - [`mattrighetti/libgen-bot-rs`](https://github.com/mattrighetti/libgen-bot-rs) — Telgram bot to interface with libgen. - [`zamazan4ik/npaperbot-telegram`](https://github.com/zamazan4ik/npaperbot-telegram) — Telegram bot for searching via C++ proposals. -(Only bots using teloxide v0.6.0 or higher are listed.) +
+Show bots using teloxide older than v0.6.0 + + - [`mxseev/logram`](https://github.com/mxseev/logram) — Utility that takes logs from anywhere and sends them to Telegram. + - [`alexkonovalov/PedigreeBot`](https://github.com/alexkonovalov/PedigreeBot) — A Telegram bot for building family trees. + - [`Hermitter/tepe`](https://github.com/Hermitter/tepe) — A CLI to command a bot to send messages and files over Telegram. + - [`myblackbeard/basketball-betting-bot`](https://github.com/myblackbeard/basketball-betting-bot) — The bot lets you bet on NBA games against your buddies. + - [`dracarys18/grpmr-rs`](https://github.com/dracarys18/grpmr-rs) — Modular Telegram Group Manager Bot written in Rust. + - [`ArtHome12/vzmuinebot`](https://github.com/ArtHome12/vzmuinebot) — Telegram bot for food menu navigate. + - [`ArtHome12/cognito_bot`](https://github.com/ArtHome12/cognito_bot) — The bot is designed to anonymize messages to a group. + - [`crapstone/hsctt`](https://codeberg.org/crapstones-bots/hsctt) — A bot that converts HTTP status codes into text. + +
## Contributing From 11231655c222510a21792ccdfa51d36fa4c0f5fe Mon Sep 17 00:00:00 2001 From: Maybe Waffle Date: Thu, 21 Jul 2022 12:36:57 +0400 Subject: [PATCH 21/26] Move ctrlc handler enable function to `DispatcherBuilder` This helps with consistency -- every setting is changed in builder. Also `Self -> Self` function sometimes plays more nicely with borrowck. Former-commit-id: dd4af30727caa2dfbd81464e0a6f8e87f056a2d3 --- CHANGELOG.md | 2 + MIGRATION_GUIDE.md | 4 +- README.md | 2 +- examples/buttons.rs | 2 +- examples/db_remember.rs | 2 +- examples/dialogue.rs | 2 +- examples/dispatching_features.rs | 2 +- examples/inline.rs | 2 +- examples/purchase.rs | 2 +- examples/shared_state.rs | 2 +- src/dispatching.rs | 2 +- src/dispatching/dispatcher.rs | 51 ++++++++++++++++++++------ src/dispatching/repls/commands_repl.rs | 2 +- src/dispatching/repls/repl.rs | 2 +- src/features.md | 40 ++++++++++---------- 15 files changed, 76 insertions(+), 43 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8681abe3..db915866 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Security checks based on `secret_token` param of `set_webhook` to built-in webhooks. - `dispatching::update_listeners::{PollingBuilder, Polling, PollingStream}`. + - `DispatcherBuilder::enable_ctrlc_handler` method. ### Fixed @@ -27,6 +28,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Deprecated - The `dispatching::update_listeners::polling` function. +- `Dispatcher::setup_ctrlc_handler` method. ## 0.9.2 - 2022-06-07 diff --git a/MIGRATION_GUIDE.md b/MIGRATION_GUIDE.md index dd1af6eb..78003f48 100644 --- a/MIGRATION_GUIDE.md +++ b/MIGRATION_GUIDE.md @@ -38,7 +38,9 @@ Some places now use `FileMeta` instead of `File`, you may need to change types. ### teloxide Teloxide itself doesn't have any major API changes. -Note however that `dispatching::update_listeners::polling` function was deprecated, use `polling_builder` instead. +Note however that some function were deprecated: +- Instead of `dispatching::update_listeners::polling` use `polling_builder` +- Instead of `Dispatcher::setup_ctrlc_handler` use `DispatcherBuilder::enable_ctrlc_handler` ## 0.7 -> 0.8 diff --git a/README.md b/README.md index 12663bea..b05f48f8 100644 --- a/README.md +++ b/README.md @@ -223,8 +223,8 @@ async fn main() { ), ) .dependencies(dptree::deps![InMemStorage::::new()]) + .enable_ctrlc_handler() .build() - .setup_ctrlc_handler() .dispatch() .await; } diff --git a/examples/buttons.rs b/examples/buttons.rs index 5b16fe35..b510e24a 100644 --- a/examples/buttons.rs +++ b/examples/buttons.rs @@ -30,7 +30,7 @@ async fn main() -> Result<(), Box> { .branch(Update::filter_callback_query().endpoint(callback_handler)) .branch(Update::filter_inline_query().endpoint(inline_query_handler)); - Dispatcher::builder(bot, handler).build().setup_ctrlc_handler().dispatch().await; + Dispatcher::builder(bot, handler).enable_ctrlc_handler().build().dispatch().await; Ok(()) } diff --git a/examples/db_remember.rs b/examples/db_remember.rs index 206768d9..1aed2808 100644 --- a/examples/db_remember.rs +++ b/examples/db_remember.rs @@ -54,8 +54,8 @@ async fn main() { Dispatcher::builder(bot, handler) .dependencies(dptree::deps![storage]) + .enable_ctrlc_handler() .build() - .setup_ctrlc_handler() .dispatch() .await; } diff --git a/examples/dialogue.rs b/examples/dialogue.rs index 30636924..8e30219d 100644 --- a/examples/dialogue.rs +++ b/examples/dialogue.rs @@ -51,8 +51,8 @@ async fn main() { ), ) .dependencies(dptree::deps![InMemStorage::::new()]) + .enable_ctrlc_handler() .build() - .setup_ctrlc_handler() .dispatch() .await; } diff --git a/examples/dispatching_features.rs b/examples/dispatching_features.rs index 91ef0808..dcaf4fcc 100644 --- a/examples/dispatching_features.rs +++ b/examples/dispatching_features.rs @@ -87,8 +87,8 @@ async fn main() { .error_handler(LoggingErrorHandler::with_custom_text( "An error has occurred in the dispatcher", )) + .enable_ctrlc_handler() .build() - .setup_ctrlc_handler() .dispatch() .await; } diff --git a/examples/inline.rs b/examples/inline.rs index a85de2c2..837fa30d 100644 --- a/examples/inline.rs +++ b/examples/inline.rs @@ -60,5 +60,5 @@ async fn main() { }, )); - Dispatcher::builder(bot, handler).build().setup_ctrlc_handler().dispatch().await; + Dispatcher::builder(bot, handler).enable_ctrlc_handler().build().dispatch().await; } diff --git a/examples/purchase.rs b/examples/purchase.rs index cbe4bfe6..f2f68729 100644 --- a/examples/purchase.rs +++ b/examples/purchase.rs @@ -52,8 +52,8 @@ async fn main() { Dispatcher::builder(bot, schema()) .dependencies(dptree::deps![InMemStorage::::new()]) + .enable_ctrlc_handler() .build() - .setup_ctrlc_handler() .dispatch() .await; } diff --git a/examples/shared_state.rs b/examples/shared_state.rs index c09fab93..21a0fcc0 100644 --- a/examples/shared_state.rs +++ b/examples/shared_state.rs @@ -27,8 +27,8 @@ async fn main() { Dispatcher::builder(bot, handler) // Pass the shared state to the handler as a dependency. .dependencies(dptree::deps![messages_total]) + .enable_ctrlc_handler() .build() - .setup_ctrlc_handler() .dispatch() .await; } diff --git a/src/dispatching.rs b/src/dispatching.rs index ce939b28..f8fb3bdf 100644 --- a/src/dispatching.rs +++ b/src/dispatching.rs @@ -140,8 +140,8 @@ //! //! Dispatcher::builder(bot, schema()) //! .dependencies(dptree::deps![InMemStorage::::new()]) +//! .enable_ctrlc_handler() //! .build() -//! .setup_ctrlc_handler() //! .dispatch() //! .await; //! } diff --git a/src/dispatching/dispatcher.rs b/src/dispatching/dispatcher.rs index 74eace82..3926792d 100644 --- a/src/dispatching/dispatcher.rs +++ b/src/dispatching/dispatcher.rs @@ -33,6 +33,7 @@ pub struct DispatcherBuilder { handler: Arc>, default_handler: DefaultHandler, error_handler: Arc + Send + Sync>, + ctrlc_handler: bool, distribution_f: fn(&Update) -> Option, worker_queue_size: usize, } @@ -78,6 +79,14 @@ where Self { dependencies, ..self } } + /// Enables the `^C` handler that [`shutdown`]s dispatching. + /// + /// [`shutdown`]: ShutdownToken::shutdown + #[cfg(feature = "ctrlc_handler")] + pub fn enable_ctrlc_handler(self) -> Self { + Self { ctrlc_handler: true, ..self } + } + /// Specifies size of the queue for workers. /// /// By default it's 64. @@ -101,6 +110,7 @@ where handler, default_handler, error_handler, + ctrlc_handler, distribution_f: _, worker_queue_size, } = self; @@ -111,6 +121,7 @@ where handler, default_handler, error_handler, + ctrlc_handler, distribution_f: f, worker_queue_size, } @@ -127,9 +138,10 @@ where error_handler, distribution_f, worker_queue_size, + ctrlc_handler, } = self; - Dispatcher { + let dp = Dispatcher { bot, dependencies, handler, @@ -142,7 +154,18 @@ where default_worker: None, current_number_of_active_workers: Default::default(), max_number_of_active_workers: Default::default(), + }; + + #[cfg(feature = "ctrlc_handler")] + { + if ctrlc_handler { + let mut dp = dp; + dp.setup_ctrlc_handler_inner(); + return dp; + } } + + dp } } @@ -212,6 +235,7 @@ where Box::pin(async {}) }), error_handler: LoggingErrorHandler::new(), + ctrlc_handler: false, worker_queue_size: DEFAULT_WORKER_QUEUE_SIZE, distribution_f: default_distribution_function, } @@ -238,7 +262,6 @@ where /// - [`crate::types::Me`] (can be used in [`HandlerExt::filter_command`]). /// /// [`shutdown`]: ShutdownToken::shutdown - /// [a ctrlc signal]: Dispatcher::setup_ctrlc_handler /// [`HandlerExt::filter_command`]: crate::dispatching::HandlerExt::filter_command pub async fn dispatch(&mut self) where @@ -258,7 +281,6 @@ where /// This method adds the same dependencies as [`Dispatcher::dispatch`]. /// /// [`shutdown`]: ShutdownToken::shutdown - /// [a ctrlc signal]: Dispatcher::setup_ctrlc_handler pub async fn dispatch_with_listener<'a, UListener, ListenerE, Eh>( &'a mut self, mut update_listener: UListener, @@ -425,7 +447,22 @@ where /// /// [`shutdown`]: ShutdownToken::shutdown #[cfg(feature = "ctrlc_handler")] + #[deprecated(since = "0.10", note = "use `enable_ctrlc_handler` on builder instead")] pub fn setup_ctrlc_handler(&mut self) -> &mut Self { + self.setup_ctrlc_handler_inner(); + self + } + + /// Returns a shutdown token, which can later be used to shutdown + /// dispatching. + pub fn shutdown_token(&self) -> ShutdownToken { + self.state.clone() + } +} + +impl Dispatcher { + #[cfg(feature = "ctrlc_handler")] + fn setup_ctrlc_handler_inner(&mut self) { let token = self.state.clone(); tokio::spawn(async move { loop { @@ -443,14 +480,6 @@ where } } }); - - self - } - - /// Returns a shutdown token, which can later be used to shutdown - /// dispatching. - pub fn shutdown_token(&self) -> ShutdownToken { - self.state.clone() } } diff --git a/src/dispatching/repls/commands_repl.rs b/src/dispatching/repls/commands_repl.rs index c5669e29..7f7db10f 100644 --- a/src/dispatching/repls/commands_repl.rs +++ b/src/dispatching/repls/commands_repl.rs @@ -96,8 +96,8 @@ pub async fn commands_repl_with_listener<'a, R, Cmd, H, L, ListenerE, E, Args>( Update::filter_message().filter_command::().chain(dptree::endpoint(handler)), ) .default_handler(ignore_update) + .enable_ctrlc_handler() .build() - .setup_ctrlc_handler() .dispatch_with_listener( listener, LoggingErrorHandler::with_custom_text("An error from the update listener"), diff --git a/src/dispatching/repls/repl.rs b/src/dispatching/repls/repl.rs index 509525d4..cecf90ad 100644 --- a/src/dispatching/repls/repl.rs +++ b/src/dispatching/repls/repl.rs @@ -71,8 +71,8 @@ where Dispatcher::builder(bot, Update::filter_message().chain(dptree::endpoint(handler))) .default_handler(ignore_update) + .enable_ctrlc_handler() .build() - .setup_ctrlc_handler() .dispatch_with_listener( listener, LoggingErrorHandler::with_custom_text("An error from the update listener"), diff --git a/src/features.md b/src/features.md index 1d199a80..2c4b2951 100644 --- a/src/features.md +++ b/src/features.md @@ -1,24 +1,24 @@ ## Cargo features -| Feature | Description | -|----------------------|------------------------------------------------------------------------------------| -| `webhooks` | Enables general webhook utilities (almost useless on its own) | -| `webhooks-axum` | Enables webhook implementation based on axum framework | -| `macros` | Re-exports macros from [`teloxide-macros`]. | -| `ctrlc_handler` | Enables the [`Dispatcher::setup_ctrlc_handler`] function (**enabled by default**). | -| `auto-send` | Enables the [`AutoSend`](adaptors::AutoSend) bot adaptor (**enabled by default**). | -| `throttle` | Enables the [`Throttle`](adaptors::Throttle) bot adaptor. | -| `cache-me` | Enables the [`CacheMe`](adaptors::CacheMe) bot adaptor. | -| `trace-adaptor` | Enables the [`Trace`](adaptors::Trace) bot adaptor. | -| `erased` | Enables the [`ErasedRequester`](adaptors::ErasedRequester) bot adaptor. | -| `full` | Enables all the features except `nightly`. | -| `nightly` | Enables nightly-only features (see the [teloxide-core features]). | -| `native-tls` | Enables the [`native-tls`] TLS implementation (**enabled by default**). | -| `rustls` | Enables the [`rustls`] TLS implementation. | -| `redis-storage` | Enables the [Redis] storage support for dialogues. | -| `sqlite-storage` | Enables the [Sqlite] storage support for dialogues. | -| `cbor-serializer` | Enables the [CBOR] serializer for dialogues. | -| `bincode-serializer` | Enables the [Bincode] serializer for dialogues. | +| Feature | Description | +|----------------------|--------------------------------------------------------------------------------------------| +| `webhooks` | Enables general webhook utilities (almost useless on its own) | +| `webhooks-axum` | Enables webhook implementation based on axum framework | +| `macros` | Re-exports macros from [`teloxide-macros`]. | +| `ctrlc_handler` | Enables the [`DispatcherBuilder::enable_ctrlc_handler`] function (**enabled by default**). | +| `auto-send` | Enables the [`AutoSend`](adaptors::AutoSend) bot adaptor (**enabled by default**). | +| `throttle` | Enables the [`Throttle`](adaptors::Throttle) bot adaptor. | +| `cache-me` | Enables the [`CacheMe`](adaptors::CacheMe) bot adaptor. | +| `trace-adaptor` | Enables the [`Trace`](adaptors::Trace) bot adaptor. | +| `erased` | Enables the [`ErasedRequester`](adaptors::ErasedRequester) bot adaptor. | +| `full` | Enables all the features except `nightly`. | +| `nightly` | Enables nightly-only features (see the [teloxide-core features]). | +| `native-tls` | Enables the [`native-tls`] TLS implementation (**enabled by default**). | +| `rustls` | Enables the [`rustls`] TLS implementation. | +| `redis-storage` | Enables the [Redis] storage support for dialogues. | +| `sqlite-storage` | Enables the [Sqlite] storage support for dialogues. | +| `cbor-serializer` | Enables the [CBOR] serializer for dialogues. | +| `bincode-serializer` | Enables the [Bincode] serializer for dialogues. | [Redis]: https://redis.io/ @@ -31,4 +31,4 @@ [`teloxide::utils::UpState`]: utils::UpState [teloxide-core features]: https://docs.rs/teloxide-core/latest/teloxide_core/#cargo-features -[`Dispatcher::setup_ctrlc_handler`]: dispatching::Dispatcher::setup_ctrlc_handler \ No newline at end of file +[`DispatcherBuilder::enable_ctrlc_handler`]: dispatching::DispatcherBuilder::enable_ctrlc_handler \ No newline at end of file From a4ecaa03af807a502874c7af0cd1c43fc4bc5c8a Mon Sep 17 00:00:00 2001 From: Maybe Waffle Date: Thu, 21 Jul 2022 13:22:11 +0400 Subject: [PATCH 22/26] Do not `ignore` tests in `dispatching` When test is ignored rustdoc shows a warning sign which is disturbing. Former-commit-id: 627b8624f3cbc0a0dc51ad5d14894c6294fac689 --- src/dispatching.rs | 42 +++++++++++++++++++++++++++++++++++------- 1 file changed, 35 insertions(+), 7 deletions(-) diff --git a/src/dispatching.rs b/src/dispatching.rs index f8fb3bdf..feef5c38 100644 --- a/src/dispatching.rs +++ b/src/dispatching.rs @@ -7,20 +7,23 @@ //! Take [`examples/purchase.rs`] as an example of dispatching logic. First, we //! define a type named `State` to represent the current state of a dialogue: //! -//! ```ignore +//! ```no_run //! #[derive(Clone, Default)] //! pub enum State { //! #[default] //! Start, //! ReceiveFullName, -//! ReceiveProductChoice { full_name: String }, +//! ReceiveProductChoice { +//! full_name: String, +//! }, //! } //! ``` //! //! Then, we define a type `Command` to represent user commands such as //! `/start` or `/help`: //! -//! ```ignore +//! ```no_run +//! # use teloxide::utils::command::BotCommands; //! #[derive(BotCommands, Clone)] //! #[command(rename = "lowercase", description = "These commands are supported:")] //! enum Command { @@ -39,7 +42,21 @@ //! are in a given dialogue state (and possibly under other circumstances!). The //! solution is to use [`dptree`]: //! -//! ```ignore +//! ```no_run +//! # // That's a lot of context needed to compile this, oof +//! # use teloxide::dispatching::{UpdateHandler, UpdateFilterExt, dialogue::InMemStorage}; +//! # use teloxide::utils::command::BotCommands; +//! # use teloxide::types::Update; +//! # #[derive(Clone, Default)] pub enum State { #[default] Start, ReceiveFullName, ReceiveProductChoice { full_name: String } } +//! # #[derive(BotCommands, Clone)] enum Command { Help, Start, Cancel } +//! # type HandlerResult = Result<(), Box>; +//! # async fn help() -> HandlerResult { Ok(()) } +//! # async fn start() -> HandlerResult { Ok(()) } +//! # async fn cancel() -> HandlerResult { Ok(()) } +//! # async fn receive_full_name() -> HandlerResult { Ok(()) } +//! # async fn invalid_state() -> HandlerResult { Ok(()) } +//! # async fn receive_product_selection() -> HandlerResult { Ok(()) } +//! # //! fn schema() -> UpdateHandler> { //! let command_handler = teloxide::filter_command::() //! .branch( @@ -86,8 +103,14 @@ //! //! Finally, we define our endpoints like this: //! -//! ```ignore -//! // Handler definitions omitted... +//! ```no_run +//! # use teloxide::{Bot, adaptors::AutoSend}; +//! # use teloxide::types::{Message, CallbackQuery}; +//! # use teloxide::dispatching::dialogue::{InMemStorage, Dialogue}; +//! # enum State{} +//! # +//! type MyDialogue = Dialogue>; +//! type HandlerResult = Result<(), Box>; //! //! async fn start(bot: AutoSend, msg: Message, dialogue: MyDialogue) -> HandlerResult { //! todo!() @@ -133,7 +156,12 @@ //! //! Inside `main`, we plug the schema into [`Dispatcher`] like this: //! -//! ```ignore +//! ```no_run +//! # use teloxide::Bot; +//! # use teloxide::requests::RequesterExt; +//! # use teloxide::dispatching::{Dispatcher, dialogue::InMemStorage}; +//! # enum State {} +//! # fn schema() -> teloxide::dispatching::UpdateHandler> { teloxide::dptree::entry() } //! #[tokio::main] //! async fn main() { //! let bot = Bot::from_env().auto_send(); From 04bcce77019d8fde55f35ae81b9d89b35cd64c9a Mon Sep 17 00:00:00 2001 From: Maybe Waffle Date: Thu, 21 Jul 2022 13:31:37 +0400 Subject: [PATCH 23/26] make `schema` in docs nicer Former-commit-id: 84beedfff4864fe2d17b1fc053328b2829f095ec --- src/dispatching.rs | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/src/dispatching.rs b/src/dispatching.rs index feef5c38..e8a744bb 100644 --- a/src/dispatching.rs +++ b/src/dispatching.rs @@ -58,25 +58,29 @@ //! # async fn receive_product_selection() -> HandlerResult { Ok(()) } //! # //! fn schema() -> UpdateHandler> { -//! let command_handler = teloxide::filter_command::() +//! use teloxide::dispatching::dialogue; +//! use teloxide::filter_command; +//! use dptree::case; +//! +//! let command_handler = filter_command::() //! .branch( -//! dptree::case![State::Start] -//! .branch(dptree::case![Command::Help].endpoint(help)) -//! .branch(dptree::case![Command::Start].endpoint(start)), +//! case![State::Start] +//! .branch(case![Command::Help].endpoint(help)) +//! .branch(case![Command::Start].endpoint(start)), //! ) -//! .branch(dptree::case![Command::Cancel].endpoint(cancel)); +//! .branch(case![Command::Cancel].endpoint(cancel)); //! //! let message_handler = Update::filter_message() //! .branch(command_handler) -//! .branch(dptree::case![State::ReceiveFullName].endpoint(receive_full_name)) +//! .branch(case![State::ReceiveFullName].endpoint(receive_full_name)) //! .branch(dptree::endpoint(invalid_state)); //! //! let callback_query_handler = Update::filter_callback_query().branch( -//! dptree::case![State::ReceiveProductChoice { full_name }] +//! case![State::ReceiveProductChoice { full_name }] //! .endpoint(receive_product_selection), //! ); //! -//! teloxide::dispatching::dialogue::enter::, State, _>() +//! dialogue::enter::, State, _>() //! .branch(message_handler) //! .branch(callback_query_handler) //! } From e1419f578f5eef7864434da71a47a123b6a5176c Mon Sep 17 00:00:00 2001 From: Maybe Waffle Date: Thu, 21 Jul 2022 13:35:48 +0400 Subject: [PATCH 24/26] Fix deprecation version Former-commit-id: 0cb4bfef36d28628bd12ebc2ea75932c13ad9072 --- src/dispatching/dispatcher.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/dispatching/dispatcher.rs b/src/dispatching/dispatcher.rs index 3926792d..6ff568e6 100644 --- a/src/dispatching/dispatcher.rs +++ b/src/dispatching/dispatcher.rs @@ -447,7 +447,7 @@ where /// /// [`shutdown`]: ShutdownToken::shutdown #[cfg(feature = "ctrlc_handler")] - #[deprecated(since = "0.10", note = "use `enable_ctrlc_handler` on builder instead")] + #[deprecated(since = "0.10.0", note = "use `enable_ctrlc_handler` on builder instead")] pub fn setup_ctrlc_handler(&mut self) -> &mut Self { self.setup_ctrlc_handler_inner(); self From 3dd8787f132d5e0c86714bd98beae72a37e536a5 Mon Sep 17 00:00:00 2001 From: Hirrolot Date: Thu, 21 Jul 2022 16:53:52 +0600 Subject: [PATCH 25/26] Adjust imports a little bit in `examples/purchase.rs` Former-commit-id: a22c91df6ce693b6abbf91a0707e5a7283fb0c6e --- examples/purchase.rs | 19 ++++++++++--------- src/dispatching.rs | 9 +++------ 2 files changed, 13 insertions(+), 15 deletions(-) diff --git a/examples/purchase.rs b/examples/purchase.rs index f2f68729..0eac1ad3 100644 --- a/examples/purchase.rs +++ b/examples/purchase.rs @@ -13,7 +13,7 @@ // ``` use teloxide::{ - dispatching::{dialogue::InMemStorage, UpdateHandler}, + dispatching::{dialogue, dialogue::InMemStorage, UpdateHandler}, prelude::*, types::{InlineKeyboardButton, InlineKeyboardMarkup}, utils::command::BotCommands, @@ -59,25 +59,26 @@ async fn main() { } fn schema() -> UpdateHandler> { + use dptree::case; + let command_handler = teloxide::filter_command::() .branch( - dptree::case![State::Start] - .branch(dptree::case![Command::Help].endpoint(help)) - .branch(dptree::case![Command::Start].endpoint(start)), + case![State::Start] + .branch(case![Command::Help].endpoint(help)) + .branch(case![Command::Start].endpoint(start)), ) - .branch(dptree::case![Command::Cancel].endpoint(cancel)); + .branch(case![Command::Cancel].endpoint(cancel)); let message_handler = Update::filter_message() .branch(command_handler) - .branch(dptree::case![State::ReceiveFullName].endpoint(receive_full_name)) + .branch(case![State::ReceiveFullName].endpoint(receive_full_name)) .branch(dptree::endpoint(invalid_state)); let callback_query_handler = Update::filter_callback_query().branch( - dptree::case![State::ReceiveProductChoice { full_name }] - .endpoint(receive_product_selection), + case![State::ReceiveProductChoice { full_name }].endpoint(receive_product_selection), ); - teloxide::dispatching::dialogue::enter::, State, _>() + dialogue::enter::, State, _>() .branch(message_handler) .branch(callback_query_handler) } diff --git a/src/dispatching.rs b/src/dispatching.rs index e8a744bb..e0440705 100644 --- a/src/dispatching.rs +++ b/src/dispatching.rs @@ -44,7 +44,7 @@ //! //! ```no_run //! # // That's a lot of context needed to compile this, oof -//! # use teloxide::dispatching::{UpdateHandler, UpdateFilterExt, dialogue::InMemStorage}; +//! # use teloxide::dispatching::{UpdateHandler, UpdateFilterExt, dialogue, dialogue::InMemStorage}; //! # use teloxide::utils::command::BotCommands; //! # use teloxide::types::Update; //! # #[derive(Clone, Default)] pub enum State { #[default] Start, ReceiveFullName, ReceiveProductChoice { full_name: String } } @@ -58,11 +58,9 @@ //! # async fn receive_product_selection() -> HandlerResult { Ok(()) } //! # //! fn schema() -> UpdateHandler> { -//! use teloxide::dispatching::dialogue; -//! use teloxide::filter_command; //! use dptree::case; //! -//! let command_handler = filter_command::() +//! let command_handler = teloxide::filter_command::() //! .branch( //! case![State::Start] //! .branch(case![Command::Help].endpoint(help)) @@ -76,8 +74,7 @@ //! .branch(dptree::endpoint(invalid_state)); //! //! let callback_query_handler = Update::filter_callback_query().branch( -//! case![State::ReceiveProductChoice { full_name }] -//! .endpoint(receive_product_selection), +//! case![State::ReceiveProductChoice { full_name }].endpoint(receive_product_selection), //! ); //! //! dialogue::enter::, State, _>() From f4d99b87665f640727be66fc30394d3177b378e7 Mon Sep 17 00:00:00 2001 From: Hirrolot Date: Thu, 21 Jul 2022 16:54:37 +0600 Subject: [PATCH 26/26] Update `CHANGELOG.md` to v0.10.0 Former-commit-id: 02ec94a08b5728309d700ca2392544ad98419762 --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index db915866..2198111f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## unreleased +## 0.10.0 - 2022-07-21 + ### Added - Security checks based on `secret_token` param of `set_webhook` to built-in webhooks.