<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[186740] trunk/Source/WebCore</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/186740">186740</a></dd>
<dt>Author</dt> <dd>youenn.fablet@crf.canon.fr</dd>
<dt>Date</dt> <dd>2015-07-12 09:28:11 -0700 (Sun, 12 Jul 2015)</dd>
</dl>
<h3>Log Message</h3>
<pre>[Streams API] Templating ReadableJSStream
https://bugs.webkit.org/show_bug.cgi?id=146802
Reviewed by Darin Adler.
Introducing ReadableStream::clearValues to clear queued values when cancelling and going into error state.
Introducing ReadableEnqueuingStream to handle the stream queue, as a class template.
Specialized ReadableEnqueuingStream for the purpose of ReadableJSStream (storage of JSValue with variable size).
Updated some static functions to accept a ReadableStream in lieu of the more specialized ReadableJSStream.
Covered by existing tests.
* Modules/streams/ReadableStream.cpp:
(WebCore::ReadableStream::changeStateToErrored):
(WebCore::ReadableStream::cancelNoCheck):
* Modules/streams/ReadableStream.h:
(WebCore::ReadableEnqueuingStream::ReadableEnqueuingStream):
(WebCore::ReadableEnqueuingStream::enqueueChunk):
(WebCore::ReadableEnqueuingStream<ChunkType>::read):
* bindings/js/ReadableJSStream.cpp:
(WebCore::ReadableEnqueuingStream<ReadableJSStreamValue>::read):
(WebCore::ReadableEnqueuingStream<ReadableJSStreamValue>::enqueueChunk):
(WebCore::createPullResultFulfilledFunction):
(WebCore::createCancelResultFulfilledFunction):
(WebCore::ReadableJSStream::ReadableJSStream):
(WebCore::ReadableJSStream::enqueue):
* bindings/js/ReadableJSStream.h:
(WebCore::ReadableJSStreamValue::create):
(WebCore::ReadableEnqueuingStream<ReadableJSStreamValue>::desiredSize):
(WebCore::ReadableEnqueuingStream<ReadableJSStreamValue>::ReadableEnqueuingStream):</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebCoreChangeLog">trunk/Source/WebCore/ChangeLog</a></li>
<li><a href="#trunkSourceWebCoreModulesstreamsReadableStreamcpp">trunk/Source/WebCore/Modules/streams/ReadableStream.cpp</a></li>
<li><a href="#trunkSourceWebCoreModulesstreamsReadableStreamh">trunk/Source/WebCore/Modules/streams/ReadableStream.h</a></li>
<li><a href="#trunkSourceWebCorebindingsjsReadableJSStreamcpp">trunk/Source/WebCore/bindings/js/ReadableJSStream.cpp</a></li>
<li><a href="#trunkSourceWebCorebindingsjsReadableJSStreamh">trunk/Source/WebCore/bindings/js/ReadableJSStream.h</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebCoreChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/ChangeLog (186739 => 186740)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/ChangeLog 2015-07-12 14:46:42 UTC (rev 186739)
+++ trunk/Source/WebCore/ChangeLog 2015-07-12 16:28:11 UTC (rev 186740)
</span><span class="lines">@@ -1,3 +1,38 @@
</span><ins>+2015-07-12 Youenn Fablet <youenn.fablet@crf.canon.fr>
+
+ [Streams API] Templating ReadableJSStream
+ https://bugs.webkit.org/show_bug.cgi?id=146802
+
+ Reviewed by Darin Adler.
+
+ Introducing ReadableStream::clearValues to clear queued values when cancelling and going into error state.
+
+ Introducing ReadableEnqueuingStream to handle the stream queue, as a class template.
+ Specialized ReadableEnqueuingStream for the purpose of ReadableJSStream (storage of JSValue with variable size).
+
+ Updated some static functions to accept a ReadableStream in lieu of the more specialized ReadableJSStream.
+
+ Covered by existing tests.
+
+ * Modules/streams/ReadableStream.cpp:
+ (WebCore::ReadableStream::changeStateToErrored):
+ (WebCore::ReadableStream::cancelNoCheck):
+ * Modules/streams/ReadableStream.h:
+ (WebCore::ReadableEnqueuingStream::ReadableEnqueuingStream):
+ (WebCore::ReadableEnqueuingStream::enqueueChunk):
+ (WebCore::ReadableEnqueuingStream<ChunkType>::read):
+ * bindings/js/ReadableJSStream.cpp:
+ (WebCore::ReadableEnqueuingStream<ReadableJSStreamValue>::read):
+ (WebCore::ReadableEnqueuingStream<ReadableJSStreamValue>::enqueueChunk):
+ (WebCore::createPullResultFulfilledFunction):
+ (WebCore::createCancelResultFulfilledFunction):
+ (WebCore::ReadableJSStream::ReadableJSStream):
+ (WebCore::ReadableJSStream::enqueue):
+ * bindings/js/ReadableJSStream.h:
+ (WebCore::ReadableJSStreamValue::create):
+ (WebCore::ReadableEnqueuingStream<ReadableJSStreamValue>::desiredSize):
+ (WebCore::ReadableEnqueuingStream<ReadableJSStreamValue>::ReadableEnqueuingStream):
+
</ins><span class="cx"> 2015-07-11 Babak Shafiei <bshafiei@apple.com>
</span><span class="cx">
</span><span class="cx"> Unreviewed build fix.
</span></span></pre></div>
<a id="trunkSourceWebCoreModulesstreamsReadableStreamcpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/Modules/streams/ReadableStream.cpp (186739 => 186740)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/Modules/streams/ReadableStream.cpp 2015-07-12 14:46:42 UTC (rev 186739)
+++ trunk/Source/WebCore/Modules/streams/ReadableStream.cpp 2015-07-12 16:28:11 UTC (rev 186740)
</span><span class="lines">@@ -105,6 +105,8 @@
</span><span class="cx"> {
</span><span class="cx"> if (m_state != State::Readable)
</span><span class="cx"> return;
</span><ins>+
+ clearValues();
</ins><span class="cx"> m_state = State::Errored;
</span><span class="cx">
</span><span class="cx"> JSC::JSValue error = this->error();
</span><span class="lines">@@ -197,6 +199,8 @@
</span><span class="cx"> }
</span><span class="cx"> ASSERT(m_state == State::Readable);
</span><span class="cx">
</span><ins>+ clearValues();
+
</ins><span class="cx"> m_cancelPromise = WTF::move(promise);
</span><span class="cx">
</span><span class="cx"> close();
</span></span></pre></div>
<a id="trunkSourceWebCoreModulesstreamsReadableStreamh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/Modules/streams/ReadableStream.h (186739 => 186740)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/Modules/streams/ReadableStream.h 2015-07-12 14:46:42 UTC (rev 186739)
+++ trunk/Source/WebCore/Modules/streams/ReadableStream.h 2015-07-12 16:28:11 UTC (rev 186740)
</span><span class="lines">@@ -33,7 +33,9 @@
</span><span class="cx"> #if ENABLE(STREAMS_API)
</span><span class="cx">
</span><span class="cx"> #include "ActiveDOMObject.h"
</span><ins>+#include "DOMRequestState.h"
</ins><span class="cx"> #include "JSDOMPromise.h"
</span><ins>+#include "ScriptState.h"
</ins><span class="cx"> #include "ScriptWrappable.h"
</span><span class="cx"> #include <functional>
</span><span class="cx"> #include <wtf/Deque.h>
</span><span class="lines">@@ -113,6 +115,7 @@
</span><span class="cx"> void clearCallbacks();
</span><span class="cx"> void close();
</span><span class="cx">
</span><ins>+ virtual void clearValues() = 0;
</ins><span class="cx"> virtual bool hasEnoughValues() const = 0;
</span><span class="cx"> virtual bool hasValue() const = 0;
</span><span class="cx"> virtual JSC::JSValue read() = 0;
</span><span class="lines">@@ -134,8 +137,33 @@
</span><span class="cx"> State m_state { State::Readable };
</span><span class="cx"> };
</span><span class="cx">
</span><ins>+// This class manages the queue and knows whether there is sufficient data in it.
+// Subclasses should implement error storage, pulling and cancelling.
+template<typename ChunkType>
+class ReadableEnqueuingStream final : public ReadableStream {
+protected:
+ explicit ReadableEnqueuingStream(ScriptExecutionContext& context) : ReadableStream(context) { }
+
+ void enqueueChunk(ChunkType&& chunk) { m_queue.append(std::forward(chunk)); }
+
+private:
+ virtual void clearValues() override { m_queue.clear(); }
+ virtual bool hasEnoughValues() const override { return m_queue.size(); }
+ virtual bool hasValue() const override { return m_queue.size(); }
+ virtual JSC::JSValue read() override;
+
+ Deque<ChunkType> m_queue;
+};
+
+template<typename ChunkType>
+inline JSC::JSValue ReadableEnqueuingStream<ChunkType>::read()
+{
+ DOMRequestState state(scriptExecutionContext());
+ return toJS(state.exec(), toJSDOMGlobalObject(scriptExecutionContext(), state.exec()), m_queue.read());
</ins><span class="cx"> }
</span><span class="cx">
</span><ins>+}
+
</ins><span class="cx"> #endif
</span><span class="cx">
</span><span class="cx"> #endif // ReadableStream_h
</span></span></pre></div>
<a id="trunkSourceWebCorebindingsjsReadableJSStreamcpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/bindings/js/ReadableJSStream.cpp (186739 => 186740)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/bindings/js/ReadableJSStream.cpp 2015-07-12 14:46:42 UTC (rev 186739)
+++ trunk/Source/WebCore/bindings/js/ReadableJSStream.cpp 2015-07-12 16:28:11 UTC (rev 186740)
</span><span class="lines">@@ -119,6 +119,19 @@
</span><span class="cx"> });
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+JSC::JSValue ReadableEnqueuingStream<ReadableJSStreamValue>::read()
+{
+ ReadableJSStreamValue chunk = m_queue.takeFirst();
+ m_totalQueueSize -= chunk.size;
+ return chunk.value.get();
+}
+
+void ReadableEnqueuingStream<ReadableJSStreamValue>::enqueueChunk(ReadableJSStreamValue&& chunk)
+{
+ m_totalQueueSize += chunk.size;
+ m_queue.append(WTF::move(chunk));
+}
+
</ins><span class="cx"> void ReadableJSStream::doStart(ExecState& exec)
</span><span class="cx"> {
</span><span class="cx"> JSLockHolder lock(&exec);
</span><span class="lines">@@ -136,9 +149,9 @@
</span><span class="cx"> thenPromise(exec, promise, createStartResultFulfilledFunction(exec, *this), m_errorFunction.get());
</span><span class="cx"> }
</span><span class="cx">
</span><del>-static inline JSFunction* createPullResultFulfilledFunction(ExecState& exec, ReadableJSStream& stream)
</del><ins>+static inline JSFunction* createPullResultFulfilledFunction(ExecState& exec, ReadableStream& stream)
</ins><span class="cx"> {
</span><del>- RefPtr<ReadableJSStream> protectedStream = &stream;
</del><ins>+ RefPtr<ReadableStream> protectedStream = &stream;
</ins><span class="cx"> return JSFunction::create(exec.vm(), exec.callee()->globalObject(), 0, String(), [protectedStream](ExecState*) {
</span><span class="cx"> protectedStream->finishPulling();
</span><span class="cx"> return JSValue::encode(jsUndefined());
</span><span class="lines">@@ -164,9 +177,9 @@
</span><span class="cx"> return !promise;
</span><span class="cx"> }
</span><span class="cx">
</span><del>-static JSFunction* createCancelResultFulfilledFunction(ExecState& exec, ReadableJSStream& stream)
</del><ins>+static JSFunction* createCancelResultFulfilledFunction(ExecState& exec, ReadableStream& stream)
</ins><span class="cx"> {
</span><del>- RefPtr<ReadableJSStream> protectedStream = &stream;
</del><ins>+ RefPtr<ReadableStream> protectedStream = &stream;
</ins><span class="cx"> return JSFunction::create(exec.vm(), exec.callee()->globalObject(), 1, String(), [protectedStream](ExecState*) {
</span><span class="cx"> protectedStream->notifyCancelSucceeded();
</span><span class="cx"> return JSValue::encode(jsUndefined());
</span><span class="lines">@@ -247,8 +260,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> ReadableJSStream::ReadableJSStream(ExecState& state, JSObject* source, double highWaterMark, JSFunction* sizeFunction)
</span><del>- : ReadableStream(*scriptExecutionContextFromExecState(&state))
- , m_highWaterMark(highWaterMark)
</del><ins>+ : ReadableEnqueuingStream<ReadableJSStreamValue>(*scriptExecutionContextFromExecState(&state), highWaterMark)
</ins><span class="cx"> {
</span><span class="cx"> m_source.set(state.vm(), source);
</span><span class="cx"> // We do not take a Ref to the stream as this would cause a Ref cycle.
</span><span class="lines">@@ -302,21 +314,6 @@
</span><span class="cx"> changeStateToErrored();
</span><span class="cx"> }
</span><span class="cx">
</span><del>-bool ReadableJSStream::hasValue() const
-{
- return m_chunkQueue.size();
-}
-
-JSValue ReadableJSStream::read()
-{
- ASSERT(hasValue());
-
- Chunk chunk = m_chunkQueue.takeFirst();
- m_totalQueueSize -= chunk.size;
-
- return chunk.value.get();
-}
-
</del><span class="cx"> void ReadableJSStream::enqueue(JSC::ExecState& state, JSC::JSValue chunk)
</span><span class="cx"> {
</span><span class="cx"> if (isErrored()) {
</span><span class="lines">@@ -339,8 +336,7 @@
</span><span class="cx"> if (state.hadException())
</span><span class="cx"> return;
</span><span class="cx">
</span><del>- m_chunkQueue.append({ JSC::Strong<JSC::Unknown>(state.vm(), chunk), size });
- m_totalQueueSize += size;
</del><ins>+ enqueueChunk({ JSC::Strong<JSC::Unknown>(state.vm(), chunk), size });
</ins><span class="cx">
</span><span class="cx"> pull();
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunkSourceWebCorebindingsjsReadableJSStreamh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/bindings/js/ReadableJSStream.h (186739 => 186740)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/bindings/js/ReadableJSStream.h 2015-07-12 14:46:42 UTC (rev 186739)
+++ trunk/Source/WebCore/bindings/js/ReadableJSStream.h 2015-07-12 16:28:11 UTC (rev 186740)
</span><span class="lines">@@ -52,8 +52,35 @@
</span><span class="cx">
</span><span class="cx"> typedef int ExceptionCode;
</span><span class="cx">
</span><del>-class ReadableJSStream: public ReadableStream {
</del><ins>+struct ReadableJSStreamValue {
+ JSC::Strong<JSC::Unknown> value;
+ double size;
+};
+
+template<> class ReadableEnqueuingStream<ReadableJSStreamValue> : public ReadableStream {
</ins><span class="cx"> public:
</span><ins>+ double desiredSize() const { return m_highWaterMark - m_totalQueueSize; }
+
+protected:
+ ReadableEnqueuingStream(ScriptExecutionContext& context, double highWaterMark)
+ : ReadableStream(context)
+ , m_highWaterMark(highWaterMark) { }
+
+ void enqueueChunk(ReadableJSStreamValue&&);
+
+private:
+ virtual void clearValues() override { m_queue.clear(); }
+ virtual bool hasEnoughValues() const override { return desiredSize() <= 0; }
+ virtual bool hasValue() const override { return m_queue.size(); }
+ virtual JSC::JSValue read() override;
+
+ Deque<ReadableJSStreamValue> m_queue;
+ double m_totalQueueSize { 0 };
+ double m_highWaterMark;
+};
+
+class ReadableJSStream final : public ReadableEnqueuingStream<ReadableJSStreamValue> {
+public:
</ins><span class="cx"> static RefPtr<ReadableJSStream> create(JSC::ExecState&, JSC::JSValue, const Dictionary&);
</span><span class="cx">
</span><span class="cx"> JSC::JSValue jsController(JSC::ExecState&, JSDOMGlobalObject*);
</span><span class="lines">@@ -65,8 +92,6 @@
</span><span class="cx"> void enqueue(JSC::ExecState&, JSC::JSValue);
</span><span class="cx"> void error(JSC::ExecState&, JSC::JSValue, ExceptionCode&);
</span><span class="cx">
</span><del>- double desiredSize() const { return m_highWaterMark - m_totalQueueSize; }
-
</del><span class="cx"> private:
</span><span class="cx"> ReadableJSStream(JSC::ExecState&, JSC::JSObject*, double, JSC::JSFunction*);
</span><span class="cx">
</span><span class="lines">@@ -75,9 +100,6 @@
</span><span class="cx"> JSC::JSPromise* invoke(JSC::ExecState&, const char*, JSC::JSValue parameter);
</span><span class="cx"> void storeException(JSC::ExecState&);
</span><span class="cx">
</span><del>- virtual bool hasEnoughValues() const override { return desiredSize() <= 0; }
- virtual bool hasValue() const override;
- virtual JSC::JSValue read() override;
</del><span class="cx"> virtual bool doPull() override;
</span><span class="cx"> virtual bool doCancel(JSC::JSValue) override;
</span><span class="cx">
</span><span class="lines">@@ -89,16 +111,8 @@
</span><span class="cx"> // FIXME: we should consider not using JSC::Strong, see https://bugs.webkit.org/show_bug.cgi?id=146278
</span><span class="cx"> JSC::Strong<JSC::Unknown> m_error;
</span><span class="cx"> JSC::Strong<JSC::JSFunction> m_errorFunction;
</span><ins>+
</ins><span class="cx"> JSC::Strong<JSC::JSObject> m_source;
</span><del>-
- struct Chunk {
- JSC::Strong<JSC::Unknown> value;
- double size;
- };
- Deque<Chunk> m_chunkQueue;
-
- double m_totalQueueSize { 0 };
- double m_highWaterMark;
</del><span class="cx"> JSC::Strong<JSC::JSFunction> m_sizeFunction;
</span><span class="cx"> };
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>