1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
|
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "third_party/blink/renderer/core/streams/writable_stream.h"
#include "third_party/blink/renderer/bindings/core/v8/script_value.h"
#include "third_party/blink/renderer/bindings/core/v8/to_v8_traits.h"
#include "third_party/blink/renderer/bindings/core/v8/v8_queuing_strategy_init.h"
#include "third_party/blink/renderer/core/dom/abort_signal.h"
#include "third_party/blink/renderer/core/streams/count_queuing_strategy.h"
#include "third_party/blink/renderer/core/streams/miscellaneous_operations.h"
#include "third_party/blink/renderer/core/streams/pipe_options.h"
#include "third_party/blink/renderer/core/streams/readable_stream.h"
#include "third_party/blink/renderer/core/streams/readable_stream_transferring_optimizer.h"
#include "third_party/blink/renderer/core/streams/transferable_streams.h"
#include "third_party/blink/renderer/core/streams/underlying_sink_base.h"
#include "third_party/blink/renderer/core/streams/writable_stream_default_controller.h"
#include "third_party/blink/renderer/core/streams/writable_stream_default_writer.h"
#include "third_party/blink/renderer/core/streams/writable_stream_transferring_optimizer.h"
#include "third_party/blink/renderer/platform/bindings/exception_state.h"
#include "third_party/blink/renderer/platform/bindings/script_state.h"
#include "third_party/blink/renderer/platform/bindings/v8_binding.h"
#include "third_party/blink/renderer/platform/heap/garbage_collected.h"
#include "third_party/blink/renderer/platform/heap/visitor.h"
// Implementation of WritableStream for Blink. See
// https://streams.spec.whatwg.org/#ws. The implementation closely follows the
// standard, except where required for performance or integration with Blink.
// In particular, classes, methods and abstract operations are implemented in
// the same order as in the standard, to simplify side-by-side reading.
namespace blink {
// The PendingAbortRequest type corresponds to the Record {[[promise]],
// [[reason]], [[wasAlreadyErroring]]} from the standard.
class WritableStream::PendingAbortRequest final
: public GarbageCollected<PendingAbortRequest> {
public:
PendingAbortRequest(v8::Isolate* isolate,
ScriptPromiseResolver<IDLUndefined>* resolver,
v8::Local<v8::Value> reason,
bool was_already_erroring)
: resolver_(resolver),
reason_(isolate, reason),
was_already_erroring_(was_already_erroring) {}
PendingAbortRequest(const PendingAbortRequest&) = delete;
PendingAbortRequest& operator=(const PendingAbortRequest&) = delete;
ScriptPromiseResolver<IDLUndefined>* GetResolver() { return resolver_.Get(); }
v8::Local<v8::Value> Reason(v8::Isolate* isolate) {
return reason_.Get(isolate);
}
bool WasAlreadyErroring() { return was_already_erroring_; }
void Trace(Visitor* visitor) const {
visitor->Trace(resolver_);
visitor->Trace(reason_);
}
private:
Member<ScriptPromiseResolver<IDLUndefined>> resolver_;
TraceWrapperV8Reference<v8::Value> reason_;
const bool was_already_erroring_;
};
WritableStream* WritableStream::Create(ScriptState* script_state,
ExceptionState& exception_state) {
return Create(script_state,
ScriptValue(script_state->GetIsolate(),
v8::Undefined(script_state->GetIsolate())),
ScriptValue(script_state->GetIsolate(),
v8::Undefined(script_state->GetIsolate())),
exception_state);
}
WritableStream* WritableStream::Create(ScriptState* script_state,
ScriptValue underlying_sink,
ExceptionState& exception_state) {
return Create(script_state, underlying_sink,
ScriptValue(script_state->GetIsolate(),
v8::Undefined(script_state->GetIsolate())),
exception_state);
}
WritableStream* WritableStream::Create(ScriptState* script_state,
ScriptValue raw_underlying_sink,
ScriptValue raw_strategy,
ExceptionState& exception_state) {
auto* stream = MakeGarbageCollected<WritableStream>();
stream->InitInternal(script_state, raw_underlying_sink, raw_strategy,
exception_state);
if (exception_state.HadException()) {
return nullptr;
}
return stream;
}
WritableStream::WritableStream() = default;
WritableStream::~WritableStream() = default;
ScriptPromise<IDLUndefined> WritableStream::abort(
ScriptState* script_state,
ExceptionState& exception_state) {
return abort(script_state,
ScriptValue(script_state->GetIsolate(),
v8::Undefined(script_state->GetIsolate())),
exception_state);
}
ScriptPromise<IDLUndefined> WritableStream::abort(
ScriptState* script_state,
ScriptValue reason,
ExceptionState& exception_state) {
// https://streams.spec.whatwg.org/#ws-abort
// 2. If ! IsWritableStreamLocked(this) is true, return a promise rejected
// with a TypeError exception.
if (IsLocked(this)) {
exception_state.ThrowTypeError("Cannot abort a locked stream");
return EmptyPromise();
}
// 3. Return ! WritableStreamAbort(this, reason).
return Abort(script_state, this, reason.V8Value());
}
ScriptPromise<IDLUndefined> WritableStream::close(
ScriptState* script_state,
ExceptionState& exception_state) {
// https://streams.spec.whatwg.org/#ws-close
// 2. If ! IsWritableStreamLocked(this) is true, return a promise rejected
// with a TypeError exception.
if (IsLocked(this)) {
exception_state.ThrowTypeError("Cannot close a locked stream");
return EmptyPromise();
}
// 3. If ! WritableStreamCloseQueuedOrInFlight(this) is true, return a promise
// rejected with a TypeError exception.
if (CloseQueuedOrInFlight(this)) {
exception_state.ThrowTypeError("Cannot close a closed or closing stream");
return EmptyPromise();
}
if (!script_state->ContextIsValid()) {
exception_state.ThrowTypeError("invalid realm");
return EmptyPromise();
}
return Close(script_state, this);
}
WritableStreamDefaultWriter* WritableStream::getWriter(
ScriptState* script_state,
ExceptionState& exception_state) {
// https://streams.spec.whatwg.org/#ws-get-writer
// 2. Return ? AcquireWritableStreamDefaultWriter(this).
auto* writer = AcquireDefaultWriter(script_state, this, exception_state);
if (exception_state.HadException()) {
return nullptr;
}
return writer;
}
// General Writable Stream Abstract Operations
WritableStream* WritableStream::Create(ScriptState* script_state,
StreamStartAlgorithm* start_algorithm,
StreamAlgorithm* write_algorithm,
StreamAlgorithm* close_algorithm,
StreamAlgorithm* abort_algorithm,
double high_water_mark,
StrategySizeAlgorithm* size_algorithm,
ExceptionState& exception_state) {
DCHECK(size_algorithm);
// https://streams.spec.whatwg.org/#create-writable-stream
// 3. Assert: ! IsNonNegativeNumber(highWaterMark) is true.
DCHECK_GE(high_water_mark, 0);
// 4. Let stream be ObjectCreate(the original value of WritableStream's
// prototype property).
// 5. Perform ! InitializeWritableStream(stream).
auto* stream = MakeGarbageCollected<WritableStream>();
// 6. Let controller be ObjectCreate(the original value of
// WritableStreamDefaultController's prototype property).
auto* controller = MakeGarbageCollected<WritableStreamDefaultController>();
// 7. Perform ? SetUpWritableStreamDefaultController(stream, controller,
// startAlgorithm, writeAlgorithm, closeAlgorithm, abortAlgorithm,
// highWaterMark, sizeAlgorithm).
WritableStreamDefaultController::SetUp(
script_state, stream, controller, start_algorithm, write_algorithm,
close_algorithm, abort_algorithm, high_water_mark, size_algorithm,
exception_state);
// 8. Return stream.
return stream;
}
// static
WritableStream* WritableStream::CreateWithCountQueueingStrategy(
ScriptState* script_state,
UnderlyingSinkBase* underlying_sink,
size_t high_water_mark) {
return CreateWithCountQueueingStrategy(script_state, underlying_sink,
high_water_mark,
/*optimizer=*/nullptr);
}
WritableStream* WritableStream::CreateWithCountQueueingStrategy(
ScriptState* script_state,
UnderlyingSinkBase* underlying_sink,
size_t high_water_mark,
std::unique_ptr<WritableStreamTransferringOptimizer> optimizer) {
v8::Isolate* isolate = script_state->GetIsolate();
v8::MicrotasksScope microtasks_scope(
isolate, ToMicrotaskQueue(script_state),
v8::MicrotasksScope::kDoNotRunMicrotasks);
auto* stream = MakeGarbageCollected<WritableStream>();
stream->InitWithCountQueueingStrategy(script_state, underlying_sink,
high_water_mark, std::move(optimizer),
PassThroughException(isolate));
if (isolate->HasPendingException()) {
return nullptr;
}
return stream;
}
void WritableStream::InitWithCountQueueingStrategy(
ScriptState* script_state,
UnderlyingSinkBase* underlying_sink,
size_t high_water_mark,
std::unique_ptr<WritableStreamTransferringOptimizer> optimizer,
ExceptionState& exception_state) {
auto* controller = MakeGarbageCollected<WritableStreamDefaultController>();
WritableStreamDefaultController::SetUp(
script_state, this, controller,
MakeGarbageCollected<UnderlyingSinkStartAlgorithm>(underlying_sink,
controller),
MakeGarbageCollected<UnderlyingSinkWriteAlgorithm>(underlying_sink),
MakeGarbageCollected<UnderlyingSinkCloseAlgorithm>(underlying_sink),
MakeGarbageCollected<UnderlyingSinkAbortAlgorithm>(underlying_sink),
high_water_mark, CreateDefaultSizeAlgorithm(), exception_state);
transferring_optimizer_ = std::move(optimizer);
}
void WritableStream::Serialize(ScriptState* script_state,
MessagePort* port,
ExceptionState& exception_state) {
// https://streams.spec.whatwg.org/#ws-transfer
// 1. If ! IsWritableStreamLocked(value) is true, throw a "DataCloneError"
// DOMException.
if (IsLocked(this)) {
exception_state.ThrowTypeError("Cannot transfer a locked stream");
return;
}
// Done by SerializedScriptValue::TransferWritableStream():
// 2. Let port1 be a new MessagePort in the current Realm.
// 3. Let port2 be a new MessagePort in the current Realm.
// 4. Entangle port1 and port2.
// 5. Let readable be a new ReadableStream in the current Realm.
// 6. Perform ! SetUpCrossRealmTransformReadable(readable, port1).
auto* readable = CreateCrossRealmTransformReadable(
script_state, port, /*optimizer=*/nullptr, exception_state);
if (exception_state.HadException()) {
return;
}
// 7. Let promise be ! ReadableStreamPipeTo(readable, value, false, false,
// false).
auto promise = ReadableStream::PipeTo(script_state, readable, this,
MakeGarbageCollected<PipeOptions>(),
exception_state);
// 8. Set promise.[[PromiseIsHandled]] to true.
promise.MarkAsHandled();
// This step is done in a roundabout way by the caller:
// 9. Set dataHolder.[[port]] to ! StructuredSerializeWithTransfer(port2, «
// port2 »).
}
WritableStream* WritableStream::Deserialize(
ScriptState* script_state,
MessagePort* port,
std::unique_ptr<WritableStreamTransferringOptimizer> optimizer,
ExceptionState& exception_state) {
// We need to execute JavaScript to call "Then" on v8::Promises. We will not
// run author code.
v8::Isolate::AllowJavascriptExecutionScope allow_js(
script_state->GetIsolate());
// https://streams.spec.whatwg.org/#ws-transfer
// These step is done by V8ScriptValueDeserializer::ReadDOMObject().
// 1. Let deserializedRecord be !
// StructuredDeserializeWithTransfer(dataHolder.[[port]], the current
// Realm).
// 2. Let port be deserializedRecord.[[Deserialized]].
// 3. Perform ! SetUpCrossRealmTransformWritable(value, port).
// In the standard |value| contains an unitialized WritableStream. In the
// implementation, we create the stream here.
auto* writable = CreateCrossRealmTransformWritable(
script_state, port, AllowPerChunkTransferring(false),
std::move(optimizer), exception_state);
if (exception_state.HadException()) {
return nullptr;
}
return writable;
}
WritableStreamDefaultWriter* WritableStream::AcquireDefaultWriter(
ScriptState* script_state,
WritableStream* stream,
ExceptionState& exception_state) {
// https://streams.spec.whatwg.org/#acquire-writable-stream-default-writer
// 1. Return ? Construct(WritableStreamDefaultWriter, « stream »).
auto* writer = MakeGarbageCollected<WritableStreamDefaultWriter>(
script_state, stream, exception_state);
if (exception_state.HadException()) {
return nullptr;
}
return writer;
}
ScriptPromise<IDLUndefined> WritableStream::Abort(ScriptState* script_state,
WritableStream* stream,
v8::Local<v8::Value> reason) {
// https://streams.spec.whatwg.org/#writable-stream-abort
// 1. If stream.[[state]] is "closed" or "errored", return a promise resolved
// with undefined.
if (stream->state_ == kClosed || stream->state_ == kErrored) {
return ToResolvedUndefinedPromise(script_state);
}
// 2. Signal abort on stream.[[controller]].[[abortController]] with reason.
auto* isolate = script_state->GetIsolate();
stream->Controller()->Abort(script_state, ScriptValue(isolate, reason));
// 3. Let state be stream.[[state]].
const auto state = stream->state_;
// 4. If state is "closed" or "errored", return a promise resolved with
// undefined.
if (state == kClosed || state == kErrored) {
return ToResolvedUndefinedPromise(script_state);
}
// 5. If stream.[[pendingAbortRequest]] is not undefined, return
// stream.[[pendingAbortRequest]]'s promise.
if (stream->pending_abort_request_) {
return stream->pending_abort_request_->GetResolver()->Promise();
}
// 6. Assert: state is "writable" or "erroring".
CHECK(state == kWritable || state == kErroring);
// 7. Let wasAlreadyErroring be false.
// 8. If state is "erroring",
// a. Set wasAlreadyErroring to true.
// b. Set reason to undefined.
const bool was_already_erroring = state == kErroring;
if (was_already_erroring) {
reason = v8::Undefined(isolate);
}
// 9. Let promise be a new promise.
auto* resolver =
MakeGarbageCollected<ScriptPromiseResolver<IDLUndefined>>(script_state);
// 10. Set stream.[[pendingAbortRequest]] to a new pending abort request
// whose promise is promise, reason is reason, and was already erroring is
// wasAlreadyErroring.
stream->pending_abort_request_ = MakeGarbageCollected<PendingAbortRequest>(
isolate, resolver, reason, was_already_erroring);
// 11. If wasAlreadyErroring is false, perform ! WritableStreamStartErroring(
// stream, reason).
if (!was_already_erroring) {
StartErroring(script_state, stream, reason);
}
// 12. Return promise.
return resolver->Promise();
}
// Writable Stream Abstract Operations Used by Controllers
void WritableStream::AddWriteRequest(
WritableStream* stream,
ScriptPromiseResolver<IDLUndefined>* resolver) {
// https://streams.spec.whatwg.org/#writable-stream-add-write-request
// 1. Assert: ! IsWritableStreamLocked(stream) is true.
DCHECK(IsLocked(stream));
// 2. Assert: stream.[[state]] is "writable".
CHECK_EQ(stream->state_, kWritable);
// 3. Let promise be a new promise.
// 4. Append promise as the last element of stream.[[writeRequests]]
// 5. Return promise.
stream->write_requests_.push_back(resolver);
}
ScriptPromise<IDLUndefined> WritableStream::Close(ScriptState* script_state,
WritableStream* stream) {
// https://streams.spec.whatwg.org/#writable-stream-close
// 1. Let state be stream.[[state]].
const auto state = stream->GetState();
// 2. If state is "closed" or "errored", return a promise rejected with a
// TypeError exception.
if (state == kClosed || state == kErrored) {
return ScriptPromise<IDLUndefined>::Reject(
script_state, CreateCannotActionOnStateStreamException(
script_state->GetIsolate(), "close", state));
}
// 3. Assert: state is "writable" or "erroring".
CHECK(state == kWritable || state == kErroring);
// 4. Assert: ! WritableStreamCloseQueuedOrInFlight(stream) is false.
CHECK(!CloseQueuedOrInFlight(stream));
// 5. Let promise be a new promise.
auto* resolver =
MakeGarbageCollected<ScriptPromiseResolver<IDLUndefined>>(script_state);
resolver->SuppressDetachCheck();
// 6. Set stream.[[closeRequest]] to promise.
stream->SetCloseRequest(resolver);
// 7. Let writer be stream.[[writer]].
WritableStreamDefaultWriter* writer = stream->writer_;
// 8. If writer is not undefined, and stream.[[backpressure]] is true, and
// state is "writable", resolve writer.[[readyPromise]] with undefined.
if (writer && stream->HasBackpressure() && state == kWritable) {
writer->ReadyResolver()->Resolve();
}
// 9. Perform ! WritableStreamDefaultControllerClose(
// stream.[[writableStreamController]]).
WritableStreamDefaultController::Close(script_state, stream->Controller());
// 10. Return promise.
return resolver->Promise();
}
bool WritableStream::CloseQueuedOrInFlight(const WritableStream* stream) {
// https://streams.spec.whatwg.org/#writable-stream-close-queued-or-in-flight
// 1. If stream.[[closeRequest]] is undefined and
// stream.[[inFlightCloseRequest]] is undefined, return false.
// 2. Return true.
return stream->close_request_ || stream->in_flight_close_request_;
}
void WritableStream::DealWithRejection(ScriptState* script_state,
WritableStream* stream,
v8::Local<v8::Value> error) {
// https://streams.spec.whatwg.org/#writable-stream-deal-with-rejection
// 1. Let state be stream.[[state]].
const auto state = stream->state_;
// 2. If state is "writable",
if (state == kWritable) {
// a. Perform ! WritableStreamStartErroring(stream, error).
StartErroring(script_state, stream, error);
// b. Return.
return;
}
// 3. Assert: state is "erroring".
CHECK_EQ(state, kErroring);
// 4. Perform ! WritableStreamFinishErroring(stream).
FinishErroring(script_state, stream);
}
void WritableStream::StartErroring(ScriptState* script_state,
WritableStream* stream,
v8::Local<v8::Value> reason) {
// https://streams.spec.whatwg.org/#writable-stream-start-erroring
// 1. Assert: stream.[[storedError]] is undefined.
DCHECK(stream->stored_error_.IsEmpty());
// 2. Assert: stream.[[state]] is "writable".
CHECK_EQ(stream->state_, kWritable);
// 3. Let controller be stream.[[writableStreamController]].
WritableStreamDefaultController* controller =
stream->writable_stream_controller_;
// 4. Assert: controller is not undefined.
DCHECK(controller);
// 5. Set stream.[[state]] to "erroring".
stream->state_ = kErroring;
// 6. Set stream.[[storedError]] to reason.
stream->stored_error_.Reset(script_state->GetIsolate(), reason);
// 7. Let writer be stream.[[writer]].
WritableStreamDefaultWriter* writer = stream->writer_;
// 8. If writer is not undefined, perform !
// WritableStreamDefaultWriterEnsureReadyPromiseRejected(writer, reason).
if (writer) {
WritableStreamDefaultWriter::EnsureReadyPromiseRejected(script_state,
writer, reason);
}
// 9. If ! WritableStreamHasOperationMarkedInFlight(stream) is false and
// controller.[[started]] is true, perform !
// WritableStreamFinishErroring(stream).
if (!HasOperationMarkedInFlight(stream) && controller->Started()) {
FinishErroring(script_state, stream);
}
}
void WritableStream::FinishErroring(ScriptState* script_state,
WritableStream* stream) {
// https://streams.spec.whatwg.org/#writable-stream-finish-erroring
// 1. Assert: stream.[[state]] is "erroring".
CHECK_EQ(stream->state_, kErroring);
// 2. Assert: ! WritableStreamHasOperationMarkedInFlight(stream) is false.
DCHECK(!HasOperationMarkedInFlight(stream));
// 3. Set stream.[[state]] to "errored".
stream->state_ = kErrored;
// 4. Perform ! stream.[[writableStreamController]].[[ErrorSteps]]().
stream->writable_stream_controller_->ErrorSteps();
// 5. Let storedError be stream.[[storedError]].
auto* isolate = script_state->GetIsolate();
const auto stored_error = stream->stored_error_.Get(isolate);
// 6. Repeat for each writeRequest that is an element of
// stream.[[writeRequests]],
// a. Reject writeRequest with storedError.
RejectPromises(script_state, &stream->write_requests_, stored_error);
// 7. Set stream.[[writeRequests]] to an empty List.
stream->write_requests_.clear();
// 8. If stream.[[pendingAbortRequest]] is undefined,
if (!stream->pending_abort_request_) {
// a. Perform !
// WritableStreamRejectCloseAndClosedPromiseIfNeeded(stream).
RejectCloseAndClosedPromiseIfNeeded(script_state, stream);
// b. Return.
return;
}
// 9. Let abortRequest be stream.[[pendingAbortRequest]].
auto* abort_request = stream->pending_abort_request_.Get();
// 10. Set stream.[[pendingAbortRequest]] to undefined.
stream->pending_abort_request_ = nullptr;
// 11. If abortRequest.[[wasAlreadyErroring]] is true,
if (abort_request->WasAlreadyErroring()) {
// a. Reject abortRequest.[[promise]] with storedError.
abort_request->GetResolver()->Reject(stored_error);
// b. Perform !
// WritableStreamRejectCloseAndClosedPromiseIfNeeded(stream)
RejectCloseAndClosedPromiseIfNeeded(script_state, stream);
// c. Return.
return;
}
// 12. Let promise be ! stream.[[writableStreamController]].[[AbortSteps]](
// abortRequest.[[reason]]).
auto promise = stream->writable_stream_controller_->AbortSteps(
script_state, abort_request->Reason(isolate));
class ResolvePromiseFunction final
: public ThenCallable<IDLUndefined, ResolvePromiseFunction> {
public:
ResolvePromiseFunction(WritableStream* stream,
ScriptPromiseResolver<IDLUndefined>* resolver)
: stream_(stream), resolver_(resolver) {}
void React(ScriptState* script_state) {
// 13. Upon fulfillment of promise,
// a. Resolve abortRequest.[[promise]] with undefined.
resolver_->Resolve();
// b. Perform !
// WritableStreamRejectCloseAndClosedPromiseIfNeeded(stream).
RejectCloseAndClosedPromiseIfNeeded(script_state, stream_);
}
void Trace(Visitor* visitor) const override {
visitor->Trace(stream_);
visitor->Trace(resolver_);
ThenCallable<IDLUndefined, ResolvePromiseFunction>::Trace(visitor);
}
private:
Member<WritableStream> stream_;
Member<ScriptPromiseResolver<IDLUndefined>> resolver_;
};
class RejectPromiseFunction final
: public ThenCallable<IDLAny, RejectPromiseFunction> {
public:
RejectPromiseFunction(WritableStream* stream,
ScriptPromiseResolver<IDLUndefined>* resolver)
: stream_(stream), resolver_(resolver) {}
void React(ScriptState* script_state, ScriptValue reason) {
// 14. Upon rejection of promise with reason reason,
// a. Reject abortRequest.[[promise]] with reason.
resolver_->Reject(reason);
// b. Perform !
// WritableStreamRejectCloseAndClosedPromiseIfNeeded(stream).
RejectCloseAndClosedPromiseIfNeeded(script_state, stream_);
}
void Trace(Visitor* visitor) const override {
visitor->Trace(stream_);
visitor->Trace(resolver_);
ThenCallable<IDLAny, RejectPromiseFunction>::Trace(visitor);
}
private:
Member<WritableStream> stream_;
Member<ScriptPromiseResolver<IDLUndefined>> resolver_;
};
promise.Then(script_state,
MakeGarbageCollected<ResolvePromiseFunction>(
stream, abort_request->GetResolver()),
MakeGarbageCollected<RejectPromiseFunction>(
stream, abort_request->GetResolver()));
}
void WritableStream::FinishInFlightWrite(ScriptState* script_state,
WritableStream* stream) {
// https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-write
// 1. Assert: stream.[[inFlightWriteRequest]] is not undefined.
DCHECK(stream->in_flight_write_request_);
// 2. Resolve stream.[[inFlightWriteRequest]] with undefined.
stream->in_flight_write_request_->Resolve();
// 3. Set stream.[[inFlightWriteRequest]] to undefined.
stream->in_flight_write_request_ = nullptr;
}
void WritableStream::FinishInFlightWriteWithError(ScriptState* script_state,
WritableStream* stream,
v8::Local<v8::Value> error) {
// https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-write-with-error
// 1. Assert: stream.[[inFlightWriteRequest]] is not undefined.
DCHECK(stream->in_flight_write_request_);
// 2. Reject stream.[[inFlightWriteRequest]] with error.
stream->in_flight_write_request_->Reject(error);
// 3. Set stream.[[inFlightWriteRequest]] to undefined.
stream->in_flight_write_request_ = nullptr;
// 4. Assert: stream.[[state]] is "writable" or "erroring".
const auto state = stream->state_;
CHECK(state == kWritable || state == kErroring);
// 5. Perform ! WritableStreamDealWithRejection(stream, error).
DealWithRejection(script_state, stream, error);
}
void WritableStream::FinishInFlightClose(ScriptState* script_state,
WritableStream* stream) {
// https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-close
// 1. Assert: stream.[[inFlightCloseRequest]] is not undefined.
DCHECK(stream->in_flight_close_request_);
// 2. Resolve stream.[[inFlightCloseRequest]] with undefined.
stream->in_flight_close_request_->Resolve();
// 3. Set stream.[[inFlightCloseRequest]] to undefined.
stream->in_flight_close_request_ = nullptr;
// 4. Let state be stream.[[state]].
const auto state = stream->state_;
// 5. Assert: stream.[[state]] is "writable" or "erroring".
CHECK(state == kWritable || state == kErroring);
// 6. If state is "erroring",
if (state == kErroring) {
// a. Set stream.[[storedError]] to undefined.
stream->stored_error_.Reset();
// b. If stream.[[pendingAbortRequest]] is not undefined,
if (stream->pending_abort_request_) {
// i. Resolve stream.[[pendingAbortRequest]].[[promise]] with
// undefined.
stream->pending_abort_request_->GetResolver()->Resolve();
// ii. Set stream.[[pendingAbortRequest]] to undefined.
stream->pending_abort_request_ = nullptr;
}
}
// 7. Set stream.[[state]] to "closed".
stream->state_ = kClosed;
// 8. Let writer be stream.[[writer]].
const auto writer = stream->writer_;
// 9. If writer is not undefined, resolve writer.[[closedPromise]] with
// undefined.
if (writer) {
writer->ClosedResolver()->Resolve();
}
// 10. Assert: stream.[[pendingAbortRequest]] is undefined.
DCHECK(!stream->pending_abort_request_);
// 11. Assert: stream.[[storedError]] is undefined.
DCHECK(stream->stored_error_.IsEmpty());
}
void WritableStream::FinishInFlightCloseWithError(ScriptState* script_state,
WritableStream* stream,
v8::Local<v8::Value> error) {
// https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-close-with-error
// 1. Assert: stream.[[inFlightCloseRequest]] is not undefined.
DCHECK(stream->in_flight_close_request_);
// 2. Reject stream.[[inFlightCloseRequest]] with error.
stream->in_flight_close_request_->Reject(error);
// 3. Set stream.[[inFlightCloseRequest]] to undefined.
stream->in_flight_close_request_ = nullptr;
// 4. Assert: stream.[[state]] is "writable" or "erroring".
const auto state = stream->state_;
CHECK(state == kWritable || state == kErroring);
// 5. If stream.[[pendingAbortRequest]] is not undefined,
if (stream->pending_abort_request_) {
// a. Reject stream.[[pendingAbortRequest]].[[promise]] with error.
stream->pending_abort_request_->GetResolver()->Reject(error);
// b. Set stream.[[pendingAbortRequest]] to undefined.
stream->pending_abort_request_ = nullptr;
}
// 6. Perform ! WritableStreamDealWithRejection(stream, error).
DealWithRejection(script_state, stream, error);
}
void WritableStream::MarkCloseRequestInFlight(WritableStream* stream) {
// https://streams.spec.whatwg.org/#writable-stream-mark-close-request-in-flight
// 1. Assert: stream.[[inFlightCloseRequest]] is undefined.
DCHECK(!stream->in_flight_close_request_);
// 2. Assert: stream.[[closeRequest]] is not undefined.
DCHECK(stream->close_request_);
// 3. Set stream.[[inFlightCloseRequest]] to stream.[[closeRequest]].
stream->in_flight_close_request_ = stream->close_request_;
// 4. Set stream.[[closeRequest]] to undefined.
stream->close_request_ = nullptr;
}
void WritableStream::MarkFirstWriteRequestInFlight(WritableStream* stream) {
// https://streams.spec.whatwg.org/#writable-stream-mark-first-write-request-in-flight
// 1. Assert: stream.[[inFlightWriteRequest]] is undefined.
DCHECK(!stream->in_flight_write_request_);
// 2. Assert: stream.[[writeRequests]] is not empty.
DCHECK(!stream->write_requests_.empty());
// 3. Let writeRequest be the first element of stream.[[writeRequests]].
ScriptPromiseResolver<IDLUndefined>* write_request =
stream->write_requests_.front();
// 4. Remove writeRequest from stream.[[writeRequests]], shifting all other
// elements downward (so that the second becomes the first, and so on).
stream->write_requests_.pop_front();
// 5. Set stream.[[inFlightWriteRequest]] to writeRequest.
stream->in_flight_write_request_ = write_request;
}
void WritableStream::UpdateBackpressure(ScriptState* script_state,
WritableStream* stream,
bool backpressure) {
// https://streams.spec.whatwg.org/#writable-stream-update-backpressure
// 1. Assert: stream.[[state]] is "writable".
CHECK_EQ(stream->state_, kWritable);
// 2. Assert: ! WritableStreamCloseQueuedOrInFlight(stream) is false.
CHECK(!CloseQueuedOrInFlight(stream));
// 3. Let writer be stream.[[writer]].
WritableStreamDefaultWriter* writer = stream->writer_;
// 4. If writer is not undefined and backpressure is not
// stream.[[backpressure]],
if (writer && backpressure != stream->has_backpressure_) {
// a. If backpressure is true, set writer.[[readyPromise]] to a new
// promise.
if (backpressure) {
writer->ResetReadyPromise(script_state);
} else {
// b. Otherwise,
// i. Assert: backpressure is false.
DCHECK(!backpressure);
// ii. Resolve writer.[[readyPromise]] with undefined.
writer->ReadyResolver()->Resolve();
}
}
// 5. Set stream.[[backpressure]] to backpressure.
stream->has_backpressure_ = backpressure;
}
v8::Local<v8::Value> WritableStream::GetStoredError(
v8::Isolate* isolate) const {
return stored_error_.Get(isolate);
}
void WritableStream::SetCloseRequest(
ScriptPromiseResolver<IDLUndefined>* close_request) {
close_request_ = close_request;
}
void WritableStream::SetController(
WritableStreamDefaultController* controller) {
writable_stream_controller_ = controller;
}
void WritableStream::SetWriter(WritableStreamDefaultWriter* writer) {
writer_ = writer;
}
std::unique_ptr<WritableStreamTransferringOptimizer>
WritableStream::TakeTransferringOptimizer() {
return std::move(transferring_optimizer_);
}
// static
v8::Local<v8::String> WritableStream::CreateCannotActionOnStateStreamMessage(
v8::Isolate* isolate,
const char* action,
const char* state_name) {
return V8String(isolate, String::Format("Cannot %s a %s writable stream",
action, state_name));
}
// static
v8::Local<v8::Value> WritableStream::CreateCannotActionOnStateStreamException(
v8::Isolate* isolate,
const char* action,
State state) {
const char* state_name = nullptr;
switch (state) {
case WritableStream::kClosed:
state_name = "CLOSED";
break;
case WritableStream::kErrored:
state_name = "ERRORED";
break;
default:
NOTREACHED();
}
return v8::Exception::TypeError(
CreateCannotActionOnStateStreamMessage(isolate, action, state_name));
}
void WritableStream::Trace(Visitor* visitor) const {
visitor->Trace(close_request_);
visitor->Trace(in_flight_write_request_);
visitor->Trace(in_flight_close_request_);
visitor->Trace(pending_abort_request_);
visitor->Trace(stored_error_);
visitor->Trace(writable_stream_controller_);
visitor->Trace(writer_);
visitor->Trace(write_requests_);
ScriptWrappable::Trace(visitor);
}
// This is not implemented inside the constructor in C++, because calling into
// JavaScript from the constructor can cause GC problems.
void WritableStream::InitInternal(ScriptState* script_state,
ScriptValue raw_underlying_sink,
ScriptValue raw_strategy,
ExceptionState& exception_state) {
// The first parts of this constructor implementation correspond to the object
// conversions that are implicit in the definition in the standard:
// https://streams.spec.whatwg.org/#ws-constructor
DCHECK(!raw_underlying_sink.IsEmpty());
DCHECK(!raw_strategy.IsEmpty());
auto context = script_state->GetContext();
auto* isolate = script_state->GetIsolate();
v8::Local<v8::Object> underlying_sink;
ScriptValueToObject(script_state, raw_underlying_sink, &underlying_sink,
exception_state);
if (exception_state.HadException()) {
return;
}
// 2. Let size be ? GetV(strategy, "size").
// 3. Let highWaterMark be ? GetV(strategy, "highWaterMark").
StrategyUnpacker strategy_unpacker(script_state, raw_strategy,
exception_state);
if (exception_state.HadException()) {
return;
}
// 4. Let type be ? GetV(underlyingSink, "type").
TryRethrowScope rethrow_scope(isolate, exception_state);
v8::Local<v8::Value> type;
if (!underlying_sink->Get(context, V8AtomicString(isolate, "type"))
.ToLocal(&type)) {
return;
}
// 5. If type is not undefined, throw a RangeError exception.
if (!type->IsUndefined()) {
exception_state.ThrowRangeError("Invalid type is specified");
return;
}
// 6. Let sizeAlgorithm be ? MakeSizeAlgorithmFromSizeFunction(size).
auto* size_algorithm =
strategy_unpacker.MakeSizeAlgorithm(script_state, exception_state);
if (exception_state.HadException()) {
return;
}
DCHECK(size_algorithm);
// 7. If highWaterMark is undefined, let highWaterMark be 1.
// 8. Set highWaterMark to ? ValidateAndNormalizeHighWaterMark(highWaterMark).
double high_water_mark =
strategy_unpacker.GetHighWaterMark(script_state, 1, exception_state);
if (exception_state.HadException()) {
return;
}
// 9. Perform ? SetUpWritableStreamDefaultControllerFromUnderlyingSink(this,
// underlyingSink, highWaterMark, sizeAlgorithm).
WritableStreamDefaultController::SetUpFromUnderlyingSink(
script_state, this, underlying_sink, high_water_mark, size_algorithm,
exception_state);
}
bool WritableStream::HasOperationMarkedInFlight(const WritableStream* stream) {
// https://streams.spec.whatwg.org/#writable-stream-has-operation-marked-in-flight
// 1. If stream.[[inFlightWriteRequest]] is undefined and
// controller.[[inFlightCloseRequest]] is undefined, return false.
// 2. Return true.
return stream->in_flight_write_request_ || stream->in_flight_close_request_;
}
void WritableStream::RejectCloseAndClosedPromiseIfNeeded(
ScriptState* script_state,
WritableStream* stream) {
// https://streams.spec.whatwg.org/#writable-stream-reject-close-and-closed-promise-if-needed
// // 1. Assert: stream.[[state]] is "errored".
CHECK_EQ(stream->state_, kErrored);
auto* isolate = script_state->GetIsolate();
// 2. If stream.[[closeRequest]] is not undefined,
if (stream->close_request_) {
// a. Assert: stream.[[inFlightCloseRequest]] is undefined.
DCHECK(!stream->in_flight_close_request_);
// b. Reject stream.[[closeRequest]] with stream.[[storedError]].
stream->close_request_->Reject(stream->stored_error_.Get(isolate));
// c. Set stream.[[closeRequest]] to undefined.
stream->close_request_ = nullptr;
}
// 3. Let writer be stream.[[writer]].
const auto writer = stream->writer_;
// 4. If writer is not undefined,
if (writer) {
// a. Reject writer.[[closedPromise]] with stream.[[storedError]].
writer->ClosedResolver()->Reject(
ScriptValue(isolate, stream->stored_error_.Get(isolate)));
// b. Set writer.[[closedPromise]].[[PromiseIsHandled]] to true.
writer->closed(script_state).MarkAsHandled();
}
}
// TODO(ricea): Functions for transferable streams.
// Utility functions (not from the standard).
void WritableStream::RejectPromises(ScriptState* script_state,
PromiseQueue* queue,
v8::Local<v8::Value> e) {
for (auto promise : *queue) {
promise->Reject(e);
}
}
} // namespace blink
|