Skip to content

De-duplicate logic between REST API and URL Metrics post type #1867

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
westonruter merged 12 commits into from
Feb 27, 2025
Merged

De-duplicate logic between REST API and URL Metrics post type #1867

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
d83801e
Replace the store_url_metric method with update_post
ShyamGadde Feb 12, 2025
b1ccc83
Add test case for update_post method
ShyamGadde Feb 12, 2025
4909aed
Move store_url_metric method to Optimization_Detective_Test_Helpers
ShyamGadde Feb 12, 2025
f382547
Remove extra blank lines
ShyamGadde Feb 12, 2025
cf0ea0e
Sort URL Metrics in decreasing order by timestamp to get latest URL M…
ShyamGadde Feb 12, 2025
010f621
Add codeCoverageIgnore to logically unreachable exception handler
ShyamGadde Feb 12, 2025
aaf48f6
Refactor `store_url_metric()` to reuse `update_post()`
ShyamGadde Feb 13, 2025
2182053
Ensure update_post method handles empty URL Metric group collection
ShyamGadde Feb 13, 2025
6d3ddc5
Merge branch 'trunk' into update/logic-for-updating-url-metrics
westonruter Feb 27, 2025
fe93912
Improve docblocks for clarity
ShyamGadde Feb 27, 2025
b75838f
Simplify URL Metric addition logic and remove unnecessary exception h…
ShyamGadde Feb 27, 2025
e8cd6bd
Remove unused variable
ShyamGadde Feb 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...bed-optimizer/tests/test-cases/single-twitter-embed-outside-viewport-on-mobile/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

$sample_size = od_get_url_metrics_breakpoint_sample_size();
for ( $j = 0; $j < $sample_size; $j++ ) {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand Down
2 changes: 1 addition & 1 deletion ...ptimizer/tests/test-cases/single-wordpress-tv-embed-outside-viewport-on-mobile/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
$elements[0]['isLCP'] = false;
}

OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand Down
2 changes: 1 addition & 1 deletion ...s/test-cases/single-youtube-embed-inside-viewport-with-only-mobile-url-metrics/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
return static function ( Test_Embed_Optimizer_Optimization_Detective $test_case ): void {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand Down
2 changes: 1 addition & 1 deletion ...bed-optimizer/tests/test-cases/single-youtube-embed-outside-viewport-on-mobile/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

$sample_size = od_get_url_metrics_breakpoint_sample_size();
for ( $i = 0; $i < $sample_size; $i++ ) {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand Down
2 changes: 1 addition & 1 deletion .../test-cases/single-youtube-embed-outside-viewport-with-only-mobile-url-metrics/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
return static function ( Test_Embed_Optimizer_Optimization_Detective $test_case ): void {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand Down
4 changes: 2 additions & 2 deletions ...e-viewport-on-all-breakpoints-but-not-desktop-with-fully-populated-sample-data/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ static function () use ( $breakpoint_max_widths ) {

foreach ( $breakpoint_max_widths as $non_desktop_viewport_width ) {
for ( $i = 0; $i < $sample_size; $i++ ) {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand All @@ -32,7 +32,7 @@ static function () use ( $breakpoint_max_widths ) {
}

for ( $i = 0; $i < $sample_size; $i++ ) {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand Down
2 changes: 1 addition & 1 deletion ...ests/test-cases/background-image-outside-viewport-with-desktop-metrics-missing/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ static function () use ( $breakpoint_max_widths ) {
);

foreach ( $breakpoint_max_widths as $non_desktop_viewport_width ) {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand Down
2 changes: 1 addition & 1 deletion ...-image-and-lazy-loaded-image-outside-viewport-with-fully-populated-sample-data/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
$sample_size = od_get_url_metrics_breakpoint_sample_size();
foreach ( array_merge( od_get_breakpoint_max_widths(), array( 1000 ) ) as $viewport_width ) {
for ( $i = 0; $i < $sample_size; $i++ ) {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
$slug,
$test_case->get_sample_url_metric(
array(
Expand Down
2 changes: 1 addition & 1 deletion ...rioritizer/tests/test-cases/common-lcp-image-with-fully-incomplete-sample-data/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

// Only populate the largest (desktop) viewport group.
for ( $i = 0; $i < $sample_size; $i++ ) {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
$slug,
$test_case->get_sample_url_metric(
array(
Expand Down
2 changes: 1 addition & 1 deletion .../image-prioritizer/tests/test-cases/different-lcp-elements-for-all-breakpoints/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ static function () use ( $breakpoint_max_widths ) {
),
);
$elements[ $i ]['isLCP'] = true;
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand Down
4 changes: 2 additions & 2 deletions ...lements-for-non-consecutive-viewport-groups-with-missing-data-for-middle-group/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
return static function ( Test_Image_Prioritizer_Helper $test_case ): void {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand All @@ -20,7 +20,7 @@
)
)
);
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand Down
8 changes: 4 additions & 4 deletions ...es/different-lcp-elements-for-two-non-consecutive-breakpoints-and-one-is-stale/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ static function () {
}
);

OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand All @@ -25,7 +25,7 @@ static function () {
)
)
);
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand All @@ -43,7 +43,7 @@ static function () {
)
)
);
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand All @@ -61,7 +61,7 @@ static function () {
)
)
);
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand Down
8 changes: 4 additions & 4 deletions ...er/tests/test-cases/different-lcp-elements-for-two-non-consecutive-breakpoints/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ static function () {
}
);

OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand All @@ -25,7 +25,7 @@ static function () {
)
)
);
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand All @@ -43,7 +43,7 @@ static function () {
)
)
);
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand All @@ -61,7 +61,7 @@ static function () {
)
)
);
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand Down
4 changes: 2 additions & 2 deletions ...cp-image-common-on-mobile-and-desktop-with-url-metrics-missing-in-other-groups/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ static function () use ( $breakpoint_max_widths ) {
}
);

OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand All @@ -24,7 +24,7 @@ static function () use ( $breakpoint_max_widths ) {
)
);

OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand Down
2 changes: 1 addition & 1 deletion ...ge-prioritizer/tests/test-cases/images-located-above-or-along-initial-viewport/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

foreach ( array_merge( od_get_breakpoint_max_widths(), array( 1000 ) ) as $viewport_width ) {
for ( $i = 0; $i < $sample_size; $i++ ) {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
$slug,
$test_case->get_sample_url_metric(
array(
Expand Down
2 changes: 1 addition & 1 deletion plugins/image-prioritizer/tests/test-cases/img-non-native-lazy-loading/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
$slug = od_get_url_metrics_slug( od_get_normalized_query_vars() );

// Populate one URL Metric so that none of the IMG elements are unknown.
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
$slug,
$test_case->get_sample_url_metric(
array(
Expand Down
2 changes: 1 addition & 1 deletion ...ases/lcp-element-external-background-image-complete-samples-but-element-absent/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ static function () {
// Fully populate all viewport groups, but for all except desktop record that the LCP element had a different tag, id, or class.
foreach ( array_merge( od_get_breakpoint_max_widths(), array( 1000 ) ) as $i => $viewport_width ) {
for ( $j = 0; $j < $sample_size; $j++ ) {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
$slug,
$test_case->get_sample_url_metric(
array(
Expand Down
2 changes: 1 addition & 1 deletion ...ment-external-background-image-present-in-document-and-fully-populated-samples/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ static function () {
// Fully populate all viewport groups.
foreach ( array_merge( od_get_breakpoint_max_widths(), array( 1000 ) ) as $i => $viewport_width ) {
for ( $j = 0; $j < $sample_size; $j++ ) {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
$slug,
$test_case->get_sample_url_metric(
array(
Expand Down
4 changes: 2 additions & 2 deletions ...-external-background-image-present-in-document-and-partially-populated-samples/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ static function () {
// Partially populate all viewport groups.
foreach ( array_merge( od_get_breakpoint_max_widths(), array( 1000 ) ) as $i => $viewport_width ) {
for ( $j = 0; $j < $viewport_sample_sizes[ $i ]; $j++ ) {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
$slug,
$test_case->get_sample_url_metric(
array(
Expand All @@ -48,7 +48,7 @@ static function () {
}

// Store one more URL metric for desktop which has a different background image.
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
$slug,
$test_case->get_sample_url_metric(
array(
Expand Down
2 changes: 1 addition & 1 deletion plugins/image-prioritizer/tests/test-cases/multiple-videos-on-all-breakpoints/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ static function () use ( $breakpoint_max_widths ) {
);

foreach ( array_merge( $breakpoint_max_widths, array( 1000 ) ) as $viewport_width ) {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand Down
2 changes: 1 addition & 1 deletion ...mage-prioritizer/tests/test-cases/multiple-videos-with-desktop-metrics-missing/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ static function () use ( $breakpoint_max_widths ) {
);

foreach ( $breakpoint_max_widths as $non_desktop_viewport_width ) {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand Down
2 changes: 1 addition & 1 deletion ...mage-prioritizer/tests/test-cases/only-mobile-and-desktop-groups-are-populated/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ static function () {
// Populate the mobile and desktop viewport groups only.
foreach ( array( 400, 800 ) as $viewport_width ) {
for ( $i = 0; $i < $sample_size; $i++ ) {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
$slug,
$test_case->get_sample_url_metric(
array(
Expand Down
2 changes: 1 addition & 1 deletion ...zer/tests/test-cases/picture-element-as-lcp-tablet-and-desktop-metrics-missing/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ static function () use ( $breakpoint_max_widths ) {
// Only populate the mobile and phablet viewport groups.
foreach ( array( 480, 600 ) as $viewport_width ) {
for ( $i = 0; $i < $sample_size; $i++ ) {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
$slug,
$test_case->get_sample_url_metric(
array(
Expand Down
2 changes: 1 addition & 1 deletion plugins/image-prioritizer/tests/test-cases/responsive-background-images/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ static function () use ( $mobile_breakpoint, $tablet_breakpoint ): array {

foreach ( $div_index_to_viewport_width_mapping as $div_index => $viewport_width ) {
for ( $i = 0; $i < $sample_size; $i++ ) {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
$slug,
$test_case->get_sample_url_metric(
array(
Expand Down
2 changes: 1 addition & 1 deletion ...image-prioritizer/tests/test-cases/url-metric-only-captured-for-one-breakpoint/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
return static function ( Test_Image_Prioritizer_Helper $test_case ): void {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand Down
2 changes: 1 addition & 1 deletion ...zer/tests/test-cases/video-with-large-poster-and-desktop-url-metrics-collected/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ static function () use ( $breakpoint_max_widths ) {
);

foreach ( array_merge( $breakpoint_max_widths, array( 1000 ) ) as $viewport_width ) {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand Down
2 changes: 1 addition & 1 deletion ...tizer/tests/test-cases/video-with-large-poster-and-desktop-url-metrics-missing/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ static function () use ( $breakpoint_max_widths ) {
);

foreach ( $breakpoint_max_widths as $non_desktop_viewport_width ) {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand Down
2 changes: 1 addition & 1 deletion ...-prioritizer/tests/test-cases/video-with-poster-lcp-element-on-all-breakpoints/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ static function () use ( $breakpoint_max_widths ) {
);

foreach ( array_merge( $breakpoint_max_widths, array( 1000 ) ) as $viewport_width ) {
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand Down
4 changes: 2 additions & 2 deletions ...age-prioritizer/tests/test-cases/video-with-poster-lcp-element-on-desktop-only/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ static function () use ( $breakpoint_max_widths ) {
'xpath' => '/HTML/BODY/DIV[@id=\'page\']/*[2][self::VIDEO]',
),
);
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand All @@ -31,7 +31,7 @@ static function () use ( $breakpoint_max_widths ) {
);
}

OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand Down
6 changes: 3 additions & 3 deletions .../test-cases/video-with-poster-lcp-element-on-mobile-and-desktop-but-not-tablet/set-up.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ static function () use ( $breakpoint_max_widths ) {
}
);

OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand Down Expand Up @@ -39,7 +39,7 @@ static function () use ( $breakpoint_max_widths ) {
'xpath' => '/HTML/BODY/DIV[@id=\'page\']/*[2][self::VIDEO]',
),
);
OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand All @@ -50,7 +50,7 @@ static function () use ( $breakpoint_max_widths ) {
);
}

OD_URL_Metrics_Post_Type::store_url_metric(
$test_case->store_url_metric(
od_get_url_metrics_slug( od_get_normalized_query_vars() ),
$test_case->get_sample_url_metric(
array(
Expand Down
Loading