Use the new State Machine abstraction

.github/workflows/ci_e2e-mariadb.yaml

@@ -44,7 +44,7 @@ jobs:
     behat-no-js:
         needs: get-matrix
         runs-on: ubuntu-latest
-        name: "Non-JS, PHP ${{ matrix.php }}, Symfony ${{ matrix.symfony }}, MariaDB ${{ matrix.mariadb }}"
+        name: "Non-JS, PHP ${{ matrix.php }}, Symfony ${{ matrix.symfony }}, MariaDB ${{ matrix.mariadb }}, State Machine Adapter ${{ matrix.state_machine_adapter }}"
         timeout-minutes: 45
         strategy:
             fail-fast: false
@@ -53,6 +53,7 @@ jobs:
         env:
             APP_ENV: test_cached
             DATABASE_URL: "mysql://root:root@127.0.0.1/sylius?charset=utf8mb4&serverVersion=mariadb-${{ matrix.mariadb }}"
+            TEST_SYLIUS_STATE_MACHINE_ADAPTER: "${{ matrix.state_machine_adapter }}"
 
         steps:
             -   name: Set variables

.github/workflows/matrix.json

@@ -19,13 +19,15 @@
         {
           "php": "8.0",
           "symfony": "^5.4",
-          "mariadb": "10.4.10"
+          "mariadb": "10.4.10",
+          "state_machine_adapter": "winzou_state_machine"
         },
         {
           "php": "8.2",
           "symfony": "^6.4",
           "mariadb": "10.4.10",
-          "dbal": "^3.0"
+          "dbal": "^3.0",
+          "state_machine_adapter": "symfony_workflow"
         }
       ]
     },
@@ -98,6 +100,7 @@
       "php": [ "8.0", "8.1", "8.2" ],
       "symfony": [ "^5.4", "^6.4" ],
       "mariadb": [ "10.4.10" ],
+      "state_machine_adapter": [ "winzou_state_machine", "symfony_workflow" ],
       "exclude": [
         {
           "php": "8.0",

UPGRADE-1.13.md

@@ -1,5 +1,27 @@
 # UPGRADE FROM `v1.12.X` TO `v1.13.0`
 
+1. Starting with Sylius `1.13` we provided a possibility to use the Symfony Workflow as your State Machine. To allow a smooth transition
+    we created a new package called `sylius/state-machine-abstraction`,
+   which provides a configurable abstraction,
+   allowing you to define which adapter should be used (Winzou State Machine or Symfony Workflow) per graph.
+   Starting with Sylius `1.13` we configure all existing Sylius' graphs to use the Symfony Workflow.
+   At the same time, all other graphs are using Winzou State Machine as a default state machine,
+   and must be configured manually to use the Symfony Workflow.
+
+    Configuration:
+    ```yaml
+    sylius_state_machine_abstraction:
+        graphs_to_adapters_mapping:
+            <graph_name>: <adapter_name>
+            # e.g.
+            sylius_order_checkout: symfony_workflow # available adapters: symfony_workflow, winzou_state_machine
+
+        # we can also can the default adapter
+        default_adapter: symfony_workflow # winzou_state_machine is a default value here
+    ```
+
+    > **Note!** Starting with Sylius `2.0` the Symfony Workflow will be the default state machine for all graphs.
+
 1. A new parameter has been added to specify the validation groups for given gateway factory.
    If you have any custom validation groups for your factory, you need to add them to your `config/packages/_sylius.yaml` file.
    Also, if you have your own gateway factory and want to add your validation groups you can add another entry to the `validation_groups` configuration node.
@@ -19,7 +41,7 @@
                     - 'your_custom_validation_group'
     ```
 
-1. New parameters have been added to specify the validation groups for given shipping method rules and calculators.
+1. There have been a naw parameters added to specify the validation groups for given shipping method rule and calculator.
    If you have any custom validation groups for your calculator or rules, you need to add them to your `config/packages/_sylius.yaml` file.
    Also, if you have your own shipping method rule or calculator and want to add your validation groups you can add another key to the `validation_groups` parameter.
 
@@ -58,7 +80,7 @@
 1. Class `Sylius\Bundle\ProductBundle\Form\Type\ProductOptionChoiceType` has been deprecated.
    Use `Sylius\Bundle\ProductBundle\Form\Type\ProductOptionAutocompleteType` instead.
 
-1. Using `parentId` query parameter to generate the slug in `Sylius\Bundle\TaxonomyBundle\Controller\TaxonSlugController` has been deprecated.
+1. Using `parentId` query parameter to generate slug in `Sylius\Bundle\TaxonomyBundle\Controller\TaxonSlugController` has been deprecated.
    Use the `parentCode` query parameter instead.
 
 1. Starting with Sylius 1.13, the `SyliusPriceHistoryPlugin` is included.
@@ -75,10 +97,6 @@
 
 1. The name of the second argument of `Sylius\Bundle\AdminBundle\Action\ResendOrderConfirmationEmailAction` is deprecated and will be renamed to `$resendOrderConfirmationEmailDispatcher`.
 
-1. Passing `Sylius\Bundle\AdminBundle\EmailManager\ShipmentEmailManagerInterface` to `Sylius\Bundle\AdminBundle\Action\ResendShipmentConfirmationEmailAction` as a second argument is deprecated, use `Sylius\Bundle\CoreBundle\MessageDispatcher\ResendShipmentConfirmationEmailDispatcherInterface` instead.
-
-1. The name of the second argument of `Sylius\Bundle\AdminBundle\Action\ResendShipmentConfirmationEmailAction` is deprecated and will be renamed to `$resendShipmentConfirmationEmailDispatcher`.
-
 1. Not passing `Sylius\Bundle\CoreBundle\CatalogPromotion\Announcer\CatalogPromotionRemovalAnnouncerInterface` to `Sylius\Bundle\CoreBundle\CatalogPromotion\Processor\CatalogPromotionRemovalProcessor`
    as a second argument is deprecated.
 

config/packages/test/_sylius.yaml

@@ -1,5 +1,20 @@
+parameters:
+    test_default_state_machine_adapter: 'symfony_workflow'
+    test_sylius_state_machine_adapter: '%env(string:default:test_default_state_machine_adapter:TEST_SYLIUS_STATE_MACHINE_ADAPTER)%'
+
 sylius_user:
     encoder: plaintext
 
 sylius_api:
     enabled: true
+
+sylius_state_machine_abstraction:
+    graphs_to_adapters_mapping:
+        sylius_catalog_promotion: '%test_sylius_state_machine_adapter%'
+        sylius_order: '%test_sylius_state_machine_adapter%'
+        sylius_order_checkout: '%test_sylius_state_machine_adapter%'
+        sylius_order_payment: '%test_sylius_state_machine_adapter%'
+        sylius_order_shipping: '%test_sylius_state_machine_adapter%'
+        sylius_payment: '%test_sylius_state_machine_adapter%'
+        sylius_product_review: '%test_sylius_state_machine_adapter%'
+        sylius_shipment: '%test_sylius_state_machine_adapter%'

src/Sylius/Abstraction/StateMachine/config/services.xml

@@ -26,14 +26,12 @@
 
         <service id="sylius_abstraction.state_machine.adapter.symfony_workflow" class="Sylius\Abstraction\StateMachine\SymfonyWorkflowAdapter">
             <argument type="service" id="workflow.registry" />
-
             <tag name="sylius.state_machine" key="symfony_workflow" />
         </service>
         <service id="Sylius\Abstraction\StateMachine\StateMachineInterface $symfonyWorkflow" alias="sylius_abstraction.state_machine.adapter.symfony_workflow" />
 
         <service id="sylius_abstraction.state_machine.adapter.winzou_state_machine" class="Sylius\Abstraction\StateMachine\WinzouStateMachineAdapter">
             <argument type="service" id="sm.factory" />
-
             <tag name="sylius.state_machine" key="winzou_state_machine" />
         </service>
         <service id="Sylius\Abstraction\StateMachine\StateMachineInterface $winzouStateMachine" alias="sylius_abstraction.state_machine.adapter.winzou_state_machine" />

src/Sylius/Abstraction/StateMachine/src/CompositeStateMachine.php

@@ -63,6 +63,16 @@ public function getEnabledTransitions(object $subject, string $graphName): array
         return $this->getStateMachineAdapter($graphName)->getEnabledTransitions($subject, $graphName);
     }
 
+    public function getTransitionFromState(object $subject, string $graphName, string $fromState): ?string
+    {
+        return $this->getStateMachineAdapter($graphName)->getTransitionFromState($subject, $graphName, $fromState);
+    }
+
+    public function getTransitionToState(object $subject, string $graphName, string $toState): ?string
+    {
+        return $this->getStateMachineAdapter($graphName)->getTransitionToState($subject, $graphName, $toState);
+    }
+
     private function getStateMachineAdapter(string $graphName): StateMachineInterface
     {
         if (isset($this->graphsToAdaptersMapping[$graphName])) {

src/Sylius/Abstraction/StateMachine/src/DependencyInjection/Configuration.php

@@ -21,22 +21,17 @@ final class Configuration implements ConfigurationInterface
 {
     public function getConfigTreeBuilder(): TreeBuilder
     {
-        $treeBuilder = new TreeBuilder('sylius_abstraction');
+        $treeBuilder = new TreeBuilder('sylius_state_machine_abstraction');
         /** @var ArrayNodeDefinition $rootNode */
         $rootNode = $treeBuilder->getRootNode();
 
         $rootNode
             ->addDefaultsIfNotSet()
             ->children()
-                ->arrayNode('state_machine')
-                    ->addDefaultsIfNotSet()
-                    ->children()
-                        ->scalarNode('default_adapter')->defaultValue('winzou_state_machine')->end()
-                        ->arrayNode('graphs_to_adapters_mapping')
-                            ->useAttributeAsKey('graph_name')
-                            ->scalarPrototype()->end()
-                        ->end()
-                    ->end()
+                ->scalarNode('default_adapter')->defaultValue('winzou_state_machine')->end()
+                ->arrayNode('graphs_to_adapters_mapping')
+                    ->useAttributeAsKey('graph_name')
+                    ->scalarPrototype()->end()
                 ->end()
             ->end()
         ;

src/Sylius/Abstraction/StateMachine/src/DependencyInjection/SyliusStateMachineAbstractionExtension.php

@@ -27,7 +27,7 @@ public function load(array $configs, ContainerBuilder $container): void
         $loader = new XmlFileLoader($container, new FileLocator(dirname(__DIR__, 2) . '/config/'));
         $loader->load('services.xml');
 
-        $container->setParameter('sylius_abstraction.state_machine.default_adapter', $config['state_machine']['default_adapter']);
-        $container->setParameter('sylius_abstraction.state_machine.graphs_to_adapters_mapping', $config['state_machine']['graphs_to_adapters_mapping']);
+        $container->setParameter('sylius_abstraction.state_machine.default_adapter', $config['default_adapter']);
+        $container->setParameter('sylius_abstraction.state_machine.graphs_to_adapters_mapping', $config['graphs_to_adapters_mapping']);
     }
 }

src/Sylius/Abstraction/StateMachine/src/Exception/StateMachineExecutionException.php

@@ -13,6 +13,6 @@
 
 namespace Sylius\Abstraction\StateMachine\Exception;
 
-class StateMachineExecutionException extends \Exception
+class StateMachineExecutionException extends \RuntimeException
 {
 }

src/Sylius/Abstraction/StateMachine/src/StateMachineInterface.php

@@ -35,4 +35,14 @@ public function apply(object $subject, string $graphName, string $transition, ar
      * @return array<TransitionInterface>
      */
     public function getEnabledTransitions(object $subject, string $graphName): array;
+
+    /**
+     * @throws StateMachineExecutionException
+     */
+    public function getTransitionFromState(object $subject, string $graphName, string $fromState): ?string;
+
+    /**
+     * @throws StateMachineExecutionException
+     */
+    public function getTransitionToState(object $subject, string $graphName, string $toState): ?string;
 }

src/Sylius/Abstraction/StateMachine/src/SymfonyWorkflowAdapter.php

@@ -61,4 +61,26 @@ function (SymfonyWorkflowTransition $transition): TransitionInterface {
             $enabledTransitions,
         );
     }
+
+    public function getTransitionFromState(object $subject, string $graphName, string $fromState): ?string
+    {
+        foreach ($this->getEnabledTransitions($subject, $graphName) as $transition) {
+            if ($transition->getFroms() !== null && in_array($fromState, $transition->getFroms(), true)) {
+                return $transition->getName();
+            }
+        }
+
+        return null;
+    }
+
+    public function getTransitionToState(object $subject, string $graphName, string $toState): ?string
+    {
+        foreach ($this->getEnabledTransitions($subject, $graphName) as $transition) {
+            if ($transition->getTos() !== null && in_array($toState, $transition->getTos(), true)) {
+                return $transition->getName();
+            }
+        }
+
+        return null;
+    }
 }

src/Sylius/Abstraction/StateMachine/src/WinzouStateMachineAdapter.php

@@ -42,21 +42,79 @@ public function apply(object $subject, string $graphName, string $transition, ar
     }
 
     public function getEnabledTransitions(object $subject, string $graphName): array
+    {
+        $stateMachine = $this->getStateMachine($subject, $graphName);
+
+        return array_filter(
+            $this->getAllTransitions($stateMachine),
+            fn (TransitionInterface $transition) => $this->can($subject, $graphName, $transition->getName()),
+        );
+    }
+
+    /**
+     * @return array<TransitionInterface>
+     */
+    private function getAllTransitions(\SM\StateMachine\StateMachineInterface $stateMachine): array
     {
         try {
-            $transitions = $this->getStateMachine($subject, $graphName)->getPossibleTransitions();
-        } catch (SMException $exception) {
+            $transitionsConfig = $this->getConfig($stateMachine)['transitions'];
+        } catch (\ReflectionException $exception) {
             throw new StateMachineExecutionException($exception->getMessage(), $exception->getCode(), $exception);
         }
 
-        return array_map(
-            fn (string $transition) => new Transition($transition, null, null),
-            $transitions,
-        );
+        $transitions = [];
+
+        foreach ($transitionsConfig as $transitionName => $transitionConfig) {
+            $froms = $transitionConfig['from'];
+            $tos = array($transitionConfig['to']);
+            $transitions[] = new Transition($transitionName, $froms, $tos);
+        }
+
+        return $transitions;
+    }
+
+    /**
+     * @throws \ReflectionException
+     *
+     * @return array{transitions: array<string, array{from: array<string>, to: string}>}
+     */
+    private function getConfig(\SM\StateMachine\StateMachineInterface $stateMachine): array
+    {
+        $reflection = new \ReflectionClass($stateMachine);
+        $configProperty = $reflection->getProperty('config');
+        $configProperty->setAccessible(true);
+
+        return  $configProperty->getValue($stateMachine);
+    }
+
+    public function getTransitionFromState(object $subject, string $graphName, string $fromState): ?string
+    {
+        foreach ($this->getEnabledTransitions($subject, $graphName) as $transition) {
+            if ($transition->getFroms() !== null && in_array($fromState, $transition->getFroms(), true)) {
+                return $transition->getName();
+            }
+        }
+
+        return null;
+    }
+
+    public function getTransitionToState(object $subject, string $graphName, string $toState): ?string
+    {
+        foreach ($this->getEnabledTransitions($subject, $graphName) as $transition) {
+            if ($transition->getTos() !== null && in_array($toState, $transition->getTos(), true)) {
+                return $transition->getName();
+            }
+        }
+
+        return null;
     }
 
     private function getStateMachine(object $subject, string $graphName): \SM\StateMachine\StateMachineInterface
     {
-        return $this->winzouStateMachineFactory->get($subject, $graphName);
+        try {
+            return $this->winzouStateMachineFactory->get($subject, $graphName);
+        } catch (SMException $exception) {
+            throw new StateMachineExecutionException($exception->getMessage(), $exception->getCode(), $exception);
+        }
     }
 }

src/Sylius/Abstraction/StateMachine/tests/Functional/DependencyInjection/ConfigurationTest.php

@@ -28,18 +28,13 @@ public function it_allows_to_configure_a_default_state_machine_adapter(): void
         $this->assertProcessedConfigurationEquals(
             [
                 [
-                    'state_machine' => [
-                        'default_adapter' => 'symfony_workflow',
-                    ],
+                    'default_adapter' => 'symfony_workflow',
                 ],
             ],
             [
-                'state_machine' => [
-                    'default_adapter' => 'symfony_workflow',
-                    'graphs_to_adapters_mapping' => [],
-                ],
+                'default_adapter' => 'symfony_workflow',
+                'graphs_to_adapters_mapping' => [],
             ],
-            'state_machine',
         );
     }
 
@@ -49,24 +44,19 @@ public function it_allows_to_configure_the_state_machines_adapters_mapping(): vo
         $this->assertProcessedConfigurationEquals(
             [
                 [
-                    'state_machine' => [
-                        'graphs_to_adapters_mapping' => [
-                            'order' => 'symfony_workflow',
-                            'payment' => 'winzou_state_machine',
-                        ],
-                    ],
-                ],
-            ],
-            [
-                'state_machine' => [
-                    'default_adapter' => 'winzou_state_machine',
                     'graphs_to_adapters_mapping' => [
                         'order' => 'symfony_workflow',
                         'payment' => 'winzou_state_machine',
                     ],
                 ],
             ],
-            'state_machine',
+            [
+                'default_adapter' => 'winzou_state_machine',
+                'graphs_to_adapters_mapping' => [
+                    'order' => 'symfony_workflow',
+                    'payment' => 'winzou_state_machine',
+                ],
+            ],
         );
     }