From 1c8c287f01757488733f5df501461bf1b74ca163 Mon Sep 17 00:00:00 2001 From: eri Date: Wed, 27 Mar 2024 21:28:51 +0100 Subject: WebIDL: Replace `NonNull` in `xmlhttprequest` (#31880) * WebIDL: Replace `NonNull` in `xmlhttprequest.rs` * doc: Update functions comments to docstring * fix: Actually allocate `response_arraybuffer` * fix: Change step descriptions * fix: change step numbers --- components/script/dom/xmlhttprequest.rs | 95 +++++++++++++++------------------ 1 file changed, 44 insertions(+), 51 deletions(-) (limited to 'components/script/dom') diff --git a/components/script/dom/xmlhttprequest.rs b/components/script/dom/xmlhttprequest.rs index a84c43201e5..c7ed203f996 100644 --- a/components/script/dom/xmlhttprequest.rs +++ b/components/script/dom/xmlhttprequest.rs @@ -5,10 +5,9 @@ use std::borrow::ToOwned; use std::cell::Cell; use std::default::Default; -use std::ptr::NonNull; use std::str::{self, FromStr}; use std::sync::{Arc, Mutex}; -use std::{cmp, ptr, slice}; +use std::{cmp, slice}; use dom_struct::dom_struct; use encoding_rs::{Encoding, UTF_8}; @@ -21,11 +20,11 @@ use http::Method; use hyper_serde::Serde; use ipc_channel::ipc; use ipc_channel::router::ROUTER; -use js::jsapi::{Heap, JSObject, JS_ClearPendingException}; +use js::jsapi::{Heap, JS_ClearPendingException}; use js::jsval::{JSVal, NullValue, UndefinedValue}; use js::rust::wrappers::JS_ParseJSON; use js::rust::HandleObject; -use js::typedarray::{ArrayBuffer, CreateWith}; +use js::typedarray::{ArrayBuffer, ArrayBufferU8}; use mime::{self, Mime, Name}; use net_traits::request::{CredentialsMode, Destination, Referrer, RequestBuilder, RequestMode}; use net_traits::CoreResourceMsg::Fetch; @@ -41,6 +40,7 @@ use url::Position; use crate::body::{BodySource, Extractable, ExtractedBody}; use crate::document_loader::DocumentLoader; +use crate::dom::bindings::buffer_source::HeapBufferSource; use crate::dom::bindings::cell::DomRefCell; use crate::dom::bindings::codegen::Bindings::WindowBinding::WindowMethods; use crate::dom::bindings::codegen::Bindings::XMLHttpRequestBinding::{ @@ -136,7 +136,7 @@ pub struct XMLHttpRequest { response_xml: MutNullableDom, response_blob: MutNullableDom, #[ignore_malloc_size_of = "mozjs"] - response_arraybuffer: Heap<*mut JSObject>, + response_arraybuffer: HeapBufferSource, #[ignore_malloc_size_of = "Defined in rust-mozjs"] response_json: Heap, #[ignore_malloc_size_of = "Defined in hyper"] @@ -195,7 +195,7 @@ impl XMLHttpRequest { response_type: Cell::new(XMLHttpRequestResponseType::_empty), response_xml: Default::default(), response_blob: Default::default(), - response_arraybuffer: Heap::default(), + response_arraybuffer: HeapBufferSource::default(), response_json: Heap::default(), response_headers: DomRefCell::new(HeaderMap::new()), override_mime_type: DomRefCell::new(None), @@ -227,8 +227,8 @@ impl XMLHttpRequest { ) } - // https://xhr.spec.whatwg.org/#constructors #[allow(non_snake_case)] + /// pub fn Constructor( global: &GlobalScope, proto: Option, @@ -339,18 +339,18 @@ impl XMLHttpRequestMethods for XMLHttpRequest { SetOnreadystatechange ); - // https://xhr.spec.whatwg.org/#dom-xmlhttprequest-readystate + /// fn ReadyState(&self) -> u16 { self.ready_state.get() as u16 } - // https://xhr.spec.whatwg.org/#the-open()-method + /// fn Open(&self, method: ByteString, url: USVString) -> ErrorResult { // Step 8 self.Open_(method, url, true, None, None) } - // https://xhr.spec.whatwg.org/#the-open()-method + /// fn Open_( &self, method: ByteString, @@ -452,7 +452,7 @@ impl XMLHttpRequestMethods for XMLHttpRequest { } } - // https://xhr.spec.whatwg.org/#the-setrequestheader()-method + /// fn SetRequestHeader(&self, name: ByteString, value: ByteString) -> ErrorResult { // Step 1, 2 if self.ready_state.get() != XMLHttpRequestState::Opened || self.send_flag.get() { @@ -506,12 +506,12 @@ impl XMLHttpRequestMethods for XMLHttpRequest { Ok(()) } - // https://xhr.spec.whatwg.org/#the-timeout-attribute + /// fn Timeout(&self) -> u32 { self.timeout.get() } - // https://xhr.spec.whatwg.org/#the-timeout-attribute + /// fn SetTimeout(&self, timeout: u32) -> ErrorResult { // Step 1 if self.sync_in_window() { @@ -536,12 +536,12 @@ impl XMLHttpRequestMethods for XMLHttpRequest { Ok(()) } - // https://xhr.spec.whatwg.org/#the-withcredentials-attribute + /// fn WithCredentials(&self) -> bool { self.with_credentials.get() } - // https://xhr.spec.whatwg.org/#dom-xmlhttprequest-withcredentials + /// fn SetWithCredentials(&self, with_credentials: bool) -> ErrorResult { match self.ready_state.get() { // Step 1 @@ -558,12 +558,12 @@ impl XMLHttpRequestMethods for XMLHttpRequest { } } - // https://xhr.spec.whatwg.org/#the-upload-attribute + /// fn Upload(&self) -> DomRoot { DomRoot::from_ref(&*self.upload) } - // https://xhr.spec.whatwg.org/#the-send()-method + /// fn Send(&self, data: Option) -> ErrorResult { // Step 1, 2 if self.ready_state.get() != XMLHttpRequestState::Opened || self.send_flag.get() { @@ -797,7 +797,7 @@ impl XMLHttpRequestMethods for XMLHttpRequest { Ok(()) } - // https://xhr.spec.whatwg.org/#the-abort()-method + /// fn Abort(&self) { // Step 1 self.terminate_ongoing_fetch(); @@ -824,22 +824,22 @@ impl XMLHttpRequestMethods for XMLHttpRequest { } } - // https://xhr.spec.whatwg.org/#the-responseurl-attribute + /// fn ResponseURL(&self) -> USVString { USVString(self.response_url.borrow().clone()) } - // https://xhr.spec.whatwg.org/#the-status-attribute + /// fn Status(&self) -> u16 { self.status.get() } - // https://xhr.spec.whatwg.org/#the-statustext-attribute + /// fn StatusText(&self) -> ByteString { self.status_text.borrow().clone() } - // https://xhr.spec.whatwg.org/#the-getresponseheader()-method + /// fn GetResponseHeader(&self, name: ByteString) -> Option { let headers = self.filter_response_headers(); let headers = headers.get_all(HeaderName::from_str(&name.as_str()?.to_lowercase()).ok()?); @@ -863,7 +863,7 @@ impl XMLHttpRequestMethods for XMLHttpRequest { } } - // https://xhr.spec.whatwg.org/#the-getallresponseheaders()-method + /// fn GetAllResponseHeaders(&self) -> ByteString { let headers = self.filter_response_headers(); let keys = headers.keys(); @@ -911,12 +911,12 @@ impl XMLHttpRequestMethods for XMLHttpRequest { Ok(()) } - // https://xhr.spec.whatwg.org/#the-responsetype-attribute + /// fn ResponseType(&self) -> XMLHttpRequestResponseType { self.response_type.get() } - // https://xhr.spec.whatwg.org/#the-responsetype-attribute + /// fn SetResponseType(&self, response_type: XMLHttpRequestResponseType) -> ErrorResult { // Step 1 if self.global().is::() && @@ -941,7 +941,7 @@ impl XMLHttpRequestMethods for XMLHttpRequest { } #[allow(unsafe_code)] - // https://xhr.spec.whatwg.org/#the-response-attribute + /// fn Response(&self, cx: JSContext) -> JSVal { rooted!(in(*cx) let mut rval = UndefinedValue()); match self.response_type.get() { @@ -972,14 +972,14 @@ impl XMLHttpRequestMethods for XMLHttpRequest { self.blob_response().to_jsval(*cx, rval.handle_mut()); }, XMLHttpRequestResponseType::Arraybuffer => match self.arraybuffer_response(cx) { - Some(js_object) => unsafe { js_object.to_jsval(*cx, rval.handle_mut()) }, + Some(array_buffer) => unsafe { array_buffer.to_jsval(*cx, rval.handle_mut()) }, None => return NullValue(), }, } rval.get() } - // https://xhr.spec.whatwg.org/#the-responsetext-attribute + /// fn GetResponseText(&self) -> Fallible { match self.response_type.get() { XMLHttpRequestResponseType::_empty | XMLHttpRequestResponseType::Text => { @@ -997,7 +997,7 @@ impl XMLHttpRequestMethods for XMLHttpRequest { } } - // https://xhr.spec.whatwg.org/#the-responsexml-attribute + /// fn GetResponseXML(&self) -> Fallible>> { match self.response_type.get() { XMLHttpRequestResponseType::_empty | XMLHttpRequestResponseType::Document => { @@ -1310,7 +1310,7 @@ impl XMLHttpRequest { } } - // https://xhr.spec.whatwg.org/#text-response + /// fn text_response(&self) -> String { // Step 3, 5 let charset = self.final_charset().unwrap_or(UTF_8); @@ -1324,7 +1324,7 @@ impl XMLHttpRequest { text.into_owned() } - // https://xhr.spec.whatwg.org/#blob-response + /// fn blob_response(&self) -> DomRoot { // Step 1 if let Some(response) = self.response_blob.get() { @@ -1344,29 +1344,22 @@ impl XMLHttpRequest { blob } - // https://xhr.spec.whatwg.org/#arraybuffer-response - #[allow(unsafe_code)] - fn arraybuffer_response(&self, cx: JSContext) -> Option> { - // Step 1 - let created = self.response_arraybuffer.get(); - if let Some(nonnull) = NonNull::new(created) { - return Some(nonnull); - } + /// + fn arraybuffer_response(&self, cx: JSContext) -> Option { + // Step 5: Set the response object to a new ArrayBuffer with the received bytes + // For caching purposes, skip this step if the response is already created + if !self.response_arraybuffer.is_initialized() { + let bytes = self.response.borrow(); - // Step 2 - let bytes = self.response.borrow(); - rooted!(in(*cx) let mut array_buffer = ptr::null_mut::()); - unsafe { - ArrayBuffer::create(*cx, CreateWith::Slice(&bytes), array_buffer.handle_mut()) - .ok() - .and_then(|()| { - self.response_arraybuffer.set(array_buffer.get()); - Some(NonNull::new_unchecked(array_buffer.get())) - }) + // If this is not successful, the response won't be set and the function will return None + self.response_arraybuffer.set_data(cx, &bytes).ok()?; } + + // Return the correct ArrayBuffer + self.response_arraybuffer.get_buffer().ok() } - // https://xhr.spec.whatwg.org/#document-response + /// fn document_response(&self) -> Option> { // Caching: if we have existing response xml, redirect it directly let response = self.response_xml.get(); @@ -1437,7 +1430,7 @@ impl XMLHttpRequest { } #[allow(unsafe_code)] - // https://xhr.spec.whatwg.org/#json-response + /// fn json_response(&self, cx: JSContext) -> JSVal { // Step 1 let response_json = self.response_json.get(); -- cgit v1.2.3