[Refund] Soft deprecate refunds bypassing RefundPlugin

Author: NoResponseMate

config/services/twig.xml

@@ -50,6 +50,11 @@
             <tag name="twig.extension" />
         </service>
 
+        <service id="sylius_mollie.twig.extension.legacy_refund" class="Sylius\MolliePlugin\Twig\Extension\LegacyRefundExtension">
+            <argument type="service" id="sylius_mollie.payum.checker.mollie_gateway_factory" />
+            <tag name="twig.extension" />
+        </service>
+
         <service
             id="sylius_mollie.twig.component.email_template.form"
             class="Sylius\Bundle\UiBundle\Twig\Component\ResourceFormComponent"

config/twig_hooks/admin/payment_method/mollie/create.yaml

@@ -13,6 +13,9 @@ sylius_twig_hooks:
             log_level:
                 template: '@SyliusMolliePlugin/admin/payment_method/form/sections/gateway_configuration/log_level.html.twig'
                 priority: 100
+            legacy_refund:
+                template: '@SyliusMolliePlugin/admin/payment_method/form/sections/gateway_configuration/legacy_refund.html.twig'
+                priority: 50
             mollie_payment_methods:
                 template: '@SyliusMolliePlugin/admin/payment_method/form/sections/gateway_configuration/mollie_payment_methods.html.twig'
                 priority: 0

config/twig_hooks/admin/payment_method/mollie/update.yaml

@@ -24,6 +24,9 @@ sylius_twig_hooks:
             log_level:
                 template: '@SyliusMolliePlugin/admin/payment_method/form/sections/gateway_configuration/log_level.html.twig'
                 priority: 100
+            legacy_refund:
+                template: '@SyliusMolliePlugin/admin/payment_method/form/sections/gateway_configuration/legacy_refund.html.twig'
+                priority: 50
             mollie_payment_methods:
                 template: '@SyliusMolliePlugin/admin/payment_method/form/sections/gateway_configuration/mollie_payment_methods.html.twig'
                 priority: 0

config/twig_hooks/admin/payment_method/mollie_subscription/create.yaml

@@ -13,6 +13,9 @@ sylius_twig_hooks:
             log_level:
                 template: '@SyliusMolliePlugin/admin/payment_method/form/sections/gateway_configuration/log_level.html.twig'
                 priority: 100
+            legacy_refund:
+                template: '@SyliusMolliePlugin/admin/payment_method/form/sections/gateway_configuration/legacy_refund.html.twig'
+                priority: 50
             mollie_payment_methods:
                 template: '@SyliusMolliePlugin/admin/payment_method/form/sections/gateway_configuration/mollie_payment_methods.html.twig'
                 priority: 0

config/twig_hooks/admin/payment_method/mollie_subscription/update.yaml

@@ -13,6 +13,9 @@ sylius_twig_hooks:
             log_level:
                 template: '@SyliusMolliePlugin/admin/payment_method/form/sections/gateway_configuration/log_level.html.twig'
                 priority: 100
+            legacy_refund:
+                template: '@SyliusMolliePlugin/admin/payment_method/form/sections/gateway_configuration/legacy_refund.html.twig'
+                priority: 50
             mollie_payment_methods:
                 template: '@SyliusMolliePlugin/admin/payment_method/form/sections/gateway_configuration/mollie_payment_methods.html.twig'
                 priority: 0

src/Form/Type/MollieGatewayConfigurationType.php

@@ -15,6 +15,7 @@
 
 use Mollie\Api\Exceptions\ApiException;
 use Sylius\MolliePlugin\Client\MollieApiClient;
+use Sylius\MolliePlugin\Twig\Extension\LegacyRefundExtension;
 use Sylius\MolliePlugin\Validator\Constraints\LiveApiKeyIsNotBlank;
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
@@ -100,6 +101,11 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             ->add('loggerLevel', LoggerLevelChoiceType::class, [
                 'log_type' => LoggerLevelChoiceType::TYPE_DEBUG,
             ])
+            ->add(LegacyRefundExtension::CONFIG_KEY, CheckboxType::class, [
+                'label' => 'sylius_mollie.form.legacy_refund',
+                'help' => 'sylius_mollie.form.legacy_refund_help',
+                'required' => false,
+            ])
             ->add('components', CheckboxType::class, [
                 'label' => 'sylius_mollie.ui.enable_components',
                 'attr' => ['class' => 'mollie-components'],

src/Twig/Extension/LegacyRefundExtension.php

@@ -0,0 +1,50 @@
+<?php
+
+/*
+ * This file is part of the Sylius Mollie Plugin package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\MolliePlugin\Twig\Extension;
+
+use Sylius\Component\Core\Model\PaymentInterface;
+use Sylius\MolliePlugin\Entity\GatewayConfigInterface;
+use Sylius\MolliePlugin\Payum\Checker\MollieGatewayFactoryCheckerInterface;
+use Twig\Extension\AbstractExtension;
+use Twig\TwigFunction;
+
+final class LegacyRefundExtension extends AbstractExtension
+{
+    public const CONFIG_KEY = 'legacy_refund';
+
+    public function __construct(private MollieGatewayFactoryCheckerInterface $mollieGatewayFactoryChecker)
+    {
+    }
+
+    /** @return TwigFunction[] */
+    public function getFunctions(): array
+    {
+        return [
+            new TwigFunction('mollie_legacy_refund_enabled', [$this, 'isLegacyRefundEnabled']),
+        ];
+    }
+
+    public function isLegacyRefundEnabled(PaymentInterface $payment): bool
+    {
+        /** @var GatewayConfigInterface|null $gatewayConfig */
+        $gatewayConfig = $payment->getMethod()?->getGatewayConfig();
+        if (null === $gatewayConfig || false === $this->mollieGatewayFactoryChecker->isMollieGateway($gatewayConfig)) {
+            return false;
+        }
+
+        $config = $gatewayConfig->getConfig();
+
+        return isset($config[self::CONFIG_KEY]) && true === $config[self::CONFIG_KEY];
+    }
+}

templates/admin/order/show/content/sections/payments/item/actions/refund.html.twig

@@ -6,7 +6,7 @@
     {% set refund_link = path('sylius_mollie_admin_order_payment_refund', {'orderId': order.id, 'id': payment.id}) %}
 {% endif %}
 
-{% if sylius_sm_can(payment, constant('Sylius\\Component\\Payment\\PaymentTransitions::GRAPH'), constant('Sylius\\Component\\Payment\\PaymentTransitions::TRANSITION_REFUND')) %}
+{% if mollie_legacy_refund_enabled(payment) and sylius_sm_can(payment, constant('Sylius\\Component\\Payment\\PaymentTransitions::GRAPH'), constant('Sylius\\Component\\Payment\\PaymentTransitions::TRANSITION_REFUND')) %}
     <form action="{{ refund_link }}" method="POST" novalidate>
         <input type="hidden" name="_method" value="PUT">
         <input type="hidden" name="_csrf_token" value="{{ csrf_token(payment.id) }}" />

templates/admin/payment_method/form/sections/gateway_configuration/legacy_refund.html.twig

@@ -0,0 +1,8 @@
+{% set form = hookable_metadata.context.form.gatewayConfig.config.legacy_refund %}
+<div class="card mb-3">
+    <div class="card-body mt-3">
+        <div class="row">
+            {{ form_row(form) }}
+        </div>
+    </div>
+</div>

translations/messages.en.yml

@@ -212,6 +212,8 @@ sylius_mollie:
         enable_all: 'Enable all'
         enabled_buy_now_button_help: 'The button is shown on the checkout page'
         expiration_date_time: 'Expiration date time'
+        legacy_refund: 'Enable legacy refund'
+        legacy_refund_help: 'Allows refunding the whole payment bypassing Sylius refund system. Enabling this options is not recommended and will be removed in future versions.'
         methods: 'Choose enabled methods'
         no_category: 'No default category'
         payment_methods: