Improve popover event handling in nested showing and hiding #9198

josepharhar · 2023-04-21T23:34:07Z

Fix a case where a beforetoggle event handler opens a new popover
Stop firing beforetoggle events when there are nested calls to showPopover or hidePopover due to script

This PR accounts for these 4 chromium patches whose commit messages have additional context:

At least two implementers are interested (and none opposed):
- Chrome
- WebKit
Tests are written and can be reviewed and commented upon at:
Implementation bugs are filed:
MDN issue is filed: N/A

(See WHATWG Working Mode: Changes for more details.)

Fixes whatwg#9197 Fixes whatwg#9196 But there was a case where the `beforetoggle` event could open a new popover while an old one was closing. This led to odd situations where asserts and infinite loops ensued. This PR breaks that loop, or rather converts it to an explicit one, by repeating the "hide all popovers until" algorithm until all popovers are closed. That admits an explicit loop, which is the popover equivalent of `while(true) {}`: when the `beforetoggle` handler for a popover re-shows the popover.

annevk · 2023-04-24T14:43:17Z

#9197 (comment) needs to be addressed first.

josepharhar · 2023-04-25T21:35:06Z

There are some additional changes to this PR i need to make based on some more changes mason has made in chromium to address #9196 and #9197
I will reopen this when it this has been incorporated and is ready for review

josepharhar · 2023-05-11T00:47:13Z

Ok, this PR is ready for review again and should fix both #9196 and #9197

source

nt1m · 2023-05-15T14:19:18Z

@emilio or @cathiechen, can you please review this? Mainly interested in two things:

if this addresses your concerns (presumably yes)
if you can find any simplifications to be made

emilio · 2023-05-22T18:12:07Z

@emilio or @cathiechen, can you please review this? Mainly interested in two things:
* if this addresses your concerns (presumably yes)

Yes

* if you can find any simplifications to be made

Instead of the if is nested, then set the flag to false, it might be easier to reason about as always set the flag to the previous (is nested) value? But that's editorial, I don't think it's observable.

cathiechen · 2023-05-22T19:36:49Z

The fix in Gecko, We have only made modifications to the loop in the hidePopover function.
So I'm thinking could we remove the changes in showPopover. Upon further examination, making changes in both functions seems reasonable for me, as I discovered the potential for nested calls to showPopover. So with changes in showPopover, we can reduce the length of the call stack.

Yet, I found another corner issue about nested popover, and I filed an issue in #9319

https://bugs.webkit.org/show_bug.cgi?id=256379 Reviewed by Tim Nguyen. Fix hideAllPopoversUntil for the case where hiding an auto popover changes the auto popover list (through beforetoggle) so the same auto popover is on top, causing a loop. To fix this, when this is detected, continue the loop without firing events. See: whatwg/html#9198 * LayoutTests/imported/w3c/web-platform-tests/html/semantics/popovers/popover-light-dismiss-expected.txt: * LayoutTests/imported/w3c/web-platform-tests/html/semantics/popovers/popover-light-dismiss.html: * LayoutTests/platform/glib/imported/w3c/web-platform-tests/html/semantics/popovers/popover-light-dismiss-expected.txt: * LayoutTests/platform/ios/imported/w3c/web-platform-tests/html/semantics/popovers/popover-light-dismiss-expected.txt: * Source/WebCore/dom/Document.cpp: (WebCore::Document::topmostAutoPopover const): (WebCore::Document::hideAllPopoversUntil): * Source/WebCore/dom/PopoverData.h: (WebCore::PopoverData::ScopedStartShowingOrHiding::ScopedStartShowingOrHiding): (WebCore::PopoverData::ScopedStartShowingOrHiding::~ScopedStartShowingOrHiding): (WebCore::PopoverData::ScopedStartShowingOrHiding::wasShowingOrHiding const): * Source/WebCore/html/HTMLElement.cpp: (WebCore::HTMLElement::showPopover): (WebCore::HTMLElement::hidePopoverInternal): Canonical link: https://commits.webkit.org/264623@main

source

nt1m · 2023-06-06T06:44:33Z

Can you add "Fixes #9319" to the commit message?

annevk

I found some nits that would be nice to see fixed in a follow-up. As they already existed I'm not gonna hold this up over them as this PR is quite old now.

annevk · 2023-06-08T06:00:51Z

source

-   <li><p>If <var>foundEndpoint</var> is false, then run <var>closeAllOpenPopovers</var> and
-   return.</p></li>
+     <li>
+      <p>For each <var>popover</var> in <var>document</var>'s <span>auto popover list</span>:</p>


We should link for each here.

annevk · 2023-06-08T06:01:54Z

source

+     <li>
+      <p>While <var>lastToHide</var> is not null and <var>lastToHide</var>'s <span>popover
+      visibility state</span> is <span data-x="popover-showing-state">showing</span> and
+      <var>document</var>'s <span>auto popover list</span> is not empty:</p>


Should make is not empty an xref.

annevk · 2023-06-08T06:08:33Z

@cathiechen does this look good to you now as well? And Gecko bug we should link from OP?

cathiechen · 2023-06-08T08:58:24Z

@cathiechen does this look good to you now as well? And Gecko bug we should link from OP?

Yes, it looks good to me. And filed the Gecko bug https://bugzilla.mozilla.org/show_bug.cgi?id=1837360

https://bugs.webkit.org/show_bug.cgi?id=256379 Reviewed by Tim Nguyen. Fix hideAllPopoversUntil for the case where hiding an auto popover changes the auto popover list (through beforetoggle) so the same auto popover is on top, causing a loop. To fix this, when this is detected, continue the loop without firing events. See: whatwg/html#9198 * LayoutTests/imported/w3c/web-platform-tests/html/semantics/popovers/popover-light-dismiss-expected.txt: * LayoutTests/imported/w3c/web-platform-tests/html/semantics/popovers/popover-light-dismiss.html: * LayoutTests/platform/glib/imported/w3c/web-platform-tests/html/semantics/popovers/popover-light-dismiss-expected.txt: * LayoutTests/platform/ios/imported/w3c/web-platform-tests/html/semantics/popovers/popover-light-dismiss-expected.txt: * Source/WebCore/dom/Document.cpp: (WebCore::Document::topmostAutoPopover const): (WebCore::Document::hideAllPopoversUntil): * Source/WebCore/dom/PopoverData.h: (WebCore::PopoverData::ScopedStartShowingOrHiding::ScopedStartShowingOrHiding): (WebCore::PopoverData::ScopedStartShowingOrHiding::~ScopedStartShowingOrHiding): (WebCore::PopoverData::ScopedStartShowingOrHiding::wasShowingOrHiding const): * Source/WebCore/html/HTMLElement.cpp: (WebCore::HTMLElement::showPopover): (WebCore::HTMLElement::hidePopoverInternal): Canonical link: https://commits.webkit.org/264623@main

Fixes whatwg#9468 I mistakenly added and modified this check while speccing a chromium patch in this PR: whatwg#9198

I mistakenly added and modified this check in #9198. Fixes #9468.

I mistakenly added and modified this check in whatwg#9198. Fixes whatwg#9468.

josepharhar added 2 commits April 21, 2023 16:30

put check popover validity back in

d8d9faa

annevk added the topic: popover The popover attribute and friends label Apr 24, 2023

josepharhar closed this Apr 25, 2023

josepharhar added 3 commits May 10, 2023 10:04

Merge branch 'main' into popoverloop

d444536

started on scoped nesting flag

efdafed

finished

1dbf6f4

josepharhar changed the title ~~Fix a corner case where beforetoggle opens a new popover~~ Improve popover event handling in nested showing and hiding May 11, 2023

josepharhar reopened this May 11, 2023

nt1m reviewed May 15, 2023

View reviewed changes

source Outdated Show resolved Hide resolved

source Outdated Show resolved Hide resolved

nt1m requested a review from emilio May 15, 2023 14:17

rwlbuis mentioned this pull request May 15, 2023

[popover] Prevent hidePopover from causing a recursive loop WebKit/WebKit#13504

Merged

move popover showing or hiding

cb6b5f6

cathiechen mentioned this pull request May 25, 2023

Another corner case about nested popovers #9319

Closed

cathiechen reviewed May 29, 2023

View reviewed changes

source Outdated Show resolved Hide resolved

cathiechen reviewed Jun 1, 2023

View reviewed changes

source Outdated Show resolved Hide resolved

source Show resolved Hide resolved

josepharhar added 3 commits June 5, 2023 15:20

Merge branch 'main' into popoverloop

44e90ae

fix assignment to repeatingHide

1a468ae

move up cleanupShowingFlag definition

11a385c

annevk approved these changes Jun 8, 2023

View reviewed changes

annevk merged commit baab26f into whatwg:main Jun 8, 2023
1 check passed

mbrodesser-Igalia mentioned this pull request Jun 15, 2023

nestedShow is not initialized in https://html.spec.whatwg.org/#show-popover #9429

Closed

josepharhar mentioned this pull request Jul 5, 2023

Should step 7 of https://html.spec.whatwg.org/#hide-popover-algorithm be a while loop? #9468

Closed

josepharhar added a commit to josepharhar/html that referenced this pull request Jul 17, 2023

Remove erroneous break in hide popover algorithm

f679518

Fixes whatwg#9468 I mistakenly added and modified this check while speccing a chromium patch in this PR: whatwg#9198

josepharhar mentioned this pull request Jul 17, 2023

Remove erroneous break in hide popover algorithm #9528

Merged

3 tasks

annevk pushed a commit that referenced this pull request Jul 25, 2023

Remove erroneous break in hide popover algorithm

eed5c0e

I mistakenly added and modified this check in #9198. Fixes #9468.

rubberyuzu pushed a commit to rubberyuzu/html that referenced this pull request Aug 25, 2023

Remove erroneous break in hide popover algorithm

0f0cc2c

I mistakenly added and modified this check in whatwg#9198. Fixes whatwg#9468.

YusukeHirao mentioned this pull request Sep 18, 2023

Update Popover API markuplint/markuplint#1152

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve popover event handling in nested showing and hiding #9198

Improve popover event handling in nested showing and hiding #9198

josepharhar commented Apr 21, 2023 •

edited by pr-preview bot

Loading

annevk commented Apr 24, 2023

josepharhar commented Apr 25, 2023

josepharhar commented May 11, 2023

nt1m commented May 15, 2023

emilio commented May 22, 2023

cathiechen commented May 22, 2023

nt1m commented Jun 6, 2023

annevk left a comment

annevk Jun 8, 2023

annevk Jun 8, 2023

annevk commented Jun 8, 2023

cathiechen commented Jun 8, 2023

Improve popover event handling in nested showing and hiding #9198

Improve popover event handling in nested showing and hiding #9198

Conversation

josepharhar commented Apr 21, 2023 • edited by pr-preview bot Loading

annevk commented Apr 24, 2023

josepharhar commented Apr 25, 2023

josepharhar commented May 11, 2023

nt1m commented May 15, 2023

emilio commented May 22, 2023

cathiechen commented May 22, 2023

nt1m commented Jun 6, 2023

annevk left a comment

Choose a reason for hiding this comment

annevk Jun 8, 2023

Choose a reason for hiding this comment

annevk Jun 8, 2023

Choose a reason for hiding this comment

annevk commented Jun 8, 2023

cathiechen commented Jun 8, 2023

josepharhar commented Apr 21, 2023 •

edited by pr-preview bot

Loading