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
use crate::core::ConnectionReadyState;
use crate::utils::StringCodec;
use crate::{js, use_event_listener};
use default_struct_builder::DefaultBuilder;
use leptos::*;
use std::cell::Cell;
use std::marker::PhantomData;
use std::rc::Rc;
use std::time::Duration;
use thiserror::Error;
/// Reactive [EventSource](https://developer.mozilla.org/en-US/docs/Web/API/EventSource)
///
/// An [EventSource](https://developer.mozilla.org/en-US/docs/Web/API/EventSource) or
/// [Server-Sent-Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events)
/// instance opens a persistent connection to an HTTP server,
/// which sends events in text/event-stream format.
///
/// ## Usage
///
/// Values are decoded via the given [`Codec`].
///
/// > To use the [`JsonCodec`], you will need to add the `"serde"` feature to your project's `Cargo.toml`.
/// > To use [`ProstCodec`], add the feature `"prost"`.
///
/// ```
/// # use leptos::*;
/// # use leptos_use::{use_event_source, UseEventSourceReturn, utils::JsonCodec};
/// # use serde::{Deserialize, Serialize};
/// #
/// #[derive(Serialize, Deserialize, Clone, PartialEq)]
/// pub struct EventSourceData {
/// pub message: String,
/// pub priority: u8,
/// }
///
/// # #[component]
/// # fn Demo() -> impl IntoView {
/// let UseEventSourceReturn {
/// ready_state, data, error, close, ..
/// } = use_event_source::<EventSourceData, JsonCodec>("https://event-source-url");
/// #
/// # view! { }
/// # }
/// ```
///
/// ### Create Your Own Custom Codec
///
/// All you need to do is to implement the [`StringCodec`] trait together with `Default` and `Clone`.
///
/// ### Named Events
///
/// You can define named events when using `use_event_source_with_options`.
///
/// ```
/// # use leptos::*;
/// # use leptos_use::{use_event_source_with_options, UseEventSourceReturn, UseEventSourceOptions, utils::FromToStringCodec};
/// #
/// # #[component]
/// # fn Demo() -> impl IntoView {
/// let UseEventSourceReturn {
/// ready_state, data, error, close, ..
/// } = use_event_source_with_options::<String, FromToStringCodec>(
/// "https://event-source-url",
/// UseEventSourceOptions::default()
/// .named_events(["notice".to_string(), "update".to_string()])
/// );
/// #
/// # view! { }
/// # }
/// ```
///
/// ### Immediate
///
/// Auto-connect (enabled by default).
///
/// This will call `open()` automatically for you, and you don't need to call it by yourself.
///
/// ### Auto-Reconnection
///
/// Reconnect on errors automatically (enabled by default).
///
/// You can control the number of reconnection attempts by setting `reconnect_limit` and the
/// interval between them by setting `reconnect_interval`.
///
/// ```
/// # use leptos::*;
/// # use leptos_use::{use_event_source_with_options, UseEventSourceReturn, UseEventSourceOptions, utils::FromToStringCodec};
/// #
/// # #[component]
/// # fn Demo() -> impl IntoView {
/// let UseEventSourceReturn {
/// ready_state, data, error, close, ..
/// } = use_event_source_with_options::<bool, FromToStringCodec>(
/// "https://event-source-url",
/// UseEventSourceOptions::default()
/// .reconnect_limit(5) // at most 5 attempts
/// .reconnect_interval(2000) // wait for 2 seconds between attempts
/// );
/// #
/// # view! { }
/// # }
/// ```
///
/// To disable auto-reconnection, set `reconnect_limit` to `0`.
///
/// ## Server-Side Rendering
///
/// On the server-side, `use_event_source` will always return `ready_state` as `ConnectionReadyState::Closed`,
/// `data`, `event` and `error` will always be `None`, and `open` and `close` will do nothing.
pub fn use_event_source<T, C>(
url: &str,
) -> UseEventSourceReturn<T, C::Error, impl Fn() + Clone + 'static, impl Fn() + Clone + 'static>
where
T: Clone + PartialEq + 'static,
C: StringCodec<T> + Default,
{
use_event_source_with_options(url, UseEventSourceOptions::<T, C>::default())
}
/// Version of [`use_event_source`] that takes a `UseEventSourceOptions`. See [`use_event_source`] for how to use.
pub fn use_event_source_with_options<T, C>(
url: &str,
options: UseEventSourceOptions<T, C>,
) -> UseEventSourceReturn<T, C::Error, impl Fn() + Clone + 'static, impl Fn() + Clone + 'static>
where
T: Clone + PartialEq + 'static,
C: StringCodec<T> + Default,
{
let UseEventSourceOptions {
codec,
reconnect_limit,
reconnect_interval,
on_failed,
immediate,
named_events,
with_credentials,
_marker,
} = options;
let url = url.to_owned();
let (event, set_event) = create_signal(None::<web_sys::Event>);
let (data, set_data) = create_signal(None::<T>);
let (ready_state, set_ready_state) = create_signal(ConnectionReadyState::Closed);
let (event_source, set_event_source) = create_signal(None::<web_sys::EventSource>);
let (error, set_error) = create_signal(None::<UseEventSourceError<C::Error>>);
let explicitly_closed = Rc::new(Cell::new(false));
let retried = Rc::new(Cell::new(0));
let set_data_from_string = move |data_string: Option<String>| {
if let Some(data_string) = data_string {
match codec.decode(data_string) {
Ok(data) => set_data.set(Some(data)),
Err(err) => set_error.set(Some(UseEventSourceError::Deserialize(err))),
}
}
};
let close = {
let explicitly_closed = Rc::clone(&explicitly_closed);
move || {
if let Some(event_source) = event_source.get_untracked() {
event_source.close();
set_event_source.set(None);
set_ready_state.set(ConnectionReadyState::Closed);
explicitly_closed.set(true);
}
}
};
let init = store_value(None::<Rc<dyn Fn()>>);
init.set_value(Some(Rc::new({
let explicitly_closed = Rc::clone(&explicitly_closed);
let retried = Rc::clone(&retried);
move || {
use wasm_bindgen::prelude::*;
if explicitly_closed.get() {
return;
}
let mut event_src_opts = web_sys::EventSourceInit::new();
event_src_opts.with_credentials(with_credentials);
let es = web_sys::EventSource::new_with_event_source_init_dict(&url, &event_src_opts)
.unwrap_throw();
set_ready_state.set(ConnectionReadyState::Connecting);
set_event_source.set(Some(es.clone()));
let on_open = Closure::wrap(Box::new(move |_: web_sys::Event| {
set_ready_state.set(ConnectionReadyState::Open);
set_error.set(None);
}) as Box<dyn FnMut(web_sys::Event)>);
es.set_onopen(Some(on_open.as_ref().unchecked_ref()));
on_open.forget();
let on_error = Closure::wrap(Box::new({
let explicitly_closed = Rc::clone(&explicitly_closed);
let retried = Rc::clone(&retried);
let on_failed = Rc::clone(&on_failed);
let es = es.clone();
move |e: web_sys::Event| {
set_ready_state.set(ConnectionReadyState::Closed);
set_error.set(Some(UseEventSourceError::Event(e)));
// only reconnect if EventSource isn't reconnecting by itself
// this is the case when the connection is closed (readyState is 2)
if es.ready_state() == 2 && !explicitly_closed.get() && reconnect_limit > 0 {
es.close();
retried.set(retried.get() + 1);
if retried.get() < reconnect_limit {
set_timeout(
move || {
if let Some(init) = init.get_value() {
init();
}
},
Duration::from_millis(reconnect_interval),
);
} else {
#[cfg(debug_assertions)]
let prev = SpecialNonReactiveZone::enter();
on_failed();
#[cfg(debug_assertions)]
SpecialNonReactiveZone::exit(prev);
}
}
}
}) as Box<dyn FnMut(web_sys::Event)>);
es.set_onerror(Some(on_error.as_ref().unchecked_ref()));
on_error.forget();
let on_message = Closure::wrap(Box::new({
let set_data_from_string = set_data_from_string.clone();
move |e: web_sys::MessageEvent| {
set_data_from_string(e.data().as_string());
}
}) as Box<dyn FnMut(web_sys::MessageEvent)>);
es.set_onmessage(Some(on_message.as_ref().unchecked_ref()));
on_message.forget();
for event_name in named_events.clone() {
let set_data_from_string = set_data_from_string.clone();
let _ = use_event_listener(
es.clone(),
ev::Custom::<ev::Event>::new(event_name),
move |e| {
set_event.set(Some(e.clone()));
let data_string = js!(e["data"]).ok().and_then(|d| d.as_string());
set_data_from_string(data_string);
},
);
}
}
})));
let open;
#[cfg(not(feature = "ssr"))]
{
open = {
let close = close.clone();
let explicitly_closed = Rc::clone(&explicitly_closed);
let retried = Rc::clone(&retried);
move || {
close();
explicitly_closed.set(false);
retried.set(0);
if let Some(init) = init.get_value() {
init();
}
}
};
}
#[cfg(feature = "ssr")]
{
open = move || {};
}
if immediate {
open();
}
on_cleanup(close.clone());
UseEventSourceReturn {
event_source: event_source.into(),
event: event.into(),
data: data.into(),
ready_state: ready_state.into(),
error: error.into(),
open,
close,
}
}
/// Options for [`use_event_source_with_options`].
#[derive(DefaultBuilder)]
pub struct UseEventSourceOptions<T, C>
where
T: 'static,
C: StringCodec<T>,
{
/// Decodes from the received String to a value of type `T`.
codec: C,
/// Retry times. Defaults to 3.
reconnect_limit: u64,
/// Retry interval in ms. Defaults to 3000.
reconnect_interval: u64,
/// On maximum retry times reached.
on_failed: Rc<dyn Fn()>,
/// If `true` the `EventSource` connection will immediately be opened when calling this function.
/// If `false` you have to manually call the `open` function.
/// Defaults to `true`.
immediate: bool,
/// List of named events to listen for on the `EventSource`.
#[builder(into)]
named_events: Vec<String>,
/// If CORS should be set to `include` credentials. Defaults to `false`.
with_credentials: bool,
_marker: PhantomData<T>,
}
impl<T, C: StringCodec<T> + Default> Default for UseEventSourceOptions<T, C> {
fn default() -> Self {
Self {
codec: C::default(),
reconnect_limit: 3,
reconnect_interval: 3000,
on_failed: Rc::new(|| {}),
immediate: true,
named_events: vec![],
with_credentials: false,
_marker: PhantomData,
}
}
}
/// Return type of [`use_event_source`].
pub struct UseEventSourceReturn<T, Err, OpenFn, CloseFn>
where
Err: 'static,
T: Clone + 'static,
OpenFn: Fn() + Clone + 'static,
CloseFn: Fn() + Clone + 'static,
{
/// Latest data received via the `EventSource`
pub data: Signal<Option<T>>,
/// The current state of the connection,
pub ready_state: Signal<ConnectionReadyState>,
/// The latest named event
pub event: Signal<Option<web_sys::Event>>,
/// The current error
pub error: Signal<Option<UseEventSourceError<Err>>>,
/// (Re-)Opens the `EventSource` connection
/// If the current one is active, will close it before opening a new one.
pub open: OpenFn,
/// Closes the `EventSource` connection
pub close: CloseFn,
/// The `EventSource` instance
pub event_source: Signal<Option<web_sys::EventSource>>,
}
#[derive(Error, Debug)]
pub enum UseEventSourceError<Err> {
#[error("Error event: {0:?}")]
Event(web_sys::Event),
#[error("Error decoding value")]
Deserialize(Err),
}