Mirrors/servo
1
0
Fork 0
mirror of https://github.com/servo/servo.git synced 2025-07-23 15:23:42 +01:00
Code Issues Projects Releases Packages Wiki Activity

WebIDL: Replace NonNull<JSObject> in xmlhttprequest (#31880)

Browse source 
* WebIDL: Replace `NonNull<JSObject>` in `xmlhttprequest.rs`

* doc: Update functions comments to docstring

* fix: Actually allocate `response_arraybuffer`

* fix: Change step descriptions

* fix: change step numbers
This commit is contained in:
eri 2024-03-27 21:28:51 +01:00 • committed by GitHub
parent ff95ce5abd
commit 1c8c287f01
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 44 additions and 51 deletions
Download patch file Download diff file Expand all files Collapse all files

97
components/script/dom/xmlhttprequest.rs
View file

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