Improve use of NeverDestroyed
[WebKit-https.git] / Source / WebCore / dom / MutationObserver.cpp
1 /*
2  * Copyright (C) 2011 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #include "config.h"
32
33 #include "MutationObserver.h"
34
35 #include "Document.h"
36 #include "ExceptionCode.h"
37 #include "HTMLSlotElement.h"
38 #include "Microtasks.h"
39 #include "MutationCallback.h"
40 #include "MutationObserverRegistration.h"
41 #include "MutationRecord.h"
42 #include <algorithm>
43 #include <wtf/MainThread.h>
44 #include <wtf/NeverDestroyed.h>
45
46 namespace WebCore {
47
48 static unsigned s_observerPriority = 0;
49
50 Ref<MutationObserver> MutationObserver::create(Ref<MutationCallback>&& callback)
51 {
52     ASSERT(isMainThread());
53     return adoptRef(*new MutationObserver(WTFMove(callback)));
54 }
55
56 MutationObserver::MutationObserver(Ref<MutationCallback>&& callback)
57     : m_callback(WTFMove(callback))
58     , m_priority(s_observerPriority++)
59 {
60 }
61
62 MutationObserver::~MutationObserver()
63 {
64     ASSERT(m_registrations.isEmpty());
65 }
66
67 bool MutationObserver::validateOptions(MutationObserverOptions options)
68 {
69     return (options & (Attributes | CharacterData | ChildList))
70         && ((options & Attributes) || !(options & AttributeOldValue))
71         && ((options & Attributes) || !(options & AttributeFilter))
72         && ((options & CharacterData) || !(options & CharacterDataOldValue));
73 }
74
75 ExceptionOr<void> MutationObserver::observe(Node& node, const Init& init)
76 {
77     MutationObserverOptions options = 0;
78
79     if (init.childList)
80         options |= ChildList;
81     if (init.subtree)
82         options |= Subtree;
83     if (init.attributeOldValue.value_or(false))
84         options |= AttributeOldValue;
85     if (init.characterDataOldValue.value_or(false))
86         options |= CharacterDataOldValue;
87
88     HashSet<AtomicString> attributeFilter;
89     if (init.attributeFilter) {
90         for (auto& value : init.attributeFilter.value())
91             attributeFilter.add(value);
92         options |= AttributeFilter;
93     }
94
95     if (init.attributes ? init.attributes.value() : (options & (AttributeFilter | AttributeOldValue)))
96         options |= Attributes;
97
98     if (init.characterData ? init.characterData.value() : (options & CharacterDataOldValue))
99         options |= CharacterData;
100
101     if (!validateOptions(options))
102         return Exception { TypeError };
103
104     node.registerMutationObserver(*this, options, attributeFilter);
105
106     return { };
107 }
108
109 Vector<Ref<MutationRecord>> MutationObserver::takeRecords()
110 {
111     Vector<Ref<MutationRecord>> records;
112     records.swap(m_records);
113     return records;
114 }
115
116 void MutationObserver::disconnect()
117 {
118     m_records.clear();
119     HashSet<MutationObserverRegistration*> registrations(m_registrations);
120     for (auto* registration : registrations)
121         registration->node().unregisterMutationObserver(*registration);
122 }
123
124 void MutationObserver::observationStarted(MutationObserverRegistration& registration)
125 {
126     ASSERT(!m_registrations.contains(&registration));
127     m_registrations.add(&registration);
128 }
129
130 void MutationObserver::observationEnded(MutationObserverRegistration& registration)
131 {
132     ASSERT(m_registrations.contains(&registration));
133     m_registrations.remove(&registration);
134 }
135
136 typedef HashSet<RefPtr<MutationObserver>> MutationObserverSet;
137
138 static MutationObserverSet& activeMutationObservers()
139 {
140     static NeverDestroyed<MutationObserverSet> activeObservers;
141     return activeObservers;
142 }
143
144 static MutationObserverSet& suspendedMutationObservers()
145 {
146     static NeverDestroyed<MutationObserverSet> suspendedObservers;
147     return suspendedObservers;
148 }
149
150 // https://dom.spec.whatwg.org/#signal-slot-list
151 static Vector<RefPtr<HTMLSlotElement>>& signalSlotList()
152 {
153     static NeverDestroyed<Vector<RefPtr<HTMLSlotElement>>> list;
154     return list;
155 }
156
157 static bool mutationObserverCompoundMicrotaskQueuedFlag;
158
159 class MutationObserverMicrotask final : public Microtask {
160     WTF_MAKE_FAST_ALLOCATED;
161 private:
162     Result run() final
163     {
164         MutationObserver::notifyMutationObservers();
165         return Result::Done;
166     }
167 };
168
169 static void queueMutationObserverCompoundMicrotask()
170 {
171     if (mutationObserverCompoundMicrotaskQueuedFlag)
172         return;
173     mutationObserverCompoundMicrotaskQueuedFlag = true;
174     MicrotaskQueue::mainThreadQueue().append(std::make_unique<MutationObserverMicrotask>());
175 }
176
177 void MutationObserver::enqueueMutationRecord(Ref<MutationRecord>&& mutation)
178 {
179     ASSERT(isMainThread());
180     m_records.append(WTFMove(mutation));
181     activeMutationObservers().add(this);
182
183     queueMutationObserverCompoundMicrotask();
184 }
185
186 void MutationObserver::enqueueSlotChangeEvent(HTMLSlotElement& slot)
187 {
188     ASSERT(isMainThread());
189     ASSERT(!signalSlotList().contains(&slot));
190     signalSlotList().append(&slot);
191
192     queueMutationObserverCompoundMicrotask();
193 }
194
195 void MutationObserver::setHasTransientRegistration()
196 {
197     ASSERT(isMainThread());
198     activeMutationObservers().add(this);
199
200     queueMutationObserverCompoundMicrotask();
201 }
202
203 HashSet<Node*> MutationObserver::observedNodes() const
204 {
205     HashSet<Node*> observedNodes;
206     for (auto* registration : m_registrations)
207         registration->addRegistrationNodesToSet(observedNodes);
208     return observedNodes;
209 }
210
211 bool MutationObserver::canDeliver()
212 {
213     return m_callback->canInvokeCallback();
214 }
215
216 void MutationObserver::deliver()
217 {
218     ASSERT(canDeliver());
219
220     // Calling clearTransientRegistrations() can modify m_registrations, so it's necessary
221     // to make a copy of the transient registrations before operating on them.
222     Vector<MutationObserverRegistration*, 1> transientRegistrations;
223     for (auto* registration : m_registrations) {
224         if (registration->hasTransientRegistrations())
225             transientRegistrations.append(registration);
226     }
227     for (auto& registration : transientRegistrations)
228         registration->clearTransientRegistrations();
229
230     if (m_records.isEmpty())
231         return;
232
233     Vector<Ref<MutationRecord>> records;
234     records.swap(m_records);
235
236     m_callback->call(records, this);
237 }
238
239 void MutationObserver::notifyMutationObservers()
240 {
241     // https://dom.spec.whatwg.org/#notify-mutation-observers
242     // 1. Unset mutation observer compound microtask queued flag.
243     mutationObserverCompoundMicrotaskQueuedFlag = false;
244
245     ASSERT(isMainThread());
246     static bool deliveryInProgress = false;
247     if (deliveryInProgress)
248         return;
249     deliveryInProgress = true;
250
251     if (!suspendedMutationObservers().isEmpty()) {
252         Vector<RefPtr<MutationObserver>> suspended;
253         copyToVector(suspendedMutationObservers(), suspended);
254         for (auto& observer : suspended) {
255             if (!observer->canDeliver())
256                 continue;
257
258             suspendedMutationObservers().remove(observer);
259             activeMutationObservers().add(observer);
260         }
261     }
262
263     while (!activeMutationObservers().isEmpty() || !signalSlotList().isEmpty()) {
264         // 2. Let notify list be a copy of unit of related similar-origin browsing contexts' list of MutationObserver objects.
265         Vector<RefPtr<MutationObserver>> notifyList;
266         copyToVector(activeMutationObservers(), notifyList);
267         activeMutationObservers().clear();
268         std::sort(notifyList.begin(), notifyList.end(), [](auto& lhs, auto& rhs) {
269             return lhs->m_priority < rhs->m_priority;
270         });
271
272         // 3. Let signalList be a copy of unit of related similar-origin browsing contexts' signal slot list.
273         // 4. Empty unit of related similar-origin browsing contexts' signal slot list.
274         Vector<RefPtr<HTMLSlotElement>> slotList;
275         if (!signalSlotList().isEmpty()) {
276             slotList.swap(signalSlotList());
277             for (auto& slot : slotList)
278                 slot->didRemoveFromSignalSlotList();
279         }
280
281         // 5. For each MutationObserver object mo in notify list, execute a compound microtask subtask
282         for (auto& observer : notifyList) {
283             if (observer->canDeliver())
284                 observer->deliver();
285             else
286                 suspendedMutationObservers().add(observer);
287         }
288
289         // 6. For each slot slot in signalList, in order, fire an event named slotchange, with its bubbles attribute set to true, at slot.
290         for (auto& slot : slotList)
291             slot->dispatchSlotChangeEvent();
292     }
293
294     deliveryInProgress = false;
295 }
296
297 } // namespace WebCore