Re organize ai code #22440

pls78 · 2025-07-16T12:25:13Z

Context

We want to tidy up the AI-related code.
⚠️ Merge this and the corresponding Premium PR only after discussing with Lingo about the AI Optimize and AI Summarize features.

Summary

This PR can be summarized in the following changelog entry:

Re-organizes AI-related code by collecting all modules into an ai parent directory and consequently losing the AI_ namespace/class prefix
Exposes the REST endpoints in the window object.

Relevant technical choices:

All the AI-related modules dropped the AI_ prefix and are now under an ai parent directory.
Endpoint_List and Endpoints_Repository classes have been moved to src/routes/endpoint directory, so that they can be re-used throughout the codebase and not being re-declared each time.
Consent_Endpoint_Interface, Free_Sparks_Endpoint_Interface, Generator_Endpoint_Interface have been introduced to let our DI container know which endpoints need to be gathered by the respective repository. As a result, they are attached to the respective integration window object in the endpoint property (exception made for the Free Sparks one, which is bundled in thewpseoAiGenerator window object.
This means we can now fetch routes URLs from the backend, avoiding hard-coding it in JavaScript ( like we already do in the Dashboard)

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

Smoke test the AI Generate and AI Optimize features

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

Please check no errors or warnings are issued in the console
Please test this PR in each of the supported editors
Please test this PR for posts, pages and product pages

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:

N/A

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 #632

coveralls · 2025-07-16T12:34:32Z

Pull Request Test Coverage Report for Build 44881b69ddc2a6cdc14ba46e26e0e855153f4d93

Details

1 of 40 (2.5%) changed or added relevant lines in 8 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-0.02%) to 52.167%

Changes Missing Coverage	Changed/Added Lines	%
src/ai/consent/application/consent-endpoints-repository.php	3	0.0%
src/ai/free-sparks/application/free-sparks-endpoints-repository.php	3	0.0%
src/ai/generate/application/generator-endpoints-repository.php	3	0.0%
src/routes/endpoint/endpoint-list.php	4	0.0%
src/ai/consent/user-interface/consent-integration.php	5	0.0%
src/routes/endpoint/endpoints-repository.php	7	0.0%
src/ai/generate/user-interface/generator-integration.php	14	0.0%

Totals
Change from base Build a4399526a0f41512e42b20af9a464fa1eccb85c3:	-0.02%
Covered Lines:	30508
Relevant Lines:	59171

💛 - Coveralls

github-actions · 2025-07-22T12:01:55Z

A merge conflict has been detected for the proposed code changes in this PR. Please resolve the conflict by either rebasing the PR or merging in changes from the base branch.

github-actions · 2025-07-30T12:58:57Z

A merge conflict has been detected for the proposed code changes in this PR. Please resolve the conflict by either rebasing the PR or merging in changes from the base branch.

mykola · 2025-07-31T10:18:09Z

src/ai/authorization/application/code-verifier-handler-interface.php

@@ -1,8 +1,9 @@
 <?php


We disable this rules in many files.

can we consider to extend maxSegments in phpcs.xml?

<rule ref="Yoast.NamingConventions.NamespaceName.TooLong"> <properties> <property name="maxSegments" value="5"/> </properties> </rule>

Yes, there's a discussion about this here.

mykola · 2025-07-31T10:41:12Z

src/ai/consent/application/consent-endpoints-repository.php

+	 *
+	 * @var array<Consent_Endpoint_Interface>
+	 */
+	private $endpoints;


Can this filed be removed taking into account the the same filed is present in Endpoints_Repository and DI will take into account constructor definition but not the internal implementation ?

Fixed here.

mykola · 2025-07-31T10:41:27Z

src/ai/free-sparks/application/free-sparks-endpoints-repository.php

+	 *
+	 * @var array<Free_Sparks_Endpoint_Interface>
+	 */
+	private $endpoints;


Can we remove this field ?

Fixed here.

mykola · 2025-07-31T10:41:40Z

src/ai/generate/application/generator-endpoints-repository.php

+	 *
+	 * @var array<Generator_Endpoint_Interface>
+	 */
+	private $endpoints;


Can we remove this field ?

Fixed here.

mykola · 2025-07-31T10:43:30Z

@pls78 please resolve merge conflicts.

…-related modules

This is done so that our DI container knows which endpoints to gather in each integration through the endpoints repo

github-actions · 2025-08-18T11:50:45Z

A merge conflict has been detected for the proposed code changes in this PR. Please resolve the conflict by either rebasing the PR or merging in changes from the base branch.

pls78 added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Jul 21, 2025

github-actions bot added the merge conflict label Jul 22, 2025

pls78 force-pushed the re-organize-ai-code branch from 77469ce to b982687 Compare July 24, 2025 12:33

github-actions bot removed the merge conflict label Jul 24, 2025

pls78 marked this pull request as ready for review July 25, 2025 10:08

github-actions bot added the merge conflict label Jul 30, 2025

mykola requested changes Jul 31, 2025

View reviewed changes

pls78 added 18 commits August 14, 2025 09:43

Add a parent ai directory and drop the ai_ prefix from all the AI…

75498a0

…-related modules

Update tests

8d7f580

Fix tests namespace

1cca8a3

Fix authorization namespace

18ea1aa

Fix cs

ccc70e0

Fix CS

bd9d526

Fix cs

fa82364

Refactor the endpoint logic

e9bf005

Introduce specialized Endpoint interfaces

b59212c

This is done so that our DI container knows which endpoints to gather in each integration through the endpoints repo

Rename and use specialized endpoint

20a4ca2

Implement endpoints repositories

ba3382f

Use endpoint repos

402afb8

Move base class

dd1be3f

Implement merge_with method

7c606c2

Fix cs

043fe28

Fix unit test

666c1ff

Rename Ai_Generator to Generate and fix namespace

5cfb2ce

rename ai-consent to consent

2d5c5ad

pls78 force-pushed the re-organize-ai-code branch from b982687 to 2d5c5ad Compare August 14, 2025 07:46

github-actions bot removed the merge conflict label Aug 14, 2025

pls78 added 4 commits August 14, 2025 11:42

Fix consent tests

3a23817

Fix authorization tests

17ae92a

Remove redundant attribute

1e05e2e

Fix cs

2c7f4c9

github-actions bot added the merge conflict label Aug 18, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Re organize ai code #22440

Re organize ai code #22440

pls78 commented Jul 16, 2025 •

edited

Loading

Uh oh!

coveralls commented Jul 16, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 22, 2025

Uh oh!

github-actions bot commented Jul 30, 2025

Uh oh!

mykola Jul 31, 2025

Uh oh!

pls78 Aug 14, 2025

Uh oh!

mykola Jul 31, 2025

Uh oh!

pls78 Aug 14, 2025

Uh oh!

mykola Jul 31, 2025

Uh oh!

pls78 Aug 14, 2025

Uh oh!

mykola Jul 31, 2025

Uh oh!

pls78 Aug 14, 2025

Uh oh!

mykola commented Jul 31, 2025

Uh oh!

github-actions bot commented Aug 18, 2025

Uh oh!

Uh oh!

Re organize ai code #22440

Are you sure you want to change the base?

Re organize ai code #22440

Conversation

pls78 commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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

Uh oh!

coveralls commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 44881b69ddc2a6cdc14ba46e26e0e855153f4d93

Details

💛 - Coveralls

Uh oh!

github-actions bot commented Jul 22, 2025

Uh oh!

github-actions bot commented Jul 30, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mykola commented Jul 31, 2025

Uh oh!

github-actions bot commented Aug 18, 2025

Uh oh!

Uh oh!

pls78 commented Jul 16, 2025 •

edited

Loading

coveralls commented Jul 16, 2025 •

edited

Loading