AbstractOperations.cpp 237 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228
  1. /*
  2. * Copyright (c) 2022, Linus Groh <linusg@serenityos.org>
  3. * Copyright (c) 2023, Matthew Olsson <mattco@serenityos.org>
  4. * Copyright (c) 2023-2024, Shannon Booth <shannon@serenityos.org>
  5. * Copyright (c) 2023-2024, Kenneth Myhra <kennethmyhra@serenityos.org>
  6. *
  7. * SPDX-License-Identifier: BSD-2-Clause
  8. */
  9. #include <LibJS/Runtime/Array.h>
  10. #include <LibJS/Runtime/ArrayBuffer.h>
  11. #include <LibJS/Runtime/DataView.h>
  12. #include <LibJS/Runtime/DataViewConstructor.h>
  13. #include <LibJS/Runtime/Intrinsics.h>
  14. #include <LibJS/Runtime/PromiseCapability.h>
  15. #include <LibJS/Runtime/PromiseConstructor.h>
  16. #include <LibJS/Runtime/TypedArray.h>
  17. #include <LibWeb/Bindings/ExceptionOrUtils.h>
  18. #include <LibWeb/DOM/AbortSignal.h>
  19. #include <LibWeb/HTML/EventLoop/EventLoop.h>
  20. #include <LibWeb/HTML/Scripting/TemporaryExecutionContext.h>
  21. #include <LibWeb/HTML/StructuredSerialize.h>
  22. #include <LibWeb/Streams/AbstractOperations.h>
  23. #include <LibWeb/Streams/QueuingStrategy.h>
  24. #include <LibWeb/Streams/ReadableByteStreamController.h>
  25. #include <LibWeb/Streams/ReadableStream.h>
  26. #include <LibWeb/Streams/ReadableStreamBYOBReader.h>
  27. #include <LibWeb/Streams/ReadableStreamBYOBRequest.h>
  28. #include <LibWeb/Streams/ReadableStreamDefaultController.h>
  29. #include <LibWeb/Streams/ReadableStreamDefaultReader.h>
  30. #include <LibWeb/Streams/ReadableStreamGenericReader.h>
  31. #include <LibWeb/Streams/TransformStream.h>
  32. #include <LibWeb/Streams/TransformStreamDefaultController.h>
  33. #include <LibWeb/Streams/Transformer.h>
  34. #include <LibWeb/Streams/UnderlyingSink.h>
  35. #include <LibWeb/Streams/UnderlyingSource.h>
  36. #include <LibWeb/Streams/WritableStream.h>
  37. #include <LibWeb/Streams/WritableStreamDefaultController.h>
  38. #include <LibWeb/Streams/WritableStreamDefaultWriter.h>
  39. #include <LibWeb/WebIDL/AbstractOperations.h>
  40. #include <LibWeb/WebIDL/Buffers.h>
  41. #include <LibWeb/WebIDL/ExceptionOr.h>
  42. #include <LibWeb/WebIDL/Promise.h>
  43. namespace Web::Streams {
  44. // https://streams.spec.whatwg.org/#acquire-readable-stream-reader
  45. WebIDL::ExceptionOr<JS::NonnullGCPtr<ReadableStreamDefaultReader>> acquire_readable_stream_default_reader(ReadableStream& stream)
  46. {
  47. auto& realm = stream.realm();
  48. // 1. Let reader be a new ReadableStreamDefaultReader.
  49. auto reader = realm.heap().allocate<ReadableStreamDefaultReader>(realm, realm);
  50. // 2. Perform ? SetUpReadableStreamDefaultReader(reader, stream).
  51. TRY(set_up_readable_stream_default_reader(reader, stream));
  52. // 3. Return reader.
  53. return reader;
  54. }
  55. // https://streams.spec.whatwg.org/#acquire-readable-stream-byob-reader
  56. WebIDL::ExceptionOr<JS::NonnullGCPtr<ReadableStreamBYOBReader>> acquire_readable_stream_byob_reader(ReadableStream& stream)
  57. {
  58. auto& realm = stream.realm();
  59. // 1. Let reader be a new ReadableStreamBYOBReader.
  60. auto reader = realm.heap().allocate<ReadableStreamBYOBReader>(realm, realm);
  61. // 2. Perform ? SetUpReadableStreamBYOBReader(reader, stream).
  62. TRY(set_up_readable_stream_byob_reader(reader, stream));
  63. // 3. Return reader.
  64. return reader;
  65. }
  66. // https://streams.spec.whatwg.org/#is-readable-stream-locked
  67. bool is_readable_stream_locked(ReadableStream const& stream)
  68. {
  69. // 1. If stream.[[reader]] is undefined, return false.
  70. if (!stream.reader().has_value())
  71. return false;
  72. // 2. Return true.
  73. return true;
  74. }
  75. // https://streams.spec.whatwg.org/#readable-stream-cancel
  76. JS::NonnullGCPtr<WebIDL::Promise> readable_stream_cancel(ReadableStream& stream, JS::Value reason)
  77. {
  78. auto& realm = stream.realm();
  79. // 1. Set stream.[[disturbed]] to true.
  80. stream.set_disturbed(true);
  81. // 2. If stream.[[state]] is "closed", return a promise resolved with undefined.
  82. if (stream.state() == ReadableStream::State::Closed)
  83. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  84. // 3. If stream.[[state]] is "errored", return a promise rejected with stream.[[storedError]].
  85. if (stream.state() == ReadableStream::State::Errored)
  86. return WebIDL::create_rejected_promise(realm, stream.stored_error());
  87. // 4. Perform ! ReadableStreamClose(stream).
  88. readable_stream_close(stream);
  89. // 5. Let reader be stream.[[reader]].
  90. auto reader = stream.reader();
  91. // 6. If reader is not undefined and reader implements ReadableStreamBYOBReader,
  92. if (reader.has_value() && reader->has<JS::NonnullGCPtr<ReadableStreamBYOBReader>>()) {
  93. // 1. Let readIntoRequests be reader.[[readIntoRequests]].
  94. // 2. Set reader.[[readIntoRequests]] to an empty list.
  95. auto read_into_requests = move(reader->get<JS::NonnullGCPtr<ReadableStreamBYOBReader>>()->read_into_requests());
  96. // 3. For each readIntoRequest of readIntoRequests,
  97. for (auto& read_into_request : read_into_requests) {
  98. // 1. Perform readIntoRequest’s close steps, given undefined.
  99. read_into_request->on_close(JS::js_undefined());
  100. }
  101. }
  102. // 7. Let sourceCancelPromise be ! stream.[[controller]].[[CancelSteps]](reason).
  103. auto source_cancel_promise = stream.controller()->visit([&](auto const& controller) {
  104. return controller->cancel_steps(reason);
  105. });
  106. // 8. Return the result of reacting to sourceCancelPromise with a fulfillment step that returns undefined.
  107. auto react_result = WebIDL::react_to_promise(*source_cancel_promise,
  108. JS::create_heap_function(stream.heap(), [](JS::Value) -> WebIDL::ExceptionOr<JS::Value> { return JS::js_undefined(); }),
  109. {});
  110. return WebIDL::create_resolved_promise(realm, react_result);
  111. }
  112. // https://streams.spec.whatwg.org/#readable-stream-fulfill-read-into-request
  113. void readable_stream_fulfill_read_into_request(ReadableStream& stream, JS::Value chunk, bool done)
  114. {
  115. // 1. Assert: ! ReadableStreamHasBYOBReader(stream) is true.
  116. VERIFY(readable_stream_has_byob_reader(stream));
  117. // 2. Let reader be stream.[[reader]].
  118. auto reader = stream.reader()->get<JS::NonnullGCPtr<ReadableStreamBYOBReader>>();
  119. // 3. Assert: reader.[[readIntoRequests]] is not empty.
  120. VERIFY(!reader->read_into_requests().is_empty());
  121. // 4. Let readIntoRequest be reader.[[readIntoRequests]][0].
  122. // 5. Remove readIntoRequest from reader.[[readIntoRequests]].
  123. auto read_into_request = reader->read_into_requests().take_first();
  124. // 6. If done is true, perform readIntoRequest’s close steps, given chunk.
  125. if (done) {
  126. read_into_request->on_close(chunk);
  127. }
  128. // 7. Otherwise, perform readIntoRequest’s chunk steps, given chunk.
  129. else {
  130. read_into_request->on_chunk(chunk);
  131. }
  132. }
  133. // https://streams.spec.whatwg.org/#readable-stream-fulfill-read-request
  134. void readable_stream_fulfill_read_request(ReadableStream& stream, JS::Value chunk, bool done)
  135. {
  136. // 1. Assert: ! ReadableStreamHasDefaultReader(stream) is true.
  137. VERIFY(readable_stream_has_default_reader(stream));
  138. // 2. Let reader be stream.[[reader]].
  139. auto reader = stream.reader()->get<JS::NonnullGCPtr<ReadableStreamDefaultReader>>();
  140. // 3. Assert: reader.[[readRequests]] is not empty.
  141. VERIFY(!reader->read_requests().is_empty());
  142. // 4. Let readRequest be reader.[[readRequests]][0].
  143. // 5. Remove readRequest from reader.[[readRequests]].
  144. auto read_request = reader->read_requests().take_first();
  145. // 6. If done is true, perform readRequest’s close steps.
  146. if (done) {
  147. read_request->on_close();
  148. }
  149. // 7. Otherwise, perform readRequest’s chunk steps, given chunk.
  150. else {
  151. read_request->on_chunk(chunk);
  152. }
  153. }
  154. // https://streams.spec.whatwg.org/#readable-stream-get-num-read-into-requests
  155. size_t readable_stream_get_num_read_into_requests(ReadableStream const& stream)
  156. {
  157. // 1. Assert: ! ReadableStreamHasBYOBReader(stream) is true.
  158. VERIFY(readable_stream_has_byob_reader(stream));
  159. // 2. Return stream.[[reader]].[[readIntoRequests]]'s size.
  160. return stream.reader()->get<JS::NonnullGCPtr<ReadableStreamBYOBReader>>()->read_into_requests().size();
  161. }
  162. // https://streams.spec.whatwg.org/#readable-stream-get-num-read-requests
  163. size_t readable_stream_get_num_read_requests(ReadableStream const& stream)
  164. {
  165. // 1. Assert: ! ReadableStreamHasDefaultReader(stream) is true.
  166. VERIFY(readable_stream_has_default_reader(stream));
  167. // 2. Return stream.[[reader]].[[readRequests]]'s size.
  168. return stream.reader()->get<JS::NonnullGCPtr<ReadableStreamDefaultReader>>()->read_requests().size();
  169. }
  170. // https://streams.spec.whatwg.org/#readable-stream-has-byob-reader
  171. bool readable_stream_has_byob_reader(ReadableStream const& stream)
  172. {
  173. // 1. Let reader be stream.[[reader]].
  174. auto reader = stream.reader();
  175. // 2. If reader is undefined, return false.
  176. if (!reader.has_value())
  177. return false;
  178. // 3. If reader implements ReadableStreamBYOBReader, return true.
  179. if (reader->has<JS::NonnullGCPtr<ReadableStreamBYOBReader>>())
  180. return true;
  181. // 4. Return false.
  182. return false;
  183. }
  184. // https://streams.spec.whatwg.org/#readable-stream-has-default-reader
  185. bool readable_stream_has_default_reader(ReadableStream const& stream)
  186. {
  187. // 1. Let reader be stream.[[reader]].
  188. auto reader = stream.reader();
  189. // 2. If reader is undefined, return false.
  190. if (!reader.has_value())
  191. return false;
  192. // 3. If reader implements ReadableStreamDefaultReader, return true.
  193. if (reader->has<JS::NonnullGCPtr<ReadableStreamDefaultReader>>())
  194. return true;
  195. // 4. Return false.
  196. return false;
  197. }
  198. // https://streams.spec.whatwg.org/#readable-stream-pipe-to
  199. JS::NonnullGCPtr<WebIDL::Promise> readable_stream_pipe_to(ReadableStream& source, WritableStream& dest, bool, bool, bool, Optional<JS::Value> signal)
  200. {
  201. auto& realm = source.realm();
  202. // 1. Assert: source implements ReadableStream.
  203. // 2. Assert: dest implements WritableStream.
  204. // 3. Assert: preventClose, preventAbort, and preventCancel are all booleans.
  205. // 4. If signal was not given, let signal be undefined.
  206. if (!signal.has_value())
  207. signal = JS::js_undefined();
  208. // 5. Assert: either signal is undefined, or signal implements AbortSignal.
  209. VERIFY(signal->is_undefined() || (signal->is_object() && is<DOM::AbortSignal>(signal->as_object())));
  210. // 6. Assert: ! IsReadableStreamLocked(source) is false.
  211. VERIFY(!is_readable_stream_locked(source));
  212. // 7. Assert: ! IsWritableStreamLocked(dest) is false.
  213. VERIFY(!is_writable_stream_locked(dest));
  214. // 8. If source.[[controller]] implements ReadableByteStreamController, let reader be either ! AcquireReadableStreamBYOBReader(source)
  215. // or ! AcquireReadableStreamDefaultReader(source), at the user agent’s discretion.
  216. // 9. Otherwise, let reader be ! AcquireReadableStreamDefaultReader(source).
  217. auto reader = MUST(source.controller()->visit(
  218. [](auto const& controller) {
  219. return acquire_readable_stream_default_reader(*controller->stream());
  220. }));
  221. // 10. Let writer be ! AcquireWritableStreamDefaultWriter(dest).
  222. auto writer = MUST(acquire_writable_stream_default_writer(dest));
  223. // 11. Set source.[[disturbed]] to true.
  224. source.set_disturbed(true);
  225. // FIXME: 12. Let shuttingDown be false.
  226. // 13. Let promise be a new promise.
  227. auto promise = WebIDL::create_promise(realm);
  228. // FIXME 14. If signal is not undefined,
  229. // 1. Let abortAlgorithm be the following steps:
  230. // 1. Let error be signal’s abort reason.
  231. // 2. Let actions be an empty ordered set.
  232. // 3. If preventAbort is false, append the following action to actions:
  233. // 1. If dest.[[state]] is "writable", return ! WritableStreamAbort(dest, error).
  234. // 2. Otherwise, return a promise resolved with undefined.
  235. // 4. If preventCancel is false, append the following action to actions:
  236. // 1. If source.[[state]] is "readable", return ! ReadableStreamCancel(source, error).
  237. // 2. Otherwise, return a promise resolved with undefined.
  238. // 5. Shutdown with an action consisting of getting a promise to wait for all of the actions in actions, and with error.
  239. // 2. If signal is aborted, perform abortAlgorithm and return promise.
  240. // 3. Add abortAlgorithm to signal.
  241. // 15. In parallel but not really; see #905, using reader and writer, read all chunks from source and write them to
  242. // dest. Due to the locking provided by the reader and writer, the exact manner in which this happens is not
  243. // observable to author code, and so there is flexibility in how this is done. The following constraints apply
  244. // regardless of the exact algorithm used:
  245. // - Public API must not be used: while reading or writing, or performing any of the operations below, the
  246. // JavaScript-modifiable reader, writer, and stream APIs (i.e. methods on the appropriate prototypes) must not
  247. // be used. Instead, the streams must be manipulated directly.
  248. // FIXME: Currently a naive implementation that uses ReadableStreamDefaultReader::read_all_chunks() to read all chunks
  249. // from the source and then through the callback success_steps writes those chunks to the destination.
  250. auto chunk_steps = [&realm, writer](ByteBuffer buffer) {
  251. auto array_buffer = JS::ArrayBuffer::create(realm, move(buffer));
  252. auto chunk = JS::Uint8Array::create(realm, array_buffer->byte_length(), *array_buffer);
  253. auto promise = writable_stream_default_writer_write(writer, chunk);
  254. WebIDL::resolve_promise(realm, promise, JS::js_undefined());
  255. };
  256. auto success_steps = [promise, &realm, writer](ByteBuffer) {
  257. // Make sure we close the acquired writer.
  258. WebIDL::resolve_promise(realm, writable_stream_default_writer_close(*writer), JS::js_undefined());
  259. WebIDL::resolve_promise(realm, promise, JS::js_undefined());
  260. };
  261. auto failure_steps = [promise, &realm, writer](JS::Value error) {
  262. // Make sure we close the acquired writer.
  263. WebIDL::resolve_promise(realm, writable_stream_default_writer_close(*writer), JS::js_undefined());
  264. WebIDL::reject_promise(realm, promise, error);
  265. };
  266. reader->read_all_chunks(move(chunk_steps), move(success_steps), move(failure_steps));
  267. // 16. Return promise.
  268. return promise;
  269. }
  270. // https://streams.spec.whatwg.org/#readable-stream-tee
  271. WebIDL::ExceptionOr<ReadableStreamPair> readable_stream_tee(JS::Realm& realm, ReadableStream& stream, bool clone_for_branch2)
  272. {
  273. // 1. Assert: stream implements ReadableStream.
  274. // 2. Assert: cloneForBranch2 is a boolean.
  275. // 3. If stream.[[controller]] implements ReadableByteStreamController, return ? ReadableByteStreamTee(stream).
  276. if (stream.controller()->has<JS::NonnullGCPtr<Streams::ReadableByteStreamController>>()) {
  277. return TRY(readable_byte_stream_tee(realm, stream));
  278. }
  279. // 4. Return ? ReadableStreamDefaultTee(stream, cloneForBranch2).
  280. return TRY(readable_stream_default_tee(realm, stream, clone_for_branch2));
  281. }
  282. struct DefaultStreamTeeParams final : JS::Cell {
  283. JS_CELL(DefaultStreamTeeParams, JS::Cell);
  284. JS_DECLARE_ALLOCATOR(DefaultStreamTeeParams);
  285. virtual void visit_edges(Visitor& visitor) override
  286. {
  287. Base::visit_edges(visitor);
  288. visitor.visit(reason1);
  289. visitor.visit(reason2);
  290. visitor.visit(branch1);
  291. visitor.visit(branch2);
  292. visitor.visit(pull_algorithm);
  293. }
  294. bool reading { false };
  295. bool read_again { false };
  296. bool canceled1 { false };
  297. bool canceled2 { false };
  298. JS::Value reason1 { JS::js_undefined() };
  299. JS::Value reason2 { JS::js_undefined() };
  300. JS::GCPtr<ReadableStream> branch1;
  301. JS::GCPtr<ReadableStream> branch2;
  302. JS::GCPtr<PullAlgorithm> pull_algorithm;
  303. };
  304. JS_DEFINE_ALLOCATOR(DefaultStreamTeeParams);
  305. // https://streams.spec.whatwg.org/#ref-for-read-request③
  306. class DefaultStreamTeeReadRequest final : public ReadRequest {
  307. JS_CELL(DefaultStreamTeeReadRequest, ReadRequest);
  308. JS_DECLARE_ALLOCATOR(DefaultStreamTeeReadRequest);
  309. public:
  310. DefaultStreamTeeReadRequest(
  311. JS::Realm& realm,
  312. JS::NonnullGCPtr<ReadableStream> stream,
  313. JS::NonnullGCPtr<DefaultStreamTeeParams> params,
  314. JS::NonnullGCPtr<WebIDL::Promise> cancel_promise,
  315. bool clone_for_branch2)
  316. : m_realm(realm)
  317. , m_stream(stream)
  318. , m_params(params)
  319. , m_cancel_promise(cancel_promise)
  320. , m_clone_for_branch2(clone_for_branch2)
  321. {
  322. }
  323. // https://streams.spec.whatwg.org/#ref-for-read-request-chunk-steps③
  324. virtual void on_chunk(JS::Value chunk) override
  325. {
  326. // 1. Queue a microtask to perform the following steps:
  327. HTML::queue_a_microtask(nullptr, JS::create_heap_function(m_realm->heap(), [this, chunk]() {
  328. HTML::TemporaryExecutionContext execution_context { Bindings::host_defined_environment_settings_object(m_realm), HTML::TemporaryExecutionContext::CallbacksEnabled::Yes };
  329. auto controller1 = m_params->branch1->controller()->get<JS::NonnullGCPtr<ReadableStreamDefaultController>>();
  330. auto controller2 = m_params->branch2->controller()->get<JS::NonnullGCPtr<ReadableStreamDefaultController>>();
  331. // 1. Set readAgain to false.
  332. m_params->read_again = false;
  333. // 2. Let chunk1 and chunk2 be chunk.
  334. auto chunk1 = chunk;
  335. auto chunk2 = chunk;
  336. // 3. If canceled2 is false and cloneForBranch2 is true,
  337. if (!m_params->canceled2 && m_clone_for_branch2) {
  338. // 1. Let cloneResult be StructuredClone(chunk2).
  339. auto clone_result = structured_clone(m_realm, chunk2);
  340. // 2. If cloneResult is an abrupt completion,
  341. if (clone_result.is_exception()) {
  342. auto completion = Bindings::dom_exception_to_throw_completion(m_realm->vm(), clone_result.release_error());
  343. // 1. Perform ! ReadableStreamDefaultControllerError(branch1.[[controller]], cloneResult.[[Value]]).
  344. readable_stream_default_controller_error(controller1, completion.value().value());
  345. // 2. Perform ! ReadableStreamDefaultControllerError(branch2.[[controller]], cloneResult.[[Value]]).
  346. readable_stream_default_controller_error(controller2, completion.value().value());
  347. // 3. Resolve cancelPromise with ! ReadableStreamCancel(stream, cloneResult.[[Value]]).
  348. auto cancel_result = readable_stream_cancel(m_stream, completion.value().value());
  349. JS::NonnullGCPtr cancel_value = verify_cast<JS::Promise>(*cancel_result->promise().ptr());
  350. WebIDL::resolve_promise(m_realm, m_cancel_promise, cancel_value);
  351. // 4. Return.
  352. return;
  353. }
  354. // 3. Otherwise, set chunk2 to cloneResult.[[Value]].
  355. chunk2 = clone_result.release_value();
  356. }
  357. // 4. If canceled1 is false, perform ! ReadableStreamDefaultControllerEnqueue(branch1.[[controller]], chunk1).
  358. if (!m_params->canceled1) {
  359. MUST(readable_stream_default_controller_enqueue(controller1, chunk1));
  360. }
  361. // 5. If canceled2 is false, perform ! ReadableStreamDefaultControllerEnqueue(branch2.[[controller]], chunk2).
  362. if (!m_params->canceled2) {
  363. MUST(readable_stream_default_controller_enqueue(controller2, chunk2));
  364. }
  365. // 6. Set reading to false.
  366. m_params->reading = false;
  367. // 7. If readAgain is true, perform pullAlgorithm.
  368. if (m_params->read_again) {
  369. m_params->pull_algorithm->function()();
  370. }
  371. }));
  372. // NOTE: The microtask delay here is necessary because it takes at least a microtask to detect errors, when we
  373. // use reader.[[closedPromise]] below. We want errors in stream to error both branches immediately, so we
  374. // cannot let successful synchronously-available reads happen ahead of asynchronously-available errors.
  375. }
  376. // https://streams.spec.whatwg.org/#ref-for-read-request-close-steps②
  377. virtual void on_close() override
  378. {
  379. auto controller1 = m_params->branch1->controller()->get<JS::NonnullGCPtr<ReadableStreamDefaultController>>();
  380. auto controller2 = m_params->branch2->controller()->get<JS::NonnullGCPtr<ReadableStreamDefaultController>>();
  381. // 1. Set reading to false.
  382. m_params->reading = false;
  383. // 2. If canceled1 is false, perform ! ReadableStreamDefaultControllerClose(branch1.[[controller]]).
  384. if (!m_params->canceled1) {
  385. readable_stream_default_controller_close(controller1);
  386. }
  387. // 3. If canceled2 is false, perform ! ReadableStreamDefaultControllerClose(branch2.[[controller]]).
  388. if (!m_params->canceled2) {
  389. readable_stream_default_controller_close(controller2);
  390. }
  391. // 4. If canceled1 is false or canceled2 is false, resolve cancelPromise with undefined.
  392. if (!m_params->canceled1 || !m_params->canceled2) {
  393. WebIDL::resolve_promise(m_realm, m_cancel_promise, JS::js_undefined());
  394. }
  395. }
  396. // https://streams.spec.whatwg.org/#ref-for-read-request-error-steps③
  397. virtual void on_error(JS::Value) override
  398. {
  399. // 1. Set reading to false.
  400. m_params->reading = false;
  401. }
  402. private:
  403. virtual void visit_edges(Visitor& visitor) override
  404. {
  405. Base::visit_edges(visitor);
  406. visitor.visit(m_realm);
  407. visitor.visit(m_stream);
  408. visitor.visit(m_params);
  409. visitor.visit(m_cancel_promise);
  410. }
  411. JS::NonnullGCPtr<JS::Realm> m_realm;
  412. JS::NonnullGCPtr<ReadableStream> m_stream;
  413. JS::NonnullGCPtr<DefaultStreamTeeParams> m_params;
  414. JS::NonnullGCPtr<WebIDL::Promise> m_cancel_promise;
  415. bool m_clone_for_branch2 { false };
  416. };
  417. JS_DEFINE_ALLOCATOR(DefaultStreamTeeReadRequest);
  418. // https://streams.spec.whatwg.org/#abstract-opdef-readablestreamdefaulttee
  419. WebIDL::ExceptionOr<ReadableStreamPair> readable_stream_default_tee(JS::Realm& realm, ReadableStream& stream, bool clone_for_branch2)
  420. {
  421. // 1. Assert: stream implements ReadableStream.
  422. // 2. Assert: cloneForBranch2 is a boolean.
  423. // 3. Let reader be ? AcquireReadableStreamDefaultReader(stream).
  424. auto reader = TRY(acquire_readable_stream_default_reader(stream));
  425. // 4. Let reading be false.
  426. // 5. Let readAgain be false.
  427. // 6. Let canceled1 be false.
  428. // 7. Let canceled2 be false.
  429. // 8. Let reason1 be undefined.
  430. // 9. Let reason2 be undefined.
  431. // 10. Let branch1 be undefined.
  432. // 11. Let branch2 be undefined.
  433. auto params = realm.heap().allocate<DefaultStreamTeeParams>(realm);
  434. // 12. Let cancelPromise be a new promise.
  435. auto cancel_promise = WebIDL::create_promise(realm);
  436. // 13. Let pullAlgorithm be the following steps:
  437. auto pull_algorithm = JS::create_heap_function(realm.heap(), [&realm, &stream, reader, params, cancel_promise, clone_for_branch2]() {
  438. // 1. If reading is true,
  439. if (params->reading) {
  440. // 1. Set readAgain to true.
  441. params->read_again = true;
  442. // 2. Return a promise resolved with undefined.
  443. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  444. }
  445. // 2. Set reading to true.
  446. params->reading = true;
  447. // 3. Let readRequest be a read request with the following items:
  448. auto read_request = realm.heap().allocate_without_realm<DefaultStreamTeeReadRequest>(realm, stream, params, cancel_promise, clone_for_branch2);
  449. // 4. Perform ! ReadableStreamDefaultReaderRead(reader, readRequest).
  450. readable_stream_default_reader_read(reader, read_request);
  451. // 5. Return a promise resolved with undefined.
  452. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  453. });
  454. // AD-HOC: The read request within the pull algorithm must be able to re-invoke the pull algorithm, so cache it here.
  455. params->pull_algorithm = pull_algorithm;
  456. // 14. Let cancel1Algorithm be the following steps, taking a reason argument:
  457. auto cancel1_algorithm = JS::create_heap_function(realm.heap(), [&realm, &stream, params, cancel_promise](JS::Value reason) {
  458. // 1. Set canceled1 to true.
  459. params->canceled1 = true;
  460. // 2. Set reason1 to reason.
  461. params->reason1 = reason;
  462. // 3. If canceled2 is true,
  463. if (params->canceled2) {
  464. // 1. Let compositeReason be ! CreateArrayFromList(« reason1, reason2 »).
  465. auto composite_reason = JS::Array::create_from(realm, AK::Array { params->reason1, params->reason2 });
  466. // 2. Let cancelResult be ! ReadableStreamCancel(stream, compositeReason).
  467. auto cancel_result = readable_stream_cancel(stream, composite_reason);
  468. // 3. Resolve cancelPromise with cancelResult.
  469. JS::NonnullGCPtr cancel_value = verify_cast<JS::Promise>(*cancel_result->promise().ptr());
  470. WebIDL::resolve_promise(realm, cancel_promise, cancel_value);
  471. }
  472. // 4. Return cancelPromise.
  473. return cancel_promise;
  474. });
  475. // 15. Let cancel2Algorithm be the following steps, taking a reason argument:
  476. auto cancel2_algorithm = JS::create_heap_function(realm.heap(), [&realm, &stream, params, cancel_promise](JS::Value reason) {
  477. // 1. Set canceled2 to true.
  478. params->canceled2 = true;
  479. // 2. Set reason2 to reason.
  480. params->reason2 = reason;
  481. // 3. If canceled1 is true,
  482. if (params->canceled1) {
  483. // 1. Let compositeReason be ! CreateArrayFromList(« reason1, reason2 »).
  484. auto composite_reason = JS::Array::create_from(realm, AK::Array { params->reason1, params->reason2 });
  485. // 2. Let cancelResult be ! ReadableStreamCancel(stream, compositeReason).
  486. auto cancel_result = readable_stream_cancel(stream, composite_reason);
  487. // 3. Resolve cancelPromise with cancelResult.
  488. JS::NonnullGCPtr cancel_value = verify_cast<JS::Promise>(*cancel_result->promise().ptr());
  489. WebIDL::resolve_promise(realm, cancel_promise, cancel_value);
  490. }
  491. // 4. Return cancelPromise.
  492. return cancel_promise;
  493. });
  494. // 16. Let startAlgorithm be an algorithm that returns undefined.
  495. auto start_algorithm = JS::create_heap_function(realm.heap(), []() -> WebIDL::ExceptionOr<JS::Value> {
  496. return JS::js_undefined();
  497. });
  498. // 17. Set branch1 to ! CreateReadableStream(startAlgorithm, pullAlgorithm, cancel1Algorithm).
  499. params->branch1 = MUST(create_readable_stream(realm, start_algorithm, pull_algorithm, cancel1_algorithm));
  500. // 18. Set branch2 to ! CreateReadableStream(startAlgorithm, pullAlgorithm, cancel2Algorithm).
  501. params->branch2 = MUST(create_readable_stream(realm, start_algorithm, pull_algorithm, cancel2_algorithm));
  502. // 19. Upon rejection of reader.[[closedPromise]] with reason r,
  503. WebIDL::upon_rejection(*reader->closed_promise_capability(), JS::create_heap_function(realm.heap(), [&realm, params, cancel_promise](JS::Value reason) -> WebIDL::ExceptionOr<JS::Value> {
  504. auto controller1 = params->branch1->controller()->get<JS::NonnullGCPtr<ReadableStreamDefaultController>>();
  505. auto controller2 = params->branch2->controller()->get<JS::NonnullGCPtr<ReadableStreamDefaultController>>();
  506. // 1. Perform ! ReadableStreamDefaultControllerError(branch1.[[controller]], r).
  507. readable_stream_default_controller_error(controller1, reason);
  508. // 2. Perform ! ReadableStreamDefaultControllerError(branch2.[[controller]], r).
  509. readable_stream_default_controller_error(controller2, reason);
  510. // 3. If canceled1 is false or canceled2 is false, resolve cancelPromise with undefined.
  511. if (!params->canceled1 || !params->canceled2) {
  512. WebIDL::resolve_promise(realm, cancel_promise, JS::js_undefined());
  513. }
  514. return JS::js_undefined();
  515. }));
  516. // 20. Return « branch1, branch2 ».
  517. return ReadableStreamPair { *params->branch1, *params->branch2 };
  518. }
  519. struct ByteStreamTeeParams final : JS::Cell {
  520. JS_CELL(ByteStreamTeeParams, JS::Cell);
  521. JS_DECLARE_ALLOCATOR(ByteStreamTeeParams);
  522. explicit ByteStreamTeeParams(ReadableStreamReader reader)
  523. : reader(move(reader))
  524. {
  525. }
  526. virtual void visit_edges(Visitor& visitor) override
  527. {
  528. Base::visit_edges(visitor);
  529. visitor.visit(reason1);
  530. visitor.visit(reason2);
  531. visitor.visit(branch1);
  532. visitor.visit(branch2);
  533. visitor.visit(pull1_algorithm);
  534. visitor.visit(pull2_algorithm);
  535. reader.visit([&](auto const& underlying_reader) { visitor.visit(underlying_reader); });
  536. }
  537. bool reading { false };
  538. bool read_again_for_branch1 { false };
  539. bool read_again_for_branch2 { false };
  540. bool canceled1 { false };
  541. bool canceled2 { false };
  542. JS::Value reason1 { JS::js_undefined() };
  543. JS::Value reason2 { JS::js_undefined() };
  544. JS::GCPtr<ReadableStream> branch1;
  545. JS::GCPtr<ReadableStream> branch2;
  546. JS::GCPtr<PullAlgorithm> pull1_algorithm;
  547. JS::GCPtr<PullAlgorithm> pull2_algorithm;
  548. ReadableStreamReader reader;
  549. };
  550. JS_DEFINE_ALLOCATOR(ByteStreamTeeParams);
  551. // https://streams.spec.whatwg.org/#ref-for-read-request④
  552. class ByteStreamTeeDefaultReadRequest final : public ReadRequest {
  553. JS_CELL(ByteStreamTeeDefaultReadRequest, ReadRequest);
  554. JS_DECLARE_ALLOCATOR(ByteStreamTeeDefaultReadRequest);
  555. public:
  556. ByteStreamTeeDefaultReadRequest(
  557. JS::Realm& realm,
  558. JS::NonnullGCPtr<ReadableStream> stream,
  559. JS::NonnullGCPtr<ByteStreamTeeParams> params,
  560. JS::NonnullGCPtr<WebIDL::Promise> cancel_promise)
  561. : m_realm(realm)
  562. , m_stream(stream)
  563. , m_params(params)
  564. , m_cancel_promise(cancel_promise)
  565. {
  566. }
  567. // https://streams.spec.whatwg.org/#ref-for-read-request-chunk-steps④
  568. virtual void on_chunk(JS::Value chunk) override
  569. {
  570. // 1. Queue a microtask to perform the following steps:
  571. HTML::queue_a_microtask(nullptr, JS::create_heap_function(m_realm->heap(), [this, chunk]() mutable {
  572. HTML::TemporaryExecutionContext execution_context { Bindings::host_defined_environment_settings_object(m_realm) };
  573. auto controller1 = m_params->branch1->controller()->get<JS::NonnullGCPtr<ReadableByteStreamController>>();
  574. auto controller2 = m_params->branch2->controller()->get<JS::NonnullGCPtr<ReadableByteStreamController>>();
  575. // 1. Set readAgainForBranch1 to false.
  576. m_params->read_again_for_branch1 = false;
  577. // 2. Set readAgainForBranch2 to false.
  578. m_params->read_again_for_branch2 = false;
  579. // 3. Let chunk1 and chunk2 be chunk.
  580. auto chunk1 = chunk;
  581. auto chunk2 = chunk;
  582. // 4. If canceled1 is false and canceled2 is false,
  583. if (!m_params->canceled1 && !m_params->canceled2) {
  584. // 1. Let cloneResult be CloneAsUint8Array(chunk).
  585. auto chunk_view = m_realm->vm().heap().allocate<WebIDL::ArrayBufferView>(m_realm, chunk.as_object());
  586. auto clone_result = clone_as_uint8_array(m_realm, chunk_view);
  587. // 2. If cloneResult is an abrupt completion,
  588. if (clone_result.is_exception()) {
  589. auto completion = Bindings::dom_exception_to_throw_completion(m_realm->vm(), clone_result.release_error());
  590. // 1. Perform ! ReadableByteStreamControllerError(branch1.[[controller]], cloneResult.[[Value]]).
  591. readable_byte_stream_controller_error(controller1, completion.value().value());
  592. // 2. Perform ! ReadableByteStreamControllerError(branch2.[[controller]], cloneResult.[[Value]]).
  593. readable_byte_stream_controller_error(controller2, completion.value().value());
  594. // 3. Resolve cancelPromise with ! ReadableStreamCancel(stream, cloneResult.[[Value]]).
  595. auto cancel_result = readable_stream_cancel(m_stream, completion.value().value());
  596. JS::NonnullGCPtr cancel_value = verify_cast<JS::Promise>(*cancel_result->promise().ptr());
  597. WebIDL::resolve_promise(m_realm, m_cancel_promise, cancel_value);
  598. // 4. Return.
  599. return;
  600. }
  601. // 3. Otherwise, set chunk2 to cloneResult.[[Value]].
  602. chunk2 = clone_result.release_value();
  603. }
  604. // 5. If canceled1 is false, perform ! ReadableByteStreamControllerEnqueue(branch1.[[controller]], chunk1).
  605. if (!m_params->canceled1) {
  606. MUST(readable_byte_stream_controller_enqueue(controller1, chunk1));
  607. }
  608. // 6. If canceled2 is false, perform ! ReadableByteStreamControllerEnqueue(branch2.[[controller]], chunk2).
  609. if (!m_params->canceled2) {
  610. MUST(readable_byte_stream_controller_enqueue(controller2, chunk2));
  611. }
  612. // 7. Set reading to false.
  613. m_params->reading = false;
  614. // 8. If readAgainForBranch1 is true, perform pull1Algorithm.
  615. if (m_params->read_again_for_branch1) {
  616. m_params->pull1_algorithm->function()();
  617. }
  618. // 9. Otherwise, if readAgainForBranch2 is true, perform pull2Algorithm.
  619. else if (m_params->read_again_for_branch2) {
  620. m_params->pull2_algorithm->function()();
  621. }
  622. }));
  623. // NOTE: The microtask delay here is necessary because it takes at least a microtask to detect errors, when we
  624. // use reader.[[closedPromise]] below. We want errors in stream to error both branches immediately, so we
  625. // cannot let successful synchronously-available reads happen ahead of asynchronously-available errors.
  626. }
  627. // https://streams.spec.whatwg.org/#ref-for-read-request-close-steps③
  628. virtual void on_close() override
  629. {
  630. auto controller1 = m_params->branch1->controller()->get<JS::NonnullGCPtr<ReadableByteStreamController>>();
  631. auto controller2 = m_params->branch2->controller()->get<JS::NonnullGCPtr<ReadableByteStreamController>>();
  632. // 1. Set reading to false.
  633. m_params->reading = false;
  634. // 2. If canceled1 is false, perform ! ReadableByteStreamControllerClose(branch1.[[controller]]).
  635. if (!m_params->canceled1) {
  636. MUST(readable_byte_stream_controller_close(controller1));
  637. }
  638. // 3. If canceled2 is false, perform ! ReadableByteStreamControllerClose(branch2.[[controller]]).
  639. if (!m_params->canceled2) {
  640. MUST(readable_byte_stream_controller_close(controller2));
  641. }
  642. // 4. If branch1.[[controller]].[[pendingPullIntos]] is not empty, perform ! ReadableByteStreamControllerRespond(branch1.[[controller]], 0).
  643. if (!controller1->pending_pull_intos().is_empty()) {
  644. MUST(readable_byte_stream_controller_respond(controller1, 0));
  645. }
  646. // 5. If branch2.[[controller]].[[pendingPullIntos]] is not empty, perform ! ReadableByteStreamControllerRespond(branch2.[[controller]], 0).
  647. if (!controller2->pending_pull_intos().is_empty()) {
  648. MUST(readable_byte_stream_controller_respond(controller2, 0));
  649. }
  650. // 6. If canceled1 is false or canceled2 is false, resolve cancelPromise with undefined.
  651. if (!m_params->canceled1 || !m_params->canceled2) {
  652. WebIDL::resolve_promise(m_realm, m_cancel_promise, JS::js_undefined());
  653. }
  654. }
  655. // https://streams.spec.whatwg.org/#ref-for-read-request-error-steps④
  656. virtual void on_error(JS::Value) override
  657. {
  658. // 1. Set reading to false.
  659. m_params->reading = false;
  660. }
  661. private:
  662. virtual void visit_edges(Visitor& visitor) override
  663. {
  664. Base::visit_edges(visitor);
  665. visitor.visit(m_realm);
  666. visitor.visit(m_stream);
  667. visitor.visit(m_params);
  668. visitor.visit(m_cancel_promise);
  669. }
  670. JS::NonnullGCPtr<JS::Realm> m_realm;
  671. JS::NonnullGCPtr<ReadableStream> m_stream;
  672. JS::NonnullGCPtr<ByteStreamTeeParams> m_params;
  673. JS::NonnullGCPtr<WebIDL::Promise> m_cancel_promise;
  674. };
  675. JS_DEFINE_ALLOCATOR(ByteStreamTeeDefaultReadRequest);
  676. // https://streams.spec.whatwg.org/#ref-for-read-into-request②
  677. class ByteStreamTeeBYOBReadRequest final : public ReadIntoRequest {
  678. JS_CELL(ByteStreamTeeBYOBReadRequest, ReadIntoRequest);
  679. JS_DECLARE_ALLOCATOR(ByteStreamTeeBYOBReadRequest);
  680. public:
  681. ByteStreamTeeBYOBReadRequest(
  682. JS::Realm& realm,
  683. JS::NonnullGCPtr<ReadableStream> stream,
  684. JS::NonnullGCPtr<ByteStreamTeeParams> params,
  685. JS::NonnullGCPtr<WebIDL::Promise> cancel_promise,
  686. JS::NonnullGCPtr<ReadableStream> byob_branch,
  687. JS::NonnullGCPtr<ReadableStream> other_branch,
  688. bool for_branch2)
  689. : m_realm(realm)
  690. , m_stream(stream)
  691. , m_params(params)
  692. , m_cancel_promise(cancel_promise)
  693. , m_byob_branch(byob_branch)
  694. , m_other_branch(other_branch)
  695. , m_for_branch2(for_branch2)
  696. {
  697. }
  698. // https://streams.spec.whatwg.org/#ref-for-read-into-request-chunk-steps①
  699. virtual void on_chunk(JS::Value chunk) override
  700. {
  701. auto chunk_view = m_realm->vm().heap().allocate<WebIDL::ArrayBufferView>(m_realm, chunk.as_object());
  702. // 1. Queue a microtask to perform the following steps:
  703. HTML::queue_a_microtask(nullptr, JS::create_heap_function(m_realm->heap(), [this, chunk = chunk_view]() {
  704. HTML::TemporaryExecutionContext execution_context { Bindings::host_defined_environment_settings_object(m_realm) };
  705. auto byob_controller = m_byob_branch->controller()->get<JS::NonnullGCPtr<ReadableByteStreamController>>();
  706. auto other_controller = m_other_branch->controller()->get<JS::NonnullGCPtr<ReadableByteStreamController>>();
  707. // 1. Set readAgainForBranch1 to false.
  708. m_params->read_again_for_branch1 = false;
  709. // 2. Set readAgainForBranch2 to false.
  710. m_params->read_again_for_branch2 = false;
  711. // 3. Let byobCanceled be canceled2 if forBranch2 is true, and canceled1 otherwise.
  712. auto byob_cancelled = m_for_branch2 ? m_params->canceled2 : m_params->canceled1;
  713. // 4. Let otherCanceled be canceled2 if forBranch2 is false, and canceled1 otherwise.
  714. auto other_cancelled = !m_for_branch2 ? m_params->canceled2 : m_params->canceled1;
  715. // 5. If otherCanceled is false,
  716. if (!other_cancelled) {
  717. // 1. Let cloneResult be CloneAsUint8Array(chunk).
  718. auto clone_result = clone_as_uint8_array(m_realm, chunk);
  719. // 2. If cloneResult is an abrupt completion,
  720. if (clone_result.is_exception()) {
  721. auto completion = Bindings::dom_exception_to_throw_completion(m_realm->vm(), clone_result.release_error());
  722. // 1. Perform ! ReadableByteStreamControllerError(byobBranch.[[controller]], cloneResult.[[Value]]).
  723. readable_byte_stream_controller_error(byob_controller, completion.value().value());
  724. // 2. Perform ! ReadableByteStreamControllerError(otherBranch.[[controller]], cloneResult.[[Value]]).
  725. readable_byte_stream_controller_error(other_controller, completion.value().value());
  726. // 3. Resolve cancelPromise with ! ReadableStreamCancel(stream, cloneResult.[[Value]]).
  727. auto cancel_result = readable_stream_cancel(m_stream, completion.value().value());
  728. JS::NonnullGCPtr cancel_value = verify_cast<JS::Promise>(*cancel_result->promise().ptr());
  729. WebIDL::resolve_promise(m_realm, m_cancel_promise, cancel_value);
  730. // 4. Return.
  731. return;
  732. }
  733. // 3. Otherwise, let clonedChunk be cloneResult.[[Value]].
  734. auto cloned_chunk = clone_result.release_value();
  735. // 4. If byobCanceled is false, perform ! ReadableByteStreamControllerRespondWithNewView(byobBranch.[[controller]], chunk).
  736. if (!byob_cancelled) {
  737. MUST(readable_byte_stream_controller_respond_with_new_view(m_realm, byob_controller, chunk));
  738. }
  739. // 5. Perform ! ReadableByteStreamControllerEnqueue(otherBranch.[[controller]], clonedChunk).
  740. MUST(readable_byte_stream_controller_enqueue(other_controller, cloned_chunk));
  741. }
  742. // 6. Otherwise, if byobCanceled is false, perform ! ReadableByteStreamControllerRespondWithNewView(byobBranch.[[controller]], chunk).
  743. else if (!byob_cancelled) {
  744. MUST(readable_byte_stream_controller_respond_with_new_view(m_realm, byob_controller, chunk));
  745. }
  746. // 7. Set reading to false.
  747. m_params->reading = false;
  748. // 8. If readAgainForBranch1 is true, perform pull1Algorithm.
  749. if (m_params->read_again_for_branch1) {
  750. m_params->pull1_algorithm->function()();
  751. }
  752. // 9. Otherwise, if readAgainForBranch2 is true, perform pull2Algorithm.
  753. else if (m_params->read_again_for_branch2) {
  754. m_params->pull2_algorithm->function()();
  755. }
  756. }));
  757. // NOTE: The microtask delay here is necessary because it takes at least a microtask to detect errors, when we
  758. // use reader.[[closedPromise]] below. We want errors in stream to error both branches immediately, so we
  759. // cannot let successful synchronously-available reads happen ahead of asynchronously-available errors.
  760. }
  761. // https://streams.spec.whatwg.org/#ref-for-read-into-request-close-steps②
  762. virtual void on_close(JS::Value chunk) override
  763. {
  764. auto byob_controller = m_byob_branch->controller()->get<JS::NonnullGCPtr<ReadableByteStreamController>>();
  765. auto other_controller = m_other_branch->controller()->get<JS::NonnullGCPtr<ReadableByteStreamController>>();
  766. // 1. Set reading to false.
  767. m_params->reading = false;
  768. // 2. Let byobCanceled be canceled2 if forBranch2 is true, and canceled1 otherwise.
  769. auto byob_cancelled = m_for_branch2 ? m_params->canceled2 : m_params->canceled1;
  770. // 3. Let otherCanceled be canceled2 if forBranch2 is false, and canceled1 otherwise.
  771. auto other_cancelled = !m_for_branch2 ? m_params->canceled2 : m_params->canceled1;
  772. // 4. If byobCanceled is false, perform ! ReadableByteStreamControllerClose(byobBranch.[[controller]]).
  773. if (!byob_cancelled) {
  774. MUST(readable_byte_stream_controller_close(byob_controller));
  775. }
  776. // 5. If otherCanceled is false, perform ! ReadableByteStreamControllerClose(otherBranch.[[controller]]).
  777. if (!other_cancelled) {
  778. MUST(readable_byte_stream_controller_close(other_controller));
  779. }
  780. // 6. If chunk is not undefined,
  781. if (!chunk.is_undefined()) {
  782. // 1. Assert: chunk.[[ByteLength]] is 0.
  783. // 2. If byobCanceled is false, perform ! ReadableByteStreamControllerRespondWithNewView(byobBranch.[[controller]], chunk).
  784. if (!byob_cancelled) {
  785. auto array_buffer_view = m_realm->vm().heap().allocate<WebIDL::ArrayBufferView>(m_realm, chunk.as_object());
  786. MUST(readable_byte_stream_controller_respond_with_new_view(m_realm, byob_controller, array_buffer_view));
  787. }
  788. // 3. If otherCanceled is false and otherBranch.[[controller]].[[pendingPullIntos]] is not empty,
  789. // perform ! ReadableByteStreamControllerRespond(otherBranch.[[controller]], 0).
  790. if (!other_cancelled && !other_controller->pending_pull_intos().is_empty()) {
  791. MUST(readable_byte_stream_controller_respond(other_controller, 0));
  792. }
  793. }
  794. // 7. If byobCanceled is false or otherCanceled is false, resolve cancelPromise with undefined.
  795. if (!byob_cancelled || !other_cancelled) {
  796. WebIDL::resolve_promise(m_realm, m_cancel_promise, JS::js_undefined());
  797. }
  798. }
  799. // https://streams.spec.whatwg.org/#ref-for-read-into-request-error-steps①
  800. virtual void on_error(JS::Value) override
  801. {
  802. // 1. Set reading to false.
  803. m_params->reading = false;
  804. }
  805. private:
  806. virtual void visit_edges(Visitor& visitor) override
  807. {
  808. Base::visit_edges(visitor);
  809. visitor.visit(m_realm);
  810. visitor.visit(m_stream);
  811. visitor.visit(m_params);
  812. visitor.visit(m_cancel_promise);
  813. visitor.visit(m_byob_branch);
  814. visitor.visit(m_other_branch);
  815. }
  816. JS::NonnullGCPtr<JS::Realm> m_realm;
  817. JS::NonnullGCPtr<ReadableStream> m_stream;
  818. JS::NonnullGCPtr<ByteStreamTeeParams> m_params;
  819. JS::NonnullGCPtr<WebIDL::Promise> m_cancel_promise;
  820. JS::NonnullGCPtr<ReadableStream> m_byob_branch;
  821. JS::NonnullGCPtr<ReadableStream> m_other_branch;
  822. bool m_for_branch2 { false };
  823. };
  824. JS_DEFINE_ALLOCATOR(ByteStreamTeeBYOBReadRequest);
  825. // https://streams.spec.whatwg.org/#abstract-opdef-readablebytestreamtee
  826. WebIDL::ExceptionOr<ReadableStreamPair> readable_byte_stream_tee(JS::Realm& realm, ReadableStream& stream)
  827. {
  828. // 1. Assert: stream implements ReadableStream.
  829. // 2. Assert: stream.[[controller]] implements ReadableByteStreamController.
  830. VERIFY(stream.controller().has_value() && stream.controller()->has<JS::NonnullGCPtr<ReadableByteStreamController>>());
  831. // 3. Let reader be ? AcquireReadableStreamDefaultReader(stream).
  832. auto reader = TRY(acquire_readable_stream_default_reader(stream));
  833. // 4. Let reading be false.
  834. // 5. Let readAgainForBranch1 be false.
  835. // 6. Let readAgainForBranch2 be false.
  836. // 7. Let canceled1 be false.
  837. // 8. Let canceled2 be false.
  838. // 9. Let reason1 be undefined.
  839. // 10. Let reason2 be undefined.
  840. // 11. Let branch1 be undefined.
  841. // 12. Let branch2 be undefined.
  842. auto params = realm.heap().allocate<ByteStreamTeeParams>(realm, reader);
  843. // 13. Let cancelPromise be a new promise.
  844. auto cancel_promise = WebIDL::create_promise(realm);
  845. // 14. Let forwardReaderError be the following steps, taking a thisReader argument:
  846. auto forward_reader_error = JS::create_heap_function(realm.heap(), [&realm, params, cancel_promise](ReadableStreamReader const& this_reader) {
  847. // 1. Upon rejection of thisReader.[[closedPromise]] with reason r,
  848. auto closed_promise = this_reader.visit([](auto const& underlying_reader) { return underlying_reader->closed_promise_capability(); });
  849. WebIDL::upon_rejection(*closed_promise, JS::create_heap_function(realm.heap(), [&realm, this_reader, params, cancel_promise](JS::Value reason) -> WebIDL::ExceptionOr<JS::Value> {
  850. auto controller1 = params->branch1->controller()->get<JS::NonnullGCPtr<ReadableByteStreamController>>();
  851. auto controller2 = params->branch2->controller()->get<JS::NonnullGCPtr<ReadableByteStreamController>>();
  852. // 1. If thisReader is not reader, return.
  853. if (this_reader != params->reader) {
  854. return JS::js_undefined();
  855. }
  856. // 2. Perform ! ReadableByteStreamControllerError(branch1.[[controller]], r).
  857. readable_byte_stream_controller_error(controller1, reason);
  858. // 3. Perform ! ReadableByteStreamControllerError(branch2.[[controller]], r).
  859. readable_byte_stream_controller_error(controller2, reason);
  860. // 4. If canceled1 is false or canceled2 is false, resolve cancelPromise with undefined.
  861. if (!params->canceled1 || !params->canceled2) {
  862. WebIDL::resolve_promise(realm, cancel_promise, JS::js_undefined());
  863. }
  864. return JS::js_undefined();
  865. }));
  866. });
  867. // 15. Let pullWithDefaultReader be the following steps:
  868. auto pull_with_default_reader = JS::create_heap_function(realm.heap(), [&realm, &stream, params, cancel_promise, forward_reader_error]() mutable {
  869. // 1. If reader implements ReadableStreamBYOBReader,
  870. if (auto const* byob_reader = params->reader.get_pointer<JS::NonnullGCPtr<ReadableStreamBYOBReader>>()) {
  871. // 1. Assert: reader.[[readIntoRequests]] is empty.
  872. VERIFY((*byob_reader)->read_into_requests().is_empty());
  873. // 2. Perform ! ReadableStreamBYOBReaderRelease(reader).
  874. readable_stream_byob_reader_release(*byob_reader);
  875. // 3. Set reader to ! AcquireReadableStreamDefaultReader(stream).
  876. params->reader = MUST(acquire_readable_stream_default_reader(stream));
  877. // 4. Perform forwardReaderError, given reader.
  878. forward_reader_error->function()(params->reader);
  879. }
  880. // 2. Let readRequest be a read request with the following items:
  881. auto read_request = realm.heap().allocate_without_realm<ByteStreamTeeDefaultReadRequest>(realm, stream, params, cancel_promise);
  882. // 3. Perform ! ReadableStreamDefaultReaderRead(reader, readRequest).
  883. readable_stream_default_reader_read(params->reader.get<JS::NonnullGCPtr<ReadableStreamDefaultReader>>(), read_request);
  884. });
  885. // 16. Let pullWithBYOBReader be the following steps, given view and forBranch2:
  886. auto pull_with_byob_reader = JS::create_heap_function(realm.heap(), [&realm, &stream, params, cancel_promise, forward_reader_error](JS::NonnullGCPtr<WebIDL::ArrayBufferView> view, bool for_branch2) mutable {
  887. // 1. If reader implements ReadableStreamDefaultReader,
  888. if (auto const* default_reader = params->reader.get_pointer<JS::NonnullGCPtr<ReadableStreamDefaultReader>>()) {
  889. // 2. Assert: reader.[[readRequests]] is empty.
  890. VERIFY((*default_reader)->read_requests().is_empty());
  891. // 3. Perform ! ReadableStreamDefaultReaderRelease(reader).
  892. readable_stream_default_reader_release(*default_reader);
  893. // 4. Set reader to ! AcquireReadableStreamBYOBReader(stream).
  894. params->reader = MUST(acquire_readable_stream_byob_reader(stream));
  895. // 5. Perform forwardReaderError, given reader.
  896. forward_reader_error->function()(params->reader);
  897. };
  898. // 2. Let byobBranch be branch2 if forBranch2 is true, and branch1 otherwise.
  899. auto byob_branch = for_branch2 ? params->branch2 : params->branch1;
  900. // 3. Let otherBranch be branch2 if forBranch2 is false, and branch1 otherwise.
  901. auto other_branch = !for_branch2 ? params->branch2 : params->branch1;
  902. // 4. Let readIntoRequest be a read-into request with the following items:
  903. auto read_into_request = realm.heap().allocate_without_realm<ByteStreamTeeBYOBReadRequest>(realm, stream, params, cancel_promise, *byob_branch, *other_branch, for_branch2);
  904. // 5. Perform ! ReadableStreamBYOBReaderRead(reader, view, 1, readIntoRequest).
  905. readable_stream_byob_reader_read(params->reader.get<JS::NonnullGCPtr<ReadableStreamBYOBReader>>(), view, read_into_request);
  906. });
  907. // 17. Let pull1Algorithm be the following steps:
  908. auto pull1_algorithm = JS::create_heap_function(realm.heap(), [&realm, params, pull_with_default_reader, pull_with_byob_reader]() {
  909. auto controller1 = params->branch1->controller()->get<JS::NonnullGCPtr<ReadableByteStreamController>>();
  910. // 1. If reading is true,
  911. if (params->reading) {
  912. // 1. Set readAgainForBranch1 to true.
  913. params->read_again_for_branch1 = true;
  914. // 2. Return a promise resolved with undefined.
  915. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  916. }
  917. // 2. Set reading to true.
  918. params->reading = true;
  919. // 3. Let byobRequest be ! ReadableByteStreamControllerGetBYOBRequest(branch1.[[controller]]).
  920. auto byob_request = readable_byte_stream_controller_get_byob_request(controller1);
  921. // 4. If byobRequest is null, perform pullWithDefaultReader.
  922. if (!byob_request) {
  923. pull_with_default_reader->function()();
  924. }
  925. // 5. Otherwise, perform pullWithBYOBReader, given byobRequest.[[view]] and false.
  926. else {
  927. pull_with_byob_reader->function()(*byob_request->view(), false);
  928. }
  929. // 6. Return a promise resolved with undefined.
  930. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  931. });
  932. // 18. Let pull2Algorithm be the following steps:
  933. auto pull2_algorithm = JS::create_heap_function(realm.heap(), [&realm, params, pull_with_default_reader, pull_with_byob_reader]() {
  934. auto controller2 = params->branch2->controller()->get<JS::NonnullGCPtr<ReadableByteStreamController>>();
  935. // 1. If reading is true,
  936. if (params->reading) {
  937. // 1. Set readAgainForBranch2 to true.
  938. params->read_again_for_branch2 = true;
  939. // 2. Return a promise resolved with undefined.
  940. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  941. }
  942. // 2. Set reading to true.
  943. params->reading = true;
  944. // 3. Let byobRequest be ! ReadableByteStreamControllerGetBYOBRequest(branch2.[[controller]]).
  945. auto byob_request = readable_byte_stream_controller_get_byob_request(controller2);
  946. // 4. If byobRequest is null, perform pullWithDefaultReader.
  947. if (!byob_request) {
  948. pull_with_default_reader->function()();
  949. }
  950. // 5. Otherwise, perform pullWithBYOBReader, given byobRequest.[[view]] and true.
  951. else {
  952. pull_with_byob_reader->function()(*byob_request->view(), true);
  953. }
  954. // 6. Return a promise resolved with undefined.
  955. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  956. });
  957. // AD-HOC: The read requests within the pull algorithms must be able to re-invoke the pull algorithms, so cache them here.
  958. params->pull1_algorithm = pull1_algorithm;
  959. params->pull2_algorithm = pull2_algorithm;
  960. // 19. Let cancel1Algorithm be the following steps, taking a reason argument:
  961. auto cancel1_algorithm = JS::create_heap_function(realm.heap(), [&realm, &stream, params, cancel_promise](JS::Value reason) {
  962. // 1. Set canceled1 to true.
  963. params->canceled1 = true;
  964. // 2. Set reason1 to reason.
  965. params->reason1 = reason;
  966. // 3. If canceled2 is true,
  967. if (params->canceled2) {
  968. // 1. Let compositeReason be ! CreateArrayFromList(« reason1, reason2 »).
  969. auto composite_reason = JS::Array::create_from(realm, AK::Array { params->reason1, params->reason2 });
  970. // 2. Let cancelResult be ! ReadableStreamCancel(stream, compositeReason).
  971. auto cancel_result = readable_stream_cancel(stream, composite_reason);
  972. // 3. Resolve cancelPromise with cancelResult.
  973. JS::NonnullGCPtr cancel_value = verify_cast<JS::Promise>(*cancel_result->promise().ptr());
  974. WebIDL::resolve_promise(realm, cancel_promise, cancel_value);
  975. }
  976. // 4. Return cancelPromise.
  977. return cancel_promise;
  978. });
  979. // 20. Let cancel2Algorithm be the following steps, taking a reason argument:
  980. auto cancel2_algorithm = JS::create_heap_function(realm.heap(), [&realm, &stream, params, cancel_promise](JS::Value reason) {
  981. // 1. Set canceled2 to true.
  982. params->canceled2 = true;
  983. // 2. Set reason2 to reason.
  984. params->reason2 = reason;
  985. // 3. If canceled1 is true,
  986. if (params->canceled1) {
  987. // 1. Let compositeReason be ! CreateArrayFromList(« reason1, reason2 »).
  988. auto composite_reason = JS::Array::create_from(realm, AK::Array { params->reason1, params->reason2 });
  989. // 2. Let cancelResult be ! ReadableStreamCancel(stream, compositeReason).
  990. auto cancel_result = readable_stream_cancel(stream, composite_reason);
  991. // 3. Resolve cancelPromise with cancelResult.
  992. JS::NonnullGCPtr cancel_value = verify_cast<JS::Promise>(*cancel_result->promise().ptr());
  993. WebIDL::resolve_promise(realm, cancel_promise, cancel_value);
  994. }
  995. // 4. Return cancelPromise.
  996. return cancel_promise;
  997. });
  998. // 21. Let startAlgorithm be an algorithm that returns undefined.
  999. auto start_algorithm = JS::create_heap_function(realm.heap(), []() -> WebIDL::ExceptionOr<JS::Value> {
  1000. return JS::js_undefined();
  1001. });
  1002. // 22. Set branch1 to ! CreateReadableByteStream(startAlgorithm, pull1Algorithm, cancel1Algorithm).
  1003. params->branch1 = MUST(create_readable_byte_stream(realm, start_algorithm, pull1_algorithm, cancel1_algorithm));
  1004. // 23. Set branch2 to ! CreateReadableByteStream(startAlgorithm, pull2Algorithm, cancel2Algorithm).
  1005. params->branch2 = MUST(create_readable_byte_stream(realm, start_algorithm, pull2_algorithm, cancel2_algorithm));
  1006. // 24. Perform forwardReaderError, given reader.
  1007. forward_reader_error->function()(reader);
  1008. // 25. Return « branch1, branch2 ».
  1009. return ReadableStreamPair { *params->branch1, *params->branch2 };
  1010. }
  1011. // https://streams.spec.whatwg.org/#make-size-algorithm-from-size-function
  1012. JS::NonnullGCPtr<SizeAlgorithm> extract_size_algorithm(JS::VM& vm, QueuingStrategy const& strategy)
  1013. {
  1014. // 1. If strategy["size"] does not exist, return an algorithm that returns 1.
  1015. if (!strategy.size)
  1016. return JS::create_heap_function(vm.heap(), [](JS::Value) { return JS::normal_completion(JS::Value(1)); });
  1017. // 2. Return an algorithm that performs the following steps, taking a chunk argument:
  1018. return JS::create_heap_function(vm.heap(), [size = strategy.size](JS::Value chunk) {
  1019. return WebIDL::invoke_callback(*size, JS::js_undefined(), chunk);
  1020. });
  1021. }
  1022. // https://streams.spec.whatwg.org/#validate-and-normalize-high-water-mark
  1023. WebIDL::ExceptionOr<double> extract_high_water_mark(QueuingStrategy const& strategy, double default_hwm)
  1024. {
  1025. // 1. If strategy["highWaterMark"] does not exist, return defaultHWM.
  1026. if (!strategy.high_water_mark.has_value())
  1027. return default_hwm;
  1028. // 2. Let highWaterMark be strategy["highWaterMark"].
  1029. auto high_water_mark = strategy.high_water_mark.value();
  1030. // 3. If highWaterMark is NaN or highWaterMark < 0, throw a RangeError exception.
  1031. if (isnan(high_water_mark) || high_water_mark < 0)
  1032. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::RangeError, "Invalid value for high water mark"sv };
  1033. // 4. Return highWaterMark.
  1034. return high_water_mark;
  1035. }
  1036. // https://streams.spec.whatwg.org/#readable-stream-close
  1037. void readable_stream_close(ReadableStream& stream)
  1038. {
  1039. auto& realm = stream.realm();
  1040. // 1. Assert: stream.[[state]] is "readable".
  1041. VERIFY(stream.state() == ReadableStream::State::Readable);
  1042. // 2. Set stream.[[state]] to "closed".
  1043. stream.set_state(ReadableStream::State::Closed);
  1044. // 3. Let reader be stream.[[reader]].
  1045. auto reader = stream.reader();
  1046. // 4. If reader is undefined, return.
  1047. if (!reader.has_value())
  1048. return;
  1049. // 5. Resolve reader.[[closedPromise]] with undefined.
  1050. WebIDL::resolve_promise(realm, *reader->visit([](auto& reader) {
  1051. return reader->closed_promise_capability();
  1052. }));
  1053. // 6. If reader implements ReadableStreamDefaultReader,
  1054. if (reader->has<JS::NonnullGCPtr<ReadableStreamDefaultReader>>()) {
  1055. // 1. Let readRequests be reader.[[readRequests]].
  1056. // 2. Set reader.[[readRequests]] to an empty list.
  1057. auto read_requests = move(reader->get<JS::NonnullGCPtr<ReadableStreamDefaultReader>>()->read_requests());
  1058. // 3. For each readRequest of readRequests,
  1059. for (auto& read_request : read_requests) {
  1060. // 1. Perform readRequest’s close steps.
  1061. read_request->on_close();
  1062. }
  1063. }
  1064. }
  1065. // https://streams.spec.whatwg.org/#readable-stream-error
  1066. void readable_stream_error(ReadableStream& stream, JS::Value error)
  1067. {
  1068. auto& realm = stream.realm();
  1069. // 1. Assert: stream.[[state]] is "readable".
  1070. VERIFY(stream.state() == ReadableStream::State::Readable);
  1071. // 2. Set stream.[[state]] to "errored".
  1072. stream.set_state(ReadableStream::State::Errored);
  1073. // 3. Set stream.[[storedError]] to e.
  1074. stream.set_stored_error(error);
  1075. // 4. Let reader be stream.[[reader]].
  1076. auto reader = stream.reader();
  1077. // 5. If reader is undefined, return.
  1078. if (!reader.has_value())
  1079. return;
  1080. auto closed_promise_capability = reader->visit([](auto& reader) { return reader->closed_promise_capability(); });
  1081. // 6. Reject reader.[[closedPromise]] with e.
  1082. WebIDL::reject_promise(realm, *closed_promise_capability, error);
  1083. // 7. Set reader.[[closedPromise]].[[PromiseIsHandled]] to true.
  1084. WebIDL::mark_promise_as_handled(*closed_promise_capability);
  1085. // 8. If reader implements ReadableStreamDefaultReader,
  1086. if (reader->has<JS::NonnullGCPtr<ReadableStreamDefaultReader>>()) {
  1087. // 1. Perform ! ReadableStreamDefaultReaderErrorReadRequests(reader, e).
  1088. readable_stream_default_reader_error_read_requests(*reader->get<JS::NonnullGCPtr<ReadableStreamDefaultReader>>(), error);
  1089. }
  1090. // 9. Otherwise,
  1091. else {
  1092. // 1. Assert: reader implements ReadableStreamBYOBReader.
  1093. VERIFY(reader->has<JS::NonnullGCPtr<ReadableStreamBYOBReader>>());
  1094. // 2. Perform ! ReadableStreamBYOBReaderErrorReadIntoRequests(reader, e).
  1095. readable_stream_byob_reader_error_read_into_requests(*reader->get<JS::NonnullGCPtr<ReadableStreamBYOBReader>>(), error);
  1096. }
  1097. }
  1098. // https://streams.spec.whatwg.org/#readable-stream-add-read-request
  1099. void readable_stream_add_read_request(ReadableStream& stream, JS::NonnullGCPtr<ReadRequest> read_request)
  1100. {
  1101. // 1. Assert: stream.[[reader]] implements ReadableStreamDefaultReader.
  1102. VERIFY(stream.reader().has_value() && stream.reader()->has<JS::NonnullGCPtr<ReadableStreamDefaultReader>>());
  1103. // 2. Assert: stream.[[state]] is "readable".
  1104. VERIFY(stream.state() == ReadableStream::State::Readable);
  1105. // 3. Append readRequest to stream.[[reader]].[[readRequests]].
  1106. stream.reader()->get<JS::NonnullGCPtr<ReadableStreamDefaultReader>>()->read_requests().append(read_request);
  1107. }
  1108. // https://streams.spec.whatwg.org/#readable-stream-add-read-into-request
  1109. void readable_stream_add_read_into_request(ReadableStream& stream, JS::NonnullGCPtr<ReadIntoRequest> read_into_request)
  1110. {
  1111. // 1. Assert: stream.[[reader]] implements ReadableStreamBYOBReader.
  1112. VERIFY(stream.reader().has_value() && stream.reader()->has<JS::NonnullGCPtr<ReadableStreamBYOBReader>>());
  1113. // 2. Assert: stream.[[state]] is "readable" or "closed".
  1114. VERIFY(stream.is_readable() || stream.is_closed());
  1115. // 3. Append readRequest to stream.[[reader]].[[readIntoRequests]].
  1116. stream.reader()->get<JS::NonnullGCPtr<ReadableStreamBYOBReader>>()->read_into_requests().append(read_into_request);
  1117. }
  1118. // https://streams.spec.whatwg.org/#readable-stream-reader-generic-cancel
  1119. JS::NonnullGCPtr<WebIDL::Promise> readable_stream_reader_generic_cancel(ReadableStreamGenericReaderMixin& reader, JS::Value reason)
  1120. {
  1121. // 1. Let stream be reader.[[stream]]
  1122. auto stream = reader.stream();
  1123. // 2. Assert: stream is not undefined
  1124. VERIFY(stream);
  1125. // 3. Return ! ReadableStreamCancel(stream, reason)
  1126. return readable_stream_cancel(*stream, reason);
  1127. }
  1128. // https://streams.spec.whatwg.org/#readable-stream-reader-generic-initialize
  1129. void readable_stream_reader_generic_initialize(ReadableStreamReader reader, ReadableStream& stream)
  1130. {
  1131. auto& realm = stream.realm();
  1132. // 1. Set reader.[[stream]] to stream.
  1133. reader.visit([&](auto& reader) { reader->set_stream(stream); });
  1134. // 2. Set stream.[[reader]] to reader.
  1135. stream.set_reader(reader);
  1136. // 3. If stream.[[state]] is "readable",
  1137. if (stream.state() == ReadableStream::State::Readable) {
  1138. // 1. Set reader.[[closedPromise]] to a new promise.
  1139. reader.visit([&](auto& reader) { reader->set_closed_promise_capability(WebIDL::create_promise(realm)); });
  1140. }
  1141. // 4. Otherwise, if stream.[[state]] is "closed",
  1142. else if (stream.state() == ReadableStream::State::Closed) {
  1143. // 1. Set reader.[[closedPromise]] to a promise resolved with undefined.
  1144. reader.visit([&](auto& reader) {
  1145. reader->set_closed_promise_capability(WebIDL::create_resolved_promise(realm, JS::js_undefined()));
  1146. });
  1147. }
  1148. // 5. Otherwise,
  1149. else {
  1150. // 1. Assert: stream.[[state]] is "errored".
  1151. VERIFY(stream.state() == ReadableStream::State::Errored);
  1152. // 2. Set reader.[[closedPromise]] to a promise rejected with stream.[[storedError]].
  1153. // 3. Set reader.[[closedPromise]].[[PromiseIsHandled]] to true.
  1154. reader.visit([&](auto& reader) {
  1155. reader->set_closed_promise_capability(WebIDL::create_rejected_promise(realm, stream.stored_error()));
  1156. WebIDL::mark_promise_as_handled(*reader->closed_promise_capability());
  1157. });
  1158. }
  1159. }
  1160. // https://streams.spec.whatwg.org/#readable-stream-reader-generic-release
  1161. void readable_stream_reader_generic_release(ReadableStreamGenericReaderMixin& reader)
  1162. {
  1163. // 1. Let stream be reader.[[stream]].
  1164. auto stream = reader.stream();
  1165. // 2. Assert: stream is not undefined.
  1166. VERIFY(stream);
  1167. // 3. Assert: stream.[[reader]] is reader.
  1168. VERIFY(stream->reader()->visit([](auto& reader) -> ReadableStreamGenericReaderMixin* { return reader.ptr(); }) == &reader);
  1169. auto& realm = stream->realm();
  1170. // 4. If stream.[[state]] is "readable", reject reader.[[closedPromise]] with a TypeError exception.
  1171. auto exception = JS::TypeError::create(realm, "Released readable stream"sv);
  1172. if (stream->is_readable()) {
  1173. WebIDL::reject_promise(realm, *reader.closed_promise_capability(), exception);
  1174. }
  1175. // 5. Otherwise, set reader.[[closedPromise]] to a promise rejected with a TypeError exception.
  1176. else {
  1177. reader.set_closed_promise_capability(WebIDL::create_rejected_promise(realm, exception));
  1178. }
  1179. // 6. Set reader.[[closedPromise]].[[PromiseIsHandled]] to true.
  1180. WebIDL::mark_promise_as_handled(*reader.closed_promise_capability());
  1181. // 7. Perform ! stream.[[controller]].[[ReleaseSteps]]().
  1182. stream->controller()->visit([](auto const& controller) { return controller->release_steps(); });
  1183. // 8. Set stream.[[reader]] to undefined.
  1184. stream->set_reader({});
  1185. // 9. Set reader.[[stream]] to undefined.
  1186. reader.set_stream({});
  1187. }
  1188. // https://streams.spec.whatwg.org/#abstract-opdef-readablestreamdefaultreadererrorreadrequests
  1189. void readable_stream_default_reader_error_read_requests(ReadableStreamDefaultReader& reader, JS::Value error)
  1190. {
  1191. // 1. Let readRequests be reader.[[readRequests]].
  1192. auto read_requests = move(reader.read_requests());
  1193. // 2. Set reader.[[readRequests]] to a new empty list.
  1194. reader.read_requests().clear();
  1195. // 3. For each readRequest of readRequests,
  1196. for (auto& read_request : read_requests) {
  1197. // 1. Perform readRequest’s error steps, given e.
  1198. read_request->on_error(error);
  1199. }
  1200. }
  1201. // https://streams.spec.whatwg.org/#abstract-opdef-readablestreambyobreadererrorreadintorequests
  1202. void readable_stream_byob_reader_error_read_into_requests(ReadableStreamBYOBReader& reader, JS::Value error)
  1203. {
  1204. // 1. Let readIntoRequests be reader.[[readIntoRequests]].
  1205. auto read_into_requests = move(reader.read_into_requests());
  1206. // 2. Set reader.[[readIntoRequests]] to a new empty list.
  1207. reader.read_into_requests().clear();
  1208. // 3. For each readIntoRequest of readIntoRequests,
  1209. for (auto& read_into_request : read_into_requests) {
  1210. // 1. Perform readIntoRequest’s error steps, given e.
  1211. read_into_request->on_error(error);
  1212. }
  1213. }
  1214. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-fill-head-pull-into-descriptor
  1215. void readable_byte_stream_controller_fill_head_pull_into_descriptor(ReadableByteStreamController const& controller, u64 size, PullIntoDescriptor& pull_into_descriptor)
  1216. {
  1217. // 1. Assert: either controller.[[pendingPullIntos]] is empty, or controller.[[pendingPullIntos]][0] is pullIntoDescriptor.
  1218. VERIFY(controller.pending_pull_intos().is_empty() || &controller.pending_pull_intos().first() == &pull_into_descriptor);
  1219. // 2. Assert: controller.[[byobRequest]] is null.
  1220. VERIFY(!controller.raw_byob_request());
  1221. // 3. Set pullIntoDescriptor’s bytes filled to bytes filled + size.
  1222. pull_into_descriptor.bytes_filled += size;
  1223. }
  1224. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-fill-pull-into-descriptor-from-queue
  1225. bool readable_byte_stream_controller_fill_pull_into_descriptor_from_queue(ReadableByteStreamController& controller, PullIntoDescriptor& pull_into_descriptor)
  1226. {
  1227. // 1. Let elementSize be pullIntoDescriptor.[[elementSize]].
  1228. auto element_size = pull_into_descriptor.element_size;
  1229. // 2. Let currentAlignedBytes be pullIntoDescriptor’s bytes filled − (pullIntoDescriptor’s bytes filled mod elementSize).
  1230. auto current_aligned_bytes = pull_into_descriptor.bytes_filled - (pull_into_descriptor.bytes_filled % pull_into_descriptor.element_size);
  1231. // 3. Let maxBytesToCopy be min(controller.[[queueTotalSize]], pullIntoDescriptor’s byte length − pullIntoDescriptor’s bytes filled).
  1232. auto max_bytes_to_copy = min(controller.queue_total_size(), pull_into_descriptor.byte_length - pull_into_descriptor.bytes_filled);
  1233. // 4. Let maxBytesFilled be pullIntoDescriptor’s bytes filled + maxBytesToCopy.
  1234. u64 max_bytes_filled = pull_into_descriptor.bytes_filled + max_bytes_to_copy;
  1235. // 5. Let maxAlignedBytes be maxBytesFilled − (maxBytesFilled mod elementSize).
  1236. auto max_aligned_bytes = max_bytes_filled - (max_bytes_filled % element_size);
  1237. // 6. Let totalBytesToCopyRemaining be maxBytesToCopy.
  1238. auto total_bytes_to_copy_remaining = max_bytes_to_copy;
  1239. // 7. Let ready be false.
  1240. bool ready = false;
  1241. // 8. If maxAlignedBytes > currentAlignedBytes,
  1242. if (max_aligned_bytes > current_aligned_bytes) {
  1243. // 1. Set totalBytesToCopyRemaining to maxAlignedBytes − pullIntoDescriptor’s bytes filled.
  1244. total_bytes_to_copy_remaining = max_aligned_bytes - pull_into_descriptor.bytes_filled;
  1245. // 2. Set ready to true.
  1246. ready = true;
  1247. }
  1248. // 9. Let queue be controller.[[queue]].
  1249. auto& queue = controller.queue();
  1250. // 10. While totalBytesToCopyRemaining > 0,
  1251. while (total_bytes_to_copy_remaining > 0) {
  1252. // 1. Let headOfQueue be queue[0].
  1253. auto& head_of_queue = queue.first();
  1254. // 2. Let bytesToCopy be min(totalBytesToCopyRemaining, headOfQueue’s byte length).
  1255. auto bytes_to_copy = min(total_bytes_to_copy_remaining, head_of_queue.byte_length);
  1256. // 3. Let destStart be pullIntoDescriptor’s byte offset + pullIntoDescriptor’s bytes filled.
  1257. auto dest_start = pull_into_descriptor.byte_offset + pull_into_descriptor.bytes_filled;
  1258. // 4. Perform ! CopyDataBlockBytes(pullIntoDescriptor’s buffer.[[ArrayBufferData]], destStart, headOfQueue’s buffer.[[ArrayBufferData]], headOfQueue’s byte offset, bytesToCopy).
  1259. JS::copy_data_block_bytes(pull_into_descriptor.buffer->buffer(), dest_start, head_of_queue.buffer->buffer(), head_of_queue.byte_offset, bytes_to_copy);
  1260. // 5. If headOfQueue’s byte length is bytesToCopy,
  1261. if (head_of_queue.byte_length == bytes_to_copy) {
  1262. // 1. Remove queue[0].
  1263. queue.take_first();
  1264. }
  1265. // 6. Otherwise,
  1266. else {
  1267. // 1. Set headOfQueue’s byte offset to headOfQueue’s byte offset + bytesToCopy.
  1268. head_of_queue.byte_offset += bytes_to_copy;
  1269. // 2. Set headOfQueue’s byte length to headOfQueue’s byte length − bytesToCopy.
  1270. head_of_queue.byte_length -= bytes_to_copy;
  1271. }
  1272. // 7. Set controller.[[queueTotalSize]] to controller.[[queueTotalSize]] − bytesToCopy.
  1273. controller.set_queue_total_size(controller.queue_total_size() - bytes_to_copy);
  1274. // 8, Perform ! ReadableByteStreamControllerFillHeadPullIntoDescriptor(controller, bytesToCopy, pullIntoDescriptor).
  1275. readable_byte_stream_controller_fill_head_pull_into_descriptor(controller, bytes_to_copy, pull_into_descriptor);
  1276. // 9. Set totalBytesToCopyRemaining to totalBytesToCopyRemaining − bytesToCopy.
  1277. total_bytes_to_copy_remaining -= bytes_to_copy;
  1278. }
  1279. // 11. If ready is false,
  1280. if (!ready) {
  1281. // 1. Assert: controller.[[queueTotalSize]] is 0.
  1282. VERIFY(controller.queue_total_size() == 0);
  1283. // 2. Assert: pullIntoDescriptor’s bytes filled > 0.
  1284. VERIFY(pull_into_descriptor.bytes_filled > 0);
  1285. // 3. Assert: pullIntoDescriptor’s bytes filled < pullIntoDescriptor’s element size.
  1286. VERIFY(pull_into_descriptor.bytes_filled < pull_into_descriptor.element_size);
  1287. }
  1288. // 12. Return ready.
  1289. return ready;
  1290. }
  1291. // https://streams.spec.whatwg.org/#readable-stream-default-reader-read
  1292. void readable_stream_default_reader_read(ReadableStreamDefaultReader& reader, ReadRequest& read_request)
  1293. {
  1294. // 1. Let stream be reader.[[stream]].
  1295. auto stream = reader.stream();
  1296. // 2. Assert: stream is not undefined.
  1297. VERIFY(stream);
  1298. // 3. Set stream.[[disturbed]] to true.
  1299. stream->set_disturbed(true);
  1300. // 4. If stream.[[state]] is "closed", perform readRequest’s close steps.
  1301. if (stream->is_closed()) {
  1302. read_request.on_close();
  1303. }
  1304. // 5. Otherwise, if stream.[[state]] is "errored", perform readRequest’s error steps given stream.[[storedError]].
  1305. else if (stream->is_errored()) {
  1306. read_request.on_error(stream->stored_error());
  1307. }
  1308. // 6. Otherwise,
  1309. else {
  1310. // 1. Assert: stream.[[state]] is "readable".
  1311. VERIFY(stream->is_readable());
  1312. // 2. Perform ! stream.[[controller]].[[PullSteps]](readRequest).
  1313. stream->controller()->visit([&](auto const& controller) {
  1314. return controller->pull_steps(read_request);
  1315. });
  1316. }
  1317. }
  1318. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-convert-pull-into-descriptor
  1319. JS::Value readable_byte_stream_controller_convert_pull_into_descriptor(JS::Realm& realm, PullIntoDescriptor const& pull_into_descriptor)
  1320. {
  1321. auto& vm = realm.vm();
  1322. // 1. Let bytesFilled be pullIntoDescriptor’s bytes filled.
  1323. auto bytes_filled = pull_into_descriptor.bytes_filled;
  1324. // 2. Let elementSize be pullIntoDescriptor’s element size.
  1325. auto element_size = pull_into_descriptor.element_size;
  1326. // 3. Assert: bytesFilled ≤ pullIntoDescriptor’s byte length.
  1327. VERIFY(bytes_filled <= pull_into_descriptor.byte_length);
  1328. // 4. Assert: bytesFilled mod elementSize is 0.
  1329. VERIFY(bytes_filled % element_size == 0);
  1330. // 5. Let buffer be ! TransferArrayBuffer(pullIntoDescriptor’s buffer).
  1331. auto buffer = MUST(transfer_array_buffer(realm, pull_into_descriptor.buffer));
  1332. // 6. Return ! Construct(pullIntoDescriptor’s view constructor, « buffer, pullIntoDescriptor’s byte offset, bytesFilled ÷ elementSize »).
  1333. return MUST(JS::construct(vm, *pull_into_descriptor.view_constructor, buffer, JS::Value(pull_into_descriptor.byte_offset), JS::Value(bytes_filled / element_size)));
  1334. }
  1335. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-pull-into
  1336. void readable_byte_stream_controller_pull_into(ReadableByteStreamController& controller, WebIDL::ArrayBufferView& view, ReadIntoRequest& read_into_request)
  1337. {
  1338. auto& vm = controller.vm();
  1339. auto& realm = controller.realm();
  1340. // 1. Let stream be controller.[[stream]].
  1341. auto stream = controller.stream();
  1342. // 2. Let elementSize be 1.
  1343. size_t element_size = 1;
  1344. // 3. Let ctor be %DataView%.
  1345. JS::NativeFunction* ctor = realm.intrinsics().data_view_constructor();
  1346. // 4. If view has a [[TypedArrayName]] internal slot (i.e., it is not a DataView),
  1347. if (view.bufferable_object().has<JS::NonnullGCPtr<JS::TypedArrayBase>>()) {
  1348. auto const& typed_array = *view.bufferable_object().get<JS::NonnullGCPtr<JS::TypedArrayBase>>();
  1349. // 1. Set elementSize to the element size specified in the typed array constructors table for view.[[TypedArrayName]].
  1350. element_size = typed_array.element_size();
  1351. // 2. Set ctor to the constructor specified in the typed array constructors table for view.[[TypedArrayName]].
  1352. switch (typed_array.kind()) {
  1353. #define __JS_ENUMERATE(ClassName, snake_name, PrototypeName, ConstructorName, Type) \
  1354. case JS::TypedArrayBase::Kind::ClassName: \
  1355. ctor = realm.intrinsics().snake_name##_constructor(); \
  1356. break;
  1357. JS_ENUMERATE_TYPED_ARRAYS
  1358. #undef __JS_ENUMERATE
  1359. }
  1360. }
  1361. // 5. Let byteOffset be view.[[ByteOffset]].
  1362. auto byte_offset = view.byte_offset();
  1363. // 6. Let byteLength be view.[[ByteLength]].
  1364. auto byte_length = view.byte_length();
  1365. // 7. Let bufferResult be TransferArrayBuffer(view.[[ViewedArrayBuffer]]).
  1366. auto buffer_result = transfer_array_buffer(realm, *view.viewed_array_buffer());
  1367. // 8. If bufferResult is an abrupt completion,
  1368. if (buffer_result.is_exception()) {
  1369. // 1. Perform readIntoRequest’s error steps, given bufferResult.[[Value]].
  1370. auto throw_completion = Bindings::dom_exception_to_throw_completion(vm, buffer_result.exception());
  1371. read_into_request.on_error(*throw_completion.release_value());
  1372. // 2. Return.
  1373. return;
  1374. }
  1375. // 9. Let buffer be bufferResult.[[Value]].
  1376. auto buffer = buffer_result.value();
  1377. // 10. Let pullIntoDescriptor be a new pull-into descriptor with buffer buffer, buffer byte length buffer.[[ArrayBufferByteLength]],
  1378. // byte offset byteOffset, byte length byteLength, bytes filled 0, element size elementSize, view constructor ctor, and reader type "byob".
  1379. PullIntoDescriptor pull_into_descriptor {
  1380. .buffer = buffer,
  1381. .buffer_byte_length = buffer->byte_length(),
  1382. .byte_offset = byte_offset,
  1383. .byte_length = byte_length,
  1384. .bytes_filled = 0,
  1385. .element_size = element_size,
  1386. .view_constructor = *ctor,
  1387. .reader_type = ReaderType::Byob,
  1388. };
  1389. // 11. If controller.[[pendingPullIntos]] is not empty,
  1390. if (!controller.pending_pull_intos().is_empty()) {
  1391. // 1. Append pullIntoDescriptor to controller.[[pendingPullIntos]].
  1392. controller.pending_pull_intos().append(pull_into_descriptor);
  1393. // 2. Perform ! ReadableStreamAddReadIntoRequest(stream, readIntoRequest).
  1394. readable_stream_add_read_into_request(*stream, read_into_request);
  1395. // 3. Return.
  1396. return;
  1397. }
  1398. // 12. If stream.[[state]] is "closed",
  1399. if (stream->is_closed()) {
  1400. // 1. Let emptyView be ! Construct(ctor, « pullIntoDescriptor’s buffer, pullIntoDescriptor’s byte offset, 0 »).
  1401. auto empty_view = MUST(JS::construct(vm, *ctor, pull_into_descriptor.buffer, JS::Value(pull_into_descriptor.byte_offset), JS::Value(0)));
  1402. // 2. Perform readIntoRequest’s close steps, given emptyView.
  1403. read_into_request.on_close(empty_view);
  1404. // 3. Return.
  1405. return;
  1406. }
  1407. // 13. If controller.[[queueTotalSize]] > 0,
  1408. if (controller.queue_total_size() > 0) {
  1409. // 1. If ! ReadableByteStreamControllerFillPullIntoDescriptorFromQueue(controller, pullIntoDescriptor) is true,
  1410. if (readable_byte_stream_controller_fill_pull_into_descriptor_from_queue(controller, pull_into_descriptor)) {
  1411. // 1. Let filledView be ! ReadableByteStreamControllerConvertPullIntoDescriptor(pullIntoDescriptor).
  1412. auto filled_view = readable_byte_stream_controller_convert_pull_into_descriptor(realm, pull_into_descriptor);
  1413. // 2. Perform ! ReadableByteStreamControllerHandleQueueDrain(controller).
  1414. readable_byte_stream_controller_handle_queue_drain(controller);
  1415. // 3. Perform readIntoRequest’s chunk steps, given filledView.
  1416. read_into_request.on_chunk(filled_view);
  1417. // 4. Return.
  1418. return;
  1419. }
  1420. // 2. If controller.[[closeRequested]] is true,
  1421. if (controller.close_requested()) {
  1422. // 1. Let e be a TypeError exception.
  1423. auto error = JS::TypeError::create(realm, "Reader has been released"sv);
  1424. // 2. Perform ! ReadableByteStreamControllerError(controller, e).
  1425. readable_byte_stream_controller_error(controller, error);
  1426. // 3. Perform readIntoRequest’s error steps, given e.
  1427. read_into_request.on_error(error);
  1428. // 4. Return.
  1429. return;
  1430. }
  1431. }
  1432. // 14. Append pullIntoDescriptor to controller.[[pendingPullIntos]].
  1433. controller.pending_pull_intos().append(pull_into_descriptor);
  1434. // 15. Perform ! ReadableStreamAddReadIntoRequest(stream, readIntoRequest).
  1435. readable_stream_add_read_into_request(*stream, read_into_request);
  1436. // 16. Perform ! ReadableByteStreamControllerCallPullIfNeeded(controller).
  1437. readable_byte_stream_controller_call_pull_if_needed(controller);
  1438. }
  1439. // https://streams.spec.whatwg.org/#readable-stream-byob-reader-read
  1440. void readable_stream_byob_reader_read(ReadableStreamBYOBReader& reader, WebIDL::ArrayBufferView& view, ReadIntoRequest& read_into_request)
  1441. {
  1442. // 1. Let stream be reader.[[stream]].
  1443. auto stream = reader.stream();
  1444. // 2. Assert: stream is not undefined.
  1445. VERIFY(stream);
  1446. // 3. Set stream.[[disturbed]] to true.
  1447. stream->set_disturbed(true);
  1448. // 4. If stream.[[state]] is "errored", perform readIntoRequest’s error steps given stream.[[storedError]].
  1449. if (stream->is_errored()) {
  1450. read_into_request.on_error(stream->stored_error());
  1451. }
  1452. // 5. Otherwise, perform ! ReadableByteStreamControllerPullInto(stream.[[controller]], view, readIntoRequest).
  1453. else {
  1454. readable_byte_stream_controller_pull_into(*stream->controller()->get<JS::NonnullGCPtr<ReadableByteStreamController>>(), view, read_into_request);
  1455. }
  1456. }
  1457. // https://streams.spec.whatwg.org/#abstract-opdef-readablestreamdefaultreaderrelease
  1458. void readable_stream_default_reader_release(ReadableStreamDefaultReader& reader)
  1459. {
  1460. auto& realm = reader.realm();
  1461. // 1. Perform ! ReadableStreamReaderGenericRelease(reader).
  1462. readable_stream_reader_generic_release(reader);
  1463. // 2. Let e be a new TypeError exception.
  1464. auto exception = JS::TypeError::create(realm, "Reader has been released"sv);
  1465. // 3. Perform ! ReadableStreamDefaultReaderErrorReadRequests(reader, e).
  1466. readable_stream_default_reader_error_read_requests(reader, exception);
  1467. }
  1468. // https://streams.spec.whatwg.org/#abstract-opdef-readablestreambyobreaderrelease
  1469. void readable_stream_byob_reader_release(ReadableStreamBYOBReader& reader)
  1470. {
  1471. auto& realm = reader.realm();
  1472. // 1. Perform ! ReadableStreamReaderGenericRelease(reader).
  1473. readable_stream_reader_generic_release(reader);
  1474. // 2. Let e be a new TypeError exception.
  1475. auto exception = JS::TypeError::create(realm, "Reader has been released"sv);
  1476. // 3. Perform ! ReadableStreamBYOBReaderErrorReadIntoRequests(reader, e).
  1477. readable_stream_byob_reader_error_read_into_requests(reader, exception);
  1478. }
  1479. // https://streams.spec.whatwg.org/#set-up-readable-stream-default-reader
  1480. WebIDL::ExceptionOr<void> set_up_readable_stream_default_reader(ReadableStreamDefaultReader& reader, ReadableStream& stream)
  1481. {
  1482. // 1. If ! IsReadableStreamLocked(stream) is true, throw a TypeError exception.
  1483. if (is_readable_stream_locked(stream))
  1484. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, "Cannot create stream reader for a locked stream"sv };
  1485. // 2. Perform ! ReadableStreamReaderGenericInitialize(reader, stream).
  1486. // 3. Set reader.[[readRequests]] to a new empty list.
  1487. readable_stream_reader_generic_initialize(ReadableStreamReader { reader }, stream);
  1488. return {};
  1489. }
  1490. // https://streams.spec.whatwg.org/#set-up-readable-stream-byob-reader
  1491. WebIDL::ExceptionOr<void> set_up_readable_stream_byob_reader(ReadableStreamBYOBReader& reader, ReadableStream& stream)
  1492. {
  1493. // 1. If ! IsReadableStreamLocked(stream) is true, throw a TypeError exception.
  1494. if (is_readable_stream_locked(stream))
  1495. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, "Cannot create stream reader for a locked stream"sv };
  1496. // 2. If stream.[[controller]] does not implement ReadableByteStreamController, throw a TypeError exception.
  1497. if (!stream.controller()->has<JS::NonnullGCPtr<ReadableByteStreamController>>())
  1498. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, "BYOB reader cannot set up reader from non-byte stream"sv };
  1499. // 3. Perform ! ReadableStreamReaderGenericInitialize(reader, stream).
  1500. readable_stream_reader_generic_initialize(ReadableStreamReader { reader }, stream);
  1501. // 4. Set reader.[[readIntoRequests]] to a new empty list.
  1502. reader.read_into_requests().clear();
  1503. return {};
  1504. }
  1505. // https://streams.spec.whatwg.org/#readable-stream-default-controller-close
  1506. void readable_stream_default_controller_close(ReadableStreamDefaultController& controller)
  1507. {
  1508. // 1. If ! ReadableStreamDefaultControllerCanCloseOrEnqueue(controller) is false, return.
  1509. if (!readable_stream_default_controller_can_close_or_enqueue(controller))
  1510. return;
  1511. // 2. Let stream be controller.[[stream]].
  1512. auto stream = controller.stream();
  1513. // 3. Set controller.[[closeRequested]] to true.
  1514. controller.set_close_requested(true);
  1515. // 4. If controller.[[queue]] is empty,
  1516. if (controller.queue().is_empty()) {
  1517. // 1. Perform ! ReadableStreamDefaultControllerClearAlgorithms(controller).
  1518. readable_stream_default_controller_clear_algorithms(controller);
  1519. // 2. Perform ! ReadableStreamClose(stream).
  1520. readable_stream_close(*stream);
  1521. }
  1522. }
  1523. // https://streams.spec.whatwg.org/#rs-default-controller-has-backpressure
  1524. bool readable_stream_default_controller_has_backpressure(ReadableStreamDefaultController& controller)
  1525. {
  1526. // 1. If ! ReadableStreamDefaultControllerShouldCallPull(controller) is true, return false.
  1527. if (readable_stream_default_controller_should_call_pull(controller))
  1528. return false;
  1529. // 2. Otherwise, return true.
  1530. return true;
  1531. }
  1532. // https://streams.spec.whatwg.org/#readable-stream-default-controller-enqueue
  1533. WebIDL::ExceptionOr<void> readable_stream_default_controller_enqueue(ReadableStreamDefaultController& controller, JS::Value chunk)
  1534. {
  1535. auto& vm = controller.vm();
  1536. // 1. If ! ReadableStreamDefaultControllerCanCloseOrEnqueue(controller) is false, return.
  1537. if (!readable_stream_default_controller_can_close_or_enqueue(controller))
  1538. return {};
  1539. // 2. Let stream be controller.[[stream]].
  1540. auto stream = controller.stream();
  1541. // 3. If ! IsReadableStreamLocked(stream) is true and ! ReadableStreamGetNumReadRequests(stream) > 0, perform ! ReadableStreamFulfillReadRequest(stream, chunk, false).
  1542. if (is_readable_stream_locked(*stream) && readable_stream_get_num_read_requests(*stream) > 0) {
  1543. readable_stream_fulfill_read_request(*stream, chunk, false);
  1544. }
  1545. // 4. Otherwise,
  1546. else {
  1547. // 1. Let result be the result of performing controller.[[strategySizeAlgorithm]], passing in chunk, and interpreting the result as a completion record.
  1548. auto result = controller.strategy_size_algorithm()->function()(chunk);
  1549. // 2. If result is an abrupt completion,
  1550. if (result.is_abrupt()) {
  1551. // 1. Perform ! ReadableStreamDefaultControllerError(controller, result.[[Value]]).
  1552. readable_stream_default_controller_error(controller, result.value().value());
  1553. // 2. Return result.
  1554. return result;
  1555. }
  1556. // 3. Let chunkSize be result.[[Value]].
  1557. auto chunk_size = result.release_value().release_value();
  1558. // 4. Let enqueueResult be EnqueueValueWithSize(controller, chunk, chunkSize).
  1559. auto enqueue_result = enqueue_value_with_size(controller, chunk, chunk_size);
  1560. // 5. If enqueueResult is an abrupt completion,
  1561. if (enqueue_result.is_error()) {
  1562. auto throw_completion = Bindings::throw_dom_exception_if_needed(vm, [&] { return enqueue_result; }).throw_completion();
  1563. // 1. Perform ! ReadableStreamDefaultControllerError(controller, enqueueResult.[[Value]]).
  1564. readable_stream_default_controller_error(controller, throw_completion.value().value());
  1565. // 2. Return enqueueResult.
  1566. // Note: We need to return the throw_completion object here, as enqueue needs to throw the same object that the controller is errored with
  1567. return throw_completion;
  1568. }
  1569. }
  1570. // 5. Perform ! ReadableStreamDefaultControllerCallPullIfNeeded(controller).
  1571. readable_stream_default_controller_can_pull_if_needed(controller);
  1572. return {};
  1573. }
  1574. // https://streams.spec.whatwg.org/#readable-stream-default-controller-call-pull-if-needed
  1575. void readable_stream_default_controller_can_pull_if_needed(ReadableStreamDefaultController& controller)
  1576. {
  1577. // 1. Let shouldPull be ! ReadableStreamDefaultControllerShouldCallPull(controller).
  1578. auto should_pull = readable_stream_default_controller_should_call_pull(controller);
  1579. // 2. If shouldPull is false, return.
  1580. if (!should_pull)
  1581. return;
  1582. // 3. If controller.[[pulling]] is true,
  1583. if (controller.pulling()) {
  1584. // 1. Set controller.[[pullAgain]] to true.
  1585. controller.set_pull_again(true);
  1586. // 2. Return.
  1587. return;
  1588. }
  1589. // 4. Assert: controller.[[pullAgain]] is false.
  1590. VERIFY(!controller.pull_again());
  1591. // 5. Set controller.[[pulling]] to true.
  1592. controller.set_pulling(true);
  1593. // 6. Let pullPromise be the result of performing controller.[[pullAlgorithm]].
  1594. auto pull_promise = controller.pull_algorithm()->function()();
  1595. // 7. Upon fulfillment of pullPromise,
  1596. WebIDL::upon_fulfillment(*pull_promise, JS::create_heap_function(controller.heap(), [&controller](JS::Value) -> WebIDL::ExceptionOr<JS::Value> {
  1597. // 1. Set controller.[[pulling]] to false.
  1598. controller.set_pulling(false);
  1599. // 2. If controller.[[pullAgain]] is true,
  1600. if (controller.pull_again()) {
  1601. // 1. Set controller.[[pullAgain]] to false.
  1602. controller.set_pull_again(false);
  1603. // 2. Perform ! ReadableStreamDefaultControllerCallPullIfNeeded(controller).
  1604. readable_stream_default_controller_can_pull_if_needed(controller);
  1605. }
  1606. return JS::js_undefined();
  1607. }));
  1608. // 8. Upon rejection of pullPromise with reason e,
  1609. WebIDL::upon_rejection(*pull_promise, JS::create_heap_function(controller.heap(), [&controller](JS::Value e) -> WebIDL::ExceptionOr<JS::Value> {
  1610. // 1. Perform ! ReadableStreamDefaultControllerError(controller, e).
  1611. readable_stream_default_controller_error(controller, e);
  1612. return JS::js_undefined();
  1613. }));
  1614. }
  1615. // https://streams.spec.whatwg.org/#readable-stream-default-controller-should-call-pull
  1616. bool readable_stream_default_controller_should_call_pull(ReadableStreamDefaultController& controller)
  1617. {
  1618. // 1. Let stream be controller.[[stream]].
  1619. auto stream = controller.stream();
  1620. // 2. If ! ReadableStreamDefaultControllerCanCloseOrEnqueue(controller) is false, return false.
  1621. if (!readable_stream_default_controller_can_close_or_enqueue(controller))
  1622. return false;
  1623. // 3. If controller.[[started]] is false, return false.
  1624. if (!controller.started())
  1625. return false;
  1626. // 4. If ! IsReadableStreamLocked(stream) is true and ! ReadableStreamGetNumReadRequests(stream) > 0, return true.
  1627. if (is_readable_stream_locked(*stream) && readable_stream_get_num_read_requests(*stream) > 0)
  1628. return true;
  1629. // 5. Let desiredSize be ! ReadableStreamDefaultControllerGetDesiredSize(controller).
  1630. auto desired_size = readable_stream_default_controller_get_desired_size(controller);
  1631. // 6. Assert: desiredSize is not null.
  1632. VERIFY(desired_size.has_value());
  1633. // 7. If desiredSize > 0, return true.
  1634. if (desired_size.release_value() > 0.0)
  1635. return true;
  1636. // 8. Return false.
  1637. return false;
  1638. }
  1639. // https://streams.spec.whatwg.org/#abstract-opdef-readablebytestreamcontrollergetbyobrequest
  1640. JS::GCPtr<ReadableStreamBYOBRequest> readable_byte_stream_controller_get_byob_request(JS::NonnullGCPtr<ReadableByteStreamController> controller)
  1641. {
  1642. auto& vm = controller->vm();
  1643. auto& realm = controller->realm();
  1644. // 1. If controller.[[byobRequest]] is null and controller.[[pendingPullIntos]] is not empty,
  1645. if (!controller->raw_byob_request() && !controller->pending_pull_intos().is_empty()) {
  1646. // 1. Let firstDescriptor be controller.[[pendingPullIntos]][0].
  1647. auto const& first_descriptor = controller->pending_pull_intos().first();
  1648. // 2. Let view be ! Construct(%Uint8Array%, « firstDescriptor’s buffer, firstDescriptor’s byte offset + firstDescriptor’s bytes filled, firstDescriptor’s byte length − firstDescriptor’s bytes filled »).
  1649. auto view = MUST(JS::construct(vm, *realm.intrinsics().uint8_array_constructor(), first_descriptor.buffer, JS::Value(first_descriptor.byte_offset + first_descriptor.bytes_filled), JS::Value(first_descriptor.byte_length - first_descriptor.bytes_filled)));
  1650. // 3. Let byobRequest be a new ReadableStreamBYOBRequest.
  1651. auto byob_request = realm.heap().allocate<ReadableStreamBYOBRequest>(realm, realm);
  1652. // 4. Set byobRequest.[[controller]] to controller.
  1653. byob_request->set_controller(controller);
  1654. // 5. Set byobRequest.[[view]] to view.
  1655. auto array_buffer_view = vm.heap().allocate<WebIDL::ArrayBufferView>(realm, view);
  1656. byob_request->set_view(array_buffer_view);
  1657. // 6. Set controller.[[byobRequest]] to byobRequest.
  1658. controller->set_byob_request(byob_request);
  1659. }
  1660. // 2. Return controller.[[byobRequest]].
  1661. return controller->raw_byob_request();
  1662. }
  1663. // https://streams.spec.whatwg.org/#readable-stream-default-controller-clear-algorithms
  1664. void readable_stream_default_controller_clear_algorithms(ReadableStreamDefaultController& controller)
  1665. {
  1666. // 1. Set controller.[[pullAlgorithm]] to undefined.
  1667. controller.set_pull_algorithm({});
  1668. // 2. Set controller.[[cancelAlgorithm]] to undefined.
  1669. controller.set_cancel_algorithm({});
  1670. // 3. Set controller.[[strategySizeAlgorithm]] to undefined.
  1671. controller.set_strategy_size_algorithm({});
  1672. }
  1673. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-respond-in-readable-state
  1674. WebIDL::ExceptionOr<void> readable_byte_stream_controller_respond_in_readable_state(ReadableByteStreamController& controller, u64 bytes_written, PullIntoDescriptor& pull_into_descriptor)
  1675. {
  1676. // 1. Assert: pullIntoDescriptor’s bytes filled + bytesWritten ≤ pullIntoDescriptor’s byte length.
  1677. VERIFY(pull_into_descriptor.bytes_filled + bytes_written <= pull_into_descriptor.byte_length);
  1678. // 2. Perform ! ReadableByteStreamControllerFillHeadPullIntoDescriptor(controller, bytesWritten, pullIntoDescriptor).
  1679. readable_byte_stream_controller_fill_head_pull_into_descriptor(controller, bytes_written, pull_into_descriptor);
  1680. // 3. If pullIntoDescriptor’s reader type is "none",
  1681. if (pull_into_descriptor.reader_type == ReaderType::None) {
  1682. // 1. Perform ? ReadableByteStreamControllerEnqueueDetachedPullIntoToQueue(controller, pullIntoDescriptor).
  1683. TRY(readable_byte_stream_controller_enqueue_detached_pull_into_queue(controller, pull_into_descriptor));
  1684. // 2. Perform ! ReadableByteStreamControllerProcessPullIntoDescriptorsUsingQueue(controller).
  1685. readable_byte_stream_controller_process_pull_into_descriptors_using_queue(controller);
  1686. // 3. Return.
  1687. return {};
  1688. }
  1689. // 4. If pullIntoDescriptor’s bytes filled < pullIntoDescriptor’s minimum fill, return.
  1690. // FIXME: Support minimum fill.
  1691. if (pull_into_descriptor.bytes_filled < pull_into_descriptor.element_size)
  1692. return {};
  1693. // NOTE: A descriptor for a read() request that is not yet filled up to its minimum length will stay at the head of the queue, so the underlying source can keep filling it.
  1694. // 5. Perform ! ReadableByteStreamControllerShiftPendingPullInto(controller).
  1695. // NOTE: We need to take a copy of pull_into_descriptor here as the shift destroys the pull into descriptor we are given.
  1696. auto pull_into_descriptor_copy = readable_byte_stream_controller_shift_pending_pull_into(controller);
  1697. // 6. Let remainderSize be the remainder after dividing pullIntoDescriptor’s bytes filled by pullIntoDescriptor’s element size.
  1698. auto remainder_size = pull_into_descriptor_copy.bytes_filled % pull_into_descriptor_copy.element_size;
  1699. // 7. If remainderSize > 0,
  1700. if (remainder_size > 0) {
  1701. // 1. Let end be pullIntoDescriptor’s byte offset + pullIntoDescriptor’s bytes filled.
  1702. auto end = pull_into_descriptor_copy.byte_offset + pull_into_descriptor_copy.bytes_filled;
  1703. // 2. Perform ? ReadableByteStreamControllerEnqueueClonedChunkToQueue(controller, pullIntoDescriptor’s buffer, end − remainderSize, remainderSize).
  1704. TRY(readable_byte_stream_controller_enqueue_cloned_chunk_to_queue(controller, *pull_into_descriptor_copy.buffer, end - remainder_size, remainder_size));
  1705. }
  1706. // 8. Set pullIntoDescriptor’s bytes filled to pullIntoDescriptor’s bytes filled − remainderSize.
  1707. pull_into_descriptor_copy.bytes_filled -= remainder_size;
  1708. // 9. Perform ! ReadableByteStreamControllerCommitPullIntoDescriptor(controller.[[stream]], pullIntoDescriptor).
  1709. readable_byte_stream_controller_commit_pull_into_descriptor(*controller.stream(), pull_into_descriptor_copy);
  1710. return {};
  1711. }
  1712. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-respond-in-closed-state
  1713. void readable_byte_stream_controller_respond_in_closed_state(ReadableByteStreamController& controller, PullIntoDescriptor& first_descriptor)
  1714. {
  1715. // 1. Assert: the remainder after dividing firstDescriptor’s bytes filled by firstDescriptor’s element size is 0.
  1716. VERIFY(first_descriptor.bytes_filled % first_descriptor.element_size == 0);
  1717. // 2. If firstDescriptor’s reader type is "none", perform ! ReadableByteStreamControllerShiftPendingPullInto(controller).
  1718. if (first_descriptor.reader_type == ReaderType::None)
  1719. readable_byte_stream_controller_shift_pending_pull_into(controller);
  1720. // 3. Let stream be controller.[[stream]].
  1721. auto& stream = *controller.stream();
  1722. // 4. If ! ReadableStreamHasBYOBReader(stream) is true,
  1723. if (readable_stream_has_byob_reader(stream)) {
  1724. // 1. While ! ReadableStreamGetNumReadIntoRequests(stream) > 0,
  1725. while (readable_stream_get_num_read_into_requests(stream) > 0) {
  1726. // 1. Let pullIntoDescriptor be ! ReadableByteStreamControllerShiftPendingPullInto(controller).
  1727. auto pull_into_descriptor = readable_byte_stream_controller_shift_pending_pull_into(controller);
  1728. // 2. Perform ! ReadableByteStreamControllerCommitPullIntoDescriptor(stream, pullIntoDescriptor).
  1729. readable_byte_stream_controller_commit_pull_into_descriptor(stream, pull_into_descriptor);
  1730. }
  1731. }
  1732. }
  1733. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-respond-internal
  1734. WebIDL::ExceptionOr<void> readable_byte_stream_controller_respond_internal(ReadableByteStreamController& controller, u64 bytes_written)
  1735. {
  1736. // 1. Let firstDescriptor be controller.[[pendingPullIntos]][0].
  1737. auto& first_descriptor = controller.pending_pull_intos().first();
  1738. // 2. Assert: ! CanTransferArrayBuffer(firstDescriptor’s buffer) is true.
  1739. VERIFY(can_transfer_array_buffer(*first_descriptor.buffer));
  1740. // 3. Perform ! ReadableByteStreamControllerInvalidateBYOBRequest(controller).
  1741. readable_byte_stream_controller_invalidate_byob_request(controller);
  1742. // 4. Let state be controller.[[stream]].[[state]].
  1743. auto state = controller.stream()->state();
  1744. // 5. If state is "closed",
  1745. if (state == ReadableStream::State::Closed) {
  1746. // 1. Assert: bytesWritten is 0.
  1747. VERIFY(bytes_written == 0);
  1748. // 2. Perform ! ReadableByteStreamControllerRespondInClosedState(controller, firstDescriptor).
  1749. readable_byte_stream_controller_respond_in_closed_state(controller, first_descriptor);
  1750. }
  1751. // 6. Otherwise,
  1752. else {
  1753. // 1. Assert: state is "readable".
  1754. VERIFY(state == ReadableStream::State::Readable);
  1755. // 2. Assert: bytesWritten > 0.
  1756. VERIFY(bytes_written > 0);
  1757. // 3. Perform ? ReadableByteStreamControllerRespondInReadableState(controller, bytesWritten, firstDescriptor).
  1758. TRY(readable_byte_stream_controller_respond_in_readable_state(controller, bytes_written, first_descriptor));
  1759. }
  1760. // 7. Perform ! ReadableByteStreamControllerCallPullIfNeeded(controller).
  1761. readable_byte_stream_controller_call_pull_if_needed(controller);
  1762. return {};
  1763. }
  1764. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-respond
  1765. WebIDL::ExceptionOr<void> readable_byte_stream_controller_respond(ReadableByteStreamController& controller, u64 bytes_written)
  1766. {
  1767. auto& realm = controller.realm();
  1768. // 1. Assert: controller.[[pendingPullIntos]] is not empty.
  1769. VERIFY(!controller.pending_pull_intos().is_empty());
  1770. // 2. Let firstDescriptor be controller.[[pendingPullIntos]][0].
  1771. auto& first_descriptor = controller.pending_pull_intos().first();
  1772. // 3. Let state be controller.[[stream]].[[state]].
  1773. auto state = controller.stream()->state();
  1774. // 4. If state is "closed",
  1775. if (state == ReadableStream::State::Closed) {
  1776. // 1. If bytesWritten is not 0, throw a TypeError exception.
  1777. if (bytes_written != 0)
  1778. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, "Bytes written is not zero for closed stream"sv };
  1779. }
  1780. // 5. Otherwise,
  1781. else {
  1782. // 1. Assert: state is "readable".
  1783. VERIFY(state == ReadableStream::State::Readable);
  1784. // 2. If bytesWritten is 0, throw a TypeError exception.
  1785. if (bytes_written == 0)
  1786. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, "Bytes written is zero for stream which is not closed"sv };
  1787. // 3. If firstDescriptor’s bytes filled + bytesWritten > firstDescriptor’s byte length, throw a RangeError exception.
  1788. if (first_descriptor.bytes_filled + bytes_written > first_descriptor.byte_length)
  1789. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::RangeError, "Bytes written is greater than the pull requests byte length"sv };
  1790. }
  1791. // 6. Set firstDescriptor’s buffer to ! TransferArrayBuffer(firstDescriptor’s buffer).
  1792. first_descriptor.buffer = MUST(transfer_array_buffer(realm, *first_descriptor.buffer));
  1793. // 7. Perform ? ReadableByteStreamControllerRespondInternal(controller, bytesWritten).
  1794. return readable_byte_stream_controller_respond_internal(controller, bytes_written);
  1795. }
  1796. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-respond-with-new-view
  1797. WebIDL::ExceptionOr<void> readable_byte_stream_controller_respond_with_new_view(JS::Realm& realm, ReadableByteStreamController& controller, WebIDL::ArrayBufferView& view)
  1798. {
  1799. // 1. Assert: controller.[[pendingPullIntos]] is not empty.
  1800. VERIFY(!controller.pending_pull_intos().is_empty());
  1801. // 2. Assert: ! IsDetachedBuffer(view.[[ViewedArrayBuffer]]) is false.
  1802. VERIFY(!view.viewed_array_buffer()->is_detached());
  1803. // 3. Let firstDescriptor be controller.[[pendingPullIntos]][0].
  1804. auto& first_descriptor = controller.pending_pull_intos().first();
  1805. // 4. Let state be controller.[[stream]].[[state]].
  1806. auto state = controller.stream()->state();
  1807. // 5. If state is "closed",
  1808. if (state == ReadableStream::State::Closed) {
  1809. // 1. If view.[[ByteLength]] is not 0, throw a TypeError exception.
  1810. if (view.byte_length() != 0)
  1811. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, "Byte length is not zero for closed stream"sv };
  1812. }
  1813. // 6. Otherwise,
  1814. else {
  1815. // 1. Assert: state is "readable".
  1816. VERIFY(state == ReadableStream::State::Readable);
  1817. // 2. If view.[[ByteLength]] is 0, throw a TypeError exception.
  1818. if (view.byte_length() == 0)
  1819. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, "Byte length is zero for stream which is not closed"sv };
  1820. }
  1821. // 7. If firstDescriptor’s byte offset + firstDescriptor’ bytes filled is not view.[[ByteOffset]], throw a RangeError exception.
  1822. if (first_descriptor.byte_offset + first_descriptor.bytes_filled != view.byte_offset())
  1823. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::RangeError, "Byte offset is not aligned with the pull request's byte offset"sv };
  1824. // 8. If firstDescriptor’s buffer byte length is not view.[[ViewedArrayBuffer]].[[ByteLength]], throw a RangeError exception.
  1825. if (first_descriptor.buffer_byte_length != view.viewed_array_buffer()->byte_length())
  1826. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::RangeError, "Buffer byte length is not aligned with the pull request's byte length"sv };
  1827. // 9. If firstDescriptor’s bytes filled + view.[[ByteLength]] > firstDescriptor’s byte length, throw a RangeError exception.
  1828. if (first_descriptor.bytes_filled + view.byte_length() > first_descriptor.byte_length)
  1829. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::RangeError, "Byte length is greater than the pull request's byte length"sv };
  1830. // 10. Let viewByteLength be view.[[ByteLength]].
  1831. auto view_byte_length = view.byte_length();
  1832. // 11. Set firstDescriptor’s buffer to ? TransferArrayBuffer(view.[[ViewedArrayBuffer]]).
  1833. first_descriptor.buffer = TRY(transfer_array_buffer(realm, *view.viewed_array_buffer()));
  1834. // 12. Perform ? ReadableByteStreamControllerRespondInternal(controller, viewByteLength).
  1835. TRY(readable_byte_stream_controller_respond_internal(controller, view_byte_length));
  1836. return {};
  1837. }
  1838. // https://streams.spec.whatwg.org/#readable-stream-default-controller-error
  1839. void readable_stream_default_controller_error(ReadableStreamDefaultController& controller, JS::Value error)
  1840. {
  1841. // 1. Let stream be controller.[[stream]].
  1842. auto stream = controller.stream();
  1843. // 2. If stream.[[state]] is not "readable", return.
  1844. if (!stream->is_readable())
  1845. return;
  1846. // 3. Perform ! ResetQueue(controller).
  1847. reset_queue(controller);
  1848. // 4. Perform ! ReadableStreamDefaultControllerClearAlgorithms(controller).
  1849. readable_stream_default_controller_clear_algorithms(controller);
  1850. // 5. Perform ! ReadableStreamError(stream, e).
  1851. readable_stream_error(*stream, error);
  1852. }
  1853. // https://streams.spec.whatwg.org/#readable-stream-default-controller-get-desired-size
  1854. Optional<double> readable_stream_default_controller_get_desired_size(ReadableStreamDefaultController& controller)
  1855. {
  1856. auto stream = controller.stream();
  1857. // 1. Let state be controller.[[stream]].[[state]].
  1858. // 2. If state is "errored", return null.
  1859. if (stream->is_errored())
  1860. return {};
  1861. // 3. If state is "closed", return 0.
  1862. if (stream->is_closed())
  1863. return 0.0;
  1864. // 4. Return controller.[[strategyHWM]] − controller.[[queueTotalSize]].
  1865. return controller.strategy_hwm() - controller.queue_total_size();
  1866. }
  1867. // https://streams.spec.whatwg.org/#readable-stream-default-controller-can-close-or-enqueue
  1868. bool readable_stream_default_controller_can_close_or_enqueue(ReadableStreamDefaultController& controller)
  1869. {
  1870. // 1. Let state be controller.[[stream]].[[state]].
  1871. // 2. If controller.[[closeRequested]] is false and state is "readable", return true.
  1872. // 3. Otherwise, return false.
  1873. return !controller.close_requested() && controller.stream()->is_readable();
  1874. }
  1875. // https://streams.spec.whatwg.org/#set-up-readable-stream-default-controller
  1876. WebIDL::ExceptionOr<void> set_up_readable_stream_default_controller(ReadableStream& stream, ReadableStreamDefaultController& controller, JS::NonnullGCPtr<StartAlgorithm> start_algorithm, JS::NonnullGCPtr<PullAlgorithm> pull_algorithm, JS::NonnullGCPtr<CancelAlgorithm> cancel_algorithm, double high_water_mark, JS::NonnullGCPtr<SizeAlgorithm> size_algorithm)
  1877. {
  1878. auto& realm = stream.realm();
  1879. // 1. Assert: stream.[[controller]] is undefined.
  1880. VERIFY(!stream.controller().has_value());
  1881. // 2. Set controller.[[stream]] to stream.
  1882. controller.set_stream(stream);
  1883. // 3. Perform ! ResetQueue(controller).
  1884. reset_queue(controller);
  1885. // 4. Set controller.[[started]], controller.[[closeRequested]], controller.[[pullAgain]], and controller.[[pulling]] to false.
  1886. controller.set_started(false);
  1887. controller.set_close_requested(false);
  1888. controller.set_pull_again(false);
  1889. controller.set_pulling(false);
  1890. // 5. Set controller.[[strategySizeAlgorithm]] to sizeAlgorithm and controller.[[strategyHWM]] to highWaterMark.
  1891. controller.set_strategy_size_algorithm(size_algorithm);
  1892. controller.set_strategy_hwm(high_water_mark);
  1893. // 6. Set controller.[[pullAlgorithm]] to pullAlgorithm.
  1894. controller.set_pull_algorithm(pull_algorithm);
  1895. // 7. Set controller.[[cancelAlgorithm]] to cancelAlgorithm.
  1896. controller.set_cancel_algorithm(cancel_algorithm);
  1897. // 8. Set stream.[[controller]] to controller.
  1898. stream.set_controller(ReadableStreamController { controller });
  1899. // 9. Let startResult be the result of performing startAlgorithm. (This might throw an exception.)
  1900. auto start_result = TRY(start_algorithm->function()());
  1901. // 10. Let startPromise be a promise resolved with startResult.
  1902. auto start_promise = WebIDL::create_resolved_promise(realm, start_result);
  1903. // 11. Upon fulfillment of startPromise,
  1904. WebIDL::upon_fulfillment(start_promise, JS::create_heap_function(controller.heap(), [&controller](JS::Value) -> WebIDL::ExceptionOr<JS::Value> {
  1905. // 1. Set controller.[[started]] to true.
  1906. controller.set_started(true);
  1907. // 2. Assert: controller.[[pulling]] is false.
  1908. VERIFY(!controller.pulling());
  1909. // 3. Assert: controller.[[pullAgain]] is false.
  1910. VERIFY(!controller.pull_again());
  1911. // 4. Perform ! ReadableStreamDefaultControllerCallPullIfNeeded(controller).
  1912. readable_stream_default_controller_can_pull_if_needed(controller);
  1913. return JS::js_undefined();
  1914. }));
  1915. // 12. Upon rejection of startPromise with reason r,
  1916. WebIDL::upon_rejection(start_promise, JS::create_heap_function(controller.heap(), [&controller](JS::Value r) -> WebIDL::ExceptionOr<JS::Value> {
  1917. // 1. Perform ! ReadableStreamDefaultControllerError(controller, r).
  1918. readable_stream_default_controller_error(controller, r);
  1919. return JS::js_undefined();
  1920. }));
  1921. return {};
  1922. }
  1923. // https://streams.spec.whatwg.org/#set-up-readable-stream-default-controller-from-underlying-source
  1924. 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, JS::NonnullGCPtr<SizeAlgorithm> size_algorithm)
  1925. {
  1926. auto& realm = stream.realm();
  1927. // 1. Let controller be a new ReadableStreamDefaultController.
  1928. auto controller = stream.heap().allocate<ReadableStreamDefaultController>(realm, realm);
  1929. // 2. Let startAlgorithm be an algorithm that returns undefined.
  1930. auto start_algorithm = JS::create_heap_function(realm.heap(), []() -> WebIDL::ExceptionOr<JS::Value> {
  1931. return JS::js_undefined();
  1932. });
  1933. // 3. Let pullAlgorithm be an algorithm that returns a promise resolved with undefined.
  1934. auto pull_algorithm = JS::create_heap_function(realm.heap(), [&realm]() {
  1935. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  1936. });
  1937. // 4. Let cancelAlgorithm be an algorithm that returns a promise resolved with undefined.
  1938. auto cancel_algorithm = JS::create_heap_function(realm.heap(), [&realm](JS::Value) {
  1939. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  1940. });
  1941. // 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.
  1942. if (underlying_source.start) {
  1943. start_algorithm = JS::create_heap_function(realm.heap(), [controller, underlying_source_value, callback = underlying_source.start]() -> WebIDL::ExceptionOr<JS::Value> {
  1944. // Note: callback does not return a promise, so invoke_callback may return an abrupt completion
  1945. return TRY(WebIDL::invoke_callback(*callback, underlying_source_value, controller)).release_value();
  1946. });
  1947. }
  1948. // 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.
  1949. if (underlying_source.pull) {
  1950. pull_algorithm = JS::create_heap_function(realm.heap(), [&realm, controller, underlying_source_value, callback = underlying_source.pull]() {
  1951. // Note: callback returns a promise, so invoke_callback will never return an abrupt completion
  1952. auto result = MUST(WebIDL::invoke_callback(*callback, underlying_source_value, controller)).release_value();
  1953. return WebIDL::create_resolved_promise(realm, result);
  1954. });
  1955. }
  1956. // 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.
  1957. if (underlying_source.cancel) {
  1958. cancel_algorithm = JS::create_heap_function(realm.heap(), [&realm, underlying_source_value, callback = underlying_source.cancel](JS::Value reason) {
  1959. // Note: callback returns a promise, so invoke_callback will never return an abrupt completion
  1960. auto result = MUST(WebIDL::invoke_callback(*callback, underlying_source_value, reason)).release_value();
  1961. return WebIDL::create_resolved_promise(realm, result);
  1962. });
  1963. }
  1964. // 8. Perform ? SetUpReadableStreamDefaultController(stream, controller, startAlgorithm, pullAlgorithm, cancelAlgorithm, highWaterMark, sizeAlgorithm).
  1965. return set_up_readable_stream_default_controller(stream, controller, start_algorithm, pull_algorithm, cancel_algorithm, high_water_mark, size_algorithm);
  1966. }
  1967. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-call-pull-if-needed
  1968. void readable_byte_stream_controller_call_pull_if_needed(ReadableByteStreamController& controller)
  1969. {
  1970. // 1. Let shouldPull be ! ReadableByteStreamControllerShouldCallPull(controller).
  1971. auto should_pull = readable_byte_stream_controller_should_call_pull(controller);
  1972. // 2. If shouldPull is false, return.
  1973. if (!should_pull)
  1974. return;
  1975. // 3. If controller.[[pulling]] is true,
  1976. if (controller.pulling()) {
  1977. // 1. Set controller.[[pullAgain]] to true.
  1978. controller.set_pull_again(true);
  1979. // 2. Return.
  1980. return;
  1981. }
  1982. // 4. Assert: controller.[[pullAgain]] is false.
  1983. VERIFY(!controller.pull_again());
  1984. // 5. Set controller.[[pulling]] to true.
  1985. controller.set_pulling(true);
  1986. // 6. Let pullPromise be the result of performing controller.[[pullAlgorithm]].
  1987. auto pull_promise = controller.pull_algorithm()->function()();
  1988. // 7. Upon fulfillment of pullPromise,
  1989. WebIDL::upon_fulfillment(*pull_promise, JS::create_heap_function(controller.heap(), [&controller](JS::Value) -> WebIDL::ExceptionOr<JS::Value> {
  1990. // 1. Set controller.[[pulling]] to false.
  1991. controller.set_pulling(false);
  1992. // 2. If controller.[[pullAgain]] is true,
  1993. if (controller.pull_again()) {
  1994. // 1. Set controller.[[pullAgain]] to false.
  1995. controller.set_pull_again(false);
  1996. // 2. Perform ! ReadableByteStreamControllerCallPullIfNeeded(controller).
  1997. readable_byte_stream_controller_call_pull_if_needed(controller);
  1998. }
  1999. return JS::js_undefined();
  2000. }));
  2001. // 8. Upon rejection of pullPromise with reason e,
  2002. WebIDL::upon_rejection(*pull_promise, JS::create_heap_function(controller.heap(), [&controller](JS::Value error) -> WebIDL::ExceptionOr<JS::Value> {
  2003. // 1. Perform ! ReadableByteStreamControllerError(controller, e).
  2004. readable_byte_stream_controller_error(controller, error);
  2005. return JS::js_undefined();
  2006. }));
  2007. }
  2008. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-clear-algorithms
  2009. void readable_byte_stream_controller_clear_algorithms(ReadableByteStreamController& controller)
  2010. {
  2011. // 1. Set controller.[[pullAlgorithm]] to undefined.
  2012. controller.set_pull_algorithm({});
  2013. // 2. Set controller.[[cancelAlgorithm]] to undefined.
  2014. controller.set_cancel_algorithm({});
  2015. }
  2016. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-clear-pending-pull-intos
  2017. void readable_byte_stream_controller_clear_pending_pull_intos(ReadableByteStreamController& controller)
  2018. {
  2019. // 1. Perform ! ReadableByteStreamControllerInvalidateBYOBRequest(controller).
  2020. readable_byte_stream_controller_invalidate_byob_request(controller);
  2021. // 2. Set controller.[[pendingPullIntos]] to a new empty list.
  2022. controller.pending_pull_intos().clear();
  2023. }
  2024. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-close
  2025. WebIDL::ExceptionOr<void> readable_byte_stream_controller_close(ReadableByteStreamController& controller)
  2026. {
  2027. auto& realm = controller.realm();
  2028. // 1. Let stream be controller.[[stream]].
  2029. auto stream = controller.stream();
  2030. // 2. If controller.[[closeRequested]] is true or stream.[[state]] is not "readable", return.
  2031. if (controller.close_requested() || stream->state() != ReadableStream::State::Readable)
  2032. return {};
  2033. // 3. If controller.[[queueTotalSize]] > 0,
  2034. if (controller.queue_total_size() > 0.0) {
  2035. // 1. Set controller.[[closeRequested]] to true.
  2036. controller.set_close_requested(true);
  2037. // 2. Return.
  2038. return {};
  2039. }
  2040. // 4. If controller.[[pendingPullIntos]] is not empty,
  2041. if (!controller.pending_pull_intos().is_empty()) {
  2042. // 1. Let firstPendingPullInto be controller.[[pendingPullIntos]][0].
  2043. auto& first_pending_pull_into = controller.pending_pull_intos().first();
  2044. // 2. If firstPendingPullInto’s bytes filled > 0,
  2045. if (first_pending_pull_into.bytes_filled > 0) {
  2046. // 1. Let e be a new TypeError exception.
  2047. auto error = JS::TypeError::create(realm, "Cannot close controller in the middle of processing a write request"sv);
  2048. // 2. Perform ! ReadableByteStreamControllerError(controller, e).
  2049. readable_byte_stream_controller_error(controller, error);
  2050. // 3. Throw e.
  2051. return JS::throw_completion(error);
  2052. }
  2053. }
  2054. // 5. Perform ! ReadableByteStreamControllerClearAlgorithms(controller).
  2055. readable_byte_stream_controller_clear_algorithms(controller);
  2056. // 6. Perform ! ReadableStreamClose(stream).
  2057. readable_stream_close(*stream);
  2058. return {};
  2059. }
  2060. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-error
  2061. void readable_byte_stream_controller_error(ReadableByteStreamController& controller, JS::Value error)
  2062. {
  2063. // 1. Let stream be controller.[[stream]].
  2064. auto stream = controller.stream();
  2065. // 2. If stream.[[state]] is not "readable", return.
  2066. if (stream->state() != ReadableStream::State::Readable)
  2067. return;
  2068. // 3. Perform ! ReadableByteStreamControllerClearPendingPullIntos(controller).
  2069. readable_byte_stream_controller_clear_pending_pull_intos(controller);
  2070. // 4. Perform ! ResetQueue(controller).
  2071. reset_queue(controller);
  2072. // 5. Perform ! ReadableByteStreamControllerClearAlgorithms(controller).
  2073. readable_byte_stream_controller_clear_algorithms(controller);
  2074. // 6. Perform ! ReadableStreamError(stream, e).
  2075. readable_stream_error(*stream, error);
  2076. }
  2077. // https://streams.spec.whatwg.org/#abstract-opdef-readablebytestreamcontrollerfillreadrequestfromqueue
  2078. void readable_byte_stream_controller_fill_read_request_from_queue(ReadableByteStreamController& controller, JS::NonnullGCPtr<ReadRequest> read_request)
  2079. {
  2080. auto& vm = controller.vm();
  2081. auto& realm = controller.realm();
  2082. // 1. Assert: controller.[[queueTotalSize]] > 0.
  2083. VERIFY(controller.queue_total_size() > 0.0);
  2084. // 2. Let entry be controller.[[queue]][0].
  2085. // 3. Remove entry from controller.[[queue]].
  2086. auto entry = controller.queue().take_first();
  2087. // 4. Set controller.[[queueTotalSize]] to controller.[[queueTotalSize]] − entry’s byte length.
  2088. controller.set_queue_total_size(controller.queue_total_size() - entry.byte_length);
  2089. // 5. Perform ! ReadableByteStreamControllerHandleQueueDrain(controller).
  2090. readable_byte_stream_controller_handle_queue_drain(controller);
  2091. // 6. Let view be ! Construct(%Uint8Array%, « entry’s buffer, entry’s byte offset, entry’s byte length »).
  2092. auto view = MUST(JS::construct(vm, *realm.intrinsics().uint8_array_constructor(), entry.buffer, JS::Value(entry.byte_offset), JS::Value(entry.byte_length)));
  2093. // 7. Perform readRequest’s chunk steps, given view.
  2094. read_request->on_chunk(view);
  2095. }
  2096. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-get-desired-size
  2097. Optional<double> readable_byte_stream_controller_get_desired_size(ReadableByteStreamController const& controller)
  2098. {
  2099. auto stream = controller.stream();
  2100. // 1. Let state be controller.[[stream]].[[state]].
  2101. // 2. If state is "errored", return null.
  2102. if (stream->is_errored())
  2103. return {};
  2104. // 3. If state is "closed", return 0.
  2105. if (stream->is_closed())
  2106. return 0.0;
  2107. // 4. Return controller.[[strategyHWM]] − controller.[[queueTotalSize]].
  2108. return controller.strategy_hwm() - controller.queue_total_size();
  2109. }
  2110. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-handle-queue-drain
  2111. void readable_byte_stream_controller_handle_queue_drain(ReadableByteStreamController& controller)
  2112. {
  2113. // 1. Assert: controller.[[stream]].[[state]] is "readable".
  2114. VERIFY(controller.stream()->state() == ReadableStream::State::Readable);
  2115. // 2. If controller.[[queueTotalSize]] is 0 and controller.[[closeRequested]] is true,
  2116. if (controller.queue_total_size() == 0.0 && controller.close_requested()) {
  2117. // 1. Perform ! ReadableByteStreamControllerClearAlgorithms(controller).
  2118. readable_byte_stream_controller_clear_algorithms(controller);
  2119. // 2. Perform ! ReadableStreamClose(controller.[[stream]]).
  2120. readable_stream_close(*controller.stream());
  2121. }
  2122. // 3. Otherwise,
  2123. else {
  2124. // 1. Perform ! ReadableByteStreamControllerCallPullIfNeeded(controller).
  2125. readable_byte_stream_controller_call_pull_if_needed(controller);
  2126. }
  2127. }
  2128. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-invalidate-byob-request
  2129. void readable_byte_stream_controller_invalidate_byob_request(ReadableByteStreamController& controller)
  2130. {
  2131. // 1. If controller.[[byobRequest]] is null, return.
  2132. if (!controller.byob_request())
  2133. return;
  2134. // 2. Set controller.[[byobRequest]].[[controller]] to undefined.
  2135. controller.byob_request()->set_controller({});
  2136. // 3. Set controller.[[byobRequest]].[[view]] to null.
  2137. controller.byob_request()->set_view({});
  2138. // 4. Set controller.[[byobRequest]] to null.
  2139. controller.set_byob_request({});
  2140. }
  2141. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-error
  2142. bool readable_byte_stream_controller_should_call_pull(ReadableByteStreamController const& controller)
  2143. {
  2144. // 1. Let stream be controller.[[stream]].
  2145. auto stream = controller.stream();
  2146. // 2. If stream.[[state]] is not "readable", return false.
  2147. if (stream->state() != ReadableStream::State::Readable)
  2148. return false;
  2149. // 3. If controller.[[closeRequested]] is true, return false.
  2150. if (controller.close_requested())
  2151. return false;
  2152. // 4. If controller.[[started]] is false, return false.
  2153. if (!controller.started())
  2154. return false;
  2155. // 5. If ! ReadableStreamHasDefaultReader(stream) is true and ! ReadableStreamGetNumReadRequests(stream) > 0, return true.
  2156. if (readable_stream_has_default_reader(*stream) && readable_stream_get_num_read_requests(*stream) > 0)
  2157. return true;
  2158. // 6. If ! ReadableStreamHasBYOBReader(stream) is true and ! ReadableStreamGetNumReadIntoRequests(stream) > 0, return true.
  2159. if (readable_stream_has_byob_reader(*stream) && readable_stream_get_num_read_into_requests(*stream) > 0)
  2160. return true;
  2161. // 7. Let desiredSize be ! ReadableByteStreamControllerGetDesiredSize(controller).
  2162. auto desired_size = readable_byte_stream_controller_get_desired_size(controller);
  2163. // 8. Assert: desiredSize is not null.
  2164. VERIFY(desired_size.has_value());
  2165. // 9. If desiredSize > 0, return true.
  2166. if (*desired_size > 0.0)
  2167. return true;
  2168. // 10. Return false.
  2169. return false;
  2170. }
  2171. // NON-STANDARD: Can be used instead of CreateReadableStream in cases where we need to set up a newly allocated
  2172. // ReadableStream before initialization of said ReadableStream, i.e. ReadableStream is captured by lambdas in an uninitialized state.
  2173. // Spec steps are taken from: https://streams.spec.whatwg.org/#create-readable-stream
  2174. WebIDL::ExceptionOr<void> set_up_readable_stream(JS::Realm& realm, ReadableStream& stream, JS::NonnullGCPtr<StartAlgorithm> start_algorithm, JS::NonnullGCPtr<PullAlgorithm> pull_algorithm, JS::NonnullGCPtr<CancelAlgorithm> cancel_algorithm, Optional<double> high_water_mark, JS::GCPtr<SizeAlgorithm> size_algorithm)
  2175. {
  2176. // 1. If highWaterMark was not passed, set it to 1.
  2177. if (!high_water_mark.has_value())
  2178. high_water_mark = 1.0;
  2179. // 2. If sizeAlgorithm was not passed, set it to an algorithm that returns 1.
  2180. if (!size_algorithm)
  2181. size_algorithm = JS::create_heap_function(realm.heap(), [](JS::Value) { return JS::normal_completion(JS::Value(1)); });
  2182. // 3. Assert: ! IsNonNegativeNumber(highWaterMark) is true.
  2183. VERIFY(is_non_negative_number(JS::Value { *high_water_mark }));
  2184. // 4. Let stream be a new ReadableStream.
  2185. // NOTE: The ReadableStream is allocated outside the scope of this method.
  2186. // 5. Perform ! InitializeReadableStream(stream).
  2187. initialize_readable_stream(stream);
  2188. // 6. Let controller be a new ReadableStreamDefaultController.
  2189. auto controller = realm.heap().allocate<ReadableStreamDefaultController>(realm, realm);
  2190. // 7. Perform ? SetUpReadableStreamDefaultController(stream, controller, startAlgorithm, pullAlgorithm, cancelAlgorithm, highWaterMark, sizeAlgorithm).
  2191. TRY(set_up_readable_stream_default_controller(stream, *controller, start_algorithm, pull_algorithm, cancel_algorithm, *high_water_mark, *size_algorithm));
  2192. return {};
  2193. }
  2194. // https://streams.spec.whatwg.org/#create-readable-stream
  2195. WebIDL::ExceptionOr<JS::NonnullGCPtr<ReadableStream>> create_readable_stream(JS::Realm& realm, JS::NonnullGCPtr<StartAlgorithm> start_algorithm, JS::NonnullGCPtr<PullAlgorithm> pull_algorithm, JS::NonnullGCPtr<CancelAlgorithm> cancel_algorithm, Optional<double> high_water_mark, JS::GCPtr<SizeAlgorithm> size_algorithm)
  2196. {
  2197. // 1. If highWaterMark was not passed, set it to 1.
  2198. if (!high_water_mark.has_value())
  2199. high_water_mark = 1.0;
  2200. // 2. If sizeAlgorithm was not passed, set it to an algorithm that returns 1.
  2201. if (!size_algorithm)
  2202. size_algorithm = JS::create_heap_function(realm.heap(), [](JS::Value) { return JS::normal_completion(JS::Value(1)); });
  2203. // 3. Assert: ! IsNonNegativeNumber(highWaterMark) is true.
  2204. VERIFY(is_non_negative_number(JS::Value { *high_water_mark }));
  2205. // 4. Let stream be a new ReadableStream.
  2206. auto stream = realm.heap().allocate<ReadableStream>(realm, realm);
  2207. // 5. Perform ! InitializeReadableStream(stream).
  2208. initialize_readable_stream(*stream);
  2209. // 6. Let controller be a new ReadableStreamDefaultController.
  2210. auto controller = realm.heap().allocate<ReadableStreamDefaultController>(realm, realm);
  2211. // 7. Perform ? SetUpReadableStreamDefaultController(stream, controller, startAlgorithm, pullAlgorithm, cancelAlgorithm, highWaterMark, sizeAlgorithm).
  2212. TRY(set_up_readable_stream_default_controller(*stream, *controller, start_algorithm, pull_algorithm, cancel_algorithm, *high_water_mark, *size_algorithm));
  2213. // 8. Return stream.
  2214. return stream;
  2215. }
  2216. // https://streams.spec.whatwg.org/#abstract-opdef-createreadablebytestream
  2217. WebIDL::ExceptionOr<JS::NonnullGCPtr<ReadableStream>> create_readable_byte_stream(JS::Realm& realm, JS::NonnullGCPtr<StartAlgorithm> start_algorithm, JS::NonnullGCPtr<PullAlgorithm> pull_algorithm, JS::NonnullGCPtr<CancelAlgorithm> cancel_algorithm)
  2218. {
  2219. // 1. Let stream be a new ReadableStream.
  2220. auto stream = realm.heap().allocate<ReadableStream>(realm, realm);
  2221. // 2. Perform ! InitializeReadableStream(stream).
  2222. initialize_readable_stream(*stream);
  2223. // 3. Let controller be a new ReadableByteStreamController.
  2224. auto controller = realm.heap().allocate<ReadableByteStreamController>(realm, realm);
  2225. // 4. Perform ? SetUpReadableByteStreamController(stream, controller, startAlgorithm, pullAlgorithm, cancelAlgorithm, 0, undefined).
  2226. TRY(set_up_readable_byte_stream_controller(stream, controller, start_algorithm, pull_algorithm, cancel_algorithm, 0, JS::js_undefined()));
  2227. // 5. Return stream.
  2228. return stream;
  2229. }
  2230. // https://streams.spec.whatwg.org/#create-writable-stream
  2231. WebIDL::ExceptionOr<JS::NonnullGCPtr<WritableStream>> create_writable_stream(JS::Realm& realm, JS::NonnullGCPtr<StartAlgorithm> start_algorithm, JS::NonnullGCPtr<WriteAlgorithm> write_algorithm, JS::NonnullGCPtr<CloseAlgorithm> close_algorithm, JS::NonnullGCPtr<AbortAlgorithm> abort_algorithm, double high_water_mark, JS::NonnullGCPtr<SizeAlgorithm> size_algorithm)
  2232. {
  2233. // 1. Assert: ! IsNonNegativeNumber(highWaterMark) is true.
  2234. VERIFY(is_non_negative_number(JS::Value { high_water_mark }));
  2235. // 2. Let stream be a new WritableStream.
  2236. auto stream = realm.heap().allocate<WritableStream>(realm, realm);
  2237. // 3. Perform ! InitializeWritableStream(stream).
  2238. initialize_writable_stream(*stream);
  2239. // 4. Let controller be a new WritableStreamDefaultController.
  2240. auto controller = realm.heap().allocate<WritableStreamDefaultController>(realm, realm);
  2241. // 5. Perform ? SetUpWritableStreamDefaultController(stream, controller, startAlgorithm, writeAlgorithm, closeAlgorithm, abortAlgorithm, highWaterMark, sizeAlgorithm).
  2242. 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)));
  2243. // 6. Return stream.
  2244. return stream;
  2245. }
  2246. // https://streams.spec.whatwg.org/#initialize-readable-stream
  2247. void initialize_readable_stream(ReadableStream& stream)
  2248. {
  2249. // 1. Set stream.[[state]] to "readable".
  2250. stream.set_state(ReadableStream::State::Readable);
  2251. // 2. Set stream.[[reader]] and stream.[[storedError]] to undefined.
  2252. stream.set_reader({});
  2253. stream.set_stored_error({});
  2254. // 3. Set stream.[[disturbed]] to false.
  2255. stream.set_disturbed(false);
  2256. }
  2257. // https://streams.spec.whatwg.org/#initialize-writable-stream
  2258. void initialize_writable_stream(WritableStream& stream)
  2259. {
  2260. // 1. Set stream.[[state]] to "writable".
  2261. stream.set_state(WritableStream::State::Writable);
  2262. // 2. Set stream.[[storedError]], stream.[[writer]], stream.[[controller]], stream.[[inFlightWriteRequest]],
  2263. // stream.[[closeRequest]], stream.[[inFlightCloseRequest]], and stream.[[pendingAbortRequest]] to undefined.
  2264. stream.set_stored_error(JS::js_undefined());
  2265. stream.set_writer({});
  2266. stream.set_controller({});
  2267. stream.set_in_flight_write_request({});
  2268. stream.set_close_request({});
  2269. stream.set_in_flight_close_request({});
  2270. stream.set_pending_abort_request({});
  2271. // 3. Set stream.[[writeRequests]] to a new empty list.
  2272. stream.write_requests().clear();
  2273. // 4. Set stream.[[backpressure]] to false.
  2274. stream.set_backpressure(false);
  2275. }
  2276. // https://streams.spec.whatwg.org/#acquire-writable-stream-default-writer
  2277. WebIDL::ExceptionOr<JS::NonnullGCPtr<WritableStreamDefaultWriter>> acquire_writable_stream_default_writer(WritableStream& stream)
  2278. {
  2279. auto& realm = stream.realm();
  2280. // 1. Let writer be a new WritableStreamDefaultWriter.
  2281. auto writer = stream.heap().allocate<WritableStreamDefaultWriter>(realm, realm);
  2282. // 2. Perform ? SetUpWritableStreamDefaultWriter(writer, stream).
  2283. TRY(set_up_writable_stream_default_writer(*writer, stream));
  2284. // 3. Return writer.
  2285. return writer;
  2286. }
  2287. // https://streams.spec.whatwg.org/#is-writable-stream-locked
  2288. bool is_writable_stream_locked(WritableStream const& stream)
  2289. {
  2290. // 1. If stream.[[writer]] is undefined, return false.
  2291. if (!stream.writer())
  2292. return false;
  2293. // 2. Return true.
  2294. return true;
  2295. }
  2296. // https://streams.spec.whatwg.org/#set-up-writable-stream-default-writer
  2297. WebIDL::ExceptionOr<void> set_up_writable_stream_default_writer(WritableStreamDefaultWriter& writer, WritableStream& stream)
  2298. {
  2299. auto& realm = writer.realm();
  2300. // 1. If ! IsWritableStreamLocked(stream) is true, throw a TypeError exception.
  2301. if (is_writable_stream_locked(stream))
  2302. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, "Stream is locked"sv };
  2303. // 2. Set writer.[[stream]] to stream.
  2304. writer.set_stream(stream);
  2305. // 3. Set stream.[[writer]] to writer.
  2306. stream.set_writer(writer);
  2307. // 4. Let state be stream.[[state]].
  2308. auto state = stream.state();
  2309. // 5. If state is "writable",
  2310. if (state == WritableStream::State::Writable) {
  2311. // 1. If ! WritableStreamCloseQueuedOrInFlight(stream) is false and stream.[[backpressure]] is true, set writer.[[readyPromise]] to a new promise.
  2312. if (!writable_stream_close_queued_or_in_flight(stream) && stream.backpressure()) {
  2313. writer.set_ready_promise(WebIDL::create_promise(realm));
  2314. }
  2315. // 2. Otherwise, set writer.[[readyPromise]] to a promise resolved with undefined.
  2316. else {
  2317. writer.set_ready_promise(WebIDL::create_resolved_promise(realm, JS::js_undefined()));
  2318. }
  2319. // 3. Set writer.[[closedPromise]] to a new promise.
  2320. writer.set_closed_promise(WebIDL::create_promise(realm));
  2321. }
  2322. // 6. Otherwise, if state is "erroring",
  2323. else if (state == WritableStream::State::Erroring) {
  2324. // 1. Set writer.[[readyPromise]] to a promise rejected with stream.[[storedError]].
  2325. writer.set_ready_promise(WebIDL::create_rejected_promise(realm, stream.stored_error()));
  2326. // 2. Set writer.[[readyPromise]].[[PromiseIsHandled]] to true.
  2327. WebIDL::mark_promise_as_handled(*writer.ready_promise());
  2328. // 3. Set writer.[[closedPromise]] to a new promise.
  2329. writer.set_closed_promise(WebIDL::create_promise(realm));
  2330. }
  2331. // 7. Otherwise, if state is "closed",
  2332. else if (state == WritableStream::State::Closed) {
  2333. // 1. Set writer.[[readyPromise]] to a promise resolved with undefined.
  2334. writer.set_ready_promise(WebIDL::create_resolved_promise(realm, JS::js_undefined()));
  2335. // 2. Set writer.[[closedPromise]] to a promise resolved with undefined.
  2336. writer.set_closed_promise(WebIDL::create_resolved_promise(realm, JS::js_undefined()));
  2337. }
  2338. // 8. Otherwise,
  2339. else {
  2340. // 1. Assert: state is "errored".
  2341. VERIFY(state == WritableStream::State::Errored);
  2342. // 2. Let storedError be stream.[[storedError]].
  2343. auto stored_error = stream.stored_error();
  2344. // 3. Set writer.[[readyPromise]] to a promise rejected with storedError.
  2345. writer.set_ready_promise(WebIDL::create_rejected_promise(realm, stored_error));
  2346. // 4. Set writer.[[readyPromise]].[[PromiseIsHandled]] to true.
  2347. WebIDL::mark_promise_as_handled(*writer.ready_promise());
  2348. // 5. Set writer.[[closedPromise]] to a promise rejected with storedError.
  2349. writer.set_closed_promise(WebIDL::create_rejected_promise(realm, stored_error));
  2350. // 6. Set writer.[[closedPromise]].[[PromiseIsHandled]] to true.
  2351. WebIDL::mark_promise_as_handled(*writer.closed_promise());
  2352. }
  2353. return {};
  2354. }
  2355. // https://streams.spec.whatwg.org/#set-up-readable-byte-stream-controller
  2356. WebIDL::ExceptionOr<void> set_up_readable_byte_stream_controller(ReadableStream& stream, ReadableByteStreamController& controller, JS::NonnullGCPtr<StartAlgorithm> start_algorithm, JS::NonnullGCPtr<PullAlgorithm> pull_algorithm, JS::NonnullGCPtr<CancelAlgorithm> cancel_algorithm, double high_water_mark, JS::Value auto_allocate_chunk_size)
  2357. {
  2358. auto& realm = stream.realm();
  2359. // 1. Assert: stream.[[controller]] is undefined.
  2360. VERIFY(!stream.controller().has_value());
  2361. // 2. If autoAllocateChunkSize is not undefined,
  2362. if (!auto_allocate_chunk_size.is_undefined()) {
  2363. // 1. Assert: ! IsInteger(autoAllocateChunkSize) is true.
  2364. VERIFY(auto_allocate_chunk_size.is_integral_number());
  2365. // 2. Assert: autoAllocateChunkSize is positive.
  2366. VERIFY(auto_allocate_chunk_size.as_double() > 0);
  2367. }
  2368. // 3. Set controller.[[stream]] to stream.
  2369. controller.set_stream(stream);
  2370. // 4. Set controller.[[pullAgain]] and controller.[[pulling]] to false.
  2371. controller.set_pull_again(false);
  2372. controller.set_pulling(false);
  2373. // 5. Set controller.[[byobRequest]] to null.
  2374. controller.set_byob_request({});
  2375. // 6. Perform ! ResetQueue(controller).
  2376. reset_queue(controller);
  2377. // 7. Set controller.[[closeRequested]] and controller.[[started]] to false.
  2378. controller.set_close_requested(false);
  2379. controller.set_started(false);
  2380. // 8. Set controller.[[strategyHWM]] to highWaterMark.
  2381. controller.set_strategy_hwm(high_water_mark);
  2382. // 9. Set controller.[[pullAlgorithm]] to pullAlgorithm.
  2383. controller.set_pull_algorithm(pull_algorithm);
  2384. // 10. Set controller.[[cancelAlgorithm]] to cancelAlgorithm.
  2385. controller.set_cancel_algorithm(cancel_algorithm);
  2386. // 11. Set controller.[[autoAllocateChunkSize]] to autoAllocateChunkSize.
  2387. if (auto_allocate_chunk_size.is_integral_number())
  2388. controller.set_auto_allocate_chunk_size(auto_allocate_chunk_size.as_double());
  2389. // 12. Set controller.[[pendingPullIntos]] to a new empty list.
  2390. controller.pending_pull_intos().clear();
  2391. // 13. Set stream.[[controller]] to controller.
  2392. stream.set_controller(ReadableStreamController { controller });
  2393. // 14. Let startResult be the result of performing startAlgorithm.
  2394. auto start_result = TRY(start_algorithm->function()());
  2395. // 15. Let startPromise be a promise resolved with startResult.
  2396. auto start_promise = WebIDL::create_resolved_promise(realm, start_result);
  2397. // 16. Upon fulfillment of startPromise,
  2398. WebIDL::upon_fulfillment(start_promise, JS::create_heap_function(controller.heap(), [&controller](JS::Value) -> WebIDL::ExceptionOr<JS::Value> {
  2399. // 1. Set controller.[[started]] to true.
  2400. controller.set_started(true);
  2401. // 2. Assert: controller.[[pulling]] is false.
  2402. VERIFY(!controller.pulling());
  2403. // 3. Assert: controller.[[pullAgain]] is false.
  2404. VERIFY(!controller.pull_again());
  2405. // 4. Perform ! ReadableByteStreamControllerCallPullIfNeeded(controller).
  2406. readable_byte_stream_controller_call_pull_if_needed(controller);
  2407. return JS::js_undefined();
  2408. }));
  2409. // 17. Upon rejection of startPromise with reason r,
  2410. WebIDL::upon_rejection(start_promise, JS::create_heap_function(controller.heap(), [&controller](JS::Value r) -> WebIDL::ExceptionOr<JS::Value> {
  2411. // 1. Perform ! ReadableByteStreamControllerError(controller, r).
  2412. readable_byte_stream_controller_error(controller, r);
  2413. return JS::js_undefined();
  2414. }));
  2415. return {};
  2416. }
  2417. // https://streams.spec.whatwg.org/#readablestream-enqueue
  2418. WebIDL::ExceptionOr<void> readable_stream_enqueue(ReadableStreamController& controller, JS::Value chunk)
  2419. {
  2420. // 1. If stream.[[controller]] implements ReadableStreamDefaultController,
  2421. if (controller.has<JS::NonnullGCPtr<ReadableStreamDefaultController>>()) {
  2422. // 1. Perform ! ReadableStreamDefaultControllerEnqueue(stream.[[controller]], chunk).
  2423. return readable_stream_default_controller_enqueue(controller.get<JS::NonnullGCPtr<ReadableStreamDefaultController>>(), chunk);
  2424. }
  2425. // 2. Otherwise,
  2426. else {
  2427. // 1. Assert: stream.[[controller]] implements ReadableByteStreamController.
  2428. VERIFY(controller.has<JS::NonnullGCPtr<ReadableByteStreamController>>());
  2429. auto readable_byte_controller = controller.get<JS::NonnullGCPtr<ReadableByteStreamController>>();
  2430. // FIXME: 2. Assert: chunk is an ArrayBufferView.
  2431. // 3. Let byobView be the current BYOB request view for stream.
  2432. // FIXME: This is not what the spec means by 'current BYOB request view'
  2433. auto byob_view = readable_byte_controller->raw_byob_request();
  2434. // 4. If byobView is non-null, and chunk.[[ViewedArrayBuffer]] is byobView.[[ViewedArrayBuffer]], then:
  2435. if (byob_view) {
  2436. // FIXME: 1. Assert: chunk.[[ByteOffset]] is byobView.[[ByteOffset]].
  2437. // FIXME: 2. Assert: chunk.[[ByteLength]] ≤ byobView.[[ByteLength]].
  2438. // FIXME: 3. Perform ? ReadableByteStreamControllerRespond(stream.[[controller]], chunk.[[ByteLength]]).
  2439. TODO();
  2440. }
  2441. // 5. Otherwise, perform ? ReadableByteStreamControllerEnqueue(stream.[[controller]], chunk).
  2442. return readable_byte_stream_controller_enqueue(readable_byte_controller, chunk);
  2443. }
  2444. }
  2445. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-enqueue
  2446. WebIDL::ExceptionOr<void> readable_byte_stream_controller_enqueue(ReadableByteStreamController& controller, JS::Value chunk)
  2447. {
  2448. auto& vm = controller.vm();
  2449. auto& realm = controller.realm();
  2450. // 1. Let stream be controller.[[stream]].
  2451. auto stream = controller.stream();
  2452. // 2. If controller.[[closeRequested]] is true or stream.[[state]] is not "readable", return.
  2453. if (controller.close_requested() || stream->state() != ReadableStream ::State::Readable)
  2454. return {};
  2455. // 3. Let buffer be chunk.[[ViewedArrayBuffer]].
  2456. auto* typed_array = TRY(JS::typed_array_from(vm, chunk));
  2457. auto* buffer = typed_array->viewed_array_buffer();
  2458. // 4. Let byteOffset be chunk.[[ByteOffset]].
  2459. auto byte_offset = typed_array->byte_offset();
  2460. // 6. If ! IsDetachedBuffer(buffer) is true, throw a TypeError exception.
  2461. // FIXME: The streams spec has not been updated for resizable ArrayBuffer objects. We must perform step 6 before
  2462. // invoking TypedArrayByteLength in step 5. We also must check if the array is out-of-bounds, rather than
  2463. // just detached.
  2464. auto typed_array_record = JS::make_typed_array_with_buffer_witness_record(*typed_array, JS::ArrayBuffer::Order::SeqCst);
  2465. if (JS::is_typed_array_out_of_bounds(typed_array_record))
  2466. return vm.throw_completion<JS::TypeError>(JS::ErrorType::BufferOutOfBounds, "TypedArray"sv);
  2467. // 5. Let byteLength be chunk.[[ByteLength]].
  2468. auto byte_length = JS::typed_array_byte_length(typed_array_record);
  2469. // 7. Let transferredBuffer be ? TransferArrayBuffer(buffer).
  2470. auto transferred_buffer = TRY(transfer_array_buffer(realm, *buffer));
  2471. // 8. If controller.[[pendingPullIntos]] is not empty,
  2472. if (!controller.pending_pull_intos().is_empty()) {
  2473. // 1. Let firstPendingPullInto be controller.[[pendingPullIntos]][0].
  2474. auto& first_pending_pull_into = controller.pending_pull_intos().first();
  2475. // 2. If ! IsDetachedBuffer(firstPendingPullInto’s buffer) is true, throw a TypeError exception.
  2476. if (first_pending_pull_into.buffer->is_detached()) {
  2477. auto error = JS::TypeError::create(realm, "Buffer is detached"sv);
  2478. return JS::throw_completion(error);
  2479. }
  2480. // 3. Perform ! ReadableByteStreamControllerInvalidateBYOBRequest(controller).
  2481. readable_byte_stream_controller_invalidate_byob_request(controller);
  2482. // 4. Set firstPendingPullInto’s buffer to ! TransferArrayBuffer(firstPendingPullInto’s buffer).
  2483. first_pending_pull_into.buffer = MUST(transfer_array_buffer(realm, first_pending_pull_into.buffer));
  2484. // 5. If firstPendingPullInto’s reader type is "none", perform ? ReadableByteStreamControllerEnqueueDetachedPullIntoToQueue(controller, firstPendingPullInto).
  2485. if (first_pending_pull_into.reader_type == ReaderType::None)
  2486. TRY(readable_byte_stream_controller_enqueue_detached_pull_into_queue(controller, first_pending_pull_into));
  2487. }
  2488. // 9. If ! ReadableStreamHasDefaultReader(stream) is true,
  2489. if (readable_stream_has_default_reader(*stream)) {
  2490. // 1. Perform ! ReadableByteStreamControllerProcessReadRequestsUsingQueue(controller).
  2491. readable_byte_stream_controller_process_read_requests_using_queue(controller);
  2492. // 2. If ! ReadableStreamGetNumReadRequests(stream) is 0,
  2493. if (readable_stream_get_num_read_requests(*stream) == 0) {
  2494. // 1. Assert: controller.[[pendingPullIntos]] is empty.
  2495. VERIFY(controller.pending_pull_intos().is_empty());
  2496. // 2. Perform ! ReadableByteStreamControllerEnqueueChunkToQueue(controller, transferredBuffer, byteOffset, byteLength).
  2497. readable_byte_stream_controller_enqueue_chunk_to_queue(controller, transferred_buffer, byte_offset, byte_length);
  2498. }
  2499. // 3. Otherwise.
  2500. else {
  2501. // 1. Assert: controller.[[queue]] is empty.
  2502. VERIFY(controller.queue().is_empty());
  2503. // 2. If controller.[[pendingPullIntos]] is not empty,
  2504. if (!controller.pending_pull_intos().is_empty()) {
  2505. // 1. Assert: controller.[[pendingPullIntos]][0]'s reader type is "default".
  2506. VERIFY(controller.pending_pull_intos().first().reader_type == ReaderType::Default);
  2507. // 2. Perform ! ReadableByteStreamControllerShiftPendingPullInto(controller).
  2508. readable_byte_stream_controller_shift_pending_pull_into(controller);
  2509. }
  2510. // 3. Let transferredView be ! Construct(%Uint8Array%, « transferredBuffer, byteOffset, byteLength »).
  2511. auto transferred_view = MUST(JS::construct(vm, *realm.intrinsics().uint8_array_constructor(), transferred_buffer, JS::Value(byte_offset), JS::Value(byte_length)));
  2512. // 4. Perform ! ReadableStreamFulfillReadRequest(stream, transferredView, false).
  2513. readable_stream_fulfill_read_request(*stream, transferred_view, false);
  2514. }
  2515. }
  2516. // 10. Otherwise, if ! ReadableStreamHasBYOBReader(stream) is true,
  2517. else if (readable_stream_has_byob_reader(*stream)) {
  2518. // 1. Perform ! ReadableByteStreamControllerEnqueueChunkToQueue(controller, transferredBuffer, byteOffset, byteLength).
  2519. readable_byte_stream_controller_enqueue_chunk_to_queue(controller, transferred_buffer, byte_offset, byte_length);
  2520. // 2. Perform ! ReadableByteStreamControllerProcessPullIntoDescriptorsUsingQueue(controller).
  2521. readable_byte_stream_controller_process_pull_into_descriptors_using_queue(controller);
  2522. }
  2523. // 11. Otherwise,
  2524. else {
  2525. // 1. Assert: ! IsReadableStreamLocked(stream) is false.
  2526. VERIFY(!is_readable_stream_locked(*stream));
  2527. // 2. Perform ! ReadableByteStreamControllerEnqueueChunkToQueue(controller, transferredBuffer, byteOffset, byteLength).
  2528. readable_byte_stream_controller_enqueue_chunk_to_queue(controller, transferred_buffer, byte_offset, byte_length);
  2529. }
  2530. // 12. Perform ! ReadableByteStreamControllerCallPullIfNeeded(controller).
  2531. readable_byte_stream_controller_call_pull_if_needed(controller);
  2532. return {};
  2533. }
  2534. // https://streams.spec.whatwg.org/#readablestream-pull-from-bytes
  2535. WebIDL::ExceptionOr<void> readable_stream_pull_from_bytes(ReadableStream& stream, ByteBuffer bytes)
  2536. {
  2537. // 1. Assert: stream.[[controller]] implements ReadableByteStreamController.
  2538. auto controller = stream.controller()->get<JS::NonnullGCPtr<ReadableByteStreamController>>();
  2539. // 2. Let available be bytes’s length.
  2540. auto available = bytes.size();
  2541. // 3. Let desiredSize be available.
  2542. auto desired_size = available;
  2543. // FIXME: 4. If stream’s current BYOB request view is non-null, then set desiredSize to stream’s current BYOB request
  2544. // view's byte length.
  2545. // 5. Let pullSize be the smaller value of available and desiredSize.
  2546. auto pull_size = min(available, desired_size);
  2547. // 6. Let pulled be the first pullSize bytes of bytes.
  2548. auto pulled = pull_size == available ? move(bytes) : MUST(bytes.slice(0, pull_size));
  2549. // 7. Remove the first pullSize bytes from bytes.
  2550. if (pull_size != available)
  2551. bytes = MUST(bytes.slice(pull_size, available - pull_size));
  2552. // FIXME: 8. If stream’s current BYOB request view is non-null, then:
  2553. // 1. Write pulled into stream’s current BYOB request view.
  2554. // 2. Perform ? ReadableByteStreamControllerRespond(stream.[[controller]], pullSize).
  2555. // 9. Otherwise,
  2556. {
  2557. auto& realm = HTML::relevant_realm(stream);
  2558. // 1. Set view to the result of creating a Uint8Array from pulled in stream’s relevant Realm.
  2559. auto array_buffer = JS::ArrayBuffer::create(realm, move(pulled));
  2560. auto view = JS::Uint8Array::create(realm, array_buffer->byte_length(), *array_buffer);
  2561. // 2. Perform ? ReadableByteStreamControllerEnqueue(stream.[[controller]], view).
  2562. TRY(readable_byte_stream_controller_enqueue(controller, view));
  2563. }
  2564. return {};
  2565. }
  2566. // https://streams.spec.whatwg.org/#transfer-array-buffer
  2567. WebIDL::ExceptionOr<JS::NonnullGCPtr<JS::ArrayBuffer>> transfer_array_buffer(JS::Realm& realm, JS::ArrayBuffer& buffer)
  2568. {
  2569. auto& vm = realm.vm();
  2570. // 1. Assert: ! IsDetachedBuffer(O) is false.
  2571. VERIFY(!buffer.is_detached());
  2572. // 2. Let arrayBufferData be O.[[ArrayBufferData]].
  2573. // 3. Let arrayBufferByteLength be O.[[ArrayBufferByteLength]].
  2574. auto array_buffer = buffer.buffer();
  2575. // 4. Perform ? DetachArrayBuffer(O).
  2576. TRY(JS::detach_array_buffer(vm, buffer));
  2577. // 5. Return a new ArrayBuffer object, created in the current Realm, whose [[ArrayBufferData]] internal slot value is arrayBufferData and whose [[ArrayBufferByteLength]] internal slot value is arrayBufferByteLength.
  2578. return JS::ArrayBuffer::create(realm, move(array_buffer));
  2579. }
  2580. // https://streams.spec.whatwg.org/#abstract-opdef-readablebytestreamcontrollerenqueuedetachedpullintotoqueue
  2581. WebIDL::ExceptionOr<void> readable_byte_stream_controller_enqueue_detached_pull_into_queue(ReadableByteStreamController& controller, PullIntoDescriptor& pull_into_descriptor)
  2582. {
  2583. // 1. Assert: pullIntoDescriptor’s reader type is "none".
  2584. VERIFY(pull_into_descriptor.reader_type == ReaderType::None);
  2585. // 2. If pullIntoDescriptor’s bytes filled > 0, perform ? ReadableByteStreamControllerEnqueueClonedChunkToQueue(controller, pullIntoDescriptor’s buffer, pullIntoDescriptor’s byte offset, pullIntoDescriptor’s bytes filled).
  2586. if (pull_into_descriptor.bytes_filled > 0)
  2587. TRY(readable_byte_stream_controller_enqueue_cloned_chunk_to_queue(controller, pull_into_descriptor.buffer, pull_into_descriptor.byte_offset, pull_into_descriptor.bytes_filled));
  2588. // 3. Perform ! ReadableByteStreamControllerShiftPendingPullInto(controller).
  2589. readable_byte_stream_controller_shift_pending_pull_into(controller);
  2590. return {};
  2591. }
  2592. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-commit-pull-into-descriptor
  2593. void readable_byte_stream_controller_commit_pull_into_descriptor(ReadableStream& stream, PullIntoDescriptor const& pull_into_descriptor)
  2594. {
  2595. // 1. Assert: stream.[[state]] is not "errored".
  2596. VERIFY(!stream.is_errored());
  2597. // 2. Assert: pullIntoDescriptor.reader type is not "none".
  2598. VERIFY(pull_into_descriptor.reader_type != ReaderType::None);
  2599. // 3. Let done be false.
  2600. bool done = false;
  2601. // 4. If stream.[[state]] is "closed",
  2602. if (stream.is_closed()) {
  2603. // 1. Assert: pullIntoDescriptor’s bytes filled is 0.
  2604. VERIFY(pull_into_descriptor.bytes_filled == 0);
  2605. // 2. Set done to true.
  2606. done = true;
  2607. }
  2608. // 5. Let filledView be ! ReadableByteStreamControllerConvertPullIntoDescriptor(pullIntoDescriptor).
  2609. auto filled_view = readable_byte_stream_controller_convert_pull_into_descriptor(stream.realm(), pull_into_descriptor);
  2610. // 6. If pullIntoDescriptor’s reader type is "default",
  2611. if (pull_into_descriptor.reader_type == ReaderType::Default) {
  2612. // 1. Perform ! ReadableStreamFulfillReadRequest(stream, filledView, done).
  2613. readable_stream_fulfill_read_request(stream, filled_view, done);
  2614. }
  2615. // 7. Otherwise,
  2616. else {
  2617. // 1. Assert: pullIntoDescriptor’s reader type is "byob".
  2618. VERIFY(pull_into_descriptor.reader_type == ReaderType::Byob);
  2619. // 2. Perform ! ReadableStreamFulfillReadIntoRequest(stream, filledView, done).
  2620. readable_stream_fulfill_read_into_request(stream, filled_view, done);
  2621. }
  2622. }
  2623. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-process-pull-into-descriptors-using-queue
  2624. void readable_byte_stream_controller_process_pull_into_descriptors_using_queue(ReadableByteStreamController& controller)
  2625. {
  2626. // 1. Assert: controller.[[closeRequested]] is false.
  2627. VERIFY(!controller.close_requested());
  2628. // 2. While controller.[[pendingPullIntos]] is not empty,
  2629. while (!controller.pending_pull_intos().is_empty()) {
  2630. // 1. If controller.[[queueTotalSize]] is 0, return.
  2631. if (controller.queue_total_size() == 0)
  2632. return;
  2633. // 2. Let pullIntoDescriptor be controller.[[pendingPullIntos]][0].
  2634. auto& pull_into_descriptor = controller.pending_pull_intos().first();
  2635. // 3. If ! ReadableByteStreamControllerFillPullIntoDescriptorFromQueue(controller, pullIntoDescriptor) is true,
  2636. if (readable_byte_stream_controller_fill_pull_into_descriptor_from_queue(controller, pull_into_descriptor)) {
  2637. // NOTE: We store the returned pull into descriptor here as the 'shift pending pull into' will remove
  2638. // the first entry into the list which we have a reference to above.
  2639. // 1. Perform ! ReadableByteStreamControllerShiftPendingPullInto(controller).
  2640. auto descriptor = readable_byte_stream_controller_shift_pending_pull_into(controller);
  2641. // 2. Perform ! ReadableByteStreamControllerCommitPullIntoDescriptor(controller.[[stream]], pullIntoDescriptor).
  2642. readable_byte_stream_controller_commit_pull_into_descriptor(*controller.stream(), descriptor);
  2643. }
  2644. }
  2645. }
  2646. // https://streams.spec.whatwg.org/#abstract-opdef-readablebytestreamcontrollerprocessreadrequestsusingqueue
  2647. void readable_byte_stream_controller_process_read_requests_using_queue(ReadableByteStreamController& controller)
  2648. {
  2649. // 1. Let reader be controller.[[stream]].[[reader]].
  2650. auto reader = controller.stream()->reader();
  2651. // 2. Assert: reader implements ReadableStreamDefaultReader.
  2652. VERIFY(reader->has<JS::NonnullGCPtr<ReadableStreamDefaultReader>>());
  2653. // 3. While reader.[[readRequests]] is not empty,
  2654. auto readable_stream_default_reader = reader->get<JS::NonnullGCPtr<ReadableStreamDefaultReader>>();
  2655. while (!readable_stream_default_reader->read_requests().is_empty()) {
  2656. // 1. If controller.[[queueTotalSize]] is 0, return.
  2657. if (controller.queue_total_size() == 0.0)
  2658. return;
  2659. // 2. Let readRequest be reader.[[readRequests]][0].
  2660. // 3. Remove readRequest from reader.[[readRequests]].
  2661. auto read_request = readable_stream_default_reader->read_requests().take_first();
  2662. // 4. Perform ! ReadableByteStreamControllerFillReadRequestFromQueue(controller, readRequest).
  2663. readable_byte_stream_controller_fill_read_request_from_queue(controller, read_request);
  2664. }
  2665. }
  2666. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-enqueue-chunk-to-queue
  2667. void readable_byte_stream_controller_enqueue_chunk_to_queue(ReadableByteStreamController& controller, JS::NonnullGCPtr<JS::ArrayBuffer> buffer, u32 byte_offset, u32 byte_length)
  2668. {
  2669. // 1. Append a new readable byte stream queue entry with buffer buffer, byte offset byteOffset, and byte length byteLength to controller.[[queue]].
  2670. controller.queue().append(ReadableByteStreamQueueEntry {
  2671. .buffer = buffer,
  2672. .byte_offset = byte_offset,
  2673. .byte_length = byte_length,
  2674. });
  2675. // 2. Set controller.[[queueTotalSize]] to controller.[[queueTotalSize]] + byteLength.
  2676. controller.set_queue_total_size(controller.queue_total_size() + byte_length);
  2677. }
  2678. // https://streams.spec.whatwg.org/#abstract-opdef-readablebytestreamcontrollerenqueueclonedchunktoqueue
  2679. WebIDL::ExceptionOr<void> readable_byte_stream_controller_enqueue_cloned_chunk_to_queue(ReadableByteStreamController& controller, JS::ArrayBuffer& buffer, u64 byte_offset, u64 byte_length)
  2680. {
  2681. auto& vm = controller.vm();
  2682. // 1. Let cloneResult be CloneArrayBuffer(buffer, byteOffset, byteLength, %ArrayBuffer%).
  2683. auto clone_result = JS::clone_array_buffer(vm, buffer, byte_offset, byte_length);
  2684. // 2. If cloneResult is an abrupt completion,
  2685. if (clone_result.is_throw_completion()) {
  2686. auto throw_completion = Bindings::throw_dom_exception_if_needed(vm, [&] { return clone_result; }).throw_completion();
  2687. // 1. Perform ! ReadableByteStreamControllerError(controller, cloneResult.[[Value]]).
  2688. readable_byte_stream_controller_error(controller, throw_completion.value().value());
  2689. // 2. Return cloneResult.
  2690. // Note: We need to return the throw_completion object here, as enqueue needs to throw the same object that the controller is errored with
  2691. return throw_completion;
  2692. }
  2693. // 3. Perform ! ReadableByteStreamControllerEnqueueChunkToQueue(controller, cloneResult.[[Value]], 0, byteLength).
  2694. readable_byte_stream_controller_enqueue_chunk_to_queue(controller, *clone_result.release_value(), 0, byte_length);
  2695. return {};
  2696. }
  2697. // https://streams.spec.whatwg.org/#readable-byte-stream-controller-shift-pending-pull-into
  2698. PullIntoDescriptor readable_byte_stream_controller_shift_pending_pull_into(ReadableByteStreamController& controller)
  2699. {
  2700. // 1. Assert: controller.[[byobRequest]] is null.
  2701. VERIFY(!controller.raw_byob_request());
  2702. // 2. Let descriptor be controller.[[pendingPullIntos]][0].
  2703. // 3. Remove descriptor from controller.[[pendingPullIntos]].
  2704. auto descriptor = controller.pending_pull_intos().take_first();
  2705. // 4. Return descriptor.
  2706. return descriptor;
  2707. }
  2708. // https://streams.spec.whatwg.org/#readablestream-set-up-with-byte-reading-support
  2709. void set_up_readable_stream_controller_with_byte_reading_support(ReadableStream& stream, JS::GCPtr<PullAlgorithm> pull_algorithm, JS::GCPtr<CancelAlgorithm> cancel_algorithm, double high_water_mark)
  2710. {
  2711. auto& realm = stream.realm();
  2712. // 1. Let startAlgorithm be an algorithm that returns undefined.
  2713. auto start_algorithm = JS::create_heap_function(realm.heap(), []() -> WebIDL::ExceptionOr<JS::Value> { return JS::js_undefined(); });
  2714. // 2. Let pullAlgorithmWrapper be an algorithm that runs these steps:
  2715. auto pull_algorithm_wrapper = JS::create_heap_function(realm.heap(), [&realm, pull_algorithm]() {
  2716. // 1. Let result be the result of running pullAlgorithm, if pullAlgorithm was given, or null otherwise. If this throws an exception e, return a promise rejected with e.
  2717. JS::GCPtr<JS::PromiseCapability> result = nullptr;
  2718. if (pull_algorithm)
  2719. result = pull_algorithm->function()();
  2720. // 2. If result is a Promise, then return result.
  2721. if (result != nullptr)
  2722. return JS::NonnullGCPtr(*result);
  2723. // 3. Return a promise resolved with undefined.
  2724. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  2725. });
  2726. // 3. Let cancelAlgorithmWrapper be an algorithm that runs these steps:
  2727. auto cancel_algorithm_wrapper = JS::create_heap_function(realm.heap(), [&realm, cancel_algorithm](JS::Value c) {
  2728. // 1. Let result be the result of running cancelAlgorithm, if cancelAlgorithm was given, or null otherwise. If this throws an exception e, return a promise rejected with e.
  2729. JS::GCPtr<JS::PromiseCapability> result = nullptr;
  2730. if (cancel_algorithm)
  2731. result = cancel_algorithm->function()(c);
  2732. // 2. If result is a Promise, then return result.
  2733. if (result != nullptr)
  2734. return JS::NonnullGCPtr(*result);
  2735. // 3. Return a promise resolved with undefined.
  2736. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  2737. });
  2738. // 4. Perform ! InitializeReadableStream(stream).
  2739. // 5. Let controller be a new ReadableByteStreamController.
  2740. auto controller = stream.heap().allocate<ReadableByteStreamController>(realm, realm);
  2741. // 6. Perform ! SetUpReadableByteStreamController(stream, controller, startAlgorithm, pullAlgorithmWrapper, cancelAlgorithmWrapper, highWaterMark, undefined).
  2742. MUST(set_up_readable_byte_stream_controller(stream, controller, start_algorithm, pull_algorithm_wrapper, cancel_algorithm_wrapper, high_water_mark, JS::js_undefined()));
  2743. }
  2744. // https://streams.spec.whatwg.org/#writable-stream-abort
  2745. JS::NonnullGCPtr<WebIDL::Promise> writable_stream_abort(WritableStream& stream, JS::Value reason)
  2746. {
  2747. auto& realm = stream.realm();
  2748. // 1. If stream.[[state]] is "closed" or "errored", return a promise resolved with undefined.
  2749. auto state = stream.state();
  2750. if (state == WritableStream::State::Closed || state == WritableStream::State::Errored)
  2751. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  2752. // 2. Signal abort on stream.[[controller]].[[signal]] with reason.
  2753. stream.controller()->signal()->signal_abort(reason);
  2754. // 3. Let state be stream.[[state]].
  2755. state = stream.state();
  2756. // 4. If state is "closed" or "errored", return a promise resolved with undefined.
  2757. if (state == WritableStream::State::Closed || state == WritableStream::State::Errored)
  2758. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  2759. // 5. If stream.[[pendingAbortRequest]] is not undefined, return stream.[[pendingAbortRequest]]'s promise.
  2760. if (stream.pending_abort_request().has_value())
  2761. return stream.pending_abort_request()->promise;
  2762. // 6. Assert: state is "writable" or "erroring".
  2763. VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
  2764. // 7. Let wasAlreadyErroring be false.
  2765. auto was_already_erroring = false;
  2766. // 8. If state is "erroring",
  2767. if (state == WritableStream::State::Erroring) {
  2768. // 1. Set wasAlreadyErroring to true.
  2769. was_already_erroring = true;
  2770. // 2. Set reason to undefined.
  2771. reason = JS::js_undefined();
  2772. }
  2773. // 9. Let promise be a new promise.
  2774. auto promise = WebIDL::create_promise(realm);
  2775. // 10. Set stream.[[pendingAbortRequest]] to a new pending abort request whose promise is promise, reason is reason, and was already erroring is wasAlreadyErroring.
  2776. stream.set_pending_abort_request(PendingAbortRequest { promise, reason, was_already_erroring });
  2777. // 11. If wasAlreadyErroring is false, perform ! WritableStreamStartErroring(stream, reason).
  2778. if (!was_already_erroring)
  2779. writable_stream_start_erroring(stream, reason);
  2780. // 12. Return promise.
  2781. return promise;
  2782. }
  2783. // https://streams.spec.whatwg.org/#writable-stream-close
  2784. JS::NonnullGCPtr<WebIDL::Promise> writable_stream_close(WritableStream& stream)
  2785. {
  2786. auto& realm = stream.realm();
  2787. // 1. Let state be stream.[[state]].
  2788. auto state = stream.state();
  2789. // 2. If state is "closed" or "errored", return a promise rejected with a TypeError exception.
  2790. if (state == WritableStream::State::Closed || state == WritableStream::State::Errored) {
  2791. auto message = state == WritableStream::State::Closed ? "Cannot close a closed stream"sv : "Cannot close an errored stream"sv;
  2792. auto exception = JS::TypeError::create(realm, message);
  2793. return WebIDL::create_rejected_promise(realm, exception);
  2794. }
  2795. // 3. Assert: state is "writable" or "erroring".
  2796. VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
  2797. // 4. Assert: ! WritableStreamCloseQueuedOrInFlight(stream) is false.
  2798. VERIFY(!writable_stream_close_queued_or_in_flight(stream));
  2799. // 5. Let promise be a new promise.
  2800. auto promise = WebIDL::create_promise(realm);
  2801. // 6. Set stream.[[closeRequest]] to promise.
  2802. stream.set_close_request(promise);
  2803. // 7. Let writer be stream.[[writer]].
  2804. auto writer = stream.writer();
  2805. // 8. If writer is not undefined, and stream.[[backpressure]] is true, and state is "writable", resolve writer.[[readyPromise]] with undefined.
  2806. if (writer && stream.backpressure() && state == WritableStream::State::Writable)
  2807. WebIDL::resolve_promise(realm, *writer->ready_promise(), JS::js_undefined());
  2808. // 9. Perform ! WritableStreamDefaultControllerClose(stream.[[controller]]).
  2809. writable_stream_default_controller_close(*stream.controller());
  2810. // 10. Return promise.
  2811. return promise;
  2812. }
  2813. // https://streams.spec.whatwg.org/#writable-stream-add-write-request
  2814. JS::NonnullGCPtr<WebIDL::Promise> writable_stream_add_write_request(WritableStream& stream)
  2815. {
  2816. auto& realm = stream.realm();
  2817. // 1. Assert: ! IsWritableStreamLocked(stream) is true.
  2818. VERIFY(is_writable_stream_locked(stream));
  2819. // 2. Assert: stream.[[state]] is "writable".
  2820. VERIFY(stream.state() == WritableStream::State::Writable);
  2821. // 3. Let promise be a new promise.
  2822. auto promise = WebIDL::create_promise(realm);
  2823. // 4. Append promise to stream.[[writeRequests]].
  2824. stream.write_requests().append(promise);
  2825. // 5. Return promise.
  2826. return promise;
  2827. }
  2828. // https://streams.spec.whatwg.org/#writable-stream-close-queued-or-in-flight
  2829. bool writable_stream_close_queued_or_in_flight(WritableStream const& stream)
  2830. {
  2831. // 1. If stream.[[closeRequest]] is undefined and stream.[[inFlightCloseRequest]] is undefined, return false.
  2832. if (!stream.close_request() && !stream.in_flight_close_request())
  2833. return false;
  2834. // 2. Return true.
  2835. return true;
  2836. }
  2837. // https://streams.spec.whatwg.org/#writable-stream-deal-with-rejection
  2838. void writable_stream_deal_with_rejection(WritableStream& stream, JS::Value error)
  2839. {
  2840. // 1. Let state be stream.[[state]].
  2841. auto state = stream.state();
  2842. // 2. If state is "writable",
  2843. if (state == WritableStream::State::Writable) {
  2844. // 1. Perform ! WritableStreamStartErroring(stream, error).
  2845. writable_stream_start_erroring(stream, error);
  2846. // 2. Return.
  2847. return;
  2848. }
  2849. // 3. Assert: state is "erroring".
  2850. VERIFY(state == WritableStream::State::Erroring);
  2851. // 4. Perform ! WritableStreamFinishErroring(stream).
  2852. writable_stream_finish_erroring(stream);
  2853. }
  2854. // https://streams.spec.whatwg.org/#writable-stream-finish-erroring
  2855. void writable_stream_finish_erroring(WritableStream& stream)
  2856. {
  2857. auto& realm = stream.realm();
  2858. // 1. Assert: stream.[[state]] is "erroring".
  2859. VERIFY(stream.state() == WritableStream::State::Erroring);
  2860. // 2. Assert: ! WritableStreamHasOperationMarkedInFlight(stream) is false.
  2861. VERIFY(!writable_stream_has_operation_marked_in_flight(stream));
  2862. // 3. Set stream.[[state]] to "errored".
  2863. stream.set_state(WritableStream::State::Errored);
  2864. // 4. Perform ! stream.[[controller]].[[ErrorSteps]]().
  2865. stream.controller()->error_steps();
  2866. // 5. Let storedError be stream.[[storedError]].
  2867. auto stored_error = stream.stored_error();
  2868. // 6. For each writeRequest of stream.[[writeRequests]]:
  2869. for (auto& write_request : stream.write_requests()) {
  2870. // 1. Reject writeRequest with storedError.
  2871. WebIDL::reject_promise(realm, *write_request, stored_error);
  2872. }
  2873. // 7. Set stream.[[writeRequests]] to an empty list.
  2874. stream.write_requests().clear();
  2875. // 8. If stream.[[pendingAbortRequest]] is undefined,
  2876. if (!stream.pending_abort_request().has_value()) {
  2877. // 1. Perform ! WritableStreamRejectCloseAndClosedPromiseIfNeeded(stream).
  2878. writable_stream_reject_close_and_closed_promise_if_needed(stream);
  2879. // 2. Return.
  2880. return;
  2881. }
  2882. // 9. Let abortRequest be stream.[[pendingAbortRequest]].
  2883. // 10. Set stream.[[pendingAbortRequest]] to undefined.
  2884. auto abort_request = stream.pending_abort_request().release_value();
  2885. // 11. If abortRequest’s was already erroring is true,
  2886. if (abort_request.was_already_erroring) {
  2887. // 1. Reject abortRequest’s promise with storedError.
  2888. WebIDL::reject_promise(realm, abort_request.promise, stored_error);
  2889. // 2. Perform ! WritableStreamRejectCloseAndClosedPromiseIfNeeded(stream).
  2890. writable_stream_reject_close_and_closed_promise_if_needed(stream);
  2891. // 3. Return.
  2892. return;
  2893. }
  2894. // 12. Let promise be ! stream.[[controller]].[[AbortSteps]](abortRequest’s reason).
  2895. auto promise = stream.controller()->abort_steps(abort_request.reason);
  2896. // 13. Upon fulfillment of promise,
  2897. WebIDL::upon_fulfillment(*promise, JS::create_heap_function(realm.heap(), [&realm, &stream, abort_promise = abort_request.promise](JS::Value) -> WebIDL::ExceptionOr<JS::Value> {
  2898. // 1. Resolve abortRequest’s promise with undefined.
  2899. WebIDL::resolve_promise(realm, abort_promise, JS::js_undefined());
  2900. // 2. Perform ! WritableStreamRejectCloseAndClosedPromiseIfNeeded(stream).
  2901. writable_stream_reject_close_and_closed_promise_if_needed(stream);
  2902. return JS::js_undefined();
  2903. }));
  2904. // 14. Upon rejection of promise with reason reason,
  2905. WebIDL::upon_rejection(*promise, JS::create_heap_function(realm.heap(), [&realm, &stream, abort_promise = abort_request.promise](JS::Value reason) -> WebIDL::ExceptionOr<JS::Value> {
  2906. // 1. Reject abortRequest’s promise with reason.
  2907. WebIDL::reject_promise(realm, abort_promise, reason);
  2908. // 2. Perform ! WritableStreamRejectCloseAndClosedPromiseIfNeeded(stream).
  2909. writable_stream_reject_close_and_closed_promise_if_needed(stream);
  2910. return JS::js_undefined();
  2911. }));
  2912. }
  2913. // https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-close
  2914. void writable_stream_finish_in_flight_close(WritableStream& stream)
  2915. {
  2916. auto& realm = stream.realm();
  2917. // 1. Assert: stream.[[inFlightCloseRequest]] is not undefined.
  2918. VERIFY(stream.in_flight_close_request());
  2919. // 2. Resolve stream.[[inFlightCloseRequest]] with undefined.
  2920. WebIDL::resolve_promise(realm, *stream.in_flight_close_request(), JS::js_undefined());
  2921. // 3. Set stream.[[inFlightCloseRequest]] to undefined.
  2922. stream.set_in_flight_close_request({});
  2923. // 4. Let state be stream.[[state]].
  2924. auto state = stream.state();
  2925. // 5. Assert: stream.[[state]] is "writable" or "erroring".
  2926. VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
  2927. // 6. If state is "erroring",
  2928. if (state == WritableStream::State::Erroring) {
  2929. // 1. Set stream.[[storedError]] to undefined.
  2930. stream.set_stored_error(JS::js_undefined());
  2931. // 2. If stream.[[pendingAbortRequest]] is not undefined,
  2932. if (stream.pending_abort_request().has_value()) {
  2933. // 1. Resolve stream.[[pendingAbortRequest]]'s promise with undefined.
  2934. // 2. Set stream.[[pendingAbortRequest]] to undefined.
  2935. WebIDL::resolve_promise(realm, stream.pending_abort_request().release_value().promise, JS::js_undefined());
  2936. }
  2937. }
  2938. // 7. Set stream.[[state]] to "closed".
  2939. stream.set_state(WritableStream::State::Closed);
  2940. // 8. Let writer be stream.[[writer]].
  2941. auto writer = stream.writer();
  2942. // 9. If writer is not undefined, resolve writer.[[closedPromise]] with undefined.
  2943. if (writer)
  2944. WebIDL::resolve_promise(realm, *writer->closed_promise(), JS::js_undefined());
  2945. // 10. Assert: stream.[[pendingAbortRequest]] is undefined.
  2946. VERIFY(!stream.pending_abort_request().has_value());
  2947. // 11. Assert: stream.[[storedError]] is undefined.
  2948. VERIFY(stream.stored_error().is_undefined());
  2949. }
  2950. // https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-close-with-error
  2951. void writable_stream_finish_in_flight_close_with_error(WritableStream& stream, JS::Value error)
  2952. {
  2953. auto& realm = stream.realm();
  2954. // 1. Assert: stream.[[inFlightCloseRequest]] is not undefined.
  2955. VERIFY(stream.in_flight_close_request());
  2956. // 2. Reject stream.[[inFlightCloseRequest]] with error.
  2957. WebIDL::reject_promise(realm, *stream.in_flight_close_request(), error);
  2958. // 3. Set stream.[[inFlightCloseRequest]] to undefined.
  2959. stream.set_in_flight_close_request({});
  2960. // 4. Assert: stream.[[state]] is "writable" or "erroring".
  2961. auto state = stream.state();
  2962. VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
  2963. // 5. If stream.[[pendingAbortRequest]] is not undefined,
  2964. if (stream.pending_abort_request().has_value()) {
  2965. // 1. Reject stream.[[pendingAbortRequest]]'s promise with error.
  2966. // 2. Set stream.[[pendingAbortRequest]] to undefined.
  2967. WebIDL::reject_promise(realm, stream.pending_abort_request().release_value().promise, error);
  2968. }
  2969. // 6. Perform ! WritableStreamDealWithRejection(stream, error).
  2970. writable_stream_deal_with_rejection(stream, error);
  2971. }
  2972. // https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-write
  2973. void writable_stream_finish_in_flight_write(WritableStream& stream)
  2974. {
  2975. auto& realm = stream.realm();
  2976. // 1. Assert: stream.[[inFlightWriteRequest]] is not undefined.
  2977. VERIFY(stream.in_flight_write_request());
  2978. // 2. Resolve stream.[[inFlightWriteRequest]] with undefined.
  2979. WebIDL::resolve_promise(realm, *stream.in_flight_write_request(), JS::js_undefined());
  2980. // 3. Set stream.[[inFlightWriteRequest]] to undefined.
  2981. stream.set_in_flight_write_request({});
  2982. }
  2983. // https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-write-with-error
  2984. void writable_stream_finish_in_flight_write_with_error(WritableStream& stream, JS::Value error)
  2985. {
  2986. auto& realm = stream.realm();
  2987. // 1. Assert: stream.[[inFlightWriteRequest]] is not undefined.
  2988. VERIFY(stream.in_flight_write_request());
  2989. // 2. Reject stream.[[inFlightWriteRequest]] with error.
  2990. WebIDL::reject_promise(realm, *stream.in_flight_write_request(), error);
  2991. // 3. Set stream.[[inFlightWriteRequest]] to undefined.
  2992. stream.set_in_flight_write_request({});
  2993. // 4. Assert: stream.[[state]] is "writable" or "erroring".
  2994. auto state = stream.state();
  2995. VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
  2996. // 5. Perform ! WritableStreamDealWithRejection(stream, error).
  2997. writable_stream_deal_with_rejection(stream, error);
  2998. }
  2999. // https://streams.spec.whatwg.org/#writable-stream-has-operation-marked-in-flight
  3000. bool writable_stream_has_operation_marked_in_flight(WritableStream const& stream)
  3001. {
  3002. // 1. If stream.[[inFlightWriteRequest]] is undefined and stream.[[inFlightCloseRequest]] is undefined, return false.
  3003. if (!stream.in_flight_write_request() && !stream.in_flight_close_request())
  3004. return false;
  3005. // 2. Return true.
  3006. return true;
  3007. }
  3008. // https://streams.spec.whatwg.org/#writable-stream-mark-close-request-in-flight
  3009. void writable_stream_mark_close_request_in_flight(WritableStream& stream)
  3010. {
  3011. // 1. Assert: stream.[[inFlightCloseRequest]] is undefined.
  3012. VERIFY(!stream.in_flight_close_request());
  3013. // 2. Assert: stream.[[closeRequest]] is not undefined.
  3014. VERIFY(stream.close_request());
  3015. // 3. Set stream.[[inFlightCloseRequest]] to stream.[[closeRequest]].
  3016. stream.set_in_flight_close_request(stream.close_request());
  3017. // 4. Set stream.[[closeRequest]] to undefined.
  3018. stream.set_close_request({});
  3019. }
  3020. // https://streams.spec.whatwg.org/#writable-stream-mark-first-write-request-in-flight
  3021. void writable_stream_mark_first_write_request_in_flight(WritableStream& stream)
  3022. {
  3023. // 1. Assert: stream.[[inFlightWriteRequest]] is undefined.
  3024. VERIFY(!stream.in_flight_write_request());
  3025. // 2. Assert: stream.[[writeRequests]] is not empty.
  3026. VERIFY(!stream.write_requests().is_empty());
  3027. // 3. Let writeRequest be stream.[[writeRequests]][0].
  3028. // 4. Remove writeRequest from stream.[[writeRequests]].
  3029. auto write_request = stream.write_requests().take_first();
  3030. // 5. Set stream.[[inFlightWriteRequest]] to writeRequest.
  3031. stream.set_in_flight_write_request(write_request);
  3032. }
  3033. // https://streams.spec.whatwg.org/#writable-stream-reject-close-and-closed-promise-if-needed
  3034. void writable_stream_reject_close_and_closed_promise_if_needed(WritableStream& stream)
  3035. {
  3036. auto& realm = stream.realm();
  3037. // 1. Assert: stream.[[state]] is "errored".
  3038. VERIFY(stream.state() == WritableStream::State::Errored);
  3039. // 2. If stream.[[closeRequest]] is not undefined,
  3040. if (stream.close_request()) {
  3041. // 1. Assert: stream.[[inFlightCloseRequest]] is undefined.
  3042. VERIFY(!stream.in_flight_close_request());
  3043. // 2. Reject stream.[[closeRequest]] with stream.[[storedError]].
  3044. WebIDL::reject_promise(realm, *stream.close_request(), stream.stored_error());
  3045. // 3. Set stream.[[closeRequest]] to undefined.
  3046. stream.set_close_request({});
  3047. }
  3048. // 3. Let writer be stream.[[writer]].
  3049. auto writer = stream.writer();
  3050. // 4. If writer is not undefined,
  3051. if (writer) {
  3052. // 1. Reject writer.[[closedPromise]] with stream.[[storedError]].
  3053. WebIDL::reject_promise(realm, *writer->closed_promise(), stream.stored_error());
  3054. // 2. Set writer.[[closedPromise]].[[PromiseIsHandled]] to true.
  3055. WebIDL::mark_promise_as_handled(*writer->closed_promise());
  3056. }
  3057. }
  3058. // https://streams.spec.whatwg.org/#writable-stream-start-erroring
  3059. void writable_stream_start_erroring(WritableStream& stream, JS::Value reason)
  3060. {
  3061. // 1. Assert: stream.[[storedError]] is undefined.
  3062. VERIFY(stream.stored_error().is_undefined());
  3063. // 2. Assert: stream.[[state]] is "writable".
  3064. VERIFY(stream.state() == WritableStream::State::Writable);
  3065. // 3. Let controller be stream.[[controller]].
  3066. auto controller = stream.controller();
  3067. // 4. Assert: controller is not undefined.
  3068. VERIFY(controller);
  3069. // 5. Set stream.[[state]] to "erroring".
  3070. stream.set_state(WritableStream::State::Erroring);
  3071. // 6. Set stream.[[storedError]] to reason.
  3072. stream.set_stored_error(reason);
  3073. // 7. Let writer be stream.[[writer]].
  3074. auto writer = stream.writer();
  3075. // 8. If writer is not undefined, perform ! WritableStreamDefaultWriterEnsureReadyPromiseRejected(writer, reason).
  3076. if (writer)
  3077. writable_stream_default_writer_ensure_ready_promise_rejected(*writer, reason);
  3078. // 9. If ! WritableStreamHasOperationMarkedInFlight(stream) is false and controller.[[started]] is true, perform ! WritableStreamFinishErroring(stream).
  3079. if (!writable_stream_has_operation_marked_in_flight(stream) && controller->started())
  3080. writable_stream_finish_erroring(stream);
  3081. }
  3082. // https://streams.spec.whatwg.org/#writable-stream-update-backpressure
  3083. void writable_stream_update_backpressure(WritableStream& stream, bool backpressure)
  3084. {
  3085. auto& realm = stream.realm();
  3086. // 1. Assert: stream.[[state]] is "writable".
  3087. VERIFY(stream.state() == WritableStream::State::Writable);
  3088. // 2. Assert: ! WritableStreamCloseQueuedOrInFlight(stream) is false.
  3089. VERIFY(!writable_stream_close_queued_or_in_flight(stream));
  3090. // 3. Let writer be stream.[[writer]].
  3091. auto writer = stream.writer();
  3092. // 4. If writer is not undefined and backpressure is not stream.[[backpressure]],
  3093. if (writer && backpressure != stream.backpressure()) {
  3094. // 1. If backpressure is true, set writer.[[readyPromise]] to a new promise.
  3095. if (backpressure) {
  3096. writer->set_ready_promise(WebIDL::create_promise(realm));
  3097. }
  3098. // 2. Otherwise,
  3099. else {
  3100. // 1. Assert: backpressure is false.
  3101. // 2. Resolve writer.[[readyPromise]] with undefined.
  3102. WebIDL::resolve_promise(realm, *writer->ready_promise(), JS::js_undefined());
  3103. }
  3104. }
  3105. // 5. Set stream.[[backpressure]] to backpressure.
  3106. stream.set_backpressure(backpressure);
  3107. }
  3108. // https://streams.spec.whatwg.org/#writable-stream-default-writer-abort
  3109. JS::NonnullGCPtr<WebIDL::Promise> writable_stream_default_writer_abort(WritableStreamDefaultWriter& writer, JS::Value reason)
  3110. {
  3111. // 1. Let stream be writer.[[stream]].
  3112. auto stream = writer.stream();
  3113. // 2. Assert: stream is not undefined.
  3114. VERIFY(stream);
  3115. // 3. Return ! WritableStreamAbort(stream, reason).
  3116. return writable_stream_abort(*stream, reason);
  3117. }
  3118. // https://streams.spec.whatwg.org/#writable-stream-default-writer-close
  3119. JS::NonnullGCPtr<WebIDL::Promise> writable_stream_default_writer_close(WritableStreamDefaultWriter& writer)
  3120. {
  3121. // 1. Let stream be writer.[[stream]].
  3122. auto stream = writer.stream();
  3123. // 2. Assert: stream is not undefined.
  3124. VERIFY(stream);
  3125. // 3. Return ! WritableStreamClose(stream).
  3126. return writable_stream_close(*stream);
  3127. }
  3128. // https://streams.spec.whatwg.org/#writable-stream-default-writer-ensure-closed-promise-rejected
  3129. void writable_stream_default_writer_ensure_closed_promise_rejected(WritableStreamDefaultWriter& writer, JS::Value error)
  3130. {
  3131. auto& realm = writer.realm();
  3132. // 1. If writer.[[closedPromise]].[[PromiseState]] is "pending", reject writer.[[closedPromise]] with error.
  3133. auto& closed_promise = verify_cast<JS::Promise>(*writer.closed_promise()->promise());
  3134. if (closed_promise.state() == JS::Promise::State::Pending) {
  3135. WebIDL::reject_promise(realm, *writer.closed_promise(), error);
  3136. }
  3137. // 2. Otherwise, set writer.[[closedPromise]] to a promise rejected with error.
  3138. else {
  3139. writer.set_closed_promise(WebIDL::create_rejected_promise(realm, error));
  3140. }
  3141. // 3. Set writer.[[closedPromise]].[[PromiseIsHandled]] to true.
  3142. WebIDL::mark_promise_as_handled(*writer.closed_promise());
  3143. }
  3144. // https://streams.spec.whatwg.org/#writable-stream-default-writer-ensure-ready-promise-rejected
  3145. void writable_stream_default_writer_ensure_ready_promise_rejected(WritableStreamDefaultWriter& writer, JS::Value error)
  3146. {
  3147. auto& realm = writer.realm();
  3148. // 1. If writer.[[readyPromise]].[[PromiseState]] is "pending", reject writer.[[readyPromise]] with error.
  3149. auto& ready_promise = verify_cast<JS::Promise>(*writer.ready_promise()->promise());
  3150. if (ready_promise.state() == JS::Promise::State::Pending) {
  3151. WebIDL::reject_promise(realm, *writer.ready_promise(), error);
  3152. }
  3153. // 2. Otherwise, set writer.[[readyPromise]] to a promise rejected with error.
  3154. else {
  3155. writer.set_ready_promise(WebIDL::create_rejected_promise(realm, error));
  3156. }
  3157. // 3. Set writer.[[readyPromise]].[[PromiseIsHandled]] to true.
  3158. WebIDL::mark_promise_as_handled(*writer.ready_promise());
  3159. }
  3160. // https://streams.spec.whatwg.org/#writable-stream-default-writer-get-desired-size
  3161. Optional<double> writable_stream_default_writer_get_desired_size(WritableStreamDefaultWriter const& writer)
  3162. {
  3163. // 1. Let stream be writer.[[stream]].
  3164. auto stream = writer.stream();
  3165. // 2. Let state be stream.[[state]].
  3166. auto state = stream->state();
  3167. // 3. If state is "errored" or "erroring", return null.
  3168. if (state == WritableStream::State::Errored || state == WritableStream::State::Erroring)
  3169. return {};
  3170. // 4. If state is "closed", return 0.
  3171. if (state == WritableStream::State::Closed)
  3172. return 0.0;
  3173. // 5. Return ! WritableStreamDefaultControllerGetDesiredSize(stream.[[controller]]).
  3174. return writable_stream_default_controller_get_desired_size(*stream->controller());
  3175. }
  3176. // https://streams.spec.whatwg.org/#writable-stream-default-writer-release
  3177. void writable_stream_default_writer_release(WritableStreamDefaultWriter& writer)
  3178. {
  3179. auto& realm = writer.realm();
  3180. // 1. Let stream be writer.[[stream]].
  3181. auto stream = writer.stream();
  3182. // 2. Assert: stream is not undefined.
  3183. VERIFY(stream);
  3184. // 3. Assert: stream.[[writer]] is writer.
  3185. VERIFY(stream->writer().ptr() == &writer);
  3186. // 4. Let releasedError be a new TypeError.
  3187. auto released_error = JS::TypeError::create(realm, "Writer's stream lock has been released"sv);
  3188. // 5. Perform ! WritableStreamDefaultWriterEnsureReadyPromiseRejected(writer, releasedError).
  3189. writable_stream_default_writer_ensure_ready_promise_rejected(writer, released_error);
  3190. // 6. Perform ! WritableStreamDefaultWriterEnsureClosedPromiseRejected(writer, releasedError).
  3191. writable_stream_default_writer_ensure_closed_promise_rejected(writer, released_error);
  3192. // 7. Set stream.[[writer]] to undefined.
  3193. stream->set_writer({});
  3194. // 8. Set writer.[[stream]] to undefined.
  3195. writer.set_stream({});
  3196. }
  3197. // https://streams.spec.whatwg.org/#writable-stream-default-writer-write
  3198. JS::NonnullGCPtr<WebIDL::Promise> writable_stream_default_writer_write(WritableStreamDefaultWriter& writer, JS::Value chunk)
  3199. {
  3200. auto& realm = writer.realm();
  3201. // 1. Let stream be writer.[[stream]].
  3202. auto stream = writer.stream();
  3203. // 2. Assert: stream is not undefined.
  3204. VERIFY(stream);
  3205. // 3. Let controller be stream.[[controller]].
  3206. auto controller = stream->controller();
  3207. // 4. Let chunkSize be ! WritableStreamDefaultControllerGetChunkSize(controller, chunk).
  3208. auto chunk_size = writable_stream_default_controller_get_chunk_size(*controller, chunk);
  3209. // 5. If stream is not equal to writer.[[stream]], return a promise rejected with a TypeError exception.
  3210. if (stream.ptr() != writer.stream().ptr()) {
  3211. auto exception = JS::TypeError::create(realm, "Writer's locked stream changed during write"sv);
  3212. return WebIDL::create_rejected_promise(realm, exception);
  3213. }
  3214. // 6. Let state be stream.[[state]].
  3215. auto state = stream->state();
  3216. // 7. If state is "errored", return a promise rejected with stream.[[storedError]].
  3217. if (state == WritableStream::State::Errored)
  3218. return WebIDL::create_rejected_promise(realm, stream->stored_error());
  3219. // 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.
  3220. if (writable_stream_close_queued_or_in_flight(*stream) || state == WritableStream::State::Closed) {
  3221. auto exception = JS::TypeError::create(realm, "Cannot write to a writer whose stream is closing or already closed"sv);
  3222. return WebIDL::create_rejected_promise(realm, exception);
  3223. }
  3224. // 9. If state is "erroring", return a promise rejected with stream.[[storedError]].
  3225. if (state == WritableStream::State::Erroring)
  3226. return WebIDL::create_rejected_promise(realm, stream->stored_error());
  3227. // 10. Assert: state is "writable".
  3228. VERIFY(state == WritableStream::State::Writable);
  3229. // 11. Let promise be ! WritableStreamAddWriteRequest(stream).
  3230. auto promise = writable_stream_add_write_request(*stream);
  3231. // 12. Perform ! WritableStreamDefaultControllerWrite(controller, chunk, chunkSize).
  3232. writable_stream_default_controller_write(*controller, chunk, chunk_size);
  3233. // 13. Return promise.
  3234. return promise;
  3235. }
  3236. // https://streams.spec.whatwg.org/#set-up-writable-stream-default-controller
  3237. WebIDL::ExceptionOr<void> set_up_writable_stream_default_controller(WritableStream& stream, WritableStreamDefaultController& controller, JS::NonnullGCPtr<StartAlgorithm> start_algorithm, JS::NonnullGCPtr<WriteAlgorithm> write_algorithm, JS::NonnullGCPtr<CloseAlgorithm> close_algorithm, JS::NonnullGCPtr<AbortAlgorithm> abort_algorithm, double high_water_mark, JS::NonnullGCPtr<SizeAlgorithm> size_algorithm)
  3238. {
  3239. auto& realm = stream.realm();
  3240. // 1. Assert: stream implements WritableStream.
  3241. // 2. Assert: stream.[[controller]] is undefined.
  3242. VERIFY(!stream.controller());
  3243. // 3. Set controller.[[stream]] to stream.
  3244. controller.set_stream(stream);
  3245. // 4. Set stream.[[controller]] to controller.
  3246. stream.set_controller(controller);
  3247. // 5. Perform ! ResetQueue(controller).
  3248. reset_queue(controller);
  3249. // 6. Set controller.[[signal]] to a new AbortSignal.
  3250. controller.set_signal(realm.heap().allocate<DOM::AbortSignal>(realm, realm));
  3251. // 7. Set controller.[[started]] to false.
  3252. controller.set_started(false);
  3253. // 8. Set controller.[[strategySizeAlgorithm]] to sizeAlgorithm.
  3254. controller.set_strategy_size_algorithm(size_algorithm);
  3255. // 9. Set controller.[[strategyHWM]] to highWaterMark.
  3256. controller.set_strategy_hwm(high_water_mark);
  3257. // 10. Set controller.[[writeAlgorithm]] to writeAlgorithm.
  3258. controller.set_write_algorithm(write_algorithm);
  3259. // 11. Set controller.[[closeAlgorithm]] to closeAlgorithm.
  3260. controller.set_close_algorithm(close_algorithm);
  3261. // 12. Set controller.[[abortAlgorithm]] to abortAlgorithm.
  3262. controller.set_abort_algorithm(abort_algorithm);
  3263. // 13. Let backpressure be ! WritableStreamDefaultControllerGetBackpressure(controller).
  3264. auto backpressure = writable_stream_default_controller_get_backpressure(controller);
  3265. // 14. Perform ! WritableStreamUpdateBackpressure(stream, backpressure).
  3266. writable_stream_update_backpressure(stream, backpressure);
  3267. // 15. Let startResult be the result of performing startAlgorithm. (This may throw an exception.)
  3268. auto start_result = TRY(start_algorithm->function()());
  3269. // 16. Let startPromise be a promise resolved with startResult.
  3270. auto start_promise = WebIDL::create_resolved_promise(realm, start_result);
  3271. // 17. Upon fulfillment of startPromise,
  3272. WebIDL::upon_fulfillment(*start_promise, JS::create_heap_function(realm.heap(), [&controller, &stream](JS::Value) -> WebIDL::ExceptionOr<JS::Value> {
  3273. // 1. Assert: stream.[[state]] is "writable" or "erroring".
  3274. auto state = stream.state();
  3275. VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
  3276. // 2. Set controller.[[started]] to true.
  3277. controller.set_started(true);
  3278. // 3. Perform ! WritableStreamDefaultControllerAdvanceQueueIfNeeded(controller).
  3279. writable_stream_default_controller_advance_queue_if_needed(controller);
  3280. return JS::js_undefined();
  3281. }));
  3282. // 18. Upon rejection of startPromise with reason r,
  3283. WebIDL::upon_rejection(*start_promise, JS::create_heap_function(realm.heap(), [&stream, &controller](JS::Value reason) -> WebIDL::ExceptionOr<JS::Value> {
  3284. // 1. Assert: stream.[[state]] is "writable" or "erroring".
  3285. auto state = stream.state();
  3286. VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
  3287. // 2. Set controller.[[started]] to true.
  3288. controller.set_started(true);
  3289. // 3. Perform ! WritableStreamDealWithRejection(stream, r).
  3290. writable_stream_deal_with_rejection(stream, reason);
  3291. return JS::js_undefined();
  3292. }));
  3293. return {};
  3294. }
  3295. // https://streams.spec.whatwg.org/#set-up-writable-stream-default-controller-from-underlying-sink
  3296. 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, JS::NonnullGCPtr<SizeAlgorithm> size_algorithm)
  3297. {
  3298. auto& realm = stream.realm();
  3299. // 1. Let controller be a new WritableStreamDefaultController.
  3300. auto controller = realm.heap().allocate<WritableStreamDefaultController>(realm, realm);
  3301. // 2. Let startAlgorithm be an algorithm that returns undefined.
  3302. auto start_algorithm = JS::create_heap_function(realm.heap(), []() -> WebIDL::ExceptionOr<JS::Value> { return JS::js_undefined(); });
  3303. // 3. Let writeAlgorithm be an algorithm that returns a promise resolved with undefined.
  3304. auto write_algorithm = JS::create_heap_function(realm.heap(), [&realm](JS::Value) {
  3305. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  3306. });
  3307. // 4. Let closeAlgorithm be an algorithm that returns a promise resolved with undefined.
  3308. auto close_algorithm = JS::create_heap_function(realm.heap(), [&realm]() {
  3309. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  3310. });
  3311. // 5. Let abortAlgorithm be an algorithm that returns a promise resolved with undefined.
  3312. auto abort_algorithm = JS::create_heap_function(realm.heap(), [&realm](JS::Value) {
  3313. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  3314. });
  3315. // 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.
  3316. if (underlying_sink.start) {
  3317. start_algorithm = JS::create_heap_function(realm.heap(), [controller, underlying_sink_value, callback = underlying_sink.start]() -> WebIDL::ExceptionOr<JS::Value> {
  3318. // Note: callback does not return a promise, so invoke_callback may return an abrupt completion
  3319. return TRY(WebIDL::invoke_callback(*callback, underlying_sink_value, controller)).release_value();
  3320. });
  3321. }
  3322. // 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.
  3323. if (underlying_sink.write) {
  3324. write_algorithm = JS::create_heap_function(realm.heap(), [&realm, controller, underlying_sink_value, callback = underlying_sink.write](JS::Value chunk) {
  3325. // Note: callback returns a promise, so invoke_callback will never return an abrupt completion
  3326. auto result = MUST(WebIDL::invoke_callback(*callback, underlying_sink_value, chunk, controller)).release_value();
  3327. return WebIDL::create_resolved_promise(realm, result);
  3328. });
  3329. }
  3330. // 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.
  3331. if (underlying_sink.close) {
  3332. close_algorithm = JS::create_heap_function(realm.heap(), [&realm, underlying_sink_value, callback = underlying_sink.close]() {
  3333. // Note: callback returns a promise, so invoke_callback will never return an abrupt completion
  3334. auto result = MUST(WebIDL::invoke_callback(*callback, underlying_sink_value)).release_value();
  3335. return WebIDL::create_resolved_promise(realm, result);
  3336. });
  3337. }
  3338. // 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.
  3339. if (underlying_sink.abort) {
  3340. abort_algorithm = JS::create_heap_function(realm.heap(), [&realm, underlying_sink_value, callback = underlying_sink.abort](JS::Value reason) {
  3341. // Note: callback returns a promise, so invoke_callback will never return an abrupt completion
  3342. auto result = MUST(WebIDL::invoke_callback(*callback, underlying_sink_value, reason)).release_value();
  3343. return WebIDL::create_resolved_promise(realm, result);
  3344. });
  3345. }
  3346. // 10. Perform ? SetUpWritableStreamDefaultController(stream, controller, startAlgorithm, writeAlgorithm, closeAlgorithm, abortAlgorithm, highWaterMark, sizeAlgorithm).
  3347. TRY(set_up_writable_stream_default_controller(stream, controller, start_algorithm, write_algorithm, close_algorithm, abort_algorithm, high_water_mark, size_algorithm));
  3348. return {};
  3349. }
  3350. // https://streams.spec.whatwg.org/#writable-stream-default-controller-advance-queue-if-needed
  3351. void writable_stream_default_controller_advance_queue_if_needed(WritableStreamDefaultController& controller)
  3352. {
  3353. // 1. Let stream be controller.[[stream]].
  3354. auto stream = controller.stream();
  3355. // 2. If controller.[[started]] is false, return.
  3356. if (!controller.started())
  3357. return;
  3358. // 3. If stream.[[inFlightWriteRequest]] is not undefined, return.
  3359. if (stream->in_flight_write_request())
  3360. return;
  3361. // 4. Let state be stream.[[state]].
  3362. auto state = stream->state();
  3363. // 5. Assert: state is not "closed" or "errored".
  3364. VERIFY(state != WritableStream::State::Closed && state != WritableStream::State::Errored);
  3365. // 6. If state is "erroring",
  3366. if (state == WritableStream::State::Erroring) {
  3367. // 1. Perform ! WritableStreamFinishErroring(stream).
  3368. writable_stream_finish_erroring(*stream);
  3369. // 2. Return.
  3370. return;
  3371. }
  3372. // 7. If controller.[[queue]] is empty, return.
  3373. if (controller.queue().is_empty())
  3374. return;
  3375. // 8. Let value be ! PeekQueueValue(controller).
  3376. auto value = peek_queue_value(controller);
  3377. // 9. If value is the close sentinel, perform ! WritableStreamDefaultControllerProcessClose(controller).
  3378. if (is_close_sentinel(value)) {
  3379. writable_stream_default_controller_process_close(controller);
  3380. }
  3381. // 10. Otherwise, perform ! WritableStreamDefaultControllerProcessWrite(controller, value).
  3382. else {
  3383. writable_stream_default_controller_process_write(controller, value);
  3384. }
  3385. }
  3386. // https://streams.spec.whatwg.org/#writable-stream-default-controller-clear-algorithms
  3387. void writable_stream_default_controller_clear_algorithms(WritableStreamDefaultController& controller)
  3388. {
  3389. // 1. Set controller.[[writeAlgorithm]] to undefined.
  3390. controller.set_write_algorithm({});
  3391. // 2. Set controller.[[closeAlgorithm]] to undefined.
  3392. controller.set_close_algorithm({});
  3393. // 3. Set controller.[[abortAlgorithm]] to undefined.
  3394. controller.set_abort_algorithm({});
  3395. // 4. Set controller.[[strategySizeAlgorithm]] to undefined.
  3396. controller.set_strategy_size_algorithm({});
  3397. }
  3398. // https://streams.spec.whatwg.org/#writable-stream-default-controller-close
  3399. void writable_stream_default_controller_close(WritableStreamDefaultController& controller)
  3400. {
  3401. // 1. Perform ! EnqueueValueWithSize(controller, close sentinel, 0).
  3402. MUST(enqueue_value_with_size(controller, create_close_sentinel(), JS::Value(0.0)));
  3403. // 2. Perform ! WritableStreamDefaultControllerAdvanceQueueIfNeeded(controller).
  3404. writable_stream_default_controller_advance_queue_if_needed(controller);
  3405. }
  3406. // https://streams.spec.whatwg.org/#writable-stream-default-controller-error
  3407. void writable_stream_default_controller_error(WritableStreamDefaultController& controller, JS::Value error)
  3408. {
  3409. // 1. Let stream be controller.[[stream]].
  3410. auto stream = controller.stream();
  3411. // 2. Assert: stream.[[state]] is "writable".
  3412. VERIFY(stream->state() == WritableStream::State::Writable);
  3413. // 3. Perform ! WritableStreamDefaultControllerClearAlgorithms(controller).
  3414. writable_stream_default_controller_clear_algorithms(controller);
  3415. // 4. Perform ! WritableStreamStartErroring(stream, error).
  3416. writable_stream_start_erroring(stream, error);
  3417. }
  3418. // https://streams.spec.whatwg.org/#writable-stream-default-controller-error-if-needed
  3419. void writable_stream_default_controller_error_if_needed(WritableStreamDefaultController& controller, JS::Value error)
  3420. {
  3421. // 1. If controller.[[stream]].[[state]] is "writable", perform ! WritableStreamDefaultControllerError(controller, error).
  3422. if (controller.stream()->state() == WritableStream::State::Writable)
  3423. writable_stream_default_controller_error(controller, error);
  3424. }
  3425. // https://streams.spec.whatwg.org/#writable-stream-default-controller-get-backpressure
  3426. bool writable_stream_default_controller_get_backpressure(WritableStreamDefaultController const& controller)
  3427. {
  3428. // 1. Let desiredSize be ! WritableStreamDefaultControllerGetDesiredSize(controller).
  3429. auto desired_size = writable_stream_default_controller_get_desired_size(controller);
  3430. // 2. Return true if desiredSize ≤ 0, or false otherwise.
  3431. return desired_size <= 0.0;
  3432. }
  3433. // https://streams.spec.whatwg.org/#writable-stream-default-controller-get-chunk-size
  3434. JS::Value writable_stream_default_controller_get_chunk_size(WritableStreamDefaultController& controller, JS::Value chunk)
  3435. {
  3436. // 1. Let returnValue be the result of performing controller.[[strategySizeAlgorithm]], passing in chunk, and interpreting the result as a completion record.
  3437. auto return_value = controller.strategy_size_algorithm()->function()(chunk);
  3438. // 2. If returnValue is an abrupt completion,
  3439. if (return_value.is_abrupt()) {
  3440. // 1. Perform ! WritableStreamDefaultControllerErrorIfNeeded(controller, returnValue.[[Value]]).
  3441. writable_stream_default_controller_error_if_needed(controller, *return_value.release_value());
  3442. // 2. Return 1.
  3443. return JS::Value { 1.0 };
  3444. }
  3445. // 3. Return returnValue.[[Value]].
  3446. return *return_value.release_value();
  3447. }
  3448. // https://streams.spec.whatwg.org/#writable-stream-default-controller-get-desired-size
  3449. double writable_stream_default_controller_get_desired_size(WritableStreamDefaultController const& controller)
  3450. {
  3451. // 1. Return controller.[[strategyHWM]] − controller.[[queueTotalSize]].
  3452. return controller.strategy_hwm() - controller.queue_total_size();
  3453. }
  3454. // https://streams.spec.whatwg.org/#writable-stream-default-controller-process-close
  3455. void writable_stream_default_controller_process_close(WritableStreamDefaultController& controller)
  3456. {
  3457. // 1. Let stream be controller.[[stream]].
  3458. auto stream = controller.stream();
  3459. // 2. Perform ! WritableStreamMarkCloseRequestInFlight(stream).
  3460. writable_stream_mark_close_request_in_flight(*stream);
  3461. // 3. Perform ! DequeueValue(controller).
  3462. dequeue_value(controller);
  3463. // 4. Assert: controller.[[queue]] is empty.
  3464. VERIFY(controller.queue().is_empty());
  3465. // 5. Let sinkClosePromise be the result of performing controller.[[closeAlgorithm]].
  3466. auto sink_close_promise = controller.close_algorithm()->function()();
  3467. // 6. Perform ! WritableStreamDefaultControllerClearAlgorithms(controller).
  3468. writable_stream_default_controller_clear_algorithms(controller);
  3469. // 7. Upon fulfillment of sinkClosePromise,
  3470. WebIDL::upon_fulfillment(*sink_close_promise, JS::create_heap_function(controller.heap(), [stream](JS::Value) -> WebIDL::ExceptionOr<JS::Value> {
  3471. // 1. Perform ! WritableStreamFinishInFlightClose(stream).
  3472. writable_stream_finish_in_flight_close(*stream);
  3473. return JS::js_undefined();
  3474. }));
  3475. // 8. Upon rejection of sinkClosePromise with reason reason,
  3476. WebIDL::upon_rejection(*sink_close_promise, JS::create_heap_function(controller.heap(), [stream = stream](JS::Value reason) -> WebIDL::ExceptionOr<JS::Value> {
  3477. // 1. Perform ! WritableStreamFinishInFlightCloseWithError(stream, reason).
  3478. writable_stream_finish_in_flight_close_with_error(*stream, reason);
  3479. return JS::js_undefined();
  3480. }));
  3481. }
  3482. // https://streams.spec.whatwg.org/#writable-stream-default-controller-process-write
  3483. void writable_stream_default_controller_process_write(WritableStreamDefaultController& controller, JS::Value chunk)
  3484. {
  3485. // 1. Let stream be controller.[[stream]].
  3486. auto stream = controller.stream();
  3487. // 2. Perform ! WritableStreamMarkFirstWriteRequestInFlight(stream).
  3488. writable_stream_mark_first_write_request_in_flight(*stream);
  3489. // 3. Let sinkWritePromise be the result of performing controller.[[writeAlgorithm]], passing in chunk.
  3490. auto sink_write_promise = controller.write_algorithm()->function()(chunk);
  3491. // 4. Upon fulfillment of sinkWritePromise,
  3492. WebIDL::upon_fulfillment(*sink_write_promise, JS::create_heap_function(controller.heap(), [&controller, stream](JS::Value) -> WebIDL::ExceptionOr<JS::Value> {
  3493. // 1. Perform ! WritableStreamFinishInFlightWrite(stream).
  3494. writable_stream_finish_in_flight_write(*stream);
  3495. // 2. Let state be stream.[[state]].
  3496. auto state = stream->state();
  3497. // 3. Assert: state is "writable" or "erroring".
  3498. VERIFY(state == WritableStream::State::Writable || state == WritableStream::State::Erroring);
  3499. // 4. Perform ! DequeueValue(controller).
  3500. dequeue_value(controller);
  3501. // 5. If ! WritableStreamCloseQueuedOrInFlight(stream) is false and state is "writable",
  3502. if (!writable_stream_close_queued_or_in_flight(*stream) && state == WritableStream::State::Writable) {
  3503. // 1. Let backpressure be ! WritableStreamDefaultControllerGetBackpressure(controller).
  3504. auto backpressure = writable_stream_default_controller_get_backpressure(controller);
  3505. // 2. Perform ! WritableStreamUpdateBackpressure(stream, backpressure).
  3506. writable_stream_update_backpressure(*stream, backpressure);
  3507. }
  3508. // 6 .Perform ! WritableStreamDefaultControllerAdvanceQueueIfNeeded(controller).
  3509. writable_stream_default_controller_advance_queue_if_needed(controller);
  3510. return JS::js_undefined();
  3511. }));
  3512. // 5. Upon rejection of sinkWritePromise with reason,
  3513. WebIDL::upon_rejection(*sink_write_promise, JS::create_heap_function(controller.heap(), [&controller, stream](JS::Value reason) -> WebIDL::ExceptionOr<JS::Value> {
  3514. // 1. If stream.[[state]] is "writable", perform ! WritableStreamDefaultControllerClearAlgorithms(controller).
  3515. if (stream->state() == WritableStream::State::Writable)
  3516. writable_stream_default_controller_clear_algorithms(controller);
  3517. // 2. Perform ! WritableStreamFinishInFlightWriteWithError(stream, reason).
  3518. writable_stream_finish_in_flight_write_with_error(*stream, reason);
  3519. return JS::js_undefined();
  3520. }));
  3521. }
  3522. // https://streams.spec.whatwg.org/#writable-stream-default-controller-write
  3523. void writable_stream_default_controller_write(WritableStreamDefaultController& controller, JS::Value chunk, JS::Value chunk_size)
  3524. {
  3525. auto& vm = controller.vm();
  3526. // 1. Let enqueueResult be EnqueueValueWithSize(controller, chunk, chunkSize).
  3527. auto enqueue_result = enqueue_value_with_size(controller, chunk, chunk_size);
  3528. // 2. If enqueueResult is an abrupt completion,
  3529. if (enqueue_result.is_exception()) {
  3530. auto throw_completion = Bindings::throw_dom_exception_if_needed(vm, [&] { return enqueue_result; }).throw_completion();
  3531. // 1. Perform ! WritableStreamDefaultControllerErrorIfNeeded(controller, enqueueResult.[[Value]]).
  3532. writable_stream_default_controller_error_if_needed(controller, *throw_completion.release_value());
  3533. // 2. Return.
  3534. return;
  3535. }
  3536. // 3. Let stream be controller.[[stream]].
  3537. auto stream = controller.stream();
  3538. // 4. If ! WritableStreamCloseQueuedOrInFlight(stream) is false and stream.[[state]] is "writable",
  3539. if (!writable_stream_close_queued_or_in_flight(*stream) && stream->state() == WritableStream::State::Writable) {
  3540. // 1. Let backpressure be ! WritableStreamDefaultControllerGetBackpressure(controller).
  3541. auto backpressure = writable_stream_default_controller_get_backpressure(controller);
  3542. // 2. Perform ! WritableStreamUpdateBackpressure(stream, backpressure).
  3543. writable_stream_update_backpressure(*stream, backpressure);
  3544. }
  3545. // 5. Perform ! WritableStreamDefaultControllerAdvanceQueueIfNeeded(controller).
  3546. writable_stream_default_controller_advance_queue_if_needed(controller);
  3547. }
  3548. // https://streams.spec.whatwg.org/#initialize-transform-stream
  3549. void initialize_transform_stream(TransformStream& stream, JS::NonnullGCPtr<JS::PromiseCapability> start_promise, double writable_high_water_mark, JS::NonnullGCPtr<SizeAlgorithm> writable_size_algorithm, double readable_high_water_mark, JS::NonnullGCPtr<SizeAlgorithm> readable_size_algorithm)
  3550. {
  3551. auto& realm = stream.realm();
  3552. // 1. Let startAlgorithm be an algorithm that returns startPromise.
  3553. auto writable_start_algorithm = JS::create_heap_function(realm.heap(), [start_promise]() -> WebIDL::ExceptionOr<JS::Value> {
  3554. return start_promise->promise();
  3555. });
  3556. auto readable_start_algorithm = JS::create_heap_function(realm.heap(), [start_promise]() -> WebIDL::ExceptionOr<JS::Value> {
  3557. return start_promise->promise();
  3558. });
  3559. // 2. Let writeAlgorithm be the following steps, taking a chunk argument:
  3560. auto write_algorithm = JS::create_heap_function(realm.heap(), [&stream](JS::Value chunk) {
  3561. // 1. Return ! TransformStreamDefaultSinkWriteAlgorithm(stream, chunk).
  3562. return transform_stream_default_sink_write_algorithm(stream, chunk);
  3563. });
  3564. // 3. Let abortAlgorithm be the following steps, taking a reason argument:
  3565. auto abort_algorithm = JS::create_heap_function(realm.heap(), [&stream](JS::Value reason) {
  3566. // 1. Return ! TransformStreamDefaultSinkAbortAlgorithm(stream, reason).
  3567. return transform_stream_default_sink_abort_algorithm(stream, reason);
  3568. });
  3569. // 4. Let closeAlgorithm be the following steps:
  3570. auto close_algorithm = JS::create_heap_function(realm.heap(), [&stream]() {
  3571. // 1. Return ! TransformStreamDefaultSinkCloseAlgorithm(stream).
  3572. return transform_stream_default_sink_close_algorithm(stream);
  3573. });
  3574. // 5. Set stream.[[writable]] to ! CreateWritableStream(startAlgorithm, writeAlgorithm, closeAlgorithm, abortAlgorithm, writableHighWaterMark, writableSizeAlgorithm).
  3575. stream.set_writable(MUST(create_writable_stream(realm, writable_start_algorithm, write_algorithm, close_algorithm, abort_algorithm, writable_high_water_mark, writable_size_algorithm)));
  3576. // 6. Let pullAlgorithm be the following steps:
  3577. auto pull_algorithm = JS::create_heap_function(realm.heap(), [&stream]() {
  3578. // 1. Return ! TransformStreamDefaultSourcePullAlgorithm(stream).
  3579. return transform_stream_default_source_pull_algorithm(stream);
  3580. });
  3581. // 7. Let cancelAlgorithm be the following steps, taking a reason argument:
  3582. auto cancel_algorithm = JS::create_heap_function(realm.heap(), [&stream, &realm](JS::Value reason) {
  3583. // 1. Perform ! TransformStreamErrorWritableAndUnblockWrite(stream, reason).
  3584. transform_stream_error_writable_and_unblock_write(stream, reason);
  3585. // 2. Return a promise resolved with undefined.
  3586. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  3587. });
  3588. // 8. Set stream.[[readable]] to ! CreateReadableStream(startAlgorithm, pullAlgorithm, cancelAlgorithm, readableHighWaterMark, readableSizeAlgorithm).
  3589. stream.set_readable(MUST(create_readable_stream(realm, readable_start_algorithm, pull_algorithm, cancel_algorithm, readable_high_water_mark, readable_size_algorithm)));
  3590. // 9. Set stream.[[backpressure]] and stream.[[backpressureChangePromise]] to undefined.
  3591. stream.set_backpressure({});
  3592. stream.set_backpressure_change_promise({});
  3593. // 10. Perform ! TransformStreamSetBackpressure(stream, true).
  3594. transform_stream_set_backpressure(stream, true);
  3595. // 11. Set stream.[[controller]] to undefined.
  3596. stream.set_controller({});
  3597. }
  3598. // https://streams.spec.whatwg.org/#set-up-transform-stream-default-controller
  3599. void set_up_transform_stream_default_controller(TransformStream& stream, TransformStreamDefaultController& controller, JS::NonnullGCPtr<TransformAlgorithm> transform_algorithm, JS::NonnullGCPtr<FlushAlgorithm> flush_algorithm)
  3600. {
  3601. // 1. Assert: stream implements TransformStream.
  3602. // 2. Assert: stream.[[controller]] is undefined.
  3603. VERIFY(!stream.controller());
  3604. // 3. Set controller.[[stream]] to stream.
  3605. controller.set_stream(stream);
  3606. // 4. Set stream.[[controller]] to controller.
  3607. stream.set_controller(controller);
  3608. // 5. Set controller.[[transformAlgorithm]] to transformAlgorithm.
  3609. controller.set_transform_algorithm(transform_algorithm);
  3610. // 6. Set controller.[[flushAlgorithm]] to flushAlgorithm.
  3611. controller.set_flush_algorithm(flush_algorithm);
  3612. }
  3613. // https://streams.spec.whatwg.org/#set-up-transform-stream-default-controller-from-transformer
  3614. void set_up_transform_stream_default_controller_from_transformer(TransformStream& stream, JS::Value transformer, Transformer& transformer_dict)
  3615. {
  3616. auto& realm = stream.realm();
  3617. auto& vm = realm.vm();
  3618. // 1. Let controller be a new TransformStreamDefaultController.
  3619. auto controller = realm.heap().allocate<TransformStreamDefaultController>(realm, realm);
  3620. // 2. Let transformAlgorithm be the following steps, taking a chunk argument:
  3621. auto transform_algorithm = JS::create_heap_function(realm.heap(), [controller, &realm, &vm](JS::Value chunk) {
  3622. // 1. Let result be TransformStreamDefaultControllerEnqueue(controller, chunk).
  3623. auto result = transform_stream_default_controller_enqueue(*controller, chunk);
  3624. // 2. If result is an abrupt completion, return a promise rejected with result.[[Value]].
  3625. if (result.is_error()) {
  3626. auto throw_completion = Bindings::dom_exception_to_throw_completion(vm, result.exception());
  3627. return WebIDL::create_rejected_promise(realm, *throw_completion.release_value());
  3628. }
  3629. // 3. Otherwise, return a promise resolved with undefined.
  3630. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  3631. });
  3632. // 3. Let flushAlgorithm be an algorithm which returns a promise resolved with undefined.
  3633. auto flush_algorithm = JS::create_heap_function(realm.heap(), [&realm]() {
  3634. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  3635. });
  3636. // 4. If transformerDict["transform"] exists, set transformAlgorithm to an algorithm which takes an argument chunk
  3637. // and returns the result of invoking transformerDict["transform"] with argument list « chunk, controller » and
  3638. // callback this value transformer.
  3639. if (transformer_dict.transform) {
  3640. transform_algorithm = JS::create_heap_function(realm.heap(), [controller, &realm, transformer, callback = transformer_dict.transform](JS::Value chunk) {
  3641. // Note: callback returns a promise, so invoke_callback will never return an abrupt completion
  3642. auto result = MUST(WebIDL::invoke_callback(*callback, transformer, chunk, controller)).release_value();
  3643. return WebIDL::create_resolved_promise(realm, result);
  3644. });
  3645. }
  3646. // 5. If transformerDict["flush"] exists, set flushAlgorithm to an algorithm which returns the result of invoking
  3647. // transformerDict["flush"] with argument list « controller » and callback this value transformer.
  3648. if (transformer_dict.flush) {
  3649. flush_algorithm = JS::create_heap_function(realm.heap(), [&realm, transformer, callback = transformer_dict.flush, controller]() {
  3650. // Note: callback returns a promise, so invoke_callback will never return an abrupt completion
  3651. auto result = MUST(WebIDL::invoke_callback(*callback, transformer, controller)).release_value();
  3652. return WebIDL::create_resolved_promise(realm, result);
  3653. });
  3654. }
  3655. // 6. Perform ! SetUpTransformStreamDefaultController(stream, controller, transformAlgorithm, flushAlgorithm).
  3656. set_up_transform_stream_default_controller(stream, *controller, transform_algorithm, flush_algorithm);
  3657. }
  3658. // https://streams.spec.whatwg.org/#transform-stream-default-controller-clear-algorithms
  3659. void transform_stream_default_controller_clear_algorithms(TransformStreamDefaultController& controller)
  3660. {
  3661. // NOTE: This is observable using weak references. See tc39/proposal-weakrefs#31 for more detail.
  3662. // 1. Set controller.[[transformAlgorithm]] to undefined.
  3663. controller.set_transform_algorithm({});
  3664. // 2. Set controller.[[flushAlgorithm]] to undefined.
  3665. controller.set_flush_algorithm({});
  3666. }
  3667. // https://streams.spec.whatwg.org/#transform-stream-default-controller-enqueue
  3668. WebIDL::ExceptionOr<void> transform_stream_default_controller_enqueue(TransformStreamDefaultController& controller, JS::Value chunk)
  3669. {
  3670. auto& vm = controller.vm();
  3671. // 1. Let stream be controller.[[stream]].
  3672. auto stream = controller.stream();
  3673. // 2. Let readableController be stream.[[readable]].[[controller]].
  3674. VERIFY(stream->readable()->controller().has_value() && stream->readable()->controller()->has<JS::NonnullGCPtr<ReadableStreamDefaultController>>());
  3675. auto& readable_controller = stream->readable()->controller()->get<JS::NonnullGCPtr<ReadableStreamDefaultController>>();
  3676. // 3. If ! ReadableStreamDefaultControllerCanCloseOrEnqueue(readableController) is false, throw a TypeError exception.
  3677. if (!readable_stream_default_controller_can_close_or_enqueue(readable_controller))
  3678. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, "ReadableController is either closed or not readable."sv };
  3679. // 4. Let enqueueResult be ReadableStreamDefaultControllerEnqueue(readableController, chunk).
  3680. auto enqueue_result = readable_stream_default_controller_enqueue(readable_controller, chunk);
  3681. // 5. If enqueueResult is an abrupt completion,
  3682. if (enqueue_result.is_error()) {
  3683. auto throw_completion = Bindings::dom_exception_to_throw_completion(vm, enqueue_result.exception());
  3684. // 1. Perform ! TransformStreamErrorWritableAndUnblockWrite(stream, enqueueResult.[[Value]]).
  3685. transform_stream_error_writable_and_unblock_write(*stream, throw_completion.value().value());
  3686. // 2. Throw stream.[[readable]].[[storedError]].
  3687. return JS::throw_completion(stream->readable()->stored_error());
  3688. }
  3689. // 6. Let backpressure be ! ReadableStreamDefaultControllerHasBackpressure(readableController).
  3690. auto backpressure = readable_stream_default_controller_has_backpressure(readable_controller);
  3691. // 7. If backpressure is not stream.[[backpressure]],
  3692. if (backpressure != stream->backpressure()) {
  3693. // 1. Assert: backpressure is true.
  3694. VERIFY(backpressure);
  3695. // 2. Perform ! TransformStreamSetBackpressure(stream, true).
  3696. transform_stream_set_backpressure(*stream, true);
  3697. }
  3698. return {};
  3699. }
  3700. // https://streams.spec.whatwg.org/#transform-stream-default-controller-error
  3701. void transform_stream_default_controller_error(TransformStreamDefaultController& controller, JS::Value error)
  3702. {
  3703. // 1. Perform ! TransformStreamError(controller.[[stream]], e).
  3704. transform_stream_error(*controller.stream(), error);
  3705. }
  3706. // https://streams.spec.whatwg.org/#transform-stream-default-controller-terminate
  3707. void transform_stream_default_controller_terminate(TransformStreamDefaultController& controller)
  3708. {
  3709. auto& realm = controller.realm();
  3710. // 1. Let stream be controller.[[stream]].
  3711. auto stream = controller.stream();
  3712. // 2. Let readableController be stream.[[readable]].[[controller]].
  3713. VERIFY(stream->readable()->controller().has_value() && stream->readable()->controller()->has<JS::NonnullGCPtr<ReadableStreamDefaultController>>());
  3714. auto readable_controller = stream->readable()->controller()->get<JS::NonnullGCPtr<ReadableStreamDefaultController>>();
  3715. // 3. Perform ! ReadableStreamDefaultControllerClose(readableController).
  3716. readable_stream_default_controller_close(readable_controller);
  3717. // 4. Let error be a TypeError exception indicating that the stream has been terminated.
  3718. auto error = JS::TypeError::create(realm, "Stream has been terminated."sv);
  3719. // 5. Perform ! TransformStreamErrorWritableAndUnblockWrite(stream, error).
  3720. transform_stream_error_writable_and_unblock_write(*stream, error);
  3721. }
  3722. // https://streams.spec.whatwg.org/#transform-stream-default-controller-perform-transform
  3723. JS::NonnullGCPtr<WebIDL::Promise> transform_stream_default_controller_perform_transform(TransformStreamDefaultController& controller, JS::Value chunk)
  3724. {
  3725. auto& realm = controller.realm();
  3726. // 1. Let transformPromise be the result of performing controller.[[transformAlgorithm]], passing chunk.
  3727. auto transform_promise = controller.transform_algorithm()->function()(chunk);
  3728. // 2. Return the result of reacting to transformPromise with the following rejection steps given the argument r:
  3729. auto react_result = WebIDL::react_to_promise(*transform_promise,
  3730. {},
  3731. JS::create_heap_function(realm.heap(), [&controller](JS::Value reason) -> WebIDL::ExceptionOr<JS::Value> {
  3732. // 1. Perform ! TransformStreamError(controller.[[stream]], r).
  3733. transform_stream_error(*controller.stream(), reason);
  3734. // 2. Throw r.
  3735. return JS::throw_completion(reason);
  3736. }));
  3737. return WebIDL::create_resolved_promise(realm, react_result);
  3738. }
  3739. // https://streams.spec.whatwg.org/#transform-stream-default-sink-abort-algorithm
  3740. JS::NonnullGCPtr<WebIDL::Promise> transform_stream_default_sink_abort_algorithm(TransformStream& stream, JS::Value reason)
  3741. {
  3742. auto& realm = stream.realm();
  3743. // 1. Perform ! TransformStreamError(stream, reason).
  3744. transform_stream_error(stream, reason);
  3745. // 2. Return a promise resolved with undefined.
  3746. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  3747. }
  3748. // https://streams.spec.whatwg.org/#transform-stream-default-sink-close-algorithm
  3749. JS::NonnullGCPtr<WebIDL::Promise> transform_stream_default_sink_close_algorithm(TransformStream& stream)
  3750. {
  3751. auto& realm = stream.realm();
  3752. // 1. Let readable be stream.[[readable]].
  3753. auto readable = stream.readable();
  3754. // 2. Let controller be stream.[[controller]].
  3755. auto controller = stream.controller();
  3756. // 3. Let flushPromise be the result of performing controller.[[flushAlgorithm]].
  3757. auto flush_promise = controller->flush_algorithm()->function()();
  3758. // 4. Perform ! TransformStreamDefaultControllerClearAlgorithms(controller).
  3759. transform_stream_default_controller_clear_algorithms(*controller);
  3760. // 5. Return the result of reacting to flushPromise:
  3761. auto react_result = WebIDL::react_to_promise(
  3762. *flush_promise,
  3763. // 1. If flushPromise was fulfilled, then:
  3764. JS::create_heap_function(realm.heap(), [readable](JS::Value) -> WebIDL::ExceptionOr<JS::Value> {
  3765. // 1. If readable.[[state]] is "errored", throw readable.[[storedError]].
  3766. if (readable->state() == ReadableStream::State::Errored)
  3767. return JS::throw_completion(readable->stored_error());
  3768. VERIFY(readable->controller().has_value() && readable->controller()->has<JS::NonnullGCPtr<ReadableStreamDefaultController>>());
  3769. // 2. Perform ! ReadableStreamDefaultControllerClose(readable.[[controller]]).
  3770. readable_stream_default_controller_close(readable->controller().value().get<JS::NonnullGCPtr<ReadableStreamDefaultController>>());
  3771. return JS::js_undefined();
  3772. }),
  3773. // 2. If flushPromise was rejected with reason r, then:
  3774. JS::create_heap_function(realm.heap(), [&stream, readable](JS::Value reason) -> WebIDL::ExceptionOr<JS::Value> {
  3775. // 1. Perform ! TransformStreamError(stream, r).
  3776. transform_stream_error(stream, reason);
  3777. // 2. Throw readable.[[storedError]].
  3778. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, readable->stored_error().as_string().utf8_string() };
  3779. }));
  3780. return WebIDL::create_resolved_promise(realm, react_result);
  3781. }
  3782. // https://streams.spec.whatwg.org/#transform-stream-default-sink-write-algorithm
  3783. JS::NonnullGCPtr<WebIDL::Promise> transform_stream_default_sink_write_algorithm(TransformStream& stream, JS::Value chunk)
  3784. {
  3785. auto& realm = stream.realm();
  3786. // 1. Assert: stream.[[writable]].[[state]] is "writable".
  3787. VERIFY(stream.writable()->state() == WritableStream::State::Writable);
  3788. // 2. Let controller be stream.[[controller]].
  3789. auto controller = stream.controller();
  3790. // 3. If stream.[[backpressure]] is true,
  3791. if (stream.backpressure().has_value() && *stream.backpressure()) {
  3792. // 1. Let backpressureChangePromise be stream.[[backpressureChangePromise]].
  3793. auto backpressure_change_promise = stream.backpressure_change_promise();
  3794. // 2. Assert: backpressureChangePromise is not undefined.
  3795. VERIFY(backpressure_change_promise);
  3796. // 3. Return the result of reacting to backpressureChangePromise with the following fulfillment steps:
  3797. auto react_result = WebIDL::react_to_promise(*backpressure_change_promise,
  3798. JS::create_heap_function(realm.heap(), [&stream, controller, chunk](JS::Value) -> WebIDL::ExceptionOr<JS::Value> {
  3799. // 1. Let writable be stream.[[writable]].
  3800. auto writable = stream.writable();
  3801. // 2. Let state be writable.[[state]].
  3802. auto state = writable->state();
  3803. // 3. If state is "erroring", throw writable.[[storedError]].
  3804. if (state == WritableStream::State::Erroring)
  3805. return JS::throw_completion(writable->stored_error());
  3806. // 4. Assert: state is "writable".
  3807. VERIFY(state == WritableStream::State::Writable);
  3808. // 5. Return ! TransformStreamDefaultControllerPerformTransform(controller, chunk).
  3809. return transform_stream_default_controller_perform_transform(*controller, chunk)->promise();
  3810. }),
  3811. {});
  3812. return WebIDL::create_resolved_promise(realm, react_result);
  3813. }
  3814. // 4. Return ! TransformStreamDefaultControllerPerformTransform(controller, chunk).
  3815. return transform_stream_default_controller_perform_transform(*controller, chunk);
  3816. }
  3817. JS::NonnullGCPtr<WebIDL::Promise> transform_stream_default_source_pull_algorithm(TransformStream& stream)
  3818. {
  3819. // 1. Assert: stream.[[backpressure]] is true.
  3820. VERIFY(stream.backpressure().has_value() && *stream.backpressure());
  3821. // 2. Assert: stream.[[backpressureChangePromise]] is not undefined.
  3822. VERIFY(stream.backpressure_change_promise());
  3823. // 3. Perform ! TransformStreamSetBackpressure(stream, false).
  3824. transform_stream_set_backpressure(stream, false);
  3825. // 4. Return stream.[[backpressureChangePromise]].
  3826. return JS::NonnullGCPtr { *stream.backpressure_change_promise() };
  3827. }
  3828. // https://streams.spec.whatwg.org/#transform-stream-error
  3829. void transform_stream_error(TransformStream& stream, JS::Value error)
  3830. {
  3831. VERIFY(stream.readable()->controller().has_value() && stream.readable()->controller()->has<JS::NonnullGCPtr<ReadableStreamDefaultController>>());
  3832. auto readable_controller = stream.readable()->controller()->get<JS::NonnullGCPtr<ReadableStreamDefaultController>>();
  3833. // 1. Perform ! ReadableStreamDefaultControllerError(stream.[[readable]].[[controller]], e).
  3834. readable_stream_default_controller_error(*readable_controller, error);
  3835. // 2. Perform ! TransformStreamErrorWritableAndUnblockWrite(stream, e).
  3836. transform_stream_error_writable_and_unblock_write(stream, error);
  3837. }
  3838. // https://streams.spec.whatwg.org/#transform-stream-error-writable-and-unblock-write
  3839. void transform_stream_error_writable_and_unblock_write(TransformStream& stream, JS::Value error)
  3840. {
  3841. // 1. Perform ! TransformStreamDefaultControllerClearAlgorithms(stream.[[controller]]).
  3842. transform_stream_default_controller_clear_algorithms(*stream.controller());
  3843. // 2. Perform ! WritableStreamDefaultControllerErrorIfNeeded(stream.[[writable]].[[controller]], e).
  3844. writable_stream_default_controller_error_if_needed(*stream.writable()->controller(), error);
  3845. // 3. If stream.[[backpressure]] is true, perform ! TransformStreamSetBackpressure(stream, false).
  3846. if (stream.backpressure().has_value() && *stream.backpressure())
  3847. transform_stream_set_backpressure(stream, false);
  3848. }
  3849. // https://streams.spec.whatwg.org/#transform-stream-set-backpressure
  3850. void transform_stream_set_backpressure(TransformStream& stream, bool backpressure)
  3851. {
  3852. auto& realm = stream.realm();
  3853. // 1. Assert: stream.[[backpressure]] is not backpressure.
  3854. VERIFY(stream.backpressure() != backpressure);
  3855. // 2. If stream.[[backpressureChangePromise]] is not undefined, resolve stream.[[backpressureChangePromise]] with undefined.
  3856. if (stream.backpressure_change_promise())
  3857. WebIDL::resolve_promise(realm, *stream.backpressure_change_promise(), JS::js_undefined());
  3858. // 3. Set stream.[[backpressureChangePromise]] to a new promise.
  3859. stream.set_backpressure_change_promise(WebIDL::create_promise(realm));
  3860. // 4. Set stream.[[backpressure]] to backpressure.
  3861. stream.set_backpressure(backpressure);
  3862. }
  3863. // https://streams.spec.whatwg.org/#transformstream-set-up
  3864. void transform_stream_set_up(TransformStream& stream, JS::NonnullGCPtr<TransformAlgorithm> transform_algorithm, JS::GCPtr<FlushAlgorithm> flush_algorithm, JS::GCPtr<CancelAlgorithm>)
  3865. {
  3866. auto& realm = stream.realm();
  3867. // 1. Let writableHighWaterMark be 1.
  3868. auto writable_high_water_mark = 1.0;
  3869. // 2. Let writableSizeAlgorithm be an algorithm that returns 1.
  3870. auto writable_size_algorithm = JS::create_heap_function(realm.heap(), [](JS::Value) {
  3871. return JS::normal_completion(JS::Value { 1 });
  3872. });
  3873. // 3. Let readableHighWaterMark be 0.
  3874. auto readable_high_water_mark = 0.0;
  3875. // 4. Let readableSizeAlgorithm be an algorithm that returns 1.
  3876. auto readable_size_algorithm = JS::create_heap_function(realm.heap(), [](JS::Value) {
  3877. return JS::normal_completion(JS::Value { 1 });
  3878. });
  3879. // 5. Let transformAlgorithmWrapper be an algorithm that runs these steps given a value chunk:
  3880. auto transform_algorithm_wrapper = JS::create_heap_function(realm.heap(), [&realm, transform_algorithm](JS::Value chunk) -> JS::NonnullGCPtr<WebIDL::Promise> {
  3881. // 1. Let result be the result of running transformAlgorithm given chunk. If this throws an exception e, return a promise rejected with e.
  3882. JS::GCPtr<JS::PromiseCapability> result = nullptr;
  3883. result = transform_algorithm->function()(chunk);
  3884. // 2. If result is a Promise, then return result.
  3885. if (result)
  3886. return JS::NonnullGCPtr { *result };
  3887. // 3. Return a promise resolved with undefined.
  3888. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  3889. });
  3890. // 6. Let flushAlgorithmWrapper be an algorithm that runs these steps:
  3891. auto flush_algorithm_wrapper = JS::create_heap_function(realm.heap(), [&realm, flush_algorithm]() -> JS::NonnullGCPtr<WebIDL::Promise> {
  3892. // 1. Let result be the result of running flushAlgorithm, if flushAlgorithm was given, or null otherwise. If this throws an exception e, return a promise rejected with e.
  3893. JS::GCPtr<JS::PromiseCapability> result = nullptr;
  3894. if (flush_algorithm)
  3895. result = flush_algorithm->function()();
  3896. // 2. If result is a Promise, then return result.
  3897. if (result)
  3898. return JS::NonnullGCPtr { *result };
  3899. // 3. Return a promise resolved with undefined.
  3900. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  3901. });
  3902. // FIXME 7. Let cancelAlgorithmWrapper be an algorithm that runs these steps given a value reason:
  3903. // 8. Let startPromise be a promise resolved with undefined.
  3904. auto start_promise = WebIDL::create_resolved_promise(realm, JS::js_undefined());
  3905. // 9. Perform ! InitializeTransformStream(stream, startPromise, writableHighWaterMark, writableSizeAlgorithm, readableHighWaterMark, readableSizeAlgorithm).
  3906. initialize_transform_stream(stream, start_promise, writable_high_water_mark, writable_size_algorithm, readable_high_water_mark, readable_size_algorithm);
  3907. // 10. Let controller be a new TransformStreamDefaultController.
  3908. auto controller = realm.heap().allocate<TransformStreamDefaultController>(realm, realm);
  3909. // 11. Perform ! SetUpTransformStreamDefaultController(stream, controller, transformAlgorithmWrapper, flushAlgorithmWrapper, cancelAlgorithmWrapper).
  3910. set_up_transform_stream_default_controller(stream, controller, transform_algorithm_wrapper, flush_algorithm_wrapper);
  3911. }
  3912. // https://streams.spec.whatwg.org/#is-non-negative-number
  3913. bool is_non_negative_number(JS::Value value)
  3914. {
  3915. // 1. If Type(v) is not Number, return false.
  3916. if (!value.is_number())
  3917. return false;
  3918. // 2. If v is NaN, return false.
  3919. if (value.is_nan())
  3920. return false;
  3921. // 3. If v < 0, return false.
  3922. if (value.as_double() < 0.0)
  3923. return false;
  3924. // 4. Return true.
  3925. return true;
  3926. }
  3927. // https://streams.spec.whatwg.org/#can-transfer-array-buffer
  3928. bool can_transfer_array_buffer(JS::ArrayBuffer const& array_buffer)
  3929. {
  3930. // 1. Assert: Type(O) is Object.
  3931. // 2. Assert: O has an [[ArrayBufferData]] internal slot.
  3932. // 3. If ! IsDetachedBuffer(O) is true, return false.
  3933. if (array_buffer.is_detached())
  3934. return false;
  3935. // 4. If SameValue(O.[[ArrayBufferDetachKey]], undefined) is false, return false.
  3936. if (!JS::same_value(array_buffer.detach_key(), JS::js_undefined()))
  3937. return false;
  3938. // 5. Return true.
  3939. return true;
  3940. }
  3941. // https://streams.spec.whatwg.org/#abstract-opdef-cloneasuint8array
  3942. WebIDL::ExceptionOr<JS::Value> clone_as_uint8_array(JS::Realm& realm, WebIDL::ArrayBufferView& view)
  3943. {
  3944. auto& vm = realm.vm();
  3945. // 1. Assert: Type(O) is Object.
  3946. // 2. Assert: O has an [[ViewedArrayBuffer]] internal slot.
  3947. // 3. Assert: ! IsDetachedBuffer(O.[[ViewedArrayBuffer]]) is false.
  3948. VERIFY(!view.viewed_array_buffer()->is_detached());
  3949. // 4. Let buffer be ? CloneArrayBuffer(O.[[ViewedArrayBuffer]], O.[[ByteOffset]], O.[[ByteLength]], %ArrayBuffer%).
  3950. auto* buffer = TRY(JS::clone_array_buffer(vm, *view.viewed_array_buffer(), view.byte_offset(), view.byte_length()));
  3951. // 5. Let array be ! Construct(%Uint8Array%, « buffer »).
  3952. auto array = MUST(JS::construct(vm, *realm.intrinsics().uint8_array_constructor(), buffer));
  3953. // 5. Return array.
  3954. return array;
  3955. }
  3956. // https://streams.spec.whatwg.org/#abstract-opdef-structuredclone
  3957. WebIDL::ExceptionOr<JS::Value> structured_clone(JS::Realm& realm, JS::Value value)
  3958. {
  3959. auto& vm = realm.vm();
  3960. // 1. Let serialized be ? StructuredSerialize(v).
  3961. auto serialized = TRY(HTML::structured_serialize(vm, value));
  3962. // 2. Return ? StructuredDeserialize(serialized, the current Realm).
  3963. return TRY(HTML::structured_deserialize(vm, serialized, realm, {}));
  3964. }
  3965. // https://streams.spec.whatwg.org/#close-sentinel
  3966. // Non-standard function that implements the "close sentinel" value.
  3967. JS::Value create_close_sentinel()
  3968. {
  3969. // 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.
  3970. // 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.
  3971. return {};
  3972. }
  3973. // https://streams.spec.whatwg.org/#close-sentinel
  3974. // Non-standard function that implements the "If value is a close sentinel" check.
  3975. bool is_close_sentinel(JS::Value value)
  3976. {
  3977. return value.is_empty();
  3978. }
  3979. // Non-standard function to aid in converting a user-provided function into a WebIDL::Callback. This is essentially
  3980. // what the Bindings generator would do at compile time, but at runtime instead.
  3981. JS::ThrowCompletionOr<JS::Handle<WebIDL::CallbackType>> property_to_callback(JS::VM& vm, JS::Value value, JS::PropertyKey const& property_key, WebIDL::OperationReturnsPromise operation_returns_promise)
  3982. {
  3983. auto property = TRY(value.get(vm, property_key));
  3984. if (property.is_undefined())
  3985. return JS::Handle<WebIDL::CallbackType> {};
  3986. if (!property.is_function())
  3987. return vm.throw_completion<JS::TypeError>(JS::ErrorType::NotAFunction, property.to_string_without_side_effects());
  3988. return vm.heap().allocate_without_realm<WebIDL::CallbackType>(property.as_object(), HTML::incumbent_settings_object(), operation_returns_promise);
  3989. }
  3990. // https://streams.spec.whatwg.org/#set-up-readable-byte-stream-controller-from-underlying-source
  3991. WebIDL::ExceptionOr<void> set_up_readable_byte_stream_controller_from_underlying_source(ReadableStream& stream, JS::Value underlying_source, UnderlyingSource const& underlying_source_dict, double high_water_mark)
  3992. {
  3993. auto& realm = stream.realm();
  3994. // 1. Let controller be a new ReadableByteStreamController.
  3995. auto controller = stream.heap().allocate<ReadableByteStreamController>(realm, realm);
  3996. // 2. Let startAlgorithm be an algorithm that returns undefined.
  3997. auto start_algorithm = JS::create_heap_function(realm.heap(), []() -> WebIDL::ExceptionOr<JS::Value> { return JS::js_undefined(); });
  3998. // 3. Let pullAlgorithm be an algorithm that returns a promise resolved with undefined.
  3999. auto pull_algorithm = JS::create_heap_function(realm.heap(), [&realm]() {
  4000. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  4001. });
  4002. // 4. Let cancelAlgorithm be an algorithm that returns a promise resolved with undefined.
  4003. auto cancel_algorithm = JS::create_heap_function(realm.heap(), [&realm](JS::Value) {
  4004. return WebIDL::create_resolved_promise(realm, JS::js_undefined());
  4005. });
  4006. // 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.
  4007. if (underlying_source_dict.start) {
  4008. start_algorithm = JS::create_heap_function(realm.heap(), [controller, underlying_source, callback = underlying_source_dict.start]() -> WebIDL::ExceptionOr<JS::Value> {
  4009. // Note: callback does not return a promise, so invoke_callback may return an abrupt completion
  4010. return TRY(WebIDL::invoke_callback(*callback, underlying_source, controller)).release_value();
  4011. });
  4012. }
  4013. // 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.
  4014. if (underlying_source_dict.pull) {
  4015. pull_algorithm = JS::create_heap_function(realm.heap(), [&realm, controller, underlying_source, callback = underlying_source_dict.pull]() {
  4016. // Note: callback returns a promise, so invoke_callback will never return an abrupt completion
  4017. auto result = MUST(WebIDL::invoke_callback(*callback, underlying_source, controller)).release_value();
  4018. return WebIDL::create_resolved_promise(realm, result);
  4019. });
  4020. }
  4021. // 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.
  4022. if (underlying_source_dict.cancel) {
  4023. cancel_algorithm = JS::create_heap_function(realm.heap(), [&realm, underlying_source, callback = underlying_source_dict.cancel](JS::Value reason) {
  4024. // Note: callback returns a promise, so invoke_callback will never return an abrupt completion
  4025. auto result = MUST(WebIDL::invoke_callback(*callback, underlying_source, reason)).release_value();
  4026. return WebIDL::create_resolved_promise(realm, result);
  4027. });
  4028. }
  4029. // 8. Let autoAllocateChunkSize be underlyingSourceDict["autoAllocateChunkSize"], if it exists, or undefined otherwise.
  4030. auto auto_allocate_chunk_size = underlying_source_dict.auto_allocate_chunk_size.has_value()
  4031. ? JS::Value(underlying_source_dict.auto_allocate_chunk_size.value())
  4032. : JS::js_undefined();
  4033. // 9. If autoAllocateChunkSize is 0, then throw a TypeError exception.
  4034. if (auto_allocate_chunk_size.is_integral_number() && auto_allocate_chunk_size.as_double() == 0)
  4035. return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, "Cannot use an auto allocate chunk size of 0"sv };
  4036. // 10. Perform ? SetUpReadableByteStreamController(stream, controller, startAlgorithm, pullAlgorithm, cancelAlgorithm, highWaterMark, autoAllocateChunkSize).
  4037. return set_up_readable_byte_stream_controller(stream, controller, start_algorithm, pull_algorithm, cancel_algorithm, high_water_mark, auto_allocate_chunk_size);
  4038. }
  4039. }