[GTIN] Add GTIN migration JOB

src/ConnectionTest.php

@@ -21,6 +21,7 @@
 use Automattic\WooCommerce\GoogleListingsAndAds\Infrastructure\Service;
 use Automattic\WooCommerce\GoogleListingsAndAds\Jobs\CleanupProductsJob;
 use Automattic\WooCommerce\GoogleListingsAndAds\Jobs\DeleteAllProducts;
+use Automattic\WooCommerce\GoogleListingsAndAds\Jobs\MigrateGTIN;
 use Automattic\WooCommerce\GoogleListingsAndAds\Jobs\UpdateAllProducts;
 use Automattic\WooCommerce\GoogleListingsAndAds\Jobs\UpdateProducts;
 use Automattic\WooCommerce\GoogleListingsAndAds\MerchantCenter\AccountService;
@@ -645,6 +646,18 @@
 					<input name="page" value="connection-test-admin-page" type="hidden" />
 					<input name="action" value="wcs-cleanup-products" type="hidden" />
 				</form>
+				<form action="<?php echo esc_url( admin_url( 'admin.php' ) ); ?>" method="GET">
+					<table class="form-table" role="presentation">
+						<tr>
+							<th><label>GTIN Migration:</label></th>
+							<td>
+								<p>
+									<a class="button" href="<?php echo esc_url( wp_nonce_url( add_query_arg( [ 'action' => 'migrate-gtin' ], $url ), 'migrate-gtin' ) ); ?>">Start GTIN Migration</a>
+								</p>
+							</td>
+						</tr>
+					</table>
+				</form>
 			<?php } ?>
 
 			<hr />
@@ -1322,6 +1335,14 @@
 			}
 		}
 
+		if ( 'migrate-gtin' === $_GET['action'] && check_admin_referer( 'migrate-gtin' ) ) {
+			/** @var MigrateGTIN $job */
+			$job = $this->container->get( MigrateGTIN::class );
+			$job->schedule();
+			$this->response = 'Successfully scheduled a job to migrate GTIN';
+		}
+
+
 	}
 
 	/**

src/Internal/DependencyManagement/JobServiceProvider.php

@@ -24,6 +24,7 @@
 use Automattic\WooCommerce\GoogleListingsAndAds\Jobs\JobInitializer;
 use Automattic\WooCommerce\GoogleListingsAndAds\Jobs\JobInterface;
 use Automattic\WooCommerce\GoogleListingsAndAds\Jobs\JobRepository;
+use Automattic\WooCommerce\GoogleListingsAndAds\Jobs\MigrateGTIN;
 use Automattic\WooCommerce\GoogleListingsAndAds\Jobs\Notifications\CouponNotificationJob;
 use Automattic\WooCommerce\GoogleListingsAndAds\Jobs\Notifications\ProductNotificationJob;
 use Automattic\WooCommerce\GoogleListingsAndAds\Jobs\Notifications\SettingsNotificationJob;
@@ -127,6 +128,13 @@
 			CouponHelper::class
 		);
 
+		// share GTIN migration job
+		$this->share_action_scheduler_job(
+			MigrateGTIN::class,
+			ProductRepository::class,
+			Product\Attributes\AttributeManager::class
+		);
+
 		$this->share_with_tags(
 			JobRepository::class,
 			JobInterface::class

src/Jobs/MigrateGTIN.php

@@ -0,0 +1,135 @@
+<?php
+declare( strict_types=1 );
+
+namespace Automattic\WooCommerce\GoogleListingsAndAds\Jobs;
+
+use Automattic\WooCommerce\GoogleListingsAndAds\ActionScheduler\ActionSchedulerInterface;
+use Automattic\WooCommerce\GoogleListingsAndAds\Options\OptionsAwareInterface;
+use Automattic\WooCommerce\GoogleListingsAndAds\Options\OptionsAwareTrait;
+use Automattic\WooCommerce\GoogleListingsAndAds\Product\Attributes\AttributeManager;
+use Automattic\WooCommerce\GoogleListingsAndAds\Product\ProductRepository;
+
+defined( 'ABSPATH' ) || exit;
+
+/**
+ * Class MigrateGTIN
+ *
+ * Schedules GTIN migration for all the products in the store.
+ *
+ * @package Automattic\WooCommerce\GoogleListingsAndAds\Jobs
+ * @since x.x.x
+ */
+class MigrateGTIN extends AbstractBatchedActionSchedulerJob implements OptionsAwareInterface {
+	use OptionsAwareTrait;
+
+	/**
+	 * @var ProductRepository
+	 */
+	protected $product_repository;
+
+
+	/**
+	 * @var AttributeManager
+	 */
+	protected $attribute_manager;
+
+
+	/**
+	 * Job constructor.
+	 *
+	 * @param ActionSchedulerInterface  $action_scheduler
+	 * @param ActionSchedulerJobMonitor $monitor
+	 * @param ProductRepository         $product_repository
+	 * @param AttributeManager          $attribute_manager
+	 */
+	public function __construct( ActionSchedulerInterface $action_scheduler, ActionSchedulerJobMonitor $monitor, ProductRepository $product_repository, AttributeManager $attribute_manager ) {
+		parent::__construct( $action_scheduler, $monitor );
+		$this->product_repository = $product_repository;
+		$this->attribute_manager  = $attribute_manager;
+	}
+
+	/**
+	 * Get the name of the job.
+	 *
+	 * @return string
+	 */
+	public function get_name(): string {
+		return 'migrate_gtin';
+	}
+
+	/**
+	 * Can the job be scheduled.
+	 *
+	 * @param array|null $args
+	 *
+	 * @return bool Returns true if the job can be scheduled.
+	 */
+	public function can_schedule( $args = [] ): bool {
+		return parent::can_schedule( $args ) && $this->is_gtin_available_in_core();
+	}
+
+	/**
+	 * Process batch items.
+	 *
+	 * @param int[] $items A single batch of WooCommerce product IDs from the get_batch() method.
+	 */
+	protected function process_items( array $items ) {
+		// todo: prevent execution if migration was completed?
+
+		// update the product core GTIN using G4W GTIN
+		$products = $this->product_repository->find_by_ids( $items );
+		foreach ( $products as $product ) {
+			// void if core GTIN is already set.
+			if ( $product->get_global_unique_id() ) {
+				continue;
+			}
+
+			// process variations
+			if ( $product instanceof \WC_Product_Variable ) {
+				$variations = $product->get_children();
+				$this->process_items( $variations );
+				continue;
+			}
+
+			$gtin = $this->attribute_manager->get_value( $product, 'gtin' );
+			if ( $gtin ) {
+				$product->set_global_unique_id( $gtin );
+				$product->save();
+			}
+		}
+	}
+
+	/**
+	 * Called when the job is completed.
+	 *
+	 * @param int $final_batch_number The final batch number when the job was completed.
+	 *                                If equal to 1 then no items were processed by the job.
+	 */
+	protected function handle_complete( int $final_batch_number ) {
+		// todo: set migration as completed?
+	}
+
+	/**
+	 * Get a single batch of items.
+	 *
+	 * If no items are returned the job will stop.
+	 *
+	 * @param int $batch_number The batch number increments for each new batch in the job cycle.
+	 *
+	 * @return array
+	 *
+	 * @throws Exception If an error occurs. The exception will be logged by ActionScheduler.
+	 */
+	protected function get_batch( int $batch_number ): array {
+		return $this->product_repository->find_all_product_ids( $this->get_batch_size(), $this->get_query_offset( $batch_number ) );
+	}
+
+	/**
+	 * Verifies if GTIN logic is available in core.
+	 *
+	 * @return bool
+	 */
+	protected function is_gtin_available_in_core(): bool {
+		return method_exists( \WC_Product::class, 'get_global_unique_id' );
+	}
+}