Use "= default" to denote default constructor or destructor
[WebKit-https.git] / Source / WebCore / dom / RejectedPromiseTracker.cpp
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  * Copyright (C) 2017 Yusuke Suzuki <utatane.tea@gmail.com>
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #include "config.h"
28 #include "RejectedPromiseTracker.h"
29
30 #include "EventNames.h"
31 #include "EventTarget.h"
32 #include "JSDOMGlobalObject.h"
33 #include "JSDOMPromise.h"
34 #include "PromiseRejectionEvent.h"
35 #include "ScriptExecutionContext.h"
36 #include <heap/HeapInlines.h>
37 #include <heap/Strong.h>
38 #include <heap/StrongInlines.h>
39 #include <heap/Weak.h>
40 #include <heap/WeakInlines.h>
41 #include <inspector/ScriptCallStack.h>
42 #include <inspector/ScriptCallStackFactory.h>
43 #include <runtime/Exception.h>
44 #include <runtime/JSCJSValueInlines.h>
45 #include <runtime/JSGlobalObject.h>
46 #include <runtime/JSPromise.h>
47 #include <runtime/WeakGCMapInlines.h>
48
49
50 namespace WebCore {
51 using namespace JSC;
52 using namespace Inspector;
53
54 class UnhandledPromise {
55     WTF_MAKE_NONCOPYABLE(UnhandledPromise);
56 public:
57     UnhandledPromise(JSDOMGlobalObject& globalObject, JSPromise& promise, RefPtr<ScriptCallStack>&& stack)
58         : m_promise(DOMPromise::create(globalObject, promise))
59         , m_stack(WTFMove(stack))
60     {
61     }
62
63     UnhandledPromise(UnhandledPromise&&) = default;
64
65     ScriptCallStack* callStack()
66     {
67         return m_stack.get();
68     }
69
70     DOMPromise& promise()
71     {
72         return m_promise.get();
73     }
74
75 private:
76     Ref<DOMPromise> m_promise;
77     RefPtr<ScriptCallStack> m_stack;
78 };
79
80
81 RejectedPromiseTracker::RejectedPromiseTracker(ScriptExecutionContext& context, JSC::VM& vm)
82     : m_context(context)
83     , m_outstandingRejectedPromises(vm)
84 {
85 }
86
87 RejectedPromiseTracker::~RejectedPromiseTracker() = default;
88
89 static RefPtr<ScriptCallStack> createScriptCallStackFromReason(ExecState& state, JSValue reason)
90 {
91     VM& vm = state.vm();
92
93     // Always capture a stack from the exception if this rejection was an exception.
94     if (auto* exception = vm.lastException()) {
95         if (exception->value() == reason)
96             return createScriptCallStackFromException(&state, exception, ScriptCallStack::maxCallStackSizeToCapture);
97     }
98
99     // Otherwise, only capture a stack if a debugger is open.
100     if (state.lexicalGlobalObject()->debugger())
101         return createScriptCallStack(&state, ScriptCallStack::maxCallStackSizeToCapture);
102
103     return nullptr;
104 }
105
106 void RejectedPromiseTracker::promiseRejected(ExecState& state, JSDOMGlobalObject& globalObject, JSPromise& promise)
107 {
108     // https://html.spec.whatwg.org/multipage/webappapis.html#the-hostpromiserejectiontracker-implementation
109
110     JSValue reason = promise.result(state.vm());
111     m_aboutToBeNotifiedRejectedPromises.append(UnhandledPromise { globalObject, promise, createScriptCallStackFromReason(state, reason) });
112 }
113
114 void RejectedPromiseTracker::promiseHandled(ExecState&, JSDOMGlobalObject& globalObject, JSPromise& promise)
115 {
116     // https://html.spec.whatwg.org/multipage/webappapis.html#the-hostpromiserejectiontracker-implementation
117
118     bool removed = m_aboutToBeNotifiedRejectedPromises.removeFirstMatching([&] (UnhandledPromise& unhandledPromise) {
119         auto& domPromise = unhandledPromise.promise();
120         if (domPromise.isSuspended())
121             return false;
122         return domPromise.promise() == &promise;
123     });
124     if (removed)
125         return;
126
127     if (!m_outstandingRejectedPromises.remove(&promise))
128         return;
129
130     m_context.postTask([this, rejectedPromise = DOMPromise::create(globalObject, promise)] (ScriptExecutionContext&) mutable {
131         reportRejectionHandled(WTFMove(rejectedPromise));
132     });
133 }
134
135 void RejectedPromiseTracker::processQueueSoon()
136 {
137     // https://html.spec.whatwg.org/multipage/webappapis.html#notify-about-rejected-promises
138
139     if (m_aboutToBeNotifiedRejectedPromises.isEmpty())
140         return;
141
142     Vector<UnhandledPromise> items = WTFMove(m_aboutToBeNotifiedRejectedPromises);
143     m_context.postTask([this, items = WTFMove(items)] (ScriptExecutionContext&) mutable {
144         reportUnhandledRejections(WTFMove(items));
145     });
146 }
147
148 void RejectedPromiseTracker::reportUnhandledRejections(Vector<UnhandledPromise>&& unhandledPromises)
149 {
150     // https://html.spec.whatwg.org/multipage/webappapis.html#unhandled-promise-rejections
151
152     VM& vm = m_context.vm();
153     JSC::JSLockHolder lock(vm);
154
155     for (auto& unhandledPromise : unhandledPromises) {
156         auto& domPromise = unhandledPromise.promise();
157         if (domPromise.isSuspended())
158             continue;
159         auto& state = *domPromise.globalObject()->globalExec();
160         auto& promise = *domPromise.promise();
161
162         if (promise.isHandled(vm))
163             continue;
164
165         PromiseRejectionEvent::Init initializer;
166         initializer.cancelable = true;
167         initializer.promise = &domPromise;
168         initializer.reason = promise.result(vm);
169
170         auto event = PromiseRejectionEvent::create(state, eventNames().unhandledrejectionEvent, initializer);
171         auto target = m_context.errorEventTarget();
172         bool needsDefaultAction = target->dispatchEvent(event);
173
174         if (needsDefaultAction)
175             m_context.reportUnhandledPromiseRejection(state, promise, unhandledPromise.callStack());
176
177         if (!promise.isHandled(vm))
178             m_outstandingRejectedPromises.set(&promise, &promise);
179     }
180 }
181
182 void RejectedPromiseTracker::reportRejectionHandled(Ref<DOMPromise>&& rejectedPromise)
183 {
184     // https://html.spec.whatwg.org/multipage/webappapis.html#the-hostpromiserejectiontracker-implementation
185
186     VM& vm = m_context.vm();
187     JSC::JSLockHolder lock(vm);
188
189     if (rejectedPromise->isSuspended())
190         return;
191
192     auto& state = *rejectedPromise->globalObject()->globalExec();
193     auto& promise = *rejectedPromise->promise();
194
195     PromiseRejectionEvent::Init initializer;
196     initializer.promise = rejectedPromise.ptr();
197     initializer.reason = promise.result(vm);
198
199     auto event = PromiseRejectionEvent::create(state, eventNames().rejectionhandledEvent, initializer);
200     auto target = m_context.errorEventTarget();
201     target->dispatchEvent(event);
202 }
203
204 } // namespace WebCore