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 troubleshooting mode in score endpoints #21891

Merged
merged 2 commits into from
Dec 6, 2024

Conversation

leonidasmi
Copy link
Contributor

@leonidasmi leonidasmi commented Dec 4, 2024

Context

Summary

This PR can be summarized in the following changelog entry:

  • Adds troubleshooting mode in score endpoints

Relevant technical choices:

  • If we're on troubleshooting mode, we bypass cache.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • With POSTMAN, do the usual GET requests for seo and readability scores (see the original PR)
  • But this time add a &troubleshooting=1 parameter
  • You should now get the same responses like before, but with an added ids attribute in each good/ok/bad/notAnalyzed score, which should represent a comma-separated list of post IDs.
  • Confirm that those IDs are:
    • the same amount that the respective amount of the score
    • for the posts that exist in the respective view links
  • Try for both seo and readability scores and for taxonomy filtering both enabled and disabled
  • Also try to send a GET request with troubleshooting on and within a minute send the same request with troubleshooting off. You should get the same amounts but also you should get both results with cacheUsed: false, even if the requests happened within the cache expiration data.

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.

Impact check

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

  • Do a smoke test of the score widgets. Mainly we want to check that we keep showing the proper amounts for each score. Again, an easy way to test this is to compare the numbers that the widget show for each score and the number of posts that exist in the View links.

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/reserved-tasks/issues/354

@leonidasmi leonidasmi added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Dec 5, 2024
@leonidasmi leonidasmi marked this pull request as ready for review December 5, 2024 10:57
@leonidasmi leonidasmi added this to the 24.1 milestone Dec 5, 2024
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: ✅

@pls78 pls78 merged commit 524f1b0 into release/24.1 Dec 6, 2024
23 checks passed
@pls78 pls78 deleted the troubleshoot-dashboard-feature branch December 6, 2024 15:30
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.

2 participants