Handle IDLPromise<> properly
[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 "PromiseRejectionEvent.h"
34 #include "ScriptExecutionContext.h"
35 #include <heap/HeapInlines.h>
36 #include <heap/Strong.h>
37 #include <heap/StrongInlines.h>
38 #include <heap/Weak.h>
39 #include <heap/WeakInlines.h>
40 #include <inspector/ScriptCallStack.h>
41 #include <inspector/ScriptCallStackFactory.h>
42 #include <runtime/Exception.h>
43 #include <runtime/JSCJSValueInlines.h>
44 #include <runtime/JSGlobalObject.h>
45 #include <runtime/JSPromise.h>
46 #include <runtime/WeakGCMapInlines.h>
47
48 using namespace JSC;
49 using namespace Inspector;
50
51 namespace WebCore {
52
53 class UnhandledPromise {
54     WTF_MAKE_NONCOPYABLE(UnhandledPromise);
55 public:
56     UnhandledPromise(JSDOMGlobalObject& globalObject, JSPromise& promise, RefPtr<ScriptCallStack>&& stack)
57         : m_promise(DOMPromise::create(globalObject, promise))
58         , m_stack(WTFMove(stack))
59     {
60     }
61
62     UnhandledPromise(UnhandledPromise&&) = default;
63
64     ScriptCallStack* callStack()
65     {
66         return m_stack.get();
67     }
68
69     DOMPromise& promise()
70     {
71         return m_promise.get();
72     }
73
74 private:
75     Ref<DOMPromise> m_promise;
76     RefPtr<ScriptCallStack> m_stack;
77 };
78
79
80 RejectedPromiseTracker::RejectedPromiseTracker(ScriptExecutionContext& context, JSC::VM& vm)
81     : m_context(context)
82     , m_outstandingRejectedPromises(vm)
83 {
84 }
85
86 RejectedPromiseTracker::~RejectedPromiseTracker()
87 {
88 }
89
90 static RefPtr<ScriptCallStack> createScriptCallStackFromReason(ExecState& state, JSValue reason)
91 {
92     VM& vm = state.vm();
93
94     // Always capture a stack from the exception if this rejection was an exception.
95     if (auto* exception = vm.lastException()) {
96         if (exception->value() == reason)
97             return createScriptCallStackFromException(&state, exception, ScriptCallStack::maxCallStackSizeToCapture);
98     }
99
100     // Otherwise, only capture a stack if a debugger is open.
101     if (state.lexicalGlobalObject()->debugger())
102         return createScriptCallStack(&state, ScriptCallStack::maxCallStackSizeToCapture);
103
104     return nullptr;
105 }
106
107 void RejectedPromiseTracker::promiseRejected(ExecState& state, JSDOMGlobalObject& globalObject, JSPromise& promise)
108 {
109     // https://html.spec.whatwg.org/multipage/webappapis.html#the-hostpromiserejectiontracker-implementation
110
111     JSValue reason = promise.result(state.vm());
112     m_aboutToBeNotifiedRejectedPromises.append(UnhandledPromise { globalObject, promise, createScriptCallStackFromReason(state, reason) });
113 }
114
115 void RejectedPromiseTracker::promiseHandled(ExecState&, JSDOMGlobalObject& globalObject, JSPromise& promise)
116 {
117     // https://html.spec.whatwg.org/multipage/webappapis.html#the-hostpromiserejectiontracker-implementation
118
119     bool removed = m_aboutToBeNotifiedRejectedPromises.removeFirstMatching([&] (UnhandledPromise& unhandledPromise) {
120         auto& domPromise = unhandledPromise.promise();
121         if (domPromise.isSuspended())
122             return false;
123         return domPromise.promise() == &promise;
124     });
125     if (removed)
126         return;
127
128     if (!m_outstandingRejectedPromises.remove(&promise))
129         return;
130
131     m_context.postTask([this, rejectedPromise = DOMPromise::create(globalObject, promise)] (ScriptExecutionContext&) mutable {
132         reportRejectionHandled(WTFMove(rejectedPromise));
133     });
134 }
135
136 void RejectedPromiseTracker::processQueueSoon()
137 {
138     // https://html.spec.whatwg.org/multipage/webappapis.html#notify-about-rejected-promises
139
140     if (m_aboutToBeNotifiedRejectedPromises.isEmpty())
141         return;
142
143     Vector<UnhandledPromise> items = WTFMove(m_aboutToBeNotifiedRejectedPromises);
144     m_context.postTask([this, items = WTFMove(items)] (ScriptExecutionContext&) mutable {
145         reportUnhandledRejections(WTFMove(items));
146     });
147 }
148
149 void RejectedPromiseTracker::reportUnhandledRejections(Vector<UnhandledPromise>&& unhandledPromises)
150 {
151     // https://html.spec.whatwg.org/multipage/webappapis.html#unhandled-promise-rejections
152
153     VM& vm = m_context.vm();
154     JSC::JSLockHolder lock(vm);
155
156     for (auto& unhandledPromise : unhandledPromises) {
157         auto& domPromise = unhandledPromise.promise();
158         if (domPromise.isSuspended())
159             continue;
160         auto& state = *domPromise.globalObject()->globalExec();
161         auto& promise = *domPromise.promise();
162
163         if (promise.isHandled(vm))
164             continue;
165
166         PromiseRejectionEvent::Init initializer;
167         initializer.cancelable = true;
168         initializer.promise = &promise;
169         initializer.reason = promise.result(vm);
170
171         auto event = PromiseRejectionEvent::create(state, eventNames().unhandledrejectionEvent, initializer);
172         auto target = m_context.errorEventTarget();
173         bool needsDefaultAction = target->dispatchEvent(event);
174
175         if (needsDefaultAction)
176             m_context.reportUnhandledPromiseRejection(state, promise, unhandledPromise.callStack());
177
178         if (!promise.isHandled(vm))
179             m_outstandingRejectedPromises.set(&promise, &promise);
180     }
181 }
182
183 void RejectedPromiseTracker::reportRejectionHandled(Ref<DOMPromise>&& rejectedPromise)
184 {
185     // https://html.spec.whatwg.org/multipage/webappapis.html#the-hostpromiserejectiontracker-implementation
186
187     VM& vm = m_context.vm();
188     JSC::JSLockHolder lock(vm);
189
190     if (rejectedPromise->isSuspended())
191         return;
192
193     auto& state = *rejectedPromise->globalObject()->globalExec();
194     auto& promise = *rejectedPromise->promise();
195
196     PromiseRejectionEvent::Init initializer;
197     initializer.promise = &promise;
198     initializer.reason = promise.result(vm);
199
200     auto event = PromiseRejectionEvent::create(state, eventNames().rejectionhandledEvent, initializer);
201     auto target = m_context.errorEventTarget();
202     target->dispatchEvent(event);
203 }
204
205 } // namespace WebCore