[Workflow] Introduce a Workflow interface #24751

Simperfit · 2017-10-30T06:27:34Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	yes
Tests pass?	yes
Fixed tickets	#23910
License	MIT
Doc PR	todo

@chalasr I think all the points you made in 23910 has been done. Needs to update the docs too.

nicolas-grekas · 2017-10-30T18:34:09Z

Note that changing a public interface is a BC break, so this cannot be merged as is, isn't it?

chalasr · 2017-10-30T20:51:37Z

@nicolas-grekas the upgrade note is misleading, this replaces the whole interface.

Simperfit · 2017-10-30T20:52:34Z

I guess i have to update the upgrade node

lyrixx

Some minor comments, but it's good.
Thanks.

lyrixx · 2017-11-02T16:19:03Z

UPGRADE-4.0.md

-
+ * Deprecated the `add` method in favor of the `addWorkflow` method in `Workflow\Registry`
+ * Deprecated the interface `SupportStrategyInterface` in favor of the interface `SupportStrategryWorkflowInterface`
+


Looks like there is a space here

lyrixx · 2017-11-02T16:19:56Z

src/Symfony/Component/Workflow/CHANGELOG.md

@@ -5,6 +5,9 @@ CHANGELOG
 -----

 * Removed class name support in `WorkflowRegistry::add()` as second parameter.
+ * Deprecate the usage of `add(Workflow $workflow, $supportStrategy) in `Workflow/Registry` use `addWorkflow(WorkflowInterface, $supportStrategy)` instead  


missing backquote at the end of add(Workflow $workflow, $supportStrategy)

lyrixx · 2017-11-02T16:20:49Z

src/Symfony/Component/Workflow/Registry.php

@@ -28,8 +29,17 @@ class Registry
     */
    public function add(Workflow $workflow, $supportStrategy)
    {
-        if (!$supportStrategy instanceof SupportStrategyInterface) {
-            throw new \InvalidArgumentException('The "supportStrategy" is not an instance of SupportStrategyInterface.');
+        @trigger_error('add is deprecated since Symfony 4.0. Use addWorkflow instead', E_USER_DEPRECATED);


'add' method is ... use 'addWorkflow' insteand.
(don't miss the final dot)

lyrixx · 2017-11-02T16:21:22Z

src/Symfony/Component/Workflow/Registry.php

+    public function addWorkflow(WorkflowInterface $workflow, $supportStrategy)
+    {
+        if ($supportStrategy instanceof SupportStrategyInterface) {
+            @trigger_error('Passing a SupportStrategyInterface in Registry::addWorkflow is deprecated since 4.0. Use SupportStrategyWorkflowInterface instead', E_USER_DEPRECATED);


use quote to surround class name and add a final dot.

lyrixx · 2017-11-02T16:22:10Z

src/Symfony/Component/Workflow/Registry.php

+        if ($supportStrategy instanceof SupportStrategyInterface) {
+            @trigger_error('Passing a SupportStrategyInterface in Registry::addWorkflow is deprecated since 4.0. Use SupportStrategyWorkflowInterface instead', E_USER_DEPRECATED);
+        }
+        if (!($supportStrategy instanceof SupportStrategyWorkflowInterface || $supportStrategy instanceof SupportStrategyInterface)) {


this if could be transformed in an elseif (!$supportStrategy instanceof SupportStrategyWorkflowInterface)

lyrixx · 2017-11-02T16:22:57Z

src/Symfony/Component/Workflow/SupportStrategy/SupportStrategyInterface.php

@@ -11,6 +11,8 @@

 namespace Symfony\Component\Workflow\SupportStrategy;

+@trigger_error('SupportStrategyInterface is deprecated since Symfony 4.0. Use SupportStrategyWorkflowInterface instead', E_USER_DEPRECATED);


please add a final dot

lyrixx · 2017-11-02T16:33:00Z

src/Symfony/Component/Workflow/WorkflowInterface.php

+     *
+     * @return bool true if the transition is enabled
+     */
+    public function can($subject, $transitionName);


Hm, if getMarking can throw an exception, then can and apply may throw an exception too

Simperfit · 2017-11-02T19:42:12Z

@lyrixx Thanks for the review :)

xabbuh · 2017-11-02T19:58:34Z

UPGRADE-4.0.md

@@ -913,7 +913,9 @@ Workflow
 --------

 * Removed class name support in `WorkflowRegistry::add()` as second parameter.
-
+ * Deprecated the `add` method in favor of the `addWorkflow` method in `Workflow\Registry`
+ * Deprecated the interface `SupportStrategyInterface` in favor of the interface `SupportStrategryWorkflowInterface`


typo here (strategry)

lyrixx · 2017-11-03T09:42:01Z

UPGRADE-4.0.md

-
+ * Deprecated the `add` method in favor of the `addWorkflow` method in `Workflow\Registry`
+ * Deprecated the interface `SupportStrategyInterface` in favor of the interface `SupportStrategyWorkflowInterface`
+


And now there are two spaces here. You need to configure your editor to remove automatically all trailing spaces :D

Yeah, you are right, I didn't configure it to do so !

lyrixx · 2017-11-03T09:44:57Z

src/Symfony/Component/Workflow/Registry.php

+    {
+        if ($supportStrategy instanceof SupportStrategyInterface) {
+            @trigger_error('Passing a "SupportStrategyInterface" in "Registry::addWorkflow" is deprecated since 4.0. Use "SupportStrategyWorkflowInterface" instead.', E_USER_DEPRECATED);
+        } elseif (!($supportStrategy instanceof SupportStrategyWorkflowInterface || $supportStrategy instanceof SupportStrategyInterface)) {


It looks like you did not simplified the condition.

Yeah, sorry, that's modified.

chalasr · 2017-11-03T10:06:16Z

src/Symfony/Component/Workflow/Registry.php

+    public function addWorkflow(WorkflowInterface $workflow, $supportStrategy)
+    {
+        if ($supportStrategy instanceof SupportStrategyInterface) {
+            @trigger_error('Passing a "SupportStrategyInterface" in "Registry::addWorkflow" is deprecated since 4.0. Use "SupportStrategyWorkflowInterface" instead.', E_USER_DEPRECATED);


strings should be replaced SupportsStrategyInterface::class, __METHOD and SupportStrategyWorkflowInterface::class in this order, we always use FQCNs

same for the exception below

chalasr · 2017-11-03T10:10:03Z

src/Symfony/Component/Workflow/SupportStrategy/ClassInstanceSupportStrategy.php


 /**
 * @author Andreas Kleemann <[email protected]>
 */
-final class ClassInstanceSupportStrategy implements SupportStrategyInterface
+final class ClassInstanceSupportStrategy implements SupportStrategyWorkflowInterface


Not implementing the old interface is a BC break ($strategy instanceof SupportsStrategyInterface returning false). Personally I wouldn't care, this could be internal

I think this is internal too.

Internal should be hinted by an annotation, we can't have a policy of telling "that's internal" and break BC.
I suggest to open a PR against 3.4 to really mark them internal so that we're free to change in 4.1.

Ill open that PR.

ro0NL · 2017-11-10T09:02:21Z

src/Symfony/Component/Workflow/SupportStrategy/InstanceOfSupportStrategy.php

+    }
+
+    /**
+     * @return string


aren't we trying to get rid of these kind docblocks?

👍 useless

ro0NL · 2017-11-10T09:06:47Z

src/Symfony/Component/Workflow/Tests/SupportStrategy/ClassInstanceSupportStrategyTest.php

@@ -6,20 +6,26 @@
 use Symfony\Component\Workflow\SupportStrategy\ClassInstanceSupportStrategy;
 use Symfony\Component\Workflow\Workflow;

+/**
+ * @group legacy


this file basically only needs this change.. what about SubjectA + SubjectB for the new test?

still.. no real reason to optimize/tweak a legacy test (::class notation, class removals). Doesnt hurt; just extra diff :)

indeed, adding the ::class notation was ok because the line was actually changed. Now it just gives merge conflicts, should be reverted

ro0NL · 2017-11-10T09:09:15Z

src/Symfony/Component/Workflow/Registry.php

-     * @param Workflow                 $workflow
-     * @param SupportStrategyInterface $supportStrategy
+     * @param Workflow                         $workflow
+     * @param WorkflowSupportStrategyInterface $supportStrategy


the BC layer actually expects a SupportStrategyInterface? Using the new strategy interface should only go via addWorkflow IMHO.

ro0NL

nice work :) i also asked @nicolas-grekas if this is really the desired upgrade path.

Basically i see one other option; to make Registry final since 3.4, so we can keep favoring add(); meaning less upgrade hassle for users as the common usecase would keep working, given Workflow implements WorkflowInterface tomorrow.

Also means we close extensibility on Registry, which we can open by introducing a RegistryInterface, when needed.

ro0NL · 2017-11-12T09:23:51Z

src/Symfony/Component/Workflow/Registry.php

@@ -25,13 +26,17 @@ class Registry
    /**
     * @param Workflow                 $workflow
     * @param SupportStrategyInterface $supportStrategy
+     *
+     * @deprecated since Symfony 4.1. Use addWorkflow() instead.


@deprecated since version 4.1, to be removed in 5.0. Use addWorkflow() instead.

ro0NL · 2017-11-12T09:24:34Z

src/Symfony/Component/Workflow/Registry.php

     */
    public function add(Workflow $workflow, $supportStrategy)
    {
-        if (!$supportStrategy instanceof SupportStrategyInterface) {


doesnt hurt to keep right? or why shouldnt it?

ro0NL · 2017-11-12T09:27:19Z

src/Symfony/Component/Workflow/Tests/SupportStrategy/ClassInstanceSupportStrategyTest.php

@@ -6,20 +6,26 @@
 use Symfony\Component\Workflow\SupportStrategy\ClassInstanceSupportStrategy;
 use Symfony\Component\Workflow\Workflow;

+/**
+ * @group legacy


still.. no real reason to optimize/tweak a legacy test (::class notation, class removals). Doesnt hurt; just extra diff :)

ro0NL · 2017-11-12T09:29:41Z

src/Symfony/Component/Workflow/WorkflowInterface.php

+     */
+    public function getEnabledTransitions($subject);
+
+    public function getName();


missing type info + {@inheritdoc} in sub class (id prefer a @return string here).

maybe we could typehint it instead of phpdoc ?

Simperfit · 2017-11-14T06:49:36Z

WDYT of @ro0NL's path ?

It's not too late to say that Registry is final since 3.4 @nicolas-grekas ?

I guess it could be a thing too to be able to re-implement the registry, and users won't need to change alot of thing. I think it's a good idea @ro0NL. (i'll take care of the comments, I just want to wait a little for others' thoughts).

chalasr · 2017-11-15T14:01:11Z

It's not too late to say that Registry if final since 3.4

It is to me, 3.4 should not receive new deprecations anymore. I think this is fine.

Simperfit · 2017-11-16T07:35:25Z

Ill take care of the 2 comments.

ro0NL · 2017-11-16T12:54:03Z

👍 lets go with addWorkflow. It's not like that's super bad or so.. but im not sure which method comes after that ;-) in case we need to patch this signature one day.

dunglas · 2017-11-30T09:18:21Z

Needs a rebase.

Simperfit · 2017-12-01T12:19:21Z

The PR has been rebased

chalasr · 2017-12-01T13:23:33Z

src/Symfony/Component/Workflow/WorkflowInterface.php

+     */
+    public function getEnabledTransitions($subject);
+
+    public function getName(): string;


return type should be removed, otherwise it requires to add it to Workflow::getName() which would break BC

chalasr · 2017-12-04T11:28:34Z

Looks good to me.

lyrixx

Sorry, I left one (two) extra comment.
I'm 👍 after the changes.

lyrixx · 2017-12-04T13:51:21Z

src/Symfony/Component/Workflow/SupportStrategy/WorkflowSupportStrategyInterface.php

+     * @param WorkflowInterface $workflow
+     * @param object            $subject
+     *
+     * @return bool


Sorry about asking again some change, but we don't need this PHP doc. Could you remove it?
Thanks

Don't be sorry, that's why the PR are made for ;)

lyrixx · 2017-12-04T13:52:12Z

UPGRADE-4.1.md

+Workflow
+--------
+
+ * Deprecated the `add` method in favor of the `addWorkflow` method in `Workflow\Registry`


As I asked a mandatory change, Can I also ask you to add a final dot on each line of each .md updated?

Simperfit · 2017-12-04T15:23:11Z

done @lyrixx

Simperfit · 2017-12-04T16:56:48Z

This PR is ready.

lyrixx · 2017-12-07T12:53:38Z

It took time, but here we go, this is in now. Thank you very much Hamza.

@chalasr

This PR was merged into the 4.1-dev branch. Discussion ---------- [Workflow] Introduce a Workflow interface | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | #23910 | License | MIT | Doc PR | todo @chalasr I think all the points you made in 23910 has been done. Needs to update the docs too. Commits ------- e8351d8 [Workflow] Introduce a Workflow interface

Simperfit · 2017-12-07T14:19:44Z

🎉 Thanks for your time @lyrixx @ro0NL @xabbuh @chalasr @nicolas-grekas

…(derrabus) This PR was merged into the 6.4 branch. Discussion ---------- [TwigBridge] Remove obsolete Workflow feature detection | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | N/A | License | MIT | Doc PR | N/A The classes and methods that are detected here have been introduced with #24751 and #26092 (both Symfony 4.1) Commits ------- 7e9d5bb [TwigBridge] Remove obsolete Workflow feature detection

carsonbot added Status: Needs Review Workflow Feature Deprecation labels Oct 30, 2017

Simperfit force-pushed the feature/introduce-an-interface-for-the-workflow-component branch 2 times, most recently from df6cd73 to 4b25e0d Compare October 30, 2017 10:04

nicolas-grekas added this to the 4.1 milestone Oct 30, 2017

chalasr self-requested a review October 30, 2017 20:51

Simperfit force-pushed the feature/introduce-an-interface-for-the-workflow-component branch 4 times, most recently from 347c55e to a673253 Compare November 1, 2017 18:43

lyrixx requested changes Nov 2, 2017

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Nov 2, 2017

Simperfit force-pushed the feature/introduce-an-interface-for-the-workflow-component branch 4 times, most recently from a597789 to f59403d Compare November 2, 2017 19:38

xabbuh reviewed Nov 2, 2017

View reviewed changes

Simperfit force-pushed the feature/introduce-an-interface-for-the-workflow-component branch from f59403d to 6902c37 Compare November 3, 2017 09:14

lyrixx reviewed Nov 3, 2017

View reviewed changes

Simperfit force-pushed the feature/introduce-an-interface-for-the-workflow-component branch from 6902c37 to 116d678 Compare November 3, 2017 10:03

chalasr reviewed Nov 3, 2017

View reviewed changes

Simperfit force-pushed the feature/introduce-an-interface-for-the-workflow-component branch from 116d678 to 6503755 Compare November 3, 2017 10:12

ro0NL reviewed Nov 10, 2017

View reviewed changes

Simperfit force-pushed the feature/introduce-an-interface-for-the-workflow-component branch 2 times, most recently from cab29ee to 860a174 Compare November 12, 2017 06:55

ro0NL reviewed Nov 12, 2017

View reviewed changes

Simperfit force-pushed the feature/introduce-an-interface-for-the-workflow-component branch 2 times, most recently from 1f0be16 to 41d3793 Compare December 1, 2017 12:19

chalasr reviewed Dec 1, 2017

View reviewed changes

Simperfit force-pushed the feature/introduce-an-interface-for-the-workflow-component branch from 41d3793 to a533a00 Compare December 1, 2017 16:08

lyrixx reviewed Dec 4, 2017

View reviewed changes

[Workflow] Introduce a Workflow interface

e8351d8

Simperfit force-pushed the feature/introduce-an-interface-for-the-workflow-component branch from a533a00 to e8351d8 Compare December 4, 2017 15:23

lyrixx approved these changes Dec 4, 2017

View reviewed changes

xabbuh approved these changes Dec 7, 2017

View reviewed changes

lyrixx merged commit e8351d8 into symfony:master Dec 7, 2017

javiereguiluz mentioned this pull request Jan 8, 2018

Document the Workflow deprecations symfony/symfony-docs#9017

Closed

fabpot mentioned this pull request May 7, 2018

Release v4.1.0-BETA1 #27181

Merged

derrabus mentioned this pull request Sep 10, 2023

[TwigBridge] Remove obsolete Workflow feature detection #51613

Merged


		* Deprecated the `add` method in favor of the `addWorkflow` method in `Workflow\Registry`
		* Deprecated the interface `SupportStrategyInterface` in favor of the interface `SupportStrategryWorkflowInterface`

		@@ -11,6 +11,8 @@

		namespace Symfony\Component\Workflow\SupportStrategy;

		@trigger_error('SupportStrategyInterface is deprecated since Symfony 4.0. Use SupportStrategyWorkflowInterface instead', E_USER_DEPRECATED);

[Workflow] Introduce a Workflow interface #24751

[Workflow] Introduce a Workflow interface #24751

Conversation

Simperfit commented Oct 30, 2017

nicolas-grekas commented Oct 30, 2017

chalasr commented Oct 30, 2017

Simperfit commented Oct 30, 2017 via email • edited by lyrixx Loading

lyrixx left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Simperfit commented Nov 2, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ro0NL left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Simperfit Dec 1, 2017 • edited Loading

Choose a reason for hiding this comment

Simperfit commented Nov 14, 2017 • edited Loading

chalasr commented Nov 15, 2017

Simperfit commented Nov 16, 2017

ro0NL commented Nov 16, 2017

dunglas commented Nov 30, 2017

Simperfit commented Dec 1, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chalasr commented Dec 4, 2017

lyrixx left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Simperfit Dec 4, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Simperfit commented Dec 4, 2017

Simperfit commented Dec 4, 2017

lyrixx commented Dec 7, 2017

Simperfit commented Dec 7, 2017

Simperfit commented Oct 30, 2017 via email •

edited by lyrixx

Loading

ro0NL left a comment •

edited

Loading

Simperfit Dec 1, 2017 •

edited

Loading

Simperfit commented Nov 14, 2017 •

edited

Loading

Simperfit Dec 4, 2017 •

edited

Loading