beet_core 0.0.8

Core utilities and types for other beet crates
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

//! Helpers for working with `HtmlIFrameElement` using a cohesive, module-style API.
//!
//! Design
//! - Small, explicit free functions (no extension traits).
//! - Async helpers leverage a Stream-based `HtmlEventListener` to await the next `load`.
//! - Clear docs, tests, and examples.
//!
//! Examples
//!
//! Reload and await load:
//! ```ignore
//! use beet_core::web_utils::{iframe, document_ext as doc};
//! use web_sys::HtmlIFrameElement;
//!
//! let iframe: HtmlIFrameElement = doc::document()
//!     .create_element("iframe").unwrap()
//!     .dyn_into().unwrap();
//!
//! doc::append_child(&iframe);
//! iframe::reload_async(&iframe).await;
//! ```
//!
//! Set source and await load:
//! ```ignore
//! use beet_core::web_utils::{iframe, document_ext as doc};
//! use web_sys::HtmlIFrameElement;
//!
//! let iframe: HtmlIFrameElement = doc::document()
//!     .create_element("iframe").unwrap()
//!     .dyn_into().unwrap();
//!
//! doc::append_child(&iframe);
//! iframe::set_source(&iframe, "data:text/html,<html><body>ok</body></html>").await;
//! // asserts same-origin document is present
//! assert!(iframe.content_document().is_some());
//! ```
use crate::web_utils::HtmlEventListener;
use wasm_bindgen::JsCast;
use web_sys::HtmlIFrameElement;

/// Reload the iframe synchronously (does not wait for load).
pub fn reload(iframe: &HtmlIFrameElement) {
	iframe
		.content_window()
		.unwrap()
		.location()
		.reload()
		.unwrap();
}

/// Reload the iframe and await the next `load` event.
///
/// This uses a Stream-based event listener to await a single `load`.
pub async fn reload_async(iframe: &HtmlIFrameElement) {
	reload(iframe);
	wait_for_load(iframe).await;
}

/// Set the iframe `src` and await the next `load` event.
///
/// Panics if the iframe finishes loading but `content_document()` is `None`,
/// which commonly indicates a cross-origin restriction.
pub async fn set_source(iframe: &HtmlIFrameElement, url: &str) {
	iframe.set_src(url);
	wait_for_load(iframe).await;
	if iframe.content_document().is_none() {
		panic!(
			"iframe loaded src: {url}\nbut content_document is None (likely a CORS issue)"
		);
	}
}

/// Await the next `load` event for the provided iframe.
pub async fn wait_for_load(iframe: &HtmlIFrameElement) {
	let target = iframe.clone().unchecked_into::<web_sys::EventTarget>();
	let mut loads =
		HtmlEventListener::<web_sys::Event>::new_with_target("load", target);
	// Await exactly one event
	let _ = loads.next_event().await;
}

#[cfg(test)]
#[cfg(target_arch = "wasm32")]
mod tests {
	use super::*;
	use crate::prelude::*;
	use crate::web_utils::document_ext as doc;

	#[ignore = "requires dom"]
	#[test]
	fn works() {
		// DOM access smoke-check
		let _ = doc::document();
		let _ = doc::head();
		let _ = doc::body();
	}

	#[ignore = "requires dom"]
	#[crate::test]
	async fn works_async() {
		doc::clear_body();

		// Create and attach an iframe, then set a same-origin data URL and await load
		let iframe: HtmlIFrameElement = doc::document()
			.create_element("iframe")
			.unwrap()
			.dyn_into()
			.unwrap();

		// Make it visible to avoid some headless environment quirks


		doc::append_child(&iframe);

		let data_url = "data:text/html,<html><body>ok</body></html>";
		set_source(&iframe, data_url).await;

		iframe.content_document().is_some().xpect_true();

		// Exercise reload path too
		reload_async(&iframe).await;
		iframe.content_document().is_some().xpect_true();
	}
}