Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Safari: see if compositing layer size is more reasonable when position fixed divs are not inserted into content #32824

Merged
merged 5 commits into from
Jun 29, 2021

Conversation

gwwar
Copy link
Contributor

@gwwar gwwar commented Jun 18, 2021

Background

In Safari, when we scroll we can notice a few things happening in some cases during scroll:

  • Text flickering on the cover block
  • Background colors that bleed from .edit-post-layout .interface-interface-skeleton__content. This appears as a flash of gray, and is normally used as a background color when previewing in tablet or mobile mode from the preview dropdown. Fixed by Avoid flash of background color when scrolling in safari #32747
text-flicker.mp4

Changes In this PR

In this branch we experiment with keeping a large compositing layer a more reasonable size. This appears to get rid of the flickering text.

Layer size in trunk Layer size in Branch
Screen Shot 2021-06-23 at 10 53 11 AM Screen Shot 2021-06-23 at 10 51 49 AM

Potential Memory Savings:

Memory use is going to depend on post content plus browser window size, but we should see roughly around a 30% reduction ✨

Here's a quick example of a very large window, the post content isn't that long but contains two galleries:

trunk ~150-170MB branch ~ 110 - 120MB
Screen Shot 2021-06-23 at 2 27 45 PM Screen Shot 2021-06-23 at 2 29 21 PM

With position:fixed rule removed from useTabNav:

noflicker.mp4

Testing Instructions

  • Create a post with enough content to scroll in the editor. Try adding a few images with captions in addition to a paragraph.
  • In Safari try focusing on an image. The caption text should not flicker on scroll or when block option menus are open
  • In Chrome, Safari, and FF verify that when tabbing from the editor pane no scroll occurs
  • Do a shift-tab back. We shouldn't see the editor post-content pane scroll when this happens

Isolated Test Case

As a general note, these Safari graphical glitches are dependant on one's GPU memory and how large of viewport folks are trying to power. It's a lot easier for example to see these errors when viewing this on a monitor (in a high resolution) with an older machine.

One other thing I noticed in Gutenberg was that one of the layers are much bigger in size than expected. Ideally it should be about the size of the scrollable pane if we didn't explicitly set some compositing reasons.

122439481-89226c80-cf50-11eb-9f16-7a74bb6e80bb

So in this test case I tried to isolate why one of the compositing layers is so large. I traced it down to <div tabindex="0" style="position: fixed;"></div> being inserted. This is added by the writing flow component

const before = (
<div
ref={ focusCaptureBeforeRef }
tabIndex={ focusCaptureTabIndex }
onFocus={ onFocusCapture }
style={ PREVENT_SCROLL_ON_FOCUS }
/>
);
const after = (
<div
ref={ focusCaptureAfterRef }
tabIndex={ focusCaptureTabIndex }
onFocus={ onFocusCapture }
style={ PREVENT_SCROLL_ON_FOCUS }
/>
);

Here's another isolated test case for that.

As a side note, changes here also reduces memory usage. With the scrollable browser pane at ~1584px x 588px with the test case, there around a 50MB difference in memory usage.

basecase.mp4

Other useful Debugging Notes:

  • --webkit-overflow-scrolling:touch is added by default in Safari when there’s a scroll area, such as (overflow:scroll or overflow:auto)
  • We cannot unset --webkit-overflow-scrolling 😭. (This is shown as an invalid property in dev tools, but will still show up as a compositing reason in the layers tab).
  • --webkit-overflow-scrolling:touch is a compositing reason. It creates a new layer to be sent off to the GPU to render. This is fine, but when this layer gets too large(and likely hits GPU memory limits, we see glitches like flicking text and incorrect ordering of elements.
  • With the same content and code, we can trigger or not trigger these glitches based on how large the compositing layer is. For example by resizing the browser window smaller, or changing the font size.

@gwwar gwwar requested review from jasmussen and ellatrix June 18, 2021 18:23
@github-actions
Copy link

github-actions bot commented Jun 18, 2021

Size Change: +100 B (0%)

Total Size: 1.05 MB

Filename Size Change
build/block-editor/index.min.js 120 kB +100 B (0%)
ℹ️ View Unchanged
Filename Size
build/a11y/index.min.js 1.12 kB
build/annotations/index.min.js 2.93 kB
build/api-fetch/index.min.js 2.44 kB
build/autop/index.min.js 2.28 kB
build/blob/index.min.js 672 B
build/block-directory/index.min.js 6.62 kB
build/block-directory/style-rtl.css 1.02 kB
build/block-directory/style.css 1.02 kB
build/block-editor/style-rtl.css 13.8 kB
build/block-editor/style.css 13.8 kB
build/block-library/blocks/archives/editor-rtl.css 61 B
build/block-library/blocks/archives/editor.css 60 B
build/block-library/blocks/archives/style-rtl.css 65 B
build/block-library/blocks/archives/style.css 65 B
build/block-library/blocks/audio/editor-rtl.css 58 B
build/block-library/blocks/audio/editor.css 58 B
build/block-library/blocks/audio/style-rtl.css 112 B
build/block-library/blocks/audio/style.css 112 B
build/block-library/blocks/audio/theme-rtl.css 125 B
build/block-library/blocks/audio/theme.css 125 B
build/block-library/blocks/block/editor-rtl.css 161 B
build/block-library/blocks/block/editor.css 161 B
build/block-library/blocks/button/editor-rtl.css 475 B
build/block-library/blocks/button/editor.css 474 B
build/block-library/blocks/button/style-rtl.css 603 B
build/block-library/blocks/button/style.css 602 B
build/block-library/blocks/buttons/editor-rtl.css 315 B
build/block-library/blocks/buttons/editor.css 315 B
build/block-library/blocks/buttons/style-rtl.css 375 B
build/block-library/blocks/buttons/style.css 375 B
build/block-library/blocks/calendar/style-rtl.css 208 B
build/block-library/blocks/calendar/style.css 208 B
build/block-library/blocks/categories/editor-rtl.css 84 B
build/block-library/blocks/categories/editor.css 83 B
build/block-library/blocks/categories/style-rtl.css 79 B
build/block-library/blocks/categories/style.css 79 B
build/block-library/blocks/code/style-rtl.css 90 B
build/block-library/blocks/code/style.css 90 B
build/block-library/blocks/code/theme-rtl.css 131 B
build/block-library/blocks/code/theme.css 131 B
build/block-library/blocks/columns/editor-rtl.css 190 B
build/block-library/blocks/columns/editor.css 190 B
build/block-library/blocks/columns/style-rtl.css 422 B
build/block-library/blocks/columns/style.css 422 B
build/block-library/blocks/cover/editor-rtl.css 670 B
build/block-library/blocks/cover/editor.css 670 B
build/block-library/blocks/cover/style-rtl.css 1.22 kB
build/block-library/blocks/cover/style.css 1.23 kB
build/block-library/blocks/embed/editor-rtl.css 486 B
build/block-library/blocks/embed/editor.css 486 B
build/block-library/blocks/embed/style-rtl.css 401 B
build/block-library/blocks/embed/style.css 400 B
build/block-library/blocks/embed/theme-rtl.css 124 B
build/block-library/blocks/embed/theme.css 124 B
build/block-library/blocks/file/editor-rtl.css 301 B
build/block-library/blocks/file/editor.css 300 B
build/block-library/blocks/file/style-rtl.css 255 B
build/block-library/blocks/file/style.css 255 B
build/block-library/blocks/file/view.min.js 780 B
build/block-library/blocks/freeform/editor-rtl.css 2.44 kB
build/block-library/blocks/freeform/editor.css 2.44 kB
build/block-library/blocks/gallery/editor-rtl.css 704 B
build/block-library/blocks/gallery/editor.css 705 B
build/block-library/blocks/gallery/style-rtl.css 1.06 kB
build/block-library/blocks/gallery/style.css 1.06 kB
build/block-library/blocks/gallery/theme-rtl.css 122 B
build/block-library/blocks/gallery/theme.css 122 B
build/block-library/blocks/group/editor-rtl.css 160 B
build/block-library/blocks/group/editor.css 160 B
build/block-library/blocks/group/style-rtl.css 57 B
build/block-library/blocks/group/style.css 57 B
build/block-library/blocks/group/theme-rtl.css 93 B
build/block-library/blocks/group/theme.css 93 B
build/block-library/blocks/heading/editor-rtl.css 152 B
build/block-library/blocks/heading/editor.css 152 B
build/block-library/blocks/heading/style-rtl.css 76 B
build/block-library/blocks/heading/style.css 76 B
build/block-library/blocks/home-link/style-rtl.css 259 B
build/block-library/blocks/home-link/style.css 259 B
build/block-library/blocks/html/editor-rtl.css 281 B
build/block-library/blocks/html/editor.css 281 B
build/block-library/blocks/image/editor-rtl.css 729 B
build/block-library/blocks/image/editor.css 727 B
build/block-library/blocks/image/style-rtl.css 481 B
build/block-library/blocks/image/style.css 485 B
build/block-library/blocks/image/theme-rtl.css 124 B
build/block-library/blocks/image/theme.css 124 B
build/block-library/blocks/latest-comments/style-rtl.css 286 B
build/block-library/blocks/latest-comments/style.css 286 B
build/block-library/blocks/latest-posts/editor-rtl.css 137 B
build/block-library/blocks/latest-posts/editor.css 137 B
build/block-library/blocks/latest-posts/style-rtl.css 534 B
build/block-library/blocks/latest-posts/style.css 532 B
build/block-library/blocks/list/style-rtl.css 63 B
build/block-library/blocks/list/style.css 63 B
build/block-library/blocks/media-text/editor-rtl.css 263 B
build/block-library/blocks/media-text/editor.css 264 B
build/block-library/blocks/media-text/style-rtl.css 492 B
build/block-library/blocks/media-text/style.css 489 B
build/block-library/blocks/more/editor-rtl.css 434 B
build/block-library/blocks/more/editor.css 434 B
build/block-library/blocks/navigation-link/editor-rtl.css 633 B
build/block-library/blocks/navigation-link/editor.css 634 B
build/block-library/blocks/navigation-link/style-rtl.css 94 B
build/block-library/blocks/navigation-link/style.css 94 B
build/block-library/blocks/navigation/editor-rtl.css 1.55 kB
build/block-library/blocks/navigation/editor.css 1.55 kB
build/block-library/blocks/navigation/style-rtl.css 1.63 kB
build/block-library/blocks/navigation/style.css 1.63 kB
build/block-library/blocks/navigation/view.min.js 2.87 kB
build/block-library/blocks/nextpage/editor-rtl.css 395 B
build/block-library/blocks/nextpage/editor.css 395 B
build/block-library/blocks/page-list/editor-rtl.css 310 B
build/block-library/blocks/page-list/editor.css 311 B
build/block-library/blocks/page-list/style-rtl.css 240 B
build/block-library/blocks/page-list/style.css 240 B
build/block-library/blocks/paragraph/editor-rtl.css 157 B
build/block-library/blocks/paragraph/editor.css 157 B
build/block-library/blocks/paragraph/style-rtl.css 247 B
build/block-library/blocks/paragraph/style.css 248 B
build/block-library/blocks/post-author/editor-rtl.css 209 B
build/block-library/blocks/post-author/editor.css 209 B
build/block-library/blocks/post-author/style-rtl.css 183 B
build/block-library/blocks/post-author/style.css 184 B
build/block-library/blocks/post-comments-form/style-rtl.css 140 B
build/block-library/blocks/post-comments-form/style.css 140 B
build/block-library/blocks/post-comments/style-rtl.css 360 B
build/block-library/blocks/post-comments/style.css 359 B
build/block-library/blocks/post-content/editor-rtl.css 139 B
build/block-library/blocks/post-content/editor.css 139 B
build/block-library/blocks/post-excerpt/editor-rtl.css 73 B
build/block-library/blocks/post-excerpt/editor.css 73 B
build/block-library/blocks/post-excerpt/style-rtl.css 69 B
build/block-library/blocks/post-excerpt/style.css 69 B
build/block-library/blocks/post-featured-image/editor-rtl.css 338 B
build/block-library/blocks/post-featured-image/editor.css 338 B
build/block-library/blocks/post-featured-image/style-rtl.css 141 B
build/block-library/blocks/post-featured-image/style.css 141 B
build/block-library/blocks/post-template/editor-rtl.css 100 B
build/block-library/blocks/post-template/editor.css 99 B
build/block-library/blocks/post-template/style-rtl.css 379 B
build/block-library/blocks/post-template/style.css 380 B
build/block-library/blocks/post-title/style-rtl.css 60 B
build/block-library/blocks/post-title/style.css 60 B
build/block-library/blocks/preformatted/style-rtl.css 103 B
build/block-library/blocks/preformatted/style.css 103 B
build/block-library/blocks/pullquote/editor-rtl.css 183 B
build/block-library/blocks/pullquote/editor.css 183 B
build/block-library/blocks/pullquote/style-rtl.css 318 B
build/block-library/blocks/pullquote/style.css 318 B
build/block-library/blocks/pullquote/theme-rtl.css 169 B
build/block-library/blocks/pullquote/theme.css 169 B
build/block-library/blocks/query-pagination-numbers/editor-rtl.css 122 B
build/block-library/blocks/query-pagination-numbers/editor.css 121 B
build/block-library/blocks/query-pagination/editor-rtl.css 270 B
build/block-library/blocks/query-pagination/editor.css 262 B
build/block-library/blocks/query-pagination/style-rtl.css 168 B
build/block-library/blocks/query-pagination/style.css 168 B
build/block-library/blocks/query-title/editor-rtl.css 86 B
build/block-library/blocks/query-title/editor.css 86 B
build/block-library/blocks/query/editor-rtl.css 131 B
build/block-library/blocks/query/editor.css 132 B
build/block-library/blocks/quote/style-rtl.css 169 B
build/block-library/blocks/quote/style.css 169 B
build/block-library/blocks/quote/theme-rtl.css 221 B
build/block-library/blocks/quote/theme.css 221 B
build/block-library/blocks/rss/editor-rtl.css 201 B
build/block-library/blocks/rss/editor.css 202 B
build/block-library/blocks/rss/style-rtl.css 290 B
build/block-library/blocks/rss/style.css 290 B
build/block-library/blocks/search/editor-rtl.css 211 B
build/block-library/blocks/search/editor.css 211 B
build/block-library/blocks/search/style-rtl.css 359 B
build/block-library/blocks/search/style.css 362 B
build/block-library/blocks/search/theme-rtl.css 64 B
build/block-library/blocks/search/theme.css 64 B
build/block-library/blocks/separator/editor-rtl.css 99 B
build/block-library/blocks/separator/editor.css 99 B
build/block-library/blocks/separator/style-rtl.css 251 B
build/block-library/blocks/separator/style.css 251 B
build/block-library/blocks/separator/theme-rtl.css 172 B
build/block-library/blocks/separator/theme.css 172 B
build/block-library/blocks/shortcode/editor-rtl.css 476 B
build/block-library/blocks/shortcode/editor.css 476 B
build/block-library/blocks/site-logo/editor-rtl.css 646 B
build/block-library/blocks/site-logo/editor.css 647 B
build/block-library/blocks/site-logo/style-rtl.css 154 B
build/block-library/blocks/site-logo/style.css 154 B
build/block-library/blocks/site-tagline/editor-rtl.css 87 B
build/block-library/blocks/site-tagline/editor.css 87 B
build/block-library/blocks/site-title/editor-rtl.css 85 B
build/block-library/blocks/site-title/editor.css 85 B
build/block-library/blocks/social-link/editor-rtl.css 164 B
build/block-library/blocks/social-link/editor.css 165 B
build/block-library/blocks/social-links/editor-rtl.css 800 B
build/block-library/blocks/social-links/editor.css 799 B
build/block-library/blocks/social-links/style-rtl.css 1.34 kB
build/block-library/blocks/social-links/style.css 1.34 kB
build/block-library/blocks/spacer/editor-rtl.css 308 B
build/block-library/blocks/spacer/editor.css 308 B
build/block-library/blocks/spacer/style-rtl.css 48 B
build/block-library/blocks/spacer/style.css 48 B
build/block-library/blocks/table/editor-rtl.css 478 B
build/block-library/blocks/table/editor.css 478 B
build/block-library/blocks/table/style-rtl.css 480 B
build/block-library/blocks/table/style.css 480 B
build/block-library/blocks/table/theme-rtl.css 188 B
build/block-library/blocks/table/theme.css 188 B
build/block-library/blocks/tag-cloud/editor-rtl.css 118 B
build/block-library/blocks/tag-cloud/editor.css 118 B
build/block-library/blocks/tag-cloud/style-rtl.css 94 B
build/block-library/blocks/tag-cloud/style.css 94 B
build/block-library/blocks/template-part/editor-rtl.css 551 B
build/block-library/blocks/template-part/editor.css 550 B
build/block-library/blocks/template-part/theme-rtl.css 101 B
build/block-library/blocks/template-part/theme.css 101 B
build/block-library/blocks/term-description/editor-rtl.css 90 B
build/block-library/blocks/term-description/editor.css 90 B
build/block-library/blocks/text-columns/editor-rtl.css 95 B
build/block-library/blocks/text-columns/editor.css 95 B
build/block-library/blocks/text-columns/style-rtl.css 166 B
build/block-library/blocks/text-columns/style.css 166 B
build/block-library/blocks/verse/style-rtl.css 87 B
build/block-library/blocks/verse/style.css 87 B
build/block-library/blocks/video/editor-rtl.css 569 B
build/block-library/blocks/video/editor.css 570 B
build/block-library/blocks/video/style-rtl.css 173 B
build/block-library/blocks/video/style.css 173 B
build/block-library/blocks/video/theme-rtl.css 124 B
build/block-library/blocks/video/theme.css 124 B
build/block-library/common-rtl.css 1.29 kB
build/block-library/common.css 1.29 kB
build/block-library/editor-rtl.css 9.73 kB
build/block-library/editor.css 9.73 kB
build/block-library/index.min.js 145 kB
build/block-library/reset-rtl.css 514 B
build/block-library/reset.css 515 B
build/block-library/style-rtl.css 10.2 kB
build/block-library/style.css 10.2 kB
build/block-library/theme-rtl.css 692 B
build/block-library/theme.css 693 B
build/block-serialization-default-parser/index.min.js 1.29 kB
build/block-serialization-spec-parser/index.min.js 3.06 kB
build/blocks/index.min.js 47.3 kB
build/components/index.min.js 182 kB
build/components/style-rtl.css 15.8 kB
build/components/style.css 15.8 kB
build/compose/index.min.js 10.2 kB
build/core-data/index.min.js 12.4 kB
build/customize-widgets/index.min.js 10.1 kB
build/customize-widgets/style-rtl.css 1.48 kB
build/customize-widgets/style.css 1.48 kB
build/data-controls/index.min.js 828 B
build/data/index.min.js 7.23 kB
build/date/index.min.js 31.8 kB
build/deprecated/index.min.js 738 B
build/dom-ready/index.min.js 577 B
build/dom/index.min.js 4.62 kB
build/edit-navigation/index.min.js 13.9 kB
build/edit-navigation/style-rtl.css 3.12 kB
build/edit-navigation/style.css 3.12 kB
build/edit-post/classic-rtl.css 483 B
build/edit-post/classic.css 483 B
build/edit-post/index.min.js 58.7 kB
build/edit-post/style-rtl.css 7.29 kB
build/edit-post/style.css 7.28 kB
build/edit-site/index.min.js 25.9 kB
build/edit-site/style-rtl.css 4.99 kB
build/edit-site/style.css 4.98 kB
build/edit-widgets/index.min.js 16.1 kB
build/edit-widgets/style-rtl.css 3.88 kB
build/edit-widgets/style.css 3.88 kB
build/editor/index.min.js 38.6 kB
build/editor/style-rtl.css 3.88 kB
build/editor/style.css 3.88 kB
build/element/index.min.js 3.44 kB
build/escape-html/index.min.js 739 B
build/format-library/index.min.js 5.69 kB
build/format-library/style-rtl.css 668 B
build/format-library/style.css 669 B
build/hooks/index.min.js 1.76 kB
build/html-entities/index.min.js 628 B
build/i18n/index.min.js 3.73 kB
build/is-shallow-equal/index.min.js 710 B
build/keyboard-shortcuts/index.min.js 1.74 kB
build/keycodes/index.min.js 1.43 kB
build/list-reusable-blocks/index.min.js 2.07 kB
build/list-reusable-blocks/style-rtl.css 842 B
build/list-reusable-blocks/style.css 842 B
build/media-utils/index.min.js 3.08 kB
build/notices/index.min.js 1.07 kB
build/nux/index.min.js 2.31 kB
build/nux/style-rtl.css 745 B
build/nux/style.css 742 B
build/plugins/index.min.js 1.99 kB
build/primitives/index.min.js 1.03 kB
build/priority-queue/index.min.js 791 B
build/react-i18n/index.min.js 924 B
build/redux-routine/index.min.js 2.82 kB
build/reusable-blocks/index.min.js 2.56 kB
build/reusable-blocks/style-rtl.css 256 B
build/reusable-blocks/style.css 256 B
build/rich-text/index.min.js 10.6 kB
build/server-side-render/index.min.js 1.63 kB
build/shortcode/index.min.js 1.68 kB
build/token-list/index.min.js 848 B
build/url/index.min.js 1.95 kB
build/viewport/index.min.js 1.28 kB
build/warning/index.min.js 1.13 kB
build/widgets/index.min.js 6.23 kB
build/widgets/style-rtl.css 1 kB
build/widgets/style.css 1.01 kB
build/wordcount/index.min.js 1.24 kB

compressed-size-action

@gwwar
Copy link
Contributor Author

gwwar commented Jun 18, 2021

With changes here, we're seeing an interesting background color set on the scrollbar controls, when focusing on an image. It's coming from the same .edit-post-layout .interface-interface-skeleton__content background color rule.

As a note to myself, it might be good to see what's happening with dropzone divs on image focus.

Edit: The scrollbar color bleed is no longer seen with changes in #32747

background.scroll.flash.mp4

@gwwar
Copy link
Contributor Author

gwwar commented Jun 23, 2021

Looks like moving the background color to a non-composited layer did the trick to fix the background scrolling bleed in #32747

@gwwar
Copy link
Contributor Author

gwwar commented Jun 23, 2021

Rebased with trunk to pull in background scroll fixes

@gwwar gwwar changed the title Debug: see if compositing layer size is more reasonable when position fixed divs are not inserted into content Safari: see if compositing layer size is more reasonable when position fixed divs are not inserted into content Jun 23, 2021
@ellatrix
Copy link
Member

Here's the problem that the fixed position was addressing:

Before After
tab-before tab-after

Now it seems that somewhere we made a regression for reverse (upwards) tabbing. Because the inserter button is not position fixed, it doesn't work. But if we'd make it fixed, it should work.

I think we'll need to find an alternative fix to prevent scrolling when the focus capture element receives focus.

I'll have a quick look if I find a way.

@ellatrix
Copy link
Member

I added the preventScroll option. MDN says it doesn't work in Safari, but after testing I don't see any issues.

@gwwar
Copy link
Contributor Author

gwwar commented Jun 24, 2021

Nice @ellatrix, we're getting closer. I've confirmed that preventScroll works in Safari but It looks like in Chrome and FF we're scrolling on tab.

Safari

tab.and.shift.tab.mp4

Chrome

chrome.scroll.mp4

@gwwar gwwar marked this pull request as ready for review June 24, 2021 14:53
@ellatrix
Copy link
Member

@gwwar Yes, that's what I meant with my comment. Only reverse tab is broken right? The problem is the insertion button. It's broken in trunk too.

@gwwar
Copy link
Contributor Author

gwwar commented Jun 24, 2021

Going to rebase to pick up changes from trunk.

@ellatrix here's the regression I see in Chrome, basically with the sidebar pane open, tab into the sidebar, then tab back. We'll see scroll drop to the bottom of post-content

chromescroll.mp4

@gwwar
Copy link
Contributor Author

gwwar commented Jun 24, 2021

🤔 What's happening in Chrome/FF is that with shifttab back into the writing pane, the window scrolls down to the after div. I think we can't use any positioning tricks to make sure this is in the viewport without creating another compositing layer.

A couple of ideas:

  • Call lastFocus.current.scrollIntoView. This gets us somewhat close, but destroys any scroll offset
  • Keep track of scrollTop, before we tab out of view. This is kind of messy datawise.
  • add another onKeyDown listener to a higher element like window to similarly intercept and call focus( { preventScroll: true } )

@gwwar
Copy link
Contributor Author

gwwar commented Jun 24, 2021

Hmm, I'm not sure I like storing the scroll position, but here's an example in a71419e

Will look into a more general keypress handler tomorrow, unless you had other ideas @ellatrix

@gwwar
Copy link
Contributor Author

gwwar commented Jun 25, 2021

This one is ready for review.

I went ahead with a keypress handler approach, which I added in 24a6ded.

Basically when we detect that the next tabbable should be one of the focus capture divs, we intercept the event and call it with focus( { preventScroll: true } )

As Ella pointed out there's a next/back works okay but not back/next (eg shift tabbing into a header element, then back into the block list). The back/next appears to be an issue in trunk as well, so I'd recommend fixing that in a follow up.

fixed.mp4

Copy link
Member

@ellatrix ellatrix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, now this went from really simple to more complex. Is there really no other way we can fix this?

@gwwar
Copy link
Contributor Author

gwwar commented Jun 28, 2021

Hm, now this went from really simple to more complex. Is there really no other way we can fix this?

@ellatrix a couple options here:

  • If we don't mind some scroll jumping, https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView would be a one liner
  • We could look into refactoring the skeleton interface, but I think that'd be rather fragile. If any wrapper divs in the scrollable have position:relative a position:fixed div will create a large compositing layer.
  • Another thing we could do is further refine this keypress handler to a single global one (since annoyingly we can't disable the scroll behavior in onFocus)

@ellatrix
Copy link
Member

What I think we have to do (and I've talked about this with @jasmussen unrelated to this problem) is normalise the scroll container across different editor modes (normal, iframed, preview), which would be to make .editor-styles-wrapper scrollable if there is no iframe. Currently "normal" post editor (without iframe and no device preview) is the only mode that doesn't make the editor content wrapper scrollable, but instead the interface .interface-interface-skeleton__content. I think the only blocker here is the old meta boxes appearing at the bottom of the page.

I'll make a PR for this so we can discuss it. In the meantime I don't mind this as a temporary fix, if we intend to remove it later.

@gwwar
Copy link
Contributor Author

gwwar commented Jun 28, 2021

I'll make a PR for this so we can discuss it. In the meantime I don't mind this as a temporary fix, if we intend to remove it later.

@ellatrix nice, that sounds reasonable to me! Happy to help 🔍 work with y'all on scrollable options in the post-editor, and remove changes here once we have a more stable option.

I added the preventScroll option. MDN says it doesn't work in Safari, but after testing I don't see any issues.

As a fun aside: It also turns out that preventScroll was just recently implemented in Webkit so the MDN documentation is a bit behind. https://bugs.webkit.org/show_bug.cgi?id=178583

@jasmussen
Copy link
Contributor

I'm still seeing a really profoundly positive effect in Safari. @kjellr will be happy to note that the fixed position cover issue is also fixed by this one:

https://cloudup.com/cNHkj6hjstj

external link because the GIF was too big

I'm also happy to help debug any scroll issues in any new PRs.

@gwwar
Copy link
Contributor Author

gwwar commented Jun 28, 2021

If folks are comfortable with this as a temporary fix, this one still needs a ✅ before merge.

Copy link
Contributor

@jasmussen jasmussen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The benefits to this one are rather big, and since the code complexity is well documented, it feels worth it to land this for all the benefits it brings Safari users.

I'd love a final blessing from @ellatrix, and I'd also like to work with the both of you in the future to refactor this around the scroll container discussions brought up. In the mean time, this is a nice one. Thank you Kerry!

target === focusCaptureBeforeRef.current ||
target === focusCaptureAfterRef.current
) {
event.stopPropagation();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this needed at all? Does it work without it? Generally it's good to avoid stopping propagation.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! Testing this manually it looks like behavior is the same in Chrome/Safari/FF. Will see if I can get a green run on E2Es, there's been some instability in trunk in other unrelated tests.

@gwwar
Copy link
Contributor Author

gwwar commented Jun 29, 2021

Thanks for the reviews and collaboration @ellatrix @jasmussen !

@gwwar
Copy link
Contributor Author

gwwar commented Jul 2, 2021

I'm pretty sure this one is a variant of https://bugs.webkit.org/show_bug.cgi?id=202576

To see the old bad behavior in action checkout 4d0959e, insert a cover block, set the image and add some text, then scroll.

The Ingredients

  • We have a resize listener which inserts an iframe with z-index of -1 for any inserter popover.
    import useResizeAware from 'react-resize-aware';
  • There were two position:fixed divs which created a large compositing layer on the block list which other layers intersect (These divs used to help prevent the scrollable panes from scrolling on tab)

See how scrolling creates a new compositing layer:

scrolling.mp4
  • With that fixed div + popover, scrolling down the page, we create another compositing layer on block list. Doing so causes text to order improperly for our use case.
  • This is not dependant on images! Here's a video of an experimental branch that pares down the cover block to just a paragraph and text:
noimage.mp4

Things that fix this independently:

  • Removing the iframe resizers from use-resize-observer
  • Removing the position fixed divs (which we did in this PR). (this makes it so that block list cannot intersect with the popover div, and turn into a compositing layer).
  • Setting an opacity on the cover block like .999. I'm thinking this would force squash/reorder layers

@gwwar
Copy link
Contributor Author

gwwar commented Jul 4, 2021

🎉 I finally isolated this to a simplified case:
See https://gist.github.com/gwwar/4bcea305ff8fb2b4ede025c174a293bf or https://codepen.io/gwwar/pen/dyWYdmg

To recreate this, it does need both fixed divs, the iframe, and some flex styles

Should look like this in Safari with the bad behavior:

flickeringtext.mp4

@jasmussen
Copy link
Contributor

I can consistenly reproduce that as well. Incredible sleuthing!

@youknowriad youknowriad added the Backport to WP 6.7 Beta/RC Pull request that needs to be backported to the WordPress major release that's currently in beta label Jul 6, 2021
@gwwar
Copy link
Contributor Author

gwwar commented Jul 6, 2021

I filed https://bugs.webkit.org/show_bug.cgi?id=227705 for this one

youknowriad pushed a commit that referenced this pull request Jul 12, 2021
…n fixed divs are not inserted into content (#32824)

* Safari: remove position:fixed div in scrollable content so compositing layers are of more reasonable size

* Prevent scroll after focusing focus capture element

* Prevent scrolling when tabbing back to a focus capture div

Co-authored-by: Ella van Durpe <ella@vandurpe.com>
@youknowriad youknowriad removed the Backport to WP 6.7 Beta/RC Pull request that needs to be backported to the WordPress major release that's currently in beta label Jul 12, 2021
youknowriad pushed a commit that referenced this pull request Jul 13, 2021
…n fixed divs are not inserted into content (#32824)

* Safari: remove position:fixed div in scrollable content so compositing layers are of more reasonable size

* Prevent scroll after focusing focus capture element

* Prevent scrolling when tabbing back to a focus capture div

Co-authored-by: Ella van Durpe <ella@vandurpe.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants