Improve DeferredWrapper code
[WebKit-https.git] / Source / WebCore / bindings / js / JSDOMPromise.h
1 /*
2  * Copyright (C) 2013 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef JSDOMPromise_h
27 #define JSDOMPromise_h
28
29 #include "ActiveDOMCallback.h"
30 #include "JSDOMBinding.h"
31 #include <heap/StrongInlines.h>
32 #include <runtime/JSPromiseDeferred.h>
33
34 namespace WebCore {
35
36 template<typename DOMClass>
37 struct TypeInspector {
38 private:
39     template<typename T> static constexpr auto testIsVector(int) -> decltype(std::declval<T>().shrinkToFit(), bool()) { return true; }
40     template<typename T> static constexpr bool testIsVector(...) { return false; }
41
42     template<typename T> static constexpr auto testIsRef(int) -> decltype(T::isRef) { return true; }
43     template<typename T> static constexpr bool testIsRef(...) { return false; }
44
45     template<typename T> static constexpr auto testIsRefPtr(int) -> decltype(T::isRefPtr) { return true; }
46     template<typename T> static constexpr bool testIsRefPtr(...) { return false; }
47
48 public:
49     static constexpr bool isRefOrRefPtr = testIsRef<DOMClass>(0) || testIsRefPtr<DOMClass>(0);
50     static constexpr bool isPassByValueType = std::is_pointer<DOMClass>::value
51         || std::is_same<DOMClass, std::nullptr_t>::value
52         || std::is_same<DOMClass, JSC::JSValue>::value
53         || std::is_same<DOMClass, bool>::value;
54     static constexpr bool isPassByConstRefType = testIsVector<DOMClass>(0)
55         || std::is_same<DOMClass, String>::value;
56 };
57
58 template<typename DOMClass, typename Enable = void>
59 struct PromiseResultInspector {
60 public:
61     static constexpr bool passByValue = false;
62     static constexpr bool passByRef = true;
63     static constexpr bool passByURef = false;
64     static constexpr bool passByConstRef = false;
65
66     typedef DOMClass& Type;
67 };
68
69 template<typename DOMClass>
70 struct PromiseResultInspector<DOMClass, typename std::enable_if<TypeInspector<DOMClass>::isPassByValueType>::type> {
71 public:
72     static constexpr bool passByValue = true;
73     static constexpr bool passByRef = false;
74     static constexpr bool passByURef = false;
75     static constexpr bool passByConstRef = false;
76
77     typedef DOMClass Type;
78 };
79
80 template<typename DOMClass>
81 struct PromiseResultInspector<DOMClass, typename std::enable_if<TypeInspector<DOMClass>::isPassByConstRefType>::type> {
82 public:
83     static constexpr bool passByValue = false;
84     static constexpr bool passByRef = false;
85     static constexpr bool passByURef = false;
86     static constexpr bool passByConstRef = true;
87
88     typedef const DOMClass& Type;
89 };
90
91 template<typename DOMClass>
92 struct PromiseResultInspector<DOMClass, typename std::enable_if<TypeInspector<DOMClass>::isRefOrRefPtr>::type> {
93     static constexpr bool passByValue = false;
94     static constexpr bool passByRef = false;
95     static constexpr bool passByURef = true;
96     static constexpr bool passByConstRef = false;
97 };
98
99 class DeferredPromise : public RefCounted<DeferredPromise>, public ActiveDOMCallback {
100 public:
101     static Ref<DeferredPromise> create(JSDOMGlobalObject& globalObject, JSC::JSPromiseDeferred& deferred)
102     {
103         return adoptRef(*new DeferredPromise(globalObject, deferred));
104     }
105
106     ~DeferredPromise();
107
108     template<class ResolveResultType> typename std::enable_if<PromiseResultInspector<ResolveResultType>::passByValue, void>::type
109     resolve(ResolveResultType result) { resolveWithValue(result); }
110     template<class ResolveResultType> typename std::enable_if<PromiseResultInspector<ResolveResultType>::passByRef, void>::type
111     resolve(ResolveResultType& result) { resolveWithValue(result); }
112     template<class ResolveResultType> typename std::enable_if<PromiseResultInspector<ResolveResultType>::passByURef, void>::type
113     resolve(ResolveResultType&& result) { resolveWithValue(std::forward<ResolveResultType>(result)); }
114     template<class ResolveResultType> typename std::enable_if<PromiseResultInspector<ResolveResultType>::passByConstRef, void>::type
115     resolve(const ResolveResultType& result) { resolveWithValue(result); }
116
117     template<class RejectResultType> typename std::enable_if<PromiseResultInspector<RejectResultType>::passByValue, void>::type
118     reject(RejectResultType result) { rejectWithValue(result); }
119     template<class RejectResultType> typename std::enable_if<PromiseResultInspector<RejectResultType>::passByRef, void>::type
120     reject(RejectResultType& result) { rejectWithValue(result); }
121     template<class RejectResultType> typename std::enable_if<PromiseResultInspector<RejectResultType>::passByURef, void>::type
122     reject(RejectResultType&& result) { rejectWithValue(std::forward<RejectResultType>(result)); }
123     template<class RejectResultType> typename std::enable_if<PromiseResultInspector<RejectResultType>::passByConstRef, void>::type
124     reject(const RejectResultType& result) { rejectWithValue(result); }
125
126     template<class ResolveResultType> void resolveWithNewlyCreated(Ref<ResolveResultType>&&);
127
128     void reject(ExceptionCode, const String& = { });
129
130     JSC::JSValue promise() const;
131
132     bool isSuspended() { return !m_deferred || !canInvokeCallback(); } // The wrapper world has gone away or active DOM objects have been suspended.
133     JSDOMGlobalObject* globalObject() { return m_globalObject.get(); }
134
135     void visitAggregate(JSC::SlotVisitor& visitor) { visitor.appendUnbarrieredWeak(&m_deferred); }
136
137 private:
138     DeferredPromise(JSDOMGlobalObject&, JSC::JSPromiseDeferred&);
139
140     void clear();
141     void contextDestroyed() override;
142
143     void callFunction(JSC::ExecState&, JSC::JSValue function, JSC::JSValue resolution);
144     void resolve(JSC::ExecState& state, JSC::JSValue resolution) { callFunction(state, m_deferred->resolve(), resolution); }
145     void reject(JSC::ExecState& state, JSC::JSValue resolution) { callFunction(state, m_deferred->reject(), resolution); }
146
147     template<class RejectResultType> void rejectWithValue(RejectResultType&&);
148     template<class ResolveResultType> void resolveWithValue(ResolveResultType&&);
149
150     JSC::Weak<JSC::JSPromiseDeferred> m_deferred;
151     JSC::Weak<JSDOMGlobalObject> m_globalObject;
152 };
153
154 Ref<DeferredPromise> createDeferredPromise(JSC::ExecState&, JSDOMWindow&);
155
156 void fulfillPromiseWithJSON(Ref<DeferredPromise>&&, const String&);
157 void fulfillPromiseWithArrayBuffer(Ref<DeferredPromise>&&, ArrayBuffer*);
158 void fulfillPromiseWithArrayBuffer(Ref<DeferredPromise>&&, const void*, size_t);
159 void rejectPromiseWithExceptionIfAny(JSC::ExecState&, JSDOMGlobalObject&, JSC::JSPromiseDeferred&);
160 JSC::EncodedJSValue createRejectedPromiseWithTypeError(JSC::ExecState&, const String&);
161
162 using PromiseFunction = void(JSC::ExecState&, Ref<DeferredPromise>&&);
163
164 enum class PromiseExecutionScope { WindowOnly, WindowOrWorker };
165
166 template<PromiseFunction promiseFunction, PromiseExecutionScope executionScope>
167 inline JSC::JSValue callPromiseFunction(JSC::ExecState& state)
168 {
169     JSC::VM& vm = state.vm();
170     auto scope = DECLARE_CATCH_SCOPE(vm);
171
172     JSDOMGlobalObject& globalObject = *JSC::jsCast<JSDOMGlobalObject*>(state.lexicalGlobalObject());
173     JSC::JSPromiseDeferred* promiseDeferred = JSC::JSPromiseDeferred::create(&state, &globalObject);
174
175     // promiseDeferred can be null when terminating a Worker abruptly.
176     if (executionScope == PromiseExecutionScope::WindowOrWorker && !promiseDeferred)
177         return JSC::jsUndefined();
178
179     promiseFunction(state, DeferredPromise::create(globalObject, *promiseDeferred));
180
181     rejectPromiseWithExceptionIfAny(state, globalObject, *promiseDeferred);
182     ASSERT_UNUSED(scope, !scope.exception());
183     return promiseDeferred->promise();
184 }
185
186 using BindingPromiseFunction = JSC::EncodedJSValue(JSC::ExecState*, Ref<DeferredPromise>&&);
187 template<BindingPromiseFunction bindingFunction>
188 inline void bindingPromiseFunctionAdapter(JSC::ExecState& state, Ref<DeferredPromise>&& promise)
189 {
190     bindingFunction(&state, WTFMove(promise));
191 }
192
193 template<BindingPromiseFunction bindingPromiseFunction, PromiseExecutionScope executionScope>
194 inline JSC::JSValue callPromiseFunction(JSC::ExecState& state)
195 {
196     return callPromiseFunction<bindingPromiseFunctionAdapter<bindingPromiseFunction>, executionScope>(state);
197 }
198
199 // At the moment, Value cannot be a Ref<T> or RefPtr<T>, it should be a DOM class.
200 template <typename Value>
201 class DOMPromise {
202 public:
203     DOMPromise(Ref<DeferredPromise>&& genericPromise) : m_promiseDeferred(WTFMove(genericPromise)) { }
204
205     DOMPromise(DOMPromise&& promise) : m_promiseDeferred(WTFMove(promise.m_promiseDeferred)) { }
206
207     DOMPromise(const DOMPromise&) = default;
208     DOMPromise& operator=(DOMPromise const&) = default;
209
210     void resolve(typename PromiseResultInspector<Value>::Type value) { m_promiseDeferred->resolve(value); }
211
212     template<typename... ErrorType> void reject(ErrorType&&... error) { m_promiseDeferred->reject(std::forward<ErrorType>(error)...); }
213
214     JSC::JSValue promise() const { return m_promiseDeferred->promise(); };
215
216 private:
217     Ref<DeferredPromise> m_promiseDeferred;
218 };
219
220 template<class ResolveResultType>
221 inline void DeferredPromise::resolveWithValue(ResolveResultType&& result)
222 {
223     if (isSuspended())
224         return;
225     ASSERT(m_globalObject);
226     JSC::ExecState* exec = m_globalObject->globalExec();
227     JSC::JSLockHolder locker(exec);
228     resolve(*exec, toJS(exec, m_globalObject.get(), std::forward<ResolveResultType>(result)));
229 }
230
231 template<class ResolveResultType>
232 inline void DeferredPromise::resolveWithNewlyCreated(Ref<ResolveResultType>&& result)
233 {
234     if (isSuspended())
235         return;
236     ASSERT(m_deferred);
237     ASSERT(m_globalObject);
238     JSC::ExecState* exec = m_globalObject->globalExec();
239     JSC::JSLockHolder locker(exec);
240     resolve(*exec, toJSNewlyCreated(exec, m_globalObject.get(), WTFMove(result)));
241 }
242
243 template<class RejectResultType>
244 inline void DeferredPromise::rejectWithValue(RejectResultType&& result)
245 {
246     if (isSuspended())
247         return;
248     ASSERT(m_deferred);
249     ASSERT(m_globalObject);
250     JSC::ExecState* exec = m_globalObject->globalExec();
251     JSC::JSLockHolder locker(exec);
252     reject(*exec, toJS(exec, m_globalObject.get(), std::forward<RejectResultType>(result)));
253 }
254
255 template<>
256 inline void DeferredPromise::resolve(bool result)
257 {
258     if (isSuspended())
259         return;
260     ASSERT(m_deferred);
261     ASSERT(m_globalObject);
262     JSC::ExecState* exec = m_globalObject->globalExec();
263     JSC::JSLockHolder locker(exec);
264     resolve(*exec, JSC::jsBoolean(result));
265 }
266
267 template<>
268 inline void DeferredPromise::resolve(JSC::JSValue value)
269 {
270     if (isSuspended())
271         return;
272     ASSERT(m_deferred);
273     ASSERT(m_globalObject);
274     JSC::ExecState* exec = m_globalObject->globalExec();
275     JSC::JSLockHolder locker(exec);
276     resolve(*exec, value);
277 }
278
279 template<>
280 inline void DeferredPromise::reject(JSC::JSValue value)
281 {
282     if (isSuspended())
283         return;
284     ASSERT(m_deferred);
285     ASSERT(m_globalObject);
286     JSC::ExecState* exec = m_globalObject->globalExec();
287     JSC::JSLockHolder locker(exec);
288     reject(*exec, value);
289 }
290
291 template<>
292 inline void DeferredPromise::resolve(std::nullptr_t)
293 {
294     if (isSuspended())
295         return;
296     ASSERT(m_deferred);
297     ASSERT(m_globalObject);
298     JSC::ExecState* exec = m_globalObject->globalExec();
299     JSC::JSLockHolder locker(exec);
300     resolve(*exec, JSC::jsUndefined());
301 }
302
303 template<>
304 inline void DeferredPromise::reject(std::nullptr_t)
305 {
306     if (isSuspended())
307         return;
308     ASSERT(m_deferred);
309     ASSERT(m_globalObject);
310     JSC::ExecState* exec = m_globalObject->globalExec();
311     JSC::JSLockHolder locker(exec);
312     reject(*exec, JSC::jsNull());
313 }
314
315 template<>
316 inline void DeferredPromise::resolve(const String& result)
317 {
318     if (isSuspended())
319         return;
320     ASSERT(m_deferred);
321     ASSERT(m_globalObject);
322     JSC::ExecState* exec = m_globalObject->globalExec();
323     JSC::JSLockHolder locker(exec);
324     resolve(*exec, jsString(exec, result));
325 }
326
327 template<>
328 inline void DeferredPromise::reject(const String& result)
329 {
330     if (isSuspended())
331         return;
332     ASSERT(m_deferred);
333     ASSERT(m_globalObject);
334     JSC::ExecState* exec = m_globalObject->globalExec();
335     JSC::JSLockHolder locker(exec);
336     reject(*exec, jsString(exec, result));
337 }
338
339 }
340
341 #endif // JSDOMPromise_h