GC can collect JS wrappers of nodes in the mutation records waiting to be delivered
[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     // Don't clear m_pendingTargets here because we can collect JS wrappers
118     // between the time takeRecords is called and nodes in records are accesssed.
119     return records;
120 }
121
122 void MutationObserver::disconnect()
123 {
124     m_pendingTargets.clear();
125     m_records.clear();
126     HashSet<MutationObserverRegistration*> registrations(m_registrations);
127     for (auto* registration : registrations)
128         registration->node().unregisterMutationObserver(*registration);
129 }
130
131 void MutationObserver::observationStarted(MutationObserverRegistration& registration)
132 {
133     ASSERT(!m_registrations.contains(&registration));
134     m_registrations.add(&registration);
135 }
136
137 void MutationObserver::observationEnded(MutationObserverRegistration& registration)
138 {
139     ASSERT(m_registrations.contains(&registration));
140     m_registrations.remove(&registration);
141 }
142
143 typedef HashSet<RefPtr<MutationObserver>> MutationObserverSet;
144
145 static MutationObserverSet& activeMutationObservers()
146 {
147     static NeverDestroyed<MutationObserverSet> activeObservers;
148     return activeObservers;
149 }
150
151 static MutationObserverSet& suspendedMutationObservers()
152 {
153     static NeverDestroyed<MutationObserverSet> suspendedObservers;
154     return suspendedObservers;
155 }
156
157 // https://dom.spec.whatwg.org/#signal-slot-list
158 static Vector<GCReachableRef<HTMLSlotElement>>& signalSlotList()
159 {
160     static NeverDestroyed<Vector<GCReachableRef<HTMLSlotElement>>> list;
161     return list;
162 }
163
164 static bool mutationObserverCompoundMicrotaskQueuedFlag;
165
166 class MutationObserverMicrotask final : public Microtask {
167     WTF_MAKE_FAST_ALLOCATED;
168 private:
169     Result run() final
170     {
171         MutationObserver::notifyMutationObservers();
172         return Result::Done;
173     }
174 };
175
176 static void queueMutationObserverCompoundMicrotask()
177 {
178     if (mutationObserverCompoundMicrotaskQueuedFlag)
179         return;
180     mutationObserverCompoundMicrotaskQueuedFlag = true;
181     MicrotaskQueue::mainThreadQueue().append(std::make_unique<MutationObserverMicrotask>());
182 }
183
184 void MutationObserver::enqueueMutationRecord(Ref<MutationRecord>&& mutation)
185 {
186     ASSERT(isMainThread());
187     ASSERT(mutation->target());
188     m_pendingTargets.add(*mutation->target());
189     m_records.append(WTFMove(mutation));
190     activeMutationObservers().add(this);
191
192     queueMutationObserverCompoundMicrotask();
193 }
194
195 void MutationObserver::enqueueSlotChangeEvent(HTMLSlotElement& slot)
196 {
197     ASSERT(isMainThread());
198     ASSERT(signalSlotList().findMatching([&slot](auto& entry) { return entry.ptr() == &slot; }) == notFound);
199     signalSlotList().append(slot);
200
201     queueMutationObserverCompoundMicrotask();
202 }
203
204 void MutationObserver::setHasTransientRegistration()
205 {
206     ASSERT(isMainThread());
207     activeMutationObservers().add(this);
208
209     queueMutationObserverCompoundMicrotask();
210 }
211
212 HashSet<Node*> MutationObserver::observedNodes() const
213 {
214     HashSet<Node*> observedNodes;
215     for (auto* registration : m_registrations)
216         registration->addRegistrationNodesToSet(observedNodes);
217     return observedNodes;
218 }
219
220 bool MutationObserver::canDeliver()
221 {
222     return m_callback->canInvokeCallback();
223 }
224
225 void MutationObserver::deliver()
226 {
227     ASSERT(canDeliver());
228
229     // Calling takeTransientRegistrations() can modify m_registrations, so it's necessary
230     // to make a copy of the transient registrations before operating on them.
231     Vector<MutationObserverRegistration*, 1> transientRegistrations;
232     Vector<std::unique_ptr<HashSet<GCReachableRef<Node>>>, 1> nodesToKeepAlive;
233     HashSet<GCReachableRef<Node>> pendingTargets;
234     pendingTargets.swap(m_pendingTargets);
235     for (auto* registration : m_registrations) {
236         if (registration->hasTransientRegistrations())
237             transientRegistrations.append(registration);
238     }
239     for (auto& registration : transientRegistrations)
240         nodesToKeepAlive.append(registration->takeTransientRegistrations());
241
242     if (m_records.isEmpty())
243         return;
244
245     Vector<Ref<MutationRecord>> records;
246     records.swap(m_records);
247
248     // FIXME: Keep mutation observer callback as long as its observed nodes are alive. See https://webkit.org/b/179224.
249     if (m_callback->hasCallback())
250         m_callback->handleEvent(*this, records, *this);
251 }
252
253 void MutationObserver::notifyMutationObservers()
254 {
255     // https://dom.spec.whatwg.org/#notify-mutation-observers
256     // 1. Unset mutation observer compound microtask queued flag.
257     mutationObserverCompoundMicrotaskQueuedFlag = false;
258
259     ASSERT(isMainThread());
260     static bool deliveryInProgress = false;
261     if (deliveryInProgress)
262         return;
263     deliveryInProgress = true;
264
265     if (!suspendedMutationObservers().isEmpty()) {
266         for (auto& observer : copyToVector(suspendedMutationObservers())) {
267             if (!observer->canDeliver())
268                 continue;
269
270             suspendedMutationObservers().remove(observer);
271             activeMutationObservers().add(observer);
272         }
273     }
274
275     while (!activeMutationObservers().isEmpty() || !signalSlotList().isEmpty()) {
276         // 2. Let notify list be a copy of unit of related similar-origin browsing contexts' list of MutationObserver objects.
277         auto notifyList = copyToVector(activeMutationObservers());
278         activeMutationObservers().clear();
279         std::sort(notifyList.begin(), notifyList.end(), [](auto& lhs, auto& rhs) {
280             return lhs->m_priority < rhs->m_priority;
281         });
282
283         // 3. Let signalList be a copy of unit of related similar-origin browsing contexts' signal slot list.
284         // 4. Empty unit of related similar-origin browsing contexts' signal slot list.
285         Vector<GCReachableRef<HTMLSlotElement>> slotList;
286         if (!signalSlotList().isEmpty()) {
287             slotList.swap(signalSlotList());
288             for (auto& slot : slotList)
289                 slot->didRemoveFromSignalSlotList();
290         }
291
292         // 5. For each MutationObserver object mo in notify list, execute a compound microtask subtask
293         for (auto& observer : notifyList) {
294             if (observer->canDeliver())
295                 observer->deliver();
296             else
297                 suspendedMutationObservers().add(observer);
298         }
299
300         // 6. For each slot slot in signalList, in order, fire an event named slotchange, with its bubbles attribute set to true, at slot.
301         for (auto& slot : slotList)
302             slot->dispatchSlotChangeEvent();
303     }
304
305     deliveryInProgress = false;
306 }
307
308 } // namespace WebCore