Provide the State Machine abstraction

composer.json

@@ -134,6 +134,7 @@
         "symfony/twig-bundle": "^5.4.21 || ^6.0",
         "symfony/validator": "^5.4.21 || ^6.0",
         "symfony/webpack-encore-bundle": "^1.15",
+        "symfony/workflow": "^5.4.21 || ^6.0",
         "symfony/yaml": "^5.4.21 || ^6.0",
         "twig/intl-extra": "^2.12 || ^3.4",
         "twig/twig": "^2.12 || ^3.3",

config/packages/workflow.yaml

@@ -0,0 +1,2 @@
+framework:
+    workflows: ~

psalm.xml

@@ -98,6 +98,7 @@
             <errorLevel type="info">
                 <referencedMethod name="PHPUnit\Framework\TestCase::__construct" />
                 <referencedMethod name="Symfony\Bundle\SecurityBundle\Security\_FirewallMap::getFirewallConfig" />
+                <referencedMethod name="Symfony\Component\Workflow\Registry::get" />
                 <referencedMethod name="ApiPlatform\Core\Util\RequestParser::getQueryString" />
                 <referencedMethod name="ApiPlatform\Util\RequestParser::getQueryString" />
                 <referencedMethod name="ApiPlatform\Core\Util\RequestParser::parseRequestParams" />

src/Sylius/Bundle/AdminBundle/test/config/packages/config.yaml

@@ -15,6 +15,7 @@ framework:
     test: ~
     mailer:
         dsn: 'null://null'
+    workflows: ~
 
 security:
     firewalls:

src/Sylius/Bundle/ApiBundle/Tests/Application/config/config.yaml

@@ -39,6 +39,7 @@ framework:
             paths: ['%kernel.project_dir%/config/serialization']
     mailer:
         dsn: 'null://null'
+    workflows: ~
 
 doctrine_migrations:
     storage:

src/Sylius/Bundle/CoreBundle/DependencyInjection/Configuration.php

@@ -98,6 +98,16 @@ public function getConfigTreeBuilder(): TreeBuilder
                         ->end()
                     ->end()
                 ->end()
+                ->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()
+                ->end()
             ->end()
         ;
 

src/Sylius/Bundle/CoreBundle/DependencyInjection/SyliusCoreExtension.php

@@ -72,6 +72,8 @@ public function load(array $configs, ContainerBuilder $container): void
         $container->setParameter('sylius_core.order_by_identifier', $config['order_by_identifier']);
         $container->setParameter('sylius_core.catalog_promotions.batch_size', $config['catalog_promotions']['batch_size']);
         $container->setParameter('sylius_core.price_history.batch_size', $config['price_history']['batch_size']);
+        $container->setParameter('sylius_core.state_machine.default_adapter', $config['state_machine']['default_adapter']);
+        $container->setParameter('sylius_core.state_machine.graphs_to_adapters_mapping', $config['state_machine']['graphs_to_adapters_mapping']);
 
         /** @var string $env */
         $env = $container->getParameter('kernel.environment');

src/Sylius/Bundle/CoreBundle/Resources/config/services.xml

@@ -37,6 +37,7 @@
         <import resource="services/promotion.xml" />
         <import resource="services/providers.xml" />
         <import resource="services/shipping.xml" />
+        <import resource="services/state_machines.xml" />
         <import resource="services/state_resolvers.xml" />
         <import resource="services/taxation.xml" />
         <import resource="services/templating.xml" />

src/Sylius/Bundle/CoreBundle/Resources/config/services/state_machines.xml

@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+
+ This file is part of the Sylius 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.
+
+-->
+
+<container xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://symfony.com/schema/dic/services"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+    <services>
+        <defaults public="true" />
+
+        <service id="sylius.state_machine.composite" class="Sylius\Bundle\CoreBundle\StateMachine\CompositeStateMachine">
+            <argument type="tagged_iterator" tag="sylius.state_machine" index-by="key" />
+            <argument>%sylius_core.state_machine.default_adapter%</argument>
+            <argument>%sylius_core.state_machine.graphs_to_adapters_mapping%</argument>
+        </service>
+        <service id="Sylius\Bundle\CoreBundle\StateMachine\StateMachineInterface $compositeStateMachine" alias="sylius.state_machine.composite" />
+
+        <service id="sylius.state_machine" alias="sylius.state_machine.composite" />
+        <service id="Sylius\Bundle\CoreBundle\StateMachine\StateMachineInterface" alias="sylius.state_machine" />
+
+        <service id="sylius.state_machine.adapter.symfony_workflow" class="Sylius\Bundle\CoreBundle\StateMachine\SymfonyWorkflowAdapter">
+            <argument type="service" id="workflow.registry" />
+
+            <tag name="sylius.state_machine" key="symfony_workflow" />
+        </service>
+        <service id="Sylius\Bundle\CoreBundle\StateMachine\StateMachineInterface $symfonyWorkflow" alias="sylius.state_machine.adapter.symfony_workflow" />
+
+        <service id="sylius.state_machine.adapter.winzou_state_machine" class="Sylius\Bundle\CoreBundle\StateMachine\WinzouStateMachineAdapter">
+            <argument type="service" id="sm.factory" />
+
+            <tag name="sylius.state_machine" key="winzou_state_machine" />
+        </service>
+        <service id="Sylius\Bundle\CoreBundle\StateMachine\StateMachineInterface $winzouStateMachine" alias="sylius.state_machine.adapter.winzou_state_machine" />
+    </services>
+</container>

src/Sylius/Bundle/CoreBundle/StateMachine/CompositeStateMachine.php

@@ -0,0 +1,74 @@
+<?php
+
+/*
+ * This file is part of the Sylius 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\Bundle\CoreBundle\StateMachine;
+
+use Traversable;
+use Webmozart\Assert\Assert;
+
+class CompositeStateMachine implements StateMachineInterface
+{
+    /** @var array<StateMachineInterface> */
+    private array $stateMachineAdapters;
+
+    /**
+     * @param iterable<StateMachineInterface> $stateMachineAdapters
+     * @param array<string, string> $graphsToAdaptersMapping
+     */
+    public function __construct(
+        iterable $stateMachineAdapters,
+        private string $defaultAdapter,
+        private array $graphsToAdaptersMapping,
+    ) {
+        Assert::notEmpty($stateMachineAdapters, 'At least one state machine adapter should be provided.');
+        Assert::allIsInstanceOf(
+            $stateMachineAdapters,
+            StateMachineInterface::class,
+            sprintf('All state machine adapters should implement the "%s" interface.', StateMachineInterface::class),
+        );
+        $this->stateMachineAdapters = $stateMachineAdapters instanceof Traversable ? iterator_to_array($stateMachineAdapters) : $stateMachineAdapters;
+    }
+
+    /**
+     * @throws \Exception
+     */
+    public function can(object $subject, string $graphName, string $transition): bool
+    {
+        return $this->getStateMachineAdapter($graphName)->can($subject, $graphName, $transition);
+    }
+
+    /**
+     * @throws \Exception
+     */
+    public function apply(object $subject, string $graphName, string $transition, array $context = []): void
+    {
+        $this->getStateMachineAdapter($graphName)->apply($subject, $graphName, $transition, $context);
+    }
+
+    /**
+     * @throws \Exception
+     */
+    public function getEnabledTransitions(object $subject, string $graphName): array
+    {
+        return $this->getStateMachineAdapter($graphName)->getEnabledTransitions($subject, $graphName);
+    }
+
+    private function getStateMachineAdapter(string $graphName): StateMachineInterface
+    {
+        if (isset($this->graphsToAdaptersMapping[$graphName])) {
+            return $this->stateMachineAdapters[$this->graphsToAdaptersMapping[$graphName]];
+        }
+
+        return $this->stateMachineAdapters[$this->defaultAdapter];
+    }
+}

src/Sylius/Bundle/CoreBundle/StateMachine/Exception/StateMachineExecutionException.php

@@ -0,0 +1,18 @@
+<?php
+
+/*
+ * This file is part of the Sylius 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\Bundle\CoreBundle\StateMachine\Exception;
+
+class StateMachineExecutionException extends \Exception
+{
+}

src/Sylius/Bundle/CoreBundle/StateMachine/StateMachineInterface.php

@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the Sylius 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\Bundle\CoreBundle\StateMachine;
+
+use Sylius\Bundle\CoreBundle\StateMachine\Exception\StateMachineExecutionException;
+
+interface StateMachineInterface
+{
+    /**
+     * @throws StateMachineExecutionException
+     */
+    public function can(object $subject, string $graphName, string $transition): bool;
+
+    /**
+     * @param array<string, mixed> $context
+     *
+     * @throws StateMachineExecutionException
+     */
+    public function apply(object $subject, string $graphName, string $transition, array $context = []): void;
+
+    /**
+     * @throws StateMachineExecutionException
+     *
+     * @return array<TransitionInterface>
+     */
+    public function getEnabledTransitions(object $subject, string $graphName): array;
+}

src/Sylius/Bundle/CoreBundle/StateMachine/SymfonyWorkflowAdapter.php

@@ -0,0 +1,64 @@
+<?php
+
+/*
+ * This file is part of the Sylius 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\Bundle\CoreBundle\StateMachine;
+
+use Sylius\Bundle\CoreBundle\StateMachine\Exception\StateMachineExecutionException;
+use Symfony\Component\Workflow\Exception\InvalidArgumentException;
+use Symfony\Component\Workflow\Registry;
+use Symfony\Component\Workflow\Transition as SymfonyWorkflowTransition;
+
+final class SymfonyWorkflowAdapter implements StateMachineInterface
+{
+    public function __construct(private Registry $symfonyWorkflowRegistry)
+    {
+    }
+
+    public function can(object $subject, string $graphName, string $transition): bool
+    {
+        try {
+            return $this->symfonyWorkflowRegistry->get($subject, $graphName)->can($subject, $transition);
+        } catch (InvalidArgumentException $exception) {
+            throw new StateMachineExecutionException($exception->getMessage(), $exception->getCode(), $exception);
+        }
+    }
+
+    public function apply(object $subject, string $graphName, string $transition, array $context = []): void
+    {
+        try {
+            $this->symfonyWorkflowRegistry->get($subject, $graphName)->apply($subject, $transition, $context);
+        } catch (InvalidArgumentException $exception) {
+            throw new StateMachineExecutionException($exception->getMessage(), $exception->getCode(), $exception);
+        }
+    }
+
+    public function getEnabledTransitions(object $subject, string $graphName): array
+    {
+        try {
+            $enabledTransitions = $this->symfonyWorkflowRegistry->get($subject, $graphName)->getEnabledTransitions($subject);
+        } catch (InvalidArgumentException $exception) {
+            throw new StateMachineExecutionException($exception->getMessage(), $exception->getCode(), $exception);
+        }
+
+        return array_map(
+            function (SymfonyWorkflowTransition $transition): TransitionInterface {
+                return new Transition(
+                    $transition->getName(),
+                    $transition->getFroms(),
+                    $transition->getTos(),
+                );
+            },
+            $enabledTransitions,
+        );
+    }
+}

src/Sylius/Bundle/CoreBundle/StateMachine/Transition.php

@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the Sylius 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\Bundle\CoreBundle\StateMachine;
+
+final class Transition implements TransitionInterface
+{
+    /**
+     * @param array<string>|null $froms
+     * @param array<string>|null $tos
+     */
+    public function __construct(
+        private string $name,
+        private ?array $froms,
+        private ?array $tos,
+    ) {
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    public function getFroms(): ?array
+    {
+        return $this->froms;
+    }
+
+    public function getTos(): ?array
+    {
+        return $this->tos;
+    }
+}

src/Sylius/Bundle/CoreBundle/StateMachine/TransitionInterface.php

@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the Sylius 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\Bundle\CoreBundle\StateMachine;
+
+interface TransitionInterface
+{
+    public function getName(): string;
+
+    /**
+     * @return array<string>|null
+     */
+    public function getFroms(): ?array;
+
+    /**
+     * @return array<string>|null
+     */
+    public function getTos(): ?array;
+}