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

Merge commit 'd435f549fe9bbfbea64ed9be36104e7a23f9603c' as 'libraries/action-scheduler'

Browse Source
This commit is contained in:
Duskell
2026-03-16 13:15:04 +01:00
parent 4f75604fa0 d435f549fe
commit 76eb96666b
174 changed files with 32087 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

134
libraries/action-scheduler/tests/phpunit/logging/ActionScheduler_DBLogger_Test.php Normal file
View File

@@ -0,0 +1,134 @@
<?php
/**
* Class ActionScheduler_DBLogger_Test
* @package test_cases\logging
* @group tables
*/
class ActionScheduler_DBLogger_Test extends ActionScheduler_UnitTestCase {
public function test_default_logger() {
$logger = ActionScheduler::logger();
$this->assertInstanceOf( 'ActionScheduler_Logger', $logger );
$this->assertInstanceOf( ActionScheduler_DBLogger::class, $logger );
}
public function test_add_log_entry() {
$action_id = as_schedule_single_action( time(), __METHOD__ );
$logger = ActionScheduler::logger();
$message = 'Logging that something happened';
$log_id = $logger->log( $action_id, $message );
$entry = $logger->get_entry( $log_id );
$this->assertEquals( $action_id, $entry->get_action_id() );
$this->assertEquals( $message, $entry->get_message() );
}
public function test_storage_logs() {
$action_id = as_schedule_single_action( time(), __METHOD__ );
$logger = ActionScheduler::logger();
$logs = $logger->get_logs( $action_id );
$expected = new ActionScheduler_LogEntry( $action_id, 'action created' );
$this->assertCount( 1, $logs );
$this->assertEquals( $expected->get_action_id(), $logs[0]->get_action_id() );
$this->assertEquals( $expected->get_message(), $logs[0]->get_message() );
}
public function test_execution_logs() {
$action_id = as_schedule_single_action( time(), ActionScheduler_Callbacks::HOOK_WITH_CALLBACK );
$logger = ActionScheduler::logger();
$started = new ActionScheduler_LogEntry( $action_id, 'action started via Unit Tests' );
$finished = new ActionScheduler_LogEntry( $action_id, 'action complete via Unit Tests' );
$runner = ActionScheduler_Mocker::get_queue_runner();
$runner->run( 'Unit Tests' );
// Expect 3 logs with the correct action ID.
$logs = $logger->get_logs( $action_id );
$this->assertCount( 3, $logs );
foreach ( $logs as $log ) {
$this->assertEquals( $action_id, $log->get_action_id() );
}
// Expect created, then started, then completed.
$this->assertEquals( 'action created', $logs[0]->get_message() );
$this->assertEquals( $started->get_message(), $logs[1]->get_message() );
$this->assertEquals( $finished->get_message(), $logs[2]->get_message() );
}
public function test_failed_execution_logs() {
$hook = __METHOD__;
add_action( $hook, array( $this, 'a_hook_callback_that_throws_an_exception' ) );
$action_id = as_schedule_single_action( time(), $hook );
$logger = ActionScheduler::logger();
$started = new ActionScheduler_LogEntry( $action_id, 'action started via Unit Tests' );
$finished = new ActionScheduler_LogEntry( $action_id, 'action complete via Unit Tests' );
$failed = new ActionScheduler_LogEntry( $action_id, 'action failed via Unit Tests: Execution failed' );
$runner = ActionScheduler_Mocker::get_queue_runner();
$runner->run( 'Unit Tests' );
// Expect 3 logs with the correct action ID.
$logs = $logger->get_logs( $action_id );
$this->assertCount( 3, $logs );
foreach ( $logs as $log ) {
$this->assertEquals( $action_id, $log->get_action_id() );
$this->assertNotEquals( $finished->get_message(), $log->get_message() );
}
// Expect created, then started, then failed.
$this->assertEquals( 'action created', $logs[0]->get_message() );
$this->assertEquals( $started->get_message(), $logs[1]->get_message() );
$this->assertEquals( $failed->get_message(), $logs[2]->get_message() );
}
public function test_fatal_error_log() {
$action_id = as_schedule_single_action( time(), __METHOD__ );
$logger = ActionScheduler::logger();
$args = array(
'type' => E_ERROR,
'message' => 'Test error',
'file' => __FILE__,
'line' => __LINE__,
);
do_action( 'action_scheduler_unexpected_shutdown', $action_id, $args );
$logs = $logger->get_logs( $action_id );
$found_log = false;
foreach ( $logs as $l ) {
if ( strpos( $l->get_message(), 'unexpected shutdown' ) === 0 ) {
$found_log = true;
}
}
$this->assertTrue( $found_log, 'Unexpected shutdown log not found' );
}
public function test_canceled_action_log() {
$action_id = as_schedule_single_action( time(), __METHOD__ );
as_unschedule_action( __METHOD__ );
$logger = ActionScheduler::logger();
$logs = $logger->get_logs( $action_id );
$expected = new ActionScheduler_LogEntry( $action_id, 'action canceled' );
$this->assertEquals( $expected->get_message(), end( $logs )->get_message() );
}
public function test_deleted_action_cleanup() {
$time = as_get_datetime_object( '-10 minutes' );
$schedule = new \ActionScheduler_SimpleSchedule( $time );
$action = new \ActionScheduler_Action( ActionScheduler_Callbacks::HOOK_WITH_CALLBACK, array(), $schedule );
$store = new ActionScheduler_DBStore();
$action_id = $store->save_action( $action );
$logger = new ActionScheduler_DBLogger();
$logs = $logger->get_logs( $action_id );
$this->assertNotEmpty( $logs );
$store->delete_action( $action_id );
$logs = $logger->get_logs( $action_id );
$this->assertEmpty( $logs );
}
public function a_hook_callback_that_throws_an_exception() {
throw new \RuntimeException( 'Execution failed' );
}
}

241
libraries/action-scheduler/tests/phpunit/logging/ActionScheduler_wpCommentLogger_Test.php Normal file
View File

@@ -0,0 +1,241 @@
<?php
/**
* Class ActionScheduler_wpCommentLogger_Test
* @package test_cases\logging
*/
class ActionScheduler_wpCommentLogger_Test extends ActionScheduler_UnitTestCase {
/** @var bool */
private $use_comment_logger;
public function test_default_logger() {
$logger = ActionScheduler::logger();
$this->assertInstanceOf( 'ActionScheduler_Logger', $logger );
if ( $this->using_comment_logger() ) {
$this->assertInstanceOf( 'ActionScheduler_wpCommentLogger', $logger );
} else {
$this->assertNotInstanceOf( 'ActionScheduler_wpCommentLogger', $logger );
}
}
public function test_add_log_entry() {
$action_id = as_schedule_single_action( time(), 'a hook' );
$logger = ActionScheduler::logger();
$message = 'Logging that something happened';
$log_id = $logger->log( $action_id, $message );
$entry = $logger->get_entry( $log_id );
$this->assertEquals( $action_id, $entry->get_action_id() );
$this->assertEquals( $message, $entry->get_message() );
}
public function test_add_log_datetime() {
$action_id = as_schedule_single_action( time(), 'a hook' );
$logger = ActionScheduler::logger();
$message = 'Logging that something happened';
$date = new DateTime( 'now', new DateTimeZone( 'UTC' ) );
$log_id = $logger->log( $action_id, $message, $date );
$entry = $logger->get_entry( $log_id );
$this->assertEquals( $action_id, $entry->get_action_id() );
$this->assertEquals( $message, $entry->get_message() );
$date = new ActionScheduler_DateTime( 'now', new DateTimeZone( 'UTC' ) );
$log_id = $logger->log( $action_id, $message, $date );
$entry = $logger->get_entry( $log_id );
$this->assertEquals( $action_id, $entry->get_action_id() );
$this->assertEquals( $message, $entry->get_message() );
}
public function test_erroneous_entry_id() {
$comment = wp_insert_comment(
array(
'comment_post_ID' => 1,
'comment_author' => 'test',
'comment_content' => 'this is not a log entry',
)
);
$logger = ActionScheduler::logger();
$entry = $logger->get_entry( $comment );
$this->assertEquals( '', $entry->get_action_id() );
$this->assertEquals( '', $entry->get_message() );
}
public function test_storage_comments() {
$action_id = as_schedule_single_action( time(), 'a hook' );
$logger = ActionScheduler::logger();
$logs = $logger->get_logs( $action_id );
$expected = new ActionScheduler_LogEntry( $action_id, 'action created' );
// phpcs:ignore WordPress.PHP.StrictInArray.MissingTrueStrict
$this->assertTrue( in_array( $this->log_entry_to_array( $expected ), $this->log_entry_to_array( $logs ) ) );
}
protected function log_entry_to_array( $logs ) {
if ( $logs instanceof ActionScheduler_LogEntry ) {
return array(
'action_id' => $logs->get_action_id(),
'message' => $logs->get_message(),
);
}
foreach ( $logs as $id => $log ) {
$logs[ $id ] = array(
'action_id' => $log->get_action_id(),
'message' => $log->get_message(),
);
}
return $logs;
}
public function test_execution_comments() {
$action_id = as_schedule_single_action( time(), ActionScheduler_Callbacks::HOOK_WITH_CALLBACK );
$logger = ActionScheduler::logger();
$started = new ActionScheduler_LogEntry( $action_id, 'action started via Unit Tests' );
$finished = new ActionScheduler_LogEntry( $action_id, 'action complete via Unit Tests' );
$runner = ActionScheduler_Mocker::get_queue_runner();
$runner->run( 'Unit Tests' );
$logs = $logger->get_logs( $action_id );
// phpcs:disable WordPress.PHP.StrictInArray.MissingTrueStrict
$this->assertTrue( in_array( $this->log_entry_to_array( $started ), $this->log_entry_to_array( $logs ) ) );
$this->assertTrue( in_array( $this->log_entry_to_array( $finished ), $this->log_entry_to_array( $logs ) ) );
// phpcs:enable
}
public function test_failed_execution_comments() {
$hook = md5( wp_rand() );
add_action( $hook, array( $this, 'a_hook_callback_that_throws_an_exception' ) );
$action_id = as_schedule_single_action( time(), $hook );
$logger = ActionScheduler::logger();
$started = new ActionScheduler_LogEntry( $action_id, 'action started via Unit Tests' );
$finished = new ActionScheduler_LogEntry( $action_id, 'action complete via Unit Tests' );
$failed = new ActionScheduler_LogEntry( $action_id, 'action failed via Unit Tests: Execution failed' );
$runner = ActionScheduler_Mocker::get_queue_runner();
$runner->run( 'Unit Tests' );
$logs = $logger->get_logs( $action_id );
// phpcs:disable WordPress.PHP.StrictInArray.MissingTrueStrict
$this->assertTrue( in_array( $this->log_entry_to_array( $started ), $this->log_entry_to_array( $logs ) ) );
$this->assertFalse( in_array( $this->log_entry_to_array( $finished ), $this->log_entry_to_array( $logs ) ) );
$this->assertTrue( in_array( $this->log_entry_to_array( $failed ), $this->log_entry_to_array( $logs ) ) );
// phpcs:enable
}
public function test_failed_schedule_next_instance_comments() {
$action_id = wp_rand();
$logger = ActionScheduler::logger();
$log_entry = new ActionScheduler_LogEntry( $action_id, 'There was a failure scheduling the next instance of this action: Execution failed' );
try {
$this->a_hook_callback_that_throws_an_exception();
} catch ( Exception $e ) {
do_action( 'action_scheduler_failed_to_schedule_next_instance', $action_id, $e, new ActionScheduler_Action( ActionScheduler_Callbacks::HOOK_WITH_CALLBACK ) );
}
$logs = $logger->get_logs( $action_id );
// phpcs:ignore WordPress.PHP.StrictInArray.MissingTrueStrict
$this->assertTrue( in_array( $this->log_entry_to_array( $log_entry ), $this->log_entry_to_array( $logs ) ) );
}
public function test_fatal_error_comments() {
$hook = md5( wp_rand() );
$action_id = as_schedule_single_action( time(), $hook );
$logger = ActionScheduler::logger();
$args = array(
'type' => E_ERROR,
'message' => 'Test error',
'file' => __FILE__,
'line' => __LINE__,
);
do_action( 'action_scheduler_unexpected_shutdown', $action_id, $args );
$logs = $logger->get_logs( $action_id );
$found_log = false;
foreach ( $logs as $l ) {
if ( strpos( $l->get_message(), 'unexpected shutdown' ) === 0 ) {
$found_log = true;
}
}
$this->assertTrue( $found_log, 'Unexpected shutdown log not found' );
}
public function test_canceled_action_comments() {
$action_id = as_schedule_single_action( time(), 'a hook' );
as_unschedule_action( 'a hook' );
$logger = ActionScheduler::logger();
$logs = $logger->get_logs( $action_id );
$expected = new ActionScheduler_LogEntry( $action_id, 'action canceled' );
// phpcs:ignore WordPress.PHP.StrictInArray.MissingTrueStrict
$this->assertTrue( in_array( $this->log_entry_to_array( $expected ), $this->log_entry_to_array( $logs ) ) );
}
public function a_hook_callback_that_throws_an_exception() {
throw new RuntimeException( 'Execution failed' );
}
public function test_filtering_of_get_comments() {
if ( ! $this->using_comment_logger() ) {
$this->assertTrue( true );
return;
}
$post_id = $this->factory->post->create_object( array( 'post_title' => __FUNCTION__ ) );
$comment_id = $this->factory->comment->create_object(
array(
'comment_post_ID' => $post_id,
'comment_author' => __CLASS__,
'comment_content' => __FUNCTION__,
)
);
// Verify that we're getting the expected comment before we add logging comments.
$comments = get_comments();
$this->assertCount( 1, $comments );
$this->assertEquals( $comment_id, $comments[0]->comment_ID );
$action_id = as_schedule_single_action( time(), 'a hook' );
$logger = ActionScheduler::logger();
$message = 'Logging that something happened';
$log_id = $logger->log( $action_id, $message );
// Verify that logging comments are excluded from general comment queries.
$comments = get_comments();
$this->assertCount( 1, $comments );
$this->assertEquals( $comment_id, $comments[0]->comment_ID );
// Verify that logging comments are returned when asking for them specifically.
$comments = get_comments(
array(
'type' => ActionScheduler_wpCommentLogger::TYPE,
)
);
// Expecting two: one when the action is created, another when we added our custom log.
$this->assertCount( 2, $comments );
$this->assertContains( $log_id, wp_list_pluck( $comments, 'comment_ID' ) );
}
private function using_comment_logger() {
if ( is_null( $this->use_comment_logger ) ) {
$this->use_comment_logger = ! ActionScheduler_DataController::dependencies_met();
}
return $this->use_comment_logger;
}
}