fix(settings): hide delivery options position setting when blocks checkout is enabled

src/Contract/WooCommerceServiceInterface.php

@@ -6,11 +6,6 @@
 
 interface WooCommerceServiceInterface
 {
-    /**
-     * Whether HPOS is enabled in WooCommerce.
-     */
-    public function isUsingHpos(): bool;
-
     /**
      * @return string
      */
@@ -20,4 +15,14 @@ public function getVersion(): string;
      * @return bool
      */
     public function isActive(): bool;
+
+    /**
+     * @return bool
+     */
+    public function isUsingBlocksCheckout(): bool;
+
+    /**
+     * Whether HPOS is enabled in WooCommerce.
+     */
+    public function isUsingHpos(): bool;
 }

src/Pdk/WcPdkBootstrapper.php

@@ -8,6 +8,7 @@
 use MyParcelNL\Pdk\Facade\Pdk;
 use MyParcelNL\Pdk\Settings\Model\CheckoutSettings;
 use MyParcelNL\WooCommerce\Integration\DeliveryOptionsBlocksIntegration;
+use MyParcelNL\WooCommerce\Service\WooCommerceService;
 use function DI\factory;
 use function DI\value;
 
@@ -194,13 +195,23 @@ protected function getAdditionalConfig(
              * Settings defaults
              */
 
-            'defaultSettings'          => value([
+            'defaultSettings' => value([
                 CheckoutSettings::ID => [
                     CheckoutSettings::ALLOWED_SHIPPING_METHODS  => ['flat_rate:0', 'free_shipping:0'],
                     CheckoutSettings::DELIVERY_OPTIONS_POSITION => 'woocommerce_after_checkout_billing_form',
                 ],
             ]),
 
+            'disabledSettings'         => factory(function () {
+                $disabledSettings = [];
+                if (Pdk::get(WooCommerceService::class)
+                    ->isUsingBlocksCheckout()) {
+                    $disabledSettings[CheckoutSettings::ID][] = CheckoutSettings::DELIVERY_OPTIONS_POSITION;
+                }
+
+                return $disabledSettings;
+            }),
+
             /**
              * @see https://www.businessbloomer.com/woocommerce-visual-hook-guide-checkout-page/
              */

src/Service/WooCommerceService.php

@@ -7,6 +7,7 @@
 use Automattic\WooCommerce\Utilities\OrderUtil;
 use MyParcelNL\Pdk\Facade\Pdk;
 use MyParcelNL\WooCommerce\Contract\WooCommerceServiceInterface;
+use WC_Blocks_Utils;
 
 /**
  * @see /config/pdk.php
@@ -21,6 +22,15 @@ public function getVersion(): string
         return Pdk::get('wooCommerceVersion');
     }
 
+    /**
+     * @return bool
+     * @see https://stackoverflow.com/a/77950175
+     */
+    public function isUsingBlocksCheckout(): bool
+    {
+        return WC_Blocks_Utils::has_block_in_page(wc_get_page_id('checkout'), 'woocommerce/checkout');
+    }
+
     /**
      * @return bool
      */

tests/Mock/MockWcBlocksUtils.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MyParcelNL\WooCommerce\Tests\Mock;
+
+use WP_Post;
+
+class MockWcBlocksUtils extends MockWcClass
+{
+    /**
+     * Check if a given page contains a particular block.
+     *
+     * @param  int|WP_Post $page       Page post ID or post object.
+     * @param  string      $block_name The name (id) of a block, e.g. `woocommerce/cart`.
+     *
+     * @return bool Boolean value if the page contains the block or not. Null in case the page does not exist.
+     */
+    public static function has_block_in_page($page, $block_name)
+    {
+        //todo: extend this function when we want to check for specific blocks in tests
+        return MockWpCache::get($page, 'pages')['hasBlocks'];
+    }
+}

tests/Unit/Pdk/WcPdkBootstrapperTest.php

@@ -5,6 +5,8 @@
 namespace MyParcelNL\WooCommerce\Pdk;
 
 use MyParcelNL\Pdk\Facade\Pdk;
+use MyParcelNL\Pdk\Settings\Model\CheckoutSettings;
+use MyParcelNL\WooCommerce\Tests\Mock\MockWpCache;
 use MyParcelNL\WooCommerce\Tests\Mock\MockWpUser;
 use MyParcelNL\WooCommerce\Tests\Uses\UsesMockWcPdkInstance;
 use function MyParcelNL\Pdk\Tests\usesShared;
@@ -65,3 +67,23 @@
         'expected' => true,
     ],
 ]);
+
+it('enables or disables delivery options position setting', function ($pageId, $group, $data, $result) {
+    MockWpCache::add($pageId, $data, $group);
+    $disabledSettings = Pdk::get('disabledSettings');
+
+    expect($disabledSettings)->toEqual($result);
+})->with([
+    'Blocks checkout enabled'  => [
+        'pageId' => '7',
+        'group'  => 'pages',
+        'data'   => ['pageName' => 'checkout', 'hasBlocks' => true],
+        'result' => [CheckoutSettings::ID => [CheckoutSettings::DELIVERY_OPTIONS_POSITION]],
+    ],
+    'Classic checkout enabled' => [
+        'pageId' => '7',
+        'group'  => 'pages',
+        'data'   => ['pageName' => 'checkout', 'hasBlocks' => false],
+        'result' => [],
+    ],
+]);

tests/mock_class_map.php

@@ -4,6 +4,7 @@
 declare(strict_types=1);
 
 use MyParcelNL\WooCommerce\Tests\Mock\MockWc;
+use MyParcelNL\WooCommerce\Tests\Mock\MockWcBlocksUtils;
 use MyParcelNL\WooCommerce\Tests\Mock\MockWcCart;
 use MyParcelNL\WooCommerce\Tests\Mock\MockWcCartRepository;
 use MyParcelNL\WooCommerce\Tests\Mock\MockWcClass;
@@ -17,10 +18,10 @@
 use MyParcelNL\WooCommerce\Tests\Mock\MockWcShippingMethodFlatRateClass;
 use MyParcelNL\WooCommerce\Tests\Mock\MockWcShippingZone;
 use MyParcelNL\WooCommerce\Tests\Mock\MockWcShippingZonesClass;
-use MyParcelNL\WooCommerce\Tests\Mock\MockWpTerm;
 use MyParcelNL\WooCommerce\Tests\Mock\MockWpRestRequest;
 use MyParcelNL\WooCommerce\Tests\Mock\MockWpRestResponse;
 use MyParcelNL\WooCommerce\Tests\Mock\MockWpRestServer;
+use MyParcelNL\WooCommerce\Tests\Mock\MockWpTerm;
 
 /** @see \MyParcelNL\WooCommerce\bootPdk() */
 const PEST = true;
@@ -83,3 +84,6 @@
 
 /** @see \WP_REST_Response */
 class WP_REST_Response extends MockWpRestResponse { }
+
+/** @see \WC_Blocks_Utils */
+class WC_Blocks_Utils extends MockWcBlocksUtils { }

tests/mock_wc_functions.php

@@ -5,6 +5,7 @@
 
 use MyParcelNL\WooCommerce\Tests\Mock\MockWc;
 use MyParcelNL\WooCommerce\Tests\Mock\MockWcData;
+use MyParcelNL\WooCommerce\Tests\Mock\MockWpCache;
 
 /** @see \get_woocommerce_currency() */
 function get_woocommerce_currency(): string
@@ -84,3 +85,31 @@
 {
     return MockWc::getInstance();
 }
+
+/**
+ * @param  string $page Page slug.
+ *
+ * @return int
+ * @see \wc_get_page_id()
+ *      Retrieve page ids - used for myaccount, edit_address, shop, cart, checkout, pay, view_order, terms. returns -1
+ *      if no page is found.
+ */
+function wc_get_page_id(string $page)
+{
+    if ('pay' === $page || 'thanks' === $page) {
+        $page = 'checkout';
+    }
+    if ('change_password' === $page || 'edit_address' === $page || 'lost_password' === $page) {
+        $page = 'myaccount';
+    }
+
+    $allPages = MockWpCache::$cache['pages'];
+
+    foreach ($allPages as $pageId => $singlePage) {
+        if ($singlePage['data']['pageName'] === $page) {
+            return $pageId;
+        }
+    }
+
+    return -1;
+}