mirrors/serenity
1
0
Fork 0
mirror of https://github.com/SerenityOS/serenity.git synced 2025-01-22 17:31:58 -05:00
Code Issues Projects Releases Packages Wiki Activity

LibWeb: Implement and wire up TransformStream's cancel callback

Browse source 
(cherry picked from commit e70886595ab83d650662f46be2ac2e147603c790)
This commit is contained in:
Kenneth Myhra 2024-06-02 22:54:12 +02:00 committed by Nico Weber
parent 8f8d577b52
commit 702ff7eb46
8 changed files with 80 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
Tests/LibWeb/Text/expected/Streams/TransformStream-cancelled-by-readable-side.txt Normal file
View file

@ -0,0 +1 @@
TransformStream cancelled due to: cancel called by the readable side.

1
Tests/LibWeb/Text/expected/Streams/TransformStream-cancelled-by-writable-side.txt Normal file
View file

@ -0,0 +1 @@
TransformStream cancelled due to: abort called by the writable side.

16
Tests/LibWeb/Text/input/Streams/TransformStream-cancelled-by-readable-side.html Normal file
View file

@ -0,0 +1,16 @@
<script src="../include.js"></script>
<script>
function testTransformStreamReadableStreamCancellation() {
const transformStream = new TransformStream({
cancel(reason) {
println(`TransformStream cancelled due to: ${reason}`);
return Promise.resolve();
}
});
transformStream.readable.cancel('cancel called by the readable side.');
}
test(() => {
testTransformStreamReadableStreamCancellation();
});
</script>

16
Tests/LibWeb/Text/input/Streams/TransformStream-cancelled-by-writable-side.html Normal file
View file

@ -0,0 +1,16 @@
<script src="../include.js"></script>
<script>
function testTransformStreamReadableStreamCancellation() {
const transformStream = new TransformStream({
cancel(reason) {
println(`TransformStream cancelled due to: ${reason}`);
return Promise.resolve();
}
});
transformStream.writable.abort('abort called by the writable side.');
}
test(() => {
testTransformStreamReadableStreamCancellation();
});
</script>

50
Userland/Libraries/LibWeb/Streams/AbstractOperations.cpp
View file

@ -4761,7 +4761,7 @@ void initialize_transform_stream(TransformStream& stream, JS::NonnullGCPtr<JS::P
}
// https://streams.spec.whatwg.org/#set-up-transform-stream-default-controller
void set_up_transform_stream_default_controller(TransformStream& stream, TransformStreamDefaultController& controller, JS::NonnullGCPtr<TransformAlgorithm> transform_algorithm, JS::NonnullGCPtr<FlushAlgorithm> flush_algorithm)
void set_up_transform_stream_default_controller(TransformStream& stream, TransformStreamDefaultController& controller, JS::NonnullGCPtr<TransformAlgorithm> transform_algorithm, JS::NonnullGCPtr<FlushAlgorithm> flush_algorithm, JS::NonnullGCPtr<CancelAlgorithm> cancel_algorithm)
{
// 1. Assert: stream implements TransformStream.
// 2. Assert: stream.[[controller]] is undefined.
@ -4778,6 +4778,9 @@ void set_up_transform_stream_default_controller(TransformStream& stream, Transfo
// 6. Set controller.[[flushAlgorithm]] to flushAlgorithm.
controller.set_flush_algorithm(flush_algorithm);
// 7. Set controller.[[cancelAlgorithm]] to cancelAlgorithm.
controller.set_cancel_algorithm(cancel_algorithm);
}
// https://streams.spec.whatwg.org/#set-up-transform-stream-default-controller-from-transformer
@ -4809,7 +4812,12 @@ void set_up_transform_stream_default_controller_from_transformer(TransformStream
return WebIDL::create_resolved_promise(realm, JS::js_undefined());
});
// 4. If transformerDict["transform"] exists, set transformAlgorithm to an algorithm which takes an argument chunk
// 4. Let cancelAlgorithm be an algorithm which returns a promise resolved with undefined.
auto cancel_algorithm = JS::create_heap_function(realm.heap(), [&realm](JS::Value) {
return WebIDL::create_resolved_promise(realm, JS::js_undefined());
});
// 5. If transformerDict["transform"] exists, set transformAlgorithm to an algorithm which takes an argument chunk
// and returns the result of invoking transformerDict["transform"] with argument list « chunk, controller » and
// callback this value transformer.
if (transformer_dict.transform) {
@ -4820,7 +4828,7 @@ void set_up_transform_stream_default_controller_from_transformer(TransformStream
});
}
// 5. If transformerDict["flush"] exists, set flushAlgorithm to an algorithm which returns the result of invoking
// 6. If transformerDict["flush"] exists, set flushAlgorithm to an algorithm which returns the result of invoking
// transformerDict["flush"] with argument list « controller » and callback this value transformer.
if (transformer_dict.flush) {
flush_algorithm = JS::create_heap_function(realm.heap(), [&realm, transformer, callback = transformer_dict.flush, controller]() {
@ -4830,8 +4838,18 @@ void set_up_transform_stream_default_controller_from_transformer(TransformStream
});
}
// 6. Perform ! SetUpTransformStreamDefaultController(stream, controller, transformAlgorithm, flushAlgorithm).
set_up_transform_stream_default_controller(stream, *controller, transform_algorithm, flush_algorithm);
// 7. If transformerDict["cancel"] exists, set cancelAlgorithm to an algorithm which takes an argument reason and returns
// the result of invoking transformerDict["cancel"] with argument list « reason » and callback this value transformer.
if (transformer_dict.cancel) {
cancel_algorithm = JS::create_heap_function(realm.heap(), [&realm, transformer, callback = transformer_dict.cancel](JS::Value reason) {
// Note: callback returns a promise, so invoke_callback will never return an abrupt completion
auto result = MUST(WebIDL::invoke_callback(*callback, transformer, reason)).release_value();
return WebIDL::create_resolved_promise(realm, result);
});
}
// 8. Perform ! SetUpTransformStreamDefaultController(stream, controller, transformAlgorithm, flushAlgorithm).
set_up_transform_stream_default_controller(stream, *controller, transform_algorithm, flush_algorithm, cancel_algorithm);
}
// https://streams.spec.whatwg.org/#transform-stream-default-controller-clear-algorithms
@ -4843,6 +4861,9 @@ void transform_stream_default_controller_clear_algorithms(TransformStreamDefault
// 2. Set controller.[[flushAlgorithm]] to undefined.
controller.set_flush_algorithm({});
// 3. Set controller.[[cancelAlgorithm]] to undefined.
controller.set_cancel_algorithm({});
}
// https://streams.spec.whatwg.org/#transform-stream-default-controller-enqueue
@ -5215,7 +5236,7 @@ void transform_stream_set_backpressure(TransformStream& stream, bool backpressur
}
// https://streams.spec.whatwg.org/#transformstream-set-up
void transform_stream_set_up(TransformStream& stream, JS::NonnullGCPtr<TransformAlgorithm> transform_algorithm, JS::GCPtr<FlushAlgorithm> flush_algorithm, JS::GCPtr<CancelAlgorithm>)
void transform_stream_set_up(TransformStream& stream, JS::NonnullGCPtr<TransformAlgorithm> transform_algorithm, JS::GCPtr<FlushAlgorithm> flush_algorithm, JS::GCPtr<CancelAlgorithm> cancel_algorithm)
{
auto& realm = stream.realm();
@ -5264,7 +5285,20 @@ void transform_stream_set_up(TransformStream& stream, JS::NonnullGCPtr<Transform
return WebIDL::create_resolved_promise(realm, JS::js_undefined());
});
// FIXME 7. Let cancelAlgorithmWrapper be an algorithm that runs these steps given a value reason:
// 7. Let cancelAlgorithmWrapper be an algorithm that runs these steps given a value reason:
auto cancel_algorithm_wrapper = JS::create_heap_function(realm.heap(), [&realm, cancel_algorithm](JS::Value reason) -> JS::NonnullGCPtr<WebIDL::Promise> {
// 1. Let result be the result of running cancelAlgorithm given reason, if cancelAlgorithm was given, or null otherwise. If this throws an exception e, return a promise rejected with e.
JS::GCPtr<JS::PromiseCapability> result = nullptr;
if (cancel_algorithm)
result = cancel_algorithm->function()(reason);
// 2. If result is a Promise, then return result.
if (result)
return JS::NonnullGCPtr { *result };
// 3. Return a promise resolved with undefined.
return WebIDL::create_resolved_promise(realm, JS::js_undefined());
});
// 8. Let startPromise be a promise resolved with undefined.
auto start_promise = WebIDL::create_resolved_promise(realm, JS::js_undefined());
@ -5276,7 +5310,7 @@ void transform_stream_set_up(TransformStream& stream, JS::NonnullGCPtr<Transform
auto controller = realm.heap().allocate<TransformStreamDefaultController>(realm, realm);
// 11. Perform ! SetUpTransformStreamDefaultController(stream, controller, transformAlgorithmWrapper, flushAlgorithmWrapper, cancelAlgorithmWrapper).
set_up_transform_stream_default_controller(stream, controller, transform_algorithm_wrapper, flush_algorithm_wrapper);
set_up_transform_stream_default_controller(stream, controller, transform_algorithm_wrapper, flush_algorithm_wrapper, cancel_algorithm_wrapper);
}
// https://streams.spec.whatwg.org/#transform-stream-unblock-write

2
Userland/Libraries/LibWeb/Streams/AbstractOperations.h
View file

@ -168,7 +168,7 @@ void writable_stream_default_controller_process_write(WritableStreamDefaultContr
void writable_stream_default_controller_write(WritableStreamDefaultController&, JS::Value chunk, JS::Value chunk_size);
void initialize_transform_stream(TransformStream&, 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);
void set_up_transform_stream_default_controller(TransformStream&, TransformStreamDefaultController&, JS::NonnullGCPtr<TransformAlgorithm>, JS::NonnullGCPtr<FlushAlgorithm>);
void set_up_transform_stream_default_controller(TransformStream&, TransformStreamDefaultController&, JS::NonnullGCPtr<TransformAlgorithm>, JS::NonnullGCPtr<FlushAlgorithm>, JS::NonnullGCPtr<CancelAlgorithm>);
void set_up_transform_stream_default_controller_from_transformer(TransformStream&, JS::Value transformer, Transformer&);
void transform_stream_default_controller_clear_algorithms(TransformStreamDefaultController&);
WebIDL::ExceptionOr<void> transform_stream_default_controller_enqueue(TransformStreamDefaultController&, JS::Value chunk);

1
Userland/Libraries/LibWeb/Streams/Transformer.cpp
View file

@ -22,6 +22,7 @@ JS::ThrowCompletionOr<Transformer> Transformer::from_value(JS::VM& vm, JS::Value
.start = TRY(property_to_callback(vm, value, "start", WebIDL::OperationReturnsPromise::No)),
.transform = TRY(property_to_callback(vm, value, "transform", WebIDL::OperationReturnsPromise::Yes)),
.flush = TRY(property_to_callback(vm, value, "flush", WebIDL::OperationReturnsPromise::Yes)),
.cancel = TRY(property_to_callback(vm, value, "cancel", WebIDL::OperationReturnsPromise::Yes)),
.readable_type = {},
.writable_type = {},
};

2
Userland/Libraries/LibWeb/Streams/Transformer.h
View file

@ -20,6 +20,8 @@ struct Transformer {
JS::Handle<WebIDL::CallbackType> transform;
// https://streams.spec.whatwg.org/#dom-transformer-flush
JS::Handle<WebIDL::CallbackType> flush;
// https://streams.spec.whatwg.org/#dom-transformer-cancel
JS::Handle<WebIDL::CallbackType> cancel;
// https://streams.spec.whatwg.org/#dom-transformer-readabletype
Optional<JS::Value> readable_type;