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

Make sure assets are also enqueued for non block editor editors. #21703

Merged
merged 6 commits into from
Oct 15, 2024

Conversation

thijsoo
Copy link
Contributor

@thijsoo thijsoo commented Oct 14, 2024

Context

  • We need to enqueue our metabox assets differently for non block editor editors.

Summary

This PR can be summarized in the following changelog entry:

  • Fixes an unreleased bug where the assets for non block editor editors were no longer enqueued.

Relevant technical choices:

  • I added a maybe callback method since at construct time the system does not know if we are in the block editor yet. The current_screen methods are not yet defined.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

Test the assets get correctly enqueued in all the editors

Test the assets get correctly enqueued by third-party plugins

  • Install Tabify Edit Screen
  • Go to Settings -> Tabify edit screen
    • click on Create new tab
    • name the tab Yoast and make sure Yoast SEO is in it
    • toggle Show tabs in this post type to on
    • click Save changes
  • Activate the Classic editor
  • Edit a post
    • you should see the following:
    Screenshot 2024-10-15 at 11 22 36 * click on `Yoast` and make sure the metabox is correctly loaded

Relevant test scenarios

  • 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

  • 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

  • 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

  • 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 #

@thijsoo thijsoo added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Oct 14, 2024
@pls78 pls78 self-requested a review October 14, 2024 09:31
@pls78 pls78 linked an issue Oct 14, 2024 that may be closed by this pull request
Copy link
Member

@pls78 pls78 left a comment

Choose a reason for hiding this comment

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

CR && Acc: ✅
Tests are broken but it is related to WordPress itself

This won't cure the notice but it's the correct hook for us to use, because we don't enqueue anything in the frontend about the metabox
@coveralls
Copy link

coveralls commented Oct 15, 2024

Pull Request Test Coverage Report for Build 0defbcbfb5b1cdad4758cbe77567d73b6b19945b

Details

  • 2 of 9 (22.22%) changed or added relevant lines in 1 file are covered.
  • 2 unchanged lines in 1 file lost coverage.
  • Overall coverage decreased (-0.007%) to 54.526%

Changes Missing Coverage Covered Lines Changed/Added Lines %
admin/metabox/class-metabox.php 2 9 22.22%
Files with Coverage Reduction New Missed Lines %
admin/metabox/class-metabox.php 2 20.4%
Totals Coverage Status
Change from base Build 17073c53f358a61d5f0e617de10e18698fc84434: -0.007%
Covered Lines: 29671
Relevant Lines: 54670

💛 - Coveralls

Co-authored-by: Enrico Battocchi <enrico.battocchi@gmail.com>
Copy link
Contributor Author

@thijsoo thijsoo left a comment

Choose a reason for hiding this comment

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

CR + ACC 👍

@pls78 pls78 modified the milestones: 23.7, 23.8 Oct 15, 2024
@pls78 pls78 merged commit aada569 into trunk Oct 15, 2024
23 checks passed
@pls78 pls78 deleted the fix-editor-assets-enqueue branch October 15, 2024 10:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Metabox is broken with classic editor and WP6.7
4 participants