summaryrefslogtreecommitdiff
path: root/ext/timers/lib.rs
diff options
context:
space:
mode:
Diffstat (limited to 'ext/timers/lib.rs')
-rw-r--r--ext/timers/lib.rs153
1 files changed, 48 insertions, 105 deletions
diff --git a/ext/timers/lib.rs b/ext/timers/lib.rs
index d95ac71e8..7d0b9ddc1 100644
--- a/ext/timers/lib.rs
+++ b/ext/timers/lib.rs
@@ -1,28 +1,20 @@
// Copyright 2018-2021 the Deno authors. All rights reserved. MIT license.
-//! This module helps deno implement timers.
-//!
-//! As an optimization, we want to avoid an expensive calls into rust for every
-//! setTimeout in JavaScript. Thus in //js/timers.ts a data structure is
-//! implemented that calls into Rust for only the smallest timeout. Thus we
-//! only need to be able to start, cancel and await a single timer (or Delay, as Tokio
-//! calls it) for an entire Isolate. This is what is implemented here.
+//! This module helps deno implement timers and performance APIs.
use deno_core::error::AnyError;
-use deno_core::futures;
-use deno_core::futures::channel::oneshot;
-use deno_core::futures::FutureExt;
-use deno_core::futures::TryFutureExt;
use deno_core::include_js_files;
use deno_core::op_async;
use deno_core::op_sync;
+use deno_core::CancelFuture;
+use deno_core::CancelHandle;
use deno_core::Extension;
use deno_core::OpState;
+use deno_core::Resource;
+use deno_core::ResourceId;
+use std::borrow::Cow;
use std::cell::RefCell;
-use std::future::Future;
-use std::pin::Pin;
use std::rc::Rc;
-use std::thread::sleep;
use std::time::Duration;
use std::time::Instant;
@@ -39,14 +31,12 @@ pub fn init<P: TimersPermission + 'static>() -> Extension {
"02_performance.js",
))
.ops(vec![
- ("op_global_timer_stop", op_sync(op_global_timer_stop)),
- ("op_global_timer_start", op_sync(op_global_timer_start)),
- ("op_global_timer", op_async(op_global_timer)),
("op_now", op_sync(op_now::<P>)),
+ ("op_timer_handle", op_sync(op_timer_handle)),
+ ("op_sleep", op_async(op_sleep)),
("op_sleep_sync", op_sync(op_sleep_sync::<P>)),
])
.state(|state| {
- state.put(GlobalTimer::default());
state.put(StartTime::now());
Ok(())
})
@@ -55,92 +45,6 @@ pub fn init<P: TimersPermission + 'static>() -> Extension {
pub type StartTime = Instant;
-type TimerFuture = Pin<Box<dyn Future<Output = Result<(), ()>>>>;
-
-#[derive(Default)]
-pub struct GlobalTimer {
- tx: Option<oneshot::Sender<()>>,
- pub future: Option<TimerFuture>,
-}
-
-impl GlobalTimer {
- pub fn cancel(&mut self) {
- if let Some(tx) = self.tx.take() {
- tx.send(()).ok();
- }
- }
-
- pub fn new_timeout(&mut self, deadline: Instant) {
- if self.tx.is_some() {
- self.cancel();
- }
- assert!(self.tx.is_none());
- self.future.take();
-
- let (tx, rx) = oneshot::channel();
- self.tx = Some(tx);
-
- let delay = tokio::time::sleep_until(deadline.into()).boxed_local();
- let rx = rx
- .map_err(|err| panic!("Unexpected error in receiving channel {:?}", err));
-
- let fut = futures::future::select(delay, rx)
- .then(|_| futures::future::ok(()))
- .boxed_local();
- self.future = Some(fut);
- }
-}
-
-pub fn op_global_timer_stop(
- state: &mut OpState,
- _: (),
- _: (),
-) -> Result<(), AnyError> {
- let global_timer = state.borrow_mut::<GlobalTimer>();
- global_timer.cancel();
- Ok(())
-}
-
-// Set up a timer that will be later awaited by JS promise.
-// It's a separate op, because canceling a timeout immediately
-// after setting it caused a race condition (because Tokio timeout)
-// might have been registered after next event loop tick.
-//
-// See https://github.com/denoland/deno/issues/7599 for more
-// details.
-pub fn op_global_timer_start(
- state: &mut OpState,
- timeout: u64,
- _: (),
-) -> Result<(), AnyError> {
- // According to spec, minimum allowed timeout is 4 ms.
- // https://html.spec.whatwg.org/multipage/timers-and-user-prompts.html#timers
- // TODO(#10974) Per spec this is actually a little more complicated than this.
- // The minimum timeout depends on the nesting level of the timeout.
- let timeout = std::cmp::max(timeout, 4);
-
- let deadline = Instant::now() + Duration::from_millis(timeout);
- let global_timer = state.borrow_mut::<GlobalTimer>();
- global_timer.new_timeout(deadline);
- Ok(())
-}
-
-pub async fn op_global_timer(
- state: Rc<RefCell<OpState>>,
- _: (),
- _: (),
-) -> Result<(), AnyError> {
- let maybe_timer_fut = {
- let mut s = state.borrow_mut();
- let global_timer = s.borrow_mut::<GlobalTimer>();
- global_timer.future.take()
- };
- if let Some(timer_fut) = maybe_timer_fut {
- let _ = timer_fut.await;
- }
- Ok(())
-}
-
// Returns a milliseconds and nanoseconds subsec
// since the start time of the deno runtime.
// If the High precision flag is not set, the
@@ -170,6 +74,45 @@ where
Ok(result)
}
+pub struct TimerHandle(Rc<CancelHandle>);
+
+impl Resource for TimerHandle {
+ fn name(&self) -> Cow<str> {
+ "timer".into()
+ }
+
+ fn close(self: Rc<Self>) {
+ self.0.cancel();
+ }
+}
+
+/// Creates a [`TimerHandle`] resource that can be used to cancel invocations of
+/// [`op_sleep`].
+pub fn op_timer_handle(
+ state: &mut OpState,
+ _: (),
+ _: (),
+) -> Result<ResourceId, AnyError> {
+ let rid = state
+ .resource_table
+ .add(TimerHandle(CancelHandle::new_rc()));
+ Ok(rid)
+}
+
+/// Waits asynchronously until either `millis` milliseconds have passed or the
+/// [`TimerHandle`] resource given by `rid` has been canceled.
+pub async fn op_sleep(
+ state: Rc<RefCell<OpState>>,
+ millis: u64,
+ rid: ResourceId,
+) -> Result<(), AnyError> {
+ let handle = state.borrow().resource_table.get::<TimerHandle>(rid)?;
+ tokio::time::sleep(Duration::from_millis(millis))
+ .or_cancel(handle.0.clone())
+ .await?;
+ Ok(())
+}
+
pub fn op_sleep_sync<TP>(
state: &mut OpState,
millis: u64,
@@ -179,6 +122,6 @@ where
TP: TimersPermission + 'static,
{
state.borrow::<TP>().check_unstable(state, "Deno.sleepSync");
- sleep(Duration::from_millis(millis));
+ std::thread::sleep(Duration::from_millis(millis));
Ok(())
}