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

Add an integration to check the `Requires Yoast SEO` header.

Open enricobattocchi opened this issue 1 year ago • 1 comments

Context

Summary

This PR can be summarized in the following changelog entry:

  • Prevents the installation of addons requiring a higher Yoast SEO version than the current one.

Relevant technical choices:

  • We need to inject the custom header via an initializer since the cache might be primed with the plugins data earlier in the process
  • I did not add tests since the methods are not easy to trigger outside the flow of the plugin update

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

Important: Use the provided zips (see Slack)

  • Connect a site (e.g. a TasteWP site) to MyYoast (you need all the addons, not just Premium)
  • install and activate Free 22.7-requirement-check
  • install and activate VideoSEO 14.8
  • visit the Dashboard > Updates
    • you should see that both Free and VideoSEO can be upgraded
  • Select only VideoSEO and update
  • See that you get this message and VideoSEO is not updated Screenshot 2024-08-13 at 16-17-40 Update Plugins ‹ Shiny Cave — WordPress
  • Visit the Plugins page
  • click on "update now" only for VideoSEO
  • See that the update fails with the alert Update failed: The package could not be installed because it's not supported by the currently installed Yoast SEO version.
  • Upload VideoSEO 14.9
  • See that you get this message and VideoSEO is not updated Screenshot 2024-08-13 at 16-17-40 Update Plugins ‹ Shiny Cave — WordPress
  • install and activate Free 23.1-requirement-check
  • try to update VideoSEO in any way and see it works now
  • install and activate Premium 23.1
  • visit the Dashboard > Updates
    • you should see that both Free and Premium can be upgraded
  • Select only Premium and update
  • See that you get this message and Premium is not updated Screenshot 2024-08-13 at 15-31-07 Update Plugins ‹ Shiny Cave — WordPress
  • Visit the Plugins page
  • click on "update now" only for Premium
  • See that the update fails with the alert Update failed: The package could not be installed because it's not supported by the currently installed Yoast SEO version.
  • Upload Premium 23.2
  • See that you get this message and Premium is not updated Screenshot 2024-08-13 at 15-34-41 Upload Plugin ‹ Shiny Cave — WordPress
  • if you want, check that the above works even if Premium is not active (but Free still needs to be active for the check to be working)
  • install Free 23.2-requirement-check
  • try to update Premium in any way and see it works now
  • Upload any Premium ZIP to overwrite the existing Premium and see that you get a new "Required Yoast SEO" row in the table outlining the plugin params: Screenshot 2024-08-14 at 12-04-48 Upload Plugin ‹ Display Airport — WordPress

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

  • [x] 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 https://github.com/Yoast/roadmap/issues/448

enricobattocchi avatar May 17 '24 10:05 enricobattocchi

Pull Request Test Coverage Report for Build 0bfc22239db1d722983a928a1ce273fd24b71335

Details

  • 0 of 54 (0.0%) changed or added relevant lines in 3 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+5.3%) to 54.454%

Changes Missing Coverage Covered Lines Changed/Added Lines %
src/conditionals/check-required-version-conditional.php 0 2 0.0%
src/initializers/plugin-headers.php 0 5 0.0%
src/integrations/admin/check-required-version.php 0 47 0.0%
<!-- Total: 0 54
Totals Coverage Status
Change from base Build 6c76b5aa36abf55cdd18912cbf36edf68a9d5272: 5.3%
Covered Lines: 29831
Relevant Lines: 55004

💛 - Coveralls

coveralls avatar May 17 '24 10:05 coveralls

CR: ✅ (aside from the fact that we named a non-public change (because of the feature flag) an enhancement and an open question)

leonidasmi avatar Aug 29 '24 08:08 leonidasmi

Tested by @thijsoo

enricobattocchi avatar Sep 03 '24 06:09 enricobattocchi