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
// This file is part of Gear.
// Copyright (C) 2022-2024 Gear Technologies Inc.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
mod iterator;
mod subscription;
pub use gsdk::metadata::{gear::Event as GearEvent, Event};
pub use iterator::*;
use crate::{Error, Result};
use async_trait::async_trait;
use gear_core::ids::MessageId;
use gear_core_errors::ReplyCode;
use gsdk::metadata::runtime_types::{
gear_common::event::DispatchStatus as GenDispatchStatus,
gear_core::message::{
common::ReplyDetails as GenReplyDetails, user::UserMessage as GenUserMessage,
},
gprimitives::MessageId as GenMId,
};
/// Dispatch status returned after processing a message.
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
pub enum DispatchStatus {
/// Successful execution.
Success,
/// Execution failed.
Failed,
/// Message has not been processed.
NotExecuted,
}
impl From<GenDispatchStatus> for DispatchStatus {
fn from(other: GenDispatchStatus) -> Self {
match other {
GenDispatchStatus::Success => Self::Success,
GenDispatchStatus::Failed => Self::Failed,
GenDispatchStatus::NotExecuted => Self::NotExecuted,
}
}
}
impl DispatchStatus {
/// Check whether `DispatchStatus` is
/// [`Success`](DispatchStatus::Success).
pub fn succeed(&self) -> bool {
matches!(self, DispatchStatus::Success)
}
/// Check whether `DispatchStatus` is [`Failed`](DispatchStatus::Failed).
pub fn failed(&self) -> bool {
matches!(self, DispatchStatus::Failed)
}
/// Check whether `DispatchStatus` is
/// [`NotExecuted`](DispatchStatus::NotExecuted).
pub fn not_executed(&self) -> bool {
matches!(self, DispatchStatus::NotExecuted)
}
}
/// Events processing trait.
///
/// This trait minimizes a boilerplate code when processing events by providing
/// several default implementations.
///
/// See implementation example in [`EventListener`].
#[async_trait(?Send)]
pub trait EventProcessor {
/// This function is called if a received event has an unexpected type.
///
/// # Examples
///
/// Implement this function to return a not-found error:
///
/// ```
/// # use gclient::Error;
/// fn not_waited() -> Error {
/// Error::EventNotFoundInIterator
/// }
/// ```
fn not_waited() -> Error;
/// Event processing function.
///
/// `predicate` contains specific processing logic depending on an event
/// type.
///
/// Implementor is responsible for applying the `predicate` to every event
/// to be processed and collecting their results.
///
/// This function is one of the central functions to be defined by the trait
/// implementor.
async fn proc<T>(&mut self, predicate: impl Fn(Event) -> Option<T> + Copy) -> Result<T>;
/// Multiple events processing function.
///
/// `predicate` contains specific processing logic depending on an event
/// type. `validator` checks whether an additional condition is met for the
/// batch of results.
async fn proc_many<T>(
&mut self,
predicate: impl Fn(Event) -> Option<T>,
validate: impl Fn(Vec<T>) -> (Vec<T>, bool),
) -> Result<Vec<T>>;
/// Check whether the message identified by `message_id` has been processed.
async fn message_processed(&mut self, message_id: MessageId) -> Result<DispatchStatus> {
let message_id: GenMId = message_id.into();
self.proc(|e| {
if let Event::Gear(GearEvent::MessagesDispatched { statuses, .. }) = e {
statuses
.into_iter()
.find(|(mid, _)| mid == &message_id)
.map(|(_, status)| status.into())
} else {
None
}
})
.await
}
/// Check whether the batch of messages identified by corresponding
/// `message_ids` has been processed.
async fn message_processed_batch(
&mut self,
message_ids: impl IntoIterator<Item = MessageId>,
) -> Result<Vec<(MessageId, DispatchStatus)>> {
let message_ids: Vec<GenMId> = message_ids.into_iter().map(Into::into).collect();
Ok(self
.proc_many(
|e| {
if let Event::Gear(GearEvent::MessagesDispatched { statuses, .. }) = e {
let requested: Vec<_> = statuses
.into_iter()
.filter_map(|(mid, status)| {
message_ids
.contains(&mid)
.then(|| (mid.into(), status.into()))
})
.collect();
(!requested.is_empty()).then_some(requested)
} else {
None
}
},
|v| {
let count = v.iter().flatten().count() == message_ids.len();
(v, count)
},
)
.await?
.into_iter()
.flatten()
.collect())
}
/// Get details of a reply to the message identified by `message_id`.
///
/// If a reply has been received, this function returns its identifier
/// ([`MessageId`]), payload's bytes (in case of zero status code) or an
/// error message (otherwise), and an associated value.
async fn reply_bytes_on(
&mut self,
message_id: MessageId,
) -> Result<(MessageId, Result<Vec<u8>, String>, u128)> {
let message_id: GenMId = message_id.into();
self.proc(|e| {
if let Event::Gear(GearEvent::UserMessageSent {
message:
GenUserMessage {
id,
payload,
value,
details: Some(GenReplyDetails { to, code }),
..
},
..
}) = e
{
to.eq(&message_id).then(|| {
let res = ReplyCode::from(code)
.is_success()
.then(|| payload.0.clone())
.ok_or_else(|| String::from_utf8(payload.0).expect("Infallible"));
(id.into(), res, value)
})
} else {
None
}
})
.await
}
/// Check whether the processing of a message identified by `message_id`
/// resulted in an error or has been successful.
///
/// This function returns an error message in case of an error. It is needed
/// only due to the possibility of a message's
/// [`NotExecuted`](DispatchStatus::NotExecuted) state.
async fn err_or_succeed(&mut self, message_id: MessageId) -> Result<Option<String>> {
let message_id: GenMId = message_id.into();
self.proc(|e| match e {
Event::Gear(GearEvent::UserMessageSent {
message:
GenUserMessage {
payload,
details: Some(GenReplyDetails { to, code }),
..
},
..
}) => {
if to == message_id && ReplyCode::from(code).is_success() {
Some(Some(String::from_utf8(payload.0).expect("Infallible")))
} else {
None
}
}
Event::Gear(GearEvent::MessagesDispatched { statuses, .. }) => match statuses
.into_iter()
.find(|(mid, _)| mid == &message_id)
.map(|(_, status)| status)
{
Some(GenDispatchStatus::Failed) | None => None,
_ => Some(None),
},
_ => None,
})
.await
}
/// Check whether processing batch of messages identified by corresponding
/// `message_ids` resulted in errors or has been successful.
///
/// This function returns a vector of statuses with an associated message
/// identifier ([`MessageId`]). Each status can be an error message in case
/// of an error.
async fn err_or_succeed_batch(
&mut self,
message_ids: impl IntoIterator<Item = MessageId>,
) -> Result<Vec<(MessageId, Option<String>)>> {
let message_ids: Vec<GenMId> = message_ids.into_iter().map(Into::into).collect();
Ok(self
.proc_many(
|e| match e {
Event::Gear(GearEvent::UserMessageSent {
message:
GenUserMessage {
payload,
details: Some(GenReplyDetails { to, code }),
..
},
..
}) => {
if message_ids.contains(&to) && ReplyCode::from(code).is_success() {
Some(vec![(
to.into(),
Some(String::from_utf8(payload.0).expect("Infallible")),
)])
} else {
None
}
}
Event::Gear(GearEvent::MessagesDispatched { statuses, .. }) => {
let requested: Vec<_> = statuses
.into_iter()
.filter_map(|(mid, status)| {
if message_ids.contains(&mid)
&& !matches!(status, GenDispatchStatus::Failed)
{
Some((MessageId::from(mid), None))
} else {
None
}
})
.collect();
(!requested.is_empty()).then_some(requested)
}
_ => None,
},
|v| {
let count = v.iter().flatten().count() == message_ids.len();
(v, count)
},
)
.await?
.into_iter()
.flatten()
.collect())
}
}