4d49ed9834fbc582adc792776edc7e0dadf2cf35
[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 DeferredWrapper : public RefCounted<DeferredWrapper>, public ActiveDOMCallback {
100 public:
101     // FIXME: We should pass references here, not pointers, see bug 161787
102     static Ref<DeferredWrapper> create(JSC::ExecState* state, JSDOMGlobalObject* globalObject, JSC::JSPromiseDeferred* deferred)
103     {
104         return adoptRef(*new DeferredWrapper(state, globalObject, deferred));
105     }
106
107     ~DeferredWrapper();
108
109     template<class ResolveResultType> typename std::enable_if<PromiseResultInspector<ResolveResultType>::passByValue, void>::type
110     resolve(ResolveResultType result) { resolveWithValue(result); }
111     template<class ResolveResultType> typename std::enable_if<PromiseResultInspector<ResolveResultType>::passByRef, void>::type
112     resolve(ResolveResultType& result) { resolveWithValue(result); }
113     template<class ResolveResultType> typename std::enable_if<PromiseResultInspector<ResolveResultType>::passByURef, void>::type
114     resolve(ResolveResultType&& result) { resolveWithValue(std::forward<ResolveResultType>(result)); }
115     template<class ResolveResultType> typename std::enable_if<PromiseResultInspector<ResolveResultType>::passByConstRef, void>::type
116     resolve(const ResolveResultType& result) { resolveWithValue(result); }
117
118     template<class RejectResultType> typename std::enable_if<PromiseResultInspector<RejectResultType>::passByValue, void>::type
119     reject(RejectResultType result) { rejectWithValue(result); }
120     template<class RejectResultType> typename std::enable_if<PromiseResultInspector<RejectResultType>::passByRef, void>::type
121     reject(RejectResultType& result) { rejectWithValue(result); }
122     template<class RejectResultType> typename std::enable_if<PromiseResultInspector<RejectResultType>::passByURef, void>::type
123     reject(RejectResultType&& result) { rejectWithValue(std::forward<RejectResultType>(result)); }
124     template<class RejectResultType> typename std::enable_if<PromiseResultInspector<RejectResultType>::passByConstRef, void>::type
125     reject(const RejectResultType& result) { rejectWithValue(result); }
126
127     template<class ResolveResultType> void resolveWithNewlyCreated(Ref<ResolveResultType>&&);
128
129     void reject(ExceptionCode, const String& = { });
130
131     JSC::JSValue promise() const;
132
133     bool isSuspended() { return !m_deferred || !canInvokeCallback(); } // The wrapper world has gone away or active DOM objects have been suspended.
134     JSDOMGlobalObject* globalObject() { return m_globalObject.get(); }
135
136     void visitAggregate(JSC::SlotVisitor& visitor) { visitor.appendUnbarrieredWeak(&m_deferred); }
137
138 private:
139     DeferredWrapper(JSC::ExecState*, JSDOMGlobalObject*, JSC::JSPromiseDeferred*);
140
141     void clear();
142     void contextDestroyed() override;
143
144     void callFunction(JSC::ExecState&, JSC::JSValue function, JSC::JSValue resolution);
145     void resolve(JSC::ExecState& state, JSC::JSValue resolution) { callFunction(state, m_deferred->resolve(), resolution); }
146     void reject(JSC::ExecState& state, JSC::JSValue resolution) { callFunction(state, m_deferred->reject(), resolution); }
147
148     template<class RejectResultType> void rejectWithValue(RejectResultType&&);
149     template<class ResolveResultType> void resolveWithValue(ResolveResultType&&);
150
151     JSC::Weak<JSC::JSPromiseDeferred> m_deferred;
152     JSC::Weak<JSDOMGlobalObject> m_globalObject;
153 };
154
155 void fulfillPromiseWithJSON(Ref<DeferredWrapper>&&, const String&);
156 void fulfillPromiseWithArrayBuffer(Ref<DeferredWrapper>&&, ArrayBuffer*);
157 void fulfillPromiseWithArrayBuffer(Ref<DeferredWrapper>&&, const void*, size_t);
158 void rejectPromiseWithExceptionIfAny(JSC::ExecState&, JSDOMGlobalObject&, JSC::JSPromiseDeferred&);
159 JSC::EncodedJSValue createRejectedPromiseWithTypeError(JSC::ExecState&, const String&);
160
161 using PromiseFunction = void(JSC::ExecState&, Ref<DeferredWrapper>&&);
162
163 enum class PromiseExecutionScope { WindowOnly, WindowOrWorker };
164
165 template<PromiseFunction promiseFunction, PromiseExecutionScope executionScope>
166 inline JSC::JSValue callPromiseFunction(JSC::ExecState& state)
167 {
168     JSC::VM& vm = state.vm();
169     auto scope = DECLARE_CATCH_SCOPE(vm);
170
171     JSDOMGlobalObject& globalObject = *JSC::jsCast<JSDOMGlobalObject*>(state.lexicalGlobalObject());
172     JSC::JSPromiseDeferred* promiseDeferred = JSC::JSPromiseDeferred::create(&state, &globalObject);
173
174     // promiseDeferred can be null when terminating a Worker abruptly.
175     if (executionScope == PromiseExecutionScope::WindowOrWorker && !promiseDeferred)
176         return JSC::jsUndefined();
177
178     promiseFunction(state, DeferredWrapper::create(&state, &globalObject, promiseDeferred));
179
180     rejectPromiseWithExceptionIfAny(state, globalObject, *promiseDeferred);
181     ASSERT_UNUSED(scope, !scope.exception());
182     return promiseDeferred->promise();
183 }
184
185 using BindingPromiseFunction = JSC::EncodedJSValue(JSC::ExecState*, Ref<DeferredWrapper>&&);
186 template<BindingPromiseFunction bindingFunction>
187 inline void bindingPromiseFunctionAdapter(JSC::ExecState& state, Ref<DeferredWrapper>&& promise)
188 {
189     bindingFunction(&state, WTFMove(promise));
190 }
191
192 template<BindingPromiseFunction bindingPromiseFunction, PromiseExecutionScope executionScope>
193 inline JSC::JSValue callPromiseFunction(JSC::ExecState& state)
194 {
195     return callPromiseFunction<bindingPromiseFunctionAdapter<bindingPromiseFunction>, executionScope>(state);
196 }
197
198 // At the moment, Value cannot be a Ref<T> or RefPtr<T>, it should be a DOM class.
199 template <typename Value>
200 class DOMPromise {
201 public:
202     DOMPromise(Ref<DeferredWrapper>&& wrapper)
203         : m_wrapper(WTFMove(wrapper))
204     {
205     }
206
207     DOMPromise(DOMPromise&& promise) : m_wrapper(WTFMove(promise.m_wrapper)) { }
208
209     DOMPromise(const DOMPromise&) = default;
210     DOMPromise& operator=(DOMPromise const&) = default;
211
212     void resolve(typename PromiseResultInspector<Value>::Type value) { m_wrapper->resolve(value); }
213
214     template<typename... ErrorType> void reject(ErrorType&&... error) { m_wrapper->reject(std::forward<ErrorType>(error)...); }
215
216     DeferredWrapper& deferredWrapper() { return m_wrapper; }
217
218 private:
219     Ref<DeferredWrapper> m_wrapper;
220 };
221
222 template<class ResolveResultType>
223 inline void DeferredWrapper::resolveWithValue(ResolveResultType&& result)
224 {
225     if (isSuspended())
226         return;
227     ASSERT(m_globalObject);
228     JSC::ExecState* exec = m_globalObject->globalExec();
229     JSC::JSLockHolder locker(exec);
230     resolve(*exec, toJS(exec, m_globalObject.get(), std::forward<ResolveResultType>(result)));
231 }
232
233 template<class ResolveResultType>
234 inline void DeferredWrapper::resolveWithNewlyCreated(Ref<ResolveResultType>&& result)
235 {
236     if (isSuspended())
237         return;
238     ASSERT(m_deferred);
239     ASSERT(m_globalObject);
240     JSC::ExecState* exec = m_globalObject->globalExec();
241     JSC::JSLockHolder locker(exec);
242     resolve(*exec, toJSNewlyCreated(exec, m_globalObject.get(), WTFMove(result)));
243 }
244
245 template<class RejectResultType>
246 inline void DeferredWrapper::rejectWithValue(RejectResultType&& result)
247 {
248     if (isSuspended())
249         return;
250     ASSERT(m_deferred);
251     ASSERT(m_globalObject);
252     JSC::ExecState* exec = m_globalObject->globalExec();
253     JSC::JSLockHolder locker(exec);
254     reject(*exec, toJS(exec, m_globalObject.get(), std::forward<RejectResultType>(result)));
255 }
256
257 template<>
258 inline void DeferredWrapper::resolve(bool result)
259 {
260     if (isSuspended())
261         return;
262     ASSERT(m_deferred);
263     ASSERT(m_globalObject);
264     JSC::ExecState* exec = m_globalObject->globalExec();
265     JSC::JSLockHolder locker(exec);
266     resolve(*exec, JSC::jsBoolean(result));
267 }
268
269 template<>
270 inline void DeferredWrapper::resolve(JSC::JSValue value)
271 {
272     if (isSuspended())
273         return;
274     ASSERT(m_deferred);
275     ASSERT(m_globalObject);
276     JSC::ExecState* exec = m_globalObject->globalExec();
277     JSC::JSLockHolder locker(exec);
278     resolve(*exec, value);
279 }
280
281 template<>
282 inline void DeferredWrapper::reject(JSC::JSValue value)
283 {
284     if (isSuspended())
285         return;
286     ASSERT(m_deferred);
287     ASSERT(m_globalObject);
288     JSC::ExecState* exec = m_globalObject->globalExec();
289     JSC::JSLockHolder locker(exec);
290     reject(*exec, value);
291 }
292
293 template<>
294 inline void DeferredWrapper::resolve(std::nullptr_t)
295 {
296     if (isSuspended())
297         return;
298     ASSERT(m_deferred);
299     ASSERT(m_globalObject);
300     JSC::ExecState* exec = m_globalObject->globalExec();
301     JSC::JSLockHolder locker(exec);
302     resolve(*exec, JSC::jsUndefined());
303 }
304
305 template<>
306 inline void DeferredWrapper::reject(std::nullptr_t)
307 {
308     if (isSuspended())
309         return;
310     ASSERT(m_deferred);
311     ASSERT(m_globalObject);
312     JSC::ExecState* exec = m_globalObject->globalExec();
313     JSC::JSLockHolder locker(exec);
314     reject(*exec, JSC::jsNull());
315 }
316
317 template<>
318 inline void DeferredWrapper::resolve(const String& result)
319 {
320     if (isSuspended())
321         return;
322     ASSERT(m_deferred);
323     ASSERT(m_globalObject);
324     JSC::ExecState* exec = m_globalObject->globalExec();
325     JSC::JSLockHolder locker(exec);
326     resolve(*exec, jsString(exec, result));
327 }
328
329 template<>
330 inline void DeferredWrapper::reject(const String& result)
331 {
332     if (isSuspended())
333         return;
334     ASSERT(m_deferred);
335     ASSERT(m_globalObject);
336     JSC::ExecState* exec = m_globalObject->globalExec();
337     JSC::JSLockHolder locker(exec);
338     reject(*exec, jsString(exec, result));
339 }
340
341 }
342
343 #endif // JSDOMPromise_h