script/dom/performance/
performanceobserver.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5use std::cell::Cell;
6use std::rc::Rc;
7
8use dom_struct::dom_struct;
9use js::rust::{HandleObject, MutableHandleValue};
10use script_bindings::cell::DomRefCell;
11use script_bindings::reflector::{Reflector, reflect_dom_object_with_proto};
12
13use super::performance::PerformanceEntryList;
14use super::performanceentry::{EntryType, PerformanceEntry};
15use super::performanceobserverentrylist::PerformanceObserverEntryList;
16use crate::dom::bindings::callback::ExceptionHandling;
17use crate::dom::bindings::codegen::Bindings::PerformanceBinding::PerformanceEntryList as DOMPerformanceEntryList;
18use crate::dom::bindings::codegen::Bindings::PerformanceObserverBinding::{
19    PerformanceObserverCallback, PerformanceObserverInit, PerformanceObserverMethods,
20};
21use crate::dom::bindings::error::{Error, Fallible};
22use crate::dom::bindings::reflector::DomGlobal;
23use crate::dom::bindings::root::DomRoot;
24use crate::dom::console::Console;
25use crate::dom::globalscope::GlobalScope;
26use crate::script_runtime::{CanGc, JSContext};
27
28#[derive(Clone, Copy, JSTraceable, MallocSizeOf, PartialEq)]
29enum ObserverType {
30    Undefined,
31    Single,
32    Multiple,
33}
34
35#[dom_struct]
36pub(crate) struct PerformanceObserver {
37    reflector_: Reflector,
38    #[conditional_malloc_size_of]
39    callback: Rc<PerformanceObserverCallback>,
40    entries: DomRefCell<DOMPerformanceEntryList>,
41    observer_type: Cell<ObserverType>,
42}
43
44impl PerformanceObserver {
45    fn new_inherited(
46        callback: Rc<PerformanceObserverCallback>,
47        entries: DomRefCell<DOMPerformanceEntryList>,
48    ) -> PerformanceObserver {
49        PerformanceObserver {
50            reflector_: Reflector::new(),
51            callback,
52            entries,
53            observer_type: Cell::new(ObserverType::Undefined),
54        }
55    }
56
57    pub(crate) fn new(
58        global: &GlobalScope,
59        callback: Rc<PerformanceObserverCallback>,
60        entries: DOMPerformanceEntryList,
61        can_gc: CanGc,
62    ) -> DomRoot<PerformanceObserver> {
63        Self::new_with_proto(global, None, callback, entries, can_gc)
64    }
65
66    #[cfg_attr(crown, expect(crown::unrooted_must_root))]
67    fn new_with_proto(
68        global: &GlobalScope,
69        proto: Option<HandleObject>,
70        callback: Rc<PerformanceObserverCallback>,
71        entries: DOMPerformanceEntryList,
72        can_gc: CanGc,
73    ) -> DomRoot<PerformanceObserver> {
74        let observer = PerformanceObserver::new_inherited(callback, DomRefCell::new(entries));
75        reflect_dom_object_with_proto(Box::new(observer), global, proto, can_gc)
76    }
77
78    /// Buffer a new performance entry.
79    pub(crate) fn queue_entry(&self, entry: &PerformanceEntry) {
80        self.entries.borrow_mut().push(DomRoot::from_ref(entry));
81    }
82
83    /// Trigger performance observer callback with the list of performance entries
84    /// buffered since the last callback call.
85    pub(crate) fn notify(&self, cx: &mut js::context::JSContext) {
86        if self.entries.borrow().is_empty() {
87            return;
88        }
89        let entry_list = PerformanceEntryList::new(self.entries.borrow_mut().drain(..).collect());
90        let observer_entry_list =
91            PerformanceObserverEntryList::new(&self.global(), entry_list, CanGc::from_cx(cx));
92        // using self both as thisArg and as the second formal argument
93        let _ = self.callback.Call_(
94            cx,
95            self,
96            &observer_entry_list,
97            self,
98            ExceptionHandling::Report,
99        );
100    }
101
102    pub(crate) fn callback(&self) -> Rc<PerformanceObserverCallback> {
103        self.callback.clone()
104    }
105
106    pub(crate) fn entries(&self) -> DOMPerformanceEntryList {
107        self.entries.borrow().clone()
108    }
109
110    pub(crate) fn set_entries(&self, entries: DOMPerformanceEntryList) {
111        *self.entries.borrow_mut() = entries;
112    }
113}
114
115impl PerformanceObserverMethods<crate::DomTypeHolder> for PerformanceObserver {
116    /// <https://w3c.github.io/performance-timeline/#dom-performanceobserver-constructor>
117    fn Constructor(
118        global: &GlobalScope,
119        proto: Option<HandleObject>,
120        can_gc: CanGc,
121        callback: Rc<PerformanceObserverCallback>,
122    ) -> Fallible<DomRoot<PerformanceObserver>> {
123        Ok(PerformanceObserver::new_with_proto(
124            global,
125            proto,
126            callback,
127            Vec::new(),
128            can_gc,
129        ))
130    }
131
132    /// <https://w3c.github.io/performance-timeline/#supportedentrytypes-attribute>
133    fn SupportedEntryTypes(
134        cx: JSContext,
135        global: &GlobalScope,
136        can_gc: CanGc,
137        retval: MutableHandleValue,
138    ) {
139        // While this is exposed through a method of PerformanceObserver,
140        // it is specified as associated with the global scope.
141        global.supported_performance_entry_types(cx, retval, can_gc)
142    }
143
144    /// <https://w3c.github.io/performance-timeline/#dom-performanceobserver-observe()>
145    fn Observe(&self, options: &PerformanceObserverInit) -> Fallible<()> {
146        // Step 1 is self
147
148        // Step 2 is self.global()
149
150        // Step 3
151        if options.entryTypes.is_none() && options.type_.is_none() {
152            return Err(Error::Syntax(None));
153        }
154
155        // Step 4
156        if options.entryTypes.is_some() && (options.buffered.is_some() || options.type_.is_some()) {
157            return Err(Error::Syntax(None));
158        }
159
160        // If this point is reached, then one of options.entryTypes or options.type_
161        // is_some, but not both.
162
163        // Step 5
164        match self.observer_type.get() {
165            ObserverType::Undefined => {
166                if options.entryTypes.is_some() {
167                    self.observer_type.set(ObserverType::Multiple);
168                } else {
169                    self.observer_type.set(ObserverType::Single);
170                }
171            },
172            ObserverType::Single => {
173                if options.entryTypes.is_some() {
174                    return Err(Error::InvalidModification(None));
175                }
176            },
177            ObserverType::Multiple => {
178                if options.type_.is_some() {
179                    return Err(Error::InvalidModification(None));
180                }
181            },
182        }
183
184        // The entryTypes and type paths diverge here
185        const NO_VALID_ENTRY_TYPE: &str = "No valid entry type provided to observe().";
186        if let Some(entry_types) = &options.entryTypes {
187            // Steps 6.1 - 6.2
188            let entry_types = entry_types
189                .iter()
190                .filter_map(|e| EntryType::try_from(&*e.str()).ok())
191                .collect::<Vec<EntryType>>();
192
193            // Step 6.3
194            if entry_types.is_empty() {
195                Console::internal_warn(&self.global(), NO_VALID_ENTRY_TYPE.to_string());
196                return Ok(());
197            }
198
199            // Steps 6.4-6.5
200            // This never pre-fills buffered entries, and
201            // any existing types are replaced.
202            self.global()
203                .performance()
204                .add_multiple_type_observer(self, entry_types);
205            Ok(())
206        } else if let Some(entry_type) = &options.type_ {
207            // Step 7.2
208            let Ok(entry_type) = EntryType::try_from(&*entry_type.str()) else {
209                Console::internal_warn(&self.global(), NO_VALID_ENTRY_TYPE.to_string());
210                return Ok(());
211            };
212
213            // Steps 7.3-7.5
214            // This may pre-fill buffered entries, and
215            // existing types are appended to.
216            self.global().performance().add_single_type_observer(
217                self,
218                entry_type,
219                options.buffered.unwrap_or(false),
220            );
221            Ok(())
222        } else {
223            // Step 7.1
224            unreachable!()
225        }
226    }
227
228    /// <https://w3c.github.io/performance-timeline/#dom-performanceobserver-disconnect>
229    fn Disconnect(&self) {
230        self.global().performance().remove_observer(self);
231        self.entries.borrow_mut().clear();
232    }
233
234    /// <https://w3c.github.io/performance-timeline/#takerecords-method>
235    fn TakeRecords(&self) -> Vec<DomRoot<PerformanceEntry>> {
236        let mut entries = self.entries.borrow_mut();
237        let taken = entries
238            .iter()
239            .map(|entry| DomRoot::from_ref(&**entry))
240            .collect();
241        entries.clear();
242        taken
243    }
244}
script/dom/performance/performanceobserver.rs

script/dom/performance/
performanceobserver.rs
