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

Edit Site: Avoid dirtying un-customized templates on first load. #22876

Merged

Conversation

epiqueras
Copy link
Contributor

Description

This PR stops uncustomized templates from becoming dirty just by being loaded in the site editor. It does this by ensuring template parts don't persist a post ID unless they've been edited, and by deferring the site editor's initial status and title template edits to the entities saved states callback, which is now called right before saving.

How has this been tested?

It was verified that loading the site editor on a template without saved customizations, that contains template parts, does not make it dirty.

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR.

@epiqueras epiqueras added [Type] Bug An existing feature does not function as intended [Feature] Full Site Editing labels Jun 4, 2020
@epiqueras epiqueras self-assigned this Jun 4, 2020
@github-actions
Copy link

github-actions bot commented Jun 4, 2020

Size Change: +816 B (0%)

Total Size: 1.12 MB

Filename Size Change
build/block-editor/index.js 106 kB -61 B (0%)
build/block-editor/style-rtl.css 11.4 kB +12 B (0%)
build/block-editor/style.css 11.4 kB +10 B (0%)
build/block-library/index.js 126 kB +714 B (0%)
build/blocks/index.js 48.2 kB +25 B (0%)
build/components/index.js 193 kB +4 B (0%)
build/components/style-rtl.css 19.5 kB -6 B (0%)
build/components/style.css 19.5 kB -5 B (0%)
build/compose/index.js 9.31 kB -14 B (0%)
build/date/index.js 5.47 kB +1 B
build/dom/index.js 3.17 kB +55 B (1%)
build/edit-navigation/style-rtl.css 918 B +40 B (4%)
build/edit-navigation/style.css 919 B +43 B (4%)
build/edit-site/index.js 15 kB -1 B
build/editor/index.js 44.7 kB -1 B
ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.14 kB 0 B
build/annotations/index.js 3.62 kB 0 B
build/api-fetch/index.js 3.4 kB 0 B
build/autop/index.js 2.83 kB 0 B
build/blob/index.js 620 B 0 B
build/block-directory/index.js 6.75 kB 0 B
build/block-directory/style-rtl.css 892 B 0 B
build/block-directory/style.css 892 B 0 B
build/block-library/editor-rtl.css 7.87 kB 0 B
build/block-library/editor.css 7.88 kB 0 B
build/block-library/style-rtl.css 7.69 kB 0 B
build/block-library/style.css 7.68 kB 0 B
build/block-library/theme-rtl.css 684 B 0 B
build/block-library/theme.css 686 B 0 B
build/block-serialization-default-parser/index.js 1.88 kB 0 B
build/block-serialization-spec-parser/index.js 3.1 kB 0 B
build/core-data/index.js 11.4 kB 0 B
build/data-controls/index.js 1.29 kB 0 B
build/data/index.js 8.46 kB 0 B
build/deprecated/index.js 771 B 0 B
build/dom-ready/index.js 568 B 0 B
build/edit-navigation/index.js 8.25 kB 0 B
build/edit-post/index.js 302 kB 0 B
build/edit-post/style-rtl.css 5.43 kB 0 B
build/edit-post/style.css 5.43 kB 0 B
build/edit-site/style-rtl.css 2.96 kB 0 B
build/edit-site/style.css 2.96 kB 0 B
build/edit-widgets/index.js 8.83 kB 0 B
build/edit-widgets/style-rtl.css 2.4 kB 0 B
build/edit-widgets/style.css 2.4 kB 0 B
build/editor/editor-styles-rtl.css 425 B 0 B
build/editor/editor-styles.css 428 B 0 B
build/editor/style-rtl.css 4.26 kB 0 B
build/editor/style.css 4.27 kB 0 B
build/element/index.js 4.65 kB 0 B
build/escape-html/index.js 733 B 0 B
build/format-library/index.js 7.72 kB 0 B
build/format-library/style-rtl.css 502 B 0 B
build/format-library/style.css 502 B 0 B
build/hooks/index.js 2.13 kB 0 B
build/html-entities/index.js 621 B 0 B
build/i18n/index.js 3.56 kB 0 B
build/is-shallow-equal/index.js 711 B 0 B
build/keyboard-shortcuts/index.js 2.52 kB 0 B
build/keycodes/index.js 1.94 kB 0 B
build/list-reusable-blocks/index.js 3.12 kB 0 B
build/list-reusable-blocks/style-rtl.css 226 B 0 B
build/list-reusable-blocks/style.css 226 B 0 B
build/media-utils/index.js 5.3 kB 0 B
build/notices/index.js 1.79 kB 0 B
build/nux/index.js 3.4 kB 0 B
build/nux/style-rtl.css 616 B 0 B
build/nux/style.css 613 B 0 B
build/plugins/index.js 2.56 kB 0 B
build/primitives/index.js 1.5 kB 0 B
build/priority-queue/index.js 789 B 0 B
build/redux-routine/index.js 2.85 kB 0 B
build/rich-text/index.js 14.8 kB 0 B
build/server-side-render/index.js 2.68 kB 0 B
build/shortcode/index.js 1.7 kB 0 B
build/token-list/index.js 1.28 kB 0 B
build/url/index.js 4.06 kB 0 B
build/viewport/index.js 1.85 kB 0 B
build/warning/index.js 1.14 kB 0 B
build/wordcount/index.js 1.17 kB 0 B

compressed-size-action

Copy link
Member

@noahtallen noahtallen left a comment

Choose a reason for hiding this comment

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

I don't think this is quite working for me:

  1. Template Parts are still dirty (I know this isn't the goal of the PR, but would still be nice to solve)
  2. The first edit to a template part dirties the template as well. (probably because of the template part ID being set?)

It seems like the solution here is just deferring the problem, so I wonder if there is a more robust way to solve it.

I tested this by cleaning my environment and re-enabling the FSE experiment & templates before testing

@epiqueras
Copy link
Contributor Author

Template Parts are still dirty (I know this isn't the goal of the PR, but would still be nice to solve)

When?

The first edit to a template part dirties the template as well. (probably because of the template part ID being set?)

Yes, this is still a clear improvement over master. Do you think we can merge this as a first step?

@noahtallen
Copy link
Member

When?

On loading the editor with non-customized template parts (same situation as when the template would be dirtied).

Obviously none of this is an issue once we are loading from CPTs.

this is still a clear improvement over master

I think I'm onboard with this if we fix the same problem with template parts. Otherwise, it's not really noticeable that anything has been improved, since a dirty state is still visible when entering the editor for the first time... So on load, I get:

Dirtied: template part

Then, I modify the template part and I get:

Dirtied: template and template part

This is confusing behavior to me, and I feel like the template & template part being dirty the whole time makes more sense, in a way.

The other thing is that I assume if we fix the problem in a more robust way, then we wouldn't need this workaround

@epiqueras
Copy link
Contributor Author

On loading the editor with non-customized template parts (same situation as when the template would be dirtied).
I think I'm onboard with this if we fix the same problem with template parts.

Fixed :)

Copy link
Member

@noahtallen noahtallen left a comment

Choose a reason for hiding this comment

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

Nice! works for me. Now the editor shows no dirty changes until you actually modify something, so it at least looks like expected behavior now.

@epiqueras epiqueras requested review from nerrad and ntwb as code owners June 5, 2020 03:09
@epiqueras epiqueras merged commit 0ab323a into master Jun 5, 2020
@epiqueras epiqueras deleted the fix/avoid-dirtying-uncustomized-templates-on-first-load branch June 5, 2020 18:02
@github-actions github-actions bot added this to the Gutenberg 8.3 milestone Jun 5, 2020
@youknowriad
Copy link
Contributor

This is a really cool one. It fixes one of the most important bugs in the current flows.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Bug An existing feature does not function as intended
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants