Handle running checks in loop and return output

[vishalkakadiya]

Description

Handle running checks one by one and return output.

This issue is dependent on the following:

• Create AJAX function and triggers and handling of progress indicator for the user #34
• AJAX Runtime Environment Setup/Cleanup #86
• Create plugin_check_get_checks_to_run endpoint #90

Acceptance Criteria

• Update the run_checks() method in the Admin_AJAX class to handle running checks and returning a response.
  • The run_checks method will first verify the request using the nonce passed and If invalid will return an error response.
  • Then the AJAX_Runner instance is gathered by calling the Plugin_Request_Utility::get_runner().
  • If the Plugin_Request_Utility::get_runner() returns null a new instance of the AJAX_Runner class should be created.
    • As part of creating the AJAX_Runner instance, the set_check_slugs() and set_plugin_slug () methods should be called passing in the appropriate values taken from the request.
  • Then the AJAX_Runners run() method is called and the Check_Results instance returned is stored in a variable.
  • If the run() method throws an exception, the error message is captured and returned in an error response to the client. The admin-plugin-check.js file will handle the error and display it on the admin page for debugging. Any further check requests will not be sent.
  • The results are then passed to the protected format_results() method in the Admin_AJAX class. This method will handle formatting all results into an array of messages, with each message being an object with the following properties.
    • message - The error or warning message.
    • type - Either error or warning.
    • standard - The standard or check name.
    • file - The filename and path
    • line_column - The line and column numbers the error/warning occurred.
  • A response is returned containing the following information
    • success - true or false as to whether the check run was successful.
    • results - The array of messages returned by format_results(). Can be an empty array.
    • check - The slug of the check that was run.
    • error - false if there were no critical errors when running checks, false if the check run was successful.
• Update the plugin-check-admin.js to send requests to the admin-ajax.php endpoint to run checks.
  • The checks_to_run returned by the plugin_check_get_checks_to_run action will be used to send requests for each individual check.
  • The first check is removed from the array and sent in the request.
  • The AJAX request will send the following:
    • A array containing a single check slug to be run
    • The plugin name to check.
    • A valid nonce.
  • On a successful response:
    • The messages returned will be injected into the admin page using the templates setup in Show check results on the page #35
    • The next check in the checks_to_run array is removed and used in the next request. This process will repeat until the checks_to_run is empty and the last check is run.
    • When all checks have been run and the checks_to_run array is empty the runtime environment cleanup is executed by making a request to the admin-ajax.php endpoint with the plugin_check_cleanup_environment action (implemented in AJAX Runtime Environment Setup/Cleanup #86)
  • On a error response:
    • A user-friendly error message is displayed in the admin page with the error that occurred.
    • The runtime environment cleanup function will be run by making a request to the admin-ajax.php endpoint with the plugin_check_cleanup_environment action (implemented in AJAX Runtime Environment Setup/Cleanup #86)

[felixarntz]

@vishalkakadiya Some notes regarding the eventual ACs here:

• We need to access the AJAX_Runner instance via the Plugin_Request_Utility::get_runner() method that is being implemented in Create Runtime_Environment_Setup and object-cache.php #80. (We need to include error handling, in case the instance is not set or not an AJAX_Runner instance.)
• The ACs should include which AJAX actions we need. I think at the minimum we will need individual AJAX actions to get the list of checks to run, prepare the environment, run a single check (called multiple times, one by one), then clean up the environment.

[jjgrainger]

Thanks @felixarntz

I had created a separate issue with AC's to handle to the environment setup and cleanup for AJAX here #86

I've referenced this in the AC's here but updated this ticket to tackle the action to get a list of checks to run and to run a single check which is called multiple times.

This is ready for you to review. Thanks!