[Streams API] Shield streams against user replacing the Promise constructor
[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 (typeof underlyingSink === "undefined")
34         underlyingSink = { };
35     if (typeof strategy === "undefined")
36         strategy = { highWaterMark: 0, size: function() { return 1; } };
37
38     if (!@isObject(underlyingSink))
39         throw new @TypeError("WritableStream constructor takes an object as first argument");
40
41     if (!@isObject(strategy))
42         throw new @TypeError("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(undefined) };
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     var error = @errorWritableStream.bind(this);
57     var startResult = @invokeOrNoop(underlyingSink, "start", [error]);
58     this.@startedPromise = @Promise.resolve(startResult);
59     var _this = this;
60     this.@startedPromise.then(function() {
61         _this.@started = true;
62         _this.@startedPromise = undefined;
63     }, error);
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(undefined);
77
78     if (this.@state === @streamErrored)
79         return @Promise.reject(this.@storedError);
80
81     @errorWritableStream.@apply(this, [reason]);
82
83     const sinkAbortPromise = @promiseInvokeOrFallbackOrNoop(this.@underlyingSink, "abort", [reason], "close", []);
84
85     return sinkAbortPromise.then(function() { return undefined; });
86 }
87
88 function close()
89 {
90     "use strict";
91
92     if (!@isWritableStream(this))
93         return @Promise.reject(new @TypeError("The WritableStream.close method can only be used on instances of WritableStream"));
94
95     if (this.@state === @streamClosed || this.@state === @streamClosing)
96         return @Promise.reject(new @TypeError("Cannot close a WritableString that is closed or closing"));
97
98     if (this.@state === @streamErrored)
99         return @Promise.reject(this.@storedError);
100
101     if (this.@state === @streamWaiting)
102         this.@readyPromiseCapability.@resolve.@call(undefined, undefined);
103
104     this.@state = @streamClosing;
105     @enqueueValueWithSize(this.@queue, "close", 0);
106     @callOrScheduleWritableStreamAdvanceQueue(this);
107
108     return this.@closedPromiseCapability.@promise;
109 }
110
111 function write(chunk)
112 {
113     "use strict";
114
115     if (!@isWritableStream(this))
116         return @Promise.reject(new @TypeError("The WritableStream.close method can only be used on instances of WritableStream"));
117
118     if (this.@state === @streamClosed || this.@state === @streamClosing)
119         return @Promise.reject(new @TypeError("Cannot write on a WritableString that is closed or closing"));
120
121     if (this.@state === @streamErrored)
122         return @Promise.reject(this.@storedError);
123
124     // FIXME
125     // assert(this.@state === @streamWritable || this.@state === @streamWaiting);
126
127     let chunkSize = 1;
128     if (this.@strategy.size !== undefined) {
129         try {
130             chunkSize = this.@strategy.size.@call(undefined, chunk);
131         } catch(e) {
132             @errorWritableStream.@call(this, e);
133             return @Promise.reject(e);
134         }
135     }
136
137     const promiseCapability = @newPromiseCapability(@Promise);
138     try {
139         @enqueueValueWithSize(this.@queue, { promiseCapability: promiseCapability, chunk: chunk }, chunkSize);
140     } catch (e) {
141         @errorWritableStream.@call(this, e);
142         return @Promise.reject(e);
143     }
144
145     @syncWritableStreamStateWithQueue(this);
146     @callOrScheduleWritableStreamAdvanceQueue(this);
147
148     return promiseCapability.@promise;
149 }
150
151 function closed()
152 {
153     "use strict";
154
155     if (!@isWritableStream(this))
156         return @Promise.reject(new @TypeError("The WritableStream.closed getter can only be used on instances of WritableStream"));
157
158     return this.@closedPromiseCapability.@promise;
159 }
160
161 function ready()
162 {
163     "use strict";
164
165     if (!@isWritableStream(this))
166         return @Promise.reject(new @TypeError("The WritableStream.ready getter can only be used on instances of WritableStream"));
167
168     return this.@readyPromiseCapability.@promise;
169 }
170
171 function state()
172 {
173     "use strict";
174
175     if (!@isWritableStream(this))
176         throw new @TypeError("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     // FIXME
192     // assert_not_reached();
193
194     return undefined;
195 }