AbstractOperations.cpp 121 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798
  1. /*
  2. * Copyright (c) 2022, Linus Groh <linusg@serenityos.org>
  3. * Copyright (c) 2023, Matthew Olsson <mattco@serenityos.org>
  4. * Copyright (c) 2023, Shannon Booth <shannon.ml.booth@gmail.com>
  5. *
  6. * SPDX-License-Identifier: BSD-2-Clause
  7. */
  8. #include <LibJS/Runtime/ArrayBuffer.h>
  9. #include <LibJS/Runtime/PromiseCapability.h>
  10. #include <LibJS/Runtime/PromiseConstructor.h>
  11. #include <LibWeb/Bindings/ExceptionOrUtils.h>
  12. #include <LibWeb/DOM/AbortSignal.h>
  13. #include <LibWeb/Streams/AbstractOperations.h>
  14. #include <LibWeb/Streams/QueuingStrategy.h>
  15. #include <LibWeb/Streams/ReadableByteStreamController.h>
  16. #include <LibWeb/Streams/ReadableStream.h>
  17. #include <LibWeb/Streams/ReadableStreamBYOBReader.h>
  18. #include <LibWeb/Streams/ReadableStreamBYOBRequest.h>
  19. #include <LibWeb/Streams/ReadableStreamDefaultController.h>
  20. #include <LibWeb/Streams/ReadableStreamDefaultReader.h>
  21. #include <LibWeb/Streams/ReadableStreamGenericReader.h>
  22. #include <LibWeb/Streams/UnderlyingSink.h>
  23. #include <LibWeb/Streams/UnderlyingSource.h>
  24. #include <LibWeb/Streams/WritableStream.h>
  25. #include <LibWeb/Streams/WritableStreamDefaultController.h>
  26. #include <LibWeb/Streams/WritableStreamDefaultWriter.h>
  27. #include <LibWeb/WebIDL/AbstractOperations.h>
  28. #include <LibWeb/WebIDL/ExceptionOr.h>
  29. #include <LibWeb/WebIDL/Promise.h>
  30. namespace Web::Streams {
  31. // https://streams.spec.whatwg.org/#acquire-readable-stream-reader
  32. WebIDL::ExceptionOr<JS::NonnullGCPtr<ReadableStreamDefaultReader>> acquire_readable_stream_default_reader(ReadableStream& stream)
  33. {
  34. auto& realm = stream.realm();
  35. // 1. Let reader be a new ReadableStreamDefaultReader.
  36. auto reader = TRY(realm.heap().allocate<ReadableStreamDefaultReader>(realm, realm));
  37. // 2. Perform ? SetUpReadableStreamDefaultReader(reader, stream).
  38. TRY(set_up_readable_stream_default_reader(reader, stream));
  39. // 3. Return reader.
  40. return reader;
  41. }
  42. // https://streams.spec.whatwg.org/#is-readable-stream-locked
  43. bool is_readable_stream_locked(ReadableStream const& stream)
  44. {
  45. // 1. If stream.[[reader]] is undefined, return false.
  46. if (!stream.reader().has_value())
  47. return false;
  48. // 2. Return true.
  49. return true;
  50. }
  51. // https://streams.spec.whatwg.org/#readable-stream-cancel
  52. WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> readable_stream_cancel(ReadableStream& stream, JS::Value reason)
  53. {
  54. auto& realm = stream.realm();
  55. // 1. Set stream.[[disturbed]] to true.
  56. stream.set_disturbed(true);
  57. // 2. If stream.[[state]] is "closed", return a promise resolved with undefined.
  58. if (stream.state() == ReadableStream::State::Closed)
  59. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  60. // 3. If stream.[[state]] is "errored", return a promise rejected with stream.[[storedError]].
  61. if (stream.state() == ReadableStream::State::Errored)
  62. return WebIDL::create_rejected_promise(realm, stream.stored_error());
  63. // 4. Perform ! ReadableStreamClose(stream).
  64. readable_stream_close(stream);
  65. // 5. Let reader be stream.[[reader]].
  66. auto reader = stream.reader();
  67. // 6. If reader is not undefined and reader implements ReadableStreamBYOBReader,
  68. if (reader.has_value() && reader->has<JS::NonnullGCPtr<ReadableStreamBYOBReader>>()) {
  69. // 1. Let readIntoRequests be reader.[[readIntoRequests]].
  70. // 2. Set reader.[[readIntoRequests]] to an empty list.
  71. auto read_into_requests = move(reader->get<JS::NonnullGCPtr<ReadableStreamBYOBReader>>()->read_into_requests());
  72. // 3. For each readIntoRequest of readIntoRequests,
  73. for (auto& read_into_request : read_into_requests) {
  74. // 1. Perform readIntoRequest’s close steps, given undefined.
  75. read_into_request->on_close(JS::js_undefined());
  76. }
  77. }
  78. // 7. Let sourceCancelPromise be ! stream.[[controller]].[[CancelSteps]](reason).
  79. auto source_cancel_promise = TRY(stream.controller()->visit([&](auto const& controller) {
  80. return controller->cancel_steps(reason);
  81. }));
  82. // 8. Return the result of reacting to sourceCancelPromise with a fulfillment step that returns undefined.
  83. auto react_result = WebIDL::react_to_promise(*source_cancel_promise,
  84. [](auto const&) -> WebIDL::ExceptionOr<JS::Value> { return JS::js_undefined(); },
  85. {});
  86. return WebIDL::create_resolved_promise(realm, react_result);
  87. }
  88. // https://streams.spec.whatwg.org/#readable-stream-fulfill-read-request
  89. void readable_stream_fulfill_read_request(ReadableStream& stream, JS::Value chunk, bool done)
  90. {
  91. // 1. Assert: ! ReadableStreamHasDefaultReader(stream) is true.
  92. VERIFY(readable_stream_has_default_reader(stream));
  93. // 2. Let reader be stream.[[reader]].
  94. auto reader = stream.reader()->get<JS::NonnullGCPtr<ReadableStreamDefaultReader>>();
  95. // 3. Assert: reader.[[readRequests]] is not empty.
  96. VERIFY(!reader->read_requests().is_empty());
  97. // 4. Let readRequest be reader.[[readRequests]][0].
  98. // 5. Remove readRequest from reader.[[readRequests]].
  99. auto read_request = reader->read_requests().take_first();
  100. // 6. If done is true, perform readRequest’s close steps.
  101. if (done) {
  102. read_request->on_close();
  103. }
  104. // 7. Otherwise, perform readRequest’s chunk steps, given chunk.
  105. else {
  106. read_request->on_chunk(chunk);
  107. }
  108. }
  109. // https://streams.spec.whatwg.org/#readable-stream-get-num-read-into-requests
  110. size_t readable_stream_get_num_read_into_requests(ReadableStream const& stream)
  111. {
  112. // 1. Assert: ! ReadableStreamHasBYOBReader(stream) is true.
  113. VERIFY(readable_stream_has_byob_reader(stream));
  114. // 2. Return stream.[[reader]].[[readIntoRequests]]'s size.
  115. return stream.reader()->get<JS::NonnullGCPtr<ReadableStreamBYOBReader>>()->read_into_requests().size();
  116. }
  117. // https://streams.spec.whatwg.org/#readable-stream-get-num-read-requests
  118. size_t readable_stream_get_num_read_requests(ReadableStream const& stream)
  119. {
  120. // 1. Assert: ! ReadableStreamHasDefaultReader(stream) is true.
  121. VERIFY(readable_stream_has_default_reader(stream));
  122. // 2. Return stream.[[reader]].[[readRequests]]'s size.
  123. return stream.reader()->get<JS::NonnullGCPtr<ReadableStreamDefaultReader>>()->read_requests().size();
  124. }
  125. // https://streams.spec.whatwg.org/#readable-stream-has-byob-reader
  126. bool readable_stream_has_byob_reader(ReadableStream const& stream)
  127. {
  128. // 1. Let reader be stream.[[reader]].
  129. auto reader = stream.reader();
  130. // 2. If reader is undefined, return false.
  131. if (!reader.has_value())
  132. return false;
  133. // 3. If reader implements ReadableStreamBYOBReader, return true.
  134. if (reader->has<JS::NonnullGCPtr<ReadableStreamBYOBReader>>())
  135. return true;
  136. // 4. Return false.
  137. return false;
  138. }
  139. // https://streams.spec.whatwg.org/#readable-stream-has-default-reader
  140. bool readable_stream_has_default_reader(ReadableStream const& stream)
  141. {
  142. // 1. Let reader be stream.[[reader]].
  143. auto reader = stream.reader();
  144. // 2. If reader is undefined, return false.
  145. if (!reader.has_value())
  146. return false;
  147. // 3. If reader implements ReadableStreamDefaultReader, return true.
  148. if (reader->has<JS::NonnullGCPtr<ReadableStreamDefaultReader>>())
  149. return true;
  150. // 4. Return false.
  151. return false;
  152. }
  153. // https://streams.spec.whatwg.org/#make-size-algorithm-from-size-function
  154. SizeAlgorithm extract_size_algorithm(QueuingStrategy const& strategy)
  155. {
  156. // 1. If strategy["size"] does not exist, return an algorithm that returns 1.
  157. if (!strategy.size)
  158. return [](auto const&) { return JS::normal_completion(JS::Value(1)); };
  159. // 2. Return an algorithm that performs the following steps, taking a chunk argument:
  160. return [strategy](auto const& chunk) {
  161. // 1. Return the result of invoking strategy["size"] with argument list « chunk ».
  162. return WebIDL::invoke_callback(*strategy.size, JS::js_undefined(), chunk);
  163. };
  164. }
  165. // https://streams.spec.whatwg.org/#validate-and-normalize-high-water-mark
  166. WebIDL::ExceptionOr<double> extract_high_water_mark(QueuingStrategy const& strategy, double default_hwm)
  167. {
  168. // 1. If strategy["highWaterMark"] does not exist, return defaultHWM.
  169. if (!strategy.high_water_mark.has_value())
  170. return default_hwm;
  171. // 2. Let highWaterMark be strategy["highWaterMark"].
  172. auto high_water_mark = strategy.high_water_mark.value();
  173. // 3. If highWaterMark is NaN or highWaterMark < 0, throw a RangeError exception.
  174. if (isnan(high_water_mark) || high_water_mark < 0)
  175. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::RangeError, "Invalid value for high water mark"sv };
  176. // 4. Return highWaterMark.
  177. return high_water_mark;
  178. }
  179. // https://streams.spec.whatwg.org/#readable-stream-close
  180. void readable_stream_close(ReadableStream& stream)
  181. {
  182. auto& realm = stream.realm();
  183. // 1. Assert: stream.[[state]] is "readable".
  184. VERIFY(stream.state() == ReadableStream::State::Readable);
  185. // 2. Set stream.[[state]] to "closed".
  186. stream.set_state(ReadableStream::State::Closed);
  187. // 3. Let reader be stream.[[reader]].
  188. auto reader = stream.reader();
  189. // 4. If reader is undefined, return.
  190. if (!reader.has_value())
  191. return;
  192. // 5. Resolve reader.[[closedPromise]] with undefined.
  193. WebIDL::resolve_promise(realm, *reader->visit([](auto& reader) {
  194. return reader->closed_promise_capability();
  195. }));
  196. // 6. If reader implements ReadableStreamDefaultReader,
  197. if (reader->has<JS::NonnullGCPtr<ReadableStreamDefaultReader>>()) {
  198. // 1. Let readRequests be reader.[[readRequests]].
  199. // 2. Set reader.[[readRequests]] to an empty list.
  200. auto read_requests = move(reader->get<JS::NonnullGCPtr<ReadableStreamDefaultReader>>()->read_requests());
  201. // 3. For each readRequest of readRequests,
  202. for (auto& read_request : read_requests) {
  203. // 1. Perform readRequest’s close steps.
  204. read_request->on_close();
  205. }
  206. }
  207. }
  208. // https://streams.spec.whatwg.org/#readable-stream-error
  209. void readable_stream_error(ReadableStream& stream, JS::Value error)
  210. {
  211. auto& realm = stream.realm();
  212. // 1. Assert: stream.[[state]] is "readable".
  213. VERIFY(stream.state() == ReadableStream::State::Readable);
  214. // 2. Set stream.[[state]] to "errored".
  215. stream.set_state(ReadableStream::State::Errored);
  216. // 3. Set stream.[[storedError]] to e.
  217. stream.set_stored_error(error);
  218. // 4. Let reader be stream.[[reader]].
  219. auto reader = stream.reader();
  220. // 5. If reader is undefined, return.
  221. if (!reader.has_value())
  222. return;
  223. auto closed_promise_capability = reader->visit([](auto& reader) { return reader->closed_promise_capability(); });
  224. // 6. Reject reader.[[closedPromise]] with e.
  225. WebIDL::reject_promise(realm, *closed_promise_capability, error);
  226. // 7. Set reader.[[closedPromise]].[[PromiseIsHandled]] to true.
  227. WebIDL::mark_promise_as_handled(*closed_promise_capability);
  228. // 8. If reader implements ReadableStreamDefaultReader,
  229. if (reader->has<JS::NonnullGCPtr<ReadableStreamDefaultReader>>()) {
  230. // 1. Perform ! ReadableStreamDefaultReaderErrorReadRequests(reader, e).
  231. readable_stream_default_reader_error_read_requests(*reader->get<JS::NonnullGCPtr<ReadableStreamDefaultReader>>(), error);
  232. }
  233. // 9. Otherwise,
  234. else {
  235. // 1. Assert: reader implements ReadableStreamBYOBReader.
  236. // 2. Perform ! ReadableStreamBYOBReaderErrorReadIntoRequests(reader, e).
  237. // FIXME: Handle BYOBReader
  238. TODO();
  239. }
  240. }
  241. // https://streams.spec.whatwg.org/#readable-stream-add-read-request
  242. void readable_stream_add_read_request(ReadableStream& stream, ReadRequest const& read_request)
  243. {
  244. // 1. Assert: stream.[[reader]] implements ReadableStreamDefaultReader.
  245. VERIFY(stream.reader().has_value() && stream.reader()->has<JS::NonnullGCPtr<ReadableStreamDefaultReader>>());
  246. // 2. Assert: stream.[[state]] is "readable".
  247. VERIFY(stream.state() == ReadableStream::State::Readable);
  248. // 3. Append readRequest to stream.[[reader]].[[readRequests]].
  249. stream.reader()->get<JS::NonnullGCPtr<ReadableStreamDefaultReader>>()->read_requests().append(read_request);
  250. }
  251. // https://streams.spec.whatwg.org/#readable-stream-reader-generic-cancel
  252. WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> readable_stream_reader_generic_cancel(ReadableStreamGenericReaderMixin& reader, JS::Value reason)
  253. {
  254. // 1. Let stream be reader.[[stream]]
  255. auto stream = reader.stream();
  256. // 2. Assert: stream is not undefined
  257. VERIFY(stream);
  258. // 3. Return ! ReadableStreamCancel(stream, reason)
  259. return TRY(readable_stream_cancel(*stream, reason));
  260. }
  261. // https://streams.spec.whatwg.org/#readable-stream-reader-generic-initialize
  262. void readable_stream_reader_generic_initialize(ReadableStreamReader reader, ReadableStream& stream)
  263. {
  264. auto& realm = stream.realm();
  265. // 1. Set reader.[[stream]] to stream.
  266. reader.visit([&](auto& reader) { reader->set_stream(stream); });
  267. // 2. Set stream.[[reader]] to reader.
  268. stream.set_reader(reader);
  269. // 3. If stream.[[state]] is "readable",
  270. if (stream.state() == ReadableStream::State::Readable) {
  271. // 1. Set reader.[[closedPromise]] to a new promise.
  272. reader.visit([&](auto& reader) { reader->set_closed_promise_capability(WebIDL::create_promise(realm)); });
  273. }
  274. // 4. Otherwise, if stream.[[state]] is "closed",
  275. else if (stream.state() == ReadableStream::State::Closed) {
  276. // 1. Set reader.[[closedPromise]] to a promise resolved with undefined.
  277. reader.visit([&](auto& reader) {
  278. reader->set_closed_promise_capability(WebIDL::create_resolved_promise(realm, JS::js_undefined()));
  279. });
  280. }
  281. // 5. Otherwise,
  282. else {
  283. // 1. Assert: stream.[[state]] is "errored".
  284. VERIFY(stream.state() == ReadableStream::State::Errored);
  285. // 2. Set reader.[[closedPromise]] to a promise rejected with stream.[[storedError]].
  286. // 3. Set reader.[[closedPromise]].[[PromiseIsHandled]] to true.
  287. reader.visit([&](auto& reader) {
  288. reader->set_closed_promise_capability(WebIDL::create_rejected_promise(realm, stream.stored_error()));
  289. WebIDL::mark_promise_as_handled(*reader->closed_promise_capability());
  290. });
  291. }
  292. }
  293. // https://streams.spec.whatwg.org/#readable-stream-reader-generic-release
  294. WebIDL::ExceptionOr<void> readable_stream_reader_generic_release(ReadableStreamGenericReaderMixin& reader)
  295. {
  296. // 1. Let stream be reader.[[stream]].
  297. auto stream = reader.stream();
  298. // 2. Assert: stream is not undefined.
  299. VERIFY(stream);
  300. // 3. Assert: stream.[[reader]] is reader.
  301. VERIFY(stream->reader()->visit([](auto& reader) -> ReadableStreamGenericReaderMixin* { return reader.ptr(); }) == &reader);
  302. auto& realm = stream->realm();
  303. // 4. If stream.[[state]] is "readable", reject reader.[[closedPromise]] with a TypeError exception.
  304. auto exception = MUST_OR_THROW_OOM(JS::TypeError::create(realm, "Released readable stream"sv));
  305. if (stream->is_readable()) {
  306. WebIDL::reject_promise(realm, *reader.closed_promise_capability(), exception);
  307. }
  308. // 5. Otherwise, set reader.[[closedPromise]] to a promise rejected with a TypeError exception.
  309. else {
  310. reader.set_closed_promise_capability(WebIDL::create_rejected_promise(realm, exception));
  311. }
  312. // 6. Set reader.[[closedPromise]].[[PromiseIsHandled]] to true.
  313. WebIDL::mark_promise_as_handled(*reader.closed_promise_capability());
  314. // 7. Perform ! stream.[[controller]].[[ReleaseSteps]]().
  315. TRY(stream->controller()->visit([](auto const& controller) { return controller->release_steps(); }));
  316. // 8. Set stream.[[reader]] to undefined.
  317. stream->set_reader({});
  318. // 9. Set reader.[[stream]] to undefined.
  319. reader.set_stream({});
  320. return {};
  321. }
  322. // https://streams.spec.whatwg.org/#abstract-opdef-readablestreamdefaultreadererrorreadrequests
  323. void readable_stream_default_reader_error_read_requests(ReadableStreamDefaultReader& reader, JS::Value error)
  324. {
  325. // 1. Let readRequests be reader.[[readRequests]].
  326. // 2. Set reader.[[readRequests]] to a new empty list.
  327. auto read_requests = move(reader.read_requests());
  328. // 3. For each readRequest of readRequests,
  329. for (auto& read_request : read_requests) {
  330. // 1. Perform readRequest’s error steps, given e.
  331. read_request->on_error(error);
  332. }
  333. }
  334. // https://streams.spec.whatwg.org/#readable-stream-default-reader-read
  335. WebIDL::ExceptionOr<void> readable_stream_default_reader_read(ReadableStreamDefaultReader& reader, ReadRequest& read_request)
  336. {
  337. // 1. Let stream be reader.[[stream]].
  338. auto stream = reader.stream();
  339. // 2. Assert: stream is not undefined.
  340. VERIFY(stream);
  341. // 3. Set stream.[[disturbed]] to true.
  342. stream->set_disturbed(true);
  343. // 4. If stream.[[state]] is "closed", perform readRequest’s close steps.
  344. if (stream->is_closed()) {
  345. read_request.on_close();
  346. }
  347. // 5. Otherwise, if stream.[[state]] is "errored", perform readRequest’s error steps given stream.[[storedError]].
  348. else if (stream->is_errored()) {
  349. read_request.on_error(stream->stored_error());
  350. }
  351. // 6. Otherwise,
  352. else {
  353. // 1. Assert: stream.[[state]] is "readable".
  354. VERIFY(stream->is_readable());
  355. // 2. Perform ! stream.[[controller]].[[PullSteps]](readRequest).
  356. TRY(stream->controller()->visit([&](auto const& controller) {
  357. return controller->pull_steps(read_request);
  358. }));
  359. }
  360. return {};
  361. }
  362. // https://streams.spec.whatwg.org/#abstract-opdef-readablestreamdefaultreaderrelease
  363. WebIDL::ExceptionOr<void> readable_stream_default_reader_release(ReadableStreamDefaultReader& reader)
  364. {
  365. auto& realm = reader.realm();
  366. // 1. Perform ! ReadableStreamReaderGenericRelease(reader).
  367. TRY(readable_stream_reader_generic_release(reader));
  368. // 2. Let e be a new TypeError exception.
  369. auto exception = MUST_OR_THROW_OOM(JS::TypeError::create(realm, "Reader has been released"sv));
  370. // 3. Perform ! ReadableStreamDefaultReaderErrorReadRequests(reader, e).
  371. readable_stream_default_reader_error_read_requests(reader, exception);
  372. return {};
  373. }
  374. // https://streams.spec.whatwg.org/#set-up-readable-stream-default-reader
  375. WebIDL::ExceptionOr<void> set_up_readable_stream_default_reader(ReadableStreamDefaultReader& reader, ReadableStream& stream)
  376. {
  377. // 1. If ! IsReadableStreamLocked(stream) is true, throw a TypeError exception.
  378. if (is_readable_stream_locked(stream))
  379. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, "Cannot create stream reader for a locked stream"sv };
  380. // 2. Perform ! ReadableStreamReaderGenericInitialize(reader, stream).
  381. // 3. Set reader.[[readRequests]] to a new empty list.
  382. readable_stream_reader_generic_initialize(ReadableStreamReader { reader }, stream);
  383. return {};
  384. }
  385. // https://streams.spec.whatwg.org/#readable-stream-default-controller-close
  386. void readable_stream_default_controller_close(ReadableStreamDefaultController& controller)
  387. {
  388. // 1. If ! ReadableStreamDefaultControllerCanCloseOrEnqueue(controller) is false, return.
  389. if (!readable_stream_default_controller_can_close_or_enqueue(controller))
  390. return;
  391. // 2. Let stream be controller.[[stream]].
  392. auto stream = controller.stream();
  393. // 3. Set controller.[[closeRequested]] to true.
  394. controller.set_close_requested(true);
  395. // 4. If controller.[[queue]] is empty,
  396. if (controller.queue().is_empty()) {
  397. // 1. Perform ! ReadableStreamDefaultControllerClearAlgorithms(controller).
  398. readable_stream_default_controller_clear_algorithms(controller);
  399. // 2. Perform ! ReadableStreamClose(stream).
  400. readable_stream_close(*stream);
  401. }
  402. }
  403. // https://streams.spec.whatwg.org/#readable-stream-default-controller-enqueue
  404. WebIDL::ExceptionOr<void> readable_stream_default_controller_enqueue(ReadableStreamDefaultController& controller, JS::Value chunk)
  405. {
  406. auto& vm = controller.vm();
  407. // 1. If ! ReadableStreamDefaultControllerCanCloseOrEnqueue(controller) is false, return.
  408. if (!readable_stream_default_controller_can_close_or_enqueue(controller))
  409. return {};
  410. // 2. Let stream be controller.[[stream]].
  411. auto stream = controller.stream();
  412. // 3. If ! IsReadableStreamLocked(stream) is true and ! ReadableStreamGetNumReadRequests(stream) > 0, perform ! ReadableStreamFulfillReadRequest(stream, chunk, false).
  413. if (is_readable_stream_locked(*stream) && readable_stream_get_num_read_requests(*stream) > 0) {
  414. readable_stream_fulfill_read_request(*stream, chunk, false);
  415. }
  416. // 4. Otherwise,
  417. else {
  418. // 1. Let result be the result of performing controller.[[strategySizeAlgorithm]], passing in chunk, and interpreting the result as a completion record.
  419. auto result = (*controller.strategy_size_algorithm())(chunk);
  420. // 2. If result is an abrupt completion,
  421. if (result.is_abrupt()) {
  422. // 1. Perform ! ReadableStreamDefaultControllerError(controller, result.[[Value]]).
  423. readable_stream_default_controller_error(controller, result.value().value());
  424. // 2. Return result.
  425. return result;
  426. }
  427. // 3. Let chunkSize be result.[[Value]].
  428. auto chunk_size = result.release_value().release_value();
  429. // 4. Let enqueueResult be EnqueueValueWithSize(controller, chunk, chunkSize).
  430. auto enqueue_result = enqueue_value_with_size(controller, chunk, chunk_size);
  431. // 5. If enqueueResult is an abrupt completion,
  432. if (enqueue_result.is_error()) {
  433. auto throw_completion = Bindings::throw_dom_exception_if_needed(vm, [&] { return enqueue_result; }).throw_completion();
  434. // 1. Perform ! ReadableStreamDefaultControllerError(controller, enqueueResult.[[Value]]).
  435. readable_stream_default_controller_error(controller, throw_completion.value().value());
  436. // 2. Return enqueueResult.
  437. // Note: We need to return the throw_completion object here, as enqueue needs to throw the same object that the controller is errored with
  438. return throw_completion;
  439. }
  440. }
  441. // 5. Perform ! ReadableStreamDefaultControllerCallPullIfNeeded(controller).
  442. return readable_stream_default_controller_can_pull_if_needed(controller);
  443. }
  444. // https://streams.spec.whatwg.org/#readable-stream-default-controller-call-pull-if-needed
  445. WebIDL::ExceptionOr<void> readable_stream_default_controller_can_pull_if_needed(ReadableStreamDefaultController& controller)
  446. {
  447. // 1. Let shouldPull be ! ReadableStreamDefaultControllerShouldCallPull(controller).
  448. auto should_pull = readable_stream_default_controller_should_call_pull(controller);
  449. // 2. If shouldPull is false, return.
  450. if (!should_pull)
  451. return {};
  452. // 3. If controller.[[pulling]] is true,
  453. if (controller.pulling()) {
  454. // 1. Set controller.[[pullAgain]] to true.
  455. controller.set_pull_again(true);
  456. // 2. Return.
  457. return {};
  458. }
  459. // 4. Assert: controller.[[pullAgain]] is false.
  460. VERIFY(!controller.pull_again());
  461. // 5. Set controller.[[pulling]] to true.
  462. controller.set_pulling(true);
  463. // 6. Let pullPromise be the result of performing controller.[[pullAlgorithm]].
  464. auto pull_promise = TRY((*controller.pull_algorithm())());
  465. // 7. Upon fulfillment of pullPromise,
  466. WebIDL::upon_fulfillment(*pull_promise, [&](auto const&) -> WebIDL::ExceptionOr<JS::Value> {
  467. // 1. Set controller.[[pulling]] to false.
  468. controller.set_pulling(false);
  469. // 2. If controller.[[pullAgain]] is true,
  470. if (controller.pull_again()) {
  471. // 1. Set controller.[[pullAgain]] to false.
  472. controller.set_pull_again(false);
  473. // 2. Perform ! ReadableStreamDefaultControllerCallPullIfNeeded(controller).
  474. TRY(readable_stream_default_controller_can_pull_if_needed(controller));
  475. }
  476. return JS::js_undefined();
  477. });
  478. // 8. Upon rejection of pullPromise with reason e,
  479. WebIDL::upon_rejection(*pull_promise, [&](auto const& e) -> WebIDL::ExceptionOr<JS::Value> {
  480. // 1. Perform ! ReadableStreamDefaultControllerError(controller, e).
  481. readable_stream_default_controller_error(controller, e);
  482. return JS::js_undefined();
  483. });
  484. return {};
  485. }
  486. // https://streams.spec.whatwg.org/#readable-stream-default-controller-should-call-pull
  487. bool readable_stream_default_controller_should_call_pull(ReadableStreamDefaultController& controller)
  488. {
  489. // 1. Let stream be controller.[[stream]].
  490. auto stream = controller.stream();
  491. // 2. If ! ReadableStreamDefaultControllerCanCloseOrEnqueue(controller) is false, return false.
  492. if (!readable_stream_default_controller_can_close_or_enqueue(controller))
  493. return false;
  494. // 3. If controller.[[started]] is false, return false.
  495. if (!controller.started())
  496. return false;
  497. // 4. If ! IsReadableStreamLocked(stream) is true and ! ReadableStreamGetNumReadRequests(stream) > 0, return true.
  498. if (is_readable_stream_locked(*stream) && readable_stream_get_num_read_requests(*stream) > 0)
  499. return true;
  500. // 5. Let desiredSize be ! ReadableStreamDefaultControllerGetDesiredSize(controller).
  501. auto desired_size = readable_stream_default_controller_get_desired_size(controller);
  502. // 6. Assert: desiredSize is not null.
  503. VERIFY(desired_size.has_value());
  504. // 7. If desiredSize > 0, return true.
  505. if (desired_size.release_value() > 0.0)
  506. return true;
  507. // 8. Return false.
  508. return false;
  509. }
  510. // https://streams.spec.whatwg.org/#readable-stream-default-controller-clear-algorithms
  511. void readable_stream_default_controller_clear_algorithms(ReadableStreamDefaultController& controller)
  512. {
  513. // FIXME: This AO can be invoked from within one of the algorithms below. If we clear them, it invokes SafeFunction's
  514. // destructor, which asserts we are not currently invoking the function (as it clears the storage). We need to
  515. // figure out how to delay this, as these algorithms may keep objects alive that can otherwise be GC'd.
  516. (void)controller;
  517. // 1. Set controller.[[pullAlgorithm]] to undefined.
  518. // controller.set_pull_algorithm({});
  519. // 2. Set controller.[[cancelAlgorithm]] to undefined.
  520. // controller.set_cancel_algorithm({});
  521. // 3. Set controller.[[strategySizeAlgorithm]] to undefined.
  522. // controller.set_strategy_size_algorithm({});
  523. }
  524. // https://streams.spec.whatwg.org/#readable-stream-default-controller-error
  525. void readable_stream_default_controller_error(ReadableStreamDefaultController& controller, JS::Value error)
  526. {
  527. // 1. Let stream be controller.[[stream]].
  528. auto stream = controller.stream();
  529. // 2. If stream.[[state]] is not "readable", return.
  530. if (!stream->is_readable())
  531. return;
  532. // 3. Perform ! ResetQueue(controller).
  533. reset_queue(controller);
  534. // 4. Perform ! ReadableStreamDefaultControllerClearAlgorithms(controller).
  535. readable_stream_default_controller_clear_algorithms(controller);
  536. // 5. Perform ! ReadableStreamError(stream, e).
  537. readable_stream_error(*stream, error);
  538. }
  539. // https://streams.spec.whatwg.org/#readable-stream-default-controller-get-desired-size
  540. Optional<double> readable_stream_default_controller_get_desired_size(ReadableStreamDefaultController& controller)
  541. {
  542. auto stream = controller.stream();
  543. // 1. Let state be controller.[[stream]].[[state]].
  544. // 2. If state is "errored", return null.
  545. if (stream->is_errored())
  546. return {};
  547. // 3. If state is "closed", return 0.
  548. if (stream->is_closed())
  549. return 0.0;
  550. // 4. Return controller.[[strategyHWM]] − controller.[[queueTotalSize]].
  551. return controller.strategy_hwm() - controller.queue_total_size();
  552. }
  553. // https://streams.spec.whatwg.org/#readable-stream-default-controller-can-close-or-enqueue
  554. bool readable_stream_default_controller_can_close_or_enqueue(ReadableStreamDefaultController& controller)
  555. {
  556. // 1. Let state be controller.[[stream]].[[state]].
  557. // 2. If controller.[[closeRequested]] is false and state is "readable", return true.
  558. // 3. Otherwise, return false.
  559. return !controller.close_requested() && controller.stream()->is_readable();
  560. }
  561. // https://streams.spec.whatwg.org/#set-up-readable-stream-default-controller
  562. WebIDL::ExceptionOr<void> set_up_readable_stream_default_controller(ReadableStream& stream, ReadableStreamDefaultController& controller, StartAlgorithm&& start_algorithm, PullAlgorithm&& pull_algorithm, CancelAlgorithm&& cancel_algorithm, double high_water_mark, SizeAlgorithm&& size_algorithm)
  563. {
  564. auto& realm = stream.realm();
  565. // 1. Assert: stream.[[controller]] is undefined.
  566. VERIFY(!stream.controller().has_value());
  567. // 2. Set controller.[[stream]] to stream.
  568. controller.set_stream(stream);
  569. // 3. Perform ! ResetQueue(controller).
  570. reset_queue(controller);
  571. // 4. Set controller.[[started]], controller.[[closeRequested]], controller.[[pullAgain]], and controller.[[pulling]] to false.
  572. controller.set_started(false);
  573. controller.set_close_requested(false);
  574. controller.set_pull_again(false);
  575. controller.set_pulling(false);
  576. // 5. Set controller.[[strategySizeAlgorithm]] to sizeAlgorithm and controller.[[strategyHWM]] to highWaterMark.
  577. controller.set_strategy_size_algorithm(move(size_algorithm));
  578. controller.set_strategy_hwm(high_water_mark);
  579. // 6. Set controller.[[pullAlgorithm]] to pullAlgorithm.
  580. controller.set_pull_algorithm(move(pull_algorithm));
  581. // 7. Set controller.[[cancelAlgorithm]] to cancelAlgorithm.
  582. controller.set_cancel_algorithm(move(cancel_algorithm));
  583. // 8. Set stream.[[controller]] to controller.
  584. stream.set_controller(ReadableStreamController { controller });
  585. // 9. Let startResult be the result of performing startAlgorithm. (This might throw an exception.)
  586. auto start_result = TRY(start_algorithm());
  587. // 10. Let startPromise be a promise resolved with startResult.
  588. auto start_promise = WebIDL::create_resolved_promise(realm, start_result);
  589. // 11. Upon fulfillment of startPromise,
  590. WebIDL::upon_fulfillment(start_promise, [&](auto const&) -> WebIDL::ExceptionOr<JS::Value> {
  591. // 1. Set controller.[[started]] to true.
  592. controller.set_started(true);
  593. // 2. Assert: controller.[[pulling]] is false.
  594. VERIFY(!controller.pulling());
  595. // 3. Assert: controller.[[pullAgain]] is false.
  596. VERIFY(!controller.pull_again());
  597. // 4. Perform ! ReadableStreamDefaultControllerCallPullIfNeeded(controller).
  598. TRY(readable_stream_default_controller_can_pull_if_needed(controller));
  599. return JS::js_undefined();
  600. });
  601. // 12. Upon rejection of startPromise with reason r,
  602. WebIDL::upon_rejection(start_promise, [&](auto const& r) -> WebIDL::ExceptionOr<JS::Value> {
  603. // 1. Perform ! ReadableStreamDefaultControllerError(controller, r).
  604. readable_stream_default_controller_error(controller, r);
  605. return JS::js_undefined();
  606. });
  607. return {};
  608. }
  609. // https://streams.spec.whatwg.org/#set-up-readable-stream-default-controller-from-underlying-source
  610. WebIDL::ExceptionOr<void> set_up_readable_stream_default_controller_from_underlying_source(ReadableStream& stream, JS::Value underlying_source_value, UnderlyingSource underlying_source, double high_water_mark, SizeAlgorithm&& size_algorithm)
  611. {
  612. auto& realm = stream.realm();
  613. // 1. Let controller be a new ReadableStreamDefaultController.
  614. auto controller = MUST_OR_THROW_OOM(stream.heap().allocate<ReadableStreamDefaultController>(realm, realm));
  615. // 2. Let startAlgorithm be an algorithm that returns undefined.
  616. StartAlgorithm start_algorithm = [] { return JS::js_undefined(); };
  617. // 3. Let pullAlgorithm be an algorithm that returns a promise resolved with undefined.
  618. PullAlgorithm pull_algorithm = [&realm]() {
  619. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  620. };
  621. // 4. Let cancelAlgorithm be an algorithm that returns a promise resolved with undefined.
  622. CancelAlgorithm cancel_algorithm = [&realm](auto const&) {
  623. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  624. };
  625. // 5. If underlyingSourceDict["start"] exists, then set startAlgorithm to an algorithm which returns the result of invoking underlyingSourceDict["start"] with argument list « controller » and callback this value underlyingSource.
  626. if (underlying_source.start) {
  627. start_algorithm = [controller, underlying_source_value, callback = underlying_source.start]() -> WebIDL::ExceptionOr<JS::Value> {
  628. // Note: callback does not return a promise, so invoke_callback may return an abrupt completion
  629. return TRY(WebIDL::invoke_callback(*callback, underlying_source_value, controller)).release_value();
  630. };
  631. }
  632. // 6. If underlyingSourceDict["pull"] exists, then set pullAlgorithm to an algorithm which returns the result of invoking underlyingSourceDict["pull"] with argument list « controller » and callback this value underlyingSource.
  633. if (underlying_source.pull) {
  634. pull_algorithm = [&realm, controller, underlying_source_value, callback = underlying_source.pull]() -> WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> {
  635. // Note: callback return a promise, so invoke_callback will never return an abrupt completion
  636. auto result = MUST_OR_THROW_OOM(WebIDL::invoke_callback(*callback, underlying_source_value, controller)).release_value();
  637. return WebIDL::create_resolved_promise(realm, result);
  638. };
  639. }
  640. // 7. If underlyingSourceDict["cancel"] exists, then set cancelAlgorithm to an algorithm which takes an argument reason and returns the result of invoking underlyingSourceDict["cancel"] with argument list « reason » and callback this value underlyingSource.
  641. if (underlying_source.cancel) {
  642. cancel_algorithm = [&realm, controller, underlying_source_value, callback = underlying_source.cancel](auto const& reason) -> WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> {
  643. // Note: callback return a promise, so invoke_callback will never return an abrupt completion
  644. auto result = MUST_OR_THROW_OOM(WebIDL::invoke_callback(*callback, underlying_source_value, reason)).release_value();
  645. return WebIDL::create_resolved_promise(realm, result);
  646. };
  647. }
  648. // 8. Perform ? SetUpReadableStreamDefaultController(stream, controller, startAlgorithm, pullAlgorithm, cancelAlgorithm, highWaterMark, sizeAlgorithm).
  649. return set_up_readable_stream_default_controller(stream, controller, move(start_algorithm), move(pull_algorithm), move(cancel_algorithm), high_water_mark, move(size_algorithm));
  650. }
  651. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-call-pull-if-needed
  652. WebIDL::ExceptionOr<void> readable_byte_stream_controller_call_pull_if_needed(ReadableByteStreamController& controller)
  653. {
  654. // 1. Let shouldPull be ! ReadableByteStreamControllerShouldCallPull(controller).
  655. auto should_pull = readable_byte_stream_controller_should_call_pull(controller);
  656. // 2. If shouldPull is false, return.
  657. if (!should_pull)
  658. return {};
  659. // 3. If controller.[[pulling]] is true,
  660. if (controller.pulling()) {
  661. // 1. Set controller.[[pullAgain]] to true.
  662. controller.set_pull_again(true);
  663. // 2. Return.
  664. return {};
  665. }
  666. // 4. Assert: controller.[[pullAgain]] is false.
  667. VERIFY(!controller.pull_again());
  668. // 5. Set controller.[[pulling]] to true.
  669. controller.set_pulling(true);
  670. // 6. Let pullPromise be the result of performing controller.[[pullAlgorithm]].
  671. auto pull_promise = TRY((*controller.pull_algorithm())());
  672. // 7. Upon fulfillment of pullPromise,
  673. WebIDL::upon_fulfillment(*pull_promise, [&](auto const&) -> WebIDL::ExceptionOr<JS::Value> {
  674. // 1. Set controller.[[pulling]] to false.
  675. controller.set_pulling(false);
  676. // 2. If controller.[[pullAgain]] is true,
  677. if (controller.pull_again()) {
  678. // 1. Set controller.[[pullAgain]] to false.
  679. controller.set_pull_again(false);
  680. // 2. Perform ! ReadableByteStreamControllerCallPullIfNeeded(controller).
  681. TRY(readable_byte_stream_controller_call_pull_if_needed(controller));
  682. }
  683. return JS::js_undefined();
  684. });
  685. // 8. Upon rejection of pullPromise with reason e,
  686. WebIDL::upon_rejection(*pull_promise, [&](auto const& error) -> WebIDL::ExceptionOr<JS::Value> {
  687. // 1. Perform ! ReadableByteStreamControllerError(controller, e).
  688. readable_byte_stream_controller_error(controller, error);
  689. return JS::js_undefined();
  690. });
  691. return {};
  692. }
  693. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-clear-algorithms
  694. void readable_byte_stream_controller_clear_algorithms(ReadableByteStreamController& controller)
  695. {
  696. // FIXME: This AO can be invoked from within one of the algorithms below. If we clear them, it invokes SafeFunction's
  697. // destructor, which asserts we are not currently invoking the function (as it clears the storage). We need to
  698. // figure out how to delay this, as these algorithms may keep objects alive that can otherwise be GC'd.
  699. (void)controller;
  700. // 1. Set controller.[[pullAlgorithm]] to undefined.
  701. // controller.set_pull_algorithm({});
  702. // 2. Set controller.[[cancelAlgorithm]] to undefined.
  703. // controller.set_cancel_algorithm({});
  704. }
  705. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-clear-pending-pull-intos
  706. void readable_byte_stream_controller_clear_pending_pull_intos(ReadableByteStreamController& controller)
  707. {
  708. // 1. Perform ! ReadableByteStreamControllerInvalidateBYOBRequest(controller).
  709. readable_byte_stream_controller_invalidate_byob_request(controller);
  710. // 2. Set controller.[[pendingPullIntos]] to a new empty list.
  711. controller.pending_pull_intos().clear();
  712. }
  713. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-close
  714. WebIDL::ExceptionOr<void> readable_byte_stream_controller_close(ReadableByteStreamController& controller)
  715. {
  716. auto& realm = controller.realm();
  717. // 1. Let stream be controller.[[stream]].
  718. auto stream = controller.stream();
  719. // 2. If controller.[[closeRequested]] is true or stream.[[state]] is not "readable", return.
  720. if (controller.close_requested() || stream->state() != ReadableStream::State::Readable)
  721. return {};
  722. // 3. If controller.[[queueTotalSize]] > 0,
  723. if (controller.queue_total_size() > 0.0) {
  724. // 1. Set controller.[[closeRequested]] to true.
  725. controller.set_close_requested(true);
  726. // 2. Return.
  727. return {};
  728. }
  729. // 4. If controller.[[pendingPullIntos]] is not empty,
  730. if (!controller.pending_pull_intos().is_empty()) {
  731. // 1. Let firstPendingPullInto be controller.[[pendingPullIntos]][0].
  732. auto& first_pending_pull_into = controller.pending_pull_intos().first();
  733. // 2. If firstPendingPullInto’s bytes filled > 0,
  734. if (first_pending_pull_into.bytes_filled > 0) {
  735. // 1. Let e be a new TypeError exception.
  736. auto error = MUST_OR_THROW_OOM(JS::TypeError::create(realm, "Cannot close controller in the middle of processing a write request"sv));
  737. // 2. Perform ! ReadableByteStreamControllerError(controller, e).
  738. readable_byte_stream_controller_error(controller, error);
  739. // 3. Throw e.
  740. return JS::throw_completion(error);
  741. }
  742. }
  743. // 5. Perform ! ReadableByteStreamControllerClearAlgorithms(controller).
  744. readable_byte_stream_controller_clear_algorithms(controller);
  745. // 6. Perform ! ReadableStreamClose(stream).
  746. readable_stream_close(*stream);
  747. return {};
  748. }
  749. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-error
  750. void readable_byte_stream_controller_error(ReadableByteStreamController& controller, JS::Value error)
  751. {
  752. // 1. Let stream be controller.[[stream]].
  753. auto stream = controller.stream();
  754. // 2. If stream.[[state]] is not "readable", return.
  755. if (stream->state() != ReadableStream::State::Readable)
  756. return;
  757. // 3. Perform ! ReadableByteStreamControllerClearPendingPullIntos(controller).
  758. readable_byte_stream_controller_clear_pending_pull_intos(controller);
  759. // 4. Perform ! ResetQueue(controller).
  760. reset_queue(controller);
  761. // 5. Perform ! ReadableByteStreamControllerClearAlgorithms(controller).
  762. readable_byte_stream_controller_clear_algorithms(controller);
  763. // 6. Perform ! ReadableStreamError(stream, e).
  764. readable_stream_error(*stream, error);
  765. }
  766. // https://streams.spec.whatwg.org/#abstract-opdef-readablebytestreamcontrollerfillreadrequestfromqueue
  767. WebIDL::ExceptionOr<void> readable_byte_stream_controller_fill_read_request_from_queue(ReadableByteStreamController& controller, NonnullRefPtr<ReadRequest> read_request)
  768. {
  769. auto& vm = controller.vm();
  770. auto& realm = controller.realm();
  771. // 1. Assert: controller.[[queueTotalSize]] > 0.
  772. VERIFY(controller.queue_total_size() > 0.0);
  773. // 2. Let entry be controller.[[queue]][0].
  774. // 3. Remove entry from controller.[[queue]].
  775. auto entry = controller.queue().take_first();
  776. // 4. Set controller.[[queueTotalSize]] to controller.[[queueTotalSize]] − entry’s byte length.
  777. controller.set_queue_total_size(controller.queue_total_size() - entry.byte_length);
  778. // 5. Perform ! ReadableByteStreamControllerHandleQueueDrain(controller).
  779. TRY(readable_byte_stream_controller_handle_queue_drain(controller));
  780. // 6. Let view be ! Construct(%Uint8Array%, « entry’s buffer, entry’s byte offset, entry’s byte length »).
  781. auto view = MUST_OR_THROW_OOM(JS::construct(vm, *realm.intrinsics().uint8_array_constructor(), entry.buffer, JS::Value(entry.byte_offset), JS::Value(entry.byte_length)));
  782. // 7. Perform readRequest’s chunk steps, given view.
  783. read_request->on_chunk(view);
  784. return {};
  785. }
  786. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-get-desired-size
  787. Optional<double> readable_byte_stream_controller_get_desired_size(ReadableByteStreamController const& controller)
  788. {
  789. auto stream = controller.stream();
  790. // 1. Let state be controller.[[stream]].[[state]].
  791. // 2. If state is "errored", return null.
  792. if (stream->is_errored())
  793. return {};
  794. // 3. If state is "closed", return 0.
  795. if (stream->is_closed())
  796. return 0.0;
  797. // 4. Return controller.[[strategyHWM]] − controller.[[queueTotalSize]].
  798. return controller.strategy_hwm() - controller.queue_total_size();
  799. }
  800. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-handle-queue-drain
  801. WebIDL::ExceptionOr<void> readable_byte_stream_controller_handle_queue_drain(ReadableByteStreamController& controller)
  802. {
  803. // 1. Assert: controller.[[stream]].[[state]] is "readable".
  804. VERIFY(controller.stream()->state() == ReadableStream::State::Readable);
  805. // 2. If controller.[[queueTotalSize]] is 0 and controller.[[closeRequested]] is true,
  806. if (controller.queue_total_size() == 0.0 && controller.close_requested()) {
  807. // 1. Perform ! ReadableByteStreamControllerClearAlgorithms(controller).
  808. readable_byte_stream_controller_clear_algorithms(controller);
  809. // 2. Perform ! ReadableStreamClose(controller.[[stream]]).
  810. readable_stream_close(*controller.stream());
  811. }
  812. // 3. Otherwise,
  813. else {
  814. // 1. Perform ! ReadableByteStreamControllerCallPullIfNeeded(controller).
  815. TRY(readable_byte_stream_controller_call_pull_if_needed(controller));
  816. }
  817. return {};
  818. }
  819. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-invalidate-byob-request
  820. void readable_byte_stream_controller_invalidate_byob_request(ReadableByteStreamController& controller)
  821. {
  822. // 1. If controller.[[byobRequest]] is null, return.
  823. if (!controller.byob_request())
  824. return;
  825. // 2. Set controller.[[byobRequest]].[[controller]] to undefined.
  826. controller.byob_request()->set_controller({});
  827. // 3. Set controller.[[byobRequest]].[[view]] to null.
  828. controller.byob_request()->set_view({});
  829. // 4. Set controller.[[byobRequest]] to null.
  830. controller.set_byob_request({});
  831. }
  832. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-error
  833. bool readable_byte_stream_controller_should_call_pull(ReadableByteStreamController const& controller)
  834. {
  835. // 1. Let stream be controller.[[stream]].
  836. auto stream = controller.stream();
  837. // 2. If stream.[[state]] is not "readable", return false.
  838. if (stream->state() != ReadableStream::State::Readable)
  839. return false;
  840. // 3. If controller.[[closeRequested]] is true, return false.
  841. if (controller.close_requested())
  842. return false;
  843. // 4. If controller.[[started]] is false, return false.
  844. if (!controller.started())
  845. return false;
  846. // 5. If ! ReadableStreamHasDefaultReader(stream) is true and ! ReadableStreamGetNumReadRequests(stream) > 0, return true.
  847. if (readable_stream_has_default_reader(*stream) && readable_stream_get_num_read_requests(*stream) > 0)
  848. return true;
  849. // 6. If ! ReadableStreamHasBYOBReader(stream) is true and ! ReadableStreamGetNumReadIntoRequests(stream) > 0, return true.
  850. if (readable_stream_has_byob_reader(*stream) && readable_stream_get_num_read_into_requests(*stream) > 0)
  851. return true;
  852. // 7. Let desiredSize be ! ReadableByteStreamControllerGetDesiredSize(controller).
  853. auto desired_size = readable_byte_stream_controller_get_desired_size(controller);
  854. // 8. Assert: desiredSize is not null.
  855. VERIFY(desired_size.has_value());
  856. // 9. If desiredSize > 0, return true.
  857. if (*desired_size > 0.0)
  858. return true;
  859. // 10. Return false.
  860. return false;
  861. }
  862. // https://streams.spec.whatwg.org/#acquire-writable-stream-default-writer
  863. WebIDL::ExceptionOr<JS::NonnullGCPtr<WritableStreamDefaultWriter>> acquire_writable_stream_default_writer(WritableStream& stream)
  864. {
  865. auto& realm = stream.realm();
  866. // 1. Let writer be a new WritableStreamDefaultWriter.
  867. auto writer = MUST_OR_THROW_OOM(stream.heap().allocate<WritableStreamDefaultWriter>(realm, realm));
  868. // 2. Perform ? SetUpWritableStreamDefaultWriter(writer, stream).
  869. TRY(set_up_writable_stream_default_writer(*writer, stream));
  870. // 3. Return writer.
  871. return writer;
  872. }
  873. // https://streams.spec.whatwg.org/#is-writable-stream-locked
  874. bool is_writable_stream_locked(WritableStream const& stream)
  875. {
  876. // 1. If stream.[[writer]] is undefined, return false.
  877. if (!stream.writer())
  878. return false;
  879. // 2. Return true.
  880. return true;
  881. }
  882. // https://streams.spec.whatwg.org/#set-up-writable-stream-default-writer
  883. WebIDL::ExceptionOr<void> set_up_writable_stream_default_writer(WritableStreamDefaultWriter& writer, WritableStream& stream)
  884. {
  885. auto& realm = writer.realm();
  886. // 1. If ! IsWritableStreamLocked(stream) is true, throw a TypeError exception.
  887. if (is_writable_stream_locked(stream))
  888. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, "Stream is locked"sv };
  889. // 2. Set writer.[[stream]] to stream.
  890. writer.set_stream(stream);
  891. // 3. Set stream.[[writer]] to writer.
  892. stream.set_writer(writer);
  893. // 4. Let state be stream.[[state]].
  894. auto state = stream.state();
  895. // 5. If state is "writable",
  896. if (state == WritableStream::State::Writable) {
  897. // 1. If ! WritableStreamCloseQueuedOrInFlight(stream) is false and stream.[[backpressure]] is true, set writer.[[readyPromise]] to a new promise.
  898. if (!writable_stream_close_queued_or_in_flight(stream) && stream.backpressure()) {
  899. writer.set_ready_promise(WebIDL::create_promise(realm));
  900. }
  901. // 2. Otherwise, set writer.[[readyPromise]] to a promise resolved with undefined.
  902. else {
  903. writer.set_ready_promise(WebIDL::create_resolved_promise(realm, JS::js_undefined()));
  904. }
  905. // 3. Set writer.[[closedPromise]] to a new promise.
  906. writer.set_closed_promise(WebIDL::create_promise(realm));
  907. }
  908. // 6. Otherwise, if state is "erroring",
  909. else if (state == WritableStream::State::Erroring) {
  910. // 1. Set writer.[[readyPromise]] to a promise rejected with stream.[[storedError]].
  911. writer.set_ready_promise(WebIDL::create_rejected_promise(realm, stream.stored_error()));
  912. // 2. Set writer.[[readyPromise]].[[PromiseIsHandled]] to true.
  913. WebIDL::mark_promise_as_handled(*writer.ready_promise());
  914. // 3. Set writer.[[closedPromise]] to a new promise.
  915. writer.set_closed_promise(WebIDL::create_promise(realm));
  916. }
  917. // 7. Otherwise, if state is "closed",
  918. else if (state == WritableStream::State::Closed) {
  919. // 1. Set writer.[[readyPromise]] to a promise resolved with undefined.
  920. writer.set_ready_promise(WebIDL::create_resolved_promise(realm, JS::js_undefined()));
  921. // 2. Set writer.[[closedPromise]] to a promise resolved with undefined.
  922. writer.set_closed_promise(WebIDL::create_resolved_promise(realm, JS::js_undefined()));
  923. }
  924. // 8. Otherwise,
  925. else {
  926. // 1. Assert: state is "errored".
  927. VERIFY(state == WritableStream::State::Errored);
  928. // 2. Let storedError be stream.[[storedError]].
  929. auto stored_error = stream.stored_error();
  930. // 3. Set writer.[[readyPromise]] to a promise rejected with storedError.
  931. writer.set_ready_promise(WebIDL::create_rejected_promise(realm, stored_error));
  932. // 4. Set writer.[[readyPromise]].[[PromiseIsHandled]] to true.
  933. WebIDL::mark_promise_as_handled(*writer.ready_promise());
  934. // 5. Set writer.[[closedPromise]] to a promise rejected with storedError.
  935. writer.set_closed_promise(WebIDL::create_rejected_promise(realm, stored_error));
  936. // 6. Set writer.[[closedPromise]].[[PromiseIsHandled]] to true.
  937. WebIDL::mark_promise_as_handled(*writer.closed_promise());
  938. }
  939. return {};
  940. }
  941. // https://streams.spec.whatwg.org/#set-up-readable-byte-stream-controller
  942. WebIDL::ExceptionOr<void> set_up_readable_byte_stream_controller(ReadableStream& stream, ReadableByteStreamController& controller, StartAlgorithm&& start_algorithm, PullAlgorithm&& pull_algorithm, CancelAlgorithm&& cancel_algorithm, double high_water_mark, JS::Value auto_allocate_chunk_size)
  943. {
  944. auto& realm = stream.realm();
  945. // 1. Assert: stream.[[controller]] is undefined.
  946. VERIFY(!stream.controller().has_value());
  947. // 2. If autoAllocateChunkSize is not undefined,
  948. if (!auto_allocate_chunk_size.is_undefined()) {
  949. // 1. Assert: ! IsInteger(autoAllocateChunkSize) is true.
  950. VERIFY(auto_allocate_chunk_size.is_integral_number());
  951. // 2. Assert: autoAllocateChunkSize is positive.
  952. VERIFY(auto_allocate_chunk_size.as_double() > 0);
  953. }
  954. // 3. Set controller.[[stream]] to stream.
  955. controller.set_stream(stream);
  956. // 4. Set controller.[[pullAgain]] and controller.[[pulling]] to false.
  957. controller.set_pull_again(false);
  958. controller.set_pulling(false);
  959. // 5. Set controller.[[byobRequest]] to null.
  960. controller.set_byob_request({});
  961. // 6. Perform ! ResetQueue(controller).
  962. reset_queue(controller);
  963. // 7. Set controller.[[closeRequested]] and controller.[[started]] to false.
  964. controller.set_close_requested(false);
  965. controller.set_started(false);
  966. // 8. Set controller.[[strategyHWM]] to highWaterMark.
  967. controller.set_strategy_hwm(high_water_mark);
  968. // 9. Set controller.[[pullAlgorithm]] to pullAlgorithm.
  969. controller.set_pull_algorithm(move(pull_algorithm));
  970. // 10. Set controller.[[cancelAlgorithm]] to cancelAlgorithm.
  971. controller.set_cancel_algorithm(move(cancel_algorithm));
  972. // 11. Set controller.[[autoAllocateChunkSize]] to autoAllocateChunkSize.
  973. if (auto_allocate_chunk_size.is_integral_number())
  974. controller.set_auto_allocate_chunk_size(auto_allocate_chunk_size.as_double());
  975. // 12. Set controller.[[pendingPullIntos]] to a new empty list.
  976. controller.pending_pull_intos().clear();
  977. // 13. Set stream.[[controller]] to controller.
  978. stream.set_controller(ReadableStreamController { controller });
  979. // 14. Let startResult be the result of performing startAlgorithm.
  980. auto start_result = TRY(start_algorithm());
  981. // 15. Let startPromise be a promise resolved with startResult.
  982. auto start_promise = WebIDL::create_resolved_promise(realm, start_result);
  983. // 16. Upon fulfillment of startPromise,
  984. WebIDL::upon_fulfillment(start_promise, [&](auto const&) -> WebIDL::ExceptionOr<JS::Value> {
  985. // 1. Set controller.[[started]] to true.
  986. controller.set_started(true);
  987. // 2. Assert: controller.[[pulling]] is false.
  988. VERIFY(!controller.pulling());
  989. // 3. Assert: controller.[[pullAgain]] is false.
  990. VERIFY(!controller.pull_again());
  991. // 4. Perform ! ReadableByteStreamControllerCallPullIfNeeded(controller).
  992. TRY(readable_byte_stream_controller_call_pull_if_needed(controller));
  993. return JS::js_undefined();
  994. });
  995. // 17. Upon rejection of startPromise with reason r,
  996. WebIDL::upon_rejection(start_promise, [&](auto const& r) -> WebIDL::ExceptionOr<JS::Value> {
  997. // 1. Perform ! ReadableByteStreamControllerError(controller, r).
  998. readable_byte_stream_controller_error(controller, r);
  999. return JS::js_undefined();
  1000. });
  1001. return {};
  1002. }
  1003. // https://streams.spec.whatwg.org/#readablestream-enqueue
  1004. WebIDL::ExceptionOr<void> readable_stream_enqueue(ReadableStreamController& controller, JS::Value chunk)
  1005. {
  1006. // 1. If stream.[[controller]] implements ReadableStreamDefaultController,
  1007. if (controller.has<JS::NonnullGCPtr<ReadableStreamDefaultController>>()) {
  1008. // 1. Perform ! ReadableStreamDefaultControllerEnqueue(stream.[[controller]], chunk).
  1009. return readable_stream_default_controller_enqueue(controller.get<JS::NonnullGCPtr<ReadableStreamDefaultController>>(), chunk);
  1010. }
  1011. // 2. Otherwise,
  1012. else {
  1013. // 1. Assert: stream.[[controller]] implements ReadableByteStreamController.
  1014. VERIFY(controller.has<JS::NonnullGCPtr<ReadableByteStreamController>>());
  1015. auto readable_byte_controller = controller.get<JS::NonnullGCPtr<ReadableByteStreamController>>();
  1016. // FIXME: 2. Assert: chunk is an ArrayBufferView.
  1017. // 3. Let byobView be the current BYOB request view for stream.
  1018. auto byob_view = readable_byte_controller->byob_request();
  1019. // 4. If byobView is non-null, and chunk.[[ViewedArrayBuffer]] is byobView.[[ViewedArrayBuffer]], then:
  1020. if (byob_view) {
  1021. // FIXME: 1. Assert: chunk.[[ByteOffset]] is byobView.[[ByteOffset]].
  1022. // FIXME: 2. Assert: chunk.[[ByteLength]] ≤ byobView.[[ByteLength]].
  1023. // FIXME: 3. Perform ? ReadableByteStreamControllerRespond(stream.[[controller]], chunk.[[ByteLength]]).
  1024. TODO();
  1025. }
  1026. // 5. Otherwise, perform ? ReadableByteStreamControllerEnqueue(stream.[[controller]], chunk).
  1027. return readable_byte_stream_controller_enqueue(readable_byte_controller, chunk);
  1028. }
  1029. }
  1030. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-enqueue
  1031. WebIDL::ExceptionOr<void> readable_byte_stream_controller_enqueue(ReadableByteStreamController& controller, JS::Value chunk)
  1032. {
  1033. auto& vm = controller.vm();
  1034. auto& realm = controller.realm();
  1035. // 1. Let stream be controller.[[stream]].
  1036. auto stream = controller.stream();
  1037. // 2. If controller.[[closeRequested]] is true or stream.[[state]] is not "readable", return.
  1038. if (controller.close_requested() || stream->state() != ReadableStream ::State::Readable)
  1039. return {};
  1040. // 3. Let buffer be chunk.[[ViewedArrayBuffer]].
  1041. auto* typed_array = TRY(JS::typed_array_from(vm, chunk));
  1042. auto* buffer = typed_array->viewed_array_buffer();
  1043. // 4. Let byteOffset be chunk.[[ByteOffset]].
  1044. auto byte_offset = typed_array->byte_offset();
  1045. // 5. Let byteLength be chunk.[[ByteLength]].
  1046. auto byte_length = typed_array->byte_length();
  1047. // 6. If ! IsDetachedBuffer(buffer) is true, throw a TypeError exception.
  1048. if (buffer->is_detached()) {
  1049. auto error = MUST_OR_THROW_OOM(JS::TypeError::create(realm, "Buffer is detached"sv));
  1050. return JS::throw_completion(error);
  1051. }
  1052. // 7. Let transferredBuffer be ? TransferArrayBuffer(buffer).
  1053. auto transferred_buffer = TRY(transfer_array_buffer(realm, *buffer));
  1054. // 8. If controller.[[pendingPullIntos]] is not empty,
  1055. if (!controller.pending_pull_intos().is_empty()) {
  1056. // 1. Let firstPendingPullInto be controller.[[pendingPullIntos]][0].
  1057. auto& first_pending_pull_into = controller.pending_pull_intos().first();
  1058. // 2. If ! IsDetachedBuffer(firstPendingPullInto’s buffer) is true, throw a TypeError exception.
  1059. if (first_pending_pull_into.buffer->is_detached()) {
  1060. auto error = MUST_OR_THROW_OOM(JS::TypeError::create(realm, "Buffer is detached"sv));
  1061. return JS::throw_completion(error);
  1062. }
  1063. // 3. Perform ! ReadableByteStreamControllerInvalidateBYOBRequest(controller).
  1064. readable_byte_stream_controller_invalidate_byob_request(controller);
  1065. // 4. Set firstPendingPullInto’s buffer to ! TransferArrayBuffer(firstPendingPullInto’s buffer).
  1066. first_pending_pull_into.buffer = TRY(transfer_array_buffer(realm, first_pending_pull_into.buffer));
  1067. // 5. If firstPendingPullInto’s reader type is "none", perform ? ReadableByteStreamControllerEnqueueDetachedPullIntoToQueue(controller, firstPendingPullInto).
  1068. if (first_pending_pull_into.reader_type == ReaderType::None)
  1069. TRY(readable_byte_stream_controller_enqueue_detached_pull_into_queue(controller, first_pending_pull_into));
  1070. }
  1071. // 9. If ! ReadableStreamHasDefaultReader(stream) is true,
  1072. if (readable_stream_has_default_reader(*stream)) {
  1073. // 1. Perform ! ReadableByteStreamControllerProcessReadRequestsUsingQueue(controller).
  1074. TRY(readable_byte_stream_controller_process_read_requests_using_queue(controller));
  1075. // 2. If ! ReadableStreamGetNumReadRequests(stream) is 0,
  1076. if (readable_stream_get_num_read_requests(*stream) == 0) {
  1077. // 1. Assert: controller.[[pendingPullIntos]] is empty.
  1078. VERIFY(controller.pending_pull_intos().is_empty());
  1079. // 2. Perform ! ReadableByteStreamControllerEnqueueChunkToQueue(controller, transferredBuffer, byteOffset, byteLength).
  1080. readable_byte_stream_controller_enqueue_chunk_to_queue(controller, transferred_buffer, byte_offset, byte_length);
  1081. }
  1082. // 3. Otherwise.
  1083. else {
  1084. // 1. Assert: controller.[[queue]] is empty.
  1085. VERIFY(controller.queue().is_empty());
  1086. // 2. If controller.[[pendingPullIntos]] is not empty,
  1087. if (!controller.pending_pull_intos().is_empty()) {
  1088. // 1. Assert: controller.[[pendingPullIntos]][0]'s reader type is "default".
  1089. VERIFY(controller.pending_pull_intos().first().reader_type == ReaderType::Default);
  1090. // 2. Perform ! ReadableByteStreamControllerShiftPendingPullInto(controller).
  1091. readable_byte_stream_controller_shift_pending_pull_into(controller);
  1092. }
  1093. // 3. Let transferredView be ! Construct(%Uint8Array%, « transferredBuffer, byteOffset, byteLength »).
  1094. auto transferred_view = MUST_OR_THROW_OOM(JS::construct(vm, *realm.intrinsics().uint8_array_constructor(), transferred_buffer, JS::Value(byte_offset), JS::Value(byte_length)));
  1095. // 4. Perform ! ReadableStreamFulfillReadRequest(stream, transferredView, false).
  1096. readable_stream_fulfill_read_request(*stream, transferred_view, false);
  1097. }
  1098. }
  1099. // 10. Otherwise, if ! ReadableStreamHasBYOBReader(stream) is true,
  1100. else if (readable_stream_has_byob_reader(*stream)) {
  1101. // FIXME: 1. Perform ! ReadableByteStreamControllerEnqueueChunkToQueue(controller, transferredBuffer, byteOffset, byteLength).
  1102. // FIXME: 2. Perform ! ReadableByteStreamControllerProcessPullIntoDescriptorsUsingQueue(controller).
  1103. TODO();
  1104. }
  1105. // 11. Otherwise,
  1106. else {
  1107. // 1. Assert: ! IsReadableStreamLocked(stream) is false.
  1108. VERIFY(!is_readable_stream_locked(*stream));
  1109. // 2. Perform ! ReadableByteStreamControllerEnqueueChunkToQueue(controller, transferredBuffer, byteOffset, byteLength).
  1110. readable_byte_stream_controller_enqueue_chunk_to_queue(controller, transferred_buffer, byte_offset, byte_length);
  1111. }
  1112. // 12. Perform ! ReadableByteStreamControllerCallPullIfNeeded(controller).
  1113. TRY(readable_byte_stream_controller_call_pull_if_needed(controller));
  1114. return {};
  1115. }
  1116. // https://streams.spec.whatwg.org/#transfer-array-buffer
  1117. WebIDL::ExceptionOr<JS::NonnullGCPtr<JS::ArrayBuffer>> transfer_array_buffer(JS::Realm& realm, JS::ArrayBuffer& buffer)
  1118. {
  1119. auto& vm = realm.vm();
  1120. // 1. Assert: ! IsDetachedBuffer(O) is false.
  1121. VERIFY(!buffer.is_detached());
  1122. // 2. Let arrayBufferData be O.[[ArrayBufferData]].
  1123. // 3. Let arrayBufferByteLength be O.[[ArrayBufferByteLength]].
  1124. auto array_buffer = buffer.buffer();
  1125. // 4. Perform ? DetachArrayBuffer(O).
  1126. TRY(JS::detach_array_buffer(vm, buffer));
  1127. // 5. Return a new ArrayBuffer object, created in the current Realm, whose [[ArrayBufferData]] internal slot value is arrayBufferData and whose [[ArrayBufferByteLength]] internal slot value is arrayBufferByteLength.
  1128. return JS::ArrayBuffer::create(realm, array_buffer);
  1129. }
  1130. // https://streams.spec.whatwg.org/#abstract-opdef-readablebytestreamcontrollerenqueuedetachedpullintotoqueue
  1131. WebIDL::ExceptionOr<void> readable_byte_stream_controller_enqueue_detached_pull_into_queue(ReadableByteStreamController& controller, PullIntoDescriptor& pull_into_descriptor)
  1132. {
  1133. // 1. Assert: pullIntoDescriptor’s reader type is "none".
  1134. VERIFY(pull_into_descriptor.reader_type == ReaderType::None);
  1135. // 2. If pullIntoDescriptor’s bytes filled > 0, perform ? ReadableByteStreamControllerEnqueueClonedChunkToQueue(controller, pullIntoDescriptor’s buffer, pullIntoDescriptor’s byte offset, pullIntoDescriptor’s bytes filled).
  1136. if (pull_into_descriptor.bytes_filled > 0)
  1137. TRY(readable_byte_stream_controller_enqueue_cloned_chunk_to_queue(controller, pull_into_descriptor.buffer, pull_into_descriptor.byte_offset, pull_into_descriptor.bytes_filled));
  1138. // 3. Perform ! ReadableByteStreamControllerShiftPendingPullInto(controller).
  1139. readable_byte_stream_controller_shift_pending_pull_into(controller);
  1140. return {};
  1141. }
  1142. // https://streams.spec.whatwg.org/#abstract-opdef-readablebytestreamcontrollerprocessreadrequestsusingqueue
  1143. WebIDL::ExceptionOr<void> readable_byte_stream_controller_process_read_requests_using_queue(ReadableByteStreamController& controller)
  1144. {
  1145. // 1. Let reader be controller.[[stream]].[[reader]].
  1146. auto reader = controller.stream()->reader();
  1147. // 2. Assert: reader implements ReadableStreamDefaultReader.
  1148. VERIFY(reader->has<JS::NonnullGCPtr<ReadableStreamDefaultReader>>());
  1149. // 3. While reader.[[readRequests]] is not empty,
  1150. auto readable_stream_default_reader = reader->get<JS::NonnullGCPtr<ReadableStreamDefaultReader>>();
  1151. while (!readable_stream_default_reader->read_requests().is_empty()) {
  1152. // 1. If controller.[[queueTotalSize]] is 0, return.
  1153. if (controller.queue_total_size() == 0.0)
  1154. return {};
  1155. // 2. Let readRequest be reader.[[readRequests]][0].
  1156. // 3. Remove readRequest from reader.[[readRequests]].
  1157. auto read_request = readable_stream_default_reader->read_requests().take_first();
  1158. // 4. Perform ! ReadableByteStreamControllerFillReadRequestFromQueue(controller, readRequest).
  1159. TRY(readable_byte_stream_controller_fill_read_request_from_queue(controller, read_request));
  1160. }
  1161. return {};
  1162. }
  1163. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-enqueue-chunk-to-queue
  1164. void readable_byte_stream_controller_enqueue_chunk_to_queue(ReadableByteStreamController& controller, JS::NonnullGCPtr<JS::ArrayBuffer> buffer, u32 byte_offset, u32 byte_length)
  1165. {
  1166. // 1. Append a new readable byte stream queue entry with buffer buffer, byte offset byteOffset, and byte length byteLength to controller.[[queue]].
  1167. controller.queue().append(ReadableByteStreamQueueEntry {
  1168. .buffer = buffer,
  1169. .byte_offset = byte_offset,
  1170. .byte_length = byte_length,
  1171. });
  1172. // 2. Set controller.[[queueTotalSize]] to controller.[[queueTotalSize]] + byteLength.
  1173. controller.set_queue_total_size(controller.queue_total_size() + byte_length);
  1174. }
  1175. // https://streams.spec.whatwg.org/#abstract-opdef-readablebytestreamcontrollerenqueueclonedchunktoqueue
  1176. WebIDL::ExceptionOr<void> readable_byte_stream_controller_enqueue_cloned_chunk_to_queue(ReadableByteStreamController& controller, JS::ArrayBuffer& buffer, u64 byte_offset, u64 byte_length)
  1177. {
  1178. auto& vm = controller.vm();
  1179. // 1. Let cloneResult be CloneArrayBuffer(buffer, byteOffset, byteLength, %ArrayBuffer%).
  1180. auto clone_result = JS::clone_array_buffer(vm, buffer, byte_offset, byte_length);
  1181. // 2. If cloneResult is an abrupt completion,
  1182. if (clone_result.is_throw_completion()) {
  1183. auto throw_completion = Bindings::throw_dom_exception_if_needed(vm, [&] { return clone_result; }).throw_completion();
  1184. // 1. Perform ! ReadableByteStreamControllerError(controller, cloneResult.[[Value]]).
  1185. readable_byte_stream_controller_error(controller, throw_completion.value().value());
  1186. // 2. Return cloneResult.
  1187. // Note: We need to return the throw_completion object here, as enqueue needs to throw the same object that the controller is errored with
  1188. return throw_completion;
  1189. }
  1190. // 3. Perform ! ReadableByteStreamControllerEnqueueChunkToQueue(controller, cloneResult.[[Value]], 0, byteLength).
  1191. readable_byte_stream_controller_enqueue_chunk_to_queue(controller, *clone_result.release_value(), 0, byte_length);
  1192. return {};
  1193. }
  1194. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-shift-pending-pull-into
  1195. PullIntoDescriptor readable_byte_stream_controller_shift_pending_pull_into(ReadableByteStreamController& controller)
  1196. {
  1197. // 1. Assert: controller.[[byobRequest]] is null.
  1198. VERIFY(!controller.byob_request());
  1199. // 2. Let descriptor be controller.[[pendingPullIntos]][0].
  1200. // 3. Remove descriptor from controller.[[pendingPullIntos]].
  1201. auto descriptor = controller.pending_pull_intos().take_first();
  1202. // 4. Return descriptor.
  1203. return descriptor;
  1204. }
  1205. // https://streams.spec.whatwg.org/#readablestream-set-up-with-byte-reading-support
  1206. WebIDL::ExceptionOr<void> set_up_readable_stream_controller_with_byte_reading_support(ReadableStream& stream, Optional<PullAlgorithm>&& pull_algorithm, Optional<CancelAlgorithm>&& cancel_algorithm, double high_water_mark)
  1207. {
  1208. auto& realm = stream.realm();
  1209. // 1. Let startAlgorithm be an algorithm that returns undefined.
  1210. StartAlgorithm start_algorithm = [] { return JS::js_undefined(); };
  1211. // 2. Let pullAlgorithmWrapper be an algorithm that runs these steps:
  1212. PullAlgorithm pull_algorithm_wrapper = [&realm, pull_algorithm = move(pull_algorithm)]() -> WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> {
  1213. // 1. Let result be the result of running pullAlgorithm, if pullAlgorithm was given, or null otherwise. If this throws an exception e, return a promise rejected with e.
  1214. JS::GCPtr<JS::PromiseCapability> result = nullptr;
  1215. if (pull_algorithm.has_value())
  1216. result = TRY(pull_algorithm.value()());
  1217. // 2. If result is a Promise, then return result.
  1218. if (result != nullptr)
  1219. return JS::NonnullGCPtr(*result);
  1220. // 3. Return a promise resolved with undefined.
  1221. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  1222. };
  1223. // 3. Let cancelAlgorithmWrapper be an algorithm that runs these steps:
  1224. CancelAlgorithm cancel_algorithm_wrapper = [&realm, cancel_algorithm = move(cancel_algorithm)](auto const& c) -> WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> {
  1225. // 1. Let result be the result of running cancelAlgorithm, if cancelAlgorithm was given, or null otherwise. If this throws an exception e, return a promise rejected with e.
  1226. JS::GCPtr<JS::PromiseCapability> result = nullptr;
  1227. if (cancel_algorithm.has_value())
  1228. result = TRY(cancel_algorithm.value()(c));
  1229. // 2. If result is a Promise, then return result.
  1230. if (result != nullptr)
  1231. return JS::NonnullGCPtr(*result);
  1232. // 3. Return a promise resolved with undefined.
  1233. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  1234. };
  1235. // 4. Perform ! InitializeReadableStream(stream).
  1236. // 5. Let controller be a new ReadableByteStreamController.
  1237. auto controller = MUST_OR_THROW_OOM(stream.heap().allocate<ReadableByteStreamController>(realm, realm));
  1238. // 6. Perform ! SetUpReadableByteStreamController(stream, controller, startAlgorithm, pullAlgorithmWrapper, cancelAlgorithmWrapper, highWaterMark, undefined).
  1239. TRY(set_up_readable_byte_stream_controller(stream, controller, move(start_algorithm), move(pull_algorithm_wrapper), move(cancel_algorithm_wrapper), high_water_mark, JS::js_undefined()));
  1240. return {};
  1241. }
  1242. // https://streams.spec.whatwg.org/#writable-stream-abort
  1243. WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> writable_stream_abort(WritableStream& stream, JS::Value reason)
  1244. {
  1245. auto& realm = stream.realm();
  1246. // 1. If stream.[[state]] is "closed" or "errored", return a promise resolved with undefined.
  1247. auto state = stream.state();
  1248. if (state == WritableStream::State::Closed || state == WritableStream::State::Errored)
  1249. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  1250. // 2. Signal abort on stream.[[controller]].[[signal]] with reason.
  1251. stream.controller()->signal()->signal_abort(reason);
  1252. // 3. Let state be stream.[[state]].
  1253. state = stream.state();
  1254. // 4. If state is "closed" or "errored", return a promise resolved with undefined.
  1255. if (state == WritableStream::State::Closed || state == WritableStream::State::Errored)
  1256. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  1257. // 5. If stream.[[pendingAbortRequest]] is not undefined, return stream.[[pendingAbortRequest]]'s promise.
  1258. if (stream.pending_abort_request().has_value())
  1259. return stream.pending_abort_request()->promise;
  1260. // 6. Assert: state is "writable" or "erroring".
  1261. VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
  1262. // 7. Let wasAlreadyErroring be false.
  1263. auto was_already_erroring = false;
  1264. // 8. If state is "erroring",
  1265. if (state == WritableStream::State::Erroring) {
  1266. // 1. Set wasAlreadyErroring to true.
  1267. was_already_erroring = true;
  1268. // 2. Set reason to undefined.
  1269. reason = JS::js_undefined();
  1270. }
  1271. // 9. Let promise be a new promise.
  1272. auto promise = WebIDL::create_promise(realm);
  1273. // 10. Set stream.[[pendingAbortRequest]] to a new pending abort request whose promise is promise, reason is reason, and was already erroring is wasAlreadyErroring.
  1274. stream.set_pending_abort_request(PendingAbortRequest { promise, reason, was_already_erroring });
  1275. // 11. If wasAlreadyErroring is false, perform ! WritableStreamStartErroring(stream, reason).
  1276. if (!was_already_erroring)
  1277. TRY(writable_stream_start_erroring(stream, reason));
  1278. // 12. Return promise.
  1279. return promise;
  1280. }
  1281. // https://streams.spec.whatwg.org/#writable-stream-close
  1282. WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> writable_stream_close(WritableStream& stream)
  1283. {
  1284. auto& realm = stream.realm();
  1285. // 1. Let state be stream.[[state]].
  1286. auto state = stream.state();
  1287. // 2. If state is "closed" or "errored", return a promise rejected with a TypeError exception.
  1288. if (state == WritableStream::State::Closed || state == WritableStream::State::Errored) {
  1289. auto message = state == WritableStream::State::Closed ? "Cannot close a closed stream"sv : "Cannot close an errored stream"sv;
  1290. auto exception = MUST_OR_THROW_OOM(JS::TypeError::create(realm, message));
  1291. return WebIDL::create_rejected_promise(realm, exception);
  1292. }
  1293. // 3. Assert: state is "writable" or "erroring".
  1294. VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
  1295. // 4. Assert: ! WritableStreamCloseQueuedOrInFlight(stream) is false.
  1296. VERIFY(!writable_stream_close_queued_or_in_flight(stream));
  1297. // 5. Let promise be a new promise.
  1298. auto promise = WebIDL::create_promise(realm);
  1299. // 6. Set stream.[[closeRequest]] to promise.
  1300. stream.set_close_request(promise);
  1301. // 7. Let writer be stream.[[writer]].
  1302. auto writer = stream.writer();
  1303. // 8. If writer is not undefined, and stream.[[backpressure]] is true, and state is "writable", resolve writer.[[readyPromise]] with undefined.
  1304. if (writer && stream.backpressure() && state == WritableStream::State::Writable)
  1305. WebIDL::resolve_promise(realm, *writer->ready_promise(), JS::js_undefined());
  1306. // 9. Perform ! WritableStreamDefaultControllerClose(stream.[[controller]]).
  1307. TRY(writable_stream_default_controller_close(*stream.controller()));
  1308. // 10. Return promise.
  1309. return promise;
  1310. }
  1311. // https://streams.spec.whatwg.org/#writable-stream-add-write-request
  1312. WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> writable_stream_add_write_request(WritableStream& stream)
  1313. {
  1314. auto& realm = stream.realm();
  1315. auto& vm = stream.vm();
  1316. // 1. Assert: ! IsWritableStreamLocked(stream) is true.
  1317. VERIFY(is_writable_stream_locked(stream));
  1318. // 2. Assert: stream.[[state]] is "writable".
  1319. VERIFY(stream.state() == WritableStream::State::Writable);
  1320. // 3. Let promise be a new promise.
  1321. auto promise = WebIDL::create_promise(realm);
  1322. // 4. Append promise to stream.[[writeRequests]].
  1323. TRY_OR_THROW_OOM(vm, stream.write_requests().try_append(promise));
  1324. // 5. Return promise.
  1325. return promise;
  1326. }
  1327. // https://streams.spec.whatwg.org/#writable-stream-close-queued-or-in-flight
  1328. bool writable_stream_close_queued_or_in_flight(WritableStream const& stream)
  1329. {
  1330. // 1. If stream.[[closeRequest]] is undefined and stream.[[inFlightCloseRequest]] is undefined, return false.
  1331. if (!stream.close_request() && !stream.in_flight_write_request())
  1332. return false;
  1333. // 2. Return true.
  1334. return true;
  1335. }
  1336. // https://streams.spec.whatwg.org/#writable-stream-deal-with-rejection
  1337. WebIDL::ExceptionOr<void> writable_stream_deal_with_rejection(WritableStream& stream, JS::Value error)
  1338. {
  1339. // 1. Let state be stream.[[state]].
  1340. auto state = stream.state();
  1341. // 2. If state is "writable",
  1342. if (state == WritableStream::State::Writable) {
  1343. // 1. Perform ! WritableStreamStartErroring(stream, error).
  1344. // 2. Return.
  1345. return writable_stream_start_erroring(stream, error);
  1346. }
  1347. // 3. Assert: state is "erroring".
  1348. VERIFY(state == WritableStream::State::Erroring);
  1349. // 4. Perform ! WritableStreamFinishErroring(stream).
  1350. return writable_stream_finish_erroring(stream);
  1351. }
  1352. // https://streams.spec.whatwg.org/#writable-stream-finish-erroring
  1353. WebIDL::ExceptionOr<void> writable_stream_finish_erroring(WritableStream& stream)
  1354. {
  1355. auto& realm = stream.realm();
  1356. // 1. Assert: stream.[[state]] is "erroring".
  1357. VERIFY(stream.state() == WritableStream::State::Erroring);
  1358. // 2. Assert: ! WritableStreamHasOperationMarkedInFlight(stream) is false.
  1359. VERIFY(!writable_stream_has_operation_marked_in_flight(stream));
  1360. // 3. Set stream.[[state]] to "errored".
  1361. stream.set_state(WritableStream::State::Errored);
  1362. // 4. Perform ! stream.[[controller]].[[ErrorSteps]]().
  1363. stream.controller()->error_steps();
  1364. // 5. Let storedError be stream.[[storedError]].
  1365. auto stored_error = stream.stored_error();
  1366. // 6. For each writeRequest of stream.[[writeRequests]]:
  1367. for (auto& write_request : stream.write_requests()) {
  1368. // 1. Reject writeRequest with storedError.
  1369. WebIDL::reject_promise(realm, *write_request, stored_error);
  1370. }
  1371. // 7. Set stream.[[writeRequests]] to an empty list.
  1372. stream.write_requests().clear();
  1373. // 8. If stream.[[pendingAbortRequest]] is undefined,
  1374. if (!stream.pending_abort_request().has_value()) {
  1375. // 1. Perform ! WritableStreamRejectCloseAndClosedPromiseIfNeeded(stream).
  1376. writable_stream_reject_close_and_closed_promise_if_needed(stream);
  1377. // 2. Return.
  1378. return {};
  1379. }
  1380. // 9. Let abortRequest be stream.[[pendingAbortRequest]].
  1381. // 10. Set stream.[[pendingAbortRequest]] to undefined.
  1382. auto abort_request = stream.pending_abort_request().release_value();
  1383. // 11. If abortRequest’s was already erroring is true,
  1384. if (abort_request.was_already_erroring) {
  1385. // 1. Reject abortRequest’s promise with storedError.
  1386. WebIDL::reject_promise(realm, abort_request.promise, stored_error);
  1387. // 2. Perform ! WritableStreamRejectCloseAndClosedPromiseIfNeeded(stream).
  1388. writable_stream_reject_close_and_closed_promise_if_needed(stream);
  1389. // 3. Return.
  1390. return {};
  1391. }
  1392. // 12. Let promise be ! stream.[[controller]].[[AbortSteps]](abortRequest’s reason).
  1393. auto promise = TRY(stream.controller()->abort_steps(abort_request.reason));
  1394. // 13. Upon fulfillment of promise,
  1395. WebIDL::upon_fulfillment(*promise, [&, abort_promise = abort_request.promise](auto const&) -> WebIDL::ExceptionOr<JS::Value> {
  1396. // 1. Resolve abortRequest’s promise with undefined.
  1397. WebIDL::resolve_promise(realm, abort_promise, JS::js_undefined());
  1398. // 2. Perform ! WritableStreamRejectCloseAndClosedPromiseIfNeeded(stream).
  1399. writable_stream_reject_close_and_closed_promise_if_needed(stream);
  1400. return JS::js_undefined();
  1401. });
  1402. // 14. Upon rejection of promise with reason reason,
  1403. WebIDL::upon_rejection(*promise, [&, abort_promise = abort_request.promise](auto const& reason) -> WebIDL::ExceptionOr<JS::Value> {
  1404. // 1. Reject abortRequest’s promise with reason.
  1405. WebIDL::reject_promise(realm, abort_promise, reason);
  1406. // 2. Perform ! WritableStreamRejectCloseAndClosedPromiseIfNeeded(stream).
  1407. writable_stream_reject_close_and_closed_promise_if_needed(stream);
  1408. return JS::js_undefined();
  1409. });
  1410. return {};
  1411. }
  1412. // https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-close
  1413. void writable_stream_finish_in_flight_close(WritableStream& stream)
  1414. {
  1415. auto& realm = stream.realm();
  1416. // 1. Assert: stream.[[inFlightCloseRequest]] is not undefined.
  1417. VERIFY(stream.in_flight_close_request());
  1418. // 2. Resolve stream.[[inFlightCloseRequest]] with undefined.
  1419. WebIDL::resolve_promise(realm, *stream.in_flight_close_request(), JS::js_undefined());
  1420. // 3. Set stream.[[inFlightCloseRequest]] to undefined.
  1421. stream.set_in_flight_close_request({});
  1422. // 4. Let state be stream.[[state]].
  1423. auto state = stream.state();
  1424. // 5. Assert: stream.[[state]] is "writable" or "erroring".
  1425. VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
  1426. // 6. If state is "erroring",
  1427. if (state == WritableStream::State::Erroring) {
  1428. // 1. Set stream.[[storedError]] to undefined.
  1429. stream.set_stored_error(JS::js_undefined());
  1430. // 2. If stream.[[pendingAbortRequest]] is not undefined,
  1431. if (stream.pending_abort_request().has_value()) {
  1432. // 1. Resolve stream.[[pendingAbortRequest]]'s promise with undefined.
  1433. // 2. Set stream.[[pendingAbortRequest]] to undefined.
  1434. WebIDL::resolve_promise(realm, stream.pending_abort_request().release_value().promise, JS::js_undefined());
  1435. }
  1436. }
  1437. // 7. Set stream.[[state]] to "closed".
  1438. stream.set_state(WritableStream::State::Closed);
  1439. // 8. Let writer be stream.[[writer]].
  1440. auto writer = stream.writer();
  1441. // 9. If writer is not undefined, resolve writer.[[closedPromise]] with undefined.
  1442. if (writer)
  1443. WebIDL::resolve_promise(realm, *writer->closed_promise(), JS::js_undefined());
  1444. // 10. Assert: stream.[[pendingAbortRequest]] is undefined.
  1445. VERIFY(!stream.pending_abort_request().has_value());
  1446. // 11. Assert: stream.[[storedError]] is undefined.
  1447. VERIFY(stream.stored_error().is_undefined());
  1448. }
  1449. // https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-close-with-error
  1450. WebIDL::ExceptionOr<void> writable_stream_finish_in_flight_close_with_error(WritableStream& stream, JS::Value error)
  1451. {
  1452. auto& realm = stream.realm();
  1453. // 1. Assert: stream.[[inFlightCloseRequest]] is not undefined.
  1454. VERIFY(stream.in_flight_close_request());
  1455. // 2. Reject stream.[[inFlightCloseRequest]] with error.
  1456. WebIDL::reject_promise(realm, *stream.in_flight_close_request(), error);
  1457. // 3. Set stream.[[inFlightCloseRequest]] to undefined.
  1458. stream.set_in_flight_close_request({});
  1459. // 4. Assert: stream.[[state]] is "writable" or "erroring".
  1460. auto state = stream.state();
  1461. VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
  1462. // 5. If stream.[[pendingAbortRequest]] is not undefined,
  1463. if (stream.pending_abort_request().has_value()) {
  1464. // 1. Reject stream.[[pendingAbortRequest]]'s promise with error.
  1465. // 2. Set stream.[[pendingAbortRequest]] to undefined.
  1466. WebIDL::reject_promise(realm, stream.pending_abort_request().release_value().promise, error);
  1467. }
  1468. // 6. Perform ! WritableStreamDealWithRejection(stream, error).
  1469. return writable_stream_deal_with_rejection(stream, error);
  1470. }
  1471. // https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-write
  1472. void writable_stream_finish_in_flight_write(WritableStream& stream)
  1473. {
  1474. auto& realm = stream.realm();
  1475. // 1. Assert: stream.[[inFlightWriteRequest]] is not undefined.
  1476. VERIFY(stream.in_flight_write_request());
  1477. // 2. Resolve stream.[[inFlightWriteRequest]] with undefined.
  1478. WebIDL::resolve_promise(realm, *stream.in_flight_write_request(), JS::js_undefined());
  1479. // 3. Set stream.[[inFlightWriteRequest]] to undefined.
  1480. stream.set_in_flight_write_request({});
  1481. }
  1482. // https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-write-with-error
  1483. WebIDL::ExceptionOr<void> writable_stream_finish_in_flight_write_with_error(WritableStream& stream, JS::Value error)
  1484. {
  1485. auto& realm = stream.realm();
  1486. // 1. Assert: stream.[[inFlightWriteRequest]] is not undefined.
  1487. VERIFY(stream.in_flight_write_request());
  1488. // 2. Reject stream.[[inFlightWriteRequest]] with error.
  1489. WebIDL::reject_promise(realm, *stream.in_flight_write_request(), error);
  1490. // 3. Set stream.[[inFlightWriteRequest]] to undefined.
  1491. stream.set_in_flight_write_request({});
  1492. // 4. Assert: stream.[[state]] is "writable" or "erroring".
  1493. auto state = stream.state();
  1494. VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
  1495. // 5. Perform ! WritableStreamDealWithRejection(stream, error).
  1496. return writable_stream_deal_with_rejection(stream, error);
  1497. }
  1498. // https://streams.spec.whatwg.org/#writable-stream-has-operation-marked-in-flight
  1499. bool writable_stream_has_operation_marked_in_flight(WritableStream const& stream)
  1500. {
  1501. // 1. If stream.[[inFlightWriteRequest]] is undefined and stream.[[inFlightCloseRequest]] is undefined, return false.
  1502. if (!stream.in_flight_write_request() && !stream.in_flight_close_request())
  1503. return false;
  1504. // 2. Return true.
  1505. return true;
  1506. }
  1507. // https://streams.spec.whatwg.org/#writable-stream-mark-close-request-in-flight
  1508. void writable_stream_mark_close_request_in_flight(WritableStream& stream)
  1509. {
  1510. // 1. Assert: stream.[[inFlightCloseRequest]] is undefined.
  1511. VERIFY(!stream.in_flight_close_request());
  1512. // 2. Assert: stream.[[closeRequest]] is not undefined.
  1513. VERIFY(stream.close_request());
  1514. // 3. Set stream.[[inFlightCloseRequest]] to stream.[[closeRequest]].
  1515. stream.set_in_flight_close_request(stream.close_request());
  1516. // 4. Set stream.[[closeRequest]] to undefined.
  1517. stream.set_close_request({});
  1518. }
  1519. // https://streams.spec.whatwg.org/#writable-stream-mark-first-write-request-in-flight
  1520. void writable_stream_mark_first_write_request_in_flight(WritableStream& stream)
  1521. {
  1522. // 1. Assert: stream.[[inFlightWriteRequest]] is undefined.
  1523. VERIFY(!stream.in_flight_write_request());
  1524. // 2. Assert: stream.[[writeRequests]] is not empty.
  1525. VERIFY(!stream.write_requests().is_empty());
  1526. // 3. Let writeRequest be stream.[[writeRequests]][0].
  1527. // 4. Remove writeRequest from stream.[[writeRequests]].
  1528. auto write_request = stream.write_requests().take_first();
  1529. // 5. Set stream.[[inFlightWriteRequest]] to writeRequest.
  1530. stream.set_in_flight_write_request(write_request);
  1531. }
  1532. // https://streams.spec.whatwg.org/#writable-stream-reject-close-and-closed-promise-if-needed
  1533. void writable_stream_reject_close_and_closed_promise_if_needed(WritableStream& stream)
  1534. {
  1535. auto& realm = stream.realm();
  1536. // 1. Assert: stream.[[state]] is "errored".
  1537. VERIFY(stream.state() == WritableStream::State::Errored);
  1538. // 2. If stream.[[closeRequest]] is not undefined,
  1539. if (stream.close_request()) {
  1540. // 1. Assert: stream.[[inFlightCloseRequest]] is undefined.
  1541. VERIFY(!stream.in_flight_close_request());
  1542. // 2. Reject stream.[[closeRequest]] with stream.[[storedError]].
  1543. WebIDL::reject_promise(realm, *stream.close_request(), stream.stored_error());
  1544. // 3. Set stream.[[closeRequest]] to undefined.
  1545. stream.set_close_request({});
  1546. }
  1547. // 3. Let writer be stream.[[writer]].
  1548. auto writer = stream.writer();
  1549. // 4. If writer is not undefined,
  1550. if (writer) {
  1551. // 1. Reject writer.[[closedPromise]] with stream.[[storedError]].
  1552. WebIDL::reject_promise(realm, *writer->closed_promise(), stream.stored_error());
  1553. // 2. Set writer.[[closedPromise]].[[PromiseIsHandled]] to true.
  1554. WebIDL::mark_promise_as_handled(*writer->closed_promise());
  1555. }
  1556. }
  1557. // https://streams.spec.whatwg.org/#writable-stream-start-erroring
  1558. WebIDL::ExceptionOr<void> writable_stream_start_erroring(WritableStream& stream, JS::Value reason)
  1559. {
  1560. // 1. Assert: stream.[[storedError]] is undefined.
  1561. VERIFY(stream.stored_error().is_undefined());
  1562. // 2. Assert: stream.[[state]] is "writable".
  1563. VERIFY(stream.state() == WritableStream::State::Writable);
  1564. // 3. Let controller be stream.[[controller]].
  1565. auto controller = stream.controller();
  1566. // 4. Assert: controller is not undefined.
  1567. VERIFY(controller);
  1568. // 5. Set stream.[[state]] to "erroring".
  1569. stream.set_state(WritableStream::State::Erroring);
  1570. // 6. Set stream.[[storedError]] to reason.
  1571. stream.set_stored_error(reason);
  1572. // 7. Let writer be stream.[[writer]].
  1573. auto writer = stream.writer();
  1574. // 8. If writer is not undefined, perform ! WritableStreamDefaultWriterEnsureReadyPromiseRejected(writer, reason).
  1575. if (writer)
  1576. writable_stream_default_writer_ensure_ready_promise_rejected(*writer, reason);
  1577. // 9. If ! WritableStreamHasOperationMarkedInFlight(stream) is false and controller.[[started]] is true, perform ! WritableStreamFinishErroring(stream).
  1578. if (!writable_stream_has_operation_marked_in_flight(stream) && controller->started())
  1579. TRY(writable_stream_finish_erroring(stream));
  1580. return {};
  1581. }
  1582. // https://streams.spec.whatwg.org/#writable-stream-update-backpressure
  1583. void writable_stream_update_backpressure(WritableStream& stream, bool backpressure)
  1584. {
  1585. auto& realm = stream.realm();
  1586. // 1. Assert: stream.[[state]] is "writable".
  1587. VERIFY(stream.state() == WritableStream::State::Writable);
  1588. // 2. Assert: ! WritableStreamCloseQueuedOrInFlight(stream) is false.
  1589. VERIFY(!writable_stream_close_queued_or_in_flight(stream));
  1590. // 3. Let writer be stream.[[writer]].
  1591. auto writer = stream.writer();
  1592. // 4. If writer is not undefined and backpressure is not stream.[[backpressure]],
  1593. if (writer && backpressure != stream.backpressure()) {
  1594. // 1. If backpressure is true, set writer.[[readyPromise]] to a new promise.
  1595. if (backpressure) {
  1596. writer->set_ready_promise(WebIDL::create_promise(realm));
  1597. }
  1598. // 2. Otherwise,
  1599. else {
  1600. // 1. Assert: backpressure is false.
  1601. // 2. Resolve writer.[[readyPromise]] with undefined.
  1602. WebIDL::resolve_promise(realm, *writer->ready_promise(), JS::js_undefined());
  1603. }
  1604. }
  1605. // 5. Set stream.[[backpressure]] to backpressure.
  1606. stream.set_backpressure(backpressure);
  1607. }
  1608. // https://streams.spec.whatwg.org/#writable-stream-default-writer-abort
  1609. WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> writable_stream_default_writer_abort(WritableStreamDefaultWriter& writer, JS::Value reason)
  1610. {
  1611. // 1. Let stream be writer.[[stream]].
  1612. auto stream = writer.stream();
  1613. // 2. Assert: stream is not undefined.
  1614. VERIFY(stream);
  1615. // 3. Return ! WritableStreamAbort(stream, reason).
  1616. return writable_stream_abort(*stream, reason);
  1617. }
  1618. // https://streams.spec.whatwg.org/#writable-stream-default-writer-close
  1619. WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> writable_stream_default_writer_close(WritableStreamDefaultWriter& writer)
  1620. {
  1621. // 1. Let stream be writer.[[stream]].
  1622. auto stream = writer.stream();
  1623. // 2. Assert: stream is not undefined.
  1624. VERIFY(stream);
  1625. // 3. Return ! WritableStreamClose(stream).
  1626. return writable_stream_close(*stream);
  1627. }
  1628. // https://streams.spec.whatwg.org/#writable-stream-default-writer-ensure-closed-promise-rejected
  1629. void writable_stream_default_writer_ensure_closed_promise_rejected(WritableStreamDefaultWriter& writer, JS::Value error)
  1630. {
  1631. auto& realm = writer.realm();
  1632. // 1. If writer.[[closedPromise]].[[PromiseState]] is "pending", reject writer.[[closedPromise]] with error.
  1633. auto& closed_promise = verify_cast<JS::Promise>(*writer.closed_promise()->promise());
  1634. if (closed_promise.state() == JS::Promise::State::Pending) {
  1635. WebIDL::reject_promise(realm, *writer.closed_promise(), error);
  1636. }
  1637. // 2. Otherwise, set writer.[[closedPromise]] to a promise rejected with error.
  1638. else {
  1639. writer.set_closed_promise(WebIDL::create_rejected_promise(realm, error));
  1640. }
  1641. // 3. Set writer.[[closedPromise]].[[PromiseIsHandled]] to true.
  1642. WebIDL::mark_promise_as_handled(*writer.closed_promise());
  1643. }
  1644. // https://streams.spec.whatwg.org/#writable-stream-default-writer-ensure-ready-promise-rejected
  1645. void writable_stream_default_writer_ensure_ready_promise_rejected(WritableStreamDefaultWriter& writer, JS::Value error)
  1646. {
  1647. auto& realm = writer.realm();
  1648. // 1. If writer.[[readyPromise]].[[PromiseState]] is "pending", reject writer.[[readyPromise]] with error.
  1649. auto& ready_promise = verify_cast<JS::Promise>(*writer.ready_promise()->promise());
  1650. if (ready_promise.state() == JS::Promise::State::Pending) {
  1651. WebIDL::reject_promise(realm, *writer.ready_promise(), error);
  1652. }
  1653. // 2. Otherwise, set writer.[[readyPromise]] to a promise rejected with error.
  1654. else {
  1655. writer.set_ready_promise(WebIDL::create_rejected_promise(realm, error));
  1656. }
  1657. // 3. Set writer.[[readyPromise]].[[PromiseIsHandled]] to true.
  1658. WebIDL::mark_promise_as_handled(*writer.ready_promise());
  1659. }
  1660. // https://streams.spec.whatwg.org/#writable-stream-default-writer-get-desired-size
  1661. Optional<double> writable_stream_default_writer_get_desired_size(WritableStreamDefaultWriter const& writer)
  1662. {
  1663. // 1. Let stream be writer.[[stream]].
  1664. auto stream = writer.stream();
  1665. // 2. Let state be stream.[[state]].
  1666. auto state = stream->state();
  1667. // 3. If state is "errored" or "erroring", return null.
  1668. if (state == WritableStream::State::Errored || state == WritableStream::State::Erroring)
  1669. return {};
  1670. // 4. If state is "closed", return 0.
  1671. if (state == WritableStream::State::Closed)
  1672. return 0.0;
  1673. // 5. Return ! WritableStreamDefaultControllerGetDesiredSize(stream.[[controller]]).
  1674. return writable_stream_default_controller_get_desired_size(*stream->controller());
  1675. }
  1676. // https://streams.spec.whatwg.org/#writable-stream-default-writer-release
  1677. WebIDL::ExceptionOr<void> writable_stream_default_writer_release(WritableStreamDefaultWriter& writer)
  1678. {
  1679. auto& realm = writer.realm();
  1680. // 1. Let stream be writer.[[stream]].
  1681. auto stream = writer.stream();
  1682. // 2. Assert: stream is not undefined.
  1683. VERIFY(stream);
  1684. // 3. Assert: stream.[[writer]] is writer.
  1685. VERIFY(stream->writer().ptr() == &writer);
  1686. // 4. Let releasedError be a new TypeError.
  1687. auto released_error = MUST_OR_THROW_OOM(JS::TypeError::create(realm, "Writer's stream lock has been released"sv));
  1688. // 5. Perform ! WritableStreamDefaultWriterEnsureReadyPromiseRejected(writer, releasedError).
  1689. writable_stream_default_writer_ensure_ready_promise_rejected(writer, released_error);
  1690. // 6. Perform ! WritableStreamDefaultWriterEnsureClosedPromiseRejected(writer, releasedError).
  1691. writable_stream_default_writer_ensure_closed_promise_rejected(writer, released_error);
  1692. // 7. Set stream.[[writer]] to undefined.
  1693. stream->set_writer({});
  1694. // 8. Set writer.[[stream]] to undefined.
  1695. writer.set_stream({});
  1696. return {};
  1697. }
  1698. // https://streams.spec.whatwg.org/#writable-stream-default-writer-write
  1699. WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> writable_stream_default_writer_write(WritableStreamDefaultWriter& writer, JS::Value chunk)
  1700. {
  1701. auto& realm = writer.realm();
  1702. // 1. Let stream be writer.[[stream]].
  1703. auto stream = writer.stream();
  1704. // 2. Assert: stream is not undefined.
  1705. VERIFY(stream);
  1706. // 3. Let controller be stream.[[controller]].
  1707. auto controller = stream->controller();
  1708. // 4. Let chunkSize be ! WritableStreamDefaultControllerGetChunkSize(controller, chunk).
  1709. auto chunk_size = TRY(writable_stream_default_controller_get_chunk_size(*controller, chunk));
  1710. // 5. If stream is not equal to writer.[[stream]], return a promise rejected with a TypeError exception.
  1711. if (stream.ptr() != writer.stream().ptr()) {
  1712. auto exception = MUST_OR_THROW_OOM(JS::TypeError::create(realm, "Writer's locked stream changed during write"sv));
  1713. return WebIDL::create_rejected_promise(realm, exception);
  1714. }
  1715. // 6. Let state be stream.[[state]].
  1716. auto state = stream->state();
  1717. // 7. If state is "errored", return a promise rejected with stream.[[storedError]].
  1718. if (state == WritableStream::State::Errored)
  1719. return WebIDL::create_rejected_promise(realm, stream->stored_error());
  1720. // 8. If ! WritableStreamCloseQueuedOrInFlight(stream) is true or state is "closed", return a promise rejected with a TypeError exception indicating that the stream is closing or closed.
  1721. if (writable_stream_close_queued_or_in_flight(*stream) || state == WritableStream::State::Closed) {
  1722. auto exception = MUST_OR_THROW_OOM(JS::TypeError::create(realm, "Cannot write to a writer whose stream is closing or already closed"sv));
  1723. return WebIDL::create_rejected_promise(realm, exception);
  1724. }
  1725. // 9. If state is "erroring", return a promise rejected with stream.[[storedError]].
  1726. if (state == WritableStream::State::Erroring)
  1727. return WebIDL::create_rejected_promise(realm, stream->stored_error());
  1728. // 10. Assert: state is "writable".
  1729. VERIFY(state == WritableStream::State::Writable);
  1730. // 11. Let promise be ! WritableStreamAddWriteRequest(stream).
  1731. auto promise = writable_stream_add_write_request(*stream);
  1732. // 12. Perform ! WritableStreamDefaultControllerWrite(controller, chunk, chunkSize).
  1733. TRY(writable_stream_default_controller_write(*controller, chunk, chunk_size));
  1734. // 13. Return promise.
  1735. return promise;
  1736. }
  1737. // https://streams.spec.whatwg.org/#set-up-writable-stream-default-controller
  1738. WebIDL::ExceptionOr<void> set_up_writable_stream_default_controller(WritableStream& stream, WritableStreamDefaultController& controller, StartAlgorithm&& start_algorithm, WriteAlgorithm&& write_algorithm, CloseAlgorithm&& close_algorithm, AbortAlgorithm&& abort_algorithm, double high_water_mark, SizeAlgorithm&& size_algorithm)
  1739. {
  1740. auto& realm = stream.realm();
  1741. // 1. Assert: stream implements WritableStream.
  1742. // 2. Assert: stream.[[controller]] is undefined.
  1743. VERIFY(!stream.controller());
  1744. // 3. Set controller.[[stream]] to stream.
  1745. controller.set_stream(stream);
  1746. // 4. Set stream.[[controller]] to controller.
  1747. stream.set_controller(controller);
  1748. // 5. Perform ! ResetQueue(controller).
  1749. reset_queue(controller);
  1750. // 6. Set controller.[[signal]] to a new AbortSignal.
  1751. controller.set_signal(MUST_OR_THROW_OOM(realm.heap().allocate<DOM::AbortSignal>(realm, realm)));
  1752. // 7. Set controller.[[started]] to false.
  1753. controller.set_started(false);
  1754. // 8. Set controller.[[strategySizeAlgorithm]] to sizeAlgorithm.
  1755. controller.set_strategy_size_algorithm(move(size_algorithm));
  1756. // 9. Set controller.[[strategyHWM]] to highWaterMark.
  1757. controller.set_strategy_hwm(high_water_mark);
  1758. // 10. Set controller.[[writeAlgorithm]] to writeAlgorithm.
  1759. controller.set_write_algorithm(move(write_algorithm));
  1760. // 11. Set controller.[[closeAlgorithm]] to closeAlgorithm.
  1761. controller.set_close_algorithm(move(close_algorithm));
  1762. // 12. Set controller.[[abortAlgorithm]] to abortAlgorithm.
  1763. controller.set_abort_algorithm(move(abort_algorithm));
  1764. // 13. Let backpressure be ! WritableStreamDefaultControllerGetBackpressure(controller).
  1765. auto backpressure = writable_stream_default_controller_get_backpressure(controller);
  1766. // 14. Perform ! WritableStreamUpdateBackpressure(stream, backpressure).
  1767. writable_stream_update_backpressure(stream, backpressure);
  1768. // 15. Let startResult be the result of performing startAlgorithm. (This may throw an exception.)
  1769. auto start_result = TRY(start_algorithm());
  1770. // 16. Let startPromise be a promise resolved with startResult.
  1771. auto start_promise = WebIDL::create_resolved_promise(realm, start_result);
  1772. // 17. Upon fulfillment of startPromise,
  1773. WebIDL::upon_fulfillment(*start_promise, [&](auto const&) -> WebIDL::ExceptionOr<JS::Value> {
  1774. // 1. Assert: stream.[[state]] is "writable" or "erroring".
  1775. auto state = stream.state();
  1776. VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
  1777. // 2. Set controller.[[started]] to true.
  1778. controller.set_started(true);
  1779. // 3. Perform ! WritableStreamDefaultControllerAdvanceQueueIfNeeded(controller).
  1780. TRY(writable_stream_default_controller_advance_queue_if_needed(controller));
  1781. return JS::js_undefined();
  1782. });
  1783. // 18. Upon rejection of startPromise with reason r,
  1784. WebIDL::upon_rejection(*start_promise, [&](JS::Value reason) -> WebIDL::ExceptionOr<JS::Value> {
  1785. // 1. Assert: stream.[[state]] is "writable" or "erroring".
  1786. auto state = stream.state();
  1787. VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
  1788. // 2. Set controller.[[started]] to true.
  1789. controller.set_started(true);
  1790. // 3. Perform ! WritableStreamDealWithRejection(stream, r).
  1791. TRY(writable_stream_deal_with_rejection(stream, reason));
  1792. return JS::js_undefined();
  1793. });
  1794. return {};
  1795. }
  1796. // https://streams.spec.whatwg.org/#set-up-writable-stream-default-controller-from-underlying-sink
  1797. WebIDL::ExceptionOr<void> set_up_writable_stream_default_controller_from_underlying_sink(WritableStream& stream, JS::Value underlying_sink_value, UnderlyingSink& underlying_sink, double high_water_mark, SizeAlgorithm&& size_algorithm)
  1798. {
  1799. auto& realm = stream.realm();
  1800. // 1. Let controller be a new WritableStreamDefaultController.
  1801. auto controller = MUST_OR_THROW_OOM(realm.heap().allocate<WritableStreamDefaultController>(realm, realm));
  1802. // 2. Let startAlgorithm be an algorithm that returns undefined.
  1803. StartAlgorithm start_algorithm = [] { return JS::js_undefined(); };
  1804. // 3. Let writeAlgorithm be an algorithm that returns a promise resolved with undefined.
  1805. WriteAlgorithm write_algorithm = [&realm](auto const&) {
  1806. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  1807. };
  1808. // 4. Let closeAlgorithm be an algorithm that returns a promise resolved with undefined.
  1809. CloseAlgorithm close_algorithm = [&realm] {
  1810. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  1811. };
  1812. // 5. Let abortAlgorithm be an algorithm that returns a promise resolved with undefined.
  1813. AbortAlgorithm abort_algorithm = [&realm](auto const&) {
  1814. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  1815. };
  1816. // 6. If underlyingSinkDict["start"] exists, then set startAlgorithm to an algorithm which returns the result of invoking underlyingSinkDict["start"] with argument list « controller » and callback this value underlyingSink.
  1817. if (underlying_sink.start) {
  1818. start_algorithm = [controller, underlying_sink_value, callback = underlying_sink.start]() -> WebIDL::ExceptionOr<JS::Value> {
  1819. // Note: callback does not return a promise, so invoke_callback may return an abrupt completion
  1820. return TRY(WebIDL::invoke_callback(*callback, underlying_sink_value, controller)).release_value();
  1821. };
  1822. }
  1823. // 7. If underlyingSinkDict["write"] exists, then set writeAlgorithm to an algorithm which takes an argument chunk and returns the result of invoking underlyingSinkDict["write"] with argument list « chunk, controller » and callback this value underlyingSink.
  1824. if (underlying_sink.write) {
  1825. write_algorithm = [&realm, controller, underlying_sink_value, callback = underlying_sink.write](JS::Value chunk) -> WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> {
  1826. // Note: callback return a promise, so invoke_callback will never return an abrupt completion
  1827. auto result = MUST_OR_THROW_OOM(WebIDL::invoke_callback(*callback, underlying_sink_value, chunk, controller)).release_value();
  1828. return WebIDL::create_resolved_promise(realm, result);
  1829. };
  1830. }
  1831. // 8. If underlyingSinkDict["close"] exists, then set closeAlgorithm to an algorithm which returns the result of invoking underlyingSinkDict["close"] with argument list «» and callback this value underlyingSink.
  1832. if (underlying_sink.close) {
  1833. close_algorithm = [&realm, controller, underlying_sink_value, callback = underlying_sink.close]() -> WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> {
  1834. // Note: callback return a promise, so invoke_callback will never return an abrupt completion
  1835. auto result = MUST_OR_THROW_OOM(WebIDL::invoke_callback(*callback, underlying_sink_value)).release_value();
  1836. return WebIDL::create_resolved_promise(realm, result);
  1837. };
  1838. }
  1839. // 9. If underlyingSinkDict["abort"] exists, then set abortAlgorithm to an algorithm which takes an argument reason and returns the result of invoking underlyingSinkDict["abort"] with argument list « reason » and callback this value underlyingSink.
  1840. if (underlying_sink.abort) {
  1841. abort_algorithm = [&realm, controller, underlying_sink_value, callback = underlying_sink.abort](JS::Value reason) -> WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> {
  1842. // Note: callback return a promise, so invoke_callback will never return an abrupt completion
  1843. auto result = MUST_OR_THROW_OOM(WebIDL::invoke_callback(*callback, underlying_sink_value, reason)).release_value();
  1844. return WebIDL::create_resolved_promise(realm, result);
  1845. };
  1846. }
  1847. // 10. Perform ? SetUpWritableStreamDefaultController(stream, controller, startAlgorithm, writeAlgorithm, closeAlgorithm, abortAlgorithm, highWaterMark, sizeAlgorithm).
  1848. TRY(set_up_writable_stream_default_controller(stream, controller, move(start_algorithm), move(write_algorithm), move(close_algorithm), move(abort_algorithm), high_water_mark, move(size_algorithm)));
  1849. return {};
  1850. }
  1851. // https://streams.spec.whatwg.org/#writable-stream-default-controller-advance-queue-if-needed
  1852. WebIDL::ExceptionOr<void> writable_stream_default_controller_advance_queue_if_needed(WritableStreamDefaultController& controller)
  1853. {
  1854. // 1. Let stream be controller.[[stream]].
  1855. auto stream = controller.stream();
  1856. // 2. If controller.[[started]] is false, return.
  1857. if (!controller.started())
  1858. return {};
  1859. // 3. If stream.[[inFlightWriteRequest]] is not undefined, return.
  1860. if (stream->in_flight_write_request())
  1861. return {};
  1862. // 4. Let state be stream.[[state]].
  1863. auto state = stream->state();
  1864. // 5. Assert: state is not "closed" or "errored".
  1865. VERIFY(state != WritableStream::State::Closed && state != WritableStream::State::Errored);
  1866. // 6. If state is "erroring",
  1867. if (state == WritableStream::State::Erroring) {
  1868. // 1. Perform ! WritableStreamFinishErroring(stream).
  1869. // 2. Return.
  1870. return writable_stream_finish_erroring(*stream);
  1871. }
  1872. // 7. If controller.[[queue]] is empty, return.
  1873. if (controller.queue().is_empty())
  1874. return {};
  1875. // 8. Let value be ! PeekQueueValue(controller).
  1876. auto value = peek_queue_value(controller);
  1877. // 9. If value is the close sentinel, perform ! WritableStreamDefaultControllerProcessClose(controller).
  1878. if (is_close_sentinel(value)) {
  1879. TRY(writable_stream_default_controller_process_close(controller));
  1880. }
  1881. // 10. Otherwise, perform ! WritableStreamDefaultControllerProcessWrite(controller, value).
  1882. else {
  1883. TRY(writable_stream_default_controller_process_write(controller, value));
  1884. }
  1885. return {};
  1886. }
  1887. // https://streams.spec.whatwg.org/#writable-stream-default-controller-clear-algorithms
  1888. void writable_stream_default_controller_clear_algorithms(WritableStreamDefaultController& controller)
  1889. {
  1890. // FIXME: This AO can be invoked from within one of the algorithms below. If we clear them, it invokes SafeFunction's
  1891. // destructor, which asserts we are not currently invoking the function (as it clears the storage). We need to
  1892. // figure out how to delay this, as these algorithms may keep objects alive that can otherwise be GC'd.
  1893. (void)controller;
  1894. // 1. Set controller.[[writeAlgorithm]] to undefined.
  1895. // controller.set_write_algorithm({});
  1896. // 2. Set controller.[[closeAlgorithm]] to undefined.
  1897. // controller.set_close_algorithm({});
  1898. // 3. Set controller.[[abortAlgorithm]] to undefined.
  1899. // controller.set_abort_algorithm({});
  1900. // 4. Set controller.[[strategySizeAlgorithm]] to undefined.
  1901. // controller.set_strategy_size_algorithm({});
  1902. }
  1903. // https://streams.spec.whatwg.org/#writable-stream-default-controller-close
  1904. WebIDL::ExceptionOr<void> writable_stream_default_controller_close(WritableStreamDefaultController& controller)
  1905. {
  1906. // 1. Perform ! EnqueueValueWithSize(controller, close sentinel, 0).
  1907. TRY(enqueue_value_with_size(controller, create_close_sentinel(), JS::Value(0.0)));
  1908. // 2. Perform ! WritableStreamDefaultControllerAdvanceQueueIfNeeded(controller).
  1909. TRY(writable_stream_default_controller_advance_queue_if_needed(controller));
  1910. return {};
  1911. }
  1912. // https://streams.spec.whatwg.org/#writable-stream-default-controller-error
  1913. WebIDL::ExceptionOr<void> writable_stream_default_controller_error(WritableStreamDefaultController& controller, JS::Value error)
  1914. {
  1915. // 1. Let stream be controller.[[stream]].
  1916. auto stream = controller.stream();
  1917. // 2. Assert: stream.[[state]] is "writable".
  1918. VERIFY(stream->state() == WritableStream::State::Writable);
  1919. // 3. Perform ! WritableStreamDefaultControllerClearAlgorithms(controller).
  1920. writable_stream_default_controller_clear_algorithms(controller);
  1921. // 4. Perform ! WritableStreamStartErroring(stream, error).
  1922. return writable_stream_start_erroring(stream, error);
  1923. }
  1924. // https://streams.spec.whatwg.org/#writable-stream-default-controller-error-if-needed
  1925. WebIDL::ExceptionOr<void> writable_stream_default_controller_error_if_needed(WritableStreamDefaultController& controller, JS::Value error)
  1926. {
  1927. // 1. If controller.[[stream]].[[state]] is "writable", perform ! WritableStreamDefaultControllerError(controller, error).
  1928. if (controller.stream()->state() == WritableStream::State::Writable)
  1929. TRY(writable_stream_default_controller_error(controller, error));
  1930. return {};
  1931. }
  1932. // https://streams.spec.whatwg.org/#writable-stream-default-controller-get-backpressure
  1933. bool writable_stream_default_controller_get_backpressure(WritableStreamDefaultController const& controller)
  1934. {
  1935. // 1. Let desiredSize be ! WritableStreamDefaultControllerGetDesiredSize(controller).
  1936. auto desired_size = writable_stream_default_controller_get_desired_size(controller);
  1937. // 2. Return true if desiredSize ≤ 0, or false otherwise.
  1938. return desired_size <= 0.0;
  1939. }
  1940. // https://streams.spec.whatwg.org/#writable-stream-default-controller-get-chunk-size
  1941. WebIDL::ExceptionOr<JS::Value> writable_stream_default_controller_get_chunk_size(WritableStreamDefaultController& controller, JS::Value chunk)
  1942. {
  1943. // 1. Let returnValue be the result of performing controller.[[strategySizeAlgorithm]], passing in chunk, and interpreting the result as a completion record.
  1944. auto return_value = (*controller.strategy_size_algorithm())(chunk);
  1945. // 2. If returnValue is an abrupt completion,
  1946. if (return_value.is_abrupt()) {
  1947. // 1. Perform ! WritableStreamDefaultControllerErrorIfNeeded(controller, returnValue.[[Value]]).
  1948. TRY(writable_stream_default_controller_error_if_needed(controller, *return_value.release_value()));
  1949. // 2. Return 1.
  1950. return 1.0;
  1951. }
  1952. // 3. Return returnValue.[[Value]].
  1953. return *return_value.release_value();
  1954. }
  1955. // https://streams.spec.whatwg.org/#writable-stream-default-controller-get-desired-size
  1956. double writable_stream_default_controller_get_desired_size(WritableStreamDefaultController const& controller)
  1957. {
  1958. // 1. Return controller.[[strategyHWM]] − controller.[[queueTotalSize]].
  1959. return controller.strategy_hwm() - controller.queue_total_size();
  1960. }
  1961. // https://streams.spec.whatwg.org/#writable-stream-default-controller-process-close
  1962. WebIDL::ExceptionOr<void> writable_stream_default_controller_process_close(WritableStreamDefaultController& controller)
  1963. {
  1964. // 1. Let stream be controller.[[stream]].
  1965. auto stream = controller.stream();
  1966. // 2. Perform ! WritableStreamMarkCloseRequestInFlight(stream).
  1967. writable_stream_mark_close_request_in_flight(*stream);
  1968. // 3. Perform ! DequeueValue(controller).
  1969. dequeue_value(controller);
  1970. // 4. Assert: controller.[[queue]] is empty.
  1971. VERIFY(controller.queue().is_empty());
  1972. // 5. Let sinkClosePromise be the result of performing controller.[[closeAlgorithm]].
  1973. auto sink_close_promise = TRY((*controller.close_algorithm())());
  1974. // 6. Perform ! WritableStreamDefaultControllerClearAlgorithms(controller).
  1975. writable_stream_default_controller_clear_algorithms(controller);
  1976. // 7. Upon fulfillment of sinkClosePromise,
  1977. WebIDL::upon_fulfillment(*sink_close_promise, [&, stream = stream](auto const&) -> WebIDL::ExceptionOr<JS::Value> {
  1978. // 1. Perform ! WritableStreamFinishInFlightClose(stream).
  1979. writable_stream_finish_in_flight_close(*stream);
  1980. return JS::js_undefined();
  1981. });
  1982. // 8. Upon rejection of sinkClosePromise with reason reason,
  1983. WebIDL::upon_rejection(*sink_close_promise, [&, stream = stream](auto const& reason) -> WebIDL::ExceptionOr<JS::Value> {
  1984. // 1. Perform ! WritableStreamFinishInFlightCloseWithError(stream, reason).
  1985. TRY(writable_stream_finish_in_flight_close_with_error(*stream, reason));
  1986. return JS::js_undefined();
  1987. });
  1988. return {};
  1989. }
  1990. // https://streams.spec.whatwg.org/#writable-stream-default-controller-process-write
  1991. WebIDL::ExceptionOr<void> writable_stream_default_controller_process_write(WritableStreamDefaultController& controller, JS::Value chunk)
  1992. {
  1993. // 1. Let stream be controller.[[stream]].
  1994. auto stream = controller.stream();
  1995. // 2. Perform ! WritableStreamMarkFirstWriteRequestInFlight(stream).
  1996. writable_stream_mark_first_write_request_in_flight(*stream);
  1997. // 3. Let sinkWritePromise be the result of performing controller.[[writeAlgorithm]], passing in chunk.
  1998. auto sink_write_promise = TRY((*controller.write_algorithm())(chunk));
  1999. // 4. Upon fulfillment of sinkWritePromise,
  2000. WebIDL::upon_fulfillment(*sink_write_promise, [&, stream = stream](auto const&) -> WebIDL::ExceptionOr<JS::Value> {
  2001. // 1. Perform ! WritableStreamFinishInFlightWrite(stream).
  2002. writable_stream_finish_in_flight_write(*stream);
  2003. // 2. Let state be stream.[[state]].
  2004. auto state = stream->state();
  2005. // 3. Assert: state is "writable" or "erroring".
  2006. VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
  2007. // 4. Perform ! DequeueValue(controller).
  2008. dequeue_value(controller);
  2009. // 5. If ! WritableStreamCloseQueuedOrInFlight(stream) is false and state is "writable",
  2010. if (!writable_stream_close_queued_or_in_flight(*stream) && state == WritableStream::State::Writable) {
  2011. // 1. Let backpressure be ! WritableStreamDefaultControllerGetBackpressure(controller).
  2012. auto backpressure = writable_stream_default_controller_get_backpressure(controller);
  2013. // 2. Perform ! WritableStreamUpdateBackpressure(stream, backpressure).
  2014. writable_stream_update_backpressure(*stream, backpressure);
  2015. }
  2016. // 6 .Perform ! WritableStreamDefaultControllerAdvanceQueueIfNeeded(controller).
  2017. TRY(writable_stream_default_controller_advance_queue_if_needed(controller));
  2018. return JS::js_undefined();
  2019. });
  2020. // 5. Upon rejection of sinkWritePromise with reason,
  2021. WebIDL::upon_rejection(*sink_write_promise, [&, stream = stream](auto const& reason) -> WebIDL::ExceptionOr<JS::Value> {
  2022. // 1. If stream.[[state]] is "writable", perform ! WritableStreamDefaultControllerClearAlgorithms(controller).
  2023. if (stream->state() == WritableStream::State::Writable)
  2024. writable_stream_default_controller_clear_algorithms(controller);
  2025. // 2. Perform ! WritableStreamFinishInFlightWriteWithError(stream, reason).
  2026. TRY(writable_stream_finish_in_flight_write_with_error(*stream, reason));
  2027. return JS::js_undefined();
  2028. });
  2029. return {};
  2030. }
  2031. // https://streams.spec.whatwg.org/#writable-stream-default-controller-write
  2032. WebIDL::ExceptionOr<void> writable_stream_default_controller_write(WritableStreamDefaultController& controller, JS::Value chunk, JS::Value chunk_size)
  2033. {
  2034. auto& vm = controller.vm();
  2035. // 1. Let enqueueResult be EnqueueValueWithSize(controller, chunk, chunkSize).
  2036. auto enqueue_result = enqueue_value_with_size(controller, chunk, chunk_size);
  2037. // 2. If enqueueResult is an abrupt completion,
  2038. if (enqueue_result.is_exception()) {
  2039. auto throw_completion = Bindings::throw_dom_exception_if_needed(vm, [&] { return enqueue_result; }).throw_completion();
  2040. // 1. Perform ! WritableStreamDefaultControllerErrorIfNeeded(controller, enqueueResult.[[Value]]).
  2041. TRY(writable_stream_default_controller_error_if_needed(controller, *throw_completion.release_value()));
  2042. // 2. Return.
  2043. return {};
  2044. }
  2045. // 3. Let stream be controller.[[stream]].
  2046. auto stream = controller.stream();
  2047. // 4. If ! WritableStreamCloseQueuedOrInFlight(stream) is false and stream.[[state]] is "writable",
  2048. if (!writable_stream_close_queued_or_in_flight(*stream) && stream->state() == WritableStream::State::Writable) {
  2049. // 1. Let backpressure be ! WritableStreamDefaultControllerGetBackpressure(controller).
  2050. auto backpressure = writable_stream_default_controller_get_backpressure(controller);
  2051. // 2. Perform ! WritableStreamUpdateBackpressure(stream, backpressure).
  2052. writable_stream_update_backpressure(*stream, backpressure);
  2053. }
  2054. // 5. Perform ! WritableStreamDefaultControllerAdvanceQueueIfNeeded(controller).
  2055. TRY(writable_stream_default_controller_advance_queue_if_needed(controller));
  2056. return {};
  2057. }
  2058. // https://streams.spec.whatwg.org/#is-non-negative-number
  2059. bool is_non_negative_number(JS::Value value)
  2060. {
  2061. // 1. If Type(v) is not Number, return false.
  2062. if (!value.is_number())
  2063. return false;
  2064. // 2. If v is NaN, return false.
  2065. if (value.is_nan())
  2066. return false;
  2067. // 3. If v < 0, return false.
  2068. if (value.as_double() < 0.0)
  2069. return false;
  2070. // 4. Return true.
  2071. return true;
  2072. }
  2073. // https://streams.spec.whatwg.org/#close-sentinel
  2074. // Non-standard function that implements the "close sentinel" value.
  2075. JS::Value create_close_sentinel()
  2076. {
  2077. // The close sentinel is a unique value enqueued into [[queue]], in lieu of a chunk, to signal that the stream is closed. It is only used internally, and is never exposed to web developers.
  2078. // Note: We use the empty Value to signal this as, similarly to the note above, the empty value is not exposed to nor creatable by web developers.
  2079. return {};
  2080. }
  2081. // https://streams.spec.whatwg.org/#close-sentinel
  2082. // Non-standard function that implements the "If value is a close sentinel" check.
  2083. bool is_close_sentinel(JS::Value value)
  2084. {
  2085. return value.is_empty();
  2086. }
  2087. // Non-standard function to aid in converting a user-provided function into a WebIDL::Callback. This is essentially
  2088. // what the Bindings generator would do at compile time, but at runtime instead.
  2089. JS::ThrowCompletionOr<JS::Handle<WebIDL::CallbackType>> property_to_callback(JS::VM& vm, JS::Value value, JS::PropertyKey const& property_key, WebIDL::OperationReturnsPromise operation_returns_promise)
  2090. {
  2091. auto property = TRY(value.get(vm, property_key));
  2092. if (property.is_undefined())
  2093. return JS::Handle<WebIDL::CallbackType> {};
  2094. if (!property.is_function())
  2095. return vm.throw_completion<JS::TypeError>(JS::ErrorType::NotAFunction, TRY_OR_THROW_OOM(vm, property.to_string_without_side_effects()));
  2096. return vm.heap().allocate_without_realm<WebIDL::CallbackType>(property.as_object(), HTML::incumbent_settings_object(), operation_returns_promise);
  2097. }
  2098. // https://streams.spec.whatwg.org/#set-up-readable-byte-stream-controller-from-underlying-source
  2099. WebIDL::ExceptionOr<void> set_up_readable_byte_stream_controller_from_underlying_source(ReadableStream& stream, JS::Value underlying_source, UnderlyingSource const& underlying_source_dict, double high_water_mark)
  2100. {
  2101. auto& realm = stream.realm();
  2102. // 1. Let controller be a new ReadableByteStreamController.
  2103. auto controller = MUST_OR_THROW_OOM(stream.heap().allocate<ReadableByteStreamController>(realm, realm));
  2104. // 2. Let startAlgorithm be an algorithm that returns undefined.
  2105. StartAlgorithm start_algorithm = [] { return JS::js_undefined(); };
  2106. // 3. Let pullAlgorithm be an algorithm that returns a promise resolved with undefined.
  2107. PullAlgorithm pull_algorithm = [&realm]() {
  2108. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  2109. };
  2110. // 4. Let cancelAlgorithm be an algorithm that returns a promise resolved with undefined.
  2111. CancelAlgorithm cancel_algorithm = [&realm](auto const&) {
  2112. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  2113. };
  2114. // 5. If underlyingSourceDict["start"] exists, then set startAlgorithm to an algorithm which returns the result of invoking underlyingSourceDict["start"] with argument list « controller » and callback this value underlyingSource.
  2115. if (underlying_source_dict.start) {
  2116. start_algorithm = [controller, underlying_source, callback = underlying_source_dict.start]() -> WebIDL::ExceptionOr<JS::Value> {
  2117. // Note: callback does not return a promise, so invoke_callback may return an abrupt completion
  2118. return TRY(WebIDL::invoke_callback(*callback, underlying_source, controller)).release_value();
  2119. };
  2120. }
  2121. // 6. If underlyingSourceDict["pull"] exists, then set pullAlgorithm to an algorithm which returns the result of invoking underlyingSourceDict["pull"] with argument list « controller » and callback this value underlyingSource.
  2122. if (underlying_source_dict.pull) {
  2123. pull_algorithm = [&realm, controller, underlying_source, callback = underlying_source_dict.pull]() -> WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> {
  2124. // Note: callback return a promise, so invoke_callback will never return an abrupt completion
  2125. auto result = MUST_OR_THROW_OOM(WebIDL::invoke_callback(*callback, underlying_source, controller)).release_value();
  2126. return WebIDL::create_resolved_promise(realm, result);
  2127. };
  2128. }
  2129. // 7. If underlyingSourceDict["cancel"] exists, then set cancelAlgorithm to an algorithm which takes an argument reason and returns the result of invoking underlyingSourceDict["cancel"] with argument list « reason » and callback this value underlyingSource.
  2130. if (underlying_source_dict.cancel) {
  2131. cancel_algorithm = [&realm, controller, underlying_source, callback = underlying_source_dict.cancel](auto const& reason) -> WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> {
  2132. // Note: callback return a promise, so invoke_callback will never return an abrupt completion
  2133. auto result = MUST_OR_THROW_OOM(WebIDL::invoke_callback(*callback, underlying_source, reason)).release_value();
  2134. return WebIDL::create_resolved_promise(realm, result);
  2135. };
  2136. }
  2137. // 8. Let autoAllocateChunkSize be underlyingSourceDict["autoAllocateChunkSize"], if it exists, or undefined otherwise.
  2138. auto auto_allocate_chunk_size = underlying_source_dict.auto_allocate_chunk_size.has_value()
  2139. ? JS::Value(underlying_source_dict.auto_allocate_chunk_size.value())
  2140. : JS::js_undefined();
  2141. // 9. If autoAllocateChunkSize is 0, then throw a TypeError exception.
  2142. if (auto_allocate_chunk_size.is_integral_number() && auto_allocate_chunk_size.as_double() == 0)
  2143. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, "Cannot use an auto allocate chunk size of 0"sv };
  2144. // 10. Perform ? SetUpReadableByteStreamController(stream, controller, startAlgorithm, pullAlgorithm, cancelAlgorithm, highWaterMark, autoAllocateChunkSize).
  2145. return set_up_readable_byte_stream_controller(stream, controller, move(start_algorithm), move(pull_algorithm), move(cancel_algorithm), high_water_mark, auto_allocate_chunk_size);
  2146. }
  2147. }