First run at a setup #21965

thijsoo · 2025-01-13T15:04:34Z

Context

We want to add the possibility to integrate with GSC.

Summary

This PR can be summarized in the following changelog entry:

Adds a endpoint to get your top 5 most view pages.

Relevant technical choices:

I used the same setup we are using for the scores by only needing a rest endpoint with some configuration to make the API request via Google Site Kit.
I have added a search-rankings-parser class that does not do alot yet but as a blueprint where we can link the indexables to the api results.
This PR does not have any fallbacks or checks to make sure site kit is configured or it takes a look a api limits. This is just a POC of the connection.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

With the YOAST_SEO_GOOGLE_SITE_KIT_FEATURE feature flag enabled:

To test this make sure you have a working Site Kit running.
Go to /wordpress-seo/src/dashboard/user-interface/search-rankings/abstract-ranking-route.php and comment out line 112.
Go to wp-json/yoast/v1/top_pages?limit=5 you should see an API response with your top 5 pages in terms of clicks. The response should look something like this:

 [
    {
        "clicks": 10,
        "ctr": 0.16393442622950818,
        "impressions": 61,
        "position": 28.278688524590162,
        "subject": "https://example.com/",
        "seoScore": 0
    },
    {
        "clicks": 3,
        "ctr": 0.076923076923076927,
        "impressions": 13,
        "position": 26.692307692307693,
        "subject": "https://example.com/page_1/",
        "seoScore": 0
    },
    {
        "clicks": 3,
        "ctr": 0,
        "impressions": 1,
        "position": 28.600000000000001,
        "subject": "https://example.com/page_2/",
        "seoScore": 0
    },
    {
        "clicks": 1,
        "ctr": 0,
        "impressions": 5,
        "position": 45,
        "subject": "https://example.com/page_3/",
        "seoScore": 0
    },
    {
        "clicks": 1,
        "ctr": 0,
        "impressions": 5,
        "position": 111,
        "subject": "https://example.com/page_4/",
        "seoScore": 0
    },
]

Go to wp-json/yoast/v1/top_queries?limit=5 you should see an API response with your top 5 queries in terms of clicks. The response will look like something like the above but with queries instead of URLs in the subject attributes.
Note that the seoScore is going to be 0 in all elements, since we haven't implemented that yet.

With the YOAST_SEO_GOOGLE_SITE_KIT_FEATURE feature flag disabled:

Repeat both requests and confirm you get an error response.

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:

This PR is just a blueprint for later development of this feauture. This pr does not need to be tested on its own.

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 · 2025-01-14T13:25:46Z

Pull Request Test Coverage Report for Build 2e90e5baee9d8bd392c2a163eb41788468aea0ff

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.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

0 of 123 (0.0%) changed or added relevant lines in 12 files are covered.
No unchanged relevant lines lost coverage.
Overall first build on first-setup-for-gsc-api-integration at 51.119%

Changes Missing Coverage	Changed/Added Lines	%
src/dashboard/user-interface/search-rankings/top-page-route.php	3	0.0%
src/dashboard/user-interface/search-rankings/top-query-route.php	3	0.0%
src/dashboard/application/search-rankings/top-page-repository.php	4	0.0%
src/dashboard/application/search-rankings/top-query-repository.php	4	0.0%
src/dashboard/infrastructure/search-console/search-console-parameters.php	4	0.0%
src/dashboard/infrastructure/endpoints/search-rankings/top-page-endpoint.php	8	0.0%
src/dashboard/infrastructure/endpoints/search-rankings/top-query-endpoint.php	8	0.0%
src/dashboard/domain/data-provider/data-container.php	9	0.0%
src/dashboard/domain/data-provider/parameters.php	12	0.0%
src/dashboard/domain/search-rankings/search-data.php	16	0.0%

Totals
Change from base Build 9c66956756c0900e29fb6645e4308dfb47898de1:	51.1%
Covered Lines:	16657
Relevant Lines:	32585

💛 - Coveralls

…ers.

leonidasmi

CR: 🏗️

Aside from the comments, I think there might be some changes in the architecture when we cross-reference the sitekit data with the indexable data, but let's tackle those with the next PR.

src/dashboard/user-interface/search-rankings/abstract-ranking-route.php

src/dashboard/infrastructure/search-console/search-console-parameters.php

src/dashboard/infrastructure/search-rankings/search-rankings-parser.php

src/dashboard/infrastructure/search-console/site-kit-search-console-adapter.php

leonidasmi · 2025-01-21T09:15:14Z

src/dashboard/domain/search-rankings/search-data.php

+	 *
+	 * @var int
+	 */
+	private $seo_score;


I'm having reservations about whether the seo_score should be here or it should be injected by an indexable-related domain class, but let's see that in the final backend task for that widget.

I'm unresolving this because indeed it needs to be dealt with in the future, so lets keep it open for future reference.

There are going to be search-ranking data that will not have seo scores, so we will need a tweak of the approach here, which we can do when we finalize the endpoint,

src/dashboard/domain/data-provider/parameters.php

src/dashboard/infrastructure/search-rankings/search-rankings-parser.php

…ion.

leonidasmi

I want to re-iterate this point and actually extend it for the whole data provider class.

These classes being in such a generic domain that's about dashboard in general, makes me feel weird about our already-implemented SEO/Readability score widgets that are also about dashboard, are also repositories that deal with data/parameters/anything else that directory is about, but are being excluded by those classes because they are different things.

In any case, I dont want to block merging this PR because of this, we can talk about it and maybe iterate it on the next stage, when the indexable data come into play

So, CR + Acceptance test is ✅

leonidasmi · 2025-01-23T11:04:41Z

src/dashboard/domain/search-rankings/search-data.php

+class Search_Data implements Data_Interface {
+
+	/**
+	 * The amount of clicks a `key` gets.


There's no longer a key but rather a subject. Don't want to block merging because of that, I'll correct in my subsequent PR if that's ok.

leonidasmi · 2025-01-23T11:13:36Z

src/dashboard/domain/search-rankings/search-data.php

+	 *
+	 * @var int
+	 */
+	private $seo_score;


I'm unresolving this because indeed it needs to be dealt with in the future, so lets keep it open for future reference.

There are going to be search-ranking data that will not have seo scores, so we will need a tweak of the approach here, which we can do when we finalize the endpoint,

First run at a setup

a6c5536

thijsoo added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Jan 13, 2025

thijsoo added 2 commits January 14, 2025 12:42

Feedback and use statements

6449947

no __construct side effects.

d3513b1

thijsoo marked this pull request as ready for review January 14, 2025 13:08

CS.

af2b9f3

thijsoo added 2 commits January 14, 2025 14:34

__construct needed but with a class exists.

8afb9bb

Add second end point to POC.

141cda3

leonidasmi mentioned this pull request Jan 17, 2025

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

Draft

18 tasks

thijsoo added 2 commits January 20, 2025 12:05

Add a layer of abstraction to split the adapters from the data provid…

a9c394e

…ers.

Oops.

49966fb

leonidasmi reviewed Jan 21, 2025

View reviewed changes

thijsoo and others added 7 commits January 21, 2025 14:54

Use needed conditional.

5dd465b

Improvements of api response and dates.

e2b3ef3

Add layer in the application to split out the route from the applicat…

b030bf4

…ion.

cs.

ad27733

😭

08c9256

Rename to repository

7097c2d

Cascade the rename of collector into repository to all the places

c46bf26

leonidasmi approved these changes Jan 23, 2025

View reviewed changes

leonidasmi added this to the 24.5 milestone Jan 23, 2025

leonidasmi merged commit 37106cf into trunk Jan 23, 2025
24 of 25 checks passed

leonidasmi deleted the first-setup-for-gsc-api-integration branch January 23, 2025 12:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

First run at a setup #21965

First run at a setup #21965

thijsoo commented Jan 13, 2025 •

edited by leonidasmi

Loading

coveralls commented Jan 14, 2025 •

edited

Loading

leonidasmi left a comment

leonidasmi Jan 21, 2025

leonidasmi Jan 23, 2025

leonidasmi left a comment

leonidasmi Jan 23, 2025

leonidasmi Jan 23, 2025

First run at a setup #21965

First run at a setup #21965

Conversation

thijsoo commented Jan 13, 2025 • edited by leonidasmi Loading

Context

Summary

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

Relevant test scenarios

Test instructions for QA when the code is in the RC

Impact check

UI changes

Other environments

Documentation

Quality assurance

Innovation

coveralls commented Jan 14, 2025 • edited Loading

Pull Request Test Coverage Report for Build 2e90e5baee9d8bd392c2a163eb41788468aea0ff

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

leonidasmi left a comment

Choose a reason for hiding this comment

leonidasmi Jan 21, 2025

Choose a reason for hiding this comment

leonidasmi Jan 23, 2025

Choose a reason for hiding this comment

leonidasmi left a comment

Choose a reason for hiding this comment

leonidasmi Jan 23, 2025

Choose a reason for hiding this comment

leonidasmi Jan 23, 2025

Choose a reason for hiding this comment

thijsoo commented Jan 13, 2025 •

edited by leonidasmi

Loading

coveralls commented Jan 14, 2025 •

edited

Loading