script/dom/abort/

abortsignal.rs

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */

use std::cell::{Cell, RefCell};
use std::rc::Rc;
use std::sync::{Arc, Mutex};

use dom_struct::dom_struct;
use indexmap::IndexSet;
use js::context::JSContext;
use js::jsapi::{ExceptionStackBehavior, Heap};
use js::jsval::{JSVal, UndefinedValue};
use js::realm::CurrentRealm;
use js::rust::wrappers2::JS_SetPendingException;
use js::rust::{HandleObject, HandleValue, MutableHandleValue};
use script_bindings::cell::DomRefCell;
use script_bindings::inheritance::Castable;
use script_bindings::reflector::reflect_dom_object_with_proto_and_cx;
use script_bindings::weakref::WeakRef;

use crate::dom::bindings::codegen::Bindings::AbortSignalBinding::AbortSignalMethods;
use crate::dom::bindings::codegen::Bindings::EventListenerBinding::EventListener;
use crate::dom::bindings::codegen::Bindings::EventTargetBinding::EventListenerOptions;
use crate::dom::bindings::error::{Error, ErrorToJsval, Fallible};
use crate::dom::bindings::refcounted::Trusted;
use crate::dom::bindings::reflector::DomGlobal;
use crate::dom::bindings::root::{Dom, DomRoot};
use crate::dom::bindings::str::DOMString;
use crate::dom::eventtarget::EventTarget;
use crate::dom::globalscope::GlobalScope;
use crate::dom::readablestream::PipeTo;
use crate::fetch::{DeferredFetchRecordId, FetchContext};
use crate::realms::enter_auto_realm;
use crate::script_runtime::JSContext as SafeJSContext;

impl js::gc::Rootable for AbortAlgorithm {}

/// <https://dom.spec.whatwg.org/#abortcontroller-api-integration>
/// TODO: implement algorithms at call point,
/// in order to integrate the abort signal with its various use cases.
#[derive(Clone, JSTraceable, MallocSizeOf)]
#[cfg_attr(crown, crown::unrooted_must_root_lint::must_root)]
pub(crate) enum AbortAlgorithm {
    /// <https://dom.spec.whatwg.org/#add-an-event-listener>
    DomEventListener(RemovableDomEventListener),
    /// <https://streams.spec.whatwg.org/#readable-stream-pipe-to>
    StreamPiping(PipeTo),
    /// <https://fetch.spec.whatwg.org/#dom-global-fetch>
    Fetch(
        #[no_trace]
        #[conditional_malloc_size_of]
        Arc<Mutex<Option<FetchContext>>>,
    ),
    /// <https://fetch.spec.whatwg.org/#dom-window-fetchlater>
    FetchLater(#[no_trace] DeferredFetchRecordId),
}

#[derive(Clone, JSTraceable, MallocSizeOf)]
#[cfg_attr(crown, crown::unrooted_must_root_lint::must_root)]
pub(crate) struct RemovableDomEventListener {
    pub(crate) event_target: Dom<EventTarget>,
    pub(crate) ty: DOMString,
    #[conditional_malloc_size_of]
    pub(crate) listener: Option<Rc<EventListener>>,
    pub(crate) options: EventListenerOptions,
}

/// <https://dom.spec.whatwg.org/#abortsignal>
#[dom_struct]
pub(crate) struct AbortSignal {
    eventtarget: EventTarget,

    /// <https://dom.spec.whatwg.org/#abortsignal-abort-reason>
    #[ignore_malloc_size_of = "mozjs"]
    abort_reason: Heap<JSVal>,

    /// <https://dom.spec.whatwg.org/#abortsignal-abort-algorithms>
    abort_algorithms: RefCell<Vec<AbortAlgorithm>>,

    /// <https://dom.spec.whatwg.org/#abortsignal-dependent>
    dependent: Cell<bool>,

    /// <https://dom.spec.whatwg.org/#abortsignal-source-signals>
    #[no_trace]
    #[ignore_malloc_size_of = "WeakRef"]
    source_signals: DomRefCell<IndexSet<WeakRef<AbortSignal>>>,

    /// <https://dom.spec.whatwg.org/#abortsignal-dependent-signals>
    #[no_trace]
    #[ignore_malloc_size_of = "WeakRef"]
    dependent_signals: DomRefCell<IndexSet<WeakRef<AbortSignal>>>,
}

impl AbortSignal {
    fn new_inherited() -> AbortSignal {
        AbortSignal {
            eventtarget: EventTarget::new_inherited(),
            abort_reason: Default::default(),
            abort_algorithms: Default::default(),
            dependent: Default::default(),
            source_signals: Default::default(),
            dependent_signals: Default::default(),
        }
    }

    pub(crate) fn new_with_proto(
        cx: &mut JSContext,
        global: &GlobalScope,
        proto: Option<HandleObject>,
    ) -> DomRoot<AbortSignal> {
        reflect_dom_object_with_proto_and_cx(
            Box::new(AbortSignal::new_inherited()),
            global,
            proto,
            cx,
        )
    }

    /// <https://dom.spec.whatwg.org/#abortsignal-signal-abort>
    pub(crate) fn signal_abort(&self, cx: &mut CurrentRealm, reason: HandleValue) {
        let global = self.global();

        // Step 1. If signal is aborted, then return.
        if self.Aborted() {
            return;
        }

        // Step 2. Set signal’s abort reason to reason if it is given;
        // otherwise to a new "AbortError" DOMException.
        let abort_reason = reason.get();
        if !abort_reason.is_undefined() {
            self.abort_reason.set(abort_reason);
        } else {
            rooted!(&in(cx) let mut rooted_error = UndefinedValue());
            Error::Abort(None).to_jsval(cx, &global, rooted_error.handle_mut());
            self.abort_reason.set(rooted_error.get())
        }

        // Step 3. Let dependentSignalsToAbort be a new list.
        let mut dependent_signals_to_abort = vec![];

        // Step 4. For each dependentSignal of signal’s dependent signals:
        for weak in self.dependent_signals.borrow().iter() {
            if let Some(dependent_signal) = weak.root() {
                // Step 4.1. If dependentSignal is not aborted:
                if !dependent_signal.aborted() {
                    // Step 4.1.1. Set dependentSignal’s abort reason to signal’s abort reason.
                    dependent_signal.abort_reason.set(self.abort_reason.get());
                    // Step 4.1.2. Append dependentSignal to dependentSignalsToAbort.
                    dependent_signals_to_abort.push(dependent_signal);
                }
            }
        }

        // Step 5. Run the abort steps for signal.
        self.run_the_abort_steps(cx, &global);

        // Step 6. For each dependentSignal of dependentSignalsToAbort, run the abort steps for dependentSignal.
        for dependent_signal in dependent_signals_to_abort.iter() {
            dependent_signal.run_the_abort_steps(cx, &global);
        }
    }

    /// <https://dom.spec.whatwg.org/#abortsignal-add>
    pub(crate) fn add(&self, algorithm: &AbortAlgorithm) {
        // Step 1. If signal is aborted, then return.
        if self.aborted() {
            return;
        }

        // Step 2. Append algorithm to signal’s abort algorithms.
        self.abort_algorithms.borrow_mut().push(algorithm.clone());

        // if this is a dependent signal, it may now need to be kept alive.
        if self.dependent.get() {
            self.global().register_dependent_abort_signal(self);
        }
    }

    /// Run a specific abort algorithm.
    pub(crate) fn run_abort_algorithm(
        &self,
        cx: &mut CurrentRealm,
        global: &GlobalScope,
        algorithm: &AbortAlgorithm,
    ) {
        match algorithm {
            AbortAlgorithm::StreamPiping(pipe) => {
                rooted!(&in(cx) let mut reason = UndefinedValue());
                reason.set(self.abort_reason.get());
                pipe.abort_with_reason(cx, global, reason.handle());
            },
            AbortAlgorithm::Fetch(fetch_context) => {
                rooted!(&in(cx) let mut reason = UndefinedValue());
                reason.set(self.abort_reason.get());
                if let Some(fetch_context) = &mut *fetch_context.lock().unwrap() {
                    fetch_context.abort_fetch(reason.handle(), cx);
                }
            },
            AbortAlgorithm::FetchLater(deferred_fetch_record_id) => {
                global
                    .deferred_fetch_record_for_id(deferred_fetch_record_id)
                    .abort();
            },
            AbortAlgorithm::DomEventListener(removable_listener) => {
                removable_listener.event_target.remove_event_listener(
                    removable_listener.ty.clone(),
                    &removable_listener.listener,
                    &removable_listener.options,
                );
            },
        }
    }

    /// <https://dom.spec.whatwg.org/#run-the-abort-steps>
    fn run_the_abort_steps(&self, cx: &mut CurrentRealm, global: &GlobalScope) {
        // Step 1. For each algorithm of signal’s abort algorithms: run algorithm.
        for algo in self.abort_algorithms.borrow().iter() {
            self.run_abort_algorithm(cx, global, algo);
        }
        // Step 2. Empty signal’s abort algorithms.
        self.abort_algorithms.borrow_mut().clear();

        // Step 3. Fire an event named abort at signal.
        self.upcast::<EventTarget>().fire_event(cx, atom!("abort"));
    }

    /// <https://dom.spec.whatwg.org/#abortsignal-aborted>
    pub(crate) fn aborted(&self) -> bool {
        // An AbortSignal object is aborted when its abort reason is not undefined.
        !self.abort_reason.get().is_undefined()
    }

    /// <https://dom.spec.whatwg.org/#create-a-dependent-abort-signal>
    pub(crate) fn create_dependent_abort_signal(
        cx: &mut JSContext,
        signals: Vec<DomRoot<AbortSignal>>,
        global: &GlobalScope,
    ) -> DomRoot<AbortSignal> {
        // Step 1. Let resultSignal be a new object implementing signalInterface using realm.
        let result_signal = Self::new_with_proto(cx, global, None);
        // Step 2. For each signal of signals: if signal is aborted,
        // then set resultSignal’s abort reason to signal’s abort reason and return resultSignal.
        for signal in signals.iter() {
            if signal.aborted() {
                result_signal.abort_reason.set(signal.abort_reason.get());
                return result_signal;
            }
        }
        // Step 3. Set resultSignal’s dependent to true.
        result_signal.dependent.set(true);
        // Step 4. For each signal of signals:
        for signal in signals.iter() {
            // Step 4.1. If signal’s dependent is false:
            if !signal.dependent.get() {
                // Step 4.1.1. Append signal to resultSignal’s source signals.
                result_signal
                    .source_signals
                    .borrow_mut()
                    .insert(WeakRef::new(signal));
                // Step 4.1.2. Append resultSignal to signal’s dependent signals.
                signal
                    .dependent_signals
                    .borrow_mut()
                    .insert(WeakRef::new(&*result_signal));
            } else {
                // Step 4.2. Otherwise, for each sourceSignal of signal’s source signals:
                for source_signal_weak in signal.source_signals.borrow().iter() {
                    if let Some(source_signal) = source_signal_weak.root() {
                        // Step 4.2.1. Assert: sourceSignal is not aborted and not dependent.
                        assert!(!source_signal.aborted() && !source_signal.dependent.get());
                        // Step 4.2.2. Append sourceSignal to resultSignal’s source signals.
                        result_signal
                            .source_signals
                            .borrow_mut()
                            .insert(WeakRef::new(&*source_signal));
                        // Step 4.2.3. Append resultSignal to sourceSignal’s dependent signals.
                        source_signal
                            .dependent_signals
                            .borrow_mut()
                            .insert(WeakRef::new(&*result_signal));
                    }
                }
            }
        }
        // Step 5. Return resultSignal.
        global.register_dependent_abort_signal(&result_signal);
        result_signal
    }

    /// Remove weak references whose target has been collected.
    fn prune_dead_weak_refs(&self) {
        self.source_signals.borrow_mut().retain(|w| w.is_alive());
        self.dependent_signals.borrow_mut().retain(|w| w.is_alive());
    }

    /// Whether this signal still has abort algorithms registered.
    fn has_abort_algorithms(&self) -> bool {
        !self.abort_algorithms.borrow().is_empty()
    }

    /// Whether this signal has any listeners for its "abort" event.
    fn has_abort_listeners(&self) -> bool {
        self.upcast::<EventTarget>()
            .has_listeners_for(&atom!("abort"))
    }

    /// <https://dom.spec.whatwg.org/#abort-signal-garbage-collection>
    /// A non-aborted dependent AbortSignal object must not be garbage
    /// collected while its source signals is non-empty and it has
    /// registered event listeners for its abort event or its abort
    /// algorithms is non-empty.
    pub(crate) fn must_keep_alive_for_gc(&self) -> bool {
        // Treat dead weak entries as removed.
        self.prune_dead_weak_refs();

        // Only care about non-aborted signals.
        if self.aborted() {
            return false;
        }

        // If it has no live source signals left, it doesn’t need to be kept.
        if self.source_signals.borrow().is_empty() {
            return false;
        }

        let has_algos = self.has_abort_algorithms();
        let has_listeners = self.has_abort_listeners();

        has_algos || has_listeners
    }
}

impl AbortSignalMethods<crate::DomTypeHolder> for AbortSignal {
    /// <https://dom.spec.whatwg.org/#dom-abortsignal-aborted>
    fn Aborted(&self) -> bool {
        // The aborted getter steps are to return true if this is aborted; otherwise false.
        self.aborted()
    }

    /// <https://dom.spec.whatwg.org/#dom-abortsignal-abort>
    fn Abort(
        cx: &mut JSContext,
        global: &GlobalScope,
        reason: HandleValue,
    ) -> DomRoot<AbortSignal> {
        // Step 1. Let signal be a new AbortSignal object.
        let signal = AbortSignal::new_with_proto(cx, global, None);

        // Step 2. Set signal’s abort reason to reason if it is given;
        // otherwise to a new "AbortError" DOMException.
        let abort_reason = reason.get();
        if !abort_reason.is_undefined() {
            signal.abort_reason.set(abort_reason);
        } else {
            rooted!(&in(cx) let mut rooted_error = UndefinedValue());
            Error::Abort(None).to_jsval(cx, global, rooted_error.handle_mut());
            signal.abort_reason.set(rooted_error.get())
        }

        // Step 3. Return signal.
        signal
    }

    /// <https://dom.spec.whatwg.org/#dom-abortsignal-timeout>
    fn Timeout(
        cx: &mut JSContext,
        global: &GlobalScope,
        milliseconds: u64,
    ) -> DomRoot<AbortSignal> {
        // Step 1. Let signal be a new AbortSignal object.
        let signal = AbortSignal::new_with_proto(cx, global, None);

        // Step 2. Let global be signal’s relevant global object.
        // We already have `global`.

        let signal_keepalive: Trusted<AbortSignal> = Trusted::new(&signal);

        let ms_i64 = if milliseconds > i64::MAX as u64 {
            i64::MAX
        } else {
            milliseconds as i64
        };

        // Step 3. Run steps after a timeout given global, "AbortSignal-timeout", milliseconds, and the following step:
        global.run_steps_after_a_timeout(
            DOMString::from("AbortSignal-timeout"),
            ms_i64,
            move |_cx, global| {
                let task_source = global.task_manager().timer_task_source().to_sendable();

                // Step 3.1. Queue a global task on the timer task source given global to signal abort given signal and a new "TimeoutError" DOMException.
                // For the duration of this timeout, if signal has any event listeners registered for its abort event,
                // there must be a strong reference from global to signal.
                task_source.queue(task!(abortsignal_timeout: move |cx| {
                    let signal_for_task = signal_keepalive.root();

                    rooted!(&in(cx) let mut reason = UndefinedValue());
                    Error::Timeout(None).to_jsval(
                        cx,
                        &signal_for_task.global(),
                        reason.handle_mut(),
                    );

                    let mut realm = enter_auto_realm(cx, &*signal_for_task.global());
                    let mut realm = realm.current_realm();

                    // “signal abort given signal and a new "TimeoutError" DOMException.”
                    signal_for_task.signal_abort(
                        &mut realm,
                        reason.handle(),
                    );
                }));
            },
        );

        // Step 4. Return signal.
        signal
    }

    /// <https://dom.spec.whatwg.org/#dom-abortsignal-any>
    fn Any(
        cx: &mut JSContext,
        global: &GlobalScope,
        signals: Vec<DomRoot<AbortSignal>>,
    ) -> DomRoot<AbortSignal> {
        // The static any(signals) method steps are to return the result
        // of creating a dependent abort signal from signals using AbortSignal and the current realm.
        Self::create_dependent_abort_signal(cx, signals, global)
    }

    /// <https://dom.spec.whatwg.org/#dom-abortsignal-reason>
    fn Reason(&self, _cx: SafeJSContext, mut rval: MutableHandleValue) {
        // The reason getter steps are to return this’s abort reason.
        rval.set(self.abort_reason.get());
    }

    /// <https://dom.spec.whatwg.org/#dom-abortsignal-throwifaborted>
    #[expect(unsafe_code)]
    fn ThrowIfAborted(&self, cx: &mut JSContext) -> Fallible<()> {
        // The throwIfAborted() method steps are to throw this’s abort reason, if this is aborted.
        if self.aborted() {
            unsafe {
                JS_SetPendingException(
                    cx,
                    HandleValue::from_raw(self.abort_reason.handle()),
                    ExceptionStackBehavior::Capture,
                )
            };
            return Err(Error::JSFailed);
        }
        Ok(())
    }

    // <https://dom.spec.whatwg.org/#dom-abortsignal-onabort>
    event_handler!(abort, GetOnabort, SetOnabort);
}