Skip to content

Handle date ranges in SK responses better#22183

Merged
thijsoo merged 6 commits intotrunkfrom
508-discrepancies-in-comparison-requests
Apr 10, 2025
Merged

Handle date ranges in SK responses better#22183
thijsoo merged 6 commits intotrunkfrom
508-discrepancies-in-comparison-requests

Conversation

@leonidasmi
Copy link
Copy Markdown
Contributor

@leonidasmi leonidasmi commented Apr 9, 2025

Context

Summary

This PR can be summarized in the following changelog entry:

  • Fixes an unreleased bug with the total Organic Session number that appear in the relevant widget.

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:

  • For getting the complete data about the last 28 days and the complete data of the 28 days before that, do a GET request to /wp-json/yoast/v1/time_based_seo_metrics?options[widget]=organicSessionsCompare
  • Confirm that the response you get is like:
[
    {
        "current": {
            "sessions": 9
        },
        "previous": {
            "sessions": 12
        }
    }
]
  • Go to the actual Google Analytics platform and search for organic sessions of the last 28 days compared with the organic sessions of the 28 days before that and confirm you get the same result
    • Specifically, you can do that by changing the date range at the top right corner of the Acquisition page in analytics and then enable Compare and select Preceding period:
      image
  • You can check now the sessions from the last 28 days compared with the 28 days before that:
    image
  • Confirm that the current sessions in our REST response is the same with the number of the period of the last 28 days in Analytics. And that the previous sessions in our REST response is the same with the number of the period of the last 28 days before the last 28 days.

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:

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/508

… the response row dictates which date range is about
@leonidasmi leonidasmi added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Apr 9, 2025
@leonidasmi leonidasmi changed the title Handle date ranges in SK responses without assuming that the order of… Handle date ranges in SK responses better Apr 9, 2025
@leonidasmi leonidasmi marked this pull request as ready for review April 9, 2025 10:44
Copy link
Copy Markdown
Contributor

@thijsoo thijsoo left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@thijsoo thijsoo added this to the 25.0 milestone Apr 10, 2025
@thijsoo thijsoo merged commit ff8374a into trunk Apr 10, 2025
27 checks passed
@thijsoo thijsoo deleted the 508-discrepancies-in-comparison-requests branch April 10, 2025 12:52
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