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

Merge conflicting wp.editor objects into a single, non-conflicting module #33228

Merged
merged 13 commits into from
Jul 9, 2021

Conversation

adamziel
Copy link
Contributor

@adamziel adamziel commented Jul 6, 2021

Description

Solves #33203

Situation: packages/editor is exposed as window.wp.editor in wp-admin

Problem: there is quite some code expecting to see a different (legacy) object under window.wp.editor

Proposed solution: assign all the members of legacy window.wp.editor to the new window.wp.editor like this:

'Object.assign(window.wp.editor, window.wp.oldEditor);',

This PR is a Gutenberg counterpart of WordPress/wordpress-develop#1481 in core

How has this been tested?

  1. Activate classic widgets plugins.
  2. Insert text widget
  3. Add some text to widget.
  4. Deactivate classic widgets plugins.
  5. Go to widget screen.
  6. There is an error message if this PR is not applied.
  7. There are no error messages if this PR is applied.

Screenshots

124498441-3f40df80-ddb4-11eb-99e1-581b287f96de

(Credits for the screenshot and the test plan to @spacedmonkey)

Types of changes

Bug fix (non-breaking change which fixes an issue)

@adamziel adamziel self-assigned this Jul 6, 2021
@adamziel adamziel added [Block] Legacy Widget Affects the Legacy Widget Block - used for displaying Classic Widgets [Feature] Widgets Screen The block-based screen that replaced widgets.php. [Feature] Widgets Customizer Ability to add and edit blocks in Customize → Widgets. [Package] Edit Widgets /packages/edit-widgets [Package] Editor /packages/editor labels Jul 6, 2021
@adamziel adamziel changed the title Fix/tinymce conflict on window wp editor Merge conflicting wp.editor objects into a single, non-conflicting module Jul 6, 2021
@github-actions
Copy link

github-actions bot commented Jul 6, 2021

Size Change: +4.77 kB (0%)

Total Size: 1.07 MB

Filename Size Change
build/a11y/index.min.js 1.12 kB -1 B (0%)
build/admin-manifest/index.min.js 1.41 kB -4 B (0%)
build/annotations/index.min.js 2.93 kB +4 B (0%)
build/autop/index.min.js 2.28 kB +1 B (0%)
build/block-directory/index.min.js 6.61 kB -2 B (0%)
build/block-editor/index.min.js 126 kB +5.43 kB (+5%) 🔍
build/block-library/blocks/file/view.min.js 780 B +1 B (0%)
build/block-library/blocks/navigation-link/editor-rtl.css 474 B -159 B (-25%) 🎉
build/block-library/blocks/navigation-link/editor.css 473 B -161 B (-25%) 🎉
build/block-library/editor-rtl.css 9.85 kB -1 B (0%)
build/block-library/editor.css 9.84 kB -1 B (0%)
build/block-library/index.min.js 146 kB -25 B (0%)
build/block-serialization-default-parser/index.min.js 1.3 kB +1 B (0%)
build/blocks/index.min.js 47.2 kB +23 B (0%)
build/components/index.min.js 194 kB +39 B (0%)
build/compose/index.min.js 10.2 kB -3 B (0%)
build/core-data/index.min.js 12.4 kB -60 B (0%)
build/customize-widgets/index.min.js 10.3 kB -4 B (0%)
build/data/index.min.js 7.22 kB -1 B (0%)
build/date/index.min.js 31.8 kB +1 B (0%)
build/deprecated/index.min.js 738 B -1 B (0%)
build/dom-ready/index.min.js 576 B -1 B (0%)
build/edit-navigation/index.min.js 13.8 kB -85 B (-1%)
build/edit-post/index.min.js 58.6 kB -53 B (0%)
build/edit-site/index.min.js 25.9 kB -64 B (0%)
build/edit-widgets/index.min.js 16.1 kB -67 B (0%)
build/editor/index.min.js 38.6 kB -52 B (0%)
build/element/index.min.js 3.44 kB -1 B (0%)
build/format-library/index.min.js 5.71 kB -7 B (0%)
build/hooks/index.min.js 1.76 kB -1 B (0%)
build/html-entities/index.min.js 628 B -1 B (0%)
build/list-reusable-blocks/index.min.js 2.07 kB +1 B (0%)
build/media-utils/index.min.js 3.08 kB +2 B (0%)
build/notices/index.min.js 1.07 kB -1 B (0%)
build/plugins/index.min.js 1.99 kB +2 B (0%)
build/priority-queue/index.min.js 790 B -1 B (0%)
build/react-i18n/index.min.js 924 B -1 B (0%)
build/url/index.min.js 1.95 kB +1 B (0%)
build/viewport/index.min.js 1.28 kB -1 B (0%)
build/warning/index.min.js 1.16 kB +24 B (+2%)
build/widgets/index.min.js 6.45 kB -1 B (0%)
ℹ️ View Unchanged
Filename Size
build/api-fetch/index.min.js 2.44 kB
build/blob/index.min.js 673 B
build/block-directory/style-rtl.css 1.02 kB
build/block-directory/style.css 1.02 kB
build/block-editor/style-rtl.css 14 kB
build/block-editor/style.css 13.9 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 475 B
build/block-library/blocks/columns/style.css 476 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/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/style-rtl.css 94 B
build/block-library/blocks/navigation-link/style.css 94 B
build/block-library/blocks/navigation/editor-rtl.css 1.69 kB
build/block-library/blocks/navigation/editor.css 1.69 kB
build/block-library/blocks/navigation/style-rtl.css 1.65 kB
build/block-library/blocks/navigation/style.css 1.65 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 465 B
build/block-library/blocks/site-logo/editor.css 465 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/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-spec-parser/index.min.js 3.06 kB
build/components/style-rtl.css 16.1 kB
build/components/style.css 16.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 830 B
build/dom/index.min.js 4.66 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/style-rtl.css 7.25 kB
build/edit-post/style.css 7.24 kB
build/edit-site/style-rtl.css 5.04 kB
build/edit-site/style.css 5.03 kB
build/edit-widgets/style-rtl.css 3.88 kB
build/edit-widgets/style.css 3.89 kB
build/editor/style-rtl.css 3.88 kB
build/editor/style.css 3.88 kB
build/escape-html/index.min.js 739 B
build/format-library/style-rtl.css 668 B
build/format-library/style.css 669 B
build/i18n/index.min.js 3.73 kB
build/is-shallow-equal/index.min.js 709 B
build/keyboard-shortcuts/index.min.js 1.74 kB
build/keycodes/index.min.js 1.43 kB
build/list-reusable-blocks/style-rtl.css 842 B
build/list-reusable-blocks/style.css 842 B
build/nux/index.min.js 2.31 kB
build/nux/style-rtl.css 745 B
build/nux/style.css 742 B
build/primitives/index.min.js 1.03 kB
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.64 kB
build/shortcode/index.min.js 1.68 kB
build/token-list/index.min.js 847 B
build/widgets/style-rtl.css 1.04 kB
build/widgets/style.css 1.05 kB
build/wordcount/index.min.js 1.24 kB

compressed-size-action

@spacedmonkey
Copy link
Member

This will like fix other issues, where other plugins have called wp.editor.initialize.
See https://wpdirectory.net/search/01F9YAKV5H5WWHMADCK7VDDA1T

@kevin940726
Copy link
Member

kevin940726 commented Jul 7, 2021

I fear that this approach is not ideal. If I'm understanding this correctly, it basically means that the gutenberg editor package will depend on oldEditor in core. We can't have initialize as a export member in the editor package anymore for instance.

I wonder, instead, if we could monkey-patch/proxy wp.editor somehow when it's running inside a legacy widget? Only then we'll return wp.oldEditor. Note that it should also take asynchronous code into account. Not sure if it'll work or if it can be done though.

// Problem: there is quite some code expecting another, legacy object available under window.wp.editor
// Solution: export all the members of legacy window.wp.editor from this new module to maintain backward compatibility
// For more context, see https://github.com/WordPress/gutenberg/issues/33203
export const { autop, removep, initialize, remove, getContent } =
Copy link
Member

Choose a reason for hiding this comment

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

I didn't even know this is valid JS 🤯

@noisysocks
Copy link
Member

It's regrettable that we ever added @wordpress/editor since that name was already "taken" 😀

My only issue with this approach is that it means we're adding five functions to @wordpress/editor which we'll need to support forever. Maybe that's OK, I'm not sure. Perhaps we should fire deprecated() and encourage folks to use wp.classicEditor instead? I'm not sure. What do you think @youknowriad?

@noisysocks
Copy link
Member

There’s also this similar issue with the wp-edit-post style dep: https://core.trac.wordpress.org/ticket/53569

Makes me wonder if a “fix” could be to add code to Core which fires off doing_it_wrong() if you enqueue wp-editor or wp-edit-post in the widgets screen.

@adamziel
Copy link
Contributor Author

adamziel commented Jul 7, 2021

Perhaps we should fire deprecated() and encourage folks to use wp.classicEditor instead?
Makes me wonder if a “fix” could be to add code to Core which fires off doing_it_wrong() if you enqueue wp-editor or wp-edit-post in the widgets screen.

Both deprecated and doing_it_wrong sounds great to me, let's absolutely add that. Still, we need to make sure the existing code keeps working for another version or two as we start deprecating things.

A slightly different approach here would be to add another inline script like the one that creates wp.oldEditor:

    // Loading the old editor and its config to ensure the classic block works as expected.
    $scripts->add_inline_script(
        'editor',
        'window.wp.oldEditor = window.wp.editor;',
        'after'

And use it to bolt these five functions on top of the “new” wp.editor immediately after it’s loaded.

Copy link
Contributor

@youknowriad youknowriad left a comment

Choose a reason for hiding this comment

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

Feels like this should be an inline script to wp-editor instead of something in the package directly because it's very WP specific, wdyt?

@adamziel
Copy link
Contributor Author

adamziel commented Jul 7, 2021

Yup, let's try that – I'll publish a new PR soon

@adamziel
Copy link
Contributor Author

adamziel commented Jul 7, 2021

Here's the inline-script approach: WordPress/wordpress-develop#1481

@youknowriad
Copy link
Contributor

@adamziel that looks good to me, should we do the same in Gutenberg.

@adamziel
Copy link
Contributor Author

adamziel commented Jul 7, 2021

@youknowriad my intuition says no because maybe then we'd run both code paths and end up having two inline scripts enqueued; also in Gutenberg there's no window.wp.oldEditor = window.wp.editor; assignment, that part (and the original wp.editor) seems to be specific to core. What do you think?

@youknowriad
Copy link
Contributor

@adamziel we do support WP 5.7 and WP 5.6 for now in Gutenberg though and when 5.8 get released, we'd shift to support 5.7 and 5.8.

@adamziel
Copy link
Contributor Author

adamziel commented Jul 7, 2021

@youknowriad Good point! I'll start a new PR for Gutenberg then

@adamziel adamziel force-pushed the fix/tinymce-conflict-on-window-wp-editor branch from 795da26 to 59db57c Compare July 8, 2021 12:11
expect( content ).toMatchInlineSnapshot(
`"<p>Typing in a metabox</p>"`
);
expect( content ).toBe( 'Typing in a metabox' );
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this change expected, I feel this test has been updated back and forth several times already in the last couple releases, do we understand why this change is needed?

Copy link
Contributor Author

@adamziel adamziel Jul 9, 2021

Choose a reason for hiding this comment

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

It turns out that TinyMCE's WordPress plugin does the following:
https://github.com/WordPress/wordpress-develop/blob/2382765afa36e10bf3c74420024ad4e85763a47c/src/js/_enqueues/vendor/tinymce/plugins/wordpress/plugin.js#L15
https://github.com/WordPress/wordpress-develop/blob/2382765afa36e10bf3c74420024ad4e85763a47c/src/js/_enqueues/vendor/tinymce/plugins/wordpress/plugin.js#L132-L133
https://github.com/WordPress/wordpress-develop/blob/2382765afa36e10bf3c74420024ad4e85763a47c/src/js/_enqueues/vendor/tinymce/plugins/wordpress/plugin.js#L593-L609

hasWpautop = ( wp && wp.editor && wp.editor.autop && editor.getParam( 'wpautop', true ) ),
editor.on( 'BeforeSetContent', function( event ) {
	// ...
	if ( hasWpautop ) {
	    event.content = wp.editor.autop( event.content );
	} else {
	    // Prevent creation of paragraphs out of multiple HTML comments
	    event.content = event.content.replace( /-->\s+<!--/g, '--><!--' );
	}
});

// ...

editor.on( 'SaveContent', function( event ) {
	// ...
	// Keep empty paragraphs :(
	event.content = event.content.replace( /<p>(?:<br ?\/?>|\u00a0|\uFEFF| )*<\/p>/g, '<p>&nbsp;</p>' );

	if ( hasWpautop ) {
		event.content = wp.editor.removep( event.content );
	} else {
		// Restore formatting of block boundaries.
		event.content = event.content.replace( /-->\s*<!-- wp:/g, '-->\n\n<!-- wp:' );
	}
});

So:

  • if Object.assign( window.wp.editor, window.wp.oldEditor ); is in place, then hasWpauto is set to true by editor.getParam( 'wpautop', true ); .
    • When I switch from HTML to visual mode of TinyMCE, event.content is wrapped in a <p>
    • When I switch back from the visual mode to the HTML mode, SaveContent is dispatched and it calls wp.editor.removep which removes the <p> tags.
  • If Object.assign thing is not in place, then hasWpauto is set to false.
    • When I switch from HTML to visual mode of TinyMCE, event.content is not wrapped in a <p> but TinyMCE wraps it anyway.
    • When I switch back from the visual mode to the HTML mode, SaveContent is dispatched and it does not call wp.editor.removep so the <p> tags are not automatically removed at that stage.

Now, for the purposes of this test, we explicitly set wpautop to true in the test plugin here:

This means that we do not want to see the the <p> tags in the editor. I added some documentation to that test to explain how to proceed in case it flips back again at some point @youknowriad .

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for the detailed explanation :)

Copy link
Member

Choose a reason for hiding this comment

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

Good one @adamziel, this test should be finally reliable 👍🏻

@noisysocks noisysocks 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 9, 2021
@noisysocks
Copy link
Member

We don't need to backport this PR as there's already a commit awaiting backport here: https://core.trac.wordpress.org/ticket/53437

@youknowriad youknowriad merged commit b403b97 into trunk Jul 9, 2021
@youknowriad youknowriad deleted the fix/tinymce-conflict-on-window-wp-editor branch July 9, 2021 12:37
@github-actions github-actions bot added this to the Gutenberg 11.1 milestone Jul 9, 2021
@youknowriad
Copy link
Contributor

@noisysocks going to backport this one because of issues in e2e tests in wp/5.8 branch

sarayourfriend pushed a commit that referenced this pull request Jul 15, 2021

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
…module (#33228)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Legacy Widget Affects the Legacy Widget Block - used for displaying Classic Widgets [Feature] Widgets Customizer Ability to add and edit blocks in Customize → Widgets. [Feature] Widgets Screen The block-based screen that replaced widgets.php. [Package] Edit Widgets /packages/edit-widgets [Package] Editor /packages/editor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants