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
use default_struct_builder::DefaultBuilder;
use leptos::*;
use std::rc::Rc;
use wasm_bindgen::{prelude::Closure, JsCast, JsValue};
use web_sys::ServiceWorkerRegistration;
use crate::{js_fut, use_window};
/// Reactive [ServiceWorker API](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API).
///
/// Please check the [working example](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_service_worker).
///
/// ## Usage
///
/// ```
/// # use leptos::*;
/// # use leptos_use::{use_service_worker_with_options, UseServiceWorkerOptions, UseServiceWorkerReturn};
/// #
/// # #[component]
/// # fn Demo() -> impl IntoView {
/// let UseServiceWorkerReturn {
/// registration,
/// installing,
/// waiting,
/// active,
/// skip_waiting,
/// check_for_update,
/// } = use_service_worker_with_options(UseServiceWorkerOptions::default()
/// .script_url("service-worker.js")
/// .skip_waiting_message("skipWaiting"),
/// );
///
/// # view! { }
/// # }
/// ```
///
/// ## Server-Side Rendering
///
/// This function does **not** support SSR. Call it inside a `create_effect`.
pub fn use_service_worker() -> UseServiceWorkerReturn<impl Fn() + Clone, impl Fn() + Clone> {
use_service_worker_with_options(UseServiceWorkerOptions::default())
}
/// Version of [`use_service_worker`] that takes a `UseServiceWorkerOptions`. See [`use_service_worker`] for how to use.
pub fn use_service_worker_with_options(
options: UseServiceWorkerOptions,
) -> UseServiceWorkerReturn<impl Fn() + Clone, impl Fn() + Clone> {
// Trigger the user-defined action (page-reload by default)
// whenever a new ServiceWorker is installed.
if let Some(navigator) = use_window().navigator() {
let on_controller_change = options.on_controller_change.clone();
let js_closure = Closure::wrap(Box::new(move |_event: JsValue| {
#[cfg(debug_assertions)]
let prev = SpecialNonReactiveZone::enter();
on_controller_change();
#[cfg(debug_assertions)]
SpecialNonReactiveZone::exit(prev);
}) as Box<dyn FnMut(JsValue)>)
.into_js_value();
navigator
.service_worker()
.set_oncontrollerchange(Some(js_closure.as_ref().unchecked_ref()));
}
// Create async actions.
let create_or_update_registration = create_action_create_or_update_registration();
let get_registration = create_action_get_registration();
let update_sw = create_action_update();
// Immediately create or update the SW registration.
create_or_update_registration.dispatch(ServiceWorkerScriptUrl(options.script_url.to_string()));
// And parse the result into individual signals.
let registration: Signal<Result<ServiceWorkerRegistration, ServiceWorkerRegistrationError>> =
Signal::derive(move || {
let a = get_registration.value().get();
let b = create_or_update_registration.value().get();
// We only dispatch create_or_update_registration once.
// Whenever we manually re-fetched the registration, the result of that has precedence!
match a {
Some(res) => res.map_err(ServiceWorkerRegistrationError::Js),
None => match b {
Some(res) => res.map_err(ServiceWorkerRegistrationError::Js),
None => Err(ServiceWorkerRegistrationError::NeverQueried),
},
}
});
let fetch_registration = Closure::wrap(Box::new(move |_event: JsValue| {
get_registration.dispatch(());
}) as Box<dyn FnMut(JsValue)>)
.into_js_value();
// Handle a changing registration state.
// Notify to developer if SW registration or retrieval fails.
create_effect(move |_| {
registration.with(|reg| match reg {
Ok(registration) => {
// We must be informed when an updated SW is available.
registration.set_onupdatefound(Some(fetch_registration.as_ref().unchecked_ref()));
// Trigger a check to see IF an updated SW is available.
update_sw.dispatch(registration.clone());
// If a SW is installing, we must be notified if its state changes!
if let Some(sw) = registration.installing() {
sw.set_onstatechange(Some(fetch_registration.as_ref().unchecked_ref()));
}
}
Err(err) => match err {
ServiceWorkerRegistrationError::Js(err) => {
logging::warn!("ServiceWorker registration failed: {err:?}")
}
ServiceWorkerRegistrationError::NeverQueried => {}
},
})
});
UseServiceWorkerReturn {
registration,
installing: Signal::derive(move || {
registration.with(|reg| {
reg.as_ref()
.map(|reg| reg.installing().is_some())
.unwrap_or_default()
})
}),
waiting: Signal::derive(move || {
registration.with(|reg| {
reg.as_ref()
.map(|reg| reg.waiting().is_some())
.unwrap_or_default()
})
}),
active: Signal::derive(move || {
registration.with(|reg| {
reg.as_ref()
.map(|reg| reg.active().is_some())
.unwrap_or_default()
})
}),
check_for_update: move || {
registration.with(|reg| {
if let Ok(reg) = reg {
update_sw.dispatch(reg.clone())
}
})
},
skip_waiting: move || {
registration.with_untracked(|reg| if let Ok(reg) = reg {
match reg.waiting() {
Some(sw) => {
logging::debug_warn!("Updating to newly installed SW...");
if let Err(err) = sw.post_message(&JsValue::from_str(&options.skip_waiting_message)) {
logging::warn!("Could not send message to active SW: Error: {err:?}");
}
},
None => {
logging::warn!("You tried to update the SW while no new SW was waiting. This is probably a bug.");
},
}
});
},
}
}
/// Options for [`use_service_worker_with_options`].
#[derive(DefaultBuilder)]
pub struct UseServiceWorkerOptions {
/// The name of your service-worker file. Must be deployed alongside your app.
/// The default name is 'service-worker.js'.
#[builder(into)]
script_url: String,
/// The message sent to a waiting ServiceWorker when you call the `skip_waiting` callback.
/// The callback is part of the return type of [`use_service_worker`]!
/// The default message is 'skipWaiting'.
#[builder(into)]
skip_waiting_message: String,
/// What should happen when a new service worker was activated?
/// The default implementation reloads the current page.
on_controller_change: Rc<dyn Fn()>,
}
impl Default for UseServiceWorkerOptions {
fn default() -> Self {
Self {
script_url: "service-worker.js".into(),
skip_waiting_message: "skipWaiting".into(),
on_controller_change: Rc::new(move || {
use std::ops::Deref;
if let Some(window) = use_window().deref() {
if let Err(err) = window.location().reload() {
logging::warn!(
"Detected a ServiceWorkerController change but the page reload failed! Error: {err:?}"
);
}
}
}),
}
}
}
/// Return type of [`use_service_worker`].
pub struct UseServiceWorkerReturn<CheckFn, SkipFn>
where
CheckFn: Fn() + Clone,
SkipFn: Fn() + Clone,
{
/// The current registration state.
pub registration: Signal<Result<ServiceWorkerRegistration, ServiceWorkerRegistrationError>>,
/// Whether a SW is currently installing.
pub installing: Signal<bool>,
/// Whether a SW was installed and is now awaiting activation.
pub waiting: Signal<bool>,
/// Whether a SW is active.
pub active: Signal<bool>,
/// Check for a ServiceWorker update.
pub check_for_update: CheckFn,
/// Call this to activate a new ("waiting") SW if one is available.
/// Calling this while the [`UseServiceWorkerReturn::waiting`] signal resolves to false has no effect.
pub skip_waiting: SkipFn,
}
struct ServiceWorkerScriptUrl(pub String);
#[derive(Debug, Clone)]
pub enum ServiceWorkerRegistrationError {
Js(JsValue),
NeverQueried,
}
/// A leptos action which asynchronously checks for ServiceWorker updates, given an existing ServiceWorkerRegistration.
fn create_action_update(
) -> Action<ServiceWorkerRegistration, Result<ServiceWorkerRegistration, JsValue>> {
create_action(move |registration: &ServiceWorkerRegistration| {
let registration = registration.clone();
async move {
match registration.update() {
Ok(promise) => js_fut!(promise)
.await
.and_then(|ok| ok.dyn_into::<ServiceWorkerRegistration>()),
Err(err) => Err(err),
}
}
})
}
/// A leptos action which asynchronously creates or updates and than retrieves the ServiceWorkerRegistration.
fn create_action_create_or_update_registration(
) -> Action<ServiceWorkerScriptUrl, Result<ServiceWorkerRegistration, JsValue>> {
create_action(move |script_url: &ServiceWorkerScriptUrl| {
let script_url = script_url.0.to_owned();
async move {
if let Some(navigator) = use_window().navigator() {
js_fut!(navigator.service_worker().register(script_url.as_str()))
.await
.and_then(|ok| ok.dyn_into::<ServiceWorkerRegistration>())
} else {
Err(JsValue::from_str("no navigator"))
}
}
})
}
/// A leptos action which asynchronously fetches the current ServiceWorkerRegistration.
fn create_action_get_registration() -> Action<(), Result<ServiceWorkerRegistration, JsValue>> {
create_action(move |(): &()| async move {
if let Some(navigator) = use_window().navigator() {
js_fut!(navigator.service_worker().get_registration())
.await
.and_then(|ok| ok.dyn_into::<ServiceWorkerRegistration>())
} else {
Err(JsValue::from_str("no navigator"))
}
})
}