jetpack-mu-wpcom: Limit comment like requests to edit-comment and gate by module

projects/packages/jetpack-mu-wpcom/changelog/update-jetpack-mu-wpcom-improve-comments-performance

@@ -0,0 +1,4 @@
+Significance: patch
+Type: changed
+
+Improves performance of wpcom comments liking by caching and minimizing API requests.

projects/packages/jetpack-mu-wpcom/src/features/wpcom-comments/wpcom-comments.php

@@ -1,4 +1,4 @@
-<?php
+<?php // phpcs:ignore
 /**
  * Plugin Name: Jetpack MU WPCom Comment Likes
  * Description: Adds a "Like" action to comment rows and enqueues the necessary assets in the admin area.
@@ -11,19 +11,95 @@
 }
 
 /**
- * Adds a "liked" class to comments that the current user has liked.
- *
- * @param array  $classes    Array of comment classes.
- * @param string $css_class  Unused.
- * @param int    $comment_id The comment ID.
- * @return array Modified array of comment classes.
+ * WPCom Comments Likes functionality in a singleton pattern.
  */
-function wpcom_comments_add_like_class( $classes, $css_class, $comment_id ) {
-	if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
-		$blog_id = get_current_blog_id();
-		$liked   = Likes::comment_like_current_user_likes( $blog_id, $comment_id );
-	} else {
-		$blog_id  = Jetpack_Options::get_option( 'id' );
+class WPCom_Comments_Likes {
+	/**
+	 * Singleton instance.
+	 *
+	 * @var WPCom_Comments_Likes
+	 */
+	private static $instance = null;
+
+	/**
+	 * Flag to track if hooks have been initialized.
+	 *
+	 * @var bool
+	 */
+	private $initialized = false;
+
+	/**
+	 * Private constructor to prevent direct instantiation.
+	 */
+	private function __construct() {
+		// Register REST API for Atomic sites.
+		if ( defined( 'IS_ATOMIC' ) && IS_ATOMIC ) {
+			add_action( 'rest_api_init', array( $this, 'register_like_api' ) );
+		}
+
+		add_action( 'current_screen', array( $this, 'init' ) );
+	}
+
+	/**
+	 * Get the singleton instance.
+	 *
+	 * @return WPCom_Comments_Likes
+	 */
+	public static function get_instance() {
+		if ( null === self::$instance ) {
+			self::$instance = new self();
+		}
+		return self::$instance;
+	}
+
+	/**
+	 * Initialize the comment likes functionality if enabled.
+	 */
+	public function init() {
+		// Only initialize if comment likes are enabled.
+		if ( ! $this->is_comment_likes_enabled() ) {
+			return;
+		}
+
+		if ( ! is_admin() ) {
+			return;
+		}
+
+		$screen = get_current_screen();
+		if ( ! $screen || 'edit-comments' !== $screen->id ) {
+			return;
+		}
+
+		add_filter( 'comment_class', array( $this, 'add_like_class' ), 10, 3 );
+		add_filter( 'comment_row_actions', array( $this, 'enable_likes' ), 10, 2 );
+		add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_scripts' ), 10, 2 );
+	}
+
+	/**
+	 * Check if comment likes are enabled.
+	 *
+	 * This is currently only expected to work for WoW sites.
+	 *
+	 * @return bool True if comment likes are enabled, false otherwise.
+	 */
+	private function is_comment_likes_enabled() {
+		// @phan-suppress-next-line PhanUndeclaredClassReference
+		if ( class_exists( 'Jetpack' ) && method_exists( 'Jetpack', 'is_module_active' ) ) {
+			// @phan-suppress-next-line PhanUndeclaredClassMethod
+			return Jetpack::is_module_active( 'comment-likes' );
+		}
+
+		return false;
+	}
+
+	/**
+	 * Do a comment like API request.
+	 *
+	 * @param int $blog_id    The blog ID.
+	 * @param int $comment_id The comment ID.
+	 * @return bool|WP_Error True if the comment is liked, false otherwise, or a WP_Error if the request fails.
+	 */
+	private function do_comment_like_api_request( $blog_id, $comment_id ) {
 		$response = Automattic\Jetpack\Connection\Client::wpcom_json_api_request_as_user(
 			"/sites/$blog_id/comments/$comment_id/likes",
 			'v1.1',
@@ -34,89 +110,103 @@ function wpcom_comments_add_like_class( $classes, $css_class, $comment_id ) {
 
 		// If the request fails, simply return the unmodified classes.
 		if ( is_wp_error( $response ) ) {
-			return $classes;
+			return $response;
 		}
 
 		$response_data = json_decode( wp_remote_retrieve_body( $response ), true );
 
-		// If the response doesn't include 'i_like', don't add the class.
-		if ( empty( $response_data['i_like'] ) ) {
-			return $classes;
+		return ! empty( $response_data['i_like'] ?? false );
+	}
+
+	/**
+	 * Adds a "liked" class to comments that the current user has liked.
+	 *
+	 * @param array  $classes    Array of comment classes.
+	 * @param string $css_class  Unused.
+	 * @param int    $comment_id The comment ID.
+	 * @return array Modified array of comment classes.
+	 */
+	public function add_like_class( $classes, $css_class, $comment_id ) {
+		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
+			$blog_id = get_current_blog_id();
+			$liked   = Likes::comment_like_current_user_likes( $blog_id, $comment_id );
+		} else {
+			$blog_id = Jetpack_Options::get_option( 'id' );
+
+			$liked = $this->do_comment_like_api_request( $blog_id, $comment_id );
+
+			if ( is_wp_error( $liked ) ) {
+				return $classes;
+			}
+		}
+
+		// Append the 'liked' class if the comment is liked.
+		if ( $liked ) {
+			$classes[] = 'liked';
 		}
 
-		$liked = $response_data['i_like'];
+		return $classes;
 	}
 
-	// Append the 'liked' class if the comment is liked.
-	if ( $liked ) {
-		$classes[] = 'liked';
+	/**
+	 * Adds "Like" and "Unlike" action buttons to comment rows.
+	 *
+	 * @param array      $actions Array of actions for the comment.
+	 * @param WP_Comment $comment The comment object.
+	 * @return array Modified actions array.
+	 */
+	public function enable_likes( $actions, $comment ) {
+		$actions['like'] = sprintf(
+			'<button class="button-link comment-like-button" data-comment-id="%d" aria-label="%s">%s</button>',
+			$comment->comment_ID,
+			esc_attr__( 'Like this comment', 'jetpack-mu-wpcom' ),
+			esc_html__( 'Like', 'jetpack-mu-wpcom' )
+		);
+
+		$actions['unlike'] = sprintf(
+			'<button class="button-link comment-unlike-button" data-comment-id="%d" aria-label="%s">%s</button>',
+			$comment->comment_ID,
+			esc_attr__( 'Unlike this comment', 'jetpack-mu-wpcom' ),
+			esc_html__( 'Liked by you', 'jetpack-mu-wpcom' )
+		);
+
+		return $actions;
 	}
 
-	return $classes;
-}
-add_filter( 'comment_class', 'wpcom_comments_add_like_class', 10, 3 );
+	/**
+	 * Enqueues the comment like assets (JavaScript and CSS) on the Edit Comments screen.
+	 *
+	 * @param string $hook The current admin page hook.
+	 */
+	public function enqueue_scripts( $hook ) {
+		// Only enqueue assets on the edit-comments screen.
+		if ( 'edit-comments.php' !== $hook ) {
+			return;
+		}
 
-/**
- * Adds "Like" and "Unlike" action buttons to comment rows.
- *
- * @param array      $actions Array of actions for the comment.
- * @param WP_Comment $comment The comment object.
- * @return array Modified actions array.
- */
-function wpcom_comments_enable_likes( $actions, $comment ) {
-	$actions['like'] = sprintf(
-		'<button class="button-link comment-like-button" data-comment-id="%d" aria-label="%s">%s</button>',
-		$comment->comment_ID,
-		esc_attr__( 'Like this comment', 'jetpack-mu-wpcom' ),
-		esc_html__( 'Like', 'jetpack-mu-wpcom' )
-	);
-
-	$actions['unlike'] = sprintf(
-		'<button class="button-link comment-unlike-button" data-comment-id="%d" aria-label="%s">%s</button>',
-		$comment->comment_ID,
-		esc_attr__( 'Unlike this comment', 'jetpack-mu-wpcom' ),
-		esc_html__( 'Liked by you', 'jetpack-mu-wpcom' )
-	);
-
-	return $actions;
-}
-add_filter( 'comment_row_actions', 'wpcom_comments_enable_likes', 10, 2 );
+		// Enqueue the assets using the Jetpack MU WPCom helper function.
+		jetpack_mu_wpcom_enqueue_assets( 'wpcom-comment-like', array( 'js', 'css' ) );
 
-/**
- * Enqueues the comment like assets (JavaScript and CSS) on the Edit Comments screen.
- *
- * @param string $hook The current admin page hook.
- */
-function wpcom_enqueue_comment_like_script( $hook ) {
-	// Only enqueue assets on the edit-comments screen.
-	if ( 'edit-comments.php' !== $hook ) {
-		return;
+		// Localize the script with error messages.
+		wp_localize_script(
+			'jetpack-mu-wpcom-wpcom-comment-like',
+			'wpcomCommentLikesData',
+			array(
+				'post_like_error'     => __( 'Something went wrong when attempting to like that comment. Please try again.', 'jetpack-mu-wpcom' ),
+				'post_unlike_error'   => __( 'Something went wrong when attempting to unlike that comment. Please try again.', 'jetpack-mu-wpcom' ),
+				'dismiss_notice_text' => __( 'Dismiss this notice', 'jetpack-mu-wpcom' ),
+			)
+		);
 	}
 
-	// Enqueue the assets using the Jetpack MU WPCom helper function.
-	jetpack_mu_wpcom_enqueue_assets( 'wpcom-comment-like', array( 'js', 'css' ) );
-
-	// Localize the script with error messages.
-	wp_localize_script(
-		'jetpack-mu-wpcom-wpcom-comment-like',
-		'wpcomCommentLikesData',
-		array(
-			'post_like_error'     => __( 'Something went wrong when attempting to like that comment. Please try again.', 'jetpack-mu-wpcom' ),
-			'post_unlike_error'   => __( 'Something went wrong when attempting to unlike that comment. Please try again.', 'jetpack-mu-wpcom' ),
-			'dismiss_notice_text' => __( 'Dismiss this notice', 'jetpack-mu-wpcom' ),
-		)
-	);
+	/**
+	 * Register an API to handle Likes on Atomic sites.
+	 */
+	public function register_like_api() {
+		require_once __DIR__ . '/class-wp-rest-comment-like.php';
+		$controller = new WP_REST_Comment_Like();
+		$controller->register_routes();
+	}
 }
-add_action( 'admin_enqueue_scripts', 'wpcom_enqueue_comment_like_script', 10, 2 );
 
-/**
- * Register an API to handle Likes on Atomic sites.
- */
-function wpcom_comments_register_like_api() {
-	require_once __DIR__ . '/class-wp-rest-comment-like.php';
-	$controller = new WP_REST_Comment_Like();
-	$controller->register_routes();
-}
-if ( defined( 'IS_ATOMIC' ) && IS_ATOMIC ) {
-	add_action( 'rest_api_init', 'wpcom_comments_register_like_api' );
-}
+WPCom_Comments_Likes::get_instance();

projects/plugins/boost/changelog/update-jetpack-mu-wpcom-improve-comments-performance

@@ -0,0 +1,4 @@
+Significance: patch
+Type: changed
+
+Improves performance of wpcom comments liking by caching and minimizing API requests.

projects/plugins/protect/changelog/update-jetpack-mu-wpcom-improve-comments-performance

@@ -0,0 +1,4 @@
+Significance: patch
+Type: changed
+
+Improves performance of wpcom comments liking by caching and minimizing API requests.

projects/plugins/search/changelog/update-jetpack-mu-wpcom-improve-comments-performance

@@ -0,0 +1,4 @@
+Significance: patch
+Type: changed
+
+Improves performance of wpcom comments liking by caching and minimizing API requests.

projects/plugins/social/changelog/update-jetpack-mu-wpcom-improve-comments-performance

@@ -0,0 +1,4 @@
+Significance: patch
+Type: changed
+
+Improves performance of wpcom comments liking by caching and minimizing API requests.

projects/plugins/starter-plugin/changelog/update-jetpack-mu-wpcom-improve-comments-performance

@@ -0,0 +1,4 @@
+Significance: patch
+Type: changed
+
+Improves performance of wpcom comments liking by caching and minimizing API requests.

projects/plugins/videopress/changelog/update-jetpack-mu-wpcom-improve-comments-performance

@@ -0,0 +1,4 @@
+Significance: patch
+Type: changed
+
+Improves performance of wpcom comments liking by caching and minimizing API requests.

projects/plugins/wpcomsh/changelog/update-jetpack-mu-wpcom-improve-comments-performance

@@ -0,0 +1,4 @@
+Significance: patch
+Type: changed
+
+Improves performance of wpcom comments liking by caching and minimizing API requests.