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

568 backend throw exceptions when data sources are not available #22059

Open
wants to merge 4 commits into
base: trunk
Choose a base branch
from

Conversation

thijsoo
Copy link
Contributor

@thijsoo thijsoo commented Feb 19, 2025

Context

  • We want to make sure API calls are not done without proper configuration.

Summary

This PR can be summarized in the following changelog entry:

  • Adds protection that ensures api calls are only fired from the repositories in the data sources are configured.

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:

  • Make sure wp-json/yoast/v1/time_based_seo_metrics?options[widget]=query and wp-json/yoast/v1/time_based_seo_metrics?options[widget]=οrganicSessionsDaily work.
  • Reset your options to disable the consent and make sure both API calls fail with the following exception message:
    "error": "The used repository is not yet onboarded fully"
  • Give consent and make sure the wp-json/yoast/v1/time_based_seo_metrics?options[widget]=query call works again.
  • Now configure and enable GA4 in your sitekit installation. Make sure wp-json/yoast/v1/time_based_seo_metrics?options[widget]=οrganicSessionsDaily works again.

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: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Feb 19, 2025
@thijsoo thijsoo marked this pull request as ready for review February 20, 2025 11:32
@coveralls
Copy link

Pull Request Test Coverage Report for Build 675cc233ad7330b26a68ae034d7260be3e6fbc4a

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 30 (0.0%) changed or added relevant lines in 6 files are covered.
  • 1046 unchanged lines in 4 files lost coverage.
  • Overall coverage decreased (-0.02%) to 54.457%

Changes Missing Coverage Covered Lines Changed/Added Lines %
src/dashboard/domain/time-based-seo-metrics/not-onboarded-exception.php 0 2 0.0%
src/dashboard/application/search-rankings/top-page-repository.php 0 3 0.0%
src/dashboard/application/traffic/organic-sessions-repository.php 0 3 0.0%
src/dashboard/application/search-rankings/top-query-repository.php 0 4 0.0%
src/dashboard/infrastructure/analytics-4/site-kit-analytics-4-adapter.php 0 4 0.0%
src/dashboard/infrastructure/integrations/site-kit.php 0 14 0.0%
Files with Coverage Reduction New Missed Lines %
src/dashboard/application/search-rankings/top-page-repository.php 1 0.0%
src/dashboard/application/search-rankings/top-query-repository.php 1 0.0%
src/dashboard/application/traffic/organic-sessions-repository.php 1 0.0%
src/generated/container.php 1043 0.38%
Totals Coverage Status
Change from base Build 93db04941ac90d35196a36cc9a46ae7f9c32e957: -0.02%
Covered Lines: 30392
Relevant Lines: 56265

💛 - 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