wordpress-seo icon indicating copy to clipboard operation
wordpress-seo copied to clipboard

Decouple snippet data and initialization cleanup

Open vraja-pro opened this issue 1 year ago • 0 comments

Context

  • Snippet editor has more complex way of using the hidden fields. We want to make the yoast editor store as the source of truth and sync values to the hidden fields.

Summary

This PR can be summarized in the following changelog entry:

  • Decouple seo title and description from metabox.

Relevant technical choices:

  • setDataFromSnippet is used as a sync function to the hidden fields for the snippet editor data. I left only the case for slug since it is not meta and the sync is done within the editor.
  • We set focus keyword in the initial state regardless of the analysis feature active or not. It doesn't make a difference.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Change the seo title, slug and description in the editors ( classic editor, block editor, term editor, elementor editor)
  • Save and check changes were saved.
  • Check the analysis detect the changes in the description in slug and title.
  • Check it analysis detects description length, and focus keyphrase in title, slug and description.

Relevant test scenarios

  • [x] Changes should be tested with the browser console open
  • [ ] Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
  • [ ] Changes should be tested on different editors (Default Block/Gutenberg/Classic/Elementor/other)
  • [ ] Changes should be tested on different browsers
  • [ ] Changes should be tested on multisite

Test instructions for QA when the code is in the RC

  • [ ] QA should use the same steps as above.

QA can test this PR by following these steps:

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

UI changes

  • [X] This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

  • [ ] This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

  • [ ] I have written documentation for this change. For example, comments in the Relevant technical choices, comments in the code, documentation on Confluence / shared Google Drive / Yoast developer portal, or other.

Quality assurance

  • [X] I have tested this code to the best of my abilities.
  • [ ] During testing, I had activated all plugins that Yoast SEO provides integrations for.
  • [ ] I have added unit tests to verify the code works as intended.
  • [ ] If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
  • [ ] I have written this PR in accordance with my team's definition of done.
  • [ ] I have checked that the base branch is correctly set.

Innovation

  • [X] No innovation project is applicable for this PR.
  • [ ] This PR falls under an innovation project. I have attached the innovation label.
  • [ ] I have added my hours to the WBSO document.

Fixes https://github.com/Yoast/wordpress-seo/issues/21225

vraja-pro avatar Apr 23 '24 09:04 vraja-pro