Add comment count upgrade routine (#1080)

* First pass at upgrade routine

* Adjust hooks and scheduling

* Some more small adjustments

* Move update routine to migration class

* Remove reference to Upgrader

* Use existing locking mechanism

* Update tests to account for new locking logic

* Remove duplicate lock test

Author: obenland

CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Send "new follower" emails
 * Send "direct message" emails
 * Account for custom comment types when calculating comment counts
+* Plugin upgrade routine that automatically updates comment counts
 
 ### Improved
 

includes/class-migration.php

@@ -21,6 +21,7 @@ class Migration {
 	 */
 	public static function init() {
 		\add_action( 'activitypub_migrate', array( self::class, 'async_migration' ) );
+		\add_action( 'activitypub_update_comment_counts', array( self::class, 'update_comment_counts' ), 10, 2 );
 
 		self::maybe_migrate();
 	}
@@ -52,9 +53,20 @@ public static function get_version() {
 
 	/**
 	 * Locks the database migration process to prevent simultaneous migrations.
+	 *
+	 * @return bool|int True if the lock was successful, timestamp of existing lock otherwise.
 	 */
 	public static function lock() {
-		\update_option( 'activitypub_migration_lock', \time() );
+		global $wpdb;
+
+		// Try to lock.
+		$lock_result = (bool) $wpdb->query( $wpdb->prepare( "INSERT IGNORE INTO `$wpdb->options` ( `option_name`, `option_value`, `autoload` ) VALUES (%s, %s, 'no') /* LOCK */", 'activitypub_migration_lock', \time() ) ); // phpcs:ignore WordPress.DB
+
+		if ( ! $lock_result ) {
+			$lock_result = \get_option( 'activitypub_migration_lock' );
+		}
+
+		return $lock_result;
 	}
 
 	/**
@@ -115,7 +127,7 @@ public static function maybe_migrate() {
 
 		$version_from_db = self::get_version();
 
-		// Check for inital migration.
+		// Check for initial migration.
 		if ( ! $version_from_db ) {
 			self::add_default_settings();
 			$version_from_db = ACTIVITYPUB_PLUGIN_VERSION;
@@ -146,6 +158,9 @@ public static function maybe_migrate() {
 		if ( \version_compare( $version_from_db, '4.1.0', '<' ) ) {
 			self::migrate_to_4_1_0();
 		}
+		if ( \version_compare( $version_from_db, '4.5.0', '<' ) ) {
+			\wp_schedule_single_event( \time() + MINUTE_IN_SECONDS, 'activitypub_update_comment_counts' );
+		}
 
 		/**
 		 * Fires when the system has to be migrated.
@@ -372,6 +387,64 @@ public static function migrate_to_4_1_0() {
 		);
 	}
 
+	/**
+	 * Update comment counts for posts in batches.
+	 *
+	 * @see Comment::pre_wp_update_comment_count_now()
+	 * @param int $batch_size Optional. Number of posts to process per batch. Default 100.
+	 * @param int $offset     Optional. Number of posts to skip. Default 0.
+	 */
+	public static function update_comment_counts( $batch_size = 100, $offset = 0 ) {
+		global $wpdb;
+
+		// Bail if the existing lock is still valid.
+		if ( self::is_locked() ) {
+			\wp_schedule_single_event(
+				time() + ( 5 * MINUTE_IN_SECONDS ),
+				'activitypub_update_comment_counts',
+				array(
+					'batch_size' => $batch_size,
+					'offset'     => $offset,
+				)
+			);
+			return;
+		}
+
+		self::lock();
+
+		Comment::register_comment_types();
+		$comment_types  = Comment::get_comment_type_slugs();
+		$type_inclusion = "AND comment_type IN ('" . implode( "','", $comment_types ) . "')";
+
+		// Get and process this batch.
+		$post_ids = $wpdb->get_col( // phpcs:ignore WordPress.DB
+			$wpdb->prepare(
+				// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+				"SELECT DISTINCT comment_post_ID FROM {$wpdb->comments} WHERE comment_approved = '1' {$type_inclusion} ORDER BY comment_post_ID LIMIT %d OFFSET %d",
+				$batch_size,
+				$offset
+			)
+		);
+
+		foreach ( $post_ids as $post_id ) {
+			\wp_update_comment_count_now( $post_id );
+		}
+
+		if ( count( $post_ids ) === $batch_size ) {
+			// Schedule next batch.
+			\wp_schedule_single_event(
+				time() + MINUTE_IN_SECONDS,
+				'activitypub_update_comment_counts',
+				array(
+					'batch_size' => $batch_size,
+					'offset'     => $offset + $batch_size,
+				)
+			);
+		}
+
+		self::unlock();
+	}
+
 	/**
 	 * Set the defaults needed for the plugin to work.
 	 *

readme.txt

@@ -138,6 +138,7 @@ For reasons of data protection, it is not possible to see the followers of other
 * Added: Send "new follower" emails
 * Added: Send "direct message" emails
 * Added: Account for custom comment types when calculating comment counts
+* Added: Plugin upgrade routine that automatically updates comment counts
 * Improved: Email templates for Likes and Reposts
 * Improved: Interactions moderation
 * Improved: Compatibility with Akismet

tests/includes/class-test-migration.php

@@ -8,6 +8,7 @@
 namespace Activitypub\Tests;
 
 use Activitypub\Migration;
+use Activitypub\Comment;
 
 /**
  * Test class for Activitypub Migrate.
@@ -184,4 +185,99 @@ public function test_migrate_to_4_1_0() {
 		$this->assertEquals( $custom, $template );
 		$this->assertFalse( $content_type );
 	}
+
+	/**
+	 * Tests that a new migration lock can be successfully acquired when no lock exists.
+	 *
+	 * @covers ::lock
+	 */
+	public function test_lock_acquire_new() {
+		$this->assertFalse( get_option( 'activitypub_migration_lock' ) );
+
+		$this->assertTrue( Migration::lock() );
+
+		// Clean up.
+		delete_option( 'activitypub_migration_lock' );
+	}
+
+	/**
+	 * Tests retrieving the timestamp of an existing lock.
+	 *
+	 * @covers ::lock
+	 */
+	public function test_lock_get_existing() {
+		$lock_time = time() - MINUTE_IN_SECONDS; // Set lock to 1 minute ago.
+		update_option( 'activitypub_migration_lock', $lock_time );
+
+		$lock_result = Migration::lock();
+
+		$this->assertEquals( $lock_time, $lock_result );
+
+		// Clean up.
+		delete_option( 'activitypub_migration_lock' );
+	}
+
+	/**
+	 * Tests update_comment_counts() properly cleans up the lock.
+	 *
+	 * @covers ::update_comment_counts
+	 */
+	public function test_update_comment_counts_with_lock() {
+		// Register comment types.
+		Comment::register_comment_types();
+
+		// Create test comments.
+		$post_id    = $this->factory->post->create();
+		$comment_id = $this->factory->comment->create(
+			array(
+				'comment_post_ID'  => $post_id,
+				'comment_approved' => '1',
+				'comment_type'     => 'repost', // One of the registered comment types.
+			)
+		);
+
+		Migration::update_comment_counts( 10, 0 );
+
+		// Verify lock was cleaned up.
+		$this->assertFalse( get_option( 'activitypub_migration_lock' ) );
+
+		// Clean up.
+		wp_delete_comment( $comment_id, true );
+		wp_delete_post( $post_id, true );
+	}
+
+	/**
+	 * Tests update_comment_counts() with existing valid lock.
+	 *
+	 * @covers ::update_comment_counts
+	 */
+	public function test_update_comment_counts_with_existing_valid_lock() {
+		// Register comment types.
+		Comment::register_comment_types();
+
+		// Set a lock.
+		Migration::lock();
+
+		Migration::update_comment_counts( 10, 0 );
+
+		// Verify a scheduled event was created.
+		$next_scheduled = wp_next_scheduled(
+			'activitypub_update_comment_counts',
+			array(
+				'batch_size' => 10,
+				'offset'     => 0,
+			)
+		);
+		$this->assertNotFalse( $next_scheduled );
+
+		// Clean up.
+		delete_option( 'activitypub_migration_lock' );
+		wp_clear_scheduled_hook(
+			'activitypub_update_comment_counts',
+			array(
+				'batch_size' => 10,
+				'offset'     => 0,
+			)
+		);
+	}
 }