1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
use std::{collections::VecDeque, fmt, panic, time::Duration};
use candid::{decode_one, CandidType, Principal};
use serde::{Deserialize, Serialize};
use serde_cbor::Serializer;
use crate::{
custom_print, custom_trap, errors::WsError, utils::get_current_time,
DEFAULT_CLIENT_KEEP_ALIVE_TIMEOUT_MS, DEFAULT_MAX_NUMBER_OF_RETURNED_MESSAGES,
DEFAULT_SEND_ACK_INTERVAL_MS, INITIAL_OUTGOING_MESSAGE_NONCE,
};
pub type ClientPrincipal = Principal;
#[derive(CandidType, Clone, Deserialize, Serialize, Eq, PartialEq, Debug, Hash)]
pub(crate) struct ClientKey {
pub(crate) client_principal: ClientPrincipal,
pub(crate) client_nonce: u64,
}
impl ClientKey {
/// Creates a new instance of ClientKey.
pub(crate) fn new(client_principal: ClientPrincipal, client_nonce: u64) -> Self {
Self {
client_principal,
client_nonce,
}
}
}
impl fmt::Display for ClientKey {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}_{}", self.client_principal, self.client_nonce)
}
}
/// The result of [ws_open].
pub type CanisterWsOpenResult = Result<(), String>;
/// The result of [ws_close].
pub type CanisterWsCloseResult = Result<(), String>;
/// The result of [ws_message].
pub type CanisterWsMessageResult = Result<(), String>;
/// The result of [ws_get_messages].
pub type CanisterWsGetMessagesResult = Result<CanisterOutputCertifiedMessages, String>;
/// The result of [ws_send].
pub type CanisterWsSendResult = Result<(), String>;
/// The arguments for [ws_open].
#[derive(CandidType, Clone, Deserialize, Serialize, Eq, PartialEq, Debug)]
pub struct CanisterWsOpenArguments {
pub(crate) client_nonce: u64,
pub(crate) gateway_principal: GatewayPrincipal,
}
/// The arguments for [ws_close].
#[derive(CandidType, Clone, Deserialize, Serialize, Eq, PartialEq, Debug)]
pub struct CanisterWsCloseArguments {
pub(crate) client_key: ClientKey,
}
/// The arguments for [ws_message].
#[derive(CandidType, Clone, Deserialize, Serialize, Eq, PartialEq, Debug)]
pub struct CanisterWsMessageArguments {
pub(crate) msg: WebsocketMessage,
}
/// The arguments for [ws_get_messages].
#[derive(CandidType, Clone, Deserialize, Serialize, Eq, PartialEq, Debug)]
pub struct CanisterWsGetMessagesArguments {
pub(crate) nonce: u64,
}
/// Messages exchanged through the WebSocket.
#[derive(CandidType, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
pub(crate) struct WebsocketMessage {
pub(crate) client_key: ClientKey, // The client that the gateway will forward the message to or that sent the message.
pub(crate) sequence_num: u64, // Both ways, messages should arrive with sequence numbers 0, 1, 2...
pub(crate) timestamp: u64, // Timestamp of when the message was made for the recipient to inspect.
pub(crate) is_service_message: bool, // Whether the message is a service message sent by the CDK to the client or vice versa.
#[serde(with = "serde_bytes")]
pub(crate) content: Vec<u8>, // Application message encoded in binary.
}
impl WebsocketMessage {
/// Serializes the message into a Vec<u8>, using CBOR.
pub(crate) fn cbor_serialize(&self) -> Result<Vec<u8>, String> {
let mut data = vec![];
let mut serializer = Serializer::new(&mut data);
serializer.self_describe().map_err(|e| e.to_string())?;
self.serialize(&mut serializer).map_err(|e| e.to_string())?;
Ok(data)
}
}
/// Element of the list of messages returned to the WS Gateway after polling.
#[derive(CandidType, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
pub(crate) struct CanisterOutputMessage {
pub(crate) client_key: ClientKey, // The client that the gateway will forward the message to or that sent the message.
pub(crate) key: String, // Key for certificate verification.
#[serde(with = "serde_bytes")]
pub(crate) content: Vec<u8>, // The message to be relayed, that contains the application message.
}
/// List of messages returned to the WS Gateway after polling.
#[derive(CandidType, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
pub struct CanisterOutputCertifiedMessages {
pub(crate) messages: Vec<CanisterOutputMessage>, // List of messages.
#[serde(with = "serde_bytes")]
pub(crate) cert: Vec<u8>, // cert+tree constitute the certificate for all returned messages.
#[serde(with = "serde_bytes")]
pub(crate) tree: Vec<u8>, // cert+tree constitute the certificate for all returned messages.
pub(crate) is_end_of_queue: bool, // Whether the end of the messages queue has been reached.
}
impl CanisterOutputCertifiedMessages {
pub fn empty() -> Self {
Self {
messages: vec![],
cert: vec![],
tree: vec![],
is_end_of_queue: true,
}
}
}
pub(crate) struct MessagesForGatewayRange {
pub start_index: usize,
pub end_index: usize,
pub is_end_of_queue: bool,
}
#[derive(Clone, Debug, Default, Eq, PartialEq)]
pub(crate) struct MessageToDelete {
timestamp: u64,
}
pub(crate) type GatewayPrincipal = Principal;
#[derive(Clone, Debug, Default, Eq, PartialEq)]
/// Contains data about the registered WS Gateway.
pub(crate) struct RegisteredGateway {
/// The queue of the messages that the gateway can poll.
pub(crate) messages_queue: VecDeque<CanisterOutputMessage>,
/// The queue of messages' keys to delete.
pub(crate) messages_to_delete: VecDeque<MessageToDelete>,
/// Keeps track of the nonce which:
/// - the WS Gateway uses to specify the first index of the certified messages to be returned when polling
/// - the client uses as part of the path in the Merkle tree in order to verify the certificate of the messages relayed by the WS Gateway
pub(crate) outgoing_message_nonce: u64,
/// The number of clients connected to this gateway.
pub(crate) connected_clients_count: u64,
}
impl RegisteredGateway {
/// Creates a new instance of RegisteredGateway.
pub(crate) fn new() -> Self {
Self {
messages_queue: VecDeque::new(),
messages_to_delete: VecDeque::new(),
outgoing_message_nonce: INITIAL_OUTGOING_MESSAGE_NONCE,
connected_clients_count: 0,
}
}
/// Increments the outgoing message nonce by 1.
pub(crate) fn increment_nonce(&mut self) {
self.outgoing_message_nonce += 1;
}
/// Increments the connected clients count by 1.
pub(crate) fn increment_clients_count(&mut self) {
self.connected_clients_count += 1;
}
/// Decrements the connected clients count by 1, returning the new value.
pub(crate) fn decrement_clients_count(&mut self) -> u64 {
self.connected_clients_count -= 1;
self.connected_clients_count
}
/// Adds the message to the queue and its metadata to the `messages_to_delete` queue.
pub(crate) fn add_message_to_queue(
&mut self,
message: CanisterOutputMessage,
message_timestamp: u64,
) {
self.messages_queue.push_back(message.clone());
self.messages_to_delete.push_back(MessageToDelete {
timestamp: message_timestamp,
});
}
/// Deletes the oldest `n` messages that are older than `message_max_age_ms` from the queue.
///
/// Returns the deleted messages keys.
pub(crate) fn delete_old_messages(&mut self, n: usize, message_max_age_ms: u64) -> Vec<String> {
let time = get_current_time();
let mut deleted_keys = vec![];
for _ in 0..n {
if let Some(message_to_delete) = self.messages_to_delete.front() {
if Duration::from_nanos(time - message_to_delete.timestamp)
> Duration::from_millis(message_max_age_ms)
{
// unwrap is safe because there is no case in which the messages_to_delete queue is populated
// while the messages_queue is empty
let deleted_message = self.messages_queue.pop_front().unwrap();
deleted_keys.push(deleted_message.key.clone());
self.messages_to_delete.pop_front();
} else {
// In this case, no messages can be deleted because
// they're all not older than `message_max_age_ms`.
break;
}
} else {
// There are no messages in the queue. Shouldn't happen.
break;
}
}
deleted_keys
}
}
/// The metadata about a registered client.
#[derive(Clone, Debug, Eq, PartialEq)]
pub(crate) struct RegisteredClient {
pub(crate) last_keep_alive_timestamp: u64,
pub(crate) gateway_principal: GatewayPrincipal,
}
impl RegisteredClient {
/// Creates a new instance of RegisteredClient.
pub(crate) fn new(gateway_principal: GatewayPrincipal) -> Self {
Self {
last_keep_alive_timestamp: get_current_time(),
gateway_principal,
}
}
/// Gets the last keep alive timestamp.
pub(crate) fn get_last_keep_alive_timestamp(&self) -> u64 {
self.last_keep_alive_timestamp
}
/// Set the last keep alive timestamp to the current time.
pub(crate) fn update_last_keep_alive_timestamp(&mut self) {
self.last_keep_alive_timestamp = get_current_time();
}
}
#[derive(CandidType, Debug, Deserialize, PartialEq, Eq)]
pub(crate) struct CanisterOpenMessageContent {
pub(crate) client_key: ClientKey,
}
#[derive(CandidType, Debug, Deserialize, PartialEq, Eq)]
pub(crate) struct CanisterAckMessageContent {
pub(crate) last_incoming_sequence_num: u64,
}
#[derive(CandidType, Debug, Deserialize, PartialEq, Eq)]
pub(crate) struct ClientKeepAliveMessageContent {
pub(crate) last_incoming_sequence_num: u64,
}
/// A service message sent by the CDK to the client or vice versa.
#[derive(CandidType, Debug, Deserialize, PartialEq, Eq)]
pub(crate) enum WebsocketServiceMessageContent {
/// Message sent by the **canister** when a client opens a connection.
OpenMessage(CanisterOpenMessageContent),
/// Message sent _periodically_ by the **canister** to the client to acknowledge the messages received.
AckMessage(CanisterAckMessageContent),
/// Message sent by the **client** in response to an acknowledgement message from the canister.
KeepAliveMessage(ClientKeepAliveMessageContent),
}
impl WebsocketServiceMessageContent {
pub(crate) fn from_candid_bytes(bytes: &[u8]) -> Result<Self, String> {
decode_one(&bytes).map_err(|err| WsError::DecodeServiceMessageContent { err }.to_string())
}
}
/// Arguments passed to the `on_open` handler.
pub struct OnOpenCallbackArgs {
pub client_principal: ClientPrincipal,
}
/// Handler initialized by the canister
/// and triggered by the CDK once the IC WebSocket connection is established.
type OnOpenCallback = fn(OnOpenCallbackArgs);
/// Arguments passed to the `on_message` handler.
/// The `message` argument is the message received from the client, serialized in Candid.
/// To deserialize the message, use [candid::decode_one].
///
/// # Example
/// This example is the deserialize equivalent of the [ws_send's example](fn.ws_send.html#example) serialize one.
/// ```rust
/// use candid::{decode_one, CandidType};
/// use ic_websocket_cdk::OnMessageCallbackArgs;
/// use serde::Deserialize;
///
/// #[derive(CandidType, Deserialize)]
/// struct MyMessage {
/// some_field: String,
/// }
///
/// fn on_message(args: OnMessageCallbackArgs) {
/// let received_message: MyMessage = decode_one(&args.message).unwrap();
///
/// println!("Received message: some_field: {:?}", received_message.some_field);
/// }
/// ```
pub struct OnMessageCallbackArgs {
/// The principal of the client sending the message to the canister.
pub client_principal: ClientPrincipal,
/// The message received from the client, serialized in Candid. See [OnMessageCallbackArgs] for an example on how to deserialize the message.
pub message: Vec<u8>,
}
/// Handler initialized by the canister
/// and triggered by the CDK once an IC WebSocket message is received.
type OnMessageCallback = fn(OnMessageCallbackArgs);
/// Arguments passed to the `on_close` handler.
pub struct OnCloseCallbackArgs {
pub client_principal: ClientPrincipal,
}
/// Handler initialized by the canister
/// and triggered by the CDK once the WS Gateway closes the IC WebSocket connection
/// for that client.
type OnCloseCallback = fn(OnCloseCallbackArgs);
/// Handlers initialized by the canister and triggered by the CDK.
#[derive(Clone, Debug, Default, PartialEq)]
pub struct WsHandlers {
pub on_open: Option<OnOpenCallback>,
pub on_message: Option<OnMessageCallback>,
pub on_close: Option<OnCloseCallback>,
}
impl WsHandlers {
pub(crate) fn call_on_open(&self, args: OnOpenCallbackArgs) {
if let Some(on_open) = self.on_open {
let res = panic::catch_unwind(|| {
on_open(args);
});
if let Err(e) = res {
custom_print!("Error calling on_open handler: {:?}", e);
}
}
}
pub(crate) fn call_on_message(&self, args: OnMessageCallbackArgs) {
if let Some(on_message) = self.on_message {
let res = panic::catch_unwind(|| {
on_message(args);
});
if let Err(e) = res {
custom_print!("Error calling on_message handler: {:?}", e);
}
}
}
pub(crate) fn call_on_close(&self, args: OnCloseCallbackArgs) {
if let Some(on_close) = self.on_close {
let res = panic::catch_unwind(|| {
on_close(args);
});
if let Err(e) = res {
custom_print!("Error calling on_close handler: {:?}", e);
}
}
}
}
/// Parameters for the IC WebSocket CDK initialization. For default parameters and simpler initialization, use [`WsInitParams::new`].
#[derive(Clone)]
pub struct WsInitParams {
/// The callback handlers for the WebSocket.
pub handlers: WsHandlers,
/// The maximum number of messages to be returned in a polling iteration.
/// Defaults to `50`.
pub max_number_of_returned_messages: usize,
/// The interval at which to send an acknowledgement message to the client,
/// so that the client knows that all the messages it sent have been received by the canister (in milliseconds).
///
/// Must be greater than `keep_alive_timeout_ms`.
///
/// Defaults to `300_000` (5 minutes).
pub send_ack_interval_ms: u64,
/// The delay to wait for the client to send a keep alive after receiving an acknowledgement (in milliseconds).
///
/// Must be lower than `send_ack_interval_ms`.
///
/// Defaults to `60_000` (1 minute).
pub keep_alive_timeout_ms: u64,
}
impl WsInitParams {
/// Creates a new instance of WsInitParams, with default interval values.
pub fn new(handlers: WsHandlers) -> Self {
Self {
handlers,
..Default::default()
}
}
pub(crate) fn get_handlers(&self) -> WsHandlers {
self.handlers.clone()
}
/// Checks the validity of the timer parameters.
/// `send_ack_interval_ms` must be greater than `keep_alive_timeout_ms`.
///
/// # Traps
/// If `send_ack_interval_ms` <= `keep_alive_timeout_ms`.
pub(crate) fn check_validity(&self) {
if self.keep_alive_timeout_ms >= self.send_ack_interval_ms {
custom_trap!("send_ack_interval_ms must be greater than keep_alive_timeout_ms");
}
}
pub fn with_max_number_of_returned_messages(
mut self,
max_number_of_returned_messages: usize,
) -> Self {
self.max_number_of_returned_messages = max_number_of_returned_messages;
self
}
pub fn with_send_ack_interval_ms(mut self, send_ack_interval_ms: u64) -> Self {
self.send_ack_interval_ms = send_ack_interval_ms;
self
}
pub fn with_keep_alive_timeout_ms(mut self, keep_alive_timeout_ms: u64) -> Self {
self.keep_alive_timeout_ms = keep_alive_timeout_ms;
self
}
}
impl Default for WsInitParams {
fn default() -> Self {
Self {
handlers: WsHandlers::default(),
max_number_of_returned_messages: DEFAULT_MAX_NUMBER_OF_RETURNED_MESSAGES,
send_ack_interval_ms: DEFAULT_SEND_ACK_INTERVAL_MS,
keep_alive_timeout_ms: DEFAULT_CLIENT_KEEP_ALIVE_TIMEOUT_MS,
}
}
}