348da124dd39779bada9a38e2d18a0caf79f2d24
[WebKit-https.git] / Source / WebCore / Modules / streams / WritableStream.js
1 /*
2  * Copyright (C) 2015 Canon Inc.
3  * Copyright (C) 2015 Igalia
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 // @conditional=ENABLE(STREAMS_API)
28
29 function initializeWritableStream(underlyingSink, strategy)
30 {
31     "use strict";
32
33     if (underlyingSink === @undefined)
34         underlyingSink = { };
35     if (strategy === @undefined)
36         strategy = { highWaterMark: 0, size: function() { return 1; } };
37
38     if (!@isObject(underlyingSink))
39         @throwTypeError("WritableStream constructor takes an object as first argument");
40
41     if (!@isObject(strategy))
42         @throwTypeError("WritableStream constructor takes an object as second argument, if any");
43
44     this.@underlyingSink = underlyingSink;
45     this.@closedPromiseCapability = @newPromiseCapability(@Promise);
46     this.@readyPromiseCapability = { @promise: @Promise.@resolve() };
47     this.@queue = @newQueue();
48     this.@state = @streamWritable;
49     this.@started = false;
50     this.@writing = false;
51
52     this.@strategy = @validateAndNormalizeQueuingStrategy(strategy.size, strategy.highWaterMark);
53
54     @syncWritableStreamStateWithQueue(this);
55
56     const errorFunction = (e) => {
57         @errorWritableStream(this, e);
58     };
59     this.@startedPromise = @promiseInvokeOrNoopNoCatch(underlyingSink, "start", [errorFunction]);
60     this.@startedPromise.@then(() => {
61         this.@started = true;
62         this.@startedPromise = @undefined;
63     }, errorFunction);
64
65     return this;
66 }
67
68 function abort(reason)
69 {
70     "use strict";
71
72     if (!@isWritableStream(this))
73         return @Promise.@reject(new @TypeError("The WritableStream.abort method can only be used on instances of WritableStream"));
74
75     if (this.@state === @streamClosed)
76         return @Promise.@resolve();
77
78     if (this.@state === @streamErrored)
79         return @Promise.@reject(this.@storedError);
80
81     @errorWritableStream(this, reason);
82
83     return @promiseInvokeOrFallbackOrNoop(this.@underlyingSink, "abort", [reason], "close", []).@then(function() { });
84 }
85
86 function close()
87 {
88     "use strict";
89
90     if (!@isWritableStream(this))
91         return @Promise.@reject(new @TypeError("The WritableStream.close method can only be used on instances of WritableStream"));
92
93     if (this.@state === @streamClosed || this.@state === @streamClosing)
94         return @Promise.@reject(new @TypeError("Cannot close a WritableString that is closed or closing"));
95
96     if (this.@state === @streamErrored)
97         return @Promise.@reject(this.@storedError);
98
99     if (this.@state === @streamWaiting)
100         this.@readyPromiseCapability.@resolve.@call();
101
102     this.@state = @streamClosing;
103     @enqueueValueWithSize(this.@queue, "close", 0);
104     @callOrScheduleWritableStreamAdvanceQueue(this);
105
106     return this.@closedPromiseCapability.@promise;
107 }
108
109 function write(chunk)
110 {
111     "use strict";
112
113     if (!@isWritableStream(this))
114         return @Promise.@reject(new @TypeError("The WritableStream.write method can only be used on instances of WritableStream"));
115
116     if (this.@state === @streamClosed || this.@state === @streamClosing)
117         return @Promise.@reject(new @TypeError("Cannot write on a WritableString that is closed or closing"));
118
119     if (this.@state === @streamErrored)
120         return @Promise.@reject(this.@storedError);
121
122     @assert(this.@state === @streamWritable || this.@state === @streamWaiting);
123
124     let chunkSize = 1;
125     if (this.@strategy.size !== @undefined) {
126         try {
127             chunkSize = this.@strategy.size.@call(@undefined, chunk);
128         } catch(e) {
129             @errorWritableStream(this, e);
130             return @Promise.@reject(e);
131         }
132     }
133
134     const promiseCapability = @newPromiseCapability(@Promise);
135     try {
136         @enqueueValueWithSize(this.@queue, { promiseCapability: promiseCapability, chunk: chunk }, chunkSize);
137     } catch (e) {
138         @errorWritableStream(this, e);
139         return @Promise.@reject(e);
140     }
141
142     @syncWritableStreamStateWithQueue(this);
143     @callOrScheduleWritableStreamAdvanceQueue(this);
144
145     return promiseCapability.@promise;
146 }
147
148 @getter
149 function closed()
150 {
151     "use strict";
152
153     if (!@isWritableStream(this))
154         return @Promise.@reject(new @TypeError("The WritableStream.closed getter can only be used on instances of WritableStream"));
155
156     return this.@closedPromiseCapability.@promise;
157 }
158
159 @getter
160 function ready()
161 {
162     "use strict";
163
164     if (!@isWritableStream(this))
165         return @Promise.@reject(new @TypeError("The WritableStream.ready getter can only be used on instances of WritableStream"));
166
167     return this.@readyPromiseCapability.@promise;
168 }
169
170 @getter
171 function state()
172 {
173     "use strict";
174
175     if (!@isWritableStream(this))
176         @throwTypeError("The WritableStream.state getter can only be used on instances of WritableStream");
177
178     switch(this.@state) {
179     case @streamClosed:
180         return "closed";
181     case @streamClosing:
182         return "closing";
183     case @streamErrored:
184         return "errored";
185     case @streamWaiting:
186         return "waiting";
187     case @streamWritable:
188         return "writable";
189     }
190
191     @assert(false);
192 }