De-duplicate logic between REST API and URL Metrics post type #1867
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Shyamsundar Gadde <[email protected]>
Signed-off-by: Shyamsundar Gadde <[email protected]>
Signed-off-by: Shyamsundar Gadde <[email protected]>
ShyamGadde
added
[Type] Enhancement
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## trunk #1867 +/- ##
=======================================
Coverage 69.59% 69.59%
=======================================
Files 86 86
Lines 6985 6983 -2
=======================================
- Hits 4861 4860 -1
+ Misses 2124 2123 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Signed-off-by: Shyamsundar Gadde <[email protected]>
ShyamGadde
commented
Feb 12, 2025
plugins/optimization-detective/storage/class-od-url-metrics-post-type.php
Outdated
Show resolved
Hide resolved
…etric Signed-off-by: Shyamsundar Gadde <[email protected]>
Signed-off-by: Shyamsundar Gadde <[email protected]>
ShyamGadde
requested review from
felixarntz and
adamsilverstein
as code owners
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
westonruter
reviewed
Feb 12, 2025
plugins/optimization-detective/storage/class-od-url-metrics-post-type.php
Show resolved
Hide resolved
westonruter
reviewed
Feb 12, 2025
Comment on lines
177
to
235
| $post_data = array( | ||
| 'post_title' => $new_url_metric->get_url(), | ||
| ); | ||
|
|
||
| $post = OD_URL_Metrics_Post_Type::get_post( $slug ); | ||
| if ( $post instanceof WP_Post ) { | ||
| $post_data['ID'] = $post->ID; | ||
| $post_data['post_name'] = $post->post_name; | ||
| $url_metrics = OD_URL_Metrics_Post_Type::get_url_metrics_from_post( $post ); | ||
| } else { | ||
| $post_data['post_name'] = $slug; | ||
| $url_metrics = array(); | ||
| } | ||
|
|
||
| $etag = $new_url_metric->get_etag(); | ||
|
|
||
| $group_collection = new OD_URL_Metric_Group_Collection( | ||
| $url_metrics, | ||
| $etag, | ||
| od_get_breakpoint_max_widths(), | ||
| od_get_url_metrics_breakpoint_sample_size(), | ||
| od_get_url_metric_freshness_ttl() | ||
| ); | ||
|
|
||
| try { | ||
| $group = $group_collection->get_group_for_viewport_width( $new_url_metric->get_viewport_width() ); | ||
| $group->add_url_metric( $new_url_metric ); | ||
| } catch ( InvalidArgumentException $e ) { | ||
| return new WP_Error( 'invalid_url_metric', $e->getMessage() ); | ||
| } | ||
|
|
||
| $post_data['post_content'] = wp_json_encode( | ||
| $group_collection->get_flattened_url_metrics(), | ||
| JSON_UNESCAPED_SLASHES // No need for escaping slashes since this JSON is not embedded in HTML. | ||
| ); | ||
| if ( ! is_string( $post_data['post_content'] ) ) { | ||
| return new WP_Error( 'json_encode_error', json_last_error_msg() ); | ||
| } | ||
|
|
||
| $has_kses = false !== has_filter( 'content_save_pre', 'wp_filter_post_kses' ); | ||
| if ( $has_kses ) { | ||
| // Prevent KSES from corrupting JSON in post_content. | ||
| kses_remove_filters(); | ||
| } | ||
|
|
||
| $post_data['post_type'] = OD_URL_Metrics_Post_Type::SLUG; | ||
| $post_data['post_status'] = 'publish'; | ||
| $slashed_post_data = wp_slash( $post_data ); | ||
| if ( isset( $post_data['ID'] ) ) { | ||
| $result = wp_update_post( $slashed_post_data, true ); | ||
| } else { | ||
| $result = wp_insert_post( $slashed_post_data, true ); | ||
| } | ||
|
|
||
| if ( $has_kses ) { | ||
| kses_init_filters(); | ||
| } | ||
|
|
||
| return $result; |
There was a problem hiding this comment.
Couldn't this be simplified now to just construct the OD_URL_Metric_Group_Collection, add the URL Metric to it, and then pass it to OD_URL_Metrics_Post_Type::update_post()?
There was a problem hiding this comment.
Makes sense. Done in aaf48f6.
Signed-off-by: Shyamsundar Gadde <[email protected]>
Signed-off-by: Shyamsundar Gadde <[email protected]>
westonruter
requested changes
Feb 27, 2025
plugins/optimization-detective/tests/class-optimization-detective-test-helpers.php
Outdated
Show resolved
Hide resolved
plugins/optimization-detective/storage/class-od-url-metrics-post-type.php
Outdated
Show resolved
Hide resolved
plugins/optimization-detective/tests/class-optimization-detective-test-helpers.php
Outdated
Show resolved
Hide resolved
plugins/optimization-detective/tests/storage/test-class-od-url-metrics-post-type.php
Outdated
Show resolved
Hide resolved
plugins/optimization-detective/tests/storage/test-class-od-url-metrics-post-type.php
Outdated
Show resolved
Hide resolved
Co-authored-by: Weston Ruter <[email protected]>
…andling Co-authored-by: Weston Ruter <[email protected]>
Signed-off-by: Shyamsundar Gadde <[email protected]>
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #1858
Relevant technical choices
OD_URL_Metrics_Post_Type::update_post( string $slug, string $post_title, OD_URL_Metric_Group_Collection $url_metric_group_collection )to replacestore_url_metric(), eliminating redundant logic.update_post()instead ofstore_url_metric(), ensuring the existingOD_URL_Metric_Group_Collectionis passed directly.store_url_metric()toOptimization_Detective_Test_Helpersfor test compatibility.