Having dynamic checkout APIs throw error if config value is not enabled (#625)

Co-authored-by: Noah Ostrowski <[email protected]>

Author: nrostrow-meta

app/code/Meta/Sales/Api/AddCartItemsApiInterface.php

@@ -33,8 +33,8 @@ interface AddCartItemsApiInterface
      * @param string $externalBusinessId
      * @param \Magento\Quote\Api\Data\CartItemInterface[] $items
      * @return \Meta\Sales\Api\AddCartItemsApiResponseInterface
-     * @throws UnauthorizedTokenException
-     * @throws LocalizedException
+     * @throws \Magento\Framework\Exception\UnauthorizedTokenException
+     * @throws \Magento\Framework\Exception\LocalizedException
      */
     public function addCartItems(string $externalBusinessId, array $items): AddCartItemsApiResponseInterface;
 }

app/code/Meta/Sales/Api/CreateCartApiInterface.php

@@ -30,8 +30,8 @@ interface CreateCartApiInterface
      *
      * @param string $externalBusinessId
      * @return string
-     * @throws UnauthorizedTokenException
-     * @throws LocalizedException
+     * @throws \Magento\Framework\Exception\UnauthorizedTokenException
+     * @throws \Magento\Framework\Exception\LocalizedException
      */
     public function createCart(string $externalBusinessId): string;
 }

app/code/Meta/Sales/Helper/OrderHelper.php

@@ -45,21 +45,29 @@ class OrderHelper
      */
     private CollectionFactory $collectionFactory;
 
+    /**
+     * @var SystemConfig
+     */
+    private SystemConfig $systemConfig;
+
     /**
      * Constructor
      *
      * @param OrderExtensionFactory $orderExtensionFactory
      * @param FacebookOrderInterfaceFactory $facebookOrderFactory
      * @param CollectionFactory $collectionFactory
+     * @param SystemConfig $systemConfig
      */
     public function __construct(
         OrderExtensionFactory         $orderExtensionFactory,
         FacebookOrderInterfaceFactory $facebookOrderFactory,
-        CollectionFactory             $collectionFactory
+        CollectionFactory             $collectionFactory,
+        SystemConfig                  $systemConfig
     ) {
         $this->orderExtensionFactory = $orderExtensionFactory;
         $this->facebookOrderFactory = $facebookOrderFactory;
         $this->collectionFactory = $collectionFactory;
+        $this->systemConfig = $systemConfig;
     }
 
     /**
@@ -149,4 +157,18 @@ public function getMBEInstalledConfigsByExternalBusinessId(string $externalBusin
             return [];
         }
     }
+
+    /**
+     * Throws an exception if dynamic checkout apis are not enabled
+     *
+     * @return void
+     */
+    public function checkDynamicCheckoutConfig(): void
+    {
+        if (!$this->systemConfig->areDynamicCheckoutApisEnabled()) {
+            throw new LocalizedException(__(
+                "Dynamic Checkout APIs are not enabled"
+            ));
+        }
+    }
 }

app/code/Meta/Sales/Model/Api/AddCartItemsApi.php

@@ -74,11 +74,12 @@ public function __construct(
      * @param string $externalBusinessId
      * @param \Magento\Quote\Api\Data\CartItemInterface[] $items
      * @return \Meta\Sales\Api\AddCartItemsApiResponseInterface
-     * @throws UnauthorizedTokenException
-     * @throws LocalizedException
+     * @throws \Magento\Framework\Exception\UnauthorizedTokenException
+     * @throws \Magento\Framework\Exception\LocalizedException
      */
     public function addCartItems(string $externalBusinessId, array $items): AddCartItemsApiResponseInterface
     {
+        $this->orderHelper->checkDynamicCheckoutConfig();
         $this->authenticator->authenticateRequest();
         $storeId = $this->orderHelper->getStoreIdByExternalBusinessId($externalBusinessId);
         $itemsAdded = [];

app/code/Meta/Sales/Model/Api/CartShippingOptionsApi.php

@@ -83,6 +83,7 @@ public function __construct(
      */
     public function cartShippingOptions(string $externalBusinessId, string $cartId, AddressInterface $address): array
     {
+        $this->orderHelper->checkDynamicCheckoutConfig();
         $this->authenticator->authenticateRequest();
         $storeId = $this->orderHelper->getStoreIdByExternalBusinessId($externalBusinessId);
         try {

app/code/Meta/Sales/Model/Api/CartTotalsApi.php

@@ -75,12 +75,13 @@ public function __construct(
      * @param string $externalBusinessId
      * @param string $cartId
      * @return \Magento\Quote\Api\Data\TotalsInterface
-     * @throws UnauthorizedTokenException
+     * @throws \Magento\Framework\Exception\UnauthorizedTokenException
      * @throws \Magento\Framework\Exception\NoSuchEntityException
      * @throws \Magento\Framework\Exception\LocalizedException
      */
     public function getCartTotals(string $externalBusinessId, string $cartId): TotalsInterface
     {
+        $this->orderHelper->checkDynamicCheckoutConfig();
         $this->authenticator->authenticateRequest();
         $storeId = $this->orderHelper->getStoreIdByExternalBusinessId($externalBusinessId);
         try {

app/code/Meta/Sales/Model/Api/CreateCartApi.php

@@ -101,11 +101,12 @@ public function __construct(
      *
      * @param string $externalBusinessId
      * @return string
-     * @throws UnauthorizedTokenException
-     * @throws LocalizedException
+     * @throws \Magento\Framework\Exception\UnauthorizedTokenException
+     * @throws \Magento\Framework\Exception\LocalizedException
      */
     public function createCart(string $externalBusinessId): string
     {
+        $this->orderHelper->checkDynamicCheckoutConfig();
         $this->authenticator->authenticateRequest();
         $storeId = $this->orderHelper->getStoreIdByExternalBusinessId($externalBusinessId);
 

app/code/Meta/Sales/Model/Api/DeleteCartItemApi.php

@@ -82,6 +82,7 @@ public function __construct(
      */
     public function deleteCartItem(string $externalBusinessId, string $cartId, string $itemId): bool
     {
+        $this->orderHelper->checkDynamicCheckoutConfig();
         $this->authenticator->authenticateRequest();
         $storeId = $this->orderHelper->getStoreIdByExternalBusinessId($externalBusinessId);
         try {

app/code/Meta/Sales/Model/Api/SetCartShippingOptionApi.php

@@ -85,6 +85,7 @@ public function setCartShippingOption(
         string $cartId,
         ShippingInformationInterface $addressInformation
     ): PaymentDetailsInterface {
+        $this->orderHelper->checkDynamicCheckoutConfig();
         $this->authenticator->authenticateRequest();
         $storeId = $this->orderHelper->getStoreIdByExternalBusinessId($externalBusinessId);
         try {