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