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

Fix not loading config_page scripts #21650

Conversation

igorschoester
Copy link
Member

Context

Fix for #21647
Errors resulting from not loading in the config_page script & style on other pages when the New Dashboard UI feature flag is enabled.

Summary

This PR can be summarized in the following changelog entry:

  • Fixes an unreleased bug where the NEW_DASHBOARD_UI feature flag would negatively influence other admin pages.

Relevant technical choices:

  • It should keep the same behavior, except when on the new dashboard page. I.e. dashboard page AND the feature flag

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Enable the feature flag for the new dashboard. By adding the following in wp-config.php:
define( 'YOAST_SEO_NEW_DASHBOARD_UI', true );
  • Be sure to activate Premium, News and Local
  • Open the console
  • Verify there is no error on the Integrations page in the Yoast admin
    • Error was: [Uncaught ReferenceError: wpseoScriptData is not defined](helper.js:3 Uncaught TypeError: Cannot read properties of undefined (reading 'isPremium'))
  • Verify there is no error on the News SEO page in the Yoast admin
    • Error was: Uncaught TypeError: Cannot destructure property 'isAlertDismissed' of 'select(...)' as it is undefined (and more)
  • Verify there is no error on the Local SEO page in the Yoast admin
    • Error was: Uncaught ReferenceError: wpseoScriptData is not defined

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:

  • The Yoast admin pages with/without the New Dashboard UI feature flag

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 #

@igorschoester igorschoester added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Sep 23, 2024
… is enabled

It should only not load when on the new dashboard page AND the feature flag for it is enabled
@igorschoester igorschoester force-pushed the fix-config-scripts-not-loading-on-other-pages-with-feature-flag branch from dbbff71 to c7e0746 Compare September 23, 2024 10:42
@coveralls
Copy link

coveralls commented Sep 23, 2024

Pull Request Test Coverage Report for Build a897ff8ac0bf04177c832908e15219f1bf10ecb2

Details

  • 0 of 4 (0.0%) changed or added relevant lines in 1 file are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage increased (+24.8%) to 54.548%

Changes Missing Coverage Covered Lines Changed/Added Lines %
admin/class-config.php 0 4 0.0%
Files with Coverage Reduction New Missed Lines %
admin/class-config.php 1 0.0%
Totals Coverage Status
Change from base Build 59c08c8224780dbe9453b7d08b88f5a4829c573b: 24.8%
Covered Lines: 29534
Relevant Lines: 54428

💛 - Coveralls

@vraja-pro
Copy link
Contributor

CR && AC ✅

@vraja-pro vraja-pro merged commit 7be81ca into trunk Sep 23, 2024
23 checks passed
@vraja-pro vraja-pro deleted the fix-config-scripts-not-loading-on-other-pages-with-feature-flag branch September 23, 2024 11:05
@vraja-pro vraja-pro added this to the 23.6 milestone Sep 23, 2024
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.

3 participants