Skip to content

Deduplicate webcore blob, sink, and S3 helpers #32024

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alii wants to merge 6 commits into
base: claude/split/jsc-runtime
Choose a base branch
from
Open

Deduplicate webcore blob, sink, and S3 helpers #32024

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2552851
Consolidate webcore blob/sink/S3 helpers
alii Jun 8, 2026
645fe0e
Add characterization tests for consolidated webcore helpers
robobun Jun 9, 2026
2c0bf18
Document fallback_read_write instead of carrying the hoisted marker c…
robobun Jun 9, 2026
bc361d6
Move S3 argument validation tests to their own file
robobun Jun 9, 2026
6a0aa4a
Merge branch 'claude/split/jsc-runtime' into claude/split/webcore
robobun Jun 10, 2026
d473d99
ci: retrigger
robobun Jun 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 2 additions & 24 deletions src/runtime/webcore/ArrayBufferSink.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,9 +260,8 @@ impl crate::webcore::sink::JsSinkType for ArrayBufferSink {
const HAS_FLUSH_FROM_JS: bool = true;
const START_TAG: Option<streams::StartTag> = Some(streams::StartTag::ArrayBufferSink);

fn memory_cost(&self) -> usize {
Self::memory_cost(self)
}
crate::impl_js_sink_forwarders!();

fn finalize(&mut self) {
// The `JSSink::finalize` C export owns destroying the heap
// allocation; the trait impl here is the *inner* finalize.
Expand All @@ -271,18 +270,6 @@ impl crate::webcore::sink::JsSinkType for ArrayBufferSink {
fn construct(this: &mut core::mem::MaybeUninit<Self>) {
Self::construct(this);
}
fn write_bytes(&mut self, data: &streams::Result) -> streams::result::Writable {
Self::write(self, data)
}
fn write_utf16(&mut self, data: &streams::Result) -> streams::result::Writable {
Self::write_utf16(self, data)
}
fn write_latin1(&mut self, data: &streams::Result) -> streams::result::Writable {
Self::write_latin1(self, data)
}
fn end(&mut self, err: Option<syscall::Error>) -> bun_sys::Result<()> {
Self::end(self, err)
}
fn end_from_js(&mut self, global: &JSGlobalObject) -> bun_sys::Result<JSValue> {
match Self::end_from_js(self, global) {
bun_sys::Result::Ok(ab) => bun_sys::Result::Ok(match ab.to_js_unchecked(global) {
Expand All @@ -292,15 +279,6 @@ impl crate::webcore::sink::JsSinkType for ArrayBufferSink {
bun_sys::Result::Err(e) => bun_sys::Result::Err(e),
}
}
fn flush(&mut self) -> bun_sys::Result<()> {
Self::flush(self)
}
fn flush_from_js(&mut self, global: &JSGlobalObject, wait: bool) -> bun_sys::Result<JSValue> {
Self::flush_from_js(self, global, wait)
}
fn start(&mut self, config: streams::Start) -> bun_sys::Result<()> {
Self::start(self, &config)
}
fn signal(&mut self) -> Option<&mut Signal> {
Some(&mut self.signal)
}
Expand Down
230 changes: 124 additions & 106 deletions src/runtime/webcore/Blob.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1337,31 +1337,7 @@ impl BlobExt for Blob {
}
if let Some(content_type) = options_object.get_truthy(global_this, "type")? {
// override the content type
if !content_type.is_string() {
return Err(global_this.throw_invalid_argument_type(
"write",
"options.type",
"string",
));
}
let content_type_str = content_type.to_slice(global_this)?;
let slice = content_type_str.slice();
if is_valid_blob_type(slice) {
self.free_content_type();
self.content_type_was_set.set(true);

// SAFETY: bun_vm() never returns null for a Bun-owned global.
if let Some(mime) = global_this.bun_vm().as_mut().mime_type(slice) {
self.content_type
.set(std::ptr::from_ref::<[u8]>(mime.value.as_ref()));
} else {
let mut buf = vec![0u8; slice.len()];
strings::copy_lowercase(slice, &mut buf);
self.content_type
.set(bun_core::heap::into_raw(buf.into_boxed_slice()));
self.content_type_allocated.set(true);
}
}
set_content_type_from_js(global_this, self, content_type)?;
}
} else if !options_object.is_empty_or_undefined_or_null() {
return Err(global_this.throw_invalid_argument_type("write", "options", "object"));
Expand Down Expand Up @@ -1767,30 +1743,7 @@ impl BlobExt for Blob {
let options = arg0;
if let Some(content_type) = options.get_truthy(global_this, "type")? {
// override the content type
if !content_type.is_string() {
return Err(global_this.throw_invalid_argument_type(
"write",
"options.type",
"string",
));
}
let content_type_str = content_type.to_slice(global_this)?;
let slice = content_type_str.slice();
if is_valid_blob_type(slice) {
self.free_content_type();
self.content_type_was_set.set(true);
// SAFETY: see other `mime_type` call sites.
if let Some(mime) = global_this.bun_vm().as_mut().mime_type(slice) {
self.content_type
.set(std::ptr::from_ref::<[u8]>(mime.value.as_ref()));
} else {
let mut buf = vec![0u8; slice.len()];
strings::copy_lowercase(slice, &mut buf);
self.content_type
.set(bun_core::heap::into_raw(buf.into_boxed_slice()));
self.content_type_allocated.set(true);
}
}
set_content_type_from_js(global_this, self, content_type)?;
}

let content_disposition_str: Option<ZigStringSlice> =
Expand Down Expand Up @@ -3372,20 +3325,7 @@ impl BlobExt for Blob {
}
}

jsc::JSType::ArrayBuffer
| jsc::JSType::Int8Array
| jsc::JSType::Uint8Array
| jsc::JSType::Uint8ClampedArray
| jsc::JSType::Int16Array
| jsc::JSType::Uint16Array
| jsc::JSType::Int32Array
| jsc::JSType::Uint32Array
| jsc::JSType::Float16Array
| jsc::JSType::Float32Array
| jsc::JSType::Float64Array
| jsc::JSType::BigInt64Array
| jsc::JSType::BigUint64Array
| jsc::JSType::DataView => {
t if t.is_array_buffer_like() => {
return Blob::try_create(
top_value.as_array_buffer(global).unwrap().byte_slice(),
global,
Expand Down Expand Up @@ -3520,21 +3460,8 @@ impl BlobExt for Blob {
continue;
}
match item.js_type_loose() {
jsc::JSType::String
| jsc::JSType::ArrayBuffer
| jsc::JSType::Int8Array
| jsc::JSType::Uint8Array
| jsc::JSType::Uint8ClampedArray
| jsc::JSType::Int16Array
| jsc::JSType::Uint16Array
| jsc::JSType::Int32Array
| jsc::JSType::Uint32Array
| jsc::JSType::Float16Array
| jsc::JSType::Float32Array
| jsc::JSType::Float64Array
| jsc::JSType::BigInt64Array
| jsc::JSType::BigUint64Array
| jsc::JSType::DataView => {}
jsc::JSType::String => {}
t if t.is_array_buffer_like() => {}
jsc::JSType::DOMWrapper
if item.as_class_ref::<Blob>().is_some() => {}
_ => {
Expand Down Expand Up @@ -3563,20 +3490,7 @@ impl BlobExt for Blob {
joiner.push_cloned(sliced.slice());
continue;
}
jsc::JSType::ArrayBuffer
| jsc::JSType::Int8Array
| jsc::JSType::Uint8Array
| jsc::JSType::Uint8ClampedArray
| jsc::JSType::Int16Array
| jsc::JSType::Uint16Array
| jsc::JSType::Int32Array
| jsc::JSType::Uint32Array
| jsc::JSType::Float16Array
| jsc::JSType::Float32Array
| jsc::JSType::Float64Array
| jsc::JSType::BigInt64Array
| jsc::JSType::BigUint64Array
| jsc::JSType::DataView => {
t if t.is_array_buffer_like() => {
could_have_non_ascii = true;
let buf = item.as_array_buffer(global).unwrap();
if parts_can_run_js {
Expand Down Expand Up @@ -3653,20 +3567,7 @@ impl BlobExt for Blob {
}
}

jsc::JSType::ArrayBuffer
| jsc::JSType::Int8Array
| jsc::JSType::Uint8Array
| jsc::JSType::Uint8ClampedArray
| jsc::JSType::Int16Array
| jsc::JSType::Uint16Array
| jsc::JSType::Int32Array
| jsc::JSType::Uint32Array
| jsc::JSType::Float16Array
| jsc::JSType::Float32Array
| jsc::JSType::Float64Array
| jsc::JSType::BigInt64Array
| jsc::JSType::BigUint64Array
| jsc::JSType::DataView => {
t if t.is_array_buffer_like() => {
let buf = current.as_array_buffer(global).unwrap();
// SAFETY: this arm is only reached when the typed array is the
// top-level value (the walk stack is empty), so no user JS runs
Expand Down Expand Up @@ -5346,6 +5247,36 @@ fn validate_writable_blob(global_this: &JSGlobalObject, blob: &Blob) -> JsResult
Ok(())
}

/// Overrides `blob`'s content type from a write-path `options.type` value.
/// Throws if the value is not a string; silently ignores invalid blob types.
fn set_content_type_from_js(
global_this: &JSGlobalObject,
blob: &Blob,
content_type: JSValue,
) -> JsResult<()> {
if !content_type.is_string() {
return Err(global_this.throw_invalid_argument_type("write", "options.type", "string"));
}
let content_type_str = content_type.to_slice(global_this)?;
let slice = content_type_str.slice();
if is_valid_blob_type(slice) {
blob.free_content_type();
blob.content_type_was_set.set(true);
// SAFETY: bun_vm() never returns null for a Bun-owned global.
if let Some(mime) = global_this.bun_vm().as_mut().mime_type(slice) {
blob.content_type
.set(std::ptr::from_ref::<[u8]>(mime.value.as_ref()));
} else {
let mut buf = vec![0u8; slice.len()];
strings::copy_lowercase(slice, &mut buf);
blob.content_type
.set(bun_core::heap::into_raw(buf.into_boxed_slice()));
blob.content_type_allocated.set(true);
}
}
Ok(())
}

/// `Bun.write(destination, input, options?)`
pub fn write_file(global_this: &JSGlobalObject, callframe: &CallFrame) -> JsResult<JSValue> {
let arguments = callframe.arguments();
Expand Down Expand Up @@ -7338,6 +7269,93 @@ pub trait FileCloser: Sized {
}
}

/// Implements [`FileCloser`] for a struct with the standard field set
/// (`opened_fd`, `close_after_io`, `state`, `io_request`, `io_poll`, `task`),
/// an inherent `update()`, and a [`bun_io::Tag`] variant named after the type.
/// Requires `bun_threading::intrusive_work_task!` and
/// `bun_io::intrusive_io_request!` on the type for the intrusive-pointer
/// recovery in the two trampolines.
macro_rules! impl_file_closer {
($T:ident) => {
impl crate::webcore::blob::FileCloser for $T {
const IO_TAG: ::bun_io::Tag = ::bun_io::Tag::$T;
fn opened_fd(&self) -> ::bun_sys::Fd {
self.opened_fd
}
fn set_opened_fd(&mut self, fd: ::bun_sys::Fd) {
self.opened_fd = fd;
}
fn close_after_io(&self) -> bool {
self.close_after_io
}
fn set_close_after_io(&mut self, v: bool) {
self.close_after_io = v;
}
fn state(&self) -> &::core::sync::atomic::AtomicU8 {
&self.state
}
fn io_request(&mut self) -> Option<&mut ::bun_io::Request> {
Some(&mut self.io_request)
}
fn io_poll(&mut self) -> &mut ::bun_io::Poll {
&mut self.io_poll
}
fn task(&mut self) -> &mut ::bun_jsc::WorkPoolTask {
&mut self.task
}
fn update(&mut self) {
$T::update(self)
}
#[cfg(windows)]
fn loop_(&self) -> *mut ::bun_libuv_sys::uv_loop_t {
unreachable!()
}

fn schedule_close(request: &mut ::bun_io::Request) -> ::bun_io::Action<'_> {
// SAFETY: request is &mut self.io_request (intrusive); recover parent.
let this = unsafe {
&mut *<$T as ::bun_io::IntrusiveIoRequest>::from_io_request(
::core::ptr::from_mut(request),
)
};
fn on_done(ctx: *mut ()) {
// SAFETY: ctx is `self as *mut Self` set below.
let this = unsafe { ::bun_ptr::callback_ctx::<$T>(ctx.cast()) };
<$T as crate::webcore::blob::FileCloser>::on_io_request_closed(this);
}
// reshaped for borrowck — compute the parent raw pointer
// before mutably borrowing `io_poll` so the two borrows do not overlap.
let ctx = ::core::ptr::from_mut::<$T>(this).cast::<()>();
let fd = this.opened_fd;
::bun_io::Action::Close(::bun_io::CloseAction {
fd,
poll: &mut this.io_poll,
ctx,
tag: <Self as crate::webcore::blob::FileCloser>::IO_TAG,
on_done,
})
}

// `FileCloser` fixes `on_close_io_request` to take `*mut WorkPoolTask`;
// the trait method cannot be marked `unsafe fn`, so the lint is
// unsatisfiable here. The pointer is the intrusive `&mut self.task` set
// in `on_io_request_closed` and is guaranteed live.
#[allow(clippy::not_unsafe_ptr_arg_deref)]
fn on_close_io_request(task: *mut ::bun_jsc::WorkPoolTask) {
// SAFETY: only reached via `WorkPoolTask::callback` with `task` =
// `&mut self.task` (intrusive) registered in `on_io_request_closed`;
// recover parent.
let this = unsafe {
&mut *<$T as ::bun_threading::IntrusiveWorkTask>::from_task_ptr(task)
};
this.close_after_io = false;
$T::update(this);
}
}
};
}
pub(crate) use impl_file_closer;

// ──────────────────────────────────────────────────────────────────────────
// isAllASCII / takeOwnership / heap-alloc helpers / external_shared_descriptor
// ──────────────────────────────────────────────────────────────────────────
Expand Down
26 changes: 2 additions & 24 deletions src/runtime/webcore/FileSink.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1422,9 +1422,8 @@ impl crate::webcore::sink::JsSinkType for FileSink {
const HAS_GET_FD: bool = true;
const START_TAG: Option<streams::StartTag> = Some(streams::StartTag::FileSink);

fn memory_cost(&self) -> usize {
Self::memory_cost(self)
}
crate::impl_js_sink_forwarders!();

fn finalize(&mut self) {
Self::finalize(self)
}
Expand All @@ -1433,30 +1432,9 @@ impl crate::webcore::sink::JsSinkType for FileSink {
// the C++ `JSFileSink` wrapper `js_construct` is about to create.
this.write(Self::construct());
}
fn write_bytes(&mut self, data: &streams::Result) -> streams::result::Writable {
Self::write(self, data)
}
fn write_utf16(&mut self, data: &streams::Result) -> streams::result::Writable {
Self::write_utf16(self, data)
}
fn write_latin1(&mut self, data: &streams::Result) -> streams::result::Writable {
Self::write_latin1(self, data)
}
fn end(&mut self, err: Option<sys::Error>) -> sys::Result<()> {
Self::end(self, err)
}
fn end_from_js(&mut self, global: &JSGlobalObject) -> sys::Result<JSValue> {
Self::end_from_js(self, global)
}
fn flush(&mut self) -> sys::Result<()> {
Self::flush(self)
}
fn flush_from_js(&mut self, global: &JSGlobalObject, wait: bool) -> sys::Result<JSValue> {
Self::flush_from_js(self, global, wait)
}
fn start(&mut self, config: streams::Start) -> sys::Result<()> {
Self::start(self, &config)
}
fn signal(&mut self) -> Option<&mut streams::Signal> {
// SAFETY: JsCell — trait receiver is `&mut self`; sole borrow of `signal`.
Some(unsafe { self.signal.get_mut() })
Expand Down
Loading
Loading