Fixes #1052

Description

In the ActionScheduler_Abstract_QueueRunner::process_action() function AS sets an error handler and any E_USER_ERROR or E_RECOVERABLE_ERROR error that occurs while processing the action is caught and thrown as an exception instead.

This is super handy for WooCommerce Subscriptions because AS will trigger the action_scheduler_failed_execution action which passes callbacks the exception that was caught.

WooCommerce Subscriptions uses this hook to log data about why our subscription-related scheduled actions have failed, however something I noticed today is that because AS is creating a new exception, if you use the $exception->getFile() $exception->getLine() helpers to point to where the exception occurred, it will point to AS, not where the error was actually thrown.

This is fixed by throwing an ErrorException which enables specifying the file and line where the error occurred.

Testing instructions

1. Add the following code snippet to your site to mimic an error occurring while processing an action.

add_action( 'action_scheduler_begin_execute', function() {
	trigger_error( 'Oops!', E_USER_ERROR );
} );

// Log the exception caught.
add_action( 'action_scheduler_failed_execution', function ( $action_id, $e ) {
	// When Action Scheduler throws an exception, it wraps the original exception in a new Exception. Information about the actual error is stored in the previous exception.
	$message = sprintf( 'a: %s in %s: %d', $e->getPrevious()->getMessage(), $e->getPrevious()->getFile(), $e->getPrevious()->getLine() );
	error_log( $message );
	ActionScheduler_Logger::instance()->log( $action_id, $message );
}, 10, 3 );

2. Go to Tools > Action Scheduler
3. Run any scheduled action
4. Check your error logs or the action logs
   • on trunk you'll notice the file and line points to AS
   • on this branch it will point to where the error was thrown. ie where you put the code snippet above.

trunk	This branch