components/script/dom/stream/compressionstream.rs - main - githubmirror/servo

components/script/dom/stream/compressionstream.rs
328 строк12 KB
Gae24
script: Drop unsafe `ToJSValConvertible::to_jsval` and wrapper trait `SafeToJSValConvertible` (#46890)
31 июл 2026, 10:20
31 июл 2026, 10:20559e0a5
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

use std::borrow::BorrowMut;
use std::cell::RefCell;
use std::io::{self, Write};
use std::ptr;

use brotli::CompressorWriter as BrotliEncoder;
use dom_struct::dom_struct;
use flate2::Compression;
use flate2::write::{DeflateEncoder, GzEncoder, ZlibEncoder};
use js::context::JSContext;
use js::jsapi::JSObject;
use js::jsval::UndefinedValue;
use js::rust::{HandleObject as SafeHandleObject, HandleValue as SafeHandleValue};
use js::typedarray::Uint8;
use malloc_size_of::{MallocSizeOf, MallocSizeOfOps};
use script_bindings::reflector::{Reflector, reflect_dom_object_with_proto};

use crate::dom::bindings::buffer_source::{create_buffer_source, get_buffer_source_copy};
use crate::dom::bindings::codegen::Bindings::CompressionStreamBinding::{
    CompressionFormat, CompressionStreamMethods,
};
use crate::dom::bindings::codegen::UnionTypes::ArrayBufferViewOrArrayBuffer;
use crate::dom::bindings::conversions::{FromJSValConvertible, ToJSValConvertible};
use crate::dom::bindings::error::{Error, Fallible};
use crate::dom::bindings::root::{Dom, DomRoot};
use crate::dom::stream::transformstreamdefaultcontroller::TransformerType;
use crate::dom::types::{
    GlobalScope, ReadableStream, TransformStream, TransformStreamDefaultController, WritableStream,
};

pub(crate) const BROTLI_BUFFER_SIZE: usize = 4096;
const BROTLI_QUALITIY_LEVEL: u32 = 5;
const BROTLI_WINDOW_SIZE: u32 = 22;

/// <https://compression.spec.whatwg.org/#compressionstream>
#[dom_struct]
pub(crate) struct CompressionStream {
    reflector_: Reflector,

    /// <https://streams.spec.whatwg.org/#generictransformstream>
    transform: Dom<TransformStream>,

    /// <https://compression.spec.whatwg.org/#compressionstream-format>
    format: CompressionFormat,

    // <https://compression.spec.whatwg.org/#compressionstream-context>
    #[no_trace]
    context: RefCell<CompressionContext>,
}

impl CompressionStream {
    fn new_inherited(transform: &TransformStream, format: CompressionFormat) -> CompressionStream {
        CompressionStream {
            reflector_: Reflector::new(),
            transform: Dom::from_ref(transform),
            format,
            context: RefCell::new(CompressionContext::new(format)),
        }
    }

    fn new_with_proto(
        cx: &mut JSContext,
        global: &GlobalScope,
        proto: Option<SafeHandleObject>,
        transform: &TransformStream,
        format: CompressionFormat,
    ) -> DomRoot<CompressionStream> {
        reflect_dom_object_with_proto(
            cx,
            Box::new(CompressionStream::new_inherited(transform, format)),
            global,
            proto,
        )
    }
}

impl CompressionStreamMethods<crate::DomTypeHolder> for CompressionStream {
    /// <https://compression.spec.whatwg.org/#dom-compressionstream-compressionstream>
    fn Constructor(
        cx: &mut JSContext,
        global: &GlobalScope,
        proto: Option<SafeHandleObject>,
        format: CompressionFormat,
    ) -> Fallible<DomRoot<CompressionStream>> {
        // Step 1. If format is unsupported in CompressionStream, then throw a TypeError.
        // NOTE: All of "brotli", "deflate", "deflate-raw" and "gzip" are supported.

        // Step 2. Set this’s format to format.
        // Step 5. Set this’s transform to a new TransformStream.
        let transform = TransformStream::new_with_proto(cx, global, None);
        let compression_stream =
            CompressionStream::new_with_proto(cx, global, proto, &transform, format);

        // Step 3. Let transformAlgorithm be an algorithm which takes a chunk argument and runs the
        // compress and enqueue a chunk algorithm with this and chunk.
        // Step 4. Let flushAlgorithm be an algorithm which takes no argument and runs the compress
        // flush and enqueue algorithm with this.

        // Step 6. Set up this’s transform with transformAlgorithm set to transformAlgorithm and
        // flushAlgorithm set to flushAlgorithm.
        transform.set_up(
            cx,
            global,
            TransformerType::Compressor(compression_stream.as_traced()),
        )?;

        Ok(compression_stream)
    }

    /// <https://streams.spec.whatwg.org/#dom-generictransformstream-readable>
    fn Readable(&self) -> DomRoot<ReadableStream> {
        // The readable getter steps are to return this’s transform.[[readable]].
        self.transform.get_readable()
    }

    /// <https://streams.spec.whatwg.org/#dom-generictransformstream-writable>
    fn Writable(&self) -> DomRoot<WritableStream> {
        // The writable getter steps are to return this’s transform.[[writable]].
        self.transform.get_writable()
    }
}

/// <https://compression.spec.whatwg.org/#compress-and-enqueue-a-chunk>
pub(crate) fn compress_and_enqueue_a_chunk(
    cx: &mut JSContext,
    global: &GlobalScope,
    cs: &CompressionStream,
    chunk: SafeHandleValue,
    controller: &TransformStreamDefaultController,
) -> Fallible<()> {
    // Step 1. If chunk is not a BufferSource type, then throw a TypeError.
    let chunk = convert_chunk_to_vec(cx, chunk)?;

    // Step 2. Let buffer be the result of compressing chunk with cs’s format and context.
    // NOTE: In our implementation, the enum type of context already indicates the format.
    let buffer = {
        let mut compression_context = cs.context.borrow_mut();
        let buffer = compression_context
            .compress(&chunk)
            .map_err(|_| Error::Operation(Some("Failed to compress a chunk of input".into())))?;

        // Step 3. If buffer is empty, return.
        if buffer.is_empty() {
            return Ok(());
        }
        buffer
    };

    // Step 4. Let arrays be the result of splitting buffer into one or more non-empty pieces and
    // converting them into Uint8Arrays.
    // Step 5. For each Uint8Array array of arrays, enqueue array in cs’s transform.
    // NOTE: We process the result in a single Uint8Array.
    rooted!(&in(cx) let mut js_object = ptr::null_mut::<JSObject>());
    let buffer_source = create_buffer_source::<Uint8>(cx, &buffer, js_object.handle_mut())
        .map_err(|_| Error::Type(c"Cannot convert byte sequence to Uint8Array".to_owned()))?;
    rooted!(&in(cx) let mut rval = UndefinedValue());
    buffer_source.safe_to_jsval(cx, rval.handle_mut());
    controller.enqueue(cx, global, rval.handle())?;

    Ok(())
}

/// <https://compression.spec.whatwg.org/#compress-flush-and-enqueue>
pub(crate) fn compress_flush_and_enqueue(
    cx: &mut JSContext,
    global: &GlobalScope,
    cs: &CompressionStream,
    controller: &TransformStreamDefaultController,
) -> Fallible<()> {
    // Step 1. Let buffer be the result of compressing an empty input with cs’s format and context,
    // with the finish flag.
    // NOTE: In our implementation, the enum type of context already indicates the format.
    let buffer = {
        let mut compression_context = cs.context.borrow_mut();
        let buffer = compression_context.finalize().map_err(|_| {
            Error::Operation(Some("Failed to finalize the compression stream".into()))
        })?;

        // Step 2. If buffer is empty, return.
        if buffer.is_empty() {
            return Ok(());
        }
        buffer
    };

    // Step 3. Let arrays be the result of splitting buffer into one or more non-empty pieces and
    // converting them into Uint8Arrays.
    // Step 4. For each Uint8Array array of arrays, enqueue array in cs’s transform.
    // NOTE: We process the result in a single Uint8Array.
    rooted!(&in(cx) let mut js_object = ptr::null_mut::<JSObject>());
    let buffer_source = create_buffer_source::<Uint8>(cx, &buffer, js_object.handle_mut())
        .map_err(|_| Error::Type(c"Cannot convert byte sequence to Uint8Array".to_owned()))?;
    rooted!(&in(cx) let mut rval = UndefinedValue());
    buffer_source.safe_to_jsval(cx, rval.handle_mut());
    controller.enqueue(cx, global, rval.handle())?;

    Ok(())
}

/// An enum grouping encoders of differenct compression algorithms.
enum Encoder {
    Brotli(Box<BrotliEncoder<Vec<u8>>>),
    Deflate(ZlibEncoder<Vec<u8>>),
    DeflateRaw(DeflateEncoder<Vec<u8>>),
    Gzip(GzEncoder<Vec<u8>>),
}

impl MallocSizeOf for Encoder {
    #[expect(unsafe_code)]
    fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize {
        match self {
            Encoder::Brotli(encoder) => unsafe { ops.malloc_size_of(&**encoder) },
            Encoder::Deflate(encoder) => encoder.size_of(ops),
            Encoder::DeflateRaw(encoder) => encoder.size_of(ops),
            Encoder::Gzip(encoder) => encoder.size_of(ops),
        }
    }
}

/// <https://compression.spec.whatwg.org/#compressionstream-context>
/// Used to encapsulate the logic of encoder.
#[derive(MallocSizeOf)]
struct CompressionContext {
    encoder: Encoder,
}

impl CompressionContext {
    fn new(format: CompressionFormat) -> CompressionContext {
        let encoder = match format {
            CompressionFormat::Brotli => Encoder::Brotli(Box::new(BrotliEncoder::new(
                Vec::new(),
                BROTLI_BUFFER_SIZE,
                BROTLI_QUALITIY_LEVEL,
                BROTLI_WINDOW_SIZE,
            ))),
            CompressionFormat::Deflate => {
                Encoder::Deflate(ZlibEncoder::new(Vec::new(), Compression::default()))
            },
            CompressionFormat::Deflate_raw => {
                Encoder::DeflateRaw(DeflateEncoder::new(Vec::new(), Compression::default()))
            },
            CompressionFormat::Gzip => {
                Encoder::Gzip(GzEncoder::new(Vec::new(), Compression::default()))
            },
        };
        CompressionContext { encoder }
    }

    fn compress(&mut self, chunk: &[u8]) -> Result<Vec<u8>, io::Error> {
        let mut result = Vec::new();

        match &mut self.encoder {
            Encoder::Brotli(encoder) => {
                encoder.write_all(chunk)?;
                encoder.flush()?;
                result.append(encoder.get_mut());
            },
            Encoder::Deflate(encoder) => {
                encoder.write_all(chunk)?;
                encoder.flush()?;
                result.append(encoder.get_mut());
            },
            Encoder::DeflateRaw(encoder) => {
                encoder.write_all(chunk)?;
                encoder.flush()?;
                result.append(encoder.get_mut());
            },
            Encoder::Gzip(encoder) => {
                encoder.write_all(chunk)?;
                encoder.flush()?;
                result.append(encoder.get_mut());
            },
        }

        Ok(result)
    }

    fn finalize(&mut self) -> Result<Vec<u8>, io::Error> {
        let mut result = Vec::new();

        match &mut self.encoder {
            Encoder::Brotli(encoder) => {
                let encoder = std::mem::replace(
                    encoder.borrow_mut(),
                    BrotliEncoder::new(
                        Vec::new(),
                        BROTLI_BUFFER_SIZE,
                        BROTLI_QUALITIY_LEVEL,
                        BROTLI_WINDOW_SIZE,
                    ),
                );
                result = encoder.into_inner();
            },
            Encoder::Deflate(encoder) => {
                encoder.try_finish()?;
                result.append(encoder.get_mut());
            },
            Encoder::DeflateRaw(encoder) => {
                encoder.try_finish()?;
                result.append(encoder.get_mut());
            },
            Encoder::Gzip(encoder) => {
                encoder.try_finish()?;
                result.append(encoder.get_mut());
            },
        }

        Ok(result)
    }
}

pub(crate) fn convert_chunk_to_vec(
    cx: &mut JSContext,
    chunk: SafeHandleValue,
) -> Result<Vec<u8>, Error> {
    let conversion_result =
        ArrayBufferViewOrArrayBuffer::safe_from_jsval(cx, chunk, ()).map_err(|_| {
            Error::Type(c"Unable to convert chunk into ArrayBuffer or ArrayBufferView".to_owned())
        })?;
    let buffer_source = conversion_result.get_success_value().ok_or_else(|| {
        Error::Type(c"Unable to convert chunk into ArrayBuffer or ArrayBufferView".to_owned())
    })?;
    Ok(get_buffer_source_copy(buffer_source.into()))
}