70ce3a1c7b1a2036823c2a6dcc52a390b6c4e848
[WebKit-https.git] / Source / WebCore / bindings / js / ReadableJSStream.cpp
1 /*
2  * Copyright (C) 2015 Canon Inc.
3  * Copyright (C) 2015 Igalia S.L.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted, provided that the following conditions
7  * are required to be met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  * 3.  Neither the name of Canon Inc. nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY CANON INC. AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL CANON INC. AND ITS CONTRIBUTORS BE LIABLE FOR
22  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
25  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #include "config.h"
31 #include "ReadableJSStream.h"
32
33 #if ENABLE(STREAMS_API)
34
35 #include "DOMWrapperWorld.h"
36 #include "JSDOMPromise.h"
37 #include "JSReadableStream.h"
38 #include "JSReadableStreamController.h"
39 #include "ScriptExecutionContext.h"
40 #include <runtime/Error.h>
41 #include <runtime/Exception.h>
42 #include <runtime/JSCJSValueInlines.h>
43 #include <runtime/JSPromise.h>
44 #include <runtime/JSString.h>
45 #include <runtime/StructureInlines.h>
46
47 using namespace JSC;
48
49 namespace WebCore {
50
51 static inline JSValue getPropertyFromObject(ExecState& exec, JSObject* object, const char* identifier)
52 {
53     return object->get(&exec, Identifier::fromString(&exec, identifier));
54 }
55
56 static inline JSValue callFunction(ExecState& exec, JSValue jsFunction, JSValue thisValue, const ArgList& arguments)
57 {
58     CallData callData;
59     CallType callType = getCallData(jsFunction, callData);
60     return call(&exec, jsFunction, callType, callData, thisValue, arguments);
61 }
62
63 JSPromise* ReadableJSStream::invoke(ExecState& state, const char* propertyName)
64 {
65     JSValue function = getPropertyFromObject(state, m_source.get(), propertyName);
66     if (state.hadException())
67         return nullptr;
68
69     if (!function.isFunction()) {
70         if (!function.isUndefined())
71             throwVMError(&state, createTypeError(&state, ASCIILiteral("ReadableStream trying to call a property that is not callable")));
72         return nullptr;
73     }
74
75     MarkedArgumentBuffer arguments;
76     arguments.append(jsController(state, globalObject()));
77
78     JSPromise* promise = jsDynamicCast<JSPromise*>(callFunction(state, function, m_source.get(), arguments));
79
80     ASSERT(!(promise && state.hadException()));
81     return promise;
82 }
83
84 static void thenPromise(ExecState& state, JSPromise* deferredPromise, JSValue fullfilFunction, JSValue rejectFunction)
85 {
86     JSValue thenValue = deferredPromise->get(&state, state.vm().propertyNames->then);
87     if (state.hadException())
88         return;
89
90     MarkedArgumentBuffer arguments;
91     arguments.append(fullfilFunction);
92     arguments.append(rejectFunction);
93
94     callFunction(state, thenValue, deferredPromise, arguments);
95 }
96
97 JSDOMGlobalObject* ReadableJSStream::globalObject()
98 {
99     return jsDynamicCast<JSDOMGlobalObject*>(m_source->globalObject());
100 }
101
102 static inline JSFunction* createStartResultFulfilledFunction(ExecState& state, ReadableStream& readableStream)
103 {
104     RefPtr<ReadableStream> stream = &readableStream;
105     return JSFunction::create(state.vm(), state.callee()->globalObject(), 1, String(), [stream](ExecState*) {
106         stream->start();
107         return JSValue::encode(jsUndefined());
108     });
109 }
110
111 static inline void startReadableStreamAsync(ReadableStream& readableStream)
112 {
113     RefPtr<ReadableStream> stream = &readableStream;
114     stream->scriptExecutionContext()->postTask([stream](ScriptExecutionContext&) {
115         stream->start();
116     });
117 }
118
119 void ReadableJSStream::doStart(ExecState& exec)
120 {
121     JSLockHolder lock(&exec);
122
123     JSPromise* promise = invoke(exec, "start");
124
125     if (exec.hadException())
126         return;
127
128     if (!promise) {
129         startReadableStreamAsync(*this);
130         return;
131     }
132
133     thenPromise(exec, promise, createStartResultFulfilledFunction(exec, *this), m_errorFunction.get());
134 }
135
136 void ReadableJSStream::doPull()
137 {
138     ExecState& state = *globalObject()->globalExec();
139     JSLockHolder lock(&state);
140
141     invoke(state, "pull");
142
143     if (state.hadException()) {
144         storeException(state);
145         ASSERT(!state.hadException());
146         return;
147     }
148     // FIXME: Implement handling promise as result of calling pull function.
149 }
150
151 RefPtr<ReadableJSStream> ReadableJSStream::create(ExecState& exec, ScriptExecutionContext& scriptExecutionContext)
152 {
153     JSObject* jsSource;
154     JSValue value = exec.argument(0);
155     if (value.isObject())
156         jsSource = value.getObject();
157     else if (!value.isUndefined()) {
158         throwVMError(&exec, createTypeError(&exec, ASCIILiteral("ReadableStream constructor first argument, if any, should be an object")));
159         return nullptr;
160     } else
161         jsSource = JSFinalObject::create(exec.vm(), JSFinalObject::createStructure(exec.vm(), exec.callee()->globalObject(), jsNull(), 1));
162
163     RefPtr<ReadableJSStream> readableStream = adoptRef(*new ReadableJSStream(scriptExecutionContext, exec, jsSource));
164     readableStream->doStart(exec);
165
166     if (exec.hadException())
167         return nullptr;
168
169     return readableStream;
170 }
171
172 ReadableJSStream::ReadableJSStream(ScriptExecutionContext& scriptExecutionContext, ExecState& state, JSObject* source)
173     : ReadableStream(scriptExecutionContext)
174 {
175     m_source.set(state.vm(), source);
176     // We do not take a Ref to the stream as this would cause a Ref cycle.
177     // The resolution callback used jointly with m_errorFunction as promise callbacks should protect the stream instead.
178     m_errorFunction.set(state.vm(), JSFunction::create(state.vm(), state.callee()->globalObject(), 1, String(), [this](ExecState* state) {
179         storeError(*state);
180         return JSValue::encode(jsUndefined());
181     }));
182 }
183
184 JSValue ReadableJSStream::jsController(ExecState& exec, JSDOMGlobalObject* globalObject)
185 {
186     if (!m_controller)
187         m_controller = std::make_unique<ReadableStreamController>(*this);
188     return toJS(&exec, globalObject, m_controller.get());
189 }
190
191 void ReadableJSStream::storeException(JSC::ExecState& state)
192 {
193     JSValue exception = state.exception()->value();
194     state.clearException();
195     storeError(state, exception);
196 }
197
198 void ReadableJSStream::storeError(JSC::ExecState& exec)
199 {
200     storeError(exec, exec.argumentCount() ? exec.argument(0) : createError(&exec, ASCIILiteral("Error function called.")));
201 }
202
203 void ReadableJSStream::storeError(JSC::ExecState& exec, JSValue error)
204 {
205     if (m_error)
206         return;
207     m_error.set(exec.vm(), error);
208
209     changeStateToErrored();
210 }
211
212 bool ReadableJSStream::hasValue() const
213 {
214     return m_chunkQueue.size();
215 }
216
217 JSValue ReadableJSStream::read()
218 {
219     ASSERT(hasValue());
220
221     return m_chunkQueue.takeFirst().get();
222 }
223
224 void ReadableJSStream::enqueue(ExecState& exec)
225 {
226     ASSERT(!isCloseRequested());
227
228     if (!isReadable())
229         return;
230
231     JSValue chunk = exec.argumentCount() ? exec.argument(0) : jsUndefined();
232     if (resolveReadCallback(chunk)) {
233         pull();
234         return;
235     }
236
237     m_chunkQueue.append(JSC::Strong<JSC::Unknown>(exec.vm(), chunk));
238     // FIXME: Compute chunk size.
239     pull();
240 }
241
242 } // namespace WebCore
243
244 #endif