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

Apply cache for requests to search analytics to avoid API quota limits #21973

Draft
wants to merge 3 commits into
base: trunk
Choose a base branch
from

Conversation

leonidasmi
Copy link
Contributor

@leonidasmi leonidasmi commented Jan 17, 2025

Context

Summary

This PR can be summarized in the following changelog entry:

  • Applies cache for requests to search analytics to avoid API quota limits

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:

  • In src\dashboard\infrastructure\search-console\cached-site-kit-search-console-adapter.php find the
		if ( $cached_data !== false ) {
			return \json_decode( $cached_data, false );
		}

snippet and below it, add a error_log('not cached'); line

  • Perform a GET request to wp-json/yoast/v1/top_pages as per the instructions of First run at a setup #21965
  • Confirm that you see the not cached message in your debug.log
  • Go to the database, search for an option looking like _transient_timeout_wpseo_search_console_data_<start_date>_<end_date>_page and get its option_value. Go to a site like epochconverter.com and convert it to human date. Confirm it's in 12 hours.
  • Repeat the request and confirm that:
    • You get the same results as before
    • You don't see a new not cached message in your debug.log
  • Go to src\dashboard\user-interface\search-rankings\abstract-ranking-route.php and change the start date from 2024-01-01 to something else
  • Repeat the request and confirm that you now see a new not cached message in your debug.log
    • Ideally your data are different on this date range so that you can confirm that you also get the updated data results
  • Run wp transient delete --all in your WP CLI and repeat the request. Confirm that you get the same result and a new not cached message appeared in your debug.log.
  • Shut off your internet access from your local machine, to fail the next request from sitekit to Google
  • Run wp transient delete --all again and repeat the GET request
  • Regardless from the response of your request (it might be that error handling has not yet been implemented in our endpoint), we need to confirm that the error response has not been cached. So, re-connect your PC to the internet and repeat the request once more. Confirm that you dont see a new not cached message in your debug.log and that you get the response you expected.

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 https://github.com/Yoast/roadmap/issues/558

@leonidasmi leonidasmi added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Jan 17, 2025
@leonidasmi leonidasmi changed the base branch from trunk to first-setup-for-gsc-api-integration January 17, 2025 12:52
Copy link

A merge conflict has been detected for the proposed code changes in this PR. Please resolve the conflict by either rebasing the PR or merging in changes from the base branch.

Base automatically changed from first-setup-for-gsc-api-integration to trunk January 23, 2025 12:46
@coveralls
Copy link

Pull Request Test Coverage Report for Build ccf0475440eb327a012193e546f651cf29b962f1

Details

  • 0 of 14 (0.0%) changed or added relevant lines in 3 files are covered.
  • 1056 unchanged lines in 1 file lost coverage.
  • Overall coverage decreased (-6.5%) to 47.957%

Changes Missing Coverage Covered Lines Changed/Added Lines %
src/dashboard/application/search-rankings/top-page-repository.php 0 1 0.0%
src/dashboard/application/search-rankings/top-query-repository.php 0 1 0.0%
src/dashboard/infrastructure/search-console/cached-site-kit-search-console-adapter.php 0 12 0.0%
Files with Coverage Reduction New Missed Lines %
src/generated/container.php 1056 0.38%
Totals Coverage Status
Change from base Build 37106cf67cec1e4178ea4e39eaad948e158a508e: -6.5%
Covered Lines: 15918
Relevant Lines: 34196

💛 - Coveralls

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