AbstractOperations.cpp 140 KB

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