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

Add early return in the hierachy creation to make sure we don't run a useless query. #21442

Conversation

thijsoo
Copy link
Contributor

@thijsoo thijsoo commented Jun 14, 2024

Context

  • After making sure we don't create indexables when the 'Yoast\WP\SEO\should_index_indexables' filter we want to make sure we also disable some side effect filters.

Summary

This PR can be summarized in the following changelog entry:

  • Removes unnecessary query when indexables are disabled.

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:
Note: Wherever add_filter( 'Yoast\WP\SEO\should_index_indexables', '__return_false' ); is mentioned, it can also mean that you are on a non-production site instead (aka, have the WP_ENVIRONMENT_TYPE constant indicate a staging or local or development site).

  • Make sure you have QM enabled.
  • Clear all you indexables and add the following code somewhere in your site:
    add_filter( 'Yoast\WP\SEO\should_index_indexables', '__return_false' );
  • Go to any post you have and make sure the following query is not present:
DELETE
FROM `wp_yoast_indexable_hierarchy`
WHERE `indexable_id` = {post_id}`

Remove the filter and make sure you now see the query.

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: enhancement Needs to be included in the 'Enhancements' category in the changelog label Jun 14, 2024
@coveralls
Copy link

coveralls commented Jun 14, 2024

Pull Request Test Coverage Report for Build 42ef26c334130eeda362cb39ea1119f33d599474

Details

  • 3 of 4 (75.0%) changed or added relevant lines in 1 file are covered.
  • 836 unchanged lines in 1 file lost coverage.
  • Overall coverage decreased (-0.002%) to 52.854%

Changes Missing Coverage Covered Lines Changed/Added Lines %
src/builders/indexable-hierarchy-builder.php 3 4 75.0%
Files with Coverage Reduction New Missed Lines %
src/generated/container.php 836 0.0%
Totals Coverage Status
Change from base Build a8818d4d5624f16d9f78369aa77336463be0838a: -0.002%
Covered Lines: 28343
Relevant Lines: 54224

💛 - Coveralls

@thijsoo thijsoo changed the base branch from trunk to feature/plugin-fixes June 25, 2024 07:26
Copy link
Member

@igorschoester igorschoester left a comment

Choose a reason for hiding this comment

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

CR ✅

… into 21405-when-indexable-creation-is-disabled-theres-redundant-db-queries-on-page-load-in-the-frontend-of-posts

# Conflicts:
#	composer.json
Copy link
Member

@igorschoester igorschoester left a comment

Choose a reason for hiding this comment

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

AC ✅

@igorschoester igorschoester added this to the feature/plugin-fixes milestone Jun 27, 2024
@coveralls
Copy link

coveralls commented Jun 27, 2024

Pull Request Test Coverage Report for Build 2c48faf9cd7ff023b978057e296b7eb7f1032a0e

Details

  • 3 of 4 (75.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall first build on 21405-when-indexable-creation-is-disabled-theres-redundant-db-queries-on-page-load-in-the-frontend-of-posts at 50.421%

Changes Missing Coverage Covered Lines Changed/Added Lines %
src/builders/indexable-hierarchy-builder.php 3 4 75.0%
Totals Coverage Status
Change from base Build aadef3b2c0b385b314d05dc7c56820abc2686e65: 50.4%
Covered Lines: 16035
Relevant Lines: 31802

💛 - Coveralls

@igorschoester igorschoester merged commit 5596f6e into feature/plugin-fixes Jun 27, 2024
23 checks passed
@igorschoester igorschoester deleted the 21405-when-indexable-creation-is-disabled-theres-redundant-db-queries-on-page-load-in-the-frontend-of-posts branch June 27, 2024 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: enhancement Needs to be included in the 'Enhancements' category in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

When indexable creation is disabled, there's redundant db queries on page load, in the frontend of posts
4 participants