beenull/ladybird
1
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2024-09-29 16:21:29 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

LibWeb: Fix hanging location.reload() when SHE is populated by fetching

Browse source 
Adds a hack to address spec bug https://github.com/whatwg/html/issues/9869
This commit is contained in:
Aliaksandr Kalenik 2024-03-27 14:54:46 +01:00 committed by Andreas Kling
parent 609a72f7c7
commit 966b042db6
Notes: sideshowbarker 2024-07-16 23:44:30 +09:00 
Author: https://github.com/kalenikaliaksandr
Commit: https://github.com/SerenityOS/serenity/commit/966b042db6
Pull-request: https://github.com/SerenityOS/serenity/pull/23720
10 changed files with 158 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
Tests/LibWeb/Text/data/iframe-reload.html Normal file
View file

@ -0,0 +1,12 @@
<script>
window.addEventListener('message', event => {
if (event.data && event.data.action === 'reload') {
window.parent.postMessage({ action: 'acknowledge-asked-to-reload' });
location.reload();
}
});
window.addEventListener('load', () => {
window.parent.postMessage({ action: 'loaded' });
});
</script>

3
Tests/LibWeb/Text/expected/navigation/location-reload-fetch.txt Normal file
View file

@ -0,0 +1,3 @@
iframe is loaded
iframe is going to reload
iframe is loaded

3
Tests/LibWeb/Text/expected/navigation/location-reload-srcdoc.txt Normal file
View file

@ -0,0 +1,3 @@
iframe is loaded
iframe is going to reload
iframe is loaded

29
Tests/LibWeb/Text/input/navigation/location-reload-fetch.html Normal file
View file

@ -0,0 +1,29 @@
<!DOCTYPE html>
<script src="../include.js"></script>
<script>
let reloaded = false;
window.addEventListener('message', event => {
switch (event.data.action) {
case "loaded":
println("iframe is loaded");
if (!reloaded) {
event.source.postMessage({ action: 'reload' });
reloaded = true;
} else {
internals.signalTextTestIsDone();
}
break;
case "acknowledge-asked-to-reload":
println("iframe is going to reload");
break;
default:
break;
}
});
document.addEventListener("DOMContentLoaded", () => {
const iframe = document.createElement('iframe');
iframe.src = "../../data/iframe-reload.html"
document.body.appendChild(iframe);
});
</script>

42
Tests/LibWeb/Text/input/navigation/location-reload-srcdoc.html Normal file
View file

@ -0,0 +1,42 @@
<!DOCTYPE html>
<script src="../include.js"></script>
<script>
let reloaded = false;
window.addEventListener('message', event => {
switch (event.data.action) {
case "loaded":
println("iframe is loaded");
if (!reloaded) {
event.source.postMessage({ action: 'reload' });
reloaded = true;
} else {
internals.signalTextTestIsDone();
}
break;
case "acknowledge-asked-to-reload":
println("iframe is going to reload");
break;
default:
break;
}
});
const iframeScript = `
window.addEventListener('message', event => {
if (event.data && event.data.action === 'reload') {
window.parent.postMessage({ action: 'acknowledge-asked-to-reload' });
location.reload();
}
});
window.addEventListener('load', () => {
window.parent.postMessage({ action: 'loaded' });
});
`;
document.addEventListener("DOMContentLoaded", () => {
const iframe = document.createElement('iframe');
iframe.srcdoc = "<script>" + iframeScript + "<\/script>";
document.body.appendChild(iframe);
});
</script>

18
Userland/Libraries/LibWeb/HTML/DocumentState.cpp
View file

@ -27,4 +27,22 @@ void DocumentState::visit_edges(Cell::Visitor& visitor)
}
}
JS::NonnullGCPtr<DocumentState> DocumentState::clone() const
{
JS::NonnullGCPtr<DocumentState> cloned = *heap().allocate_without_realm<DocumentState>();
cloned->m_document = m_document;
cloned->m_history_policy_container = m_history_policy_container;
cloned->m_request_referrer = m_request_referrer;
cloned->m_request_referrer_policy = m_request_referrer_policy;
cloned->m_initiator_origin = m_initiator_origin;
cloned->m_origin = m_origin;
cloned->m_about_base_url = m_about_base_url;
cloned->m_nested_histories = m_nested_histories;
cloned->m_resource = m_resource;
cloned->m_reload_pending = m_reload_pending;
cloned->m_ever_populated = m_ever_populated;
cloned->m_navigable_target_name = m_navigable_target_name;
return cloned;
}
}

2
Userland/Libraries/LibWeb/HTML/DocumentState.h
View file

@ -31,6 +31,8 @@ public:
virtual ~DocumentState();
JS::NonnullGCPtr<DocumentState> clone() const;
enum class Client {
Tag,
};

17
Userland/Libraries/LibWeb/HTML/SessionHistoryEntry.cpp
View file

@ -28,6 +28,23 @@ SessionHistoryEntry::SessionHistoryEntry()
{
}
JS::NonnullGCPtr<SessionHistoryEntry> SessionHistoryEntry::clone() const
{
JS::NonnullGCPtr<SessionHistoryEntry> entry = *heap().allocate_without_realm<SessionHistoryEntry>();
entry->m_step = m_step;
entry->m_url = m_url;
entry->m_document_state = m_document_state->clone();
entry->m_classic_history_api_state = m_classic_history_api_state;
entry->m_navigation_api_state = m_navigation_api_state;
entry->m_navigation_api_key = m_navigation_api_key;
entry->m_navigation_api_id = m_navigation_api_id;
entry->m_scroll_restoration_mode = m_scroll_restoration_mode;
entry->m_policy_container = m_policy_container;
entry->m_browsing_context_name = m_browsing_context_name;
entry->m_original_source_browsing_context = m_original_source_browsing_context;
return entry;
}
// https://html.spec.whatwg.org/multipage/browsing-the-web.html#she-document
JS::GCPtr<DOM::Document> SessionHistoryEntry::document() const
{

2
Userland/Libraries/LibWeb/HTML/SessionHistoryEntry.h
View file

@ -37,6 +37,8 @@ public:
void visit_edges(Cell::Visitor&) override;
JS::NonnullGCPtr<SessionHistoryEntry> clone() const;
JS::GCPtr<DOM::Document> document() const;
enum class Pending {

38
Userland/Libraries/LibWeb/HTML/TraversableNavigable.cpp
View file

@ -396,11 +396,17 @@ TraversableNavigable::HistoryStepResult TraversableNavigable::apply_the_history_
// 10. Let completedChangeJobs be 0.
size_t completed_change_jobs = 0;
enum class PopulatedClonedTargetSHE {
Yes,
No,
};
struct ChangingNavigableContinuationState {
JS::Handle<DOM::Document> displayed_document;
JS::Handle<SessionHistoryEntry> target_entry;
JS::Handle<Navigable> navigable;
bool update_only = false;
PopulatedClonedTargetSHE populated_cloned_target_she = PopulatedClonedTargetSHE::No; /* Not in the spec */
};
// 11. Let changingNavigableContinuations be an empty queue of changing navigable continuation states.
@ -471,7 +477,12 @@ TraversableNavigable::HistoryStepResult TraversableNavigable::apply_the_history_
// and oldOrigin is the same as navigable's current session history entry's document state's origin,
// then fire a traverse navigate event given targetEntry and userInvolvementForNavigateEvents.
auto after_document_populated = [old_origin, target_entry, changing_navigable_continuation, &changing_navigable_continuations, &vm, &navigable]() mutable {
auto after_document_populated = [old_origin, changing_navigable_continuation, &changing_navigable_continuations, &vm, &navigable](PopulatedClonedTargetSHE populated_cloned_target_she, JS::NonnullGCPtr<SessionHistoryEntry> target_entry) mutable {
// NOTE: Not in the spec, but we need to keep information about whether the target entry was populated or not
// so later we can decide whether we need to set active SHE to cloned target SHE in case it was populated.
changing_navigable_continuation.target_entry = target_entry;
changing_navigable_continuation.populated_cloned_target_she = populated_cloned_target_she;
// 1. If targetEntry's document is null, then set changingNavigableContinuation's update-only to true.
if (!target_entry->document()) {
changing_navigable_continuation.update_only = true;
@ -520,21 +531,25 @@ TraversableNavigable::HistoryStepResult TraversableNavigable::apply_the_history_
// 6. Let allowPOST be targetEntry's document state's reload pending.
auto allow_POST = target_entry->document_state()->reload_pending();
// https://github.com/whatwg/html/issues/9869
// Not in the spec:
// In case of reloads we need to clone the target entry before passing it to populate_session_history_entry_document()
// otherwise active SHE's document will be changed and tasks scheduled on active window's object won't be able to run.
auto target_entry_clone = target_entry->clone();
// 7. In parallel, attempt to populate the history entry's document for targetEntry, given navigable, potentiallyTargetSpecificSourceSnapshotParams,
// targetSnapshotParams, with allowPOST set to allowPOST and completionSteps set to queue a global task on the navigation and traversal task source given
// navigable's active window to run afterDocumentPopulated.
Platform::EventLoopPlugin::the().deferred_invoke([target_entry, potentially_target_specific_source_snapshot_params, target_snapshot_params, this, allow_POST, navigable, after_document_populated] {
navigable->populate_session_history_entry_document(target_entry, *potentially_target_specific_source_snapshot_params, target_snapshot_params, {}, Empty {}, CSPNavigationType::Other, allow_POST, [this, after_document_populated]() mutable {
queue_global_task(Task::Source::NavigationAndTraversal, *active_window(), [after_document_populated]() mutable {
after_document_populated();
});
Platform::EventLoopPlugin::the().deferred_invoke([target_entry_clone, potentially_target_specific_source_snapshot_params, target_snapshot_params, allow_POST, navigable, after_document_populated] {
navigable->populate_session_history_entry_document(target_entry_clone, *potentially_target_specific_source_snapshot_params, target_snapshot_params, {}, Empty {}, CSPNavigationType::Other, allow_POST, [after_document_populated, target_entry_clone]() mutable {
after_document_populated(PopulatedClonedTargetSHE::Yes, *target_entry_clone);
})
.release_value_but_fixme_should_propagate_errors();
});
}
// Otherwise, run afterDocumentPopulated immediately.
else {
after_document_populated();
after_document_populated(PopulatedClonedTargetSHE::No, *target_entry);
}
});
}
@ -613,12 +628,19 @@ TraversableNavigable::HistoryStepResult TraversableNavigable::apply_the_history_
auto entries_for_navigation_api = get_session_history_entries_for_the_navigation_api(*navigable, target_step);
// 11. Queue a global task on the navigation and traversal task source given navigable's active window to run the steps:
queue_global_task(Task::Source::NavigationAndTraversal, *navigable->active_window(), [&completed_change_jobs, target_entry, navigable, displayed_document, update_only = changing_navigable_continuation.update_only, script_history_length, script_history_index, entries_for_navigation_api = move(entries_for_navigation_api), user_involvement_for_navigate_events]() mutable {
auto populated_cloned_target_she = changing_navigable_continuation.populated_cloned_target_she;
queue_global_task(Task::Source::NavigationAndTraversal, *navigable->active_window(), [&completed_change_jobs, target_entry, navigable, displayed_document, populated_cloned_target_she, update_only = changing_navigable_continuation.update_only, script_history_length, script_history_index, entries_for_navigation_api = move(entries_for_navigation_api), user_involvement_for_navigate_events]() mutable {
// NOTE: This check is not in the spec but we should not continue navigation if navigable has been destroyed.
if (navigable->has_been_destroyed()) {
return;
}
// Not in the spec:
// If cloned target SHE was populated, we need to set active SHE to it.
if (populated_cloned_target_she == PopulatedClonedTargetSHE::Yes) {
navigable->set_active_session_history_entry(*target_entry);
}
// 1. If changingNavigableContinuation's update-only is false, then:
if (!update_only) {
// 1. If targetEntry's document does not equal displayedDocument, then: