[Console][Lock] Allow LockableTrait to use custom stores #31914

stixx · 2019-06-06T22:42:25Z

Q	A
Branch?	4.4
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	n/a
License	MIT
Doc PR	n/a

This PR adds the possibility to inject a custom store which implements the StoreInterface in a command by doing the following:

Configure a default store in the configuration of Symfony;
Adding the LockableTrait to the command;
Adding the marker interface LockableInterface to the command;

Symfony configuration:

lock:
    resources:
        default: flock

~~If those two conditions are met in the AddConsoleCommandPass, the setStore method will be called and the store of choice will be set.~~

I had difficulty choosing the best solution while keeping simplicity in tact. A different solution would be to add this functionality to the base command (Symfony\Component\Console\Command\Command) and make it configurable.

If no store is configured the LockableTrait will work as it was, by either giving the SemaphoreStore or the FlockStore.

chalasr

Some comments. Thank you for the PR.

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

src/Symfony/Component/Console/Command/LockableTrait.php

src/Symfony/Component/Console/Tests/DependencyInjection/AddConsoleCommandPassTest.php

src/Symfony/Component/Console/DependencyInjection/AddConsoleCommandPass.php

src/Symfony/Component/Console/Tests/DependencyInjection/AddConsoleCommandPassTest.php

chalasr · 2019-06-16T22:27:48Z

src/Symfony/Component/Console/DependencyInjection/AddConsoleCommandPass.php

+
+            $storeDefinition = 'lock.default.store';
+            if ($container->hasDefinition($storeDefinition)) {
+                if (\method_exists($definition->getClass(), 'setStore')) {


I'm a bit unsure about injecting the store based on method existence.
This is about autoconfiguration which usually works on types, and traits are not types. Should we add a marker LockableInterface and use it as a type for ContainerBuilder::registerForAutoconfiguration()?

ro0NL · 2019-06-17T14:29:45Z

src/Symfony/Component/Console/Command/LockableTrait.php

+     *
+     * @param StoreInterface $store
+     */
+    public function setStore(StoreInterface $store)


what about passing a non-default store as optional 3rd arg in lock()? and avoid this state issue.

meaning the user injects his own store if needed

If that's the case then this change wouldn't be needed because you can implement the Symfony\Component\Lock\Factory service in a command by dependency injection to create locks.

Right ... the user can also set private $store; already.Then, im not sure what we're solving here 🤔

We should favor pure DI / service usage IMHO.

I'm trying to solve a configurable store that can be used in commands, this can either be done by:

The current solution (setStore in LockableTrait);

Implementing a default store in Symfony\Component\Console\Command\Command;

Writing a LockableCommand class which basically does what LockableTrait does now, so this could mean bye bye for LockableTrait - would also mean more abstraction;

Why?

Because currently LockableTrait is limited to SemaphoreStore and FlockStore. Also you can use dependency injection but that would mean that you have to overwrite the constructor. Last, it's not configurable as in available in a command by default.

you can use dependency injection but that would mean that you have to overwrite the constructor.

Is that a real problem? IMHO it's the explicit way.. compared to calling an arbitrary setStore method. At least i agree with https://github.com/symfony/symfony/pull/31914/files#r294103123; if we do this we should add a marker interface for it.

I agree that we should be using a marker interface. I've updated the PR.

… the AddConsoleCommandPass

…ommandPass

…ConsoleCommandPass" This reverts commit bd46276

…ForAutoConfiguration Added LockableInterface as marker

… the AddConsoleCommandPass

…ommandPass

…ConsoleCommandPass" This reverts commit bd46276

…ForAutoConfiguration Added LockableInterface as marker

stixx · 2019-06-28T08:52:24Z

Bump, requesting new review after proposed changes.

fabpot · 2019-07-08T12:26:39Z

@jderusse Can you have a look at this PR?

jderusse

Wonder if the marker couldn't be replaced by a autowired setter?

trait LockableTrait 
{
  /**
   * @required
   */
  public function setStore(StoreInterface $store)
  {
    $this->store = $store;
  }
}

class OverrideStoreCommand 
{
  use LockableTrait;

  /**
   * @required
   */
  public function setStore(StoreInterface $notdefaultLockStore)
  {
    $this->store = $store;
  }
}

jderusse · 2019-07-08T21:45:33Z

src/Symfony/Component/Console/Command/LockableTrait.php

 use Symfony\Component\Lock\Store\FlockStore;
 use Symfony\Component\Lock\Store\SemaphoreStore;
+use Symfony\Component\Lock\StoreInterface;


beware, the interface has been renamed in #32198

nicolas-grekas · 2020-02-03T13:28:25Z

No need to add a setter, named autowiring aliases can be used instead.

carsonbot added Status: Needs Review Lock Feature labels Jun 6, 2019

chalasr added Console and removed Lock labels Jun 7, 2019

chalasr added this to the next milestone Jun 7, 2019

stixx changed the title ~~[Lock] Allow LockableTrait to use custom stores~~ [Console][Lock] Allow LockableTrait to use custom stores Jun 7, 2019

carsonbot removed the Status: Needs Review label Jun 16, 2019

chalasr requested changes Jun 16, 2019

View reviewed changes

carsonbot added the Status: Needs Work label Jun 16, 2019

ro0NL reviewed Jun 17, 2019

View reviewed changes

stixx requested review from dunglas, lyrixx, sroze and xabbuh as code owners June 21, 2019 08:48

carsonbot added Status: Needs Review and removed Status: Needs Work labels Jun 21, 2019

stixx force-pushed the set-store-in-lockable-trait branch from e4d791f to c05870e Compare June 21, 2019 09:24

Jelle van Oosterbosch added 9 commits June 21, 2019 20:23

[Lock] Added the ability to set a store in the LockableTrait by using…

38e7a8a

… the AddConsoleCommandPass

[Lock] Moved command name of lockable to the container register

7b375db

Register default store as service to be accessible by the AddConsoleC…

c097950

…ommandPass

Revert "Register default store as service to be accessible by the Add…

51626d9

…ConsoleCommandPass" This reverts commit bd46276

[Lock] Replaced method injection in AddConsoleCommandPass to register…

dff0863

…ForAutoConfiguration Added LockableInterface as marker

[Lock] Added license to LockableInterface

ac74dde

[Lock] Added the ability to set a store in the LockableTrait by using…

cf89732

… the AddConsoleCommandPass

[Lock] Moved command name of lockable to the container register

300bcc8

Register default store as service to be accessible by the AddConsoleC…

588d6d9

…ommandPass

Jelle van Oosterbosch added 3 commits June 21, 2019 20:23

Revert "Register default store as service to be accessible by the Add…

9605bdc

…ConsoleCommandPass" This reverts commit bd46276

[Lock] Replaced method injection in AddConsoleCommandPass to register…

c1f3749

…ForAutoConfiguration Added LockableInterface as marker

[Lock] Added license to LockableInterface

bbfb8aa

stixx force-pushed the set-store-in-lockable-trait branch from 045a7ac to bbfb8aa Compare June 21, 2019 18:23

jderusse reviewed Jul 8, 2019

View reviewed changes

nicolas-grekas closed this Feb 3, 2020

nicolas-grekas modified the milestones: next, 5.1 May 4, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Console][Lock] Allow LockableTrait to use custom stores #31914

[Console][Lock] Allow LockableTrait to use custom stores #31914

stixx commented Jun 6, 2019 •

edited

Loading

chalasr left a comment

chalasr Jun 16, 2019

ro0NL Jun 17, 2019

ro0NL Jun 17, 2019

stixx Jun 17, 2019 •

edited

Loading

ro0NL Jun 17, 2019

stixx Jun 19, 2019

ro0NL Jun 19, 2019

stixx Jun 21, 2019

stixx commented Jun 28, 2019

fabpot commented Jul 8, 2019

jderusse left a comment

jderusse Jul 8, 2019

nicolas-grekas commented Feb 3, 2020

[Console][Lock] Allow LockableTrait to use custom stores #31914

[Console][Lock] Allow LockableTrait to use custom stores #31914

Conversation

stixx commented Jun 6, 2019 • edited Loading

chalasr 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

stixx Jun 17, 2019 • 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

stixx commented Jun 28, 2019

fabpot commented Jul 8, 2019

jderusse left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas commented Feb 3, 2020

stixx commented Jun 6, 2019 •

edited

Loading

stixx Jun 17, 2019 •

edited

Loading