Merge pull request #20005 from Yoast/19950-revisit-background-indexing-with-wp-cron

Author: thijsoo

src/commands/index-command.php

@@ -14,6 +14,7 @@
 use Yoast\WP\SEO\Actions\Indexing\Indexing_Prepare_Action;
 use Yoast\WP\SEO\Actions\Indexing\Post_Link_Indexing_Action;
 use Yoast\WP\SEO\Actions\Indexing\Term_Link_Indexing_Action;
+use Yoast\WP\SEO\Helpers\Indexable_Helper;
 use Yoast\WP\SEO\Main;
 
 /**
@@ -77,6 +78,13 @@ class Index_Command implements Command_Interface {
 	 */
 	private $prepare_indexing_action;
 
+	/**
+	 * Represents the indexable helper.
+	 *
+	 * @var Indexable_Helper
+	 */
+	protected $indexable_helper;
+
 	/**
 	 * Generate_Indexables_Command constructor.
 	 *
@@ -96,6 +104,7 @@ class Index_Command implements Command_Interface {
 	 *                                                                                           action.
 	 * @param Term_Link_Indexing_Action                     $term_link_indexing_action           The term link indexation
 	 *                                                                                           action.
+	 * @param Indexable_Helper                              $indexable_helper                    The indexable helper.
 	 */
 	public function __construct(
 		Indexable_Post_Indexation_Action $post_indexation_action,
@@ -105,7 +114,8 @@ public function __construct(
 		Indexable_Indexing_Complete_Action $complete_indexation_action,
 		Indexing_Prepare_Action $prepare_indexing_action,
 		Post_Link_Indexing_Action $post_link_indexing_action,
-		Term_Link_Indexing_Action $term_link_indexing_action
+		Term_Link_Indexing_Action $term_link_indexing_action,
+		Indexable_Helper $indexable_helper
 	) {
 		$this->post_indexation_action              = $post_indexation_action;
 		$this->term_indexation_action              = $term_indexation_action;
@@ -115,6 +125,7 @@ public function __construct(
 		$this->prepare_indexing_action             = $prepare_indexing_action;
 		$this->post_link_indexing_action           = $post_link_indexing_action;
 		$this->term_link_indexing_action           = $term_link_indexing_action;
+		$this->indexable_helper                    = $indexable_helper;
 	}
 
 	/**
@@ -158,6 +169,14 @@ public static function get_namespace() {
 	 * @return void
 	 */
 	public function index( $args = null, $assoc_args = null ) {
+		if ( ! $this->indexable_helper->should_index_indexables() ) {
+			WP_CLI::log(
+				\__( 'Your WordPress environment is running on a non-production site. Indexables can only be created on production environments. Please check your `WP_ENVIRONMENT_TYPE` settings.', 'wordpress-seo' )
+			);
+
+			return;
+		}
+
 		if ( ! isset( $assoc_args['network'] ) ) {
 			$this->run_indexation_actions( $assoc_args );
 

src/conditionals/wp-cron-enabled-conditional.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Yoast\WP\SEO\Conditionals;
+
+/**
+ * Class that checks if WP_CRON is enabled.
+ */
+class WP_CRON_Enabled_Conditional implements Conditional {
+
+	/**
+	 * Checks if WP_CRON is enabled.
+	 *
+	 * @return bool True when WP_CRON is enabled.
+	 */
+	public function is_met() {
+		return ! ( defined( 'DISABLE_WP_CRON' ) && DISABLE_WP_CRON );
+	}
+}

src/helpers/indexing-helper.php

@@ -48,6 +48,13 @@ class Indexing_Helper {
 	 */
 	protected $indexing_actions;
 
+	/**
+	 * The indexation actions that can be done in the background.
+	 *
+	 * @var Indexation_Action_Interface[]|Limited_Indexing_Action_Interface[]
+	 */
+	protected $background_indexing_actions;
+
 	/**
 	 * The indexable repository.
 	 *
@@ -100,6 +107,9 @@ public function set_indexing_actions(
 			$post_link_indexing_action,
 			$term_link_indexing_action,
 		];
+
+		// Coincidentally, the background indexing actions are the same with the Free indexing actions for now.
+		$this->background_indexing_actions = $this->indexing_actions;
 	}
 
 	/**
@@ -307,15 +317,20 @@ public function get_filtered_unindexed_count() {
 	/**
 	 * Returns a limited number of unindexed objects.
 	 *
-	 * @param int $limit Limit the number of unindexed objects that are counted.
+	 * @param int                                                               $limit   Limit the number of unindexed objects that are counted.
+	 * @param Indexation_Action_Interface[]|Limited_Indexing_Action_Interface[] $actions The actions whose counts will be calculated.
 	 *
 	 * @return int The total number of unindexed objects.
 	 */
-	public function get_limited_unindexed_count( $limit ) {
+	public function get_limited_unindexed_count( $limit, $actions = [] ) {
 		$unindexed_count = 0;
 
-		foreach ( $this->indexing_actions as $indexing_action ) {
-			$unindexed_count += $indexing_action->get_limited_unindexed_count( $limit - $unindexed_count + 1 );
+		if ( empty( $actions ) ) {
+			$actions = $this->indexing_actions;
+		}
+
+		foreach ( $actions as $action ) {
+			$unindexed_count += $action->get_limited_unindexed_count( $limit - $unindexed_count + 1 );
 			if ( $unindexed_count > $limit ) {
 				return $unindexed_count;
 			}
@@ -332,7 +347,7 @@ public function get_limited_unindexed_count( $limit ) {
 	 * @return int The total number of unindexed objects.
 	 */
 	public function get_limited_filtered_unindexed_count( $limit ) {
-		$unindexed_count = $this->get_limited_unindexed_count( $limit );
+		$unindexed_count = $this->get_limited_unindexed_count( $limit, $this->indexing_actions );
 
 		if ( $unindexed_count > $limit ) {
 			return $unindexed_count;
@@ -348,4 +363,29 @@ public function get_limited_filtered_unindexed_count( $limit ) {
 		 */
 		return \apply_filters( 'wpseo_indexing_get_limited_unindexed_count', $unindexed_count, $limit );
 	}
+
+	/**
+	 * Returns the total number of unindexed objects that can be indexed in the background and applies a filter for third party integrations.
+	 *
+	 * @param int $limit Limit the number of unindexed objects that are counted.
+	 *
+	 * @return int The total number of unindexed objects that can be indexed in the background.
+	 */
+	public function get_limited_filtered_unindexed_count_background( $limit ) {
+		$unindexed_count = $this->get_limited_unindexed_count( $limit, $this->background_indexing_actions );
+
+		if ( $unindexed_count > $limit ) {
+			return $unindexed_count;
+		}
+
+		/**
+		 * Filter: 'wpseo_indexing_get_limited_unindexed_count_background' - Allow changing the amount of unindexed objects that can be indexed in the background,
+		 * and allow for a maximum number of items counted to improve performance.
+		 *
+		 * @param int       $unindexed_count The amount of unindexed objects.
+		 * @param int|false $limit           Limit the number of unindexed objects that need to be counted.
+		 *                                   False if it doesn't need to be limited.
+		 */
+		return \apply_filters( 'wpseo_indexing_get_limited_unindexed_count_background', $unindexed_count, $limit );
+	}
 }