Enhancement/11278 worker email sending #11874

zutigrm · 2025-12-03T18:04:38Z

Summary

Addresses issue:

"Worker" scheduled event email report generation and email sending logic #11278

Relevant technical choices

There were more adaptation and adjustment of the pipeline data than anticipated to render all section parts correctly. PR grew quite big, I also refactored several classes for improvement purposes and to simplify them into more leaner classes where possible. All Search Console metrics have been implemented as part of this PR as well.

PR Author Checklist

My code is tested and passes existing unit tests.
My code has an appropriate set of unit tests which all pass.
My code is backward-compatible with WordPress 5.2 and PHP 7.4.
My code follows the WordPress coding standards.
My code has proper inline documentation.
I have added a QA Brief on the issue linked above.
I have signed the Contributor License Agreement (see https://cla.developers.google.com/).

Do not alter or remove anything below. The following sections will be managed by moderators only.

Code Reviewer Checklist

Run the code.
Ensure the acceptance criteria are satisfied.
Reassess the implementation with the IB.
Ensure no unrelated changes are included.
Ensure CI checks pass.
Check Storybook where applicable.
Ensure there is a QA Brief.
Ensure there are no unexpected significant changes to file sizes.

Merge Reviewer Checklist

Ensure the PR has the correct target branch.
Double-check that the PR is okay to be merged.
Ensure the corresponding issue has a ZenHub release assigned.
Add a changelog message to the issue.

github-actions · 2025-12-03T18:08:44Z

Build files for 857fa3e have been deleted.

…worker-email-sending.

…ta format.

benbowler

Hey @zutigrm, alongside @tofumatt's review, I've reviewed the code and have a few comments inline below to look at.

Also, I noticed that the template preview was broken because of all of the data key/structure changes. Rather than have you get up to speed on the preview setup, I updated this for you and pushed a commit here: 1222b54

I have now tested this with the tester plugin updates as well and we're looking good.

includes/Core/Email_Reporting/templates/email-report/parts/section-conversions-metric-part.php

includes/Core/Email_Reporting/templates/email-report/parts/section-metrics.php

benbowler · 2025-12-10T10:21:38Z

includes/Core/Email_Reporting/Sections_Map.php

+		// If no conversion data is present in payload it means user do not have conversion tracking set up
+		// or no data is received yet and we can skip this section.
+		if ( empty( $this->payload['total_conversion_events'] ) || ! isset( $this->payload['total_conversion_events'] ) ) {
+			return null;


These should return an empty array otherwise the array_merge above fails with an error if this data is missing.

As mentioned by Ben: this needs to return an empty array, not null.

There is a check for this section being empty in get_sections, so no error would be raised, but thinking about it not sure why I complicated it with that, since empty array would not require additional guard and is more straightforward

benbowler · 2025-12-10T10:21:50Z

includes/Core/Email_Reporting/Sections_Map.php

 	 */
 	protected function get_growth_drivers_section() {
+		if ( empty( $this->payload['keywords_ctr_increase'] ) && empty( $this->payload['pages_clicks_increase'] ) ) {
+			return null;


These should return an empty array otherwise the array_merge above fails with an error if this data is missing.

(Please address this one too.)

Same as above, no error would be raised, but simplified it with empty array

includes/Core/Email_Reporting/Email_Reporting_Data_Requests.php

tofumatt

Overall looks good, just a few return values and small things I noticed, though admittedly it's a big PR to take in 😅

tofumatt · 2025-12-11T14:05:44Z

includes/Core/Email_Reporting/Sections_Map.php

+		// If no conversion data is present in payload it means user do not have conversion tracking set up
+		// or no data is received yet and we can skip this section.
+		if ( empty( $this->payload['total_conversion_events'] ) || ! isset( $this->payload['total_conversion_events'] ) ) {
+			return null;


As mentioned by Ben: this needs to return an empty array, not null.

tofumatt · 2025-12-11T14:06:13Z

includes/Core/Email_Reporting/Sections_Map.php

 	 */
 	protected function get_growth_drivers_section() {
+		if ( empty( $this->payload['keywords_ctr_increase'] ) && empty( $this->payload['pages_clicks_increase'] ) ) {
+			return null;


(Please address this one too.)

tofumatt · 2025-12-11T14:08:18Z

includes/Core/Email_Reporting/templates/email-report/parts/section-page-metrics.php

 		</td>
 	</tr>
 </table>
-


Please keep newlines at the end of files. 🙏🏻

Not sure what is weirder, my VS code stripping last line at random on some files, or linter not detecting it 🤔

tofumatt · 2025-12-11T14:09:05Z

includes/Modules/Analytics_4/Email_Reporting/Report_Data_Builder.php

+	 * @param Email_Report_Payload_Processor|null $report_processor    Optional. Report processor instance.
+	 * @param Report_Data_Processor|null          $data_processor       Optional. Analytics data processor.
+	 * @param array                               $audience_display_map Optional. Audience resource => display name map.
+	 * @param Context|null                        $context             Optional. Plugin context for audience lookup.


These should line up; not sure why the linter doesn't catch it 😢

Suggested change

* @param Email_Report_Payload_Processor|null $report_processor Optional. Report processor instance.

* @param Report_Data_Processor|null $data_processor Optional. Analytics data processor.

* @param array $audience_display_map Optional. Audience resource => display name map.

* @param Context|null $context Optional. Plugin context for audience lookup.

* @param Email_Report_Payload_Processor|null $report_processor Optional. Report processor instance.

* @param Report_Data_Processor|null $data_processor Optional. Analytics data processor.

* @param array $audience_display_map Optional. Audience resource => display name map.

* @param Context|null $context Optional. Plugin context for audience lookup.

tofumatt · 2025-12-11T14:24:01Z

includes/Modules/Search_Console/Email_Reporting/Report_Data_Builder.php

+	protected function format_value( $value ) {
+		if ( ! is_numeric( $value ) ) {
+			return $value;
+		}
+
+		$number = (float) $value;
+		$abs    = abs( $number );
+
+		if ( $abs >= 1000000 ) {
+			return round( $number / 1000000, 1 ) . 'M';
+		}
+
+		if ( $abs >= 1000 ) {
+			return round( $number / 1000, 1 ) . 'K';
+		}
+
+		return (string) round( $number );
+	}


The rest of the reports are translated/localisation; isn't this a bit English-specific and not properly localised? 🤔

Additionally: what happens if there are billions in the number? 😆

Good catch, I updated this to translatable, and added billions abbreviation

…worker-email-sending.

…oogle/site-kit-wp into enhancement/11278-worker-email-sending.

zutigrm · 2025-12-12T00:03:01Z

Thanks @benbowler and @tofumatt PR updated

…errors being thrown and us correct context for admin request mocks.

zutigrm added 8 commits December 3, 2025 18:14

Update Email_Log to correctly normalise/sanitize timestamp.

bb71d90

Add dimensions, dimension_values and event_names to the section part.

b08f43b

Update Email_Report_Section_Builder to align with report data pipeline.

131abfa

Fix collect_payloads and retrieval of conversion events.

1559e25

Skip conversion section when no data/events are present.

9e644df

Add Email_Template_Formatter class.

739735d

Instantiate helper classes and update Worker instance arguments.

78b338d

Add Email_Template_Renderer.

41c4c22

zutigrm added 19 commits December 3, 2025 19:18

Refactor Conversion metrics template part.

bddd128

Refactor Conversions template part.

03a1e24

Add Email_Log_Processor class.

38d6d33

Add Email_Report_Sender.

318b8df

Instantiate new classes and update Worker_Task dependencies.

b4a5809

Update Worker_Task.

c1879aa

Update data requests class to use batch requests.

0b580bf

Skip validating event_names when they are not passed.

0ec51b8

Add missing abort check in Worker.

7eaa9cd

Update Email_Reporting_Data_RequestsTest.

02cbbb1

Update worker tests.

e241e9c

Fix conflicts.

0f95d38

Fix since tag.

3e78eb1

Improve error handling in Email_Report_Sender.

a9a5cb2

Enforce integer for timestamp format.

cdecdd2

Fix Email_Report_Section_BuilderTest tests.

08c7a41

Improve section builder payload.

97120cd

Fix failing test.

3175e7c

Sync with email templates PR.

0558557

zutigrm changed the base branch from develop to enhancement/11550-finish-email-reporting-template December 4, 2025 23:08

Include page titles for popular content report options.

b715c28

zutigrm and others added 15 commits December 8, 2025 16:43

Add build_list_with_compare.

542965e

Remove unecesarry sort_rows_by_date.

90f1e9d

Add get_compare_range.

e1a13f6

Merge remote-tracking branch 'origin/develop' into enhancement/11278-…

7d21661

…worker-email-sending.

Fix failing test.

f509fb4

Fix change context in remaining sections.

5794c42

Add compare text.

6e24d4e

Skip section with new metrics.

ddbaaf5

Fix conflict.

21df7d4

Add 2 remaining SC metrics.

f92ffa8

Rename last 2 SC metrics slugs.

b1c0c23

Enable get_growth_drivers_section.

e2844ac

Include requests for new sections.

6206286

Skip last section when empty.

ae8275c

Update mock_data so the preview continues to function with the new da…

1222b54

…ta format.

benbowler requested changes Dec 10, 2025

View reviewed changes

tofumatt requested changes Dec 11, 2025

View reviewed changes

zutigrm added 7 commits December 11, 2025 23:53

Merge remote-tracking branch 'origin/develop' into enhancement/11278-…

4a7ae98

…worker-email-sending.

Fix newline.

959de92

Return error on incomplete batch.

fb2a1d1

Fix sections.

3341a9d

Fix alignement.

c508478

Add number abbr translations.

f050404

Merge branch 'enhancement/11278-worker-email-sending' of github.com:g…

906c1ef

…oogle/site-kit-wp into enhancement/11278-worker-email-sending.

benbowler approved these changes Dec 15, 2025

View reviewed changes

Fix failing tests by returning complete batch data response to avoid …

857fa3e

…errors being thrown and us correct context for admin request mocks.

tofumatt approved these changes Dec 15, 2025

View reviewed changes

tofumatt merged commit 1ff5ac0 into develop Dec 15, 2025
21 of 22 checks passed

tofumatt deleted the enhancement/11278-worker-email-sending branch December 15, 2025 17:01

Enhancement/11278 worker email sending #11874

Enhancement/11278 worker email sending #11874

Uh oh!

Conversation

zutigrm commented Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Relevant technical choices

PR Author Checklist

Code Reviewer Checklist

Merge Reviewer Checklist

Uh oh!

github-actions bot commented Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

benbowler left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zutigrm Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

Uh oh!

tofumatt left a comment

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!

zutigrm commented Dec 12, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

zutigrm commented Dec 3, 2025 •

edited

Loading

github-actions bot commented Dec 3, 2025 •

edited

Loading

zutigrm Dec 11, 2025 •

edited

Loading