/* * Copyright (c) 2023, Matthew Olsson * * SPDX-License-Identifier: BSD-2-Clause */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace Web::Streams { GC_DEFINE_ALLOCATOR(WritableStream); // https://streams.spec.whatwg.org/#ws-constructor WebIDL::ExceptionOr> WritableStream::construct_impl(JS::Realm& realm, Optional> const& underlying_sink_object, QueuingStrategy const& strategy) { auto& vm = realm.vm(); auto writable_stream = realm.create(realm); // 1. If underlyingSink is missing, set it to null. auto underlying_sink = underlying_sink_object.has_value() ? JS::Value(underlying_sink_object.value()) : JS::js_null(); // 2. Let underlyingSinkDict be underlyingSink, converted to an IDL value of type UnderlyingSink. auto underlying_sink_dict = TRY(UnderlyingSink::from_value(vm, underlying_sink)); // 3. If underlyingSinkDict["type"] exists, throw a RangeError exception. if (underlying_sink_dict.type.has_value()) return WebIDL::SimpleException { WebIDL::SimpleExceptionType::RangeError, "Invalid use of reserved key 'type'"sv }; // 4. Perform ! InitializeWritableStream(this). // Note: This AO configures slot values which are already specified in the class's field initializers. // 5. Let sizeAlgorithm be ! ExtractSizeAlgorithm(strategy). auto size_algorithm = extract_size_algorithm(vm, strategy); // 6. Let highWaterMark be ? ExtractHighWaterMark(strategy, 1). auto high_water_mark = TRY(extract_high_water_mark(strategy, 1)); // 7. Perform ? SetUpWritableStreamDefaultControllerFromUnderlyingSink(this, underlyingSink, underlyingSinkDict, highWaterMark, sizeAlgorithm). TRY(set_up_writable_stream_default_controller_from_underlying_sink(*writable_stream, underlying_sink, underlying_sink_dict, high_water_mark, size_algorithm)); return writable_stream; } WritableStream::WritableStream(JS::Realm& realm) : Bindings::PlatformObject(realm) { } void WritableStream::initialize(JS::Realm& realm) { WEB_SET_PROTOTYPE_FOR_INTERFACE(WritableStream); Base::initialize(realm); } void WritableStream::visit_edges(Cell::Visitor& visitor) { Base::visit_edges(visitor); visitor.visit(m_close_request); visitor.visit(m_controller); visitor.visit(m_in_flight_write_request); visitor.visit(m_in_flight_close_request); if (m_pending_abort_request.has_value()) { visitor.visit(m_pending_abort_request->promise); visitor.visit(m_pending_abort_request->reason); } visitor.visit(m_stored_error); visitor.visit(m_writer); for (auto& write_request : m_write_requests) visitor.visit(write_request); } // https://streams.spec.whatwg.org/#ws-locked bool WritableStream::locked() const { // 1. Return ! IsWritableStreamLocked(this). return is_writable_stream_locked(*this); } // https://streams.spec.whatwg.org/#ws-close GC::Ref WritableStream::close() { auto& realm = this->realm(); // 1. If ! IsWritableStreamLocked(this) is true, return a promise rejected with a TypeError exception. if (is_writable_stream_locked(*this)) { auto exception = JS::TypeError::create(realm, "Cannot close a locked stream"sv); return WebIDL::create_rejected_promise(realm, exception); } // 2. If ! WritableStreamCloseQueuedOrInFlight(this) is true, return a promise rejected with a TypeError exception. if (writable_stream_close_queued_or_in_flight(*this)) { auto exception = JS::TypeError::create(realm, "Cannot close a stream that is already closed or errored"sv); return WebIDL::create_rejected_promise(realm, exception); } // 3. Return ! WritableStreamClose(this). return writable_stream_close(*this); } // https://streams.spec.whatwg.org/#ws-abort GC::Ref WritableStream::abort(JS::Value reason) { auto& realm = this->realm(); // 1. If ! IsWritableStreamLocked(this) is true, return a promise rejected with a TypeError exception. if (is_writable_stream_locked(*this)) { auto exception = JS::TypeError::create(realm, "Cannot abort a locked stream"sv); return WebIDL::create_rejected_promise(realm, exception); } // 2. Return ! WritableStreamAbort(this, reason). return writable_stream_abort(*this, reason); } // https://streams.spec.whatwg.org/#ws-get-writer WebIDL::ExceptionOr> WritableStream::get_writer() { // 1. Return ? AcquireWritableStreamDefaultWriter(this). return acquire_writable_stream_default_writer(*this); } // https://streams.spec.whatwg.org/#ref-for-transfer-steps① WebIDL::ExceptionOr WritableStream::transfer_steps(HTML::TransferDataHolder& data_holder) { auto& realm = this->realm(); auto& vm = realm.vm(); HTML::TemporaryExecutionContext execution_context { realm, HTML::TemporaryExecutionContext::CallbacksEnabled::Yes }; // 1. If ! IsWritableStreamLocked(value) is true, throw a "DataCloneError" DOMException. if (is_writable_stream_locked(*this)) return WebIDL::DataCloneError::create(realm, "Cannot transfer locked WritableStream"_string); // 2. Let port1 be a new MessagePort in the current Realm. auto port1 = HTML::MessagePort::create(realm); // 3. Let port2 be a new MessagePort in the current Realm. auto port2 = HTML::MessagePort::create(realm, HTML::TransferType::WritableStream); // 4. Entangle port1 and port2. port1->entangle_with(port2); // 5. Let readable be a new ReadableStream in the current Realm. auto readable = realm.create(realm); // 6. Perform ! SetUpCrossRealmTransformReadable(readable, port1). set_up_cross_realm_transform_readable(realm, readable, port1); // 7. Let promise be ! ReadableStreamPipeTo(readable, value, false, false, false). auto promise = readable_stream_pipe_to(readable, *this, false, false, false); // 8. Set promise.[[PromiseIsHandled]] to true. WebIDL::mark_promise_as_handled(promise); // 9. Set dataHolder.[[port]] to ! StructuredSerializeWithTransfer(port2, « port2 »). auto result = MUST(HTML::structured_serialize_with_transfer(vm, port2, { { GC::Root { port2 } } })); data_holder = move(result.transfer_data_holders.first()); return {}; } // https://streams.spec.whatwg.org/#ref-for-transfer-receiving-steps① WebIDL::ExceptionOr WritableStream::transfer_receiving_steps(HTML::TransferDataHolder& data_holder) { auto& realm = this->realm(); HTML::TemporaryExecutionContext execution_context { realm, HTML::TemporaryExecutionContext::CallbacksEnabled::Yes }; // 1. Let deserializedRecord be ! StructuredDeserializeWithTransfer(dataHolder.[[port]], the current Realm). // 2. Let port be deserializedRecord.[[Deserialized]]. auto port = HTML::MessagePort::create(realm); TRY(port->transfer_receiving_steps(data_holder)); // 3. Perform ! SetUpCrossRealmTransformWritable(value, port). set_up_cross_realm_transform_writable(realm, *this, port); return {}; } }