casper_rust_wasm_sdk/sdk/deploy_watcher/watcher.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
use crate::SDK;
use chrono::{Duration, Utc};
use futures_util::StreamExt;
#[cfg(target_arch = "wasm32")]
use gloo_utils::format::JsValueSerdeExt;
#[cfg(target_arch = "wasm32")]
use js_sys::Promise;
use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::{
cell::RefCell,
fmt,
rc::Rc,
sync::{Arc, Mutex},
};
use wasm_bindgen::prelude::*;
#[cfg(target_arch = "wasm32")]
use wasm_bindgen_futures::future_to_promise;
const DEFAULT_TIMEOUT_MS: u64 = 60000;
impl SDK {
/// Creates a new DeployWatcher instance to watch deploys.
///
/// # Arguments
///
/// * `events_url` - The URL to monitor for deploy events.
/// * `timeout_duration` - An optional timeout duration in seconds.
///
/// # Returns
///
/// A `DeployWatcher` instance.
pub fn watch_deploy(&self, events_url: &str, timeout_duration: Option<u64>) -> DeployWatcher {
DeployWatcher::new(events_url.to_string(), timeout_duration)
}
/// Waits for a deploy event to be processed asynchronously.
///
/// # Arguments
///
/// * `events_url` - The URL to monitor for deploy events.
/// * `deploy_hash` - The deploy hash to wait for.
/// * `timeout_duration` - An optional timeout duration in milliseconds.
///
/// # Returns
///
/// A `Result` containing either the processed `EventParseResult` or an error message.
pub async fn wait_deploy(
&self,
events_url: &str,
deploy_hash: &str,
timeout_duration: Option<u64>,
) -> Result<EventParseResult, String> {
Self::wait_deploy_internal(
events_url.to_string(),
deploy_hash.to_string(),
timeout_duration,
)
.await
}
/// Internal function to wait for a deploy event.
///
/// # Arguments
///
/// * `events_url` - The URL to monitor for deploy events.
/// * `deploy_hash` - The deploy hash to wait for.
/// * `timeout_duration` - An optional timeout duration in milliseconds.
///
/// # Returns
///
/// A `Result` containing either the processed `EventParseResult` or an error message.
async fn wait_deploy_internal(
events_url: String,
deploy_hash: String,
timeout_duration: Option<u64>,
) -> Result<EventParseResult, String> {
let watcher = DeployWatcher::new(events_url, timeout_duration);
let result = watcher.start_internal(Some(deploy_hash)).await;
match result {
Some(event_parse_results) => {
if let Some(event_parse_result) = event_parse_results.first() {
return Ok(event_parse_result.clone());
}
Err("No first event result".to_string())
}
None => Err("No event result found".to_string()),
}
}
}
#[wasm_bindgen]
impl SDK {
/// Creates a new DeployWatcher instance to watch deploys (JavaScript-friendly).
///
/// # Arguments
///
/// * `events_url` - The URL to monitor for deploy events.
/// * `timeout_duration` - An optional timeout duration in seconds.
///
/// # Returns
///
/// A `DeployWatcher` instance.
#[cfg(target_arch = "wasm32")]
#[wasm_bindgen(js_name = "watchDeploy")]
pub fn watch_deploy_js_alias(
&self,
events_url: &str,
timeout_duration: Option<u32>,
) -> DeployWatcher {
self.watch_deploy(events_url, timeout_duration.map(Into::into))
}
/// Waits for a deploy event to be processed asynchronously (JavaScript-friendly).
///
/// # Arguments
///
/// * `events_url` - The URL to monitor for deploy events.
/// * `deploy_hash` - The deploy hash to wait for.
/// * `timeout_duration` - An optional timeout duration in seconds.
///
/// # Returns
///
/// A JavaScript `Promise` resolving to either the processed `EventParseResult` or an error message.
#[cfg(target_arch = "wasm32")]
#[wasm_bindgen(js_name = "waitDeploy")]
pub async fn wait_deploy_js_alias(
&self,
events_url: &str,
deploy_hash: &str,
timeout_duration: Option<u32>,
) -> Promise {
let events_url = events_url.to_string();
let deploy_hash = deploy_hash.to_string();
let future = async move {
let result = Self::wait_deploy_internal(
events_url,
deploy_hash,
timeout_duration.map(Into::into),
)
.await;
match result {
Ok(event_parse_result) => JsValue::from_serde(&event_parse_result)
.map_err(|err| JsValue::from_str(&format!("{err}"))),
Err(err) => Err(JsValue::from_str(&err)),
}
};
future_to_promise(future)
}
}
/// Represents a deploy watcher responsible for monitoring deploy events.
///
/// This struct allows clients to subscribe to deploy events, start watching for events,
/// or wait for an event and handle the received deploy event data.
///
/// # Fields
///
/// * `events_url` - The URL for deploy events.
/// * `deploy_subscriptions` - Vector containing deploy subscriptions.
/// * `active` - Reference-counted cell indicating whether the deploy watcher is active.
/// * `timeout_duration` - Duration representing the optional timeout for watching events.
#[derive(Clone)]
#[wasm_bindgen]
pub struct DeployWatcher {
events_url: String,
deploy_subscriptions: Vec<DeploySubscription>,
active: Rc<RefCell<bool>>,
timeout_duration: Duration,
}
#[wasm_bindgen]
impl DeployWatcher {
/// Creates a new `DeployWatcher` instance.
///
/// # Arguments
///
/// * `events_url` - The URL for deploy events.
/// * `timeout_duration` - Optional duration in milliseconds for watching events. If not provided,
/// a default timeout of 60,000 milliseconds (1 minute) is used.
///
/// # Returns
///
/// A new `DeployWatcher` instance.
#[wasm_bindgen(constructor)]
pub fn new(events_url: String, timeout_duration: Option<u64>) -> Self {
let timeout_duration = Duration::try_milliseconds(
timeout_duration
.unwrap_or(DEFAULT_TIMEOUT_MS)
.try_into()
.unwrap(),
)
.unwrap_or_default();
DeployWatcher {
events_url,
deploy_subscriptions: Vec::new(),
active: Rc::new(RefCell::new(true)),
timeout_duration,
}
}
/// Subscribes to deploy events.
///
/// # Arguments
///
/// * `deploy_subscriptions` - Vector of deploy subscriptions to be added.
///
/// # Returns
///
/// Result indicating success or an error message.
#[cfg(target_arch = "wasm32")]
#[wasm_bindgen(js_name = "subscribe")]
pub fn subscribe_js_alias(
&mut self,
deploy_subscriptions: Vec<DeploySubscription>,
) -> Result<(), String> {
self.subscribe(deploy_subscriptions)
}
/// Unsubscribes from deploy events based on the provided deploy hash.
///
/// # Arguments
///
/// * `deploy_hash` - The deploy hash to unsubscribe.
///
/// This method removes the deploy subscription associated with the provided deploy hash.
#[wasm_bindgen]
pub fn unsubscribe(&mut self, deploy_hash: String) {
self.deploy_subscriptions
.retain(|s| s.deploy_hash != deploy_hash);
}
/// Starts watching for deploy events (JavaScript-friendly).
///
/// # Returns
///
/// Result containing the serialized deploy events data or an error message.
#[cfg(target_arch = "wasm32")]
#[wasm_bindgen(js_name = "start")]
pub async fn start_js_alias(&self) -> Result<JsValue, JsError> {
let result = match self.start_internal(None).await {
Some(res) => res,
None => return Ok(JsValue::NULL),
};
let serialized = JsValue::from_serde(&result)
.map_err(|err| JsError::new(&format!("Error serializing events: {:?}", err)))?;
Ok(serialized)
}
/// Stops watching for deploy events.
///
/// This method sets the deploy watcher as inactive and stops the event listener if it exists.
#[wasm_bindgen]
pub fn stop(&self) {
*self.active.borrow_mut() = false;
}
}
impl DeployWatcher {
/// Asynchronously starts watching for deploy events and execute callback handler functions from deploy subscriptions
///
/// # Returns
///
/// An `Option` containing the serialized deploy event data or `None` if no events are received.
pub async fn start(&self) -> Option<Vec<EventParseResult>> {
self.start_internal(None).await
}
/// Asynchronously starts watching for deploy events
///
/// # Arguments
///
/// * `deploy_hash` - Optional deploy hash to directly return processed event. If provided, it directly returns matched events without executing callback handler functions from deploy subscriptions. If `None`, it executes callback handler functions from deploy subscriptions.
///
/// # Returns
///
/// An `Option` containing the serialized deploy event data or `None` if no events are received.
async fn start_internal(&self, deploy_hash: Option<String>) -> Option<Vec<EventParseResult>> {
*self.active.borrow_mut() = true;
let client = reqwest::Client::new();
let url = self.events_url.clone();
let deploy_watcher = Rc::new(RefCell::new(self.clone()));
let start_time = Utc::now();
let timeout_duration = self.timeout_duration;
let response = match client.get(&url).send().await {
Ok(res) => res,
Err(err) => {
let err = err.to_string();
let event_parse_result = EventParseResult {
err: Some(err.to_string()),
body: None,
};
return Some([event_parse_result].to_vec());
}
};
if response.status().is_success() {
let buffer_size = 1;
let mut buffer = Vec::with_capacity(buffer_size);
let mut bytes_stream = response.bytes_stream();
while let Some(chunk) = bytes_stream.next().await {
match chunk {
Ok(bytes) => {
let this_clone = Rc::clone(&deploy_watcher);
if !*this_clone.borrow_mut().active.borrow() {
return None;
}
if Utc::now() - start_time >= timeout_duration {
let event_parse_result = EventParseResult {
err: Some("Timeout expired".to_string()),
body: None,
};
return Some([event_parse_result].to_vec());
}
buffer.extend_from_slice(&bytes);
while let Some(index) = buffer.iter().position(|&b| b == b'\n') {
let message = buffer.drain(..=index).collect::<Vec<_>>();
if let Ok(message) = std::str::from_utf8(&message) {
let deploy_watcher_clone = this_clone.borrow_mut().clone();
let result = deploy_watcher_clone
.process_events(message, deploy_hash.as_deref());
match result {
Some(event_parse_result) => return Some(event_parse_result),
None => {
continue;
}
};
} else {
let event_parse_result = EventParseResult {
err: Some("Error decoding UTF-8 data".to_string()),
body: None,
};
return Some([event_parse_result].to_vec());
}
}
}
Err(err) => {
let event_parse_result = EventParseResult {
err: Some(format!("Error reading chunk: {}", err)),
body: None,
};
return Some([event_parse_result].to_vec());
}
}
}
} else {
let event_parse_result = EventParseResult {
err: Some("Failed to fetch stream".to_string()),
body: None,
};
return Some([event_parse_result].to_vec());
}
None
}
/// Subscribes to deploy events.
///
/// # Arguments
///
/// * `deploy_subscriptions` - Vector of deploy subscriptions to be added.
///
/// # Returns
///
/// Result indicating success or an error message.
pub fn subscribe(
&mut self,
deploy_subscriptions: Vec<DeploySubscription>,
) -> Result<(), String> {
for new_subscription in &deploy_subscriptions {
if self
.deploy_subscriptions
.iter()
.any(|s| s.deploy_hash == new_subscription.deploy_hash)
{
return Err(String::from("Already subscribed to this event"));
}
}
self.deploy_subscriptions.extend(deploy_subscriptions);
Ok(())
}
/// Processes events received from the stream and notifies subscribers.
///
/// # Arguments
///
/// * `message` - The raw message received from the event stream.
/// * `target_deploy_hash` - Optional deploy hash to directly return. If provided, it directly returns matched events without executing callback handler functions from deploy subscriptions. If `None`, it executes callback handler functions from deploy subscriptions.
///
/// # Returns
///
/// An `Option` containing the serialized deploy event data or `None` if an error occurs.
fn process_events(
mut self,
message: &str,
target_deploy_hash: Option<&str>,
) -> Option<Vec<EventParseResult>> {
let data_stream = Self::extract_data_stream(message);
for data_item in data_stream {
let trimmed_item = data_item.trim();
let deploy_processed_str = EventName::DeployProcessed.to_string();
if !trimmed_item.contains(&deploy_processed_str) {
continue;
}
if let Ok(parsed_json) = serde_json::from_str::<Value>(trimmed_item) {
let deploy = parsed_json.get(deploy_processed_str);
if let Some(deploy_processed) = deploy.and_then(|deploy| deploy.as_object()) {
if let Some(deploy_hash_processed) = deploy_processed
.get("deploy_hash")
.and_then(|deploy_hash| deploy_hash.as_str())
{
let mut deploy_hash_found = target_deploy_hash
.map_or(false, |target_hash| target_hash == deploy_hash_processed);
let deploy_processed: Option<DeployProcessed> =
serde_json::from_value(deploy.unwrap().clone()).ok();
let body = Some(Body { deploy_processed });
let event_parse_result = EventParseResult { err: None, body };
if deploy_hash_found {
self.unsubscribe(target_deploy_hash.unwrap().to_string());
self.stop();
return Some([event_parse_result].to_vec());
}
let mut results: Vec<EventParseResult> = [].to_vec();
for subscription in self.deploy_subscriptions.clone().iter() {
if deploy_hash_processed == subscription.deploy_hash {
let event_handler = &subscription.event_handler_fn;
#[cfg(not(target_arch = "wasm32"))]
{
event_handler.call(event_parse_result.clone());
}
#[cfg(target_arch = "wasm32")]
{
let this = JsValue::null();
let args = js_sys::Array::new();
args.push(
&JsValue::from_serde(&event_parse_result.clone()).unwrap(),
);
event_handler.apply(&this, &args).unwrap();
}
self.unsubscribe(deploy_hash_processed.to_string());
deploy_hash_found = true;
results.push(event_parse_result.clone())
}
}
if deploy_hash_found && self.deploy_subscriptions.is_empty() {
self.stop();
return Some(results);
}
}
}
} else {
let event_parse_result = EventParseResult {
err: Some("Failed to parse JSON data.".to_string()),
body: None,
};
return Some([event_parse_result].to_vec());
}
}
None
}
/// Extracts the data stream from the raw JSON data.
///
/// # Arguments
///
/// * `json_data` - The raw JSON data containing the data stream.
///
/// # Returns
///
/// A vector of data items within the data stream.
fn extract_data_stream(json_data: &str) -> Vec<&str> {
let data_stream: Vec<&str> = json_data
.split("data:")
.filter(|s| !s.is_empty())
.map(|s| s.split("id:").next().unwrap_or(""))
.collect();
data_stream
}
}
/// A wrapper for an event handler function, providing synchronization and cloning capabilities.
pub struct EventHandlerFn(Arc<Mutex<dyn Fn(EventParseResult) + Send + Sync>>);
#[allow(dead_code)]
impl EventHandlerFn {
/// Creates a new `EventHandlerFn` with the specified event handling function.
///
/// # Arguments
///
/// * `func` - A function that takes an `EventParseResult` as an argument.
///
/// # Returns
///
/// A new `EventHandlerFn` instance.
pub fn new<F>(func: F) -> Self
where
F: Fn(EventParseResult) + Send + Sync + 'static,
{
EventHandlerFn(Arc::new(Mutex::new(func)))
}
/// Calls the stored event handling function with the provided `EventParseResult`.
///
/// # Arguments
///
/// * `event_result` - The result of an event to be passed to the stored event handling function.
pub fn call(&self, event_result: EventParseResult) {
let func = self.0.lock().unwrap();
(*func)(event_result); // Call the stored function with arguments
}
}
impl fmt::Debug for EventHandlerFn {
/// Implements the `Debug` trait for better debugging support.
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "EventHandlerFn")
}
}
impl Clone for EventHandlerFn {
/// Implements the `Clone` trait for creating a cloned instance with shared underlying data.
fn clone(&self) -> Self {
EventHandlerFn(self.0.clone())
}
}
impl Default for EventHandlerFn {
/// Implements the `Default` trait, creating a default instance with a no-op event handling function.
fn default() -> Self {
EventHandlerFn(Arc::new(Mutex::new(|_event_result| {})))
}
}
// Define DeploySubscription struct with different configurations based on the target architecture.
#[cfg(not(target_arch = "wasm32"))]
/// Represents a subscription to deploy events for non-wasm32 target architecture.
#[derive(Debug, Clone, Default)]
pub struct DeploySubscription {
/// Deploy hash to identify the subscription.
pub deploy_hash: String,
/// Handler function for deploy events.
pub event_handler_fn: EventHandlerFn,
}
#[cfg(target_arch = "wasm32")]
/// Represents a subscription to deploy events for wasm32 target architecture.
#[derive(Debug, Clone, Default)]
#[wasm_bindgen(getter_with_clone)]
pub struct DeploySubscription {
/// Deploy hash to identify the subscription.
#[wasm_bindgen(js_name = "deployHash")]
pub deploy_hash: String,
/// Handler function for deploy events.
#[wasm_bindgen(js_name = "eventHandlerFn")]
pub event_handler_fn: js_sys::Function,
}
impl DeploySubscription {
/// Constructor for DeploySubscription for non-wasm32 target architecture.
///
/// # Arguments
///
/// * `deploy_hash` - Deploy hash to identify the subscription.
/// * `event_handler_fn` - Handler function for deploy events.
#[cfg(not(target_arch = "wasm32"))]
pub fn new(deploy_hash: String, event_handler_fn: EventHandlerFn) -> Self {
Self {
deploy_hash,
event_handler_fn,
}
}
}
#[wasm_bindgen]
impl DeploySubscription {
/// Constructor for DeploySubscription for wasm32 target architecture.
///
/// # Arguments
///
/// * `deploy_hash` - Deploy hash to identify the subscription.
/// * `event_handler_fn` - Handler function for deploy events.
#[cfg(target_arch = "wasm32")]
#[wasm_bindgen(constructor)]
pub fn new(deploy_hash: String, event_handler_fn: js_sys::Function) -> Self {
Self {
deploy_hash,
event_handler_fn,
}
}
}
/// Represents a failure response containing an error message.
#[derive(Debug, Deserialize, Clone, Default, Serialize)]
#[wasm_bindgen(getter_with_clone)]
pub struct Failure {
pub error_message: String,
}
/// Represents a success response containing a cost value.
#[derive(Debug, Deserialize, Clone, Default, Serialize)]
#[wasm_bindgen(getter_with_clone)]
pub struct Success {
pub cost: String,
}
/// Represents the result of an execution, either Success or Failure.
#[derive(Debug, Deserialize, Clone, Default, Serialize)]
#[wasm_bindgen(getter_with_clone)]
pub struct ExecutionResult {
/// Optional Success information.
#[serde(rename = "Success")]
#[wasm_bindgen(js_name = "Success")]
pub success: Option<Success>,
/// Optional Failure information.
#[serde(rename = "Failure")]
#[wasm_bindgen(js_name = "Failure")]
pub failure: Option<Failure>,
}
/// Represents processed deploy information.
#[derive(Debug, Deserialize, Clone, Default, Serialize)]
#[wasm_bindgen(getter_with_clone)]
pub struct DeployProcessed {
pub deploy_hash: String,
pub account: String,
pub timestamp: String,
pub ttl: String,
pub dependencies: Vec<String>,
pub block_hash: String,
/// Result of the execution, either Success or Failure.
pub execution_result: ExecutionResult,
}
/// Represents the body of an event, containing processed deploy information.
#[derive(Debug, Deserialize, Clone, Default, Serialize)]
#[wasm_bindgen(getter_with_clone)]
pub struct Body {
#[serde(rename = "DeployProcessed")]
#[wasm_bindgen(js_name = "DeployProcessed")]
pub deploy_processed: Option<DeployProcessed>,
}
/// Represents the result of parsing an event, containing error information and the event body.
#[derive(Debug, Deserialize, Clone, Default, Serialize)]
#[wasm_bindgen(getter_with_clone)]
pub struct EventParseResult {
pub err: Option<String>,
pub body: Option<Body>,
}
/// Enum representing different event names.
#[derive(Debug, Deserialize, Clone, Serialize)]
enum EventName {
BlockAdded,
DeployProcessed,
DeployAccepted,
BlockFinalized,
FinalitySignature,
Fault,
}
impl fmt::Display for EventName {
/// Implements the `fmt::Display` trait for converting the enum variant to its string representation.
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
EventName::BlockAdded => write!(f, "BlockAdded"),
EventName::DeployProcessed => write!(f, "DeployProcessed"),
EventName::DeployAccepted => write!(f, "DeployAccepted"),
EventName::BlockFinalized => write!(f, "BlockFinalized"),
EventName::FinalitySignature => write!(f, "FinalitySignature"),
EventName::Fault => write!(f, "Fault"),
}
}
}
#[cfg(test)]
mod tests {
use sdk_tests::tests::helpers::get_network_constants;
use crate::deploy_watcher::deploy_mock::DEPLOY_MOCK;
use super::*;
#[test]
fn test_new() {
// Arrange
let (_, events_url, _) = get_network_constants();
let timeout_duration = 5000;
// Act
let deploy_watcher = DeployWatcher::new(events_url.clone(), Some(timeout_duration));
// Assert
assert_eq!(deploy_watcher.events_url, events_url);
assert_eq!(deploy_watcher.deploy_subscriptions.len(), 0);
assert!(*deploy_watcher.active.borrow());
assert_eq!(
deploy_watcher.timeout_duration,
Duration::try_milliseconds(timeout_duration.try_into().unwrap()).unwrap()
);
}
#[test]
fn test_new_default_timeout() {
// Arrange
let (_, events_url, _) = get_network_constants();
// Act
let deploy_watcher = DeployWatcher::new(events_url.clone(), None);
// Assert
assert_eq!(deploy_watcher.events_url, events_url);
assert_eq!(deploy_watcher.deploy_subscriptions.len(), 0);
assert!(*deploy_watcher.active.borrow());
assert_eq!(
deploy_watcher.timeout_duration,
Duration::try_milliseconds(DEFAULT_TIMEOUT_MS.try_into().unwrap()).unwrap()
);
}
#[tokio::test]
async fn test_extract_data_stream() {
// Arrange
let json_data = r#"data:segment1id:data:segment2id:data:segment3id:"#;
// Act
let result = DeployWatcher::extract_data_stream(json_data);
// Assert
assert_eq!(result, vec!["segment1", "segment2", "segment3"]);
}
#[tokio::test]
async fn test_process_events() {
// Arrange
let (_, events_url, _) = get_network_constants();
let deploy_watcher = DeployWatcher::new(events_url, None);
let deploy_hash = "19dbf9bdcd821e55392393c74c86deede02d9434d62d0bc72ab381ce7ea1c4f2";
let target_deploy_hash = Some(deploy_hash);
// Act
let result = deploy_watcher.process_events(DEPLOY_MOCK, target_deploy_hash);
// Assert
assert!(result.is_some());
let results = result.unwrap();
assert_eq!(results.len(), 1);
let event_parse_result = &results[0];
assert!(event_parse_result.err.is_none());
let body = event_parse_result.body.as_ref().unwrap();
let deploy_processed = body.deploy_processed.as_ref().unwrap();
assert_eq!(deploy_processed.deploy_hash, deploy_hash);
}
#[tokio::test]
async fn test_start_timeout() {
// Arrange
let (_, events_url, _) = get_network_constants();
let deploy_watcher = DeployWatcher::new(events_url, Some(1));
// Act
let result = deploy_watcher.start().await;
// Assert
assert!(result.is_some());
let results = result.unwrap();
assert_eq!(results.len(), 1);
assert_eq!(results[0].err, Some("Timeout expired".to_string()));
assert!(results[0].body.is_none());
}
#[test]
fn test_stop() {
// Arrange
let (_, events_url, _) = get_network_constants();
let deploy_watcher = DeployWatcher::new(events_url, None);
assert!(*deploy_watcher.active.borrow());
// Act
deploy_watcher.stop();
// Assert
assert!(!(*deploy_watcher.active.borrow()));
}
#[test]
fn test_subscribe() {
// Arrange
let (_, events_url, _) = get_network_constants();
let mut deploy_watcher = DeployWatcher::new(events_url, None);
let deploy_hash = "19dbf9bdcd821e55392393c74c86deede02d9434d62d0bc72ab381ce7ea1c4f2";
// Create a subscription
let subscription =
DeploySubscription::new(deploy_hash.to_string(), EventHandlerFn::default());
// Act
let result = deploy_watcher.subscribe(vec![subscription]);
// Assert
assert!(result.is_ok());
// Try subscribing to the same deploy hash again
let duplicate_subscription =
DeploySubscription::new(deploy_hash.to_string(), EventHandlerFn::default());
let result_duplicate = deploy_watcher.subscribe(vec![duplicate_subscription]);
// Assert
assert!(result_duplicate.is_err());
assert_eq!(
result_duplicate.err().unwrap(),
"Already subscribed to this event"
);
}
#[test]
fn test_unsubscribe() {
// Arrange
let (_, events_url, _) = get_network_constants();
let mut deploy_watcher = DeployWatcher::new(events_url, None);
let deploy_hash = "19dbf9bdcd821e55392393c74c86deede02d9434d62d0bc72ab381ce7ea1c4f2";
// Subscribe to a deploy hash
let deploy_hash_to_subscribe = deploy_hash.to_string();
let subscription =
DeploySubscription::new(deploy_hash_to_subscribe.clone(), EventHandlerFn::default());
let _ = deploy_watcher.subscribe(vec![subscription]);
// Assert that the deploy hash is initially subscribed
assert!(deploy_watcher
.deploy_subscriptions
.iter()
.any(|s| s.deploy_hash == deploy_hash_to_subscribe));
// Act
deploy_watcher.unsubscribe(deploy_hash_to_subscribe.clone());
// Assert that the deploy hash is unsubscribed after calling unsubscribe
assert!(!deploy_watcher
.deploy_subscriptions
.iter()
.any(|s| s.deploy_hash == deploy_hash_to_subscribe));
}
#[test]
fn test_sdk_watch_deploy_retunrs_instance() {
// Arrange
let sdk = SDK::new(None, None);
let (_, events_url, _) = get_network_constants();
let timeout_duration = 5000;
// Act
let deploy_watcher = sdk.watch_deploy(&events_url, Some(timeout_duration));
// Assert
assert_eq!(deploy_watcher.events_url, events_url);
assert_eq!(deploy_watcher.deploy_subscriptions.len(), 0);
assert!(*deploy_watcher.active.borrow());
assert_eq!(
deploy_watcher.timeout_duration,
Duration::try_milliseconds(timeout_duration.try_into().unwrap()).unwrap()
);
}
#[tokio::test]
async fn test_wait_deploy_timeout() {
// Arrange
let sdk = SDK::new(None, None);
let (_, events_url, _) = get_network_constants();
let deploy_hash = "19dbf9bdcd821e55392393c74c86deede02d9434d62d0bc72ab381ce7ea1c4f2";
let timeout_duration = Some(5000);
// Act
let result = sdk
.wait_deploy(&events_url, deploy_hash, timeout_duration)
.await;
// Assert
assert!(result.is_ok());
let event_parse_result = result.unwrap();
assert!(event_parse_result.err.is_some());
assert_eq!(event_parse_result.err, Some("Timeout expired".to_string()));
}
}