Add site health check to detect blocked REST API and short-circuit optimization when Inaccessible #1762
Conversation
b1ink0
changed the title
There was a problem hiding this comment.
Should there be a plugin activation hook added as well which does add_option() for the new option and then also kicks off (or schedules) a REST API check? Ideally there would be a warning shown immediately after activating the plugin (e.g. on the plugins list table screen) whether the REST API is working so that the user doesn't have to discover it later via Site Health.
There was a problem hiding this comment.
Maybe put site-health in the root directory instead of inside includes since there are no other directories in there?
There was a problem hiding this comment.
I thought in future if we added something like admin dashboard for managing URL metrics or any other admin dashboard related thing then it would be better to add that feature in includes/admin. But we can just refactor things later when we need it so moving site-health to root makes sence.
There was a problem hiding this comment.
Yeah, let's put it in the root for now since all other directories are there.
if we added something like admin dashboard for managing URL metrics or any other admin dashboard related thing
Aside: I did put together a rough utility plugin for this: https://github.com/westonruter/od-admin-ui
| '<p>%s</p>', | ||
| esc_html__( 'The Optimization Detective endpoint could not be reached. This might mean the REST API is disabled or blocked.', 'optimization-detective' ) | ||
| ); | ||
| update_option( |
There was a problem hiding this comment.
This is the first PR that adds an option to to Optimization Detective. We'll need to make sure that the relevant delete_option() calls get added to the plugin's uninstall.php.
| // Disable detection if the REST API is disabled. | ||
| $od_rest_api_info = get_option( 'od_rest_api_info' ); | ||
| if ( is_array( $od_rest_api_info ) && isset( $od_rest_api_info['available'] ) ) { | ||
| $needs_detection = (bool) $od_rest_api_info['available']; | ||
| } | ||
|
|
There was a problem hiding this comment.
Actually, this check wouldn't make sense here. It should rather be done in od_maybe_add_template_output_buffer_filter() to short-circuit if the REST API it is not available.
| update_option( | ||
| 'od_rest_api_info', | ||
| array( | ||
| 'status' => 'error', |
There was a problem hiding this comment.
Should the $error->get_message() and maybe $error->get_code() be stored here?
| update_option( | ||
| 'od_rest_api_info', | ||
| array( | ||
| 'status' => 'forbidden', |
There was a problem hiding this comment.
Instead of storing the string, what about storing the $status_code instead?
| 'available' => false, | ||
| ) | ||
| ); | ||
| } |
There was a problem hiding this comment.
The else condition should be added as an error result as well. Here especially the $status_code could be used.
| && count( $expected_params ) === count( array_intersect( $data['data']['params'], $expected_params ) ) | ||
| ) { | ||
| // The REST API endpoint is available. | ||
| update_option( |
There was a problem hiding this comment.
Instead of having update_option() appearing in multiple places, each condition could populate an $info variable which is then sent into update_option() once at the end of the function.
westonruter
added
[Type] Enhancement
b1ink0
changed the title
| wp_schedule_event( time(), 'hourly', 'od_rest_api_health_check_event' ); | ||
| } | ||
| } | ||
| add_action( 'wp', 'od_schedule_rest_api_health_check' ); |
There was a problem hiding this comment.
Is this a best practice? Should it rather go in admin_init to avoid frontend writes? I'm not sure what others do here.
There was a problem hiding this comment.
I think scheduling on plugin activation hook will be better than admin_init.
| */ | ||
| function od_schedule_rest_api_health_check(): void { | ||
| if ( ! (bool) wp_next_scheduled( 'od_rest_api_health_check_event' ) ) { | ||
| wp_schedule_event( time(), 'hourly', 'od_rest_api_health_check_event' ); |
There was a problem hiding this comment.
I think hourly is too much. Maybe weekly would make sense.
Summary
Fixes #1731
Relevant technical choices
Adds a site health check to verify the availability and status of the
/optimization-detective/v1/url-metrics:storeREST API endpoint. The process will short-circuit if the endpoint is inaccessible.Scenarios:
When the health check passes
When the REST API endpoint returns a forbidden error
When the REST API endpoint returns an unauthorized error
When other errors are encountered
