AbstractOperations.cpp 95 KB

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