Levente/PartnerExpo-Core
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Squashed 'libraries/action-scheduler/' content from commit a95f351

Browse Source 
git-subtree-dir: libraries/action-scheduler
git-subtree-split: a95f351058eada5e5281faa22e5a40865542e839
This commit is contained in:
Duskell
2026-03-16 13:15:04 +01:00
commit d435f549fe
174 changed files with 32087 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

613
tests/phpunit/runner/ActionScheduler_QueueRunner_Test.php Normal file
View File

@@ -0,0 +1,613 @@
<?php
/**
* Class ActionScheduler_QueueRunner_Test
* @group runners
*/
class ActionScheduler_QueueRunner_Test extends ActionScheduler_UnitTestCase {
public function test_create_runner() {
$store = ActionScheduler::store();
$runner = ActionScheduler_Mocker::get_queue_runner( $store );
$actions_run = $runner->run();
$this->assertEquals( 0, $actions_run );
}
public function test_run() {
$store = ActionScheduler::store();
$runner = ActionScheduler_Mocker::get_queue_runner( $store );
$mock = new MockAction();
$random = md5( wp_rand() );
add_action( $random, array( $mock, 'action' ) );
$schedule = new ActionScheduler_SimpleSchedule( as_get_datetime_object( '1 day ago' ) );
for ( $i = 0; $i < 5; $i++ ) {
$action = new ActionScheduler_Action( $random, array( $random ), $schedule );
$store->save_action( $action );
}
$actions_run = $runner->run();
remove_action( $random, array( $mock, 'action' ) );
$this->assertEquals( 5, $mock->get_call_count() );
$this->assertEquals( 5, $actions_run );
}
public function test_run_with_future_actions() {
$store = ActionScheduler::store();
$runner = ActionScheduler_Mocker::get_queue_runner( $store );
$mock = new MockAction();
$random = md5( wp_rand() );
add_action( $random, array( $mock, 'action' ) );
$schedule = new ActionScheduler_SimpleSchedule( as_get_datetime_object( '1 day ago' ) );
for ( $i = 0; $i < 3; $i++ ) {
$action = new ActionScheduler_Action( $random, array( $random ), $schedule );
$store->save_action( $action );
}
$schedule = new ActionScheduler_SimpleSchedule( as_get_datetime_object( 'tomorrow' ) );
for ( $i = 0; $i < 3; $i++ ) {
$action = new ActionScheduler_Action( $random, array( $random ), $schedule );
$store->save_action( $action );
}
$actions_run = $runner->run();
remove_action( $random, array( $mock, 'action' ) );
$this->assertEquals( 3, $mock->get_call_count() );
$this->assertEquals( 3, $actions_run );
}
/**
* When an action is processed, it is set to "in-progress" (running) status immediately before the
* callback is invoked. If this fails (which could be because it is already in progress) then the
* action should be skipped.
*
* @return void
*/
public function test_run_with_action_that_is_already_in_progress() {
$store = ActionScheduler::store();
$hook = uniqid();
$callback = function () {};
$count = 0;
$actions = array();
$completed = array();
$schedule = new ActionScheduler_SimpleSchedule( as_get_datetime_object( '1 day ago' ) );
for ( $i = 0; $i < 3; $i++ ) {
$actions[] = $store->save_action( new ActionScheduler_Action( $hook, array( $hook ), $schedule ) );
}
/**
* This function "sabotages" the next action by prematurely setting its status to "in-progress", simulating
* an edge case where a concurrent process runs the action.
*/
$saboteur = function () use ( &$count, $store, $actions ) {
if ( 0 === $count++ ) {
$store->log_execution( $actions[1] );
}
};
/**
* @param int $action_id The ID of the recently completed action.
*
* @return void
*/
$spy = function ( $action_id ) use ( &$completed ) {
$completed[] = $action_id;
};
add_action( 'action_scheduler_begin_execute', $saboteur );
add_action( 'action_scheduler_completed_action', $spy );
add_action( $hook, $callback );
$actions_attempted = ActionScheduler_Mocker::get_queue_runner( $store )->run();
remove_action( 'action_scheduler_begin_execute', $saboteur );
remove_action( 'action_scheduler_completed_action', $spy );
remove_action( $hook, $callback );
$this->assertEquals( 3, $actions_attempted, 'The queue runner attempted to process all 3 actions.' );
$this->assertEquals( array( $actions[0], $actions[2] ), $completed, 'Only two of the three actions were completed (one was skipped, because it was processed by a concurrent request).' );
}
public function test_completed_action_status() {
$store = ActionScheduler::store();
$runner = ActionScheduler_Mocker::get_queue_runner( $store );
$random = md5( wp_rand() );
$schedule = new ActionScheduler_SimpleSchedule( as_get_datetime_object( '12 hours ago' ) );
$action = new ActionScheduler_Action( $random, array(), $schedule );
$action_id = $store->save_action( $action );
$runner->run();
$finished_action = $store->fetch_action( $action_id );
$this->assertTrue( $finished_action->is_finished() );
}
public function test_next_instance_of_cron_action() {
// Create an action with daily Cron expression (i.e. midnight each day).
$random = md5( wp_rand() );
$action_id = ActionScheduler::factory()->cron( $random, array(), null, '0 0 * * *' );
$store = ActionScheduler::store();
$runner = ActionScheduler_Mocker::get_queue_runner( $store );
// Make sure the 1st instance of the action is scheduled to occur tomorrow.
$date = as_get_datetime_object( 'tomorrow' );
$date->modify( '-1 minute' );
$claim = $store->stake_claim( 10, $date );
$this->assertCount( 0, $claim->get_actions() );
$store->release_claim( $claim );
$date->modify( '+1 minute' );
$claim = $store->stake_claim( 10, $date );
$actions = $claim->get_actions();
$this->assertCount( 1, $actions );
$fetched_action_id = reset( $actions );
$fetched_action = $store->fetch_action( $fetched_action_id );
$this->assertEquals( $fetched_action_id, $action_id );
$this->assertEquals( $random, $fetched_action->get_hook() );
$this->assertEquals( $date->getTimestamp(), $fetched_action->get_schedule()->get_date()->getTimestamp(), '', 1 );
$store->release_claim( $claim );
// Make sure the 2nd instance of the cron action is scheduled to occur tomorrow still.
$runner->process_action( $action_id );
$claim = $store->stake_claim( 10, $date );
$actions = $claim->get_actions();
$this->assertCount( 1, $actions );
$fetched_action_id = reset( $actions );
$fetched_action = $store->fetch_action( $fetched_action_id );
$this->assertNotEquals( $fetched_action_id, $action_id );
$this->assertEquals( $random, $fetched_action->get_hook() );
$this->assertEquals( $date->getTimestamp(), $fetched_action->get_schedule()->get_date()->getTimestamp(), '', 1 );
}
public function test_next_instance_of_interval_action() {
$random = md5( wp_rand() );
$date = as_get_datetime_object( '12 hours ago' );
$store = ActionScheduler::store();
$runner = ActionScheduler_Mocker::get_queue_runner( $store );
// Create an action to recur every 24 hours, with the first instance scheduled to run 12 hours ago.
$action_id = ActionScheduler::factory()->create(
array(
'type' => 'recurring',
'hook' => $random,
'when' => $date->getTimestamp(),
'pattern' => DAY_IN_SECONDS,
'priority' => 2,
)
);
// Make sure the 1st instance of the action is scheduled to occur 12 hours ago.
$claim = $store->stake_claim( 10, $date );
$actions = $claim->get_actions();
$this->assertCount( 1, $actions );
$fetched_action_id = reset( $actions );
$fetched_action = $store->fetch_action( $fetched_action_id );
$this->assertEquals( $fetched_action_id, $action_id );
$this->assertEquals( $random, $fetched_action->get_hook() );
$this->assertEquals( $date->getTimestamp(), $fetched_action->get_schedule()->get_date()->getTimestamp(), '', 1 );
$store->release_claim( $claim );
// Make sure after the queue is run, the 2nd instance of the action is scheduled to occur in 24 hours.
$runner->run();
$date = as_get_datetime_object( '+1 day' );
$claim = $store->stake_claim( 10, $date );
$actions = $claim->get_actions();
$this->assertCount( 1, $actions );
$fetched_action_id = reset( $actions );
$fetched_action = $store->fetch_action( $fetched_action_id );
$this->assertNotEquals( $fetched_action_id, $action_id );
$this->assertEquals( $random, $fetched_action->get_hook() );
$this->assertEquals( $date->getTimestamp(), $fetched_action->get_schedule()->get_date()->getTimestamp(), '', 1 );
$this->assertEquals( 2, $fetched_action->get_priority(), 'The replacement action should inherit the same priority as the original action.' );
$store->release_claim( $claim );
// Make sure the 3rd instance of the cron action is scheduled for 24 hours from now, as the action was run early, ahead of schedule.
$runner->process_action( $fetched_action_id );
$date = as_get_datetime_object( '+1 day' );
$claim = $store->stake_claim( 10, $date );
$actions = $claim->get_actions();
$this->assertCount( 1, $actions );
$fetched_action_id = reset( $actions );
$fetched_action = $store->fetch_action( $fetched_action_id );
$this->assertNotEquals( $fetched_action_id, $action_id );
$this->assertEquals( $random, $fetched_action->get_hook() );
$this->assertEquals( $date->getTimestamp(), $fetched_action->get_schedule()->get_date()->getTimestamp(), '', 1 );
}
/**
* As soon as one recurring action has been executed its replacement will be scheduled.
*
* This is true even if the current action fails. This makes sense, since a failure may be temporary in nature.
* However, if the same recurring action consistently fails then it is likely that there is a problem and we should
* stop creating new instances. This test outlines the expected behavior in this regard.
*
* @return void
*/
public function test_failing_recurring_actions_are_not_rescheduled_when_threshold_met() {
$store = ActionScheduler_Store::instance();
$runner = ActionScheduler_Mocker::get_queue_runner( $store );
$created_actions = array();
// Create 4 failed actions (one below the threshold of what counts as 'consistently failing').
for ( $i = 0; $i < 3; $i++ ) {
// We give each action a unique set of args, this illustrates that in the context of determining consistent
// failure we care only about the hook and not other properties of the action.
$args = array( 'unique-' . $i => hash( 'md5', $i ) );
$hook = 'will-fail';
$date = as_get_datetime_object( 12 - $i . ' hours ago' );
$action_id = as_schedule_recurring_action( $date->getTimestamp(), HOUR_IN_SECONDS, $hook, $args );
$store->mark_failure( $action_id );
$created_actions[] = $action_id;
}
// Now create a further action using the same hook, that is also destined to fail.
$date = as_get_datetime_object( '6 hours ago' );
$pending_action_id = as_schedule_recurring_action( $date->getTimestamp(), HOUR_IN_SECONDS, $hook, $args );
$created_actions[] = $pending_action_id;
// Process the queue!
$runner->run();
$pending_actions = $store->query_actions(
array(
'hook' => $hook,
'args' => $args,
'status' => ActionScheduler_Store::STATUS_PENDING,
)
);
$new_pending_action_id = current( $pending_actions );
// We now have 5 instances of the same recurring action. 4 have already failed, one is pending.
$this->assertCount( 1, $pending_actions, 'If the threshold for consistent failure has not been met, a replacement action should have been scheduled.' );
$this->assertNotContains( $new_pending_action_id, $created_actions, 'Confirm that the replacement action is new, and not one of those we created manually earlier in the test.' );
// Process the pending action (we do this directly instead of via `$runner->run()` because it won't actually
// become due for another hour).
$runner->process_action( $new_pending_action_id );
$pending_actions = $store->query_actions(
array(
'hook' => $hook,
'args' => $args,
'status' => ActionScheduler_Store::STATUS_PENDING,
)
);
// Now 5 instances of the same recurring action have all failed, therefore the threshold for consistent failure
// has been met and, this time, a new action should *not* have been scheduled.
$this->assertCount( 0, $pending_actions, 'The failure threshold (5 consecutive fails for recurring actions with the same signature) having been met, no further actions were scheduled.' );
}
/**
* If a recurring action continually fails, it will not be re-scheduled. However, a hook makes it possible to
* exempt specific actions from this behavior (without impacting other unrelated recurring actions).
*
* @see self::test_failing_recurring_actions_are_not_rescheduled_when_threshold_met()
* @return void
*/
public function test_exceptions_can_be_made_for_failing_recurring_actions() {
$store = ActionScheduler_Store::instance();
$runner = ActionScheduler_Mocker::get_queue_runner( $store );
$observed = 0;
// Create 2 sets of 5 actions that have already past and have already failed (five being the threshold of what
// counts as 'consistently failing').
for ( $i = 0; $i < 4; $i++ ) {
$date = as_get_datetime_object( 12 - $i . ' hours ago' );
$store->mark_failure( as_schedule_recurring_action( $date->getTimestamp(), HOUR_IN_SECONDS, 'foo' ) );
$store->mark_failure( as_schedule_recurring_action( $date->getTimestamp(), HOUR_IN_SECONDS, 'bar' ) );
}
// Add one more action (pending and past-due) to each set.
$date = as_get_datetime_object( '6 hours ago' );
as_schedule_recurring_action( $date->getTimestamp(), HOUR_IN_SECONDS, 'foo' );
as_schedule_recurring_action( $date->getTimestamp(), HOUR_IN_SECONDS, 'bar' );
// Define a filter function that allows scheduled actions for hook 'foo' to still be rescheduled, despite its
// history of consistent failure.
$filter = function( $is_failing, $action ) use ( &$observed ) {
$observed++;
return 'foo' === $action->get_hook() ? false : $is_failing;
};
// Process the queue with our consistent-failure filter function in place.
add_filter( 'action_scheduler_recurring_action_is_consistently_failing', $filter, 10, 2 );
$runner->run();
// Check how many (if any) of our test actions were re-scheduled.
$pending_foo_actions = $store->query_actions(
array(
'hook' => 'foo',
'status' => ActionScheduler_Store::STATUS_PENDING,
)
);
$pending_bar_actions = $store->query_actions(
array(
'hook' => 'bar',
'status' => ActionScheduler_Store::STATUS_PENDING,
)
);
// Expectations...
$this->assertCount( 1, $pending_foo_actions, 'We expect a new instance of action "foo" will have been scheduled.' );
$this->assertCount( 0, $pending_bar_actions, 'We expect no further instances of action "bar" will have been scheduled.' );
$this->assertEquals( 2, $observed, 'We expect our callback to have been invoked twice, once in relation to each test action.' );
// Clean-up...
remove_filter( 'action_scheduler_recurring_action_is_consistently_failing', $filter, 10, 2 );
}
public function test_hooked_into_wp_cron() {
$next = wp_next_scheduled( ActionScheduler_QueueRunner::WP_CRON_HOOK, array( 'WP Cron' ) );
$this->assertNotEmpty( $next );
}
public function test_batch_count_limit() {
$store = ActionScheduler::store();
$runner = ActionScheduler_Mocker::get_queue_runner( $store );
$mock = new MockAction();
$random = md5( wp_rand() );
add_action( $random, array( $mock, 'action' ) );
$schedule = new ActionScheduler_SimpleSchedule( new ActionScheduler_DateTime( '1 day ago' ) );
for ( $i = 0; $i < 2; $i++ ) {
$action = new ActionScheduler_Action( $random, array( $random ), $schedule );
$store->save_action( $action );
}
$claim = $store->stake_claim();
$actions_run = $runner->run();
$this->assertEquals( 0, $mock->get_call_count() );
$this->assertEquals( 0, $actions_run );
$store->release_claim( $claim );
$actions_run = $runner->run();
$this->assertEquals( 2, $mock->get_call_count() );
$this->assertEquals( 2, $actions_run );
remove_action( $random, array( $mock, 'action' ) );
}
public function test_changing_batch_count_limit() {
$store = ActionScheduler::store();
$runner = ActionScheduler_Mocker::get_queue_runner( $store );
$random = md5( wp_rand() );
$schedule = new ActionScheduler_SimpleSchedule( new ActionScheduler_DateTime( '1 day ago' ) );
for ( $i = 0; $i < 30; $i++ ) {
$action = new ActionScheduler_Action( $random, array( $random ), $schedule );
$store->save_action( $action );
}
$claims = array();
for ( $i = 0; $i < 5; $i++ ) {
$claims[] = $store->stake_claim( 5 );
}
$mock1 = new MockAction();
add_action( $random, array( $mock1, 'action' ) );
$actions_run = $runner->run();
remove_action( $random, array( $mock1, 'action' ) );
$this->assertEquals( 0, $mock1->get_call_count() );
$this->assertEquals( 0, $actions_run );
add_filter( 'action_scheduler_queue_runner_concurrent_batches', array( $this, 'return_6' ) );
$mock2 = new MockAction();
add_action( $random, array( $mock2, 'action' ) );
$actions_run = $runner->run();
remove_action( $random, array( $mock2, 'action' ) );
$this->assertEquals( 5, $mock2->get_call_count() );
$this->assertEquals( 5, $actions_run );
remove_filter( 'action_scheduler_queue_runner_concurrent_batches', array( $this, 'return_6' ) );
for ( $i = 0; $i < 5; $i++ ) { // to make up for the actions we just processed.
$action = new ActionScheduler_Action( $random, array( $random ), $schedule );
$store->save_action( $action );
}
$mock3 = new MockAction();
add_action( $random, array( $mock3, 'action' ) );
$actions_run = $runner->run();
remove_action( $random, array( $mock3, 'action' ) );
$this->assertEquals( 0, $mock3->get_call_count() );
$this->assertEquals( 0, $actions_run );
remove_filter( 'action_scheduler_queue_runner_concurrent_batches', array( $this, 'return_6' ) );
}
public function return_6() {
return 6;
}
public function test_store_fetch_action_failure_schedule_next_instance() {
$random = md5( wp_rand() );
$schedule = new ActionScheduler_IntervalSchedule( as_get_datetime_object( '12 hours ago' ), DAY_IN_SECONDS );
$action = new ActionScheduler_Action( $random, array(), $schedule );
$action_id = ActionScheduler::store()->save_action( $action );
// Set up a mock store that will throw an exception when fetching actions.
$store = $this
->getMockBuilder( 'ActionScheduler_wpPostStore' )
->setMethods( array( 'fetch_action' ) )
->getMock();
$store
->method( 'fetch_action' )
->with( array( $action_id ) )
->will( $this->throwException( new Exception() ) );
// Set up a mock queue runner to verify that schedule_next_instance()
// isn't called for an undefined $action.
$runner = $this
->getMockBuilder( 'ActionScheduler_QueueRunner' )
->setConstructorArgs( array( $store ) )
->setMethods( array( 'schedule_next_instance' ) )
->getMock();
$runner
->expects( $this->never() )
->method( 'schedule_next_instance' );
$runner->run();
// Set up a mock store that will throw an exception when fetching actions.
$store2 = $this
->getMockBuilder( 'ActionScheduler_wpPostStore' )
->setMethods( array( 'fetch_action' ) )
->getMock();
$store2
->method( 'fetch_action' )
->with( array( $action_id ) )
->willReturn( null );
// Set up a mock queue runner to verify that schedule_next_instance()
// isn't called for an undefined $action.
$runner2 = $this
->getMockBuilder( 'ActionScheduler_QueueRunner' )
->setConstructorArgs( array( $store ) )
->setMethods( array( 'schedule_next_instance' ) )
->getMock();
$runner2
->expects( $this->never() )
->method( 'schedule_next_instance' );
$runner2->run();
}
/**
* Checks that actions are processed in the correct order. Specifically, that past-due actions are not
* penalized in favor of newer async actions.
*
* @return void
*/
public function test_order_in_which_actions_are_processed() {
/** @var ActionScheduler_Store $store */
$store = ActionScheduler::store();
$runner = ActionScheduler_Mocker::get_queue_runner( $store );
$execution_order = array();
$past_due_action = as_schedule_single_action( time() - HOUR_IN_SECONDS, __METHOD__, array( 'execute' => 'first' ) );
$async_action = as_enqueue_async_action( __METHOD__, array( 'execute' => 'second' ) );
$monitor = function ( $order ) use ( &$execution_order ) {
$execution_order[] = $order;
};
add_action( __METHOD__, $monitor );
$runner->run();
remove_action( __METHOD__, $monitor );
$this->assertEquals(
array(
'first',
'second',
),
$execution_order
);
}
/**
* Tests the ability of the queue runner to accommodate a range of error conditions (raised recoverable errors
* under PHP 5.6, thrown errors under PHP 7.0 upwards, and exceptions under all supported versions).
*
* @return void
*/
public function test_recoverable_errors_do_not_break_queue_runner() {
$executed = 0;
as_enqueue_async_action( 'foo' );
as_enqueue_async_action( 'bar' );
as_enqueue_async_action( 'baz' );
as_enqueue_async_action( 'foobar' );
/**
* Trigger a custom user error.
*
* @return void
*/
$foo = function () use ( &$executed ) {
$executed++;
trigger_error( 'Trouble.', E_USER_ERROR ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_trigger_error
};
/**
* Throw an exception.
*
* @throws Exception Intentionally raised for testing purposes.
*
* @return void
*/
$bar = function () use ( &$executed ) {
$executed++;
throw new Exception( 'More trouble.' );
};
/**
* Trigger a recoverable fatal error. Under PHP 5.6 the error will be raised, and under PHP 7.0 and higher the
* error will be thrown (different mechanisms are needed to support this difference).
*
* @throws Throwable Intentionally raised for testing purposes.
*
* @return void
*/
$baz = function () use ( &$executed ) {
$executed++;
(string) (object) array();
};
/**
* A problem-free callback.
*
* @return void
*/
$foobar = function () use ( &$executed ) {
$executed++;
};
add_action( 'foo', $foo );
add_action( 'bar', $bar );
add_action( 'baz', $baz );
add_action( 'foobar', $foobar );
ActionScheduler_Mocker::get_queue_runner( ActionScheduler::store() )->run();
$this->assertEquals( 4, $executed, 'All enqueued actions ran as expected despite errors and exceptions being raised by the first actions in the set.' );
remove_action( 'foo', $foo );
remove_action( 'bar', $bar );
remove_action( 'baz', $baz );
remove_action( 'foobar', $foobar );
}
}