Preserve watchElementForClose state across bfcache#129
Open
Preserve watchElementForClose state across bfcache#129
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add
event.persistedguard to the sacrificial iframe'spagehidelistener inwatchElementForClose, preventing false-positive element close detection when the page enters bfcache.Problem
watchElementForCloseuses a sacrificial iframe to detect when a DOM element is removed. The iframe listens forpagehide(orunloadin legacy browsers) as one of its detection strategies. When a pageenters bfcache, the sacrificial iframe's
pagehidefires withevent.persisted = true, triggeringelementClosed()even though the element is still in the DOM. This causes a frozen promise that resumes onbfcache restore, leading to unnecessary cleanup or re-render in consumers like zoid.
Fix
Wrap the sacrificial iframe's termination event listener in a new
elementClosedOnTerminationfunction that checksevent.persistedbefore callingelementClosed():terminationEvent === "pagehide"andevent.persisted === true→ skip (page entering bfcache, element is not actually removed)elementClosed()as before (real navigation or legacyunload)Only the sacrificial iframe listener is affected. The MutationObserver and polling strategies continue to use
elementCloseddirectly.Changes
src/dom.js—watchElementForClose:elementClosedOnTerminationwrapper withevent.persistedguardaddEventListener(Strategy 2) to useelementClosedOnTerminationremoveEventListenerincancel()to matchTest plan
watchElementForClosedoes NOT fire (sacrificial iframe pagehide is skipped)watchElementForClosefires normally, element close is detectedunloadevent (nopersistedproperty) — guard is skipped,elementClosedfires normally