Allow integrations to have custom parameters for queries

src/CLI/Command.php

@@ -32,13 +32,25 @@ class Command extends WP_CLI_Command {
 	 */
 	private IntegrationRegistry $integration_registry;
 
+	/**
+	 * Memory manager instance.
+	 *
+	 * @var MemoryManager
+	 */
+	private MemoryManager $memory_manager;
+
 	/**
 	 * Dependency injector.
 	 *
 	 * @param IntegrationRegistry $integration_registry The integration registry.
+	 * @param MemoryManager       $memory_manager The memory manager.
 	 */
-	public function init( IntegrationRegistry $integration_registry ) {
+	public function init(
+		IntegrationRegistry $integration_registry,
+		MemoryManager $memory_manager
+	) {
 		$this->integration_registry = $integration_registry;
+		$this->memory_manager       = $memory_manager;
 	}
 
 	/**
@@ -111,7 +123,7 @@ public function generate( $args, $assoc_args ) {
 
 		// Initialize the feed and walker, set them up.
 		$feed   = $integration->create_feed();
-		$walker = new ProductWalker( $integration->get_product_mapper(), $integration->get_feed_validator(), $feed );
+		$walker = ProductWalker::from_integration( $integration, $feed );
 		$walker->set_batch_size( $batch_size );
 		$walker->add_time_limit( $timeout );
 
@@ -136,7 +148,7 @@ function ( WalkerProgress $progress ) use ( $silent, &$iteration_time, &$total_i
 
 				$per_item = round( ( $duration / $items_count ) * 1000, 2 );
 
-				WP_CLI::log( "Batch $progress->processed_batches/$progress->total_batch_count: Processed $progress->processed_items/$progress->total_count products. Available memory: " . MemoryManager::get_available_memory() . "%. Time per item: $per_item ms" );
+				WP_CLI::log( "Batch $progress->processed_batches/$progress->total_batch_count: Processed $progress->processed_items/$progress->total_count products. Available memory: " . $this->memory_manager->get_available_memory() . "%. Time per item: $per_item ms" );
 			}
 		);
 

src/Core/Plugin.php

@@ -28,7 +28,7 @@ final class Plugin {
 	 *
 	 * @var Container
 	 */
-	private Container $container;
+	private $container;
 
 	/**
 	 * Integration registry.

src/Feed/ProductLoader.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Product Loader class.
+ *
+ * @package Automattic\WooCommerce\ProductFeedForOpenAI
+ */
+
+declare(strict_types=1);
+
+namespace Automattic\WooCommerce\ProductFeedForOpenAI\Feed;
+
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+
+/**
+ * Loader for products.
+ */
+class ProductLoader {
+	/**
+	 * Retrieves products from WooCommerce.
+	 *
+	 * @see wc_get_products()
+	 *
+	 * @param array $args The arguments to pass to wc_get_products().
+	 * @return array|stdClass Number of pages and an array of product objects if
+	 *                        paginate is true, or just an array of values.
+	 */
+	public function get_products( $args ) {
+		return wc_get_products( $args );
+	}
+}

src/Feed/ProductWalker.php

@@ -9,6 +9,7 @@
 
 namespace Automattic\WooCommerce\ProductFeedForOpenAI\Feed;
 
+use Automattic\WooCommerce\ProductFeedForOpenAI\Integrations\IntegrationInterface;
 use Automattic\WooCommerce\ProductFeedForOpenAI\Utils\MemoryManager;
 
 if ( ! defined( 'ABSPATH' ) ) {
@@ -19,26 +20,40 @@
  * Walker for products.
  */
 class ProductWalker {
+	/**
+	 * The product loader.
+	 *
+	 * @var ProductLoader
+	 */
+	private ProductLoader $product_loader;
+
 	/**
 	 * The product mapper.
 	 *
 	 * @var ProductMapperInterface
 	 */
-	private $mapper;
+	private ProductMapperInterface $mapper;
 
 	/**
 	 * The feed.
 	 *
 	 * @var FeedInterface
 	 */
-	private $feed;
+	private FeedInterface $feed;
 
 	/**
 	 * The feed validator.
 	 *
 	 * @var FeedValidatorInterface
 	 */
-	private $validator;
+	private FeedValidatorInterface $validator;
+
+	/**
+	 * The memory manager.
+	 *
+	 * @var MemoryManager
+	 */
+	private MemoryManager $memory_manager;
 
 	/**
 	 * The number of products to iterate through per batch.
@@ -54,6 +69,13 @@ class ProductWalker {
 	 */
 	private int $time_limit = 0;
 
+	/**
+	 * The query arguments to apply to the product query.
+	 *
+	 * @var array
+	 */
+	private array $query_args;
+
 	/**
 	 * Class constructor.
 	 *
@@ -62,15 +84,75 @@ class ProductWalker {
 	 * @param ProductMapperInterface $mapper The product mapper.
 	 * @param FeedValidatorInterface $validator The feed validator.
 	 * @param FeedInterface          $feed The feed.
+	 * @param ProductLoader          $product_loader The product loader.
+	 * @param MemoryManager          $memory_manager The memory manager.
+	 * @param array                  $query_args The query arguments.
 	 */
-	public function __construct(
+	private function __construct(
 		ProductMapperInterface $mapper,
 		FeedValidatorInterface $validator,
-		FeedInterface $feed
+		FeedInterface $feed,
+		ProductLoader $product_loader,
+		MemoryManager $memory_manager,
+		array $query_args
 	) {
-		$this->mapper    = $mapper;
-		$this->validator = $validator;
-		$this->feed      = $feed;
+		$this->mapper         = $mapper;
+		$this->validator      = $validator;
+		$this->feed           = $feed;
+		$this->product_loader = $product_loader;
+		$this->memory_manager = $memory_manager;
+		$this->query_args     = $query_args;
+	}
+
+	/**
+	 * Creates a new instance of the ProductWalker class based on an integration.
+	 *
+	 * The walker will mostly be set up based on the integration.
+	 * The feed is provided externally, as it might be based on the context (CLI, REST, Action Scheduler, etc.).
+	 *
+	 * @param IntegrationInterface $integration The integration.
+	 * @param FeedInterface        $feed        The feed.
+	 * @return self The ProductWalker instance.
+	 */
+	public static function from_integration(
+		IntegrationInterface $integration,
+		FeedInterface $feed
+	): self {
+		$query_args = array_merge(
+			[
+				'status' => [ 'publish' ],
+				'return' => 'objects',
+			],
+			$integration->get_product_feed_query_args()
+		);
+
+		/**
+		 * Allows the base arguments for querying products for product feeds to be changed.
+		 *
+		 * Variable products are not included by default, as their variations will be included.
+		 *
+		 * @since 0.1.0
+		 *
+		 * @param array                $query_args The arguments to pass to wc_get_products().
+		 * @param IntegrationInterface $integration The integration that the query belongs to.
+		 * @return array
+		 */
+		$query_args = apply_filters(
+			'wpfoai_product_feed_args',
+			$query_args,
+			$integration
+		);
+
+		$instance = new self(
+			$integration->get_product_mapper(),
+			$integration->get_feed_validator(),
+			$feed,
+			wpfoai_get_service( ProductLoader::class ),
+			wpfoai_get_service( MemoryManager::class ),
+			$query_args
+		);
+
+		return $instance;
 	}
 
 	/**
@@ -99,42 +181,19 @@ public function add_time_limit( int $time_limit ): self {
 	 * Walks through all products.
 	 *
 	 * @param callable $callback The callback to call after each batch of products is processed.
-	 * @param array    $additional_args Optional. Additional arguments to merge into the base query args.
 	 * @return int The total number of products processed.
 	 */
-	public function walk( ?callable $callback = null, array $additional_args = [] ): int {
+	public function walk( ?callable $callback = null ): int {
 		$progress = null;
 
-		/**
-		 * Allows the base arguments for querying products for product feeds to be changed.
-		 *
-		 * Variable products are not included by default, as their variations will be included.
-		 *
-		 * @since 0.1.0
-		 *
-		 * @param array $args The arguments to pass to wc_get_products().
-		 * @return array
-		 */
-		$args = apply_filters(
-			'wpfoai_product_feed_args',
-			array_merge(
-				[
-					'status' => [ 'publish' ],
-					'type'   => [ 'simple', 'variation' ],
-					'return' => 'objects',
-				],
-				$additional_args
-			)
-		);
-
 		// Instruct the feed to start.
 		$this->feed->start();
 
 		// Check how much memory is available at first.
-		$initial_available_memory = MemoryManager::get_available_memory();
+		$initial_available_memory = $this->memory_manager->get_available_memory();
 
 		do {
-			$result   = $this->iterate( $args, $progress ? $progress->processed_batches + 1 : 1, $this->per_page );
+			$result   = $this->iterate( $this->query_args, $progress ? $progress->processed_batches + 1 : 1, $this->per_page );
 			$iterated = count( $result->products );
 
 			// Only done when the progress is not set. Will be modified otherwise.
@@ -153,10 +212,17 @@ public function walk( ?callable $callback = null, array $additional_args = [] ):
 			}
 
 			// We don't want to use more than half of the available memory at the beginning of the script.
-			if ( $initial_available_memory - MemoryManager::get_available_memory() >= $initial_available_memory / 2 ) {
-				MemoryManager::flush_caches();
+			$current_memory = $this->memory_manager->get_available_memory();
+			if ( $initial_available_memory - $current_memory >= $initial_available_memory / 2 ) {
+				$this->memory_manager->flush_caches();
 			}
-		} while ( $iterated === $this->per_page );
+		} while (
+			// If `wc_get_products()` returns less than the batch size, it was the last page.
+			$iterated === $this->per_page
+
+			// For the cases where the above is true, make sure that we do not exceed the total number of pages.
+			&& $progress->processed_batches < $progress->total_batch_count
+		);
 
 		// Instruct the feed to end.
 		$this->feed->end();
@@ -173,7 +239,7 @@ public function walk( ?callable $callback = null, array $additional_args = [] ):
 	 * @return object The result of the query.
 	 */
 	private function iterate( array $args = [], int $page = 1, int $limit = 100 ): object {
-		$result = wc_get_products(
+		$result = $this->product_loader->get_products(
 			array_merge(
 				$args,
 				[

src/Integrations/IntegrationInterface.php

@@ -38,17 +38,33 @@ public function register_hooks(): void;
 	/**
 	 * Activate the integration.
 	 *
+	 * This method is called when the plugin is activated.
+	 * If there is ever a setting that controls active integrations,
+	 * this method might also be called when the integration is activated.
+	 *
 	 * @return void
 	 */
 	public function activate(): void;
 
 	/**
 	 * Deactivate the integration.
 	 *
+	 * This method is called when the plugin is deactivated.
+	 * If there is ever a setting that controls active integrations,
+	 * this method might also be called when the integration is deactivated.
+	 *
 	 * @return void
 	 */
 	public function deactivate(): void;
 
+	/**
+	 * Get the query arguments for the product feed.
+	 *
+	 * @see wc_get_products()
+	 * @return array The query arguments.
+	 */
+	public function get_product_feed_query_args(): array;
+
 	/**
 	 * Create a feed that is to be populated.
 	 *