Merge pull request #72 from woocommerce/feat/40

feat/40: declare product compatibility

.eslintrc.js

@@ -18,6 +18,7 @@ module.exports = {
 			'@woocommerce/settings',
 			'@wordpress/i18n',
 			'@wordpress/element',
+			'@woocommerce/block-templates',
 		],
 		'import/resolver': {
 			node: {

includes/Admin/Product_Editor_Compatibility.php

@@ -0,0 +1,241 @@
+<?php
+
+namespace WooCommerce\Square\Admin;
+
+use Automattic\WooCommerce\Utilities\FeaturesUtil;
+use Automattic\WooCommerce\Admin\Features\ProductBlockEditor\BlockRegistry;
+use Automattic\WooCommerce\Internal\Admin\Features\ProductBlockEditor\ProductTemplates\ProductBlock;
+use Automattic\WooCommerce\Internal\Admin\Features\ProductBlockEditor\ProductTemplates\Section;
+use WooCommerce\Square\Handlers\Product;
+
+class Product_Editor_Compatibility {
+	public function __construct() {
+		if ( ! FeaturesUtil::feature_is_enabled( 'product_block_editor' ) ) {
+			return;
+		}
+
+		if ( wc_square()->get_settings_handler()->is_system_of_record_disabled() ) {
+			return;
+		}
+
+		add_action(
+			'init',
+			array( $this, 'register_custom_blocks' )
+		);
+
+		add_filter(
+			'woocommerce_rest_prepare_product_object',
+			array( $this, 'add_data_to_product_response' ),
+			10,
+			2
+		);
+
+		add_action(
+			'woocommerce_rest_insert_product_object',
+			array( $this, 'process_data_before_save' ),
+			10,
+			2
+		);
+
+		add_action(
+			'woocommerce_block_template_area_product-form_after_add_block_basic-details',
+			array( $this, 'add_sync_with_square_control' )
+		);
+
+		add_action(
+			'woocommerce_block_template_area_product-form_after_add_block_product-sku-field',
+			array( $this, 'add_inventory_control' )
+		);
+
+		add_action(
+			'woocommerce_block_template_after_add_block',
+			array( $this, 'remove_core_blocks' )
+		);
+	}
+
+	/**
+	 * Registers the custom product field blocks.
+	 */
+	public function register_custom_blocks() {
+		if ( isset( $_GET['page'] ) && 'wc-admin' === $_GET['page'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+			BlockRegistry::get_instance()->register_block_type_from_metadata( WC_SQUARE_PLUGIN_PATH . '/build/admin/product-blocks/stock-management-field' );
+			BlockRegistry::get_instance()->register_block_type_from_metadata( WC_SQUARE_PLUGIN_PATH . '/build/admin/product-blocks/stock-quantity-field' );
+			BlockRegistry::get_instance()->register_block_type_from_metadata( WC_SQUARE_PLUGIN_PATH . '/build/admin/product-blocks/sync-with-square-field' );
+		}
+	}
+
+	/**
+	 * Adds Square product meta to the product response.
+	 *
+	 * @param \WP_REST_Response $response The response object.
+	 * @param \WC_Product       $product  The product object.
+	 *
+	 * @return WP_REST_Response
+	 */
+	public function add_data_to_product_response( $response, $product ) {
+		$data                              = $response->get_data();
+		$data['is_sync_enabled']           = wc_square()->get_settings_handler()->is_product_sync_enabled();
+		$data['is_inventory_sync_enabled'] = wc_square()->get_settings_handler()->is_inventory_sync_enabled();
+		$data['is_square_synced']          = Product::is_synced_with_square( $product );
+		$data['edit_link']                 = Product::get_product_edit_link( $product );
+		$data['sor']                       = wc_square()->get_settings_handler()->get_system_of_record();
+		$data['fetch_stock_nonce']         = wp_create_nonce( 'fetch-product-stock-with-square' );
+		$data['stock_quantity']            = $product->get_stock_quantity();
+		$data['is_gift_card']              = Product::is_gift_card( $product ) ? 'yes' : 'no';
+		$response->set_data( $data );
+
+		return $response;
+	}
+
+	/**
+	 * Saves custom data to product metadata.
+	 *
+	 * @param \WC_Product      $product The product object.
+	 * @param \WP_REST_Request $request The request object.
+	 */
+	public function process_data_before_save( $product, $request ) {
+		$is_square_synced = $request->get_param( 'is_square_synced' );
+		$stock_quantity   = $request->get_param( 'stock_quantity' );
+		$is_gift_card     = $request->get_param( 'is_gift_card' );
+		$is_virtual       = $request->get_param( 'virtual' );
+
+		if ( ! is_null( $is_square_synced ) ) {
+			if ( $is_square_synced ) {
+				Product::set_synced_with_square( $product, 'yes' );
+			} else {
+				Product::set_synced_with_square( $product, 'no' );
+			}
+		}
+
+		if ( ! is_null( $stock_quantity ) && ! empty( $stock_quantity ) ) {
+			$product->set_stock_quantity( $stock_quantity );
+		}
+
+		if ( 'yes' === $is_gift_card && ( is_null( $is_virtual ) || $is_virtual ) ) {
+			$product->update_meta_data( Product::SQUARE_GIFT_CARD_KEY, 'yes' );
+			$product->set_virtual( true );
+			$product->set_sold_individually( 'yes' );
+			$product->set_tax_status( 'none' );
+		} elseif ( 'no' === $is_gift_card || ! $is_virtual ) {
+			$product->delete_meta_data( Product::SQUARE_GIFT_CARD_KEY );
+			$product->set_virtual( false );
+			$product->set_sold_individually( 'no' );
+			$product->set_tax_status( 'taxable' );
+		}
+
+		$product->save();
+	}
+
+	/**
+	 * Adds the sync with Square control to the product editor.
+	 *
+	 * @param Section $basic_details_field The basic details field block.
+	 */
+	public function add_sync_with_square_control( $basic_details_field ) {
+		$gift_card_settings = get_option( 'woocommerce_gift_cards_pay_settings', array() );
+
+		if ( isset( $gift_card_settings['enabled'] ) && 'yes' === $gift_card_settings['enabled'] ) {
+			$basic_details_field->add_block(
+				array(
+					'id'             => '_square_gift_card',
+					'blockName'      => 'woocommerce/product-checkbox-field',
+					'attributes'     => array(
+						'title'          => __( 'Square Gift Card', 'woocommerce-square' ),
+						'label'          => __( 'Enable to create this product as a gift card', 'woocommerce-square' ),
+						'property'       => 'is_gift_card',
+						'checkedValue'   => 'yes',
+						'uncheckedValue' => 'no',
+					),
+					'hideConditions' => array(
+						array(
+							'expression' => '"simple" !== editedProduct.type && "variable" !== editedProduct.type',
+						),
+					),
+				)
+			);
+		}
+
+		$basic_details_field->add_block(
+			array(
+				'id'             => '_wc_square_synced',
+				'blockName'      => 'woocommerce-square/sync-with-square-field',
+				'attributes'     => array(
+					'title' => __( 'Sync with Square', 'woocommerce-square' ),
+				),
+				'hideConditions' => array(
+					array(
+						'expression' => '!editedProduct.is_sync_enabled || editedProduct.is_gift_card === "yes"',
+					),
+				),
+			)
+		);
+	}
+
+	/**
+	 * Adds the inventory control to the product editor.
+	 *
+	 * @param Section $sku_field The SKU field block.
+	 */
+	public function add_inventory_control( $sku_field ) {
+		/**
+		 * Inventory section block.
+		 *
+		 * @var Section $parent
+		 */
+		$parent = $sku_field->get_parent();
+
+		$is_inventory_sync_enabled = wc_square()->get_settings_handler()->is_inventory_sync_enabled();
+
+		if ( ! $is_inventory_sync_enabled ) {
+			return;
+		}
+
+		$parent->add_block(
+			array(
+				'id'         => '_wc_square_stock_management_field',
+				'blockName'  => 'woocommerce-square/stock-management-field',
+				'attributes' => array(
+					'disabled'     => 'yes' !== get_option( 'woocommerce_manage_stock' ),
+					'disabledCopy' => sprintf(
+						/* translators: %1$s: Learn more link opening tag. %2$s: Learn more link closing tag.*/
+						__( 'Per your %1$sstore settings%2$s, inventory management is <strong>disabled</strong>.', 'woocommerce-square' ),
+						'<a href="' . admin_url( 'admin.php?page=wc-settings&tab=products&section=inventory' ) . '" target="_blank" rel="noreferrer">',
+						'</a>'
+					),
+				),
+			)
+		);
+
+		$parent->add_block(
+			array(
+				'id'        => '_wc_square_stock_quantity_field',
+				'blockName' => 'woocommerce-square/stock-quantity-field',
+			)
+		);
+	}
+
+	/**
+	 * Removes the manage stock and stock quantity blocks from the product editor.
+	 *
+	 * @param ProductBlock $block Core product blocks.
+	 */
+	public function remove_core_blocks( $block ) {
+		$blocks_to_remove = array();
+
+		if ( wc_square()->get_settings_handler()->is_inventory_sync_enabled() ) {
+			$blocks_to_remove[] = 'product-inventory-quantity';
+			$blocks_to_remove[] = 'product-track-stock';
+		}
+
+		/* Square classic product editor modifies a few core product meta fields functionaity.
+		 * For example, conditionally disabling, hiding and even modifying the core product meta fields.
+		 *
+		 * This is not possible with the current block editor implementation. However, the new product editor
+		 * allows to replace core blocks with custom implementation. This is not the best way to do it,
+		 * but it's a workaround.
+		 */
+		if ( in_array( $block->get_id(), $blocks_to_remove, true ) ) {
+			$block->remove();
+		}
+	}
+}

includes/Handlers/Products.php

@@ -31,6 +31,7 @@
 use WooCommerce\Square\Sync\Records;
 use WooCommerce\Square;
 use WooCommerce\Square\Gateway\Gift_Card;
+use Automattic\WooCommerce\Utilities\FeaturesUtil;
 
 /**
  * Products admin handler.
@@ -616,9 +617,12 @@ public function process_product_data( $product ) {
 	 * @param \WC_Product $product product object
 	 */
 	public function maybe_adjust_square_stock( $product ) {
+		$is_new_product_editor_enabled = FeaturesUtil::feature_is_enabled( 'product_block_editor' );
 
 		// this is hooked in to general product object save, so scope to specifically saving products via the admin
-		if ( ! doing_action( 'wp_ajax_woocommerce_save_variations' ) && ! doing_action( 'woocommerce_admin_process_product_object' ) ) {
+		if ( $is_new_product_editor_enabled && ! wc_rest_is_from_product_editor() ) {
+			return;
+		} elseif ( ! $is_new_product_editor_enabled && ! doing_action( 'wp_ajax_woocommerce_save_variations' ) && ! doing_action( 'woocommerce_admin_process_product_object' ) ) {
 			return;
 		}