Skip to content

Create an endpoint that allows tracking of first interactions with Yoast features#22867

Merged
thijsoo merged 6 commits intotrunkfrom
930-add-tracking-for-the-frontend-inspector
Jan 13, 2026
Merged

Create an endpoint that allows tracking of first interactions with Yoast features#22867
thijsoo merged 6 commits intotrunkfrom
930-add-tracking-for-the-frontend-inspector

Conversation

@leonidasmi
Copy link
Copy Markdown
Contributor

@leonidasmi leonidasmi commented Jan 8, 2026

Context

  • Accompanies the Premium PR that tracks when users first interact with the Frontend Inspector
  • The endpoint can be used in all sorts of similar tracking in the future.

Summary

This PR can be summarized in the following changelog entry:

  • Creates an endpoint that allows tracking of first interactions with Yoast features.

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:

  • Install Premium
  • Using POSTMAN, send a POST request to /wp-json/yoast/v1/action_tracking with the { "action": "not_existing_action" } body
    • Confirm you get a 400 response with a { "success": false, "error": "The tracked action is invalid" } response.
  • For using the endpoint successfully, move to the respective Premium PR.
  • Deactivate Premium and repeat the request
    • Confirm you get a 404 - rest_no_route 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.

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

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.
  • This PR also affects Yoast SEO for Google Docs. I have added a changelog entry starting with [yoast-doc-extension], added test instructions for Yoast SEO for Google Docs and attached the Google Docs Add-on 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.
  • I have run grunt build:images and commited the results, if my PR introduces new images or SVGs.

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
Copy Markdown

coveralls commented Jan 8, 2026

Pull Request Test Coverage Report for Build 5b2d353d3893594ddff55d516bacb4cb6a662607

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

  • 45 of 48 (93.75%) changed or added relevant lines in 3 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.5%) to 52.833%

Changes Missing Coverage Covered Lines Changed/Added Lines %
inc/options/class-wpseo-option-tracking-only.php 0 1 0.0%
src/tracking/domain/exceptions/invalid-tracked-action-exception.php 0 2 0.0%
Totals Coverage Status
Change from base Build 3d1950c997eca6ec7a69e631e58c2c372fb8cc39: -0.5%
Covered Lines: 32307
Relevant Lines: 61200

💛 - Coveralls

@leonidasmi leonidasmi added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Jan 8, 2026
@leonidasmi leonidasmi marked this pull request as ready for review January 9, 2026 08:25
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.

One small suggestion

Comment thread src/tracking/user-interface/action-tracking-route.php Outdated
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.

CR + ACC 👍

@thijsoo thijsoo added this to the 26.9 milestone Jan 13, 2026
@thijsoo thijsoo merged commit 6804bce into trunk Jan 13, 2026
27 checks passed
@thijsoo thijsoo deleted the 930-add-tracking-for-the-frontend-inspector branch January 13, 2026 15:10
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.

3 participants