AJAX Runtime Environment Setup/Cleanup

[jjgrainger]

This issue will implement the runtime environment setup and cleanup for AJAX requests. This will utilise the Runtime_Environment_Setup class to setup the WP environment before checks are run, and cleanup the environment once all checks are complete.

This issue is dependent on the following:

• Create plugin_check_get_checks_to_run endpoint #90

Acceptance Criteria

Create a Runtime Setup AJAX endpoint

• In the Admin_Ajax should create a new AJAX endpoint for the action plugin_check_setup_environment
• A new action is created for wp_ajax_plugin_check_setup_environment that calls a setup_environment method on the Admin_Ajax class.
• A public has_runtime_check method exists in the Abstract_Check_Runner class. This method will test the checks returned by get_checks_to_run(). If there is is at least 1 Runtime_Check it will return true, otherwise false.
• The setup_environment method.
  • This method will get an instance of the AJAX_Runner class via the Plugin_Request_Utility::get_runner() method.
    • If the Plugin_Request_Utility::get_runner() returns null a new instance of the AJAX_Runner class should be created.
  • Run the set_check_slugs() and set_plugin_slug () methods on the AJAX_Runner instance passing in the the appropriate values taken from the request.
  • The method will test if any of the checks requested are Runtime checks by calling the AJAX_Runner has_runtime_check() method. If this returns true the Runtime_Environment_Setup class will be instantiated and it's setup() method called.
  • The method will then return a JSON response for the AJAX request with the following structure { "success": true|false, "message": (string) success/error message }
    • An error response will be returned if setup had a critical error passing success as false and the message of the error that occured.
    • If the setup was successful, a success response will be returned with success as true and the message "runtime environment setup successful"
    • If the setup did not need to run, a success response will be returned with success as true and the message "no runtime checks, runtime environment was not setup"
• The plugin-check-admin.js file will be updated to first send an AJAX request to the admin-ajax.php endpoint with the plugin_check_setup_environment action before any check requests are sent.
• The request will also pass the plugin and checks to be run to the endpoint in order to determine if the runtime environment needs to be setup.
• If there is an error response, a user friendly error message will be displayed on the admin page and no further AJAX requests will be sent to attempt to run checks,

Create a Runtime Cleanup AJAX endpoint

• In the Admin_Ajax should create a new AJAX endpoint for the action plugin_check_cleanup_environment
• A new action is created for wp_ajax_plugin_check_cleanup_environment that calls a cleanup_environment method on the Admin_Ajax class.
• The cleanup_environment method:
  • This method will test if the runtime environment had been prepared by checking if the any of the tables with the wppc_ prefix exist.
  • If the wppc_ tables exist, the Runtime_Environment_Setup class will be instantiated and it's cleanup() method called.
  • The method will then return a JSON response for the AJAX request with the following structure { "success": true|false, "message": (string) success/error message }
    • An error response will be returned if cleanup had a critical error passing success as false and the message of the error that occured.
    • If the setup was successful, a success response will be returned with success as true and the message "runtime environment cleanup successful"
    • If the setup did not need to run, a success response will be returned with success as true and the message "Runtime environment was not prepared, cleanup was not run."
• The plugin-check-admin.js file will be updated to send a final AJAX request to the admin-ajax.php endpoint with the plugin_check_cleanup_environment action after all checks have been run.
• The request will also pass the plugin and checks to be run to the endpoint in order to determine if the runtime environment needs to be cleaned up.

[felixarntz]

@jjgrainger The ACs here overall look good. Just one critical related question: Which issue is responsible for implementing the AJAX action to get the list of checks to run (expose it to the client)? I'm asking because we will need this anyway to later send the individual AJAX requests (one per check), and we should preferably pass the list of checks to run to the two AJAX actions you're defining here as well, to make it more decoupled. In the future we may want to also add UI to provide more control on which checks to run, in which case this will become a necessity, but in terms of decoupling I think it's a good idea to already have the list of checks to run always be passed to the AJAX actions that in any way use checks.

And one nit-pick suggestion:

If the setup was successful, or did not need to run, a success response will be returned.

I would suggest we still add a way to differentiate the responses for whether the runtime preparation was made or not. Both should be success responses indeed, and we probably won't need to use this differentiation in the UI, but it will be useful for debugging as well as for unit testing.

[jjgrainger]

Thanks @felixarntz

The issue related to the endpoint to get the checks to run has been created here #90 based on your comment #84 (comment)

I've updated the AC's here to differentiate between the success response when either the runtime environment setup is successful or not run at all.

Please review and let me know if you have any other feedback. Thanks!