Add a support for Symfony Workflow while a refunding process

.github/workflows/_matrix.json

@@ -6,21 +6,30 @@
           "php": "8.0",
           "sylius": "1.12.*",
           "symfony": "5.4.*",
-          "mysql": "8.0"
+          "mysql": "8.0",
+          "state_machine": "winzou_state_machine"
         },
         {
           "php": "8.3",
           "sylius": "1.13.*",
           "symfony": "6.4.*",
-          "mysql": "8.0"
+          "mysql": "8.0",
+          "state_machine": "symfony_workflow"
         }
       ]
     },
     "daily": {
       "php": ["8.0", "8.3"],
       "sylius": ["1.12.*", "1.13.*"],
       "symfony": ["5.4.*", "6.4.*"],
-      "mysql": ["8.0"]
+      "mysql": ["8.0"],
+      "state_machine": ["winzou_state_machine", "symfony_workflow"],
+      "exclude": [
+        {
+          "sylius": "1.12.*",
+          "state_machine": "symfony_workflow"
+        }
+      ]
     }
   }
 }

.github/workflows/ci.yaml

@@ -32,7 +32,7 @@ jobs:
 
         runs-on: ubuntu-latest
 
-        name: "Sylius ${{ matrix.sylius }}, PHP ${{ matrix.php }}, Symfony ${{ matrix.symfony }}, MySQL ${{ matrix.mysql }}"
+        name: "Sylius ${{ matrix.sylius }}, PHP ${{ matrix.php }}, Symfony ${{ matrix.symfony }}, MySQL ${{ matrix.mysql }}, State Machine ${{ matrix.state_machine }}"
 
         strategy:
             fail-fast: false
@@ -41,6 +41,7 @@ jobs:
         env:
             APP_ENV: test
             DATABASE_URL: "mysql://root:[email protected]/sylius?serverVersion=${{ matrix.mysql }}"
+            STATE_MACHINE_DEFAULT_ADAPTER: ${{ matrix.state_machine }}
 
         steps:
             -

config/services/refunding.php

@@ -6,6 +6,8 @@
 
 use CommerceWeavers\SyliusTpayPlugin\Refunding\Dispatcher\RefundDispatcher;
 use CommerceWeavers\SyliusTpayPlugin\Refunding\Dispatcher\RefundDispatcherInterface;
+use CommerceWeavers\SyliusTpayPlugin\Refunding\Workflow\Listener\DispatchRefundListener;
+use Sylius\Bundle\CoreBundle\SyliusCoreBundle;
 
 return function(ContainerConfigurator $container): void {
     $services = $container->services();
@@ -15,6 +17,15 @@
         ->args([
             service('payum'),
         ])
-        ->alias(RefundDispatcherInterface::class, 'commerce_weavers.tpay.refunding.dispatcher.refund');
+        ->alias(RefundDispatcherInterface::class, 'commerce_weavers.tpay.refunding.dispatcher.refund')
     ;
+
+    if (SyliusCoreBundle::VERSION_ID >= 11300) {
+        $services->set('commerce_weavers.tpay.refunding.workflow.listener.dispatch_refund', DispatchRefundListener::class)
+            ->args([
+                service('commerce_weavers.tpay.refunding.dispatcher.refund'),
+            ])
+            ->tag('kernel.event_listener', ['event' => 'workflow.sylius_payment.transition.refund'])
+        ;
+    }
 };

phpstan.neon

@@ -13,3 +13,5 @@ parameters:
     ignoreErrors:
         - '/Parameter #1 \$configuration of method Symfony\\Component\\DependencyInjection\\Extension\\Extension::processConfiguration\(\) expects Symfony\\Component\\Config\\Definition\\ConfigurationInterface, Symfony\\Component\\Config\\Definition\\ConfigurationInterface\|null given\./'
         - '/Parameter \#1 \$request \([^)]+\) of method [^:]+::execute\(\) should be contravariant with parameter \$request \(mixed\) of method Payum\\Core\\Action\\ActionInterface::execute\(\)/'
+        - '/Parameter \$event of method CommerceWeavers\\SyliusTpayPlugin\\Refunding\\Workflow\\Listener\\DispatchRefundListener::__invoke\(\) has invalid type Symfony\\Component\\Workflow\\Event\\TransitionEvent\./'
+        - '/Call to method getSubject\(\) on an unknown class Symfony\\Component\\Workflow\\Event\\TransitionEvent\./'

src/Refunding/Workflow/Listener/DispatchRefundListener.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CommerceWeavers\SyliusTpayPlugin\Refunding\Workflow\Listener;
+
+use CommerceWeavers\SyliusTpayPlugin\Refunding\Dispatcher\RefundDispatcherInterface;
+use Sylius\Component\Core\Model\PaymentInterface;
+use Symfony\Component\Workflow\Event\TransitionEvent;
+
+final class DispatchRefundListener
+{
+    public function __construct(
+        private RefundDispatcherInterface $refundDispatcher,
+    ) {
+    }
+
+    public function __invoke(TransitionEvent $event): void
+    {
+        $payment = $event->getSubject();
+
+        if (!$payment instanceof PaymentInterface) {
+            throw new \UnexpectedValueException(
+                sprintf('Expected instance of "%s", got "%s"', PaymentInterface::class, get_class($payment)),
+            );
+        }
+
+        $this->refundDispatcher->dispatch($payment);
+    }
+}

tests/Application/config/packages/_sylius.yaml

@@ -8,6 +8,7 @@ imports:
     - { resource: "@SyliusApiBundle/Resources/config/app/config.yaml" }
 
 parameters:
+    env(STATE_MACHINE_DEFAULT_ADAPTER): 'winzou_state_machine'
     sylius_core.public_dir: '%kernel.project_dir%/public'
 
 sylius_shop:

tests/Application/config/packages/sylius_state_machine_abstraction.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\Loader\Configurator;
+
+use Sylius\Bundle\CoreBundle\SyliusCoreBundle;
+
+if (SyliusCoreBundle::VERSION_ID < 11300) {
+    return;
+}
+
+return function(ContainerConfigurator $container): void {
+    $container->extension('sylius_state_machine_abstraction', [
+        'default_adapter' => '%env(STATE_MACHINE_DEFAULT_ADAPTER)%',
+    ]);
+};