From 5bcba896c2da509d3401d4e08a2e51026b011c77 Mon Sep 17 00:00:00 2001 From: Timothy Flynn Date: Fri, 15 Nov 2024 14:40:04 -0500 Subject: [PATCH] LibWeb: Implement the DecompressionStream interface --- Libraries/LibWeb/CMakeLists.txt | 1 + .../Compression/DecompressionStream.cpp | 177 ++++++++++++++++++ .../LibWeb/Compression/DecompressionStream.h | 53 ++++++ .../Compression/DecompressionStream.idl | 10 + Libraries/LibWeb/Forward.h | 1 + Libraries/LibWeb/idl_files.cmake | 1 + .../Compression/DecompressionStream.txt | 2 + .../Text/expected/all-window-properties.txt | 1 + .../Compression/DecompressionStream.html | 37 ++++ 9 files changed, 283 insertions(+) create mode 100644 Libraries/LibWeb/Compression/DecompressionStream.cpp create mode 100644 Libraries/LibWeb/Compression/DecompressionStream.h create mode 100644 Libraries/LibWeb/Compression/DecompressionStream.idl create mode 100644 Tests/LibWeb/Text/expected/Compression/DecompressionStream.txt create mode 100644 Tests/LibWeb/Text/input/Compression/DecompressionStream.html diff --git a/Libraries/LibWeb/CMakeLists.txt b/Libraries/LibWeb/CMakeLists.txt index 4363f0782ed..ee997d93d03 100644 --- a/Libraries/LibWeb/CMakeLists.txt +++ b/Libraries/LibWeb/CMakeLists.txt @@ -29,6 +29,7 @@ set(SOURCES Clipboard/Clipboard.cpp Clipboard/ClipboardEvent.cpp Compression/CompressionStream.cpp + Compression/DecompressionStream.cpp Crypto/Crypto.cpp Crypto/CryptoAlgorithms.cpp Crypto/CryptoBindings.cpp diff --git a/Libraries/LibWeb/Compression/DecompressionStream.cpp b/Libraries/LibWeb/Compression/DecompressionStream.cpp new file mode 100644 index 00000000000..64169442cee --- /dev/null +++ b/Libraries/LibWeb/Compression/DecompressionStream.cpp @@ -0,0 +1,177 @@ +/* + * Copyright (c) 2024, Tim Flynn + * + * SPDX-License-Identifier: BSD-2-Clause + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +namespace Web::Compression { + +GC_DEFINE_ALLOCATOR(DecompressionStream); + +// https://compression.spec.whatwg.org/#dom-decompressionstream-decompressionstream +WebIDL::ExceptionOr> DecompressionStream::construct_impl(JS::Realm& realm, Bindings::CompressionFormat format) +{ + // 1. If format is unsupported in DecompressionStream, then throw a TypeError. + // 2. Set this's format to format. + auto input_stream = make(); + + auto decompressor = [&, input_stream = MaybeOwned { *input_stream }]() mutable -> ErrorOr { + switch (format) { + case Bindings::CompressionFormat::Deflate: + // FIXME: Our zlib decompressor assumes the initial data contains the zlib header. We don't have any data yet, + // so this will always fail. + return TRY(Compress::ZlibDecompressor::create(move(input_stream))); + case Bindings::CompressionFormat::DeflateRaw: + return TRY(Compress::DeflateDecompressor::construct(make(move(input_stream)))); + case Bindings::CompressionFormat::Gzip: + return make(move(input_stream)); + } + + VERIFY_NOT_REACHED(); + }(); + + if (decompressor.is_error()) + return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, MUST(String::formatted("Unable to create decompressor: {}", decompressor.error())) }; + + // 5. Set this's transform to a new TransformStream. + // NOTE: We do this first so that we may store it as nonnull in the GenericTransformStream. + auto stream = realm.create(realm, realm.create(realm), decompressor.release_value(), move(input_stream)); + + // 3. Let transformAlgorithm be an algorithm which takes a chunk argument and runs the decompress and enqueue a chunk + // algorithm with this and chunk. + auto transform_algorithm = GC::create_function(realm.heap(), [stream](JS::Value chunk) -> GC::Ref { + auto& realm = stream->realm(); + auto& vm = realm.vm(); + + if (auto result = stream->decompress_and_enqueue_chunk(chunk); result.is_error()) { + auto throw_completion = Bindings::dom_exception_to_throw_completion(vm, result.exception()); + return WebIDL::create_rejected_promise(realm, *throw_completion.release_value()); + } + + return WebIDL::create_resolved_promise(realm, JS::js_undefined()); + }); + + // 4. Let flushAlgorithm be an algorithm which takes no argument and runs the decompress flush and enqueue algorithm with this. + auto flush_algorithm = GC::create_function(realm.heap(), [stream]() -> GC::Ref { + auto& realm = stream->realm(); + auto& vm = realm.vm(); + + if (auto result = stream->decompress_flush_and_enqueue(); result.is_error()) { + auto throw_completion = Bindings::dom_exception_to_throw_completion(vm, result.exception()); + return WebIDL::create_rejected_promise(realm, *throw_completion.release_value()); + } + + return WebIDL::create_resolved_promise(realm, JS::js_undefined()); + }); + + // 6. Set up this's transform with transformAlgorithm set to transformAlgorithm and flushAlgorithm set to flushAlgorithm. + Streams::transform_stream_set_up(stream->m_transform, transform_algorithm, flush_algorithm); + + return stream; +} + +DecompressionStream::DecompressionStream(JS::Realm& realm, GC::Ref transform, Decompressor decompressor, NonnullOwnPtr input_stream) + : Bindings::PlatformObject(realm) + , Streams::GenericTransformStreamMixin(transform) + , m_decompressor(move(decompressor)) + , m_input_stream(move(input_stream)) +{ +} + +DecompressionStream::~DecompressionStream() = default; + +void DecompressionStream::initialize(JS::Realm& realm) +{ + Base::initialize(realm); + WEB_SET_PROTOTYPE_FOR_INTERFACE(DecompressionStream); +} + +void DecompressionStream::visit_edges(JS::Cell::Visitor& visitor) +{ + Base::visit_edges(visitor); + Streams::GenericTransformStreamMixin::visit_edges(visitor); +} + +// https://compression.spec.whatwg.org/#decompress-and-enqueue-a-chunk +WebIDL::ExceptionOr DecompressionStream::decompress_and_enqueue_chunk(JS::Value chunk) +{ + auto& realm = this->realm(); + + // 1. If chunk is not a BufferSource type, then throw a TypeError. + if (!WebIDL::is_buffer_source_type(chunk)) + return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, "Chunk is not a BufferSource type"sv }; + + // 2. Let buffer be the result of decompressing chunk with ds's format and context. If this results in an error, + // then throw a TypeError. + auto buffer = [&]() -> ErrorOr { + if (auto buffer = WebIDL::underlying_buffer_source(chunk.as_object())) + return decompress(buffer->buffer()); + return ByteBuffer {}; + }(); + + if (buffer.is_error()) + return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, MUST(String::formatted("Unable to decompress chunk: {}", buffer.error())) }; + + // 3. If buffer is empty, return. + if (buffer.value().is_empty()) + return {}; + + // 4. Split buffer into one or more non-empty pieces and convert them into Uint8Arrays. + auto array_buffer = JS::ArrayBuffer::create(realm, buffer.release_value()); + auto array = JS::Uint8Array::create(realm, array_buffer->byte_length(), *array_buffer); + + // 5. For each Uint8Array array, enqueue array in ds's transform. + TRY(Streams::transform_stream_default_controller_enqueue(*m_transform->controller(), array)); + return {}; +} + +// https://compression.spec.whatwg.org/#decompress-flush-and-enqueue +WebIDL::ExceptionOr DecompressionStream::decompress_flush_and_enqueue() +{ + auto& realm = this->realm(); + + // 1. Let buffer be the result of decompressing an empty input with ds's format and context, with the finish flag. + auto buffer = decompress({}); + + if (buffer.is_error()) + return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, MUST(String::formatted("Unable to compress flush: {}", buffer.error())) }; + + // FIXME: 2. If the end of the compressed input has not been reached, then throw a TypeError. + + // 3. If buffer is empty, return. + if (buffer.value().is_empty()) + return {}; + + // 4. Split buffer into one or more non-empty pieces and convert them into Uint8Arrays. + auto array_buffer = JS::ArrayBuffer::create(realm, buffer.release_value()); + auto array = JS::Uint8Array::create(realm, array_buffer->byte_length(), *array_buffer); + + // 5. For each Uint8Array array, enqueue array in ds's transform. + TRY(Streams::transform_stream_default_controller_enqueue(*m_transform->controller(), array)); + return {}; +} + +ErrorOr DecompressionStream::decompress(ReadonlyBytes bytes) +{ + TRY(m_input_stream->write_until_depleted(bytes)); + + return TRY(m_decompressor.visit([&](auto const& decompressor) { + return decompressor->read_until_eof(); + })); +} + +} diff --git a/Libraries/LibWeb/Compression/DecompressionStream.h b/Libraries/LibWeb/Compression/DecompressionStream.h new file mode 100644 index 00000000000..88ec91ae723 --- /dev/null +++ b/Libraries/LibWeb/Compression/DecompressionStream.h @@ -0,0 +1,53 @@ +/* + * Copyright (c) 2024, Tim Flynn + * + * SPDX-License-Identifier: BSD-2-Clause + */ + +#pragma once + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +namespace Web::Compression { + +using Decompressor = Variant< + NonnullOwnPtr, + NonnullOwnPtr, + NonnullOwnPtr>; + +// https://compression.spec.whatwg.org/#decompressionstream +class DecompressionStream final + : public Bindings::PlatformObject + , public Streams::GenericTransformStreamMixin { + WEB_PLATFORM_OBJECT(DecompressionStream, Bindings::PlatformObject); + GC_DECLARE_ALLOCATOR(DecompressionStream); + +public: + static WebIDL::ExceptionOr> construct_impl(JS::Realm&, Bindings::CompressionFormat); + virtual ~DecompressionStream() override; + +private: + DecompressionStream(JS::Realm&, GC::Ref, Decompressor, NonnullOwnPtr); + + virtual void initialize(JS::Realm&) override; + virtual void visit_edges(Cell::Visitor&) override; + + WebIDL::ExceptionOr decompress_and_enqueue_chunk(JS::Value); + WebIDL::ExceptionOr decompress_flush_and_enqueue(); + + ErrorOr decompress(ReadonlyBytes); + + Decompressor m_decompressor; + NonnullOwnPtr m_input_stream; +}; + +} diff --git a/Libraries/LibWeb/Compression/DecompressionStream.idl b/Libraries/LibWeb/Compression/DecompressionStream.idl new file mode 100644 index 00000000000..3e4fad33b25 --- /dev/null +++ b/Libraries/LibWeb/Compression/DecompressionStream.idl @@ -0,0 +1,10 @@ +#import +#import + +// https://compression.spec.whatwg.org/#decompressionstream +[Exposed=*] +interface DecompressionStream { + constructor(CompressionFormat format); +}; + +DecompressionStream includes GenericTransformStream; diff --git a/Libraries/LibWeb/Forward.h b/Libraries/LibWeb/Forward.h index c5ff5cd60aa..512a518f9ce 100644 --- a/Libraries/LibWeb/Forward.h +++ b/Libraries/LibWeb/Forward.h @@ -88,6 +88,7 @@ class Clipboard; namespace Web::Compression { class CompressionStream; +class DecompressionStream; } namespace Web::Cookie { diff --git a/Libraries/LibWeb/idl_files.cmake b/Libraries/LibWeb/idl_files.cmake index 9cd63ad15ce..ff569332c56 100644 --- a/Libraries/LibWeb/idl_files.cmake +++ b/Libraries/LibWeb/idl_files.cmake @@ -10,6 +10,7 @@ libweb_js_bindings(Animations/KeyframeEffect) libweb_js_bindings(Clipboard/Clipboard) libweb_js_bindings(Clipboard/ClipboardEvent) libweb_js_bindings(Compression/CompressionStream) +libweb_js_bindings(Compression/DecompressionStream) libweb_js_bindings(Crypto/Crypto) libweb_js_bindings(Crypto/CryptoKey) libweb_js_bindings(Crypto/SubtleCrypto) diff --git a/Tests/LibWeb/Text/expected/Compression/DecompressionStream.txt b/Tests/LibWeb/Text/expected/Compression/DecompressionStream.txt new file mode 100644 index 00000000000..c6c19723d88 --- /dev/null +++ b/Tests/LibWeb/Text/expected/Compression/DecompressionStream.txt @@ -0,0 +1,2 @@ +format=deflate-raw: Well hello friends! +format=gzip: Well hello friends! diff --git a/Tests/LibWeb/Text/expected/all-window-properties.txt b/Tests/LibWeb/Text/expected/all-window-properties.txt index 5d98e0cd027..c14b2d34e64 100644 --- a/Tests/LibWeb/Text/expected/all-window-properties.txt +++ b/Tests/LibWeb/Text/expected/all-window-properties.txt @@ -88,6 +88,7 @@ DataTransferItem DataTransferItemList DataView Date +DecompressionStream DisposableStack Document DocumentFragment diff --git a/Tests/LibWeb/Text/input/Compression/DecompressionStream.html b/Tests/LibWeb/Text/input/Compression/DecompressionStream.html new file mode 100644 index 00000000000..fa01e15842c --- /dev/null +++ b/Tests/LibWeb/Text/input/Compression/DecompressionStream.html @@ -0,0 +1,37 @@ + +