RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-25 14:37:46 +00:00
Code Issues Activity Actions

LibWeb: Rename XHR's ReadyState / m_ready_state to just State / m_state

Browse source 
This is what the spec calls it.
This commit is contained in:
Linus Groh 2022-11-13 13:55:40 +00:00
parent 7649feb26f
commit 04eaff3bb4
2 changed files with 24 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

44
Userland/Libraries/LibWeb/XHR/XMLHttpRequest.cpp
View file

@ -66,12 +66,6 @@ void XMLHttpRequest::visit_edges(Cell::Visitor& visitor)
visitor.visit(*value); visitor.visit(*value);
} }
void XMLHttpRequest::set_ready_state(ReadyState ready_state)
{
m_ready_state = ready_state;
dispatch_event(*DOM::Event::create(realm(), EventNames::readystatechange));
}
void XMLHttpRequest::fire_progress_event(String const& event_name, u64 transmitted, u64 length) void XMLHttpRequest::fire_progress_event(String const& event_name, u64 transmitted, u64 length)
{ {
ProgressEventInit event_init {}; ProgressEventInit event_init {};
@ -89,7 +83,7 @@ WebIDL::ExceptionOr<String> XMLHttpRequest::response_text() const
return WebIDL::InvalidStateError::create(realm(), "XHR responseText can only be used for responseType \"\" or \"text\""); return WebIDL::InvalidStateError::create(realm(), "XHR responseText can only be used for responseType \"\" or \"text\"");
// 2. If this’s state is not loading or done, then return the empty string. // 2. If this’s state is not loading or done, then return the empty string.
if (m_ready_state != ReadyState::Loading && m_ready_state != ReadyState::Done) if (m_state != State::Loading && m_state != State::Done)
return String::empty(); return String::empty();
return get_text_response(); return get_text_response();
@ -103,7 +97,7 @@ WebIDL::ExceptionOr<void> XMLHttpRequest::set_response_type(Bindings::XMLHttpReq
return {}; return {};
// 2. If this’s state is loading or done, then throw an "InvalidStateError" DOMException. // 2. If this’s state is loading or done, then throw an "InvalidStateError" DOMException.
if (m_ready_state == ReadyState::Loading || m_ready_state == ReadyState::Done) if (m_state == State::Loading || m_state == State::Done)
return WebIDL::InvalidStateError::create(realm(), "Can't readyState when XHR is loading or done"); return WebIDL::InvalidStateError::create(realm(), "Can't readyState when XHR is loading or done");
// 3. If the current global object is a Window object and this’s synchronous flag is set, then throw an "InvalidAccessError" DOMException. // 3. If the current global object is a Window object and this’s synchronous flag is set, then throw an "InvalidAccessError" DOMException.
@ -123,14 +117,14 @@ WebIDL::ExceptionOr<JS::Value> XMLHttpRequest::response()
// 1. If this’s response type is the empty string or "text", then: // 1. If this’s response type is the empty string or "text", then:
if (m_response_type == Bindings::XMLHttpRequestResponseType::Empty || m_response_type == Bindings::XMLHttpRequestResponseType::Text) { if (m_response_type == Bindings::XMLHttpRequestResponseType::Empty || m_response_type == Bindings::XMLHttpRequestResponseType::Text) {
// 1. If this’s state is not loading or done, then return the empty string. // 1. If this’s state is not loading or done, then return the empty string.
if (m_ready_state != ReadyState::Loading && m_ready_state != ReadyState::Done) if (m_state != State::Loading && m_state != State::Done)
return JS::js_string(vm, ""); return JS::js_string(vm, "");
// 2. Return the result of getting a text response for this. // 2. Return the result of getting a text response for this.
return JS::js_string(vm, get_text_response()); return JS::js_string(vm, get_text_response());
} }
// 2. If this’s state is not done, then return null. // 2. If this’s state is not done, then return null.
if (m_ready_state != ReadyState::Done) if (m_state != State::Done)
return JS::js_null(); return JS::js_null();
// 3. If this’s response object is failure, then return null. // 3. If this’s response object is failure, then return null.
@ -296,7 +290,7 @@ WebIDL::ExceptionOr<void> XMLHttpRequest::set_request_header(String const& name_
auto value = value_string.to_byte_buffer(); auto value = value_string.to_byte_buffer();
// 1. If this’s state is not opened, then throw an "InvalidStateError" DOMException. // 1. If this’s state is not opened, then throw an "InvalidStateError" DOMException.
if (m_ready_state != ReadyState::Opened) if (m_state != State::Opened)
return WebIDL::InvalidStateError::create(realm(), "XHR readyState is not OPENED"); return WebIDL::InvalidStateError::create(realm(), "XHR readyState is not OPENED");
// 2. If this’s send() flag is set, then throw an "InvalidStateError" DOMException. // 2. If this’s send() flag is set, then throw an "InvalidStateError" DOMException.
@ -411,10 +405,12 @@ WebIDL::ExceptionOr<void> XMLHttpRequest::open(String const& method_string, Stri
m_response_object = {}; m_response_object = {};
// 13. If this’s state is not opened, then: // 13. If this’s state is not opened, then:
if (m_ready_state != ReadyState::Opened) { if (m_state != State::Opened) {
// 1. Set this’s state to opened. // 1. Set this’s state to opened.
m_state = State::Opened;
// 2. Fire an event named readystatechange at this. // 2. Fire an event named readystatechange at this.
set_ready_state(ReadyState::Opened); dispatch_event(*DOM::Event::create(realm(), EventNames::readystatechange));
} }
return {}; return {};
@ -426,7 +422,7 @@ WebIDL::ExceptionOr<void> XMLHttpRequest::send(Optional<DocumentOrXMLHttpRequest
auto& vm = this->vm(); auto& vm = this->vm();
auto& realm = *vm.current_realm(); auto& realm = *vm.current_realm();
if (m_ready_state != ReadyState::Opened) if (m_state != State::Opened)
return WebIDL::InvalidStateError::create(realm, "XHR readyState is not OPENED"); return WebIDL::InvalidStateError::create(realm, "XHR readyState is not OPENED");
if (m_send) if (m_send)
@ -457,7 +453,8 @@ WebIDL::ExceptionOr<void> XMLHttpRequest::send(Optional<DocumentOrXMLHttpRequest
if (should_enforce_same_origin_policy && !m_window->associated_document().origin().is_same_origin(request_url_origin)) { if (should_enforce_same_origin_policy && !m_window->associated_document().origin().is_same_origin(request_url_origin)) {
dbgln("XHR failed to load: Same-Origin Policy violation: {} may not load {}", m_window->associated_document().url(), request_url); dbgln("XHR failed to load: Same-Origin Policy violation: {} may not load {}", m_window->associated_document().url(), request_url);
set_ready_state(ReadyState::Done); m_state = State::Done;
dispatch_event(*DOM::Event::create(realm, EventNames::readystatechange));
dispatch_event(*DOM::Event::create(realm, HTML::EventNames::error)); dispatch_event(*DOM::Event::create(realm, HTML::EventNames::error));
return {}; return {};
} }
@ -508,10 +505,10 @@ WebIDL::ExceptionOr<void> XMLHttpRequest::send(Optional<DocumentOrXMLHttpRequest
// FIXME: If this’s upload complete flag is unset and this’s upload listener flag is set, // FIXME: If this’s upload complete flag is unset and this’s upload listener flag is set,
// then fire a progress event named loadstart at this’s upload object with 0 and req’s body’s total bytes. // then fire a progress event named loadstart at this’s upload object with 0 and req’s body’s total bytes.
if (m_ready_state != ReadyState::Opened || !m_send) if (m_state != State::Opened || !m_send)
return {}; return {};
// FIXME: in order to properly set ReadyState::HeadersReceived and ReadyState::Loading, // FIXME: in order to properly set State::HeadersReceived and State::Loading,
// we need to make ResourceLoader give us more detailed updates than just "done" and "error". // we need to make ResourceLoader give us more detailed updates than just "done" and "error".
// FIXME: In the Fetch spec, which XHR gets its definition of `status` from, the status code is 0-999. // FIXME: In the Fetch spec, which XHR gets its definition of `status` from, the status code is 0-999.
// We could clamp, wrap around (current browser behavior!), or error out. // We could clamp, wrap around (current browser behavior!), or error out.
@ -534,7 +531,7 @@ WebIDL::ExceptionOr<void> XMLHttpRequest::send(Optional<DocumentOrXMLHttpRequest
xhr.fire_progress_event(EventNames::progress, transmitted, length); xhr.fire_progress_event(EventNames::progress, transmitted, length);
} }
xhr.m_ready_state = ReadyState::Done; xhr.m_state = State::Done;
xhr.m_status = status_code.value_or(0); xhr.m_status = status_code.value_or(0);
xhr.m_response_headers = move(response_headers); xhr.m_response_headers = move(response_headers);
xhr.m_send = false; xhr.m_send = false;
@ -548,8 +545,9 @@ WebIDL::ExceptionOr<void> XMLHttpRequest::send(Optional<DocumentOrXMLHttpRequest
if (!strong_this) if (!strong_this)
return; return;
auto& xhr = const_cast<XMLHttpRequest&>(*strong_this); auto& xhr = const_cast<XMLHttpRequest&>(*strong_this);
xhr.set_ready_state(ReadyState::Done); xhr.m_state = State::Done;
xhr.set_status(status_code.value_or(0)); xhr.set_status(status_code.value_or(0));
xhr.dispatch_event(*DOM::Event::create(xhr.realm(), EventNames::readystatechange));
xhr.dispatch_event(*DOM::Event::create(xhr.realm(), HTML::EventNames::error)); xhr.dispatch_event(*DOM::Event::create(xhr.realm(), HTML::EventNames::error));
}, },
m_timeout, m_timeout,
@ -598,7 +596,7 @@ String XMLHttpRequest::get_all_response_headers() const
WebIDL::ExceptionOr<void> XMLHttpRequest::override_mime_type(String const& mime) WebIDL::ExceptionOr<void> XMLHttpRequest::override_mime_type(String const& mime)
{ {
// 1. If this’s state is loading or done, then throw an "InvalidStateError" DOMException. // 1. If this’s state is loading or done, then throw an "InvalidStateError" DOMException.
if (m_ready_state == ReadyState::Loading || m_ready_state == ReadyState::Done) if (m_state == State::Loading || m_state == State::Done)
return WebIDL::InvalidStateError::create(realm(), "Cannot override MIME type when state is Loading or Done."); return WebIDL::InvalidStateError::create(realm(), "Cannot override MIME type when state is Loading or Done.");
// 2. Set this’s override MIME type to the result of parsing mime. // 2. Set this’s override MIME type to the result of parsing mime.
@ -635,9 +633,9 @@ bool XMLHttpRequest::must_survive_garbage_collection() const
// if its state is either opened with the send() flag set, headers received, or loading, // if its state is either opened with the send() flag set, headers received, or loading,
// and it has one or more event listeners registered whose type is one of // and it has one or more event listeners registered whose type is one of
// readystatechange, progress, abort, error, load, timeout, and loadend. // readystatechange, progress, abort, error, load, timeout, and loadend.
if ((m_ready_state == ReadyState::Opened && m_send) if ((m_state == State::Opened && m_send)
|| m_ready_state == ReadyState::HeadersReceived || m_state == State::HeadersReceived
|| m_ready_state == ReadyState::Loading) { || m_state == State::Loading) {
if (has_event_listener(EventNames::readystatechange)) if (has_event_listener(EventNames::readystatechange))
return true; return true;
if (has_event_listener(EventNames::progress)) if (has_event_listener(EventNames::progress))

7
Userland/Libraries/LibWeb/XHR/XMLHttpRequest.h
View file

@ -30,7 +30,7 @@ class XMLHttpRequest final : public XMLHttpRequestEventTarget {
WEB_PLATFORM_OBJECT(XMLHttpRequest, XMLHttpRequestEventTarget); WEB_PLATFORM_OBJECT(XMLHttpRequest, XMLHttpRequestEventTarget);
public: public:
enum class ReadyState : u16 { enum class State : u16 {
Unsent = 0, Unsent = 0,
Opened = 1, Opened = 1,
HeadersReceived = 2, HeadersReceived = 2,
@ -42,7 +42,7 @@ public:
virtual ~XMLHttpRequest() override; virtual ~XMLHttpRequest() override;
ReadyState ready_state() const { return m_ready_state; }; State ready_state() const { return m_state; };
Fetch::Infrastructure::Status status() const { return m_status; }; Fetch::Infrastructure::Status status() const { return m_status; };
WebIDL::ExceptionOr<String> response_text() const; WebIDL::ExceptionOr<String> response_text() const;
WebIDL::ExceptionOr<JS::Value> response(); WebIDL::ExceptionOr<JS::Value> response();
@ -72,7 +72,6 @@ private:
virtual void visit_edges(Cell::Visitor&) override; virtual void visit_edges(Cell::Visitor&) override;
virtual bool must_survive_garbage_collection() const override; virtual bool must_survive_garbage_collection() const override;
void set_ready_state(ReadyState);
void set_status(Fetch::Infrastructure::Status status) { m_status = status; } void set_status(Fetch::Infrastructure::Status status) { m_status = status; }
void fire_progress_event(String const&, u64, u64); void fire_progress_event(String const&, u64, u64);
@ -86,7 +85,7 @@ private:
JS::NonnullGCPtr<HTML::Window> m_window; JS::NonnullGCPtr<HTML::Window> m_window;
ReadyState m_ready_state { ReadyState::Unsent }; State m_state { State::Unsent };
Fetch::Infrastructure::Status m_status { 0 }; Fetch::Infrastructure::Status m_status { 0 };
bool m_send { false }; bool m_send { false };
u32 m_timeout { 0 }; u32 m_timeout { 0 };