Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a fallback for the time tracking in the web #814

Merged
merged 1 commit into from
Jun 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ include = [
]
edition = "2021"
resolver = "2"
rust-version = "1.71"
rust-version = "1.73"

[package.metadata.docs.rs]
all-features = true
Expand Down Expand Up @@ -104,7 +104,9 @@ js-sys = { version = "0.3.55", optional = true }
wasm-bindgen = { version = "0.2.78", optional = true }
wasm-bindgen-futures = { version = "0.4.28", optional = true }
web-sys = { version = "0.3.28", default-features = false, features = [
"Document",
"Performance",
"VisibilityState",
"Window",
], optional = true }

Expand Down
67 changes: 62 additions & 5 deletions src/platform/wasm/web/time.rs
Original file line number Diff line number Diff line change
@@ -1,25 +1,82 @@
use js_sys::{Date, Reflect};
use std::ops::Sub;
use std::{cell::Cell, ops::Sub};
use time::UtcOffset;
use wasm_bindgen::{prelude::*, JsCast};
use web_sys::Performance;
use web_sys::{Performance, VisibilityState};

pub use time::{Duration, OffsetDateTime as DateTime};

#[derive(Copy, Clone, PartialOrd, PartialEq, Ord, Eq, Debug)]
#[repr(transparent)]
pub struct Instant(Duration);

// Every browser's `performance.now()` implementation is not spec compliant,
// unless the browser is running on Windows. On every other operating system,
// `performance.now()` does not properly keep ticking while the operating system
// is suspended / sleeping. There isn't much that we can do. What we can do is
// we calculate the initial difference between `performance.now()` and
// `Date.now()` and store it in a thread local. Later, when the phone gets
// locked, `performance.now()` starts to break. However, we can detect when the
// phone gets unlocked again by listening to the `visibilitychange` event. This
// is where we can update the difference again. This of course isn't ideal, as
// `Date.now()` gets adjusted by NTP synchronizations, but it's the best we can
// do.
//
// More information:
// https://developer.mozilla.org/en-US/docs/Web/API/Performance/now#ticking_during_sleep
fn init_fallback(performance: &Performance) {
let Some(window) = web_sys::window() else {
// Not running in a browser environment.
return;
};

if window.navigator().platform().is_ok_and(|v| v == "Win32") {
// Windows is not affected by this issue.
return;
}

let Some(document) = window.document() else {
// Not running in a browser environment.
return;
};

DIFF_TO_DATE_NOW.set(Date::now() - performance.now());

let callback = Closure::wrap(Box::new({
let document = document.clone();
move || {
if document.visibility_state() == VisibilityState::Visible {
PERFORMANCE.with(|p| DIFF_TO_DATE_NOW.set(Date::now() - p.now()));
}
}
}) as Box<dyn FnMut()>);

if document
.add_event_listener_with_callback("visibilitychange", callback.as_ref().unchecked_ref())
.is_ok()
{
// Leak the callback to keep it alive. This is only done once, and we
// need it for the entire duration of the web app anyway.
callback.forget();
}
}

thread_local! {
static PERFORMANCE: Performance =
Reflect::get(&js_sys::global(), &JsValue::from_str("performance"))
static DIFF_TO_DATE_NOW: Cell<f64> = const { Cell::new(0.0) };
static PERFORMANCE: Performance = {
let performance: Performance = Reflect::get(&js_sys::global(), &JsValue::from_str("performance"))
.expect("Failed to get performance from global object")
.unchecked_into();

init_fallback(&performance);

performance
};
}

impl Instant {
pub fn now() -> Self {
let secs = PERFORMANCE.with(|p| p.now()) * 0.001;
let secs = PERFORMANCE.with(|p| p.now() + DIFF_TO_DATE_NOW.get()) * 0.001;
Instant(Duration::seconds_f64(secs))
}
}
Expand Down
Loading