12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093 |
- /*
- * Copyright (c) 2022, Linus Groh <linusg@serenityos.org>
- * Copyright (c) 2023, Matthew Olsson <mattco@serenityos.org>
- *
- * SPDX-License-Identifier: BSD-2-Clause
- */
- #include <LibJS/Runtime/PromiseCapability.h>
- #include <LibJS/Runtime/PromiseConstructor.h>
- #include <LibWeb/Bindings/ExceptionOrUtils.h>
- #include <LibWeb/DOM/AbortSignal.h>
- #include <LibWeb/Streams/AbstractOperations.h>
- #include <LibWeb/Streams/ReadableByteStreamController.h>
- #include <LibWeb/Streams/ReadableStream.h>
- #include <LibWeb/Streams/ReadableStreamBYOBRequest.h>
- #include <LibWeb/Streams/ReadableStreamDefaultController.h>
- #include <LibWeb/Streams/ReadableStreamDefaultReader.h>
- #include <LibWeb/Streams/ReadableStreamGenericReader.h>
- #include <LibWeb/Streams/UnderlyingSink.h>
- #include <LibWeb/Streams/UnderlyingSource.h>
- #include <LibWeb/Streams/WritableStream.h>
- #include <LibWeb/Streams/WritableStreamDefaultController.h>
- #include <LibWeb/Streams/WritableStreamDefaultWriter.h>
- #include <LibWeb/WebIDL/AbstractOperations.h>
- #include <LibWeb/WebIDL/ExceptionOr.h>
- #include <LibWeb/WebIDL/Promise.h>
- namespace Web::Streams {
- // https://streams.spec.whatwg.org/#acquire-readable-stream-reader
- WebIDL::ExceptionOr<JS::NonnullGCPtr<ReadableStreamDefaultReader>> acquire_readable_stream_default_reader(ReadableStream& stream)
- {
- auto& realm = stream.realm();
- // 1. Let reader be a new ReadableStreamDefaultReader.
- auto reader = TRY(realm.heap().allocate<ReadableStreamDefaultReader>(realm, realm));
- // 2. Perform ? SetUpReadableStreamDefaultReader(reader, stream).
- TRY(set_up_readable_stream_default_reader(reader, stream));
- // 3. Return reader.
- return reader;
- }
- // https://streams.spec.whatwg.org/#is-readable-stream-locked
- bool is_readable_stream_locked(ReadableStream const& stream)
- {
- // 1. If stream.[[reader]] is undefined, return false.
- if (!stream.reader())
- return false;
- // 2. Return true.
- return true;
- }
- // https://streams.spec.whatwg.org/#readable-stream-cancel
- WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> readable_stream_cancel(ReadableStream& stream, JS::Value reason)
- {
- auto& realm = stream.realm();
- // 1. Set stream.[[disturbed]] to true.
- stream.set_disturbed(true);
- // 2. If stream.[[state]] is "closed", return a promise resolved with undefined.
- if (stream.state() == ReadableStream::State::Closed)
- return WebIDL::create_resolved_promise(realm, JS::js_undefined());
- // 3. If stream.[[state]] is "errored", return a promise rejected with stream.[[storedError]].
- if (stream.state() == ReadableStream::State::Errored)
- return WebIDL::create_rejected_promise(realm, stream.stored_error());
- // 4. Perform ! ReadableStreamClose(stream).
- readable_stream_close(stream);
- // 5. Let reader be stream.[[reader]].
- auto reader = stream.reader();
- // FIXME:
- // 6. If reader is not undefined and reader implements ReadableStreamBYOBReader,
- // 1. Let readIntoRequests be reader.[[readIntoRequests]].
- // 2. Set reader.[[readIntoRequests]] to an empty list.
- // 3. For each readIntoRequest of readIntoRequests,
- // 1. Perform readIntoRequest’s close steps, given undefined.
- (void)reader;
- // 7. Let sourceCancelPromise be ! stream.[[controller]].[[CancelSteps]](reason).
- auto source_cancel_promise = TRY(stream.controller()->visit([&](auto const& controller) {
- return controller->cancel_steps(reason);
- }));
- // 8. Return the result of reacting to sourceCancelPromise with a fulfillment step that returns undefined.
- auto react_result = WebIDL::react_to_promise(*source_cancel_promise,
- [](auto const&) -> WebIDL::ExceptionOr<JS::Value> { return JS::js_undefined(); },
- {});
- return WebIDL::create_resolved_promise(realm, react_result);
- }
- // https://streams.spec.whatwg.org/#readable-stream-fulfill-read-request
- void readable_stream_fulfill_read_request(ReadableStream& stream, JS::Value chunk, bool done)
- {
- // 1. Assert: ! ReadableStreamHasDefaultReader(stream) is true.
- VERIFY(readable_stream_has_default_reader(stream));
- // 2. Let reader be stream.[[reader]].
- auto& reader = *stream.reader();
- // 3. Assert: reader.[[readRequests]] is not empty.
- VERIFY(!reader.read_requests().is_empty());
- // 4. Let readRequest be reader.[[readRequests]][0].
- // 5. Remove readRequest from reader.[[readRequests]].
- auto read_request = reader.read_requests().take_first();
- // 6. If done is true, perform readRequest’s close steps.
- if (done) {
- read_request->on_close();
- }
- // 7. Otherwise, perform readRequest’s chunk steps, given chunk.
- else {
- read_request->on_chunk(chunk);
- }
- }
- // https://streams.spec.whatwg.org/#readable-stream-get-num-read-requests
- size_t readable_stream_get_num_read_requests(ReadableStream& stream)
- {
- // 1. Assert: ! ReadableStreamHasDefaultReader(stream) is true.
- VERIFY(readable_stream_has_default_reader(stream));
- // 2. Return stream.[[reader]].[[readRequests]]'s size.
- return stream.reader()->read_requests().size();
- }
- // https://streams.spec.whatwg.org/#readable-stream-has-default-reader
- bool readable_stream_has_default_reader(ReadableStream& stream)
- {
- // 1. Let reader be stream.[[reader]].
- auto reader = stream.reader();
- // 2. If reader is undefined, return false.
- if (!reader)
- return false;
- // 3. If reader implements ReadableStreamDefaultReader, return true.
- if (reader->is_default_reader())
- return true;
- // 4. Return false.
- return false;
- }
- // https://streams.spec.whatwg.org/#readable-stream-close
- void readable_stream_close(ReadableStream& stream)
- {
- auto& realm = stream.realm();
- // 1. Assert: stream.[[state]] is "readable".
- VERIFY(stream.state() == ReadableStream::State::Readable);
- // 2. Set stream.[[state]] to "closed".
- stream.set_state(ReadableStream::State::Closed);
- // 3. Let reader be stream.[[reader]].
- auto reader = stream.reader();
- // 4. If reader is undefined, return.
- if (!reader)
- return;
- // 5. Resolve reader.[[closedPromise]] with undefined.
- WebIDL::resolve_promise(realm, *reader->closed_promise_capability());
- // 6. If reader implements ReadableStreamDefaultReader,
- if (reader->is_default_reader()) {
- // 1. Let readRequests be reader.[[readRequests]].
- // 2. Set reader.[[readRequests]] to an empty list.
- auto read_requests = move(reader->read_requests());
- // 3. For each readRequest of readRequests,
- for (auto& read_request : read_requests) {
- // 1. Perform readRequest’s close steps.
- read_request->on_close();
- }
- }
- }
- // https://streams.spec.whatwg.org/#readable-stream-error
- void readable_stream_error(ReadableStream& stream, JS::Value error)
- {
- auto& realm = stream.realm();
- // 1. Assert: stream.[[state]] is "readable".
- VERIFY(stream.state() == ReadableStream::State::Readable);
- // 2. Set stream.[[state]] to "errored".
- stream.set_state(ReadableStream::State::Errored);
- // 3. Set stream.[[storedError]] to e.
- stream.set_stored_error(error);
- // 4. Let reader be stream.[[reader]].
- auto reader = stream.reader();
- // 5. If reader is undefined, return.
- if (!reader)
- return;
- // 6. Reject reader.[[closedPromise]] with e.
- WebIDL::reject_promise(realm, *reader->closed_promise_capability(), error);
- // 7. Set reader.[[closedPromise]].[[PromiseIsHandled]] to true.
- WebIDL::mark_promise_as_handled(*reader->closed_promise_capability());
- // 8. If reader implements ReadableStreamDefaultReader,
- if (reader->is_default_reader()) {
- // 1. Perform ! ReadableStreamDefaultReaderErrorReadRequests(reader, e).
- readable_stream_default_reader_error_read_requests(*reader, error);
- }
- // 9. Otherwise,
- else {
- // 1. Assert: reader implements ReadableStreamBYOBReader.
- // 2. Perform ! ReadableStreamBYOBReaderErrorReadIntoRequests(reader, e).
- // FIXME: Handle BYOBReader
- TODO();
- }
- }
- // https://streams.spec.whatwg.org/#readable-stream-add-read-request
- void readable_stream_add_read_request(ReadableStream& stream, ReadRequest const& read_request)
- {
- // FIXME: Check implementation type
- // 1. Assert: stream.[[reader]] implements ReadableStreamDefaultReader.
- VERIFY(stream.reader());
- // 2. Assert: stream.[[state]] is "readable".
- VERIFY(stream.state() == ReadableStream::State::Readable);
- // 3. Append readRequest to stream.[[reader]].[[readRequests]].
- stream.reader()->read_requests().append(read_request);
- }
- // https://streams.spec.whatwg.org/#readable-stream-reader-generic-cancel
- WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> readable_stream_reader_generic_cancel(ReadableStreamGenericReaderMixin& reader, JS::Value reason)
- {
- // 1. Let stream be reader.[[stream]]
- auto stream = reader.stream();
- // 2. Assert: stream is not undefined
- VERIFY(stream);
- // 3. Return ! ReadableStreamCancel(stream, reason)
- return TRY(readable_stream_cancel(*stream, reason));
- }
- // https://streams.spec.whatwg.org/#readable-stream-reader-generic-initialize
- void readable_stream_reader_generic_initialize(ReadableStreamGenericReaderMixin& reader, ReadableStream& stream)
- {
- auto& realm = stream.realm();
- // 1. Set reader.[[stream]] to stream.
- reader.set_stream(stream);
- // 2. Set stream.[[reader]] to reader.
- if (reader.is_default_reader()) {
- stream.set_reader(static_cast<ReadableStreamDefaultReader&>(reader));
- } else {
- // FIXME: Handle other descendents of ReadableStreamGenericReaderMixin (i.e. BYOBReader)
- TODO();
- }
- // 3. If stream.[[state]] is "readable",
- if (stream.state() == ReadableStream::State::Readable) {
- // 1. Set reader.[[closedPromise]] to a new promise.
- reader.set_closed_promise_capability(WebIDL::create_promise(realm));
- }
- // 4. Otherwise, if stream.[[state]] is "closed",
- else if (stream.state() == ReadableStream::State::Closed) {
- // 1. Set reader.[[closedPromise]] to a promise resolved with undefined.
- reader.set_closed_promise_capability(WebIDL::create_resolved_promise(realm, JS::js_undefined()));
- }
- // 5. Otherwise,
- else {
- // 1. Assert: stream.[[state]] is "errored".
- VERIFY(stream.state() == ReadableStream::State::Errored);
- // 2. Set reader.[[closedPromise]] to a promise rejected with stream.[[storedError]].
- reader.set_closed_promise_capability(WebIDL::create_rejected_promise(realm, stream.stored_error()));
- // 3. Set reader.[[closedPromise]].[[PromiseIsHandled]] to true.
- WebIDL::mark_promise_as_handled(*reader.closed_promise_capability());
- }
- }
- // https://streams.spec.whatwg.org/#readable-stream-reader-generic-release
- WebIDL::ExceptionOr<void> readable_stream_reader_generic_release(ReadableStreamGenericReaderMixin& reader)
- {
- // 1. Let stream be reader.[[stream]].
- auto stream = reader.stream();
- // 2. Assert: stream is not undefined.
- VERIFY(stream);
- // 3. Assert: stream.[[reader]] is reader.
- VERIFY(stream->reader().ptr() == &reader);
- auto& realm = stream->realm();
- // 4. If stream.[[state]] is "readable", reject reader.[[closedPromise]] with a TypeError exception.
- auto exception = MUST_OR_THROW_OOM(JS::TypeError::create(realm, "Released readable stream"sv));
- if (stream->is_readable()) {
- WebIDL::reject_promise(realm, *reader.closed_promise_capability(), exception);
- }
- // 5. Otherwise, set reader.[[closedPromise]] to a promise rejected with a TypeError exception.
- else {
- reader.set_closed_promise_capability(WebIDL::create_rejected_promise(realm, exception));
- }
- // 6. Set reader.[[closedPromise]].[[PromiseIsHandled]] to true.
- WebIDL::mark_promise_as_handled(*reader.closed_promise_capability());
- // 7. Perform ! stream.[[controller]].[[ReleaseSteps]]().
- TRY(stream->controller()->visit([](auto const& controller) { return controller->release_steps(); }));
- // 8. Set stream.[[reader]] to undefined.
- stream->set_reader({});
- // 9. Set reader.[[stream]] to undefined.
- reader.set_stream({});
- return {};
- }
- // https://streams.spec.whatwg.org/#abstract-opdef-readablestreamdefaultreadererrorreadrequests
- void readable_stream_default_reader_error_read_requests(ReadableStreamDefaultReader& reader, JS::Value error)
- {
- // 1. Let readRequests be reader.[[readRequests]].
- // 2. Set reader.[[readRequests]] to a new empty list.
- auto read_requests = move(reader.read_requests());
- // 3. For each readRequest of readRequests,
- for (auto& read_request : read_requests) {
- // 1. Perform readRequest’s error steps, given e.
- read_request->on_error(error);
- }
- }
- // https://streams.spec.whatwg.org/#readable-stream-default-reader-read
- WebIDL::ExceptionOr<void> readable_stream_default_reader_read(ReadableStreamDefaultReader& reader, ReadRequest& read_request)
- {
- // 1. Let stream be reader.[[stream]].
- auto stream = reader.stream();
- // 2. Assert: stream is not undefined.
- VERIFY(stream);
- // 3. Set stream.[[disturbed]] to true.
- stream->set_disturbed(true);
- // 4. If stream.[[state]] is "closed", perform readRequest’s close steps.
- if (stream->is_closed()) {
- read_request.on_close();
- }
- // 5. Otherwise, if stream.[[state]] is "errored", perform readRequest’s error steps given stream.[[storedError]].
- else if (stream->is_errored()) {
- read_request.on_error(stream->stored_error());
- }
- // 6. Otherwise,
- else {
- // 1. Assert: stream.[[state]] is "readable".
- VERIFY(stream->is_readable());
- // 2. Perform ! stream.[[controller]].[[PullSteps]](readRequest).
- TRY(stream->controller()->visit([&](auto const& controller) {
- return controller->pull_steps(read_request);
- }));
- }
- return {};
- }
- // https://streams.spec.whatwg.org/#abstract-opdef-readablestreamdefaultreaderrelease
- WebIDL::ExceptionOr<void> readable_stream_default_reader_release(ReadableStreamDefaultReader& reader)
- {
- auto& realm = reader.realm();
- // 1. Perform ! ReadableStreamReaderGenericRelease(reader).
- TRY(readable_stream_reader_generic_release(reader));
- // 2. Let e be a new TypeError exception.
- auto exception = MUST_OR_THROW_OOM(JS::TypeError::create(realm, "Reader has been released"sv));
- // 3. Perform ! ReadableStreamDefaultReaderErrorReadRequests(reader, e).
- readable_stream_default_reader_error_read_requests(reader, exception);
- return {};
- }
- // https://streams.spec.whatwg.org/#set-up-readable-stream-default-reader
- WebIDL::ExceptionOr<void> set_up_readable_stream_default_reader(ReadableStreamDefaultReader& reader, ReadableStream& stream)
- {
- // 1. If ! IsReadableStreamLocked(stream) is true, throw a TypeError exception.
- if (is_readable_stream_locked(stream))
- return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, "Cannot create stream reader for a locked stream"sv };
- // 2. Perform ! ReadableStreamReaderGenericInitialize(reader, stream).
- // 3. Set reader.[[readRequests]] to a new empty list.
- readable_stream_reader_generic_initialize(reader, stream);
- return {};
- }
- // https://streams.spec.whatwg.org/#readable-stream-default-controller-close
- void readable_stream_default_controller_close(ReadableStreamDefaultController& controller)
- {
- // 1. If ! ReadableStreamDefaultControllerCanCloseOrEnqueue(controller) is false, return.
- if (!readable_stream_default_controller_can_close_or_enqueue(controller))
- return;
- // 2. Let stream be controller.[[stream]].
- auto stream = controller.stream();
- // 3. Set controller.[[closeRequested]] to true.
- controller.set_close_requested(true);
- // 4. If controller.[[queue]] is empty,
- if (controller.queue().is_empty()) {
- // 1. Perform ! ReadableStreamDefaultControllerClearAlgorithms(controller).
- readable_stream_default_controller_clear_algorithms(controller);
- // 2. Perform ! ReadableStreamClose(stream).
- readable_stream_close(*stream);
- }
- }
- // https://streams.spec.whatwg.org/#readable-stream-default-controller-enqueue
- WebIDL::ExceptionOr<void> readable_stream_default_controller_enqueue(ReadableStreamDefaultController& controller, JS::Value chunk)
- {
- auto& vm = controller.vm();
- // 1. If ! ReadableStreamDefaultControllerCanCloseOrEnqueue(controller) is false, return.
- if (!readable_stream_default_controller_can_close_or_enqueue(controller))
- return {};
- // 2. Let stream be controller.[[stream]].
- auto stream = controller.stream();
- // 3. If ! IsReadableStreamLocked(stream) is true and ! ReadableStreamGetNumReadRequests(stream) > 0, perform ! ReadableStreamFulfillReadRequest(stream, chunk, false).
- if (is_readable_stream_locked(*stream) && readable_stream_get_num_read_requests(*stream) > 0) {
- readable_stream_fulfill_read_request(*stream, chunk, false);
- }
- // 4. Otherwise,
- else {
- // 1. Let result be the result of performing controller.[[strategySizeAlgorithm]], passing in chunk, and interpreting the result as a completion record.
- auto result = (*controller.strategy_size_algorithm())(chunk);
- // 2. If result is an abrupt completion,
- if (result.is_abrupt()) {
- // 1. Perform ! ReadableStreamDefaultControllerError(controller, result.[[Value]]).
- readable_stream_default_controller_error(controller, result.value().value());
- // 2. Return result.
- return result;
- }
- // 3. Let chunkSize be result.[[Value]].
- auto chunk_size = result.release_value().release_value();
- // 4. Let enqueueResult be EnqueueValueWithSize(controller, chunk, chunkSize).
- auto enqueue_result = enqueue_value_with_size(controller, chunk, chunk_size);
- // 5. If enqueueResult is an abrupt completion,
- if (enqueue_result.is_error()) {
- auto throw_completion = Bindings::throw_dom_exception_if_needed(vm, [&] { return enqueue_result; }).throw_completion();
- // 1. Perform ! ReadableStreamDefaultControllerError(controller, enqueueResult.[[Value]]).
- readable_stream_default_controller_error(controller, throw_completion.value().value());
- // 2. Return enqueueResult.
- return enqueue_result;
- }
- }
- // 5. Perform ! ReadableStreamDefaultControllerCallPullIfNeeded(controller).
- return readable_stream_default_controller_can_pull_if_needed(controller);
- }
- // https://streams.spec.whatwg.org/#readable-stream-default-controller-call-pull-if-needed
- WebIDL::ExceptionOr<void> readable_stream_default_controller_can_pull_if_needed(ReadableStreamDefaultController& controller)
- {
- // 1. Let shouldPull be ! ReadableStreamDefaultControllerShouldCallPull(controller).
- auto should_pull = readable_stream_default_controller_should_call_pull(controller);
- // 2. If shouldPull is false, return.
- if (!should_pull)
- return {};
- // 3. If controller.[[pulling]] is true,
- if (controller.pulling()) {
- // 1. Set controller.[[pullAgain]] to true.
- controller.set_pull_again(true);
- // 2. Return.
- return {};
- }
- // 4. Assert: controller.[[pullAgain]] is false.
- VERIFY(!controller.pull_again());
- // 5. Set controller.[[pulling]] to true.
- controller.set_pulling(true);
- // 6. Let pullPromise be the result of performing controller.[[pullAlgorithm]].
- auto pull_promise = TRY((*controller.pull_algorithm())());
- // 7. Upon fulfillment of pullPromise,
- WebIDL::upon_fulfillment(*pull_promise, [&](auto const&) -> WebIDL::ExceptionOr<JS::Value> {
- // 1. Set controller.[[pulling]] to false.
- controller.set_pulling(false);
- // 2. If controller.[[pullAgain]] is true,
- if (controller.pull_again()) {
- // 1. Set controller.[[pullAgain]] to false.
- controller.set_pull_again(false);
- // 2. Perform ! ReadableStreamDefaultControllerCallPullIfNeeded(controller).
- TRY(readable_stream_default_controller_can_pull_if_needed(controller));
- }
- return JS::js_undefined();
- });
- // 8. Upon rejection of pullPromise with reason e,
- WebIDL::upon_rejection(*pull_promise, [&](auto const& e) -> WebIDL::ExceptionOr<JS::Value> {
- // 1. Perform ! ReadableStreamDefaultControllerError(controller, e).
- readable_stream_default_controller_error(controller, e);
- return JS::js_undefined();
- });
- return {};
- }
- // https://streams.spec.whatwg.org/#readable-stream-default-controller-should-call-pull
- bool readable_stream_default_controller_should_call_pull(ReadableStreamDefaultController& controller)
- {
- // 1. Let stream be controller.[[stream]].
- auto stream = controller.stream();
- // 2. If ! ReadableStreamDefaultControllerCanCloseOrEnqueue(controller) is false, return false.
- if (!readable_stream_default_controller_can_close_or_enqueue(controller))
- return false;
- // 3. If controller.[[started]] is false, return false.
- if (!controller.started())
- return false;
- // 4. If ! IsReadableStreamLocked(stream) is true and ! ReadableStreamGetNumReadRequests(stream) > 0, return true.
- if (is_readable_stream_locked(*stream) && readable_stream_get_num_read_requests(*stream) > 0)
- return true;
- // 5. Let desiredSize be ! ReadableStreamDefaultControllerGetDesiredSize(controller).
- auto desired_size = readable_stream_default_controller_get_desired_size(controller);
- // 6. Assert: desiredSize is not null.
- VERIFY(desired_size.has_value());
- // 7. If desiredSize > 0, return true.
- if (desired_size.release_value() > 0)
- return true;
- // 8. Return false.
- return false;
- }
- // https://streams.spec.whatwg.org/#readable-stream-default-controller-clear-algorithms
- void readable_stream_default_controller_clear_algorithms(ReadableStreamDefaultController& controller)
- {
- // 1. Set controller.[[pullAlgorithm]] to undefined.
- controller.set_pull_algorithm({});
- // 2. Set controller.[[cancelAlgorithm]] to undefined.
- controller.set_cancel_algorithm({});
- // 3. Set controller.[[strategySizeAlgorithm]] to undefined.
- controller.set_strategy_size_algorithm({});
- }
- // https://streams.spec.whatwg.org/#readable-stream-default-controller-error
- void readable_stream_default_controller_error(ReadableStreamDefaultController& controller, JS::Value error)
- {
- // 1. Let stream be controller.[[stream]].
- auto stream = controller.stream();
- // 2. If stream.[[state]] is not "readable", return.
- if (!stream->is_readable())
- return;
- // 3. Perform ! ResetQueue(controller).
- reset_queue(controller);
- // 4. Perform ! ReadableStreamDefaultControllerClearAlgorithms(controller).
- readable_stream_default_controller_clear_algorithms(controller);
- // 5. Perform ! ReadableStreamError(stream, e).
- readable_stream_error(*stream, error);
- }
- // https://streams.spec.whatwg.org/#readable-stream-default-controller-get-desired-size
- Optional<float> readable_stream_default_controller_get_desired_size(ReadableStreamDefaultController& controller)
- {
- auto stream = controller.stream();
- // 1. Let state be controller.[[stream]].[[state]].
- // 2. If state is "errored", return null.
- if (stream->is_errored())
- return {};
- // 3. If state is "closed", return 0.
- if (stream->is_closed())
- return 0.0f;
- // 4. Return controller.[[strategyHWM]] − controller.[[queueTotalSize]].
- return controller.strategy_hwm() - controller.queue_total_size();
- }
- // https://streams.spec.whatwg.org/#readable-stream-default-controller-can-close-or-enqueue
- bool readable_stream_default_controller_can_close_or_enqueue(ReadableStreamDefaultController& controller)
- {
- // 1. Let state be controller.[[stream]].[[state]].
- // 2. If controller.[[closeRequested]] is false and state is "readable", return true.
- // 3. Otherwise, return false.
- return !controller.close_requested() && controller.stream()->is_readable();
- }
- // https://streams.spec.whatwg.org/#set-up-readable-stream-default-controller
- 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)
- {
- auto& realm = stream.realm();
- // 1. Assert: stream.[[controller]] is undefined.
- VERIFY(!stream.controller().has_value());
- // 2. Set controller.[[stream]] to stream.
- controller.set_stream(stream);
- // 3. Perform ! ResetQueue(controller).
- reset_queue(controller);
- // 4. Set controller.[[started]], controller.[[closeRequested]], controller.[[pullAgain]], and controller.[[pulling]] to false.
- controller.set_started(false);
- controller.set_close_requested(false);
- controller.set_pull_again(false);
- controller.set_pulling(false);
- // 5. Set controller.[[strategySizeAlgorithm]] to sizeAlgorithm and controller.[[strategyHWM]] to highWaterMark.
- controller.set_strategy_size_algorithm(move(size_algorithm));
- controller.set_strategy_hwm(high_water_mark);
- // 6. Set controller.[[pullAlgorithm]] to pullAlgorithm.
- controller.set_pull_algorithm(move(pull_algorithm));
- // 7. Set controller.[[cancelAlgorithm]] to cancelAlgorithm.
- controller.set_cancel_algorithm(move(cancel_algorithm));
- // 8. Set stream.[[controller]] to controller.
- stream.set_controller(ReadableStreamController { controller });
- // 9. Let startResult be the result of performing startAlgorithm. (This might throw an exception.)
- auto start_result = TRY(start_algorithm());
- // 10. Let startPromise be a promise resolved with startResult.
- auto start_promise = WebIDL::create_resolved_promise(realm, start_result ? start_result->promise() : JS::js_undefined());
- // 11. Upon fulfillment of startPromise,
- WebIDL::upon_fulfillment(start_promise, [&](auto const&) -> WebIDL::ExceptionOr<JS::Value> {
- // 1. Set controller.[[started]] to true.
- controller.set_started(true);
- // 2. Assert: controller.[[pulling]] is false.
- VERIFY(!controller.pulling());
- // 3. Assert: controller.[[pullAgain]] is false.
- VERIFY(!controller.pull_again());
- // 4. Perform ! ReadableStreamDefaultControllerCallPullIfNeeded(controller).
- TRY(readable_stream_default_controller_can_pull_if_needed(controller));
- return JS::js_undefined();
- });
- // 12. Upon rejection of startPromise with reason r,
- WebIDL::upon_rejection(start_promise, [&](auto const& r) -> WebIDL::ExceptionOr<JS::Value> {
- // 1. Perform ! ReadableStreamDefaultControllerError(controller, r).
- readable_stream_default_controller_error(controller, r);
- return JS::js_undefined();
- });
- return {};
- }
- // https://streams.spec.whatwg.org/#set-up-readable-stream-default-controller-from-underlying-source
- 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)
- {
- auto& realm = stream.realm();
- // 1. Let controller be a new ReadableStreamDefaultController.
- auto controller = MUST_OR_THROW_OOM(stream.heap().allocate<ReadableStreamDefaultController>(realm, realm));
- // 2. Let startAlgorithm be an algorithm that returns undefined.
- StartAlgorithm start_algorithm = [] { return JS::GCPtr<WebIDL::Promise> {}; };
- // 3. Let pullAlgorithm be an algorithm that returns a promise resolved with undefined.
- PullAlgorithm pull_algorithm = [&realm]() {
- return WebIDL::create_resolved_promise(realm, JS::js_undefined());
- };
- // 4. Let cancelAlgorithm be an algorithm that returns a promise resolved with undefined.
- CancelAlgorithm cancel_algorithm = [&realm](auto const&) {
- return WebIDL::create_resolved_promise(realm, JS::js_undefined());
- };
- // 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.
- if (underlying_source.start) {
- start_algorithm = [&, start = underlying_source.start]() -> WebIDL::ExceptionOr<JS::GCPtr<WebIDL::Promise>> {
- // FIXME: This needs to create a rejected Promise for throw completions, which invoke_callback() currently doesn't do.
- auto result = TRY(WebIDL::invoke_callback(*start, underlying_source_value, controller)).release_value();
- return WebIDL::create_resolved_promise(realm, result);
- };
- }
- // 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.
- if (underlying_source.pull) {
- pull_algorithm = [&, pull = underlying_source.pull]() -> WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> {
- // FIXME: This needs to create a rejected Promise for throw completions, which invoke_callback() currently doesn't do.
- auto result = TRY(WebIDL::invoke_callback(*pull, underlying_source_value, controller)).release_value();
- return WebIDL::create_resolved_promise(realm, result);
- };
- }
- // 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.
- if (underlying_source.cancel) {
- cancel_algorithm = [&, cancel = underlying_source.cancel](auto const& reason) -> WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> {
- // FIXME: This needs to create a rejected Promise for throw completions, which invoke_callback() currently doesn't do.
- auto result = TRY(WebIDL::invoke_callback(*cancel, underlying_source_value, reason)).release_value();
- return WebIDL::create_resolved_promise(realm, result);
- };
- }
- // 8. Perform ? SetUpReadableStreamDefaultController(stream, controller, startAlgorithm, pullAlgorithm, cancelAlgorithm, highWaterMark, sizeAlgorithm).
- return set_up_readable_stream_default_controller(stream, controller, move(start_algorithm), move(pull_algorithm), move(cancel_algorithm), high_water_mark, move(size_algorithm));
- }
- // https://streams.spec.whatwg.org/#readable-byte-stream-controller-clear-algorithms
- void readable_byte_stream_controller_clear_algorithms(ReadableByteStreamController& controller)
- {
- // 1. Set controller.[[pullAlgorithm]] to undefined.
- controller.set_pull_algorithm({});
- // 2. Set controller.[[cancelAlgorithm]] to undefined.
- controller.set_cancel_algorithm({});
- }
- // https://streams.spec.whatwg.org/#readable-byte-stream-controller-clear-pending-pull-intos
- void readable_byte_stream_controller_clear_pending_pull_intos(ReadableByteStreamController& controller)
- {
- // 1. Perform ! ReadableByteStreamControllerInvalidateBYOBRequest(controller).
- readable_byte_stream_controller_invalidate_byob_request(controller);
- // 2. Set controller.[[pendingPullIntos]] to a new empty list.
- controller.pending_pull_intos().clear();
- }
- // https://streams.spec.whatwg.org/#abstract-opdef-readablebytestreamcontrollerfillreadrequestfromqueue
- WebIDL::ExceptionOr<void> readable_byte_stream_controller_fill_read_request_from_queue(ReadableByteStreamController& controller, NonnullRefPtr<ReadRequest> read_request)
- {
- auto& vm = controller.vm();
- auto& realm = controller.realm();
- // 1. Assert: controller.[[queueTotalSize]] > 0.
- VERIFY(controller.queue_total_size() > 0);
- // 2. Let entry be controller.[[queue]][0].
- // 3. Remove entry from controller.[[queue]].
- auto entry = controller.queue().take_first();
- // 4. Set controller.[[queueTotalSize]] to controller.[[queueTotalSize]] − entry’s byte length.
- controller.set_queue_total_size(controller.queue_total_size() - entry.byte_length);
- // 5. Perform ! ReadableByteStreamControllerHandleQueueDrain(controller).
- readable_byte_stream_controller_handle_queue_drain(controller);
- // 6. Let view be ! Construct(%Uint8Array%, « entry’s buffer, entry’s byte offset, entry’s byte length »).
- 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)));
- // 7. Perform readRequest’s chunk steps, given view.
- read_request->on_chunk(view);
- return {};
- }
- // https://streams.spec.whatwg.org/#readable-byte-stream-controller-get-desired-size
- Optional<double> readable_byte_stream_controller_get_desired_size(ReadableByteStreamController const& controller)
- {
- auto stream = controller.stream();
- // 1. Let state be controller.[[stream]].[[state]].
- // 2. If state is "errored", return null.
- if (stream->is_errored())
- return {};
- // 3. If state is "closed", return 0.
- if (stream->is_closed())
- return 0.0;
- // 4. Return controller.[[strategyHWM]] − controller.[[queueTotalSize]].
- return controller.strategy_hwm() - controller.queue_total_size();
- }
- // https://streams.spec.whatwg.org/#readable-byte-stream-controller-handle-queue-drain
- void readable_byte_stream_controller_handle_queue_drain(ReadableByteStreamController& controller)
- {
- // 1. Assert: controller.[[stream]].[[state]] is "readable".
- VERIFY(controller.stream()->state() == ReadableStream::State::Readable);
- // 2. If controller.[[queueTotalSize]] is 0 and controller.[[closeRequested]] is true,
- if (controller.queue_total_size() == 0 && controller.close_requested()) {
- // 1. Perform ! ReadableByteStreamControllerClearAlgorithms(controller).
- readable_byte_stream_controller_clear_algorithms(controller);
- // 2. Perform ! ReadableStreamClose(controller.[[stream]]).
- readable_stream_close(*controller.stream());
- }
- // 3. Otherwise,
- else {
- // FIXME: 1. Perform ! ReadableByteStreamControllerCallPullIfNeeded(controller).
- }
- }
- // https://streams.spec.whatwg.org/#readable-byte-stream-controller-invalidate-byob-request
- void readable_byte_stream_controller_invalidate_byob_request(ReadableByteStreamController& controller)
- {
- // 1. If controller.[[byobRequest]] is null, return.
- if (!controller.byob_request())
- return;
- // 2. Set controller.[[byobRequest]].[[controller]] to undefined.
- controller.byob_request()->set_controller({});
- // 3. Set controller.[[byobRequest]].[[view]] to null.
- controller.byob_request()->set_view({});
- // 4. Set controller.[[byobRequest]] to null.
- controller.set_byob_request({});
- }
- // https://streams.spec.whatwg.org/#acquire-writable-stream-default-writer
- WebIDL::ExceptionOr<JS::NonnullGCPtr<WritableStreamDefaultWriter>> acquire_writable_stream_default_writer(WritableStream& stream)
- {
- auto& realm = stream.realm();
- // 1. Let writer be a new WritableStreamDefaultWriter.
- auto writer = MUST_OR_THROW_OOM(stream.heap().allocate<WritableStreamDefaultWriter>(realm, realm));
- // 2. Perform ? SetUpWritableStreamDefaultWriter(writer, stream).
- TRY(set_up_writable_stream_default_writer(*writer, stream));
- // 3. Return writer.
- return writer;
- }
- // https://streams.spec.whatwg.org/#is-writable-stream-locked
- bool is_writable_stream_locked(WritableStream const& stream)
- {
- // 1. If stream.[[writer]] is undefined, return false.
- if (!stream.writer())
- return false;
- // 2. Return true.
- return true;
- }
- // https://streams.spec.whatwg.org/#set-up-writable-stream-default-writer
- WebIDL::ExceptionOr<void> set_up_writable_stream_default_writer(WritableStreamDefaultWriter& writer, WritableStream& stream)
- {
- auto& realm = writer.realm();
- // 1. If ! IsWritableStreamLocked(stream) is true, throw a TypeError exception.
- if (is_writable_stream_locked(stream))
- return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, "Stream is locked"sv };
- // 2. Set writer.[[stream]] to stream.
- writer.set_stream(stream);
- // 3. Set stream.[[writer]] to writer.
- stream.set_writer(writer);
- // 4. Let state be stream.[[state]].
- auto state = stream.state();
- // 5. If state is "writable",
- if (state == WritableStream::State::Writable) {
- // 1. If ! WritableStreamCloseQueuedOrInFlight(stream) is false and stream.[[backpressure]] is true, set writer.[[readyPromise]] to a new promise.
- if (!writable_stream_close_queued_or_in_flight(stream) && stream.backpressure()) {
- writer.set_ready_promise(WebIDL::create_promise(realm));
- }
- // 2. Otherwise, set writer.[[readyPromise]] to a promise resolved with undefined.
- else {
- writer.set_ready_promise(WebIDL::create_resolved_promise(realm, JS::js_undefined()));
- }
- // 3. Set writer.[[closedPromise]] to a new promise.
- writer.set_closed_promise(WebIDL::create_promise(realm));
- }
- // 6. Otherwise, if state is "erroring",
- else if (state == WritableStream::State::Erroring) {
- // 1. Set writer.[[readyPromise]] to a promise rejected with stream.[[storedError]].
- writer.set_ready_promise(WebIDL::create_rejected_promise(realm, stream.stored_error()));
- // 2. Set writer.[[readyPromise]].[[PromiseIsHandled]] to true.
- WebIDL::mark_promise_as_handled(*writer.ready_promise());
- // 3. Set writer.[[closedPromise]] to a new promise.
- writer.set_closed_promise(WebIDL::create_promise(realm));
- }
- // 7. Otherwise, if state is "closed",
- else if (state == WritableStream::State::Closed) {
- // 1. Set writer.[[readyPromise]] to a promise resolved with undefined.
- writer.set_ready_promise(WebIDL::create_resolved_promise(realm, JS::js_undefined()));
- // 2. Set writer.[[closedPromise]] to a promise resolved with undefined.
- writer.set_closed_promise(WebIDL::create_resolved_promise(realm, JS::js_undefined()));
- }
- // 8. Otherwise,
- else {
- // 1. Assert: state is "errored".
- VERIFY(state == WritableStream::State::Errored);
- // 2. Let storedError be stream.[[storedError]].
- auto stored_error = stream.stored_error();
- // 3. Set writer.[[readyPromise]] to a promise rejected with storedError.
- writer.set_ready_promise(WebIDL::create_rejected_promise(realm, stored_error));
- // 4. Set writer.[[readyPromise]].[[PromiseIsHandled]] to true.
- WebIDL::mark_promise_as_handled(*writer.ready_promise());
- // 5. Set writer.[[closedPromise]] to a promise rejected with storedError.
- writer.set_closed_promise(WebIDL::create_rejected_promise(realm, stored_error));
- // 6. Set writer.[[closedPromise]].[[PromiseIsHandled]] to true.
- WebIDL::mark_promise_as_handled(*writer.closed_promise());
- }
- return {};
- }
- // https://streams.spec.whatwg.org/#writable-stream-abort
- WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> writable_stream_abort(WritableStream& stream, JS::Value reason)
- {
- auto& realm = stream.realm();
- // 1. If stream.[[state]] is "closed" or "errored", return a promise resolved with undefined.
- auto state = stream.state();
- if (state == WritableStream::State::Closed || state == WritableStream::State::Errored)
- return WebIDL::create_resolved_promise(realm, JS::js_undefined());
- // 2. Signal abort on stream.[[controller]].[[signal]] with reason.
- stream.controller()->signal()->signal_abort(reason);
- // 3. Let state be stream.[[state]].
- state = stream.state();
- // 4. If state is "closed" or "errored", return a promise resolved with undefined.
- if (state == WritableStream::State::Closed || state == WritableStream::State::Errored)
- return WebIDL::create_resolved_promise(realm, JS::js_undefined());
- // 5. If stream.[[pendingAbortRequest]] is not undefined, return stream.[[pendingAbortRequest]]'s promise.
- if (stream.pending_abort_request().has_value())
- return stream.pending_abort_request()->promise;
- // 6. Assert: state is "writable" or "erroring".
- VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
- // 7. Let wasAlreadyErroring be false.
- auto was_already_erroring = false;
- // 8. If state is "erroring",
- if (state == WritableStream::State::Erroring) {
- // 1. Set wasAlreadyErroring to true.
- was_already_erroring = true;
- // 2. Set reason to undefined.
- reason = JS::js_undefined();
- }
- // 9. Let promise be a new promise.
- auto promise = WebIDL::create_promise(realm);
- // 10. Set stream.[[pendingAbortRequest]] to a new pending abort request whose promise is promise, reason is reason, and was already erroring is wasAlreadyErroring.
- stream.set_pending_abort_request(PendingAbortRequest { promise, reason, was_already_erroring });
- // 11. If wasAlreadyErroring is false, perform ! WritableStreamStartErroring(stream, reason).
- if (!was_already_erroring)
- TRY(writable_stream_start_erroring(stream, reason));
- // 12. Return promise.
- return promise;
- }
- // https://streams.spec.whatwg.org/#writable-stream-close
- WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> writable_stream_close(WritableStream& stream)
- {
- auto& realm = stream.realm();
- // 1. Let state be stream.[[state]].
- auto state = stream.state();
- // 2. If state is "closed" or "errored", return a promise rejected with a TypeError exception.
- if (state == WritableStream::State::Closed || state == WritableStream::State::Errored) {
- auto message = state == WritableStream::State::Closed ? "Cannot close a closed stream"sv : "Cannot close an errored stream"sv;
- auto exception = MUST_OR_THROW_OOM(JS::TypeError::create(realm, message));
- return WebIDL::create_rejected_promise(realm, exception);
- }
- // 3. Assert: state is "writable" or "erroring".
- VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
- // 4. Assert: ! WritableStreamCloseQueuedOrInFlight(stream) is false.
- VERIFY(!writable_stream_close_queued_or_in_flight(stream));
- // 5. Let promise be a new promise.
- auto promise = WebIDL::create_promise(realm);
- // 6. Set stream.[[closeRequest]] to promise.
- stream.set_close_request(promise);
- // 7. Let writer be stream.[[writer]].
- auto writer = stream.writer();
- // 8. If writer is not undefined, and stream.[[backpressure]] is true, and state is "writable", resolve writer.[[readyPromise]] with undefined.
- if (writer && stream.backpressure() && state == WritableStream::State::Writable)
- WebIDL::resolve_promise(realm, *writer->ready_promise(), JS::js_undefined());
- // 9. Perform ! WritableStreamDefaultControllerClose(stream.[[controller]]).
- TRY(writable_stream_default_controller_close(*stream.controller()));
- // 10. Return promise.
- return promise;
- }
- // https://streams.spec.whatwg.org/#writable-stream-add-write-request
- WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> writable_stream_add_write_request(WritableStream& stream)
- {
- auto& realm = stream.realm();
- auto& vm = stream.vm();
- // 1. Assert: ! IsWritableStreamLocked(stream) is true.
- VERIFY(is_writable_stream_locked(stream));
- // 2. Assert: stream.[[state]] is "writable".
- VERIFY(stream.state() == WritableStream::State::Writable);
- // 3. Let promise be a new promise.
- auto promise = WebIDL::create_promise(realm);
- // 4. Append promise to stream.[[writeRequests]].
- TRY_OR_THROW_OOM(vm, stream.write_requests().try_append(promise));
- // 5. Return promise.
- return promise;
- }
- // https://streams.spec.whatwg.org/#writable-stream-close-queued-or-in-flight
- bool writable_stream_close_queued_or_in_flight(WritableStream const& stream)
- {
- // 1. If stream.[[closeRequest]] is undefined and stream.[[inFlightCloseRequest]] is undefined, return false.
- if (!stream.close_request() && !stream.in_flight_write_request())
- return false;
- // 2. Return true.
- return true;
- }
- // https://streams.spec.whatwg.org/#writable-stream-deal-with-rejection
- WebIDL::ExceptionOr<void> writable_stream_deal_with_rejection(WritableStream& stream, JS::Value error)
- {
- // 1. Let state be stream.[[state]].
- auto state = stream.state();
- // 2. If state is "writable",
- if (state == WritableStream::State::Writable) {
- // 1. Perform ! WritableStreamStartErroring(stream, error).
- // 2. Return.
- return writable_stream_start_erroring(stream, error);
- }
- // 3. Assert: state is "erroring".
- VERIFY(state == WritableStream::State::Erroring);
- // 4. Perform ! WritableStreamFinishErroring(stream).
- return writable_stream_finish_erroring(stream);
- }
- // https://streams.spec.whatwg.org/#writable-stream-finish-erroring
- WebIDL::ExceptionOr<void> writable_stream_finish_erroring(WritableStream& stream)
- {
- auto& realm = stream.realm();
- // 1. Assert: stream.[[state]] is "erroring".
- VERIFY(stream.state() == WritableStream::State::Erroring);
- // 2. Assert: ! WritableStreamHasOperationMarkedInFlight(stream) is false.
- VERIFY(!writable_stream_has_operation_marked_in_flight(stream));
- // 3. Set stream.[[state]] to "errored".
- stream.set_state(WritableStream::State::Errored);
- // 4. Perform ! stream.[[controller]].[[ErrorSteps]]().
- stream.controller()->error_steps();
- // 5. Let storedError be stream.[[storedError]].
- auto stored_error = stream.stored_error();
- // 6. For each writeRequest of stream.[[writeRequests]]:
- for (auto& write_request : stream.write_requests()) {
- // 1. Reject writeRequest with storedError.
- WebIDL::reject_promise(realm, *write_request, stored_error);
- }
- // 7. Set stream.[[writeRequests]] to an empty list.
- stream.write_requests().clear();
- // 8. If stream.[[pendingAbortRequest]] is undefined,
- if (!stream.pending_abort_request().has_value()) {
- // 1. Perform ! WritableStreamRejectCloseAndClosedPromiseIfNeeded(stream).
- writable_stream_reject_close_and_closed_promise_if_needed(stream);
- // 2. Return.
- return {};
- }
- // 9. Let abortRequest be stream.[[pendingAbortRequest]].
- // 10. Set stream.[[pendingAbortRequest]] to undefined.
- auto abort_request = stream.pending_abort_request().release_value();
- // 11. If abortRequest’s was already erroring is true,
- if (abort_request.was_already_erroring) {
- // 1. Reject abortRequest’s promise with storedError.
- WebIDL::reject_promise(realm, abort_request.promise, stored_error);
- // 2. Perform ! WritableStreamRejectCloseAndClosedPromiseIfNeeded(stream).
- writable_stream_reject_close_and_closed_promise_if_needed(stream);
- // 3. Return.
- return {};
- }
- // 12. Let promise be ! stream.[[controller]].[[AbortSteps]](abortRequest’s reason).
- auto promise = TRY(stream.controller()->abort_steps(abort_request.reason));
- // 13. Upon fulfillment of promise,
- WebIDL::upon_fulfillment(*promise, [&, abort_promise = abort_request.promise](auto const&) -> WebIDL::ExceptionOr<JS::Value> {
- // 1. Resolve abortRequest’s promise with undefined.
- WebIDL::resolve_promise(realm, abort_promise, JS::js_undefined());
- // 2. Perform ! WritableStreamRejectCloseAndClosedPromiseIfNeeded(stream).
- writable_stream_reject_close_and_closed_promise_if_needed(stream);
- return JS::js_undefined();
- });
- // 14. Upon rejection of promise with reason reason,
- WebIDL::upon_rejection(*promise, [&, abort_promise = abort_request.promise](auto const& reason) -> WebIDL::ExceptionOr<JS::Value> {
- // 1. Reject abortRequest’s promise with reason.
- WebIDL::reject_promise(realm, abort_promise, reason);
- // 2. Perform ! WritableStreamRejectCloseAndClosedPromiseIfNeeded(stream).
- writable_stream_reject_close_and_closed_promise_if_needed(stream);
- return JS::js_undefined();
- });
- return {};
- }
- // https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-close
- void writable_stream_finish_in_flight_close(WritableStream& stream)
- {
- auto& realm = stream.realm();
- // 1. Assert: stream.[[inFlightCloseRequest]] is not undefined.
- VERIFY(stream.in_flight_close_request());
- // 2. Resolve stream.[[inFlightCloseRequest]] with undefined.
- WebIDL::resolve_promise(realm, *stream.in_flight_close_request(), JS::js_undefined());
- // 3. Set stream.[[inFlightCloseRequest]] to undefined.
- stream.set_in_flight_close_request({});
- // 4. Let state be stream.[[state]].
- auto state = stream.state();
- // 5. Assert: stream.[[state]] is "writable" or "erroring".
- VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
- // 6. If state is "erroring",
- if (state == WritableStream::State::Erroring) {
- // 1. Set stream.[[storedError]] to undefined.
- stream.set_stored_error(JS::js_undefined());
- // 2. If stream.[[pendingAbortRequest]] is not undefined,
- if (stream.pending_abort_request().has_value()) {
- // 1. Resolve stream.[[pendingAbortRequest]]'s promise with undefined.
- // 2. Set stream.[[pendingAbortRequest]] to undefined.
- WebIDL::resolve_promise(realm, stream.pending_abort_request().release_value().promise, JS::js_undefined());
- }
- }
- // 7. Set stream.[[state]] to "closed".
- stream.set_state(WritableStream::State::Closed);
- // 8. Let writer be stream.[[writer]].
- auto writer = stream.writer();
- // 9. If writer is not undefined, resolve writer.[[closedPromise]] with undefined.
- if (writer)
- WebIDL::resolve_promise(realm, *writer->closed_promise(), JS::js_undefined());
- // 10. Assert: stream.[[pendingAbortRequest]] is undefined.
- VERIFY(!stream.pending_abort_request().has_value());
- // 11. Assert: stream.[[storedError]] is undefined.
- VERIFY(stream.stored_error().is_undefined());
- }
- // https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-close-with-error
- WebIDL::ExceptionOr<void> writable_stream_finish_in_flight_close_with_error(WritableStream& stream, JS::Value error)
- {
- auto& realm = stream.realm();
- // 1. Assert: stream.[[inFlightCloseRequest]] is not undefined.
- VERIFY(stream.in_flight_close_request());
- // 2. Reject stream.[[inFlightCloseRequest]] with error.
- WebIDL::reject_promise(realm, *stream.in_flight_close_request(), error);
- // 3. Set stream.[[inFlightCloseRequest]] to undefined.
- stream.set_in_flight_close_request({});
- // 4. Assert: stream.[[state]] is "writable" or "erroring".
- auto state = stream.state();
- VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
- // 5. If stream.[[pendingAbortRequest]] is not undefined,
- if (stream.pending_abort_request().has_value()) {
- // 1. Reject stream.[[pendingAbortRequest]]'s promise with error.
- // 2. Set stream.[[pendingAbortRequest]] to undefined.
- WebIDL::reject_promise(realm, stream.pending_abort_request().release_value().promise, error);
- }
- // 6. Perform ! WritableStreamDealWithRejection(stream, error).
- return writable_stream_deal_with_rejection(stream, error);
- }
- // https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-write
- void writable_stream_finish_in_flight_write(WritableStream& stream)
- {
- auto& realm = stream.realm();
- // 1. Assert: stream.[[inFlightWriteRequest]] is not undefined.
- VERIFY(stream.in_flight_write_request());
- // 2. Resolve stream.[[inFlightWriteRequest]] with undefined.
- WebIDL::resolve_promise(realm, *stream.in_flight_write_request(), JS::js_undefined());
- // 3. Set stream.[[inFlightWriteRequest]] to undefined.
- stream.set_in_flight_write_request({});
- }
- // https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-write-with-error
- WebIDL::ExceptionOr<void> writable_stream_finish_in_flight_write_with_error(WritableStream& stream, JS::Value error)
- {
- auto& realm = stream.realm();
- // 1. Assert: stream.[[inFlightWriteRequest]] is not undefined.
- VERIFY(stream.in_flight_write_request());
- // 2. Reject stream.[[inFlightWriteRequest]] with error.
- WebIDL::reject_promise(realm, *stream.in_flight_write_request(), error);
- // 3. Set stream.[[inFlightWriteRequest]] to undefined.
- stream.set_in_flight_write_request({});
- // 4. Assert: stream.[[state]] is "writable" or "erroring".
- auto state = stream.state();
- VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
- // 5. Perform ! WritableStreamDealWithRejection(stream, error).
- return writable_stream_deal_with_rejection(stream, error);
- }
- // https://streams.spec.whatwg.org/#writable-stream-has-operation-marked-in-flight
- bool writable_stream_has_operation_marked_in_flight(WritableStream const& stream)
- {
- // 1. If stream.[[inFlightWriteRequest]] is undefined and stream.[[inFlightCloseRequest]] is undefined, return false.
- if (!stream.in_flight_write_request() && !stream.in_flight_close_request())
- return false;
- // 2. Return true.
- return true;
- }
- // https://streams.spec.whatwg.org/#writable-stream-mark-close-request-in-flight
- void writable_stream_mark_close_request_in_flight(WritableStream& stream)
- {
- // 1. Assert: stream.[[inFlightCloseRequest]] is undefined.
- VERIFY(!stream.in_flight_close_request());
- // 2. Assert: stream.[[closeRequest]] is not undefined.
- VERIFY(stream.close_request());
- // 3. Set stream.[[inFlightCloseRequest]] to stream.[[closeRequest]].
- stream.set_in_flight_close_request(stream.close_request());
- // 4. Set stream.[[closeRequest]] to undefined.
- stream.set_close_request({});
- }
- // https://streams.spec.whatwg.org/#writable-stream-mark-first-write-request-in-flight
- void writable_stream_mark_first_write_request_in_flight(WritableStream& stream)
- {
- // 1. Assert: stream.[[inFlightWriteRequest]] is undefined.
- VERIFY(!stream.in_flight_write_request());
- // 2. Assert: stream.[[writeRequests]] is not empty.
- VERIFY(!stream.write_requests().is_empty());
- // 3. Let writeRequest be stream.[[writeRequests]][0].
- // 4. Remove writeRequest from stream.[[writeRequests]].
- auto write_request = stream.write_requests().take_first();
- // 5. Set stream.[[inFlightWriteRequest]] to writeRequest.
- stream.set_in_flight_write_request(write_request);
- }
- // https://streams.spec.whatwg.org/#writable-stream-reject-close-and-closed-promise-if-needed
- void writable_stream_reject_close_and_closed_promise_if_needed(WritableStream& stream)
- {
- auto& realm = stream.realm();
- // 1. Assert: stream.[[state]] is "errored".
- VERIFY(stream.state() == WritableStream::State::Errored);
- // 2. If stream.[[closeRequest]] is not undefined,
- if (stream.close_request()) {
- // 1. Assert: stream.[[inFlightCloseRequest]] is undefined.
- VERIFY(!stream.in_flight_close_request());
- // 2. Reject stream.[[closeRequest]] with stream.[[storedError]].
- WebIDL::reject_promise(realm, *stream.close_request(), stream.stored_error());
- // 3. Set stream.[[closeRequest]] to undefined.
- stream.set_close_request({});
- }
- // 3. Let writer be stream.[[writer]].
- auto writer = stream.writer();
- // 4. If writer is not undefined,
- if (writer) {
- // 1. Reject writer.[[closedPromise]] with stream.[[storedError]].
- WebIDL::reject_promise(realm, *writer->closed_promise(), stream.stored_error());
- // 2. Set writer.[[closedPromise]].[[PromiseIsHandled]] to true.
- WebIDL::mark_promise_as_handled(*writer->closed_promise());
- }
- }
- // https://streams.spec.whatwg.org/#writable-stream-start-erroring
- WebIDL::ExceptionOr<void> writable_stream_start_erroring(WritableStream& stream, JS::Value reason)
- {
- // 1. Assert: stream.[[storedError]] is undefined.
- VERIFY(stream.stored_error().is_undefined());
- // 2. Assert: stream.[[state]] is "writable".
- VERIFY(stream.state() == WritableStream::State::Writable);
- // 3. Let controller be stream.[[controller]].
- auto controller = stream.controller();
- // 4. Assert: controller is not undefined.
- VERIFY(controller);
- // 5. Set stream.[[state]] to "erroring".
- stream.set_state(WritableStream::State::Erroring);
- // 6. Set stream.[[storedError]] to reason.
- stream.set_stored_error(reason);
- // 7. Let writer be stream.[[writer]].
- auto writer = stream.writer();
- // 8. If writer is not undefined, perform ! WritableStreamDefaultWriterEnsureReadyPromiseRejected(writer, reason).
- if (writer)
- writable_stream_default_writer_ensure_ready_promise_rejected(*writer, reason);
- // 9. If ! WritableStreamHasOperationMarkedInFlight(stream) is false and controller.[[started]] is true, perform ! WritableStreamFinishErroring(stream).
- if (!writable_stream_has_operation_marked_in_flight(stream) && controller->started())
- TRY(writable_stream_finish_erroring(stream));
- return {};
- }
- // https://streams.spec.whatwg.org/#writable-stream-update-backpressure
- void writable_stream_update_backpressure(WritableStream& stream, bool backpressure)
- {
- auto& realm = stream.realm();
- // 1. Assert: stream.[[state]] is "writable".
- VERIFY(stream.state() == WritableStream::State::Writable);
- // 2. Assert: ! WritableStreamCloseQueuedOrInFlight(stream) is false.
- VERIFY(!writable_stream_close_queued_or_in_flight(stream));
- // 3. Let writer be stream.[[writer]].
- auto writer = stream.writer();
- // 4. If writer is not undefined and backpressure is not stream.[[backpressure]],
- if (writer && backpressure != stream.backpressure()) {
- // 1. If backpressure is true, set writer.[[readyPromise]] to a new promise.
- if (backpressure) {
- writer->set_ready_promise(WebIDL::create_promise(realm));
- }
- // 2. Otherwise,
- else {
- // 1. Assert: backpressure is false.
- // 2. Resolve writer.[[readyPromise]] with undefined.
- WebIDL::resolve_promise(realm, *writer->ready_promise(), JS::js_undefined());
- }
- }
- // 5. Set stream.[[backpressure]] to backpressure.
- stream.set_backpressure(backpressure);
- }
- // https://streams.spec.whatwg.org/#writable-stream-default-writer-abort
- WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> writable_stream_default_writer_abort(WritableStreamDefaultWriter& writer, JS::Value reason)
- {
- // 1. Let stream be writer.[[stream]].
- auto stream = writer.stream();
- // 2. Assert: stream is not undefined.
- VERIFY(stream);
- // 3. Return ! WritableStreamAbort(stream, reason).
- return writable_stream_abort(*stream, reason);
- }
- // https://streams.spec.whatwg.org/#writable-stream-default-writer-close
- WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> writable_stream_default_writer_close(WritableStreamDefaultWriter& writer)
- {
- // 1. Let stream be writer.[[stream]].
- auto stream = writer.stream();
- // 2. Assert: stream is not undefined.
- VERIFY(stream);
- // 3. Return ! WritableStreamClose(stream).
- return writable_stream_close(*stream);
- }
- // https://streams.spec.whatwg.org/#writable-stream-default-writer-ensure-closed-promise-rejected
- void writable_stream_default_writer_ensure_closed_promise_rejected(WritableStreamDefaultWriter& writer, JS::Value error)
- {
- auto& realm = writer.realm();
- // 1. If writer.[[closedPromise]].[[PromiseState]] is "pending", reject writer.[[closedPromise]] with error.
- auto& closed_promise = verify_cast<JS::Promise>(*writer.closed_promise()->promise());
- if (closed_promise.state() == JS::Promise::State::Pending) {
- WebIDL::reject_promise(realm, *writer.closed_promise(), error);
- }
- // 2. Otherwise, set writer.[[closedPromise]] to a promise rejected with error.
- else {
- writer.set_closed_promise(WebIDL::create_rejected_promise(realm, error));
- }
- // 3. Set writer.[[closedPromise]].[[PromiseIsHandled]] to true.
- WebIDL::mark_promise_as_handled(*writer.closed_promise());
- }
- // https://streams.spec.whatwg.org/#writable-stream-default-writer-ensure-ready-promise-rejected
- void writable_stream_default_writer_ensure_ready_promise_rejected(WritableStreamDefaultWriter& writer, JS::Value error)
- {
- auto& realm = writer.realm();
- // 1. If writer.[[readyPromise]].[[PromiseState]] is "pending", reject writer.[[readyPromise]] with error.
- auto& ready_promise = verify_cast<JS::Promise>(*writer.ready_promise()->promise());
- if (ready_promise.state() == JS::Promise::State::Pending) {
- WebIDL::reject_promise(realm, *writer.ready_promise(), error);
- }
- // 2. Otherwise, set writer.[[readyPromise]] to a promise rejected with error.
- else {
- writer.set_ready_promise(WebIDL::create_rejected_promise(realm, error));
- }
- // 3. Set writer.[[readyPromise]].[[PromiseIsHandled]] to true.
- WebIDL::mark_promise_as_handled(*writer.ready_promise());
- }
- // https://streams.spec.whatwg.org/#writable-stream-default-writer-get-desired-size
- Optional<double> writable_stream_default_writer_get_desired_size(WritableStreamDefaultWriter const& writer)
- {
- // 1. Let stream be writer.[[stream]].
- auto stream = writer.stream();
- // 2. Let state be stream.[[state]].
- auto state = stream->state();
- // 3. If state is "errored" or "erroring", return null.
- if (state == WritableStream::State::Errored || state == WritableStream::State::Erroring)
- return {};
- // 4. If state is "closed", return 0.
- if (state == WritableStream::State::Closed)
- return 0.0;
- // 5. Return ! WritableStreamDefaultControllerGetDesiredSize(stream.[[controller]]).
- return writable_stream_default_controller_get_desired_size(*stream->controller());
- }
- // https://streams.spec.whatwg.org/#writable-stream-default-writer-release
- WebIDL::ExceptionOr<void> writable_stream_default_writer_release(WritableStreamDefaultWriter& writer)
- {
- auto& realm = writer.realm();
- // 1. Let stream be writer.[[stream]].
- auto stream = writer.stream();
- // 2. Assert: stream is not undefined.
- VERIFY(stream);
- // 3. Assert: stream.[[writer]] is writer.
- VERIFY(stream->writer().ptr() == &writer);
- // 4. Let releasedError be a new TypeError.
- auto released_error = MUST_OR_THROW_OOM(JS::TypeError::create(realm, "Writer's stream lock has been released"sv));
- // 5. Perform ! WritableStreamDefaultWriterEnsureReadyPromiseRejected(writer, releasedError).
- writable_stream_default_writer_ensure_ready_promise_rejected(writer, released_error);
- // 6. Perform ! WritableStreamDefaultWriterEnsureClosedPromiseRejected(writer, releasedError).
- writable_stream_default_writer_ensure_closed_promise_rejected(writer, released_error);
- // 7. Set stream.[[writer]] to undefined.
- stream->set_writer({});
- // 8. Set writer.[[stream]] to undefined.
- writer.set_stream({});
- return {};
- }
- // https://streams.spec.whatwg.org/#writable-stream-default-writer-write
- WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> writable_stream_default_writer_write(WritableStreamDefaultWriter& writer, JS::Value chunk)
- {
- auto& realm = writer.realm();
- // 1. Let stream be writer.[[stream]].
- auto stream = writer.stream();
- // 2. Assert: stream is not undefined.
- VERIFY(stream);
- // 3. Let controller be stream.[[controller]].
- auto controller = stream->controller();
- // 4. Let chunkSize be ! WritableStreamDefaultControllerGetChunkSize(controller, chunk).
- auto chunk_size = TRY(writable_stream_default_controller_get_chunk_size(*controller, chunk));
- // 5. If stream is not equal to writer.[[stream]], return a promise rejected with a TypeError exception.
- if (stream.ptr() != writer.stream().ptr()) {
- auto exception = MUST_OR_THROW_OOM(JS::TypeError::create(realm, "Writer's locked stream changed during write"sv));
- return WebIDL::create_rejected_promise(realm, exception);
- }
- // 6. Let state be stream.[[state]].
- auto state = stream->state();
- // 7. If state is "errored", return a promise rejected with stream.[[storedError]].
- if (state == WritableStream::State::Errored)
- return WebIDL::create_rejected_promise(realm, stream->stored_error());
- // 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.
- if (writable_stream_close_queued_or_in_flight(*stream) || state == WritableStream::State::Closed) {
- auto exception = MUST_OR_THROW_OOM(JS::TypeError::create(realm, "Cannot write to a writer whose stream is closing or already closed"sv));
- return WebIDL::create_rejected_promise(realm, exception);
- }
- // 9. If state is "erroring", return a promise rejected with stream.[[storedError]].
- if (state == WritableStream::State::Erroring)
- return WebIDL::create_rejected_promise(realm, stream->stored_error());
- // 10. Assert: state is "writable".
- VERIFY(state == WritableStream::State::Writable);
- // 11. Let promise be ! WritableStreamAddWriteRequest(stream).
- auto promise = writable_stream_add_write_request(*stream);
- // 12. Perform ! WritableStreamDefaultControllerWrite(controller, chunk, chunkSize).
- TRY(writable_stream_default_controller_write(*controller, chunk, chunk_size));
- // 13. Return promise.
- return promise;
- }
- // https://streams.spec.whatwg.org/#set-up-writable-stream-default-controller
- 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)
- {
- auto& realm = stream.realm();
- // 1. Assert: stream implements WritableStream.
- // 2. Assert: stream.[[controller]] is undefined.
- VERIFY(!stream.controller());
- // 3. Set controller.[[stream]] to stream.
- controller.set_stream(stream);
- // 4. Set stream.[[controller]] to controller.
- stream.set_controller(controller);
- // 5. Perform ! ResetQueue(controller).
- reset_queue(controller);
- // 6. Set controller.[[signal]] to a new AbortSignal.
- controller.set_signal(MUST_OR_THROW_OOM(realm.heap().allocate<DOM::AbortSignal>(realm, realm)));
- // 7. Set controller.[[started]] to false.
- controller.set_started(false);
- // 8. Set controller.[[strategySizeAlgorithm]] to sizeAlgorithm.
- controller.set_strategy_size_algorithm(move(size_algorithm));
- // 9. Set controller.[[strategyHWM]] to highWaterMark.
- controller.set_strategy_hwm(high_water_mark);
- // 10. Set controller.[[writeAlgorithm]] to writeAlgorithm.
- controller.set_write_algorithm(move(write_algorithm));
- // 11. Set controller.[[closeAlgorithm]] to closeAlgorithm.
- controller.set_close_algorithm(move(close_algorithm));
- // 12. Set controller.[[abortAlgorithm]] to abortAlgorithm.
- controller.set_abort_algorithm(move(abort_algorithm));
- // 13. Let backpressure be ! WritableStreamDefaultControllerGetBackpressure(controller).
- auto backpressure = writable_stream_default_controller_get_backpressure(controller);
- // 14. Perform ! WritableStreamUpdateBackpressure(stream, backpressure).
- writable_stream_update_backpressure(stream, backpressure);
- // 15. Let startResult be the result of performing startAlgorithm. (This may throw an exception.)
- auto start_result = TRY(start_algorithm());
- // 16. Let startPromise be a promise resolved with startResult.
- auto start_promise = WebIDL::create_resolved_promise(realm, start_result ? start_result->promise() : JS::js_undefined());
- // 17. Upon fulfillment of startPromise,
- WebIDL::upon_fulfillment(*start_promise, [&](auto const&) -> WebIDL::ExceptionOr<JS::Value> {
- // 1. Assert: stream.[[state]] is "writable" or "erroring".
- auto state = stream.state();
- VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
- // 2. Set controller.[[started]] to true.
- controller.set_started(true);
- // 3. Perform ! WritableStreamDefaultControllerAdvanceQueueIfNeeded(controller).
- TRY(writable_stream_default_controller_advance_queue_if_needed(controller));
- return JS::js_undefined();
- });
- // 18. Upon rejection of startPromise with reason r,
- WebIDL::upon_rejection(*start_promise, [&](JS::Value reason) -> WebIDL::ExceptionOr<JS::Value> {
- // 1. Assert: stream.[[state]] is "writable" or "erroring".
- auto state = stream.state();
- VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
- // 2. Set controller.[[started]] to true.
- controller.set_started(true);
- // 3. Perform ! WritableStreamDealWithRejection(stream, r).
- TRY(writable_stream_deal_with_rejection(stream, reason));
- return JS::js_undefined();
- });
- return {};
- }
- // https://streams.spec.whatwg.org/#set-up-writable-stream-default-controller-from-underlying-sink
- 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)
- {
- auto& realm = stream.realm();
- // 1. Let controller be a new WritableStreamDefaultController.
- auto controller = MUST_OR_THROW_OOM(realm.heap().allocate<WritableStreamDefaultController>(realm, realm));
- // 2. Let startAlgorithm be an algorithm that returns undefined.
- StartAlgorithm start_algorithm = [] { return JS::GCPtr<WebIDL::Promise> {}; };
- // 3. Let writeAlgorithm be an algorithm that returns a promise resolved with undefined.
- WriteAlgorithm write_algorithm = [&realm](auto const&) {
- return WebIDL::create_resolved_promise(realm, JS::js_undefined());
- };
- // 4. Let closeAlgorithm be an algorithm that returns a promise resolved with undefined.
- CloseAlgorithm close_algorithm = [&realm] {
- return WebIDL::create_resolved_promise(realm, JS::js_undefined());
- };
- // 5. Let abortAlgorithm be an algorithm that returns a promise resolved with undefined.
- AbortAlgorithm abort_algorithm = [&realm](auto const&) {
- return WebIDL::create_resolved_promise(realm, JS::js_undefined());
- };
- // 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.
- if (underlying_sink.start) {
- start_algorithm = [&, callback = underlying_sink.start]() -> WebIDL::ExceptionOr<JS::GCPtr<WebIDL::Promise>> {
- // FIXME: This needs to create a rejected Promise for throw completions, which invoke_callback() currently doesn't do.
- auto result = TRY(WebIDL::invoke_callback(*callback, underlying_sink_value, controller)).release_value();
- return WebIDL::create_resolved_promise(realm, result);
- };
- }
- // 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.
- if (underlying_sink.write) {
- write_algorithm = [&, callback = underlying_sink.write](JS::Value chunk) -> WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> {
- // FIXME: This needs to create a rejected Promise for throw completions, which invoke_callback() currently doesn't do.
- auto result = TRY(WebIDL::invoke_callback(*callback, underlying_sink_value, chunk, controller)).release_value();
- return WebIDL::create_resolved_promise(realm, result);
- };
- }
- // 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.
- if (underlying_sink.close) {
- close_algorithm = [&, callback = underlying_sink.close]() -> WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> {
- // FIXME: This needs to create a rejected Promise for throw completions, which invoke_callback() currently doesn't do.
- auto result = TRY(WebIDL::invoke_callback(*callback, underlying_sink_value)).release_value();
- return WebIDL::create_resolved_promise(realm, result);
- };
- }
- // 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.
- if (underlying_sink.abort) {
- abort_algorithm = [&, callback = underlying_sink.abort](JS::Value reason) -> WebIDL::ExceptionOr<JS::NonnullGCPtr<WebIDL::Promise>> {
- // FIXME: This needs to create a rejected Promise for throw completions, which invoke_callback() currently doesn't do.
- auto result = TRY(WebIDL::invoke_callback(*callback, underlying_sink_value, reason)).release_value();
- return WebIDL::create_resolved_promise(realm, result);
- };
- }
- // 10. Perform ? SetUpWritableStreamDefaultController(stream, controller, startAlgorithm, writeAlgorithm, closeAlgorithm, abortAlgorithm, highWaterMark, sizeAlgorithm).
- 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)));
- return {};
- }
- // https://streams.spec.whatwg.org/#writable-stream-default-controller-advance-queue-if-needed
- WebIDL::ExceptionOr<void> writable_stream_default_controller_advance_queue_if_needed(WritableStreamDefaultController& controller)
- {
- // 1. Let stream be controller.[[stream]].
- auto stream = controller.stream();
- // 2. If controller.[[started]] is false, return.
- if (!controller.started())
- return {};
- // 3. If stream.[[inFlightWriteRequest]] is not undefined, return.
- if (stream->in_flight_write_request())
- return {};
- // 4. Let state be stream.[[state]].
- auto state = stream->state();
- // 5. Assert: state is not "closed" or "errored".
- VERIFY(state != WritableStream::State::Closed && state != WritableStream::State::Errored);
- // 6. If state is "erroring",
- if (state == WritableStream::State::Erroring) {
- // 1. Perform ! WritableStreamFinishErroring(stream).
- // 2. Return.
- return writable_stream_finish_erroring(*stream);
- }
- // 7. If controller.[[queue]] is empty, return.
- if (controller.queue().is_empty())
- return {};
- // 8. Let value be ! PeekQueueValue(controller).
- auto value = peek_queue_value(controller);
- // 9. If value is the close sentinel, perform ! WritableStreamDefaultControllerProcessClose(controller).
- if (is_close_sentinel(value)) {
- TRY(writable_stream_default_controller_process_close(controller));
- }
- // 10. Otherwise, perform ! WritableStreamDefaultControllerProcessWrite(controller, value).
- else {
- TRY(writable_stream_default_controller_process_write(controller, value));
- }
- return {};
- }
- // https://streams.spec.whatwg.org/#writable-stream-default-controller-clear-algorithms
- void writable_stream_default_controller_clear_algorithms(WritableStreamDefaultController& controller)
- {
- // 1. Set controller.[[writeAlgorithm]] to undefined.
- controller.set_write_algorithm({});
- // 2. Set controller.[[closeAlgorithm]] to undefined.
- controller.set_close_algorithm({});
- // 3. Set controller.[[abortAlgorithm]] to undefined.
- controller.set_abort_algorithm({});
- // 4. Set controller.[[strategySizeAlgorithm]] to undefined.
- controller.set_strategy_size_algorithm({});
- }
- // https://streams.spec.whatwg.org/#writable-stream-default-controller-close
- WebIDL::ExceptionOr<void> writable_stream_default_controller_close(WritableStreamDefaultController& controller)
- {
- // 1. Perform ! EnqueueValueWithSize(controller, close sentinel, 0).
- TRY(enqueue_value_with_size(controller, create_close_sentinel(), JS::Value(0.0)));
- // 2. Perform ! WritableStreamDefaultControllerAdvanceQueueIfNeeded(controller).
- TRY(writable_stream_default_controller_advance_queue_if_needed(controller));
- return {};
- }
- // https://streams.spec.whatwg.org/#writable-stream-default-controller-error
- WebIDL::ExceptionOr<void> writable_stream_default_controller_error(WritableStreamDefaultController& controller, JS::Value error)
- {
- // 1. Let stream be controller.[[stream]].
- auto stream = controller.stream();
- // 2. Assert: stream.[[state]] is "writable".
- VERIFY(stream->state() == WritableStream::State::Writable);
- // 3. Perform ! WritableStreamDefaultControllerClearAlgorithms(controller).
- writable_stream_default_controller_clear_algorithms(controller);
- // 4. Perform ! WritableStreamStartErroring(stream, error).
- return writable_stream_start_erroring(stream, error);
- }
- // https://streams.spec.whatwg.org/#writable-stream-default-controller-error-if-needed
- WebIDL::ExceptionOr<void> writable_stream_default_controller_error_if_needed(WritableStreamDefaultController& controller, JS::Value error)
- {
- // 1. If controller.[[stream]].[[state]] is "writable", perform ! WritableStreamDefaultControllerError(controller, error).
- if (controller.stream()->state() == WritableStream::State::Writable)
- TRY(writable_stream_default_controller_error(controller, error));
- return {};
- }
- // https://streams.spec.whatwg.org/#writable-stream-default-controller-get-backpressure
- bool writable_stream_default_controller_get_backpressure(WritableStreamDefaultController const& controller)
- {
- // 1. Let desiredSize be ! WritableStreamDefaultControllerGetDesiredSize(controller).
- auto desired_size = writable_stream_default_controller_get_desired_size(controller);
- // 2. Return true if desiredSize ≤ 0, or false otherwise.
- return desired_size <= 0.0;
- }
- // https://streams.spec.whatwg.org/#writable-stream-default-controller-get-chunk-size
- WebIDL::ExceptionOr<JS::Value> writable_stream_default_controller_get_chunk_size(WritableStreamDefaultController& controller, JS::Value chunk)
- {
- // 1. Let returnValue be the result of performing controller.[[strategySizeAlgorithm]], passing in chunk, and interpreting the result as a completion record.
- auto return_value = (*controller.strategy_size_algorithm())(chunk);
- // 2. If returnValue is an abrupt completion,
- if (return_value.is_abrupt()) {
- // 1. Perform ! WritableStreamDefaultControllerErrorIfNeeded(controller, returnValue.[[Value]]).
- TRY(writable_stream_default_controller_error_if_needed(controller, *return_value.release_value()));
- // 2. Return 1.
- return 1.0;
- }
- // 3. Return returnValue.[[Value]].
- return *return_value.release_value();
- }
- // https://streams.spec.whatwg.org/#writable-stream-default-controller-get-desired-size
- double writable_stream_default_controller_get_desired_size(WritableStreamDefaultController const& controller)
- {
- // 1. Return controller.[[strategyHWM]] − controller.[[queueTotalSize]].
- return controller.strategy_hwm() - controller.queue_total_size();
- }
- // https://streams.spec.whatwg.org/#writable-stream-default-controller-process-close
- WebIDL::ExceptionOr<void> writable_stream_default_controller_process_close(WritableStreamDefaultController& controller)
- {
- // 1. Let stream be controller.[[stream]].
- auto stream = controller.stream();
- // 2. Perform ! WritableStreamMarkCloseRequestInFlight(stream).
- writable_stream_mark_close_request_in_flight(*stream);
- // 3. Perform ! DequeueValue(controller).
- dequeue_value(controller);
- // 4. Assert: controller.[[queue]] is empty.
- VERIFY(controller.queue().is_empty());
- // 5. Let sinkClosePromise be the result of performing controller.[[closeAlgorithm]].
- auto sink_close_promise = TRY((*controller.close_algorithm())());
- // 6. Perform ! WritableStreamDefaultControllerClearAlgorithms(controller).
- writable_stream_default_controller_clear_algorithms(controller);
- // 7. Upon fulfillment of sinkClosePromise,
- WebIDL::upon_fulfillment(*sink_close_promise, [&, stream = stream](auto const&) -> WebIDL::ExceptionOr<JS::Value> {
- // 1. Perform ! WritableStreamFinishInFlightClose(stream).
- writable_stream_finish_in_flight_close(*stream);
- return JS::js_undefined();
- });
- // 8. Upon rejection of sinkClosePromise with reason reason,
- WebIDL::upon_rejection(*sink_close_promise, [&, stream = stream](auto const& reason) -> WebIDL::ExceptionOr<JS::Value> {
- // 1. Perform ! WritableStreamFinishInFlightCloseWithError(stream, reason).
- TRY(writable_stream_finish_in_flight_close_with_error(*stream, reason));
- return JS::js_undefined();
- });
- return {};
- }
- // https://streams.spec.whatwg.org/#writable-stream-default-controller-process-write
- WebIDL::ExceptionOr<void> writable_stream_default_controller_process_write(WritableStreamDefaultController& controller, JS::Value chunk)
- {
- // 1. Let stream be controller.[[stream]].
- auto stream = controller.stream();
- // 2. Perform ! WritableStreamMarkFirstWriteRequestInFlight(stream).
- writable_stream_mark_first_write_request_in_flight(*stream);
- // 3. Let sinkWritePromise be the result of performing controller.[[writeAlgorithm]], passing in chunk.
- auto sink_write_promise = TRY((*controller.write_algorithm())(chunk));
- // 4. Upon fulfillment of sinkWritePromise,
- WebIDL::upon_fulfillment(*sink_write_promise, [&, stream = stream](auto const&) -> WebIDL::ExceptionOr<JS::Value> {
- // 1. Perform ! WritableStreamFinishInFlightWrite(stream).
- writable_stream_finish_in_flight_write(*stream);
- // 2. Let state be stream.[[state]].
- auto state = stream->state();
- // 3. Assert: state is "writable" or "erroring".
- VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
- // 4. Perform ! DequeueValue(controller).
- dequeue_value(controller);
- // 5. If ! WritableStreamCloseQueuedOrInFlight(stream) is false and state is "writable",
- if (!writable_stream_close_queued_or_in_flight(*stream) && state == WritableStream::State::Writable) {
- // 1. Let backpressure be ! WritableStreamDefaultControllerGetBackpressure(controller).
- auto backpressure = writable_stream_default_controller_get_backpressure(controller);
- // 2. Perform ! WritableStreamUpdateBackpressure(stream, backpressure).
- writable_stream_update_backpressure(*stream, backpressure);
- }
- // 6 .Perform ! WritableStreamDefaultControllerAdvanceQueueIfNeeded(controller).
- TRY(writable_stream_default_controller_advance_queue_if_needed(controller));
- return JS::js_undefined();
- });
- // 5. Upon rejection of sinkWritePromise with reason,
- WebIDL::upon_rejection(*sink_write_promise, [&, stream = stream](auto const& reason) -> WebIDL::ExceptionOr<JS::Value> {
- // 1. If stream.[[state]] is "writable", perform ! WritableStreamDefaultControllerClearAlgorithms(controller).
- if (stream->state() == WritableStream::State::Writable)
- writable_stream_default_controller_clear_algorithms(controller);
- // 2. Perform ! WritableStreamFinishInFlightWriteWithError(stream, reason).
- TRY(writable_stream_finish_in_flight_write_with_error(*stream, reason));
- return JS::js_undefined();
- });
- return {};
- }
- // https://streams.spec.whatwg.org/#writable-stream-default-controller-write
- WebIDL::ExceptionOr<void> writable_stream_default_controller_write(WritableStreamDefaultController& controller, JS::Value chunk, JS::Value chunk_size)
- {
- auto& vm = controller.vm();
- // 1. Let enqueueResult be EnqueueValueWithSize(controller, chunk, chunkSize).
- auto enqueue_result = enqueue_value_with_size(controller, chunk, chunk_size);
- // 2. If enqueueResult is an abrupt completion,
- if (enqueue_result.is_exception()) {
- auto throw_completion = Bindings::throw_dom_exception_if_needed(vm, [&] { return enqueue_result; }).throw_completion();
- // 1. Perform ! WritableStreamDefaultControllerErrorIfNeeded(controller, enqueueResult.[[Value]]).
- TRY(writable_stream_default_controller_error_if_needed(controller, *throw_completion.release_value()));
- // 2. Return.
- return {};
- }
- // 3. Let stream be controller.[[stream]].
- auto stream = controller.stream();
- // 4. If ! WritableStreamCloseQueuedOrInFlight(stream) is false and stream.[[state]] is "writable",
- if (!writable_stream_close_queued_or_in_flight(*stream) && stream->state() == WritableStream::State::Writable) {
- // 1. Let backpressure be ! WritableStreamDefaultControllerGetBackpressure(controller).
- auto backpressure = writable_stream_default_controller_get_backpressure(controller);
- // 2. Perform ! WritableStreamUpdateBackpressure(stream, backpressure).
- writable_stream_update_backpressure(*stream, backpressure);
- }
- // 5. Perform ! WritableStreamDefaultControllerAdvanceQueueIfNeeded(controller).
- TRY(writable_stream_default_controller_advance_queue_if_needed(controller));
- return {};
- }
- // https://streams.spec.whatwg.org/#is-non-negative-number
- bool is_non_negative_number(JS::Value value)
- {
- // 1. If Type(v) is not Number, return false.
- if (!value.is_number())
- return false;
- // 2. If v is NaN, return false.
- if (value.is_nan())
- return false;
- // 3. If v < 0, return false.
- if (value.as_double() < 0.0)
- return false;
- // 4. Return true.
- return true;
- }
- // https://streams.spec.whatwg.org/#close-sentinel
- // Non-standard function that implements the "close sentinel" value.
- JS::Value create_close_sentinel()
- {
- // 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.
- // 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.
- return {};
- }
- // https://streams.spec.whatwg.org/#close-sentinel
- // Non-standard function that implements the "If value is a close sentinel" check.
- bool is_close_sentinel(JS::Value value)
- {
- return value.is_empty();
- }
- // Non-standard function to aid in converting a user-provided function into a WebIDL::Callback. This is essentially
- // what the Bindings generator would do at compile time, but at runtime instead.
- JS::ThrowCompletionOr<JS::Handle<WebIDL::CallbackType>> property_to_callback(JS::VM& vm, JS::Value value, JS::PropertyKey const& property_key)
- {
- auto property = TRY(value.get(vm, property_key));
- if (property.is_undefined())
- return JS::Handle<WebIDL::CallbackType> {};
- if (!property.is_function())
- return vm.throw_completion<JS::TypeError>(JS::ErrorType::NotAFunction, TRY_OR_THROW_OOM(vm, property.to_string_without_side_effects()));
- return vm.heap().allocate_without_realm<WebIDL::CallbackType>(property.as_object(), HTML::incumbent_settings_object());
- }
- }
|