AbstractOperations.cpp 243 KB

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