PIPRES-261: Separate carrier for recurring orders improvements (#821)

* PIPRES-261: shipping option module setting (#814) * PIPRES-261: Shipping option module setting * csfixer * install and uninstall subscription configuration * improved faq page * PIPRES-333: Missing registered interface (#816) * PIPRES-261: Get carrier price to create subscription (#817) * PIPRES-261: Get carrier price to create subscription * updated subscription faq * renamed some services and added additional conditions for carrier retrieve * addedd back to exception codes * PIPRES-261: Set carrier for recurring order (#818) * PIPRES-261: Get carrier price to create subscription * renamed some services and added additional conditions for carrier retrieve * PIPRES-261: Set carrier for recurring order * PIPRES-261: Subscription order detail view refactoring (#819) * PIPRES-261: Get carrier price to create subscription * renamed some services and added additional conditions for carrier retrieve * addedd back to exception codes * PIPRES-261: Subscription order detail view refactoring * phpstan * PIPRES-261: Minor improvements (#820) * PIPRES-261: Get carrier price to create subscription * renamed some services and added additional conditions for carrier retrieve * PIPRES-261: Minor improvements * PIPRES-261: Create fresh specific price (#822) * PIPRES-261: Restrict BO subscription list for all shops (#823) * PIPRES-261: Restrict BO subscription list for all shops * fixed redundant error mesage
mollie · Oct 3, 2023 · 65b3671 · 65b3671
1 parent ae898a1
commit 65b3671
Show file tree

Hide file tree

Showing 54 changed files with 1,628 additions and 291 deletions.
diff --git a/controllers/front/recurringOrderDetail.php b/controllers/front/recurringOrderDetail.php
@@ -25,6 +25,7 @@
  */
 
 use Mollie\Controller\AbstractMollieController;
+use Mollie\Logger\PrestaLoggerInterface;
 use Mollie\Subscription\Handler\FreeOrderCreationHandler;
 use Mollie\Subscription\Handler\SubscriptionCancellationHandler;
 use Mollie\Subscription\Presenter\RecurringOrderPresenter;
@@ -74,13 +75,25 @@ public function initContent()
             Tools::redirect(Context::getContext()->link->getModuleLink($this->module->name, 'subscriptions', [], true));
         }
 
+        /** @var PrestaLoggerInterface $logger */
+        $logger = $this->module->getService(PrestaLoggerInterface::class);
+
         /** @var RecurringOrderPresenter $recurringOrderPresenter */
         $recurringOrderPresenter = $this->module->getService(RecurringOrderPresenter::class);
 
-        $this->context->smarty->assign([
-            'recurringOrderData' => $recurringOrderPresenter->present($recurringOrderId),
-            'token' => Tools::getToken(),
-        ]);
+        try {
+            $this->context->smarty->assign([
+                'recurringOrderData' => $recurringOrderPresenter->present($recurringOrderId),
+                'token' => Tools::getToken(),
+            ]);
+        } catch (Throwable $exception) {
+            $logger->error('Failed to present subscription order', [
+                'Exception message' => $exception->getMessage(),
+                'Exception code' => $exception->getCode(),
+            ]);
+
+            Tools::redirect(Context::getContext()->link->getModuleLink($this->module->name, 'subscriptions', [], true));
+        }
 
         parent::initContent();
         $this->context->controller->addCSS($this->module->getPathUri() . 'views/css/front/subscription/customer_order_detail.css');

diff --git a/controllers/front/subscriptionWebhook.php b/controllers/front/subscriptionWebhook.php
@@ -13,6 +13,7 @@
 use Mollie\Controller\AbstractMollieController;
 use Mollie\Errors\Http\HttpStatusCode;
 use Mollie\Handler\ErrorHandler\ErrorHandler;
+use Mollie\Logger\PrestaLoggerInterface;
 use Mollie\Subscription\Handler\RecurringOrderHandler;
 
 if (!defined('_PS_VERSION_')) {
@@ -62,9 +63,17 @@ protected function executeWebhook()
         /** @var ErrorHandler $errorHandler */
         $errorHandler = $this->module->getService(ErrorHandler::class);
 
+        /** @var PrestaLoggerInterface $logger */
+        $logger = $this->module->getService(PrestaLoggerInterface::class);
+
         try {
             $recurringOrderHandler->handle($transactionId);
         } catch (\Throwable $exception) {
+            $logger->error('Failed to handle recurring order', [
+                'Exception message' => $exception->getMessage(),
+                'Exception code' => $exception->getCode(),
+            ]);
+
             $errorHandler->handle($exception, null, false);
 
             $this->respond('failed', HttpStatusCode::HTTP_BAD_REQUEST);

diff --git a/src/Adapter/Context.php b/src/Adapter/Context.php
@@ -130,4 +130,19 @@ public function getShopGroupId(): int
     {
         return (int) PrestashopContext::getContext()->shop->id_shop_group;
     }
+
+    public function formatPrice(float $price, string $isoCode): string
+    {
+        $locale = PrestashopContext::getContext()->getCurrentLocale();
+
+        /* @phpstan-ignore-next-line */
+        if (!$locale) {
+            return (string) $price;
+        }
+
+        return $locale->formatPrice(
+            $price,
+            $isoCode
+        );
+    }
 }
diff --git a/src/Adapter/Shop.php b/src/Adapter/Shop.php
@@ -19,8 +19,8 @@ public function getShop(): \Shop
         return \Context::getContext()->shop;
     }
 
-    public function getContext()
+    public function getContext(): int
     {
-        return $this->getShop()->getContext();
+        return (int) $this->getShop()->getContext();
     }
 }
diff --git a/src/Builder/FormBuilder.php b/src/Builder/FormBuilder.php
@@ -24,6 +24,7 @@
 use Mollie\Api\Types\RefundStatus;
 use Mollie\Config\Config;
 use Mollie\Provider\CustomLogoProviderInterface;
+use Mollie\Repository\CarrierRepositoryInterface;
 use Mollie\Repository\TaxRulesGroupRepositoryInterface;
 use Mollie\Service\ApiService;
 use Mollie\Service\ConfigFieldService;
@@ -90,6 +91,8 @@ class FormBuilder
 
     /** @var Context */
     private $context;
+    /** @var CarrierRepositoryInterface */
+    private $carrierRepository;
 
     public function __construct(
         Mollie $module,
@@ -103,7 +106,8 @@ public function __construct(
         CustomLogoProviderInterface $creditCardLogoProvider,
         ConfigurationAdapter $configuration,
         TaxRulesGroupRepositoryInterface $taxRulesGroupRepository,
-        Context $context
+        Context $context,
+        CarrierRepositoryInterface $carrierRepository
     ) {
         $this->module = $module;
         $this->apiService = $apiService;
@@ -117,6 +121,7 @@ public function __construct(
         $this->configuration = $configuration;
         $this->taxRulesGroupRepository = $taxRulesGroupRepository;
         $this->context = $context;
+        $this->carrierRepository = $carrierRepository;
     }
 
     public function buildSettingsForm()
@@ -527,6 +532,8 @@ protected function getAdvancedSettingsSection()
             ],
         ];
 
+        $input = array_merge($input, $this->getShippingOptions($advancedSettings));
+
         $messageStatus = $this->module->l('Status for %s payments', self::FILE_NAME);
         $descriptionStatus = $this->module->l('`%s` payments get `%s` status', self::FILE_NAME);
         $messageMail = $this->module->l('Send email when %s', self::FILE_NAME);
@@ -821,4 +828,52 @@ private function getSettingTabs($isApiKeyProvided)
 
         return $tabs;
     }
+
+    private function getShippingOptions(string $tab): array
+    {
+        /** @var \Carrier[] $carriers */
+        $carriers = $this->carrierRepository->findAllBy([
+            'active' => 1,
+            'deleted' => 0,
+        ]);
+
+        $mappedCarriers = [];
+
+        $mappedCarriers[] = [
+            'id' => 0,
+            'name' => $this->module->l('Not selected', self::FILE_NAME),
+        ];
+
+        foreach ($carriers as $carrier) {
+            $mappedCarriers[] = [
+                'id' => $carrier->id,
+                'name' => $carrier->name,
+            ];
+        }
+
+        $header = [
+            'type' => 'mollie-h2',
+            'name' => '',
+            'tab' => $tab,
+            'title' => $this->module->l('Subscriptions', self::FILE_NAME),
+        ];
+
+        $options = [
+            'type' => 'select',
+            'label' => $this->module->l('Select shipping option to use in subscription orders', self::FILE_NAME),
+            'desc' => $this->module->l('WARNING: do not change selection after getting first subscription order.', self::FILE_NAME),
+            'tab' => $tab,
+            'name' => Config::MOLLIE_SUBSCRIPTION_ORDER_CARRIER_ID,
+            'options' => [
+                'query' => $mappedCarriers,
+                'id' => 'id',
+                'name' => 'name',
+            ],
+        ];
+
+        return [
+            $header,
+            $options,
+        ];
+    }
 }
diff --git a/src/Config/Config.php b/src/Config/Config.php
@@ -157,6 +157,8 @@ class Config
     const MOLLIE_CARRIER_URL_SOURCE = 'MOLLIE_CARRIER_URL_SOURCE_';
     const MOLLIE_CARRIER_CUSTOM_URL = 'MOLLIE_CARRIER_CUSTOM_URL_';
 
+    const MOLLIE_SUBSCRIPTION_ORDER_CARRIER_ID = 'MOLLIE_SUBSCRIPTION_ORDER_CARRIER_ID';
+
     const MOLLIE_METHOD_ENABLED = 'MOLLIE_METHOD_ENABLED_';
     const MOLLIE_METHOD_TITLE = 'MOLLIE_METHOD_TITLE_';
     const MOLLIE_METHOD_API = 'MOLLIE_METHOD_API_';

diff --git a/src/Exception/CouldNotCreateOrderPaymentFee.php b/src/Exception/CouldNotCreateOrderPaymentFee.php
@@ -7,7 +7,7 @@
 
 class CouldNotCreateOrderPaymentFee extends MollieException
 {
-    public static function failedToInsertOrderPaymentFee(Exception $exception): CouldNotCreateOrderPaymentFee
+    public static function failedToInsertOrderPaymentFee(Exception $exception): self
     {
         return new self(
             'Failed to insert order payment fee.',

diff --git a/src/Exception/CouldNotInstallModule.php b/src/Exception/CouldNotInstallModule.php
@@ -6,7 +6,7 @@
 
 class CouldNotInstallModule extends MollieException
 {
-    public static function failedToInstallOrderState(string $orderStateName, \Exception $exception): CouldNotInstallModule
+    public static function failedToInstallOrderState(string $orderStateName, \Exception $exception): self
     {
         return new self(
             sprintf('Failed to install order state (%s).', $orderStateName),

diff --git a/src/Exception/CouldNotUpdateOrderTotals.php b/src/Exception/CouldNotUpdateOrderTotals.php
@@ -7,7 +7,7 @@
 
 class CouldNotUpdateOrderTotals extends MollieException
 {
-    public static function failedToUpdateOrderTotals(Exception $exception): CouldNotUpdateOrderTotals
+    public static function failedToUpdateOrderTotals(Exception $exception): self
     {
         return new self(
             'Failed to update order totals.',

diff --git a/src/Handler/Exception/CouldNotHandleOrderPaymentFee.php b/src/Handler/Exception/CouldNotHandleOrderPaymentFee.php
@@ -8,7 +8,7 @@
 
 class CouldNotHandleOrderPaymentFee extends MollieException
 {
-    public static function failedToRetrievePaymentMethod(Throwable $exception): CouldNotHandleOrderPaymentFee
+    public static function failedToRetrievePaymentMethod(Throwable $exception): self
     {
         return new self(
             'Failed to retrieve payment method',
@@ -17,7 +17,7 @@ public static function failedToRetrievePaymentMethod(Throwable $exception): Coul
         );
     }
 
-    public static function failedToRetrievePaymentFee(Throwable $exception): CouldNotHandleOrderPaymentFee
+    public static function failedToRetrievePaymentFee(Throwable $exception): self
     {
         return new self(
             'Failed to retrieve payment fee',
@@ -26,7 +26,7 @@ public static function failedToRetrievePaymentFee(Throwable $exception): CouldNo
         );
     }
 
-    public static function failedToCreateOrderPaymentFee(Throwable $exception): CouldNotHandleOrderPaymentFee
+    public static function failedToCreateOrderPaymentFee(Throwable $exception): self
     {
         return new self(
             'Failed to create order payment fee',
@@ -35,7 +35,7 @@ public static function failedToCreateOrderPaymentFee(Throwable $exception): Coul
         );
     }
 
-    public static function failedToUpdateOrderTotalWithPaymentFee(Throwable $exception): CouldNotHandleOrderPaymentFee
+    public static function failedToUpdateOrderTotalWithPaymentFee(Throwable $exception): self
     {
         return new self(
             'Failed to update order total with payment fee.',

diff --git a/src/Handler/Order/OrderCreationHandler.php b/src/Handler/Order/OrderCreationHandler.php
@@ -49,6 +49,7 @@
 use Mollie\DTO\PaymentData;
 use Mollie\Exception\FailedToProvidePaymentFeeException;
 use Mollie\Exception\OrderCreationException;
+use Mollie\Logger\PrestaLoggerInterface;
 use Mollie\Provider\PaymentFeeProviderInterface;
 use Mollie\Repository\PaymentMethodRepositoryInterface;
 use Mollie\Service\OrderStatusService;
@@ -85,6 +86,8 @@ class OrderCreationHandler
     private $subscriptionOrder;
     /** @var PaymentFeeProviderInterface */
     private $paymentFeeProvider;
+    /** @var PrestaLoggerInterface */
+    private $logger;
 
     public function __construct(
         Mollie $module,
@@ -94,7 +97,8 @@ public function __construct(
         OrderStatusService $orderStatusService,
         SubscriptionCreationHandler $recurringOrderCreation,
         SubscriptionOrderValidator $subscriptionOrder,
-        PaymentFeeProviderInterface $paymentFeeProvider
+        PaymentFeeProviderInterface $paymentFeeProvider,
+        PrestaLoggerInterface $logger
     ) {
         $this->module = $module;
         $this->paymentMethodRepository = $paymentMethodRepository;
@@ -104,6 +108,7 @@ public function __construct(
         $this->recurringOrderCreation = $recurringOrderCreation;
         $this->subscriptionOrder = $subscriptionOrder;
         $this->paymentFeeProvider = $paymentFeeProvider;
+        $this->logger = $logger;
     }
 
     /**
@@ -286,6 +291,16 @@ private function createRecurringOrderEntity(Order $order, string $method): void
             return;
         }
 
-        $this->recurringOrderCreation->handle($order, $method);
+        try {
+            $this->recurringOrderCreation->handle($order, $method);
+        } catch (\Throwable $exception) {
+            $this->logger->error(
+                'Failed to create recurring order',
+                [
+                    'Exception message' => $exception->getMessage(),
+                    'Exception code' => $exception->getCode(),
+                ]
+            );
+        }
     }
 }
diff --git a/src/Install/Installer.php b/src/Install/Installer.php
@@ -209,6 +209,8 @@ protected function initConfig()
         $this->configurationAdapter->updateValue(Config::MOLLIE_API, Config::MOLLIE_ORDERS_API);
         $this->configurationAdapter->updateValue(Config::MOLLIE_APPLE_PAY_DIRECT_STYLE, 0);
         $this->configurationAdapter->updateValue(Config::MOLLIE_BANCONTACT_QR_CODE_ENABLED, 0);
+
+        $this->configurationAdapter->updateValue(Config::MOLLIE_SUBSCRIPTION_ORDER_CARRIER_ID, 0);
     }
 
     public function setDefaultCarrierStatuses()

diff --git a/src/Install/Uninstall.php b/src/Install/Uninstall.php
@@ -92,6 +92,7 @@ private function deleteConfig()
             Config::METHODS_CONFIG,
             Config::MOLLIE_MAIL_WHEN_COMPLETED,
             Config::MOLLIE_API_KEY_TEST,
+            Config::MOLLIE_SUBSCRIPTION_ORDER_CARRIER_ID,
         ];
 
         $this->deleteConfigurations($configurations);

diff --git a/src/Repository/AddressRepository.php b/src/Repository/AddressRepository.php
@@ -2,12 +2,15 @@
 
 namespace Mollie\Repository;
 
-use Address;
-
 class AddressRepository extends AbstractRepository implements AddressRepositoryInterface
 {
     public function __construct()
     {
-        parent::__construct(Address::class);
+        parent::__construct(\Address::class);
+    }
+
+    public function getZoneById(int $id_address_delivery): int
+    {
+        return \Address::getZoneById($id_address_delivery);
     }
 }
diff --git a/src/Repository/AddressRepositoryInterface.php b/src/Repository/AddressRepositoryInterface.php
@@ -4,4 +4,5 @@
 
 interface AddressRepositoryInterface extends ReadOnlyRepositoryInterface
 {
+    public function getZoneById(int $id_address_delivery): int;
 }
diff --git a/src/Repository/CarrierRepository.php b/src/Repository/CarrierRepository.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace Mollie\Repository;
+
+class CarrierRepository extends AbstractRepository implements CarrierRepositoryInterface
+{
+    public function __construct()
+    {
+        parent::__construct(\Carrier::class);
+    }
+
+    public function getCarriersForOrder(int $id_zone, array $groups = null, \Cart $cart = null, &$error = []): array
+    {
+        return \Carrier::getCarriersForOrder($id_zone, $groups, $cart, $error);
+    }
+}
diff --git a/src/Repository/CarrierRepositoryInterface.php b/src/Repository/CarrierRepositoryInterface.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace Mollie\Repository;
+
+interface CarrierRepositoryInterface extends ReadOnlyRepositoryInterface
+{
+    public function getCarriersForOrder(int $id_zone, array $groups = null, \Cart $cart = null, &$error = []): array;
+}
diff --git a/src/Repository/CountryRepository.php b/src/Repository/CountryRepository.php
@@ -15,7 +15,7 @@
 use Country;
 use Db;
 
-final class CountryRepository extends AbstractRepository
+final class CountryRepository extends AbstractRepository implements CountryRepositoryInterface
 {
     public function __construct()
     {
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,4 +4,5 @@ @@
     interface AddressRepositoryInterface extends ReadOnlyRepositoryInterface
     {
+        public function getZoneById(int $id_address_delivery): int;
     }