AbstractOperations.cpp 61 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516
  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/Streams/AbstractOperations.h>
  11. #include <LibWeb/Streams/ReadableStream.h>
  12. #include <LibWeb/Streams/ReadableStreamDefaultController.h>
  13. #include <LibWeb/Streams/ReadableStreamDefaultReader.h>
  14. #include <LibWeb/Streams/ReadableStreamGenericReader.h>
  15. #include <LibWeb/Streams/UnderlyingSink.h>
  16. #include <LibWeb/Streams/UnderlyingSource.h>
  17. #include <LibWeb/Streams/WritableStream.h>
  18. #include <LibWeb/Streams/WritableStreamDefaultController.h>
  19. #include <LibWeb/Streams/WritableStreamDefaultWriter.h>
  20. #include <LibWeb/WebIDL/AbstractOperations.h>
  21. #include <LibWeb/WebIDL/ExceptionOr.h>
  22. #include <LibWeb/WebIDL/Promise.h>
  23. namespace Web::Streams {
  24. // https://streams.spec.whatwg.org/#acquire-readable-stream-reader
  25. WebIDL::ExceptionOr<JS::NonnullGCPtr<ReadableStreamDefaultReader>> acquire_readable_stream_default_reader(ReadableStream& stream)
  26. {
  27. auto& realm = stream.realm();
  28. // 1. Let reader be a new ReadableStreamDefaultReader.
  29. auto reader = TRY(realm.heap().allocate<ReadableStreamDefaultReader>(realm, realm));
  30. // 2. Perform ? SetUpReadableStreamDefaultReader(reader, stream).
  31. TRY(set_up_readable_stream_default_reader(reader, stream));
  32. // 3. Return reader.
  33. return reader;
  34. }
  35. // https://streams.spec.whatwg.org/#is-readable-stream-locked
  36. bool is_readable_stream_locked(ReadableStream const& stream)
  37. {
  38. // 1. If stream.[[reader]] is undefined, return false.
  39. if (!stream.reader())
  40. return false;
  41. // 2. Return true.
  42. return true;
  43. }
  44. // https://streams.spec.whatwg.org/#readable-stream-cancel
  45. WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> readable_stream_cancel(ReadableStream& stream, JS::Value reason)
  46. {
  47. auto& realm = stream.realm();
  48. // 1. Set stream.[[disturbed]] to true.
  49. stream.set_disturbed(true);
  50. // 2. If stream.[[state]] is "closed", return a promise resolved with undefined.
  51. if (stream.is_closed())
  52. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  53. // 3. If stream.[[state]] is "errored", return a promise rejected with stream.[[storedError]].
  54. if (stream.is_errored())
  55. return WebIDL::create_rejected_promise(realm, stream.stored_error());
  56. // 4. Perform ! ReadableStreamClose(stream).
  57. readable_stream_close(stream);
  58. // 5. Let reader be stream.[[reader]].
  59. auto reader = stream.reader();
  60. // FIXME:
  61. // 6. If reader is not undefined and reader implements ReadableStreamBYOBReader,
  62. // 1. Let readIntoRequests be reader.[[readIntoRequests]].
  63. // 2. Set reader.[[readIntoRequests]] to an empty list.
  64. // 3. For each readIntoRequest of readIntoRequests,
  65. // 1. Perform readIntoRequest’s close steps, given undefined.
  66. (void)reader;
  67. // 7. Let sourceCancelPromise be ! stream.[[controller]].[[CancelSteps]](reason).
  68. auto source_cancel_promise = MUST(stream.controller()->cancel_steps(reason));
  69. // 8. Return the result of reacting to sourceCancelPromise with a fulfillment step that returns undefined.
  70. auto react_result = WebIDL::react_to_promise(*source_cancel_promise,
  71. [](auto const&) -> WebIDL::ExceptionOr<JS::Value> { return JS::js_undefined(); },
  72. {});
  73. return WebIDL::create_resolved_promise(realm, react_result);
  74. }
  75. // https://streams.spec.whatwg.org/#readable-stream-fulfill-read-request
  76. void readable_stream_fulfill_read_request(ReadableStream& stream, JS::Value chunk, bool done)
  77. {
  78. // 1. Assert: ! ReadableStreamHasDefaultReader(stream) is true.
  79. VERIFY(readable_stream_has_default_reader(stream));
  80. // 2. Let reader be stream.[[reader]].
  81. auto& reader = *stream.reader();
  82. // 3. Assert: reader.[[readRequests]] is not empty.
  83. VERIFY(!reader.read_requests().is_empty());
  84. // 4. Let readRequest be reader.[[readRequests]][0].
  85. // 5. Remove readRequest from reader.[[readRequests]].
  86. auto read_request = reader.read_requests().take_first();
  87. // 6. If done is true, perform readRequest’s close steps.
  88. if (done) {
  89. read_request->on_close();
  90. }
  91. // 7. Otherwise, perform readRequest’s chunk steps, given chunk.
  92. else {
  93. read_request->on_chunk(chunk);
  94. }
  95. }
  96. // https://streams.spec.whatwg.org/#readable-stream-get-num-read-requests
  97. size_t readable_stream_get_num_read_requests(ReadableStream& stream)
  98. {
  99. // 1. Assert: ! ReadableStreamHasDefaultReader(stream) is true.
  100. VERIFY(readable_stream_has_default_reader(stream));
  101. // 2. Return stream.[[reader]].[[readRequests]]'s size.
  102. return stream.reader()->read_requests().size();
  103. }
  104. // https://streams.spec.whatwg.org/#readable-stream-has-default-reader
  105. bool readable_stream_has_default_reader(ReadableStream& stream)
  106. {
  107. // 1. Let reader be stream.[[reader]].
  108. auto reader = stream.reader();
  109. // 2. If reader is undefined, return false.
  110. if (!reader)
  111. return false;
  112. // 3. If reader implements ReadableStreamDefaultReader, return true.
  113. if (reader->is_default_reader())
  114. return true;
  115. // 4. Return false.
  116. return false;
  117. }
  118. // https://streams.spec.whatwg.org/#readable-stream-close
  119. void readable_stream_close(ReadableStream& stream)
  120. {
  121. auto& realm = stream.realm();
  122. // 1. Assert: stream.[[state]] is "readable".
  123. VERIFY(stream.is_readable());
  124. // 2. Set stream.[[state]] to "closed".
  125. stream.set_stream_state(ReadableStream::State::Closed);
  126. // 3. Let reader be stream.[[reader]].
  127. auto reader = stream.reader();
  128. // 4. If reader is undefined, return.
  129. if (!reader)
  130. return;
  131. // 5. Resolve reader.[[closedPromise]] with undefined.
  132. WebIDL::resolve_promise(realm, *reader->closed_promise_capability());
  133. // 6. If reader implements ReadableStreamDefaultReader,
  134. if (reader->is_default_reader()) {
  135. // 1. Let readRequests be reader.[[readRequests]].
  136. // 2. Set reader.[[readRequests]] to an empty list.
  137. auto read_requests = move(reader->read_requests());
  138. // 3. For each readRequest of readRequests,
  139. for (auto& read_request : read_requests) {
  140. // 1. Perform readRequest’s close steps.
  141. read_request->on_close();
  142. }
  143. }
  144. }
  145. // https://streams.spec.whatwg.org/#readable-stream-error
  146. void readable_stream_error(ReadableStream& stream, JS::Value error)
  147. {
  148. auto& realm = stream.realm();
  149. // 1. Assert: stream.[[state]] is "readable".
  150. VERIFY(stream.is_readable());
  151. // 2. Set stream.[[state]] to "errored".
  152. stream.set_stream_state(ReadableStream::State::Errored);
  153. // 3. Set stream.[[storedError]] to e.
  154. stream.set_stored_error(error);
  155. // 4. Let reader be stream.[[reader]].
  156. auto reader = stream.reader();
  157. // 5. If reader is undefined, return.
  158. if (!reader)
  159. return;
  160. // 6. Reject reader.[[closedPromise]] with e.
  161. WebIDL::reject_promise(realm, *reader->closed_promise_capability(), error);
  162. // 7. Set reader.[[closedPromise]].[[PromiseIsHandled]] to true.
  163. WebIDL::mark_promise_as_handled(*reader->closed_promise_capability());
  164. // 8. If reader implements ReadableStreamDefaultReader,
  165. if (reader->is_default_reader()) {
  166. // 1. Perform ! ReadableStreamDefaultReaderErrorReadRequests(reader, e).
  167. readable_stream_default_reader_error_read_requests(*reader, error);
  168. }
  169. // 9. Otherwise,
  170. else {
  171. // 1. Assert: reader implements ReadableStreamBYOBReader.
  172. // 2. Perform ! ReadableStreamBYOBReaderErrorReadIntoRequests(reader, e).
  173. // FIXME: Handle BYOBReader
  174. TODO();
  175. }
  176. }
  177. // https://streams.spec.whatwg.org/#readable-stream-add-read-request
  178. void readable_stream_add_read_request(ReadableStream& stream, ReadRequest const& read_request)
  179. {
  180. // FIXME: Check implementation type
  181. // 1. Assert: stream.[[reader]] implements ReadableStreamDefaultReader.
  182. VERIFY(stream.reader());
  183. // 2. Assert: stream.[[state]] is "readable".
  184. VERIFY(stream.is_readable());
  185. // 3. Append readRequest to stream.[[reader]].[[readRequests]].
  186. stream.reader()->read_requests().append(read_request);
  187. }
  188. // https://streams.spec.whatwg.org/#readable-stream-reader-generic-cancel
  189. JS::NonnullGCPtr<WebIDL::Promise> readable_stream_reader_generic_cancel(ReadableStreamGenericReaderMixin& reader, JS::Value reason)
  190. {
  191. // 1. Let stream be reader.[[stream]]
  192. auto stream = reader.stream();
  193. // 2. Assert: stream is not undefined
  194. VERIFY(stream);
  195. // 3. Return ! ReadableStreamCancel(stream, reason)
  196. return MUST(readable_stream_cancel(*stream, reason));
  197. }
  198. // https://streams.spec.whatwg.org/#readable-stream-reader-generic-initialize
  199. void readable_stream_reader_generic_initialize(ReadableStreamGenericReaderMixin& reader, ReadableStream& stream)
  200. {
  201. auto& realm = stream.realm();
  202. // 1. Set reader.[[stream]] to stream.
  203. reader.set_stream(stream);
  204. // 2. Set stream.[[reader]] to reader.
  205. if (reader.is_default_reader()) {
  206. stream.set_reader(static_cast<ReadableStreamDefaultReader&>(reader));
  207. } else {
  208. // FIXME: Handle other descendents of ReadableStreamGenericReaderMixin (i.e. BYOBReader)
  209. TODO();
  210. }
  211. // 3. If stream.[[state]] is "readable",
  212. if (stream.is_readable()) {
  213. // 1. Set reader.[[closedPromise]] to a new promise.
  214. reader.set_closed_promise_capability(WebIDL::create_promise(realm));
  215. }
  216. // 4. Otherwise, if stream.[[state]] is "closed",
  217. else if (stream.is_closed()) {
  218. // 1. Set reader.[[closedPromise]] to a promise resolved with undefined.
  219. reader.set_closed_promise_capability(WebIDL::create_resolved_promise(realm, JS::js_undefined()));
  220. }
  221. // 5. Otherwise,
  222. else {
  223. // 1. Assert: stream.[[state]] is "errored".
  224. VERIFY(stream.is_errored());
  225. // 2. Set reader.[[closedPromise]] to a promise rejected with stream.[[storedError]].
  226. reader.set_closed_promise_capability(WebIDL::create_rejected_promise(realm, stream.stored_error()));
  227. // 3. Set reader.[[closedPromise]].[[PromiseIsHandled]] to true.
  228. WebIDL::mark_promise_as_handled(*reader.closed_promise_capability());
  229. }
  230. }
  231. // https://streams.spec.whatwg.org/#readable-stream-reader-generic-release
  232. WebIDL::ExceptionOr<void> readable_stream_reader_generic_release(ReadableStreamGenericReaderMixin& reader)
  233. {
  234. // 1. Let stream be reader.[[stream]].
  235. auto stream = reader.stream();
  236. // 2. Assert: stream is not undefined.
  237. VERIFY(stream);
  238. // 3. Assert: stream.[[reader]] is reader.
  239. VERIFY(stream->reader().ptr() == &reader);
  240. // 4. If stream.[[state]] is "readable", reject reader.[[closedPromise]] with a TypeError exception.
  241. auto exception = TRY(JS::TypeError::create(stream->realm(), "Released readable stream"sv));
  242. if (stream->is_readable()) {
  243. WebIDL::reject_promise(stream->realm(), *reader.closed_promise_capability(), exception);
  244. }
  245. // 5. Otherwise, set reader.[[closedPromise]] to a promise rejected with a TypeError exception.
  246. else {
  247. reader.set_closed_promise_capability(WebIDL::create_rejected_promise(stream->realm(), exception));
  248. }
  249. // 6. Set reader.[[closedPromise]].[[PromiseIsHandled]] to true.
  250. WebIDL::mark_promise_as_handled(*reader.closed_promise_capability());
  251. // 7. Perform ! stream.[[controller]].[[ReleaseSteps]]().
  252. stream->controller()->release_steps();
  253. // 8. Set stream.[[reader]] to undefined.
  254. stream->set_reader({});
  255. // 9. Set reader.[[stream]] to undefined.
  256. reader.set_stream({});
  257. return {};
  258. }
  259. // https://streams.spec.whatwg.org/#abstract-opdef-readablestreamdefaultreadererrorreadrequests
  260. void readable_stream_default_reader_error_read_requests(ReadableStreamDefaultReader& reader, JS::Value error)
  261. {
  262. // 1. Let readRequests be reader.[[readRequests]].
  263. // 2. Set reader.[[readRequests]] to a new empty list.
  264. auto read_requests = move(reader.read_requests());
  265. // 3. For each readRequest of readRequests,
  266. for (auto& read_request : read_requests) {
  267. // 1. Perform readRequest’s error steps, given e.
  268. read_request->on_error(error);
  269. }
  270. }
  271. // https://streams.spec.whatwg.org/#readable-stream-default-reader-read
  272. void readable_stream_default_reader_read(ReadableStreamDefaultReader& reader, ReadRequest& read_request)
  273. {
  274. // 1. Let stream be reader.[[stream]].
  275. auto stream = reader.stream();
  276. // 2. Assert: stream is not undefined.
  277. VERIFY(stream);
  278. // 3. Set stream.[[disturbed]] to true.
  279. stream->set_disturbed(true);
  280. // 4. If stream.[[state]] is "closed", perform readRequest’s close steps.
  281. if (stream->is_closed()) {
  282. read_request.on_close();
  283. }
  284. // 5. Otherwise, if stream.[[state]] is "errored", perform readRequest’s error steps given stream.[[storedError]].
  285. else if (stream->is_errored()) {
  286. read_request.on_error(stream->stored_error());
  287. }
  288. // 6. Otherwise,
  289. else {
  290. // 1. Assert: stream.[[state]] is "readable".
  291. VERIFY(stream->is_readable());
  292. // 2. Perform ! stream.[[controller]].[[PullSteps]](readRequest).
  293. MUST(stream->controller()->pull_steps(read_request));
  294. }
  295. }
  296. // https://streams.spec.whatwg.org/#abstract-opdef-readablestreamdefaultreaderrelease
  297. WebIDL::ExceptionOr<void> readable_stream_default_reader_release(ReadableStreamDefaultReader& reader)
  298. {
  299. // 1. Perform ! ReadableStreamReaderGenericRelease(reader).
  300. TRY(readable_stream_reader_generic_release(reader));
  301. // 2. Let e be a new TypeError exception.
  302. auto e = TRY(JS::TypeError::create(reader.realm(), "Reader has been released"sv));
  303. // 3. Perform ! ReadableStreamDefaultReaderErrorReadRequests(reader, e).
  304. readable_stream_default_reader_error_read_requests(reader, e);
  305. return {};
  306. }
  307. // https://streams.spec.whatwg.org/#set-up-readable-stream-default-reader
  308. WebIDL::ExceptionOr<void> set_up_readable_stream_default_reader(ReadableStreamDefaultReader& reader, ReadableStream& stream)
  309. {
  310. // 1. If ! IsReadableStreamLocked(stream) is true, throw a TypeError exception.
  311. if (is_readable_stream_locked(stream))
  312. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, "Cannot create stream reader for a locked stream"sv };
  313. // 2. Perform ! ReadableStreamReaderGenericInitialize(reader, stream).
  314. // 3. Set reader.[[readRequests]] to a new empty list.
  315. readable_stream_reader_generic_initialize(reader, stream);
  316. return {};
  317. }
  318. // https://streams.spec.whatwg.org/#readable-stream-default-controller-close
  319. void readable_stream_default_controller_close(ReadableStreamDefaultController& controller)
  320. {
  321. // 1. If ! ReadableStreamDefaultControllerCanCloseOrEnqueue(controller) is false, return.
  322. if (!readable_stream_default_controller_can_close_or_enqueue(controller))
  323. return;
  324. // 2. Let stream be controller.[[stream]].
  325. auto stream = controller.stream();
  326. // 3. Set controller.[[closeRequested]] to true.
  327. controller.set_close_requested(true);
  328. // 4. If controller.[[queue]] is empty,
  329. if (controller.queue().is_empty()) {
  330. // 1. Perform ! ReadableStreamDefaultControllerClearAlgorithms(controller).
  331. readable_stream_default_controller_clear_algorithms(controller);
  332. // 2. Perform ! ReadableStreamClose(stream).
  333. readable_stream_close(*stream);
  334. }
  335. }
  336. // https://streams.spec.whatwg.org/#readable-stream-default-controller-enqueue
  337. WebIDL::ExceptionOr<void> readable_stream_default_controller_enqueue(ReadableStreamDefaultController& controller, JS::Value chunk)
  338. {
  339. auto& vm = controller.vm();
  340. // 1. If ! ReadableStreamDefaultControllerCanCloseOrEnqueue(controller) is false, return.
  341. if (!readable_stream_default_controller_can_close_or_enqueue(controller))
  342. return {};
  343. // 2. Let stream be controller.[[stream]].
  344. auto stream = controller.stream();
  345. // 3. If ! IsReadableStreamLocked(stream) is true and ! ReadableStreamGetNumReadRequests(stream) > 0, perform ! ReadableStreamFulfillReadRequest(stream, chunk, false).
  346. if (is_readable_stream_locked(*stream) && readable_stream_get_num_read_requests(*stream) > 0) {
  347. readable_stream_fulfill_read_request(*stream, chunk, false);
  348. }
  349. // 4. Otherwise,
  350. else {
  351. // 1. Let result be the result of performing controller.[[strategySizeAlgorithm]], passing in chunk, and interpreting the result as a completion record.
  352. auto result = (*controller.strategy_size_algorithm())(chunk);
  353. // 2. If result is an abrupt completion,
  354. if (result.is_abrupt()) {
  355. // 1. Perform ! ReadableStreamDefaultControllerError(controller, result.[[Value]]).
  356. readable_stream_default_controller_error(controller, result.value().value());
  357. // 2. Return result.
  358. return result;
  359. }
  360. // 3. Let chunkSize be result.[[Value]].
  361. auto chunk_size = TRY(result.release_value().release_value().to_double(vm));
  362. // 4. Let enqueueResult be EnqueueValueWithSize(controller, chunk, chunkSize).
  363. auto enqueue_result = enqueue_value_with_size(controller, chunk, chunk_size);
  364. // 5. If enqueueResult is an abrupt completion,
  365. if (enqueue_result.is_error()) {
  366. auto throw_completion = Bindings::throw_dom_exception_if_needed(vm, [&] { return enqueue_result; }).throw_completion();
  367. // 1. Perform ! ReadableStreamDefaultControllerError(controller, enqueueResult.[[Value]]).
  368. readable_stream_default_controller_error(controller, throw_completion.value().value());
  369. // 2. Return enqueueResult.
  370. return enqueue_result;
  371. }
  372. }
  373. // 5. Perform ! ReadableStreamDefaultControllerCallPullIfNeeded(controller).
  374. return readable_stream_default_controller_can_pull_if_needed(controller);
  375. }
  376. // https://streams.spec.whatwg.org/#readable-stream-default-controller-call-pull-if-needed
  377. WebIDL::ExceptionOr<void> readable_stream_default_controller_can_pull_if_needed(ReadableStreamDefaultController& controller)
  378. {
  379. // 1. Let shouldPull be ! ReadableStreamDefaultControllerShouldCallPull(controller).
  380. auto should_pull = readable_stream_default_controller_should_call_pull(controller);
  381. // 2. If shouldPull is false, return.
  382. if (!should_pull)
  383. return {};
  384. // 3. If controller.[[pulling]] is true,
  385. if (controller.pulling()) {
  386. // 1. Set controller.[[pullAgain]] to true.
  387. controller.set_pull_again(true);
  388. // 2. Return.
  389. return {};
  390. }
  391. // 4. Assert: controller.[[pullAgain]] is false.
  392. VERIFY(!controller.pull_again());
  393. // 5. Set controller.[[pulling]] to true.
  394. controller.set_pulling(true);
  395. // 6. Let pullPromise be the result of performing controller.[[pullAlgorithm]].
  396. auto pull_promise = TRY((*controller.pull_algorithm())());
  397. // 7. Upon fulfillment of pullPromise,
  398. WebIDL::upon_fulfillment(*pull_promise, [&](auto const&) -> WebIDL::ExceptionOr<JS::Value> {
  399. // 1. Set controller.[[pulling]] to false.
  400. controller.set_pulling(false);
  401. // 2. If controller.[[pullAgain]] is true,
  402. if (controller.pull_again()) {
  403. // 1. Set controller.[[pullAgain]] to false.
  404. controller.set_pull_again(false);
  405. // 2. Perform ! ReadableStreamDefaultControllerCallPullIfNeeded(controller).
  406. TRY(readable_stream_default_controller_can_pull_if_needed(controller));
  407. }
  408. return JS::js_undefined();
  409. });
  410. // 8. Upon rejection of pullPromise with reason e,
  411. WebIDL::upon_rejection(*pull_promise, [&](auto const& e) -> WebIDL::ExceptionOr<JS::Value> {
  412. // 1. Perform ! ReadableStreamDefaultControllerError(controller, e).
  413. readable_stream_default_controller_error(controller, e);
  414. return JS::js_undefined();
  415. });
  416. return {};
  417. }
  418. // https://streams.spec.whatwg.org/#readable-stream-default-controller-should-call-pull
  419. bool readable_stream_default_controller_should_call_pull(ReadableStreamDefaultController& controller)
  420. {
  421. // 1. Let stream be controller.[[stream]].
  422. auto stream = controller.stream();
  423. // 2. If ! ReadableStreamDefaultControllerCanCloseOrEnqueue(controller) is false, return false.
  424. if (!readable_stream_default_controller_can_close_or_enqueue(controller))
  425. return false;
  426. // 3. If controller.[[started]] is false, return false.
  427. if (!controller.started())
  428. return false;
  429. // 4. If ! IsReadableStreamLocked(stream) is true and ! ReadableStreamGetNumReadRequests(stream) > 0, return true.
  430. if (is_readable_stream_locked(*stream) && readable_stream_get_num_read_requests(*stream) > 0)
  431. return true;
  432. // 5. Let desiredSize be ! ReadableStreamDefaultControllerGetDesiredSize(controller).
  433. auto desired_size = readable_stream_default_controller_get_desired_size(controller);
  434. // 6. Assert: desiredSize is not null.
  435. VERIFY(desired_size.has_value());
  436. // 7. If desiredSize > 0, return true.
  437. if (desired_size.release_value() > 0)
  438. return true;
  439. // 8. Return false.
  440. return false;
  441. }
  442. // https://streams.spec.whatwg.org/#readable-stream-default-controller-clear-algorithms
  443. void readable_stream_default_controller_clear_algorithms(ReadableStreamDefaultController& controller)
  444. {
  445. // 1. Set controller.[[pullAlgorithm]] to undefined.
  446. controller.set_pull_algorithm({});
  447. // 2. Set controller.[[cancelAlgorithm]] to undefined.
  448. controller.set_cancel_algorithm({});
  449. // 3. Set controller.[[strategySizeAlgorithm]] to undefined.
  450. controller.set_strategy_size_algorithm({});
  451. }
  452. // https://streams.spec.whatwg.org/#readable-stream-default-controller-error
  453. void readable_stream_default_controller_error(ReadableStreamDefaultController& controller, JS::Value error)
  454. {
  455. // 1. Let stream be controller.[[stream]].
  456. auto stream = controller.stream();
  457. // 2. If stream.[[state]] is not "readable", return.
  458. if (!stream->is_readable())
  459. return;
  460. // 3. Perform ! ResetQueue(controller).
  461. reset_queue(controller);
  462. // 4. Perform ! ReadableStreamDefaultControllerClearAlgorithms(controller).
  463. readable_stream_default_controller_clear_algorithms(controller);
  464. // 5. Perform ! ReadableStreamError(stream, e).
  465. readable_stream_error(*stream, error);
  466. }
  467. // https://streams.spec.whatwg.org/#readable-stream-default-controller-get-desired-size
  468. Optional<float> readable_stream_default_controller_get_desired_size(ReadableStreamDefaultController& controller)
  469. {
  470. auto stream = controller.stream();
  471. // 1. Let state be controller.[[stream]].[[state]].
  472. // 2. If state is "errored", return null.
  473. if (stream->is_errored())
  474. return {};
  475. // 3. If state is "closed", return 0.
  476. if (stream->is_closed())
  477. return 0.0f;
  478. // 4. Return controller.[[strategyHWM]] − controller.[[queueTotalSize]].
  479. return controller.strategy_hwm() - controller.queue_total_size();
  480. }
  481. // https://streams.spec.whatwg.org/#readable-stream-default-controller-can-close-or-enqueue
  482. bool readable_stream_default_controller_can_close_or_enqueue(ReadableStreamDefaultController& controller)
  483. {
  484. // 1. Let state be controller.[[stream]].[[state]].
  485. // 2. If controller.[[closeRequested]] is false and state is "readable", return true.
  486. // 3. Otherwise, return false.
  487. return !controller.close_requested() && controller.stream()->is_readable();
  488. }
  489. // https://streams.spec.whatwg.org/#set-up-readable-stream-default-controller
  490. 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)
  491. {
  492. auto& realm = stream.realm();
  493. // 1. Assert: stream.[[controller]] is undefined.
  494. VERIFY(!stream.controller());
  495. // 2. Set controller.[[stream]] to stream.
  496. controller.set_stream(stream);
  497. // 3. Perform ! ResetQueue(controller).
  498. reset_queue(controller);
  499. // 4. Set controller.[[started]], controller.[[closeRequested]], controller.[[pullAgain]], and controller.[[pulling]] to false.
  500. controller.set_started(false);
  501. controller.set_close_requested(false);
  502. controller.set_pull_again(false);
  503. controller.set_pulling(false);
  504. // 5. Set controller.[[strategySizeAlgorithm]] to sizeAlgorithm and controller.[[strategyHWM]] to highWaterMark.
  505. controller.set_strategy_size_algorithm(move(size_algorithm));
  506. controller.set_strategy_hwm(high_water_mark);
  507. // 6. Set controller.[[pullAlgorithm]] to pullAlgorithm.
  508. controller.set_pull_algorithm(move(pull_algorithm));
  509. // 7. Set controller.[[cancelAlgorithm]] to cancelAlgorithm.
  510. controller.set_cancel_algorithm(move(cancel_algorithm));
  511. // 8. Set stream.[[controller]] to controller.
  512. stream.set_controller(controller);
  513. // 9. Let startResult be the result of performing startAlgorithm. (This might throw an exception.)
  514. auto start_result = TRY(start_algorithm());
  515. // 10. Let startPromise be a promise resolved with startResult.
  516. auto start_promise = WebIDL::create_resolved_promise(realm, start_result ? start_result->promise() : JS::js_undefined());
  517. // 11. Upon fulfillment of startPromise,
  518. WebIDL::upon_fulfillment(start_promise, [&](auto const&) -> WebIDL::ExceptionOr<JS::Value> {
  519. // 1. Set controller.[[started]] to true.
  520. controller.set_started(true);
  521. // 2. Assert: controller.[[pulling]] is false.
  522. VERIFY(!controller.pulling());
  523. // 3. Assert: controller.[[pullAgain]] is false.
  524. VERIFY(!controller.pull_again());
  525. // 4. Perform ! ReadableStreamDefaultControllerCallPullIfNeeded(controller).
  526. TRY(readable_stream_default_controller_can_pull_if_needed(controller));
  527. return JS::js_undefined();
  528. });
  529. // 12. Upon rejection of startPromise with reason r,
  530. WebIDL::upon_rejection(start_promise, [&](auto const& r) -> WebIDL::ExceptionOr<JS::Value> {
  531. // 1. Perform ! ReadableStreamDefaultControllerError(controller, r).
  532. readable_stream_default_controller_error(controller, r);
  533. return JS::js_undefined();
  534. });
  535. return {};
  536. }
  537. // https://streams.spec.whatwg.org/#set-up-readable-stream-default-controller-from-underlying-source
  538. 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)
  539. {
  540. auto& realm = stream.realm();
  541. // 1. Let controller be a new ReadableStreamDefaultController.
  542. auto controller = MUST_OR_THROW_OOM(stream.heap().allocate<ReadableStreamDefaultController>(realm, realm));
  543. // 2. Let startAlgorithm be an algorithm that returns undefined.
  544. StartAlgorithm start_algorithm = [] { return JS::GCPtr<WebIDL::Promise> {}; };
  545. // 3. Let pullAlgorithm be an algorithm that returns a promise resolved with undefined.
  546. PullAlgorithm pull_algorithm = [&realm]() {
  547. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  548. };
  549. // 4. Let cancelAlgorithm be an algorithm that returns a promise resolved with undefined.
  550. CancelAlgorithm cancel_algorithm = [&realm](auto const&) {
  551. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  552. };
  553. // 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.
  554. if (underlying_source.start) {
  555. start_algorithm = [&, start = underlying_source.start]() -> WebIDL::ExceptionOr<JS::GCPtr<WebIDL::Promise>> {
  556. auto result = TRY(WebIDL::invoke_callback(*start, underlying_source_value, controller)).release_value();
  557. return WebIDL::create_resolved_promise(realm, result);
  558. };
  559. }
  560. // 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.
  561. if (underlying_source.pull) {
  562. pull_algorithm = [&, pull = underlying_source.pull]() -> WebIDL::ExceptionOr<JS::GCPtr<WebIDL::Promise>> {
  563. auto result = TRY(WebIDL::invoke_callback(*pull, underlying_source_value, controller)).release_value();
  564. return WebIDL::create_resolved_promise(realm, result);
  565. };
  566. }
  567. // 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.
  568. if (underlying_source.cancel) {
  569. cancel_algorithm = [&, cancel = underlying_source.cancel](auto const& reason) -> WebIDL::ExceptionOr<JS::GCPtr<WebIDL::Promise>> {
  570. auto result = TRY(WebIDL::invoke_callback(*cancel, underlying_source_value, reason)).release_value();
  571. return WebIDL::create_resolved_promise(realm, result);
  572. };
  573. }
  574. // 8. Perform ? SetUpReadableStreamDefaultController(stream, controller, startAlgorithm, pullAlgorithm, cancelAlgorithm, highWaterMark, sizeAlgorithm).
  575. return set_up_readable_stream_default_controller(stream, controller, move(start_algorithm), move(pull_algorithm), move(cancel_algorithm), high_water_mark, move(size_algorithm));
  576. }
  577. // https://streams.spec.whatwg.org/#is-writable-stream-locked
  578. bool is_writable_stream_locked(WritableStream const& stream)
  579. {
  580. // 1. If stream.[[writer]] is undefined, return false.
  581. if (!stream.writer())
  582. return false;
  583. // 2. Return true.
  584. return true;
  585. }
  586. // https://streams.spec.whatwg.org/#set-up-writable-stream-default-writer
  587. WebIDL::ExceptionOr<void> set_up_writable_stream_default_writer(WritableStreamDefaultWriter& writer, WritableStream& stream)
  588. {
  589. auto& realm = writer.realm();
  590. // 1. If ! IsWritableStreamLocked(stream) is true, throw a TypeError exception.
  591. if (is_writable_stream_locked(stream))
  592. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, "Stream is locked"sv };
  593. // 2. Set writer.[[stream]] to stream.
  594. writer.set_stream(stream);
  595. // 3. Set stream.[[writer]] to writer.
  596. stream.set_writer(writer);
  597. // 4. Let state be stream.[[state]].
  598. auto state = stream.state();
  599. // 5. If state is "writable",
  600. if (state == WritableStream::State::Writable) {
  601. // 1. If ! WritableStreamCloseQueuedOrInFlight(stream) is false and stream.[[backpressure]] is true, set writer.[[readyPromise]] to a new promise.
  602. if (!writable_stream_close_queued_or_in_flight(stream) && stream.backpressure()) {
  603. writer.set_ready_promise(WebIDL::create_promise(realm));
  604. }
  605. // 2. Otherwise, set writer.[[readyPromise]] to a promise resolved with undefined.
  606. else {
  607. writer.set_ready_promise(WebIDL::create_resolved_promise(realm, JS::js_undefined()));
  608. }
  609. // 3. Set writer.[[closedPromise]] to a new promise.
  610. writer.set_closed_promise(WebIDL::create_promise(realm));
  611. }
  612. // 6. Otherwise, if state is "erroring",
  613. else if (state == WritableStream::State::Erroring) {
  614. // 1. Set writer.[[readyPromise]] to a promise rejected with stream.[[storedError]].
  615. writer.set_ready_promise(WebIDL::create_rejected_promise(realm, stream.stored_error()));
  616. // 2. Set writer.[[readyPromise]].[[PromiseIsHandled]] to true.
  617. WebIDL::mark_promise_as_handled(*writer.ready_promise());
  618. // 3. Set writer.[[closedPromise]] to a new promise.
  619. writer.set_closed_promise(WebIDL::create_promise(realm));
  620. }
  621. // 7. Otherwise, if state is "closed",
  622. else if (state == WritableStream::State::Closed) {
  623. // 1. Set writer.[[readyPromise]] to a promise resolved with undefined.
  624. writer.set_ready_promise(WebIDL::create_resolved_promise(realm, JS::js_undefined()));
  625. // 2. Set writer.[[closedPromise]] to a promise resolved with undefined.
  626. writer.set_closed_promise(WebIDL::create_resolved_promise(realm, JS::js_undefined()));
  627. }
  628. // 8. Otherwise,
  629. else {
  630. // 1. Assert: state is "errored".
  631. VERIFY(state == WritableStream::State::Errored);
  632. // 2. Let storedError be stream.[[storedError]].
  633. auto stored_error = stream.stored_error();
  634. // 3. Set writer.[[readyPromise]] to a promise rejected with storedError.
  635. writer.set_ready_promise(WebIDL::create_rejected_promise(realm, stored_error));
  636. // 4. Set writer.[[readyPromise]].[[PromiseIsHandled]] to true.
  637. WebIDL::mark_promise_as_handled(*writer.ready_promise());
  638. // 5. Set writer.[[closedPromise]] to a promise rejected with storedError.
  639. writer.set_closed_promise(WebIDL::create_rejected_promise(realm, stored_error));
  640. // 6. Set writer.[[closedPromise]].[[PromiseIsHandled]] to true.
  641. WebIDL::mark_promise_as_handled(*writer.closed_promise());
  642. }
  643. return {};
  644. }
  645. // https://streams.spec.whatwg.org/#writable-stream-close
  646. WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> writable_stream_close(WritableStream& stream)
  647. {
  648. auto& realm = stream.realm();
  649. // 1. Let state be stream.[[state]].
  650. auto state = stream.state();
  651. // 2. If state is "closed" or "errored", return a promise rejected with a TypeError exception.
  652. if (state == WritableStream::State::Closed || state == WritableStream::State::Errored) {
  653. auto message = state == WritableStream::State::Closed ? "Cannot close a closed stream"sv : "Cannot close an errored stream"sv;
  654. auto exception = MUST_OR_THROW_OOM(JS::TypeError::create(realm, message));
  655. return WebIDL::create_rejected_promise(realm, exception);
  656. }
  657. // 3. Assert: state is "writable" or "erroring".
  658. VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
  659. // 4. Assert: ! WritableStreamCloseQueuedOrInFlight(stream) is false.
  660. VERIFY(!writable_stream_close_queued_or_in_flight(stream));
  661. // 5. Let promise be a new promise.
  662. auto promise = WebIDL::create_promise(realm);
  663. // 6. Set stream.[[closeRequest]] to promise.
  664. stream.set_close_request(promise);
  665. // 7. Let writer be stream.[[writer]].
  666. auto writer = stream.writer();
  667. // 8. If writer is not undefined, and stream.[[backpressure]] is true, and state is "writable", resolve writer.[[readyPromise]] with undefined.
  668. if (writer && stream.backpressure() && state == WritableStream::State::Writable)
  669. WebIDL::resolve_promise(realm, *writer->ready_promise(), JS::js_undefined());
  670. // 9. Perform ! WritableStreamDefaultControllerClose(stream.[[controller]]).
  671. TRY(writable_stream_default_controller_close(*stream.controller()));
  672. // 10. Return promise.
  673. return promise;
  674. }
  675. // https://streams.spec.whatwg.org/#writable-stream-close-queued-or-in-flight
  676. bool writable_stream_close_queued_or_in_flight(WritableStream const& stream)
  677. {
  678. // 1. If stream.[[closeRequest]] is undefined and stream.[[inFlightCloseRequest]] is undefined, return false.
  679. if (!stream.close_request() && !stream.in_flight_write_request())
  680. return false;
  681. // 2. Return true.
  682. return true;
  683. }
  684. // https://streams.spec.whatwg.org/#writable-stream-deal-with-rejection
  685. WebIDL::ExceptionOr<void> writable_stream_deal_with_rejection(WritableStream& stream, JS::Value error)
  686. {
  687. // 1. Let state be stream.[[state]].
  688. auto state = stream.state();
  689. // 2. If state is "writable",
  690. if (state == WritableStream::State::Writable) {
  691. // 1. Perform ! WritableStreamStartErroring(stream, error).
  692. // 2. Return.
  693. return writable_stream_start_erroring(stream, error);
  694. }
  695. // 3. Assert: state is "erroring".
  696. VERIFY(state == WritableStream::State::Erroring);
  697. // 4. Perform ! WritableStreamFinishErroring(stream).
  698. return writable_stream_finish_erroring(stream);
  699. }
  700. // https://streams.spec.whatwg.org/#writable-stream-finish-erroring
  701. WebIDL::ExceptionOr<void> writable_stream_finish_erroring(WritableStream& stream)
  702. {
  703. auto& realm = stream.realm();
  704. // 1. Assert: stream.[[state]] is "erroring".
  705. VERIFY(stream.state() == WritableStream::State::Erroring);
  706. // 2. Assert: ! WritableStreamHasOperationMarkedInFlight(stream) is false.
  707. VERIFY(!writable_stream_has_operation_marked_in_flight(stream));
  708. // 3. Set stream.[[state]] to "errored".
  709. stream.set_state(WritableStream::State::Errored);
  710. // 4. Perform ! stream.[[controller]].[[ErrorSteps]]().
  711. stream.controller()->error_steps();
  712. // 5. Let storedError be stream.[[storedError]].
  713. auto stored_error = stream.stored_error();
  714. // 6. For each writeRequest of stream.[[writeRequests]]:
  715. for (auto& write_request : stream.write_requests()) {
  716. // 1. Reject writeRequest with storedError.
  717. WebIDL::reject_promise(realm, *write_request, stored_error);
  718. }
  719. // 7. Set stream.[[writeRequests]] to an empty list.
  720. stream.write_requests().clear();
  721. // 8. If stream.[[pendingAbortRequest]] is undefined,
  722. if (!stream.pending_abort_request().has_value()) {
  723. // 1. Perform ! WritableStreamRejectCloseAndClosedPromiseIfNeeded(stream).
  724. writable_stream_reject_close_and_closed_promise_if_needed(stream);
  725. // 2. Return.
  726. return {};
  727. }
  728. // 9. Let abortRequest be stream.[[pendingAbortRequest]].
  729. // 10. Set stream.[[pendingAbortRequest]] to undefined.
  730. auto abort_request = stream.pending_abort_request().release_value();
  731. // 11. If abortRequest’s was already erroring is true,
  732. if (abort_request.was_already_erroring) {
  733. // 1. Reject abortRequest’s promise with storedError.
  734. WebIDL::reject_promise(realm, abort_request.promise, stored_error);
  735. // 2. Perform ! WritableStreamRejectCloseAndClosedPromiseIfNeeded(stream).
  736. writable_stream_reject_close_and_closed_promise_if_needed(stream);
  737. // 3. Return.
  738. return {};
  739. }
  740. // 12. Let promise be ! stream.[[controller]].[[AbortSteps]](abortRequest’s reason).
  741. auto promise = TRY(stream.controller()->abort_steps(abort_request.reason));
  742. // 13. Upon fulfillment of promise,
  743. WebIDL::upon_fulfillment(*promise, [&, abort_promise = abort_request.promise](auto const&) -> WebIDL::ExceptionOr<JS::Value> {
  744. // 1. Resolve abortRequest’s promise with undefined.
  745. WebIDL::resolve_promise(realm, abort_promise, JS::js_undefined());
  746. // 2. Perform ! WritableStreamRejectCloseAndClosedPromiseIfNeeded(stream).
  747. writable_stream_reject_close_and_closed_promise_if_needed(stream);
  748. return JS::js_undefined();
  749. });
  750. // 14. Upon rejection of promise with reason reason,
  751. WebIDL::upon_rejection(*promise, [&, abort_promise = abort_request.promise](auto const& reason) -> WebIDL::ExceptionOr<JS::Value> {
  752. // 1. Reject abortRequest’s promise with reason.
  753. WebIDL::reject_promise(realm, abort_promise, reason);
  754. // 2. Perform ! WritableStreamRejectCloseAndClosedPromiseIfNeeded(stream).
  755. writable_stream_reject_close_and_closed_promise_if_needed(stream);
  756. return JS::js_undefined();
  757. });
  758. return {};
  759. }
  760. // https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-close
  761. void writable_stream_finish_in_flight_close(WritableStream& stream)
  762. {
  763. auto& realm = stream.realm();
  764. // 1. Assert: stream.[[inFlightCloseRequest]] is not undefined.
  765. VERIFY(stream.in_flight_close_request());
  766. // 2. Resolve stream.[[inFlightCloseRequest]] with undefined.
  767. WebIDL::resolve_promise(realm, *stream.in_flight_close_request(), JS::js_undefined());
  768. // 3. Set stream.[[inFlightCloseRequest]] to undefined.
  769. stream.set_in_flight_close_request({});
  770. // 4. Let state be stream.[[state]].
  771. auto state = stream.state();
  772. // 5. Assert: stream.[[state]] is "writable" or "erroring".
  773. VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
  774. // 6. If state is "erroring",
  775. if (state == WritableStream::State::Erroring) {
  776. // 1. Set stream.[[storedError]] to undefined.
  777. stream.set_stored_error(JS::js_undefined());
  778. // 2. If stream.[[pendingAbortRequest]] is not undefined,
  779. if (stream.pending_abort_request().has_value()) {
  780. // 1. Resolve stream.[[pendingAbortRequest]]'s promise with undefined.
  781. // 2. Set stream.[[pendingAbortRequest]] to undefined.
  782. WebIDL::resolve_promise(realm, stream.pending_abort_request().release_value().promise, JS::js_undefined());
  783. }
  784. }
  785. // 7. Set stream.[[state]] to "closed".
  786. stream.set_state(WritableStream::State::Closed);
  787. // 8. Let writer be stream.[[writer]].
  788. auto writer = stream.writer();
  789. // 9. If writer is not undefined, resolve writer.[[closedPromise]] with undefined.
  790. if (writer)
  791. WebIDL::resolve_promise(realm, *writer->closed_promise(), JS::js_undefined());
  792. // 10. Assert: stream.[[pendingAbortRequest]] is undefined.
  793. VERIFY(!stream.pending_abort_request().has_value());
  794. // 11. Assert: stream.[[storedError]] is undefined.
  795. VERIFY(stream.stored_error().is_undefined());
  796. }
  797. // https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-close-with-error
  798. WebIDL::ExceptionOr<void> writable_stream_finish_in_flight_close_with_error(WritableStream& stream, JS::Value error)
  799. {
  800. auto& realm = stream.realm();
  801. // 1. Assert: stream.[[inFlightCloseRequest]] is not undefined.
  802. VERIFY(stream.in_flight_close_request());
  803. // 2. Reject stream.[[inFlightCloseRequest]] with error.
  804. WebIDL::reject_promise(realm, *stream.in_flight_close_request(), error);
  805. // 3. Set stream.[[inFlightCloseRequest]] to undefined.
  806. stream.set_in_flight_close_request({});
  807. // 4. Assert: stream.[[state]] is "writable" or "erroring".
  808. auto state = stream.state();
  809. VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
  810. // 5. If stream.[[pendingAbortRequest]] is not undefined,
  811. if (stream.pending_abort_request().has_value()) {
  812. // 1. Reject stream.[[pendingAbortRequest]]'s promise with error.
  813. // 2. Set stream.[[pendingAbortRequest]] to undefined.
  814. WebIDL::reject_promise(realm, stream.pending_abort_request().release_value().promise, error);
  815. }
  816. // 6. Perform ! WritableStreamDealWithRejection(stream, error).
  817. return writable_stream_deal_with_rejection(stream, error);
  818. }
  819. // https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-write
  820. void writable_stream_finish_in_flight_write(WritableStream& stream)
  821. {
  822. auto& realm = stream.realm();
  823. // 1. Assert: stream.[[inFlightWriteRequest]] is not undefined.
  824. VERIFY(stream.in_flight_write_request());
  825. // 2. Resolve stream.[[inFlightWriteRequest]] with undefined.
  826. WebIDL::resolve_promise(realm, *stream.in_flight_write_request(), JS::js_undefined());
  827. // 3. Set stream.[[inFlightWriteRequest]] to undefined.
  828. stream.set_in_flight_write_request({});
  829. }
  830. // https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-write-with-error
  831. WebIDL::ExceptionOr<void> writable_stream_finish_in_flight_write_with_error(WritableStream& stream, JS::Value error)
  832. {
  833. auto& realm = stream.realm();
  834. // 1. Assert: stream.[[inFlightWriteRequest]] is not undefined.
  835. VERIFY(stream.in_flight_write_request());
  836. // 2. Reject stream.[[inFlightWriteRequest]] with error.
  837. WebIDL::reject_promise(realm, *stream.in_flight_write_request(), error);
  838. // 3. Set stream.[[inFlightWriteRequest]] to undefined.
  839. stream.set_in_flight_write_request({});
  840. // 4. Assert: stream.[[state]] is "writable" or "erroring".
  841. auto state = stream.state();
  842. VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
  843. // 5. Perform ! WritableStreamDealWithRejection(stream, error).
  844. return writable_stream_deal_with_rejection(stream, error);
  845. }
  846. // https://streams.spec.whatwg.org/#writable-stream-has-operation-marked-in-flight
  847. bool writable_stream_has_operation_marked_in_flight(WritableStream const& stream)
  848. {
  849. // 1. If stream.[[inFlightWriteRequest]] is undefined and stream.[[inFlightCloseRequest]] is undefined, return false.
  850. if (!stream.in_flight_write_request() && !stream.in_flight_close_request())
  851. return false;
  852. // 2. Return true.
  853. return true;
  854. }
  855. // https://streams.spec.whatwg.org/#writable-stream-mark-close-request-in-flight
  856. void writable_stream_mark_close_request_in_flight(WritableStream& stream)
  857. {
  858. // 1. Assert: stream.[[inFlightCloseRequest]] is undefined.
  859. VERIFY(!stream.in_flight_close_request());
  860. // 2. Assert: stream.[[closeRequest]] is not undefined.
  861. VERIFY(stream.close_request());
  862. // 3. Set stream.[[inFlightCloseRequest]] to stream.[[closeRequest]].
  863. stream.set_in_flight_close_request(stream.close_request());
  864. // 4. Set stream.[[closeRequest]] to undefined.
  865. stream.set_close_request({});
  866. }
  867. // https://streams.spec.whatwg.org/#writable-stream-mark-first-write-request-in-flight
  868. void writable_stream_mark_first_write_request_in_flight(WritableStream& stream)
  869. {
  870. // 1. Assert: stream.[[inFlightWriteRequest]] is undefined.
  871. VERIFY(!stream.in_flight_write_request());
  872. // 2. Assert: stream.[[writeRequests]] is not empty.
  873. VERIFY(!stream.write_requests().is_empty());
  874. // 3. Let writeRequest be stream.[[writeRequests]][0].
  875. // 4. Remove writeRequest from stream.[[writeRequests]].
  876. auto write_request = stream.write_requests().take_first();
  877. // 5. Set stream.[[inFlightWriteRequest]] to writeRequest.
  878. stream.set_in_flight_write_request(write_request);
  879. }
  880. // https://streams.spec.whatwg.org/#writable-stream-reject-close-and-closed-promise-if-needed
  881. void writable_stream_reject_close_and_closed_promise_if_needed(WritableStream& stream)
  882. {
  883. auto& realm = stream.realm();
  884. // 1. Assert: stream.[[state]] is "errored".
  885. VERIFY(stream.state() == WritableStream::State::Errored);
  886. // 2. If stream.[[closeRequest]] is not undefined,
  887. if (stream.close_request()) {
  888. // 1. Assert: stream.[[inFlightCloseRequest]] is undefined.
  889. VERIFY(!stream.in_flight_close_request());
  890. // 2. Reject stream.[[closeRequest]] with stream.[[storedError]].
  891. WebIDL::reject_promise(realm, *stream.close_request(), stream.stored_error());
  892. // 3. Set stream.[[closeRequest]] to undefined.
  893. stream.set_close_request({});
  894. }
  895. // 3. Let writer be stream.[[writer]].
  896. auto writer = stream.writer();
  897. // 4. If writer is not undefined,
  898. if (writer) {
  899. // 1. Reject writer.[[closedPromise]] with stream.[[storedError]].
  900. WebIDL::reject_promise(realm, *writer->closed_promise(), stream.stored_error());
  901. // 2. Set writer.[[closedPromise]].[[PromiseIsHandled]] to true.
  902. WebIDL::mark_promise_as_handled(*writer->closed_promise());
  903. }
  904. }
  905. // https://streams.spec.whatwg.org/#writable-stream-start-erroring
  906. WebIDL::ExceptionOr<void> writable_stream_start_erroring(WritableStream& stream, JS::Value reason)
  907. {
  908. // 1. Assert: stream.[[storedError]] is undefined.
  909. VERIFY(stream.stored_error().is_undefined());
  910. // 2. Assert: stream.[[state]] is "writable".
  911. VERIFY(stream.state() == WritableStream::State::Writable);
  912. // 3. Let controller be stream.[[controller]].
  913. auto controller = stream.controller();
  914. // 4. Assert: controller is not undefined.
  915. VERIFY(controller);
  916. // 5. Set stream.[[state]] to "erroring".
  917. stream.set_state(WritableStream::State::Erroring);
  918. // 6. Set stream.[[storedError]] to reason.
  919. stream.set_stored_error(reason);
  920. // 7. Let writer be stream.[[writer]].
  921. auto writer = stream.writer();
  922. // 8. If writer is not undefined, perform ! WritableStreamDefaultWriterEnsureReadyPromiseRejected(writer, reason).
  923. if (writer)
  924. writable_stream_default_writer_ensure_ready_promise_rejected(*writer, reason);
  925. // 9. If ! WritableStreamHasOperationMarkedInFlight(stream) is false and controller.[[started]] is true, perform ! WritableStreamFinishErroring(stream).
  926. if (!writable_stream_has_operation_marked_in_flight(stream) && controller->started())
  927. TRY(writable_stream_finish_erroring(stream));
  928. return {};
  929. }
  930. // https://streams.spec.whatwg.org/#writable-stream-update-backpressure
  931. void writable_stream_update_backpressure(WritableStream& stream, bool backpressure)
  932. {
  933. auto& realm = stream.realm();
  934. // 1. Assert: stream.[[state]] is "writable".
  935. VERIFY(stream.state() == WritableStream::State::Writable);
  936. // 2. Assert: ! WritableStreamCloseQueuedOrInFlight(stream) is false.
  937. VERIFY(!writable_stream_close_queued_or_in_flight(stream));
  938. // 3. Let writer be stream.[[writer]].
  939. auto writer = stream.writer();
  940. // 4. If writer is not undefined and backpressure is not stream.[[backpressure]],
  941. if (writer && backpressure != stream.backpressure()) {
  942. // 1. If backpressure is true, set writer.[[readyPromise]] to a new promise.
  943. if (backpressure) {
  944. writer->set_ready_promise(WebIDL::create_promise(realm));
  945. }
  946. // 2. Otherwise,
  947. else {
  948. // 1. Assert: backpressure is false.
  949. // 2. Resolve writer.[[readyPromise]] with undefined.
  950. WebIDL::resolve_promise(realm, *writer->ready_promise(), JS::js_undefined());
  951. }
  952. }
  953. // 5. Set stream.[[backpressure]] to backpressure.
  954. stream.set_backpressure(backpressure);
  955. }
  956. // https://streams.spec.whatwg.org/#writable-stream-default-writer-ensure-ready-promise-rejected
  957. void writable_stream_default_writer_ensure_ready_promise_rejected(WritableStreamDefaultWriter& writer, JS::Value error)
  958. {
  959. auto& realm = writer.realm();
  960. // 1. If writer.[[readyPromise]].[[PromiseState]] is "pending", reject writer.[[readyPromise]] with error.
  961. auto& ready_promise = verify_cast<JS::Promise>(*writer.ready_promise()->promise());
  962. if (ready_promise.state() == JS::Promise::State::Pending) {
  963. WebIDL::reject_promise(realm, *writer.ready_promise(), error);
  964. }
  965. // 2. Otherwise, set writer.[[readyPromise]] to a promise rejected with error.
  966. else {
  967. writer.set_ready_promise(WebIDL::create_rejected_promise(realm, error));
  968. }
  969. // 3. Set writer.[[readyPromise]].[[PromiseIsHandled]] to true.
  970. WebIDL::mark_promise_as_handled(*writer.ready_promise());
  971. }
  972. // https://streams.spec.whatwg.org/#writable-stream-default-writer-get-desired-size
  973. Optional<double> writable_stream_default_writer_get_desired_size(WritableStreamDefaultWriter const& writer)
  974. {
  975. // 1. Let stream be writer.[[stream]].
  976. auto stream = writer.stream();
  977. // 2. Let state be stream.[[state]].
  978. auto state = stream->state();
  979. // 3. If state is "errored" or "erroring", return null.
  980. if (state == WritableStream::State::Errored || state == WritableStream::State::Erroring)
  981. return {};
  982. // 4. If state is "closed", return 0.
  983. if (state == WritableStream::State::Closed)
  984. return 0.0;
  985. // 5. Return ! WritableStreamDefaultControllerGetDesiredSize(stream.[[controller]]).
  986. return writable_stream_default_controller_get_desired_size(*stream->controller());
  987. }
  988. // https://streams.spec.whatwg.org/#writable-stream-default-controller-advance-queue-if-needed
  989. WebIDL::ExceptionOr<void> writable_stream_default_controller_advance_queue_if_needed(WritableStreamDefaultController& controller)
  990. {
  991. // 1. Let stream be controller.[[stream]].
  992. auto stream = controller.stream();
  993. // 2. If controller.[[started]] is false, return.
  994. if (!controller.started())
  995. return {};
  996. // 3. If stream.[[inFlightWriteRequest]] is not undefined, return.
  997. if (stream->in_flight_write_request())
  998. return {};
  999. // 4. Let state be stream.[[state]].
  1000. auto state = stream->state();
  1001. // 5. Assert: state is not "closed" or "errored".
  1002. VERIFY(state != WritableStream::State::Closed && state != WritableStream::State::Errored);
  1003. // 6. If state is "erroring",
  1004. if (state == WritableStream::State::Erroring) {
  1005. // 1. Perform ! WritableStreamFinishErroring(stream).
  1006. // 2. Return.
  1007. return writable_stream_finish_erroring(*stream);
  1008. }
  1009. // 7. If controller.[[queue]] is empty, return.
  1010. if (controller.queue().is_empty())
  1011. return {};
  1012. // 8. Let value be ! PeekQueueValue(controller).
  1013. auto value = peek_queue_value(controller);
  1014. // 9. If value is the close sentinel, perform ! WritableStreamDefaultControllerProcessClose(controller).
  1015. if (is_close_sentinel(value)) {
  1016. TRY(writable_stream_default_controller_process_close(controller));
  1017. }
  1018. // 10. Otherwise, perform ! WritableStreamDefaultControllerProcessWrite(controller, value).
  1019. else {
  1020. TRY(writable_stream_default_controller_process_write(controller, value));
  1021. }
  1022. return {};
  1023. }
  1024. // https://streams.spec.whatwg.org/#writable-stream-default-controller-clear-algorithms
  1025. void writable_stream_default_controller_clear_algorithms(WritableStreamDefaultController& controller)
  1026. {
  1027. // 1. Set controller.[[writeAlgorithm]] to undefined.
  1028. controller.set_write_algorithm({});
  1029. // 2. Set controller.[[closeAlgorithm]] to undefined.
  1030. controller.set_close_algorithm({});
  1031. // 3. Set controller.[[abortAlgorithm]] to undefined.
  1032. controller.set_abort_algorithm({});
  1033. // 4. Set controller.[[strategySizeAlgorithm]] to undefined.
  1034. controller.set_strategy_size_algorithm({});
  1035. }
  1036. // https://streams.spec.whatwg.org/#writable-stream-default-controller-close
  1037. WebIDL::ExceptionOr<void> writable_stream_default_controller_close(WritableStreamDefaultController& controller)
  1038. {
  1039. // 1. Perform ! EnqueueValueWithSize(controller, close sentinel, 0).
  1040. TRY(enqueue_value_with_size(controller, create_close_sentinel(), 0.0));
  1041. // 2. Perform ! WritableStreamDefaultControllerAdvanceQueueIfNeeded(controller).
  1042. TRY(writable_stream_default_controller_advance_queue_if_needed(controller));
  1043. return {};
  1044. }
  1045. // https://streams.spec.whatwg.org/#writable-stream-default-controller-error
  1046. WebIDL::ExceptionOr<void> writable_stream_default_controller_error(WritableStreamDefaultController& controller, JS::Value error)
  1047. {
  1048. // 1. Let stream be controller.[[stream]].
  1049. auto stream = controller.stream();
  1050. // 2. Assert: stream.[[state]] is "writable".
  1051. VERIFY(stream->state() == WritableStream::State::Writable);
  1052. // 3. Perform ! WritableStreamDefaultControllerClearAlgorithms(controller).
  1053. writable_stream_default_controller_clear_algorithms(controller);
  1054. // 4. Perform ! WritableStreamStartErroring(stream, error).
  1055. return writable_stream_start_erroring(stream, error);
  1056. }
  1057. // https://streams.spec.whatwg.org/#writable-stream-default-controller-get-backpressure
  1058. bool writable_stream_default_controller_get_backpressure(WritableStreamDefaultController const& controller)
  1059. {
  1060. // 1. Let desiredSize be ! WritableStreamDefaultControllerGetDesiredSize(controller).
  1061. auto desired_size = writable_stream_default_controller_get_desired_size(controller);
  1062. // 2. Return true if desiredSize ≤ 0, or false otherwise.
  1063. return desired_size <= 0.0;
  1064. }
  1065. // https://streams.spec.whatwg.org/#writable-stream-default-controller-get-desired-size
  1066. double writable_stream_default_controller_get_desired_size(WritableStreamDefaultController const& controller)
  1067. {
  1068. // 1. Return controller.[[strategyHWM]] − controller.[[queueTotalSize]].
  1069. return controller.strategy_hwm() - controller.queue_total_size();
  1070. }
  1071. // https://streams.spec.whatwg.org/#writable-stream-default-controller-process-close
  1072. WebIDL::ExceptionOr<void> writable_stream_default_controller_process_close(WritableStreamDefaultController& controller)
  1073. {
  1074. // 1. Let stream be controller.[[stream]].
  1075. auto stream = controller.stream();
  1076. // 2. Perform ! WritableStreamMarkCloseRequestInFlight(stream).
  1077. writable_stream_mark_close_request_in_flight(*stream);
  1078. // 3. Perform ! DequeueValue(controller).
  1079. dequeue_value(controller);
  1080. // 4. Assert: controller.[[queue]] is empty.
  1081. VERIFY(controller.queue().is_empty());
  1082. // 5. Let sinkClosePromise be the result of performing controller.[[closeAlgorithm]].
  1083. auto sink_close_promise = TRY((*controller.close_algorithm())());
  1084. // 6. Perform ! WritableStreamDefaultControllerClearAlgorithms(controller).
  1085. writable_stream_default_controller_clear_algorithms(controller);
  1086. // 7. Upon fulfillment of sinkClosePromise,
  1087. WebIDL::upon_fulfillment(*sink_close_promise, [&, stream = stream](auto const&) -> WebIDL::ExceptionOr<JS::Value> {
  1088. // 1. Perform ! WritableStreamFinishInFlightClose(stream).
  1089. writable_stream_finish_in_flight_close(*stream);
  1090. return JS::js_undefined();
  1091. });
  1092. // 8. Upon rejection of sinkClosePromise with reason reason,
  1093. WebIDL::upon_rejection(*sink_close_promise, [&, stream = stream](auto const& reason) -> WebIDL::ExceptionOr<JS::Value> {
  1094. // 1. Perform ! WritableStreamFinishInFlightCloseWithError(stream, reason).
  1095. TRY(writable_stream_finish_in_flight_close_with_error(*stream, reason));
  1096. return JS::js_undefined();
  1097. });
  1098. return {};
  1099. }
  1100. // https://streams.spec.whatwg.org/#writable-stream-default-controller-process-write
  1101. WebIDL::ExceptionOr<void> writable_stream_default_controller_process_write(WritableStreamDefaultController& controller, JS::Value chunk)
  1102. {
  1103. // 1. Let stream be controller.[[stream]].
  1104. auto stream = controller.stream();
  1105. // 2. Perform ! WritableStreamMarkFirstWriteRequestInFlight(stream).
  1106. writable_stream_mark_first_write_request_in_flight(*stream);
  1107. // 3. Let sinkWritePromise be the result of performing controller.[[writeAlgorithm]], passing in chunk.
  1108. auto sink_write_promise = TRY((*controller.write_algorithm())(chunk));
  1109. // 4. Upon fulfillment of sinkWritePromise,
  1110. WebIDL::upon_fulfillment(*sink_write_promise, [&, stream = stream](auto const&) -> WebIDL::ExceptionOr<JS::Value> {
  1111. // 1. Perform ! WritableStreamFinishInFlightWrite(stream).
  1112. writable_stream_finish_in_flight_write(*stream);
  1113. // 2. Let state be stream.[[state]].
  1114. auto state = stream->state();
  1115. // 3. Assert: state is "writable" or "erroring".
  1116. VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
  1117. // 4. Perform ! DequeueValue(controller).
  1118. dequeue_value(controller);
  1119. // 5. If ! WritableStreamCloseQueuedOrInFlight(stream) is false and state is "writable",
  1120. if (!writable_stream_close_queued_or_in_flight(*stream) && state == WritableStream::State::Writable) {
  1121. // 1. Let backpressure be ! WritableStreamDefaultControllerGetBackpressure(controller).
  1122. auto backpressure = writable_stream_default_controller_get_backpressure(controller);
  1123. // 2. Perform ! WritableStreamUpdateBackpressure(stream, backpressure).
  1124. writable_stream_update_backpressure(*stream, backpressure);
  1125. }
  1126. // 6 .Perform ! WritableStreamDefaultControllerAdvanceQueueIfNeeded(controller).
  1127. TRY(writable_stream_default_controller_advance_queue_if_needed(controller));
  1128. return JS::js_undefined();
  1129. });
  1130. // 5. Upon rejection of sinkWritePromise with reason,
  1131. WebIDL::upon_rejection(*sink_write_promise, [&, stream = stream](auto const& reason) -> WebIDL::ExceptionOr<JS::Value> {
  1132. // 1. If stream.[[state]] is "writable", perform ! WritableStreamDefaultControllerClearAlgorithms(controller).
  1133. if (stream->state() == WritableStream::State::Writable)
  1134. writable_stream_default_controller_clear_algorithms(controller);
  1135. // 2. Perform ! WritableStreamFinishInFlightWriteWithError(stream, reason).
  1136. TRY(writable_stream_finish_in_flight_write_with_error(*stream, reason));
  1137. return JS::js_undefined();
  1138. });
  1139. return {};
  1140. }
  1141. // https://streams.spec.whatwg.org/#close-sentinel
  1142. // Non-standard function that implements the "close sentinel" value.
  1143. JS::Value create_close_sentinel()
  1144. {
  1145. // 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.
  1146. // 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.
  1147. return {};
  1148. }
  1149. // https://streams.spec.whatwg.org/#close-sentinel
  1150. // Non-standard function that implements the "If value is a close sentinel" check.
  1151. bool is_close_sentinel(JS::Value value)
  1152. {
  1153. return value.is_empty();
  1154. }
  1155. // Non-standard function to aid in converting a user-provided function into a WebIDL::Callback. This is essentially
  1156. // what the Bindings generator would do at compile time, but at runtime instead.
  1157. JS::ThrowCompletionOr<JS::Handle<WebIDL::CallbackType>> property_to_callback(JS::VM& vm, JS::Value value, JS::PropertyKey const& property_key)
  1158. {
  1159. auto property = TRY(value.get(vm, property_key));
  1160. if (property.is_undefined())
  1161. return JS::Handle<WebIDL::CallbackType> {};
  1162. if (!property.is_function())
  1163. return vm.throw_completion<JS::TypeError>(JS::ErrorType::NotAFunction, TRY_OR_THROW_OOM(vm, property.to_string_without_side_effects()));
  1164. return vm.heap().allocate_without_realm<WebIDL::CallbackType>(property.as_object(), HTML::incumbent_settings_object());
  1165. }
  1166. }