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

Create endpoint to calculate comparison search ranking data #22067

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

Conversation

leonidasmi
Copy link
Contributor

@leonidasmi leonidasmi commented Feb 21, 2025

Context

Summary

This PR can be summarized in the following changelog entry:

  • Creates endpoint to calculate comparison search ranking data

Relevant technical choices:

  • For the average click through rate of a time period, we calculate that by dividing the total clicks with the total impressions of that period. This gives the same results with what the Search Console platform is giving.
  • Through trial and error, for the average position of a time period, we now calculate that by calculating the average position weighted by impressions. So, it's Weighted Avg Position= ∑( Position×Impressions) / ∑( Impressions ). This gives the same results with what the Search Console platform is giving.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

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 #

@coveralls
Copy link

Pull Request Test Coverage Report for Build a9193bbbb1a0a82637e260f45c38e4376d963d84

Details

  • 0 of 75 (0.0%) changed or added relevant lines in 5 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-3.4%) to 54.437%

Changes Missing Coverage Covered Lines Changed/Added Lines %
src/dashboard/application/search-rankings/search-ranking-compare-repository.php 0 5 0.0%
src/dashboard/domain/search-rankings/search-ranking-data.php 0 8 0.0%
src/dashboard/infrastructure/search-console/site-kit-search-console-adapter.php 0 18 0.0%
src/dashboard/user-interface/time-based-seo-metrics/time-based-seo-metrics-route.php 0 19 0.0%
src/dashboard/domain/search-rankings/comparison-search-ranking-data.php 0 25 0.0%
Totals Coverage Status
Change from base Build 3888b28d83f272168937506af6d7607a8f5e2e51: -3.4%
Covered Lines: 30407
Relevant Lines: 56323

💛 - Coveralls

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants