[DI] Add support for "wither" methods - for greater immutable services #30212

nicolas-grekas · 2019-02-12T18:38:39Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	-
License	MIT
Doc PR	symfony/symfony-docs#10991

Let's say we want to define an immutable service while still using traits for composing its optional features. A nice way to do so without hitting the downsides of setters is to use withers. Here would be an example:

 class MyService
{
    use LoggerAwareTrait;
}

trait LoggerAwareTrait
{
    private $logger;

    /**
     * @required
     * @return static
     */
    public function withLogger(LoggerInterface $logger)
    {
        $new = clone $this;
        $new->logger = $logger;

        return $new;
    }
}

$service = new MyService();
$service = $service->withLogger($logger);

As you can see, this nicely solves the setter issues.

BUT how do you make the service container create such a service? Right now, you need to resort to complex gymnastic using the "factory" setting - manageable for only one wither, but definitely not when more are involved and not compatible with autowiring.

So here we are: this PR allows configuring such services seamlessly.
Using explicit configuration, it adds a 3rd parameter to method calls configuration: after the method name and its parameters, you can pass true and done, you just declared a wither:

services:
    MyService:
        calls:
            - [withLogger, ['@logger'], true]

In XML, you could use the new returns-clone attribute on the <call> tag.

And when using autowiring, the code looks for the @return static annotation and turns the flag on if found.

There is only one limitation: unlike services with regular setters, services with withers cannot be part of circular loops that involve calls to wither methods (unless they're declared lazy of course).

src/Symfony/Component/DependencyInjection/Compiler/AutowireRequiredMethodsPass.php

src/Symfony/Component/DependencyInjection/Compiler/AnalyzeServiceReferencesPass.php

rvanlaak · 2019-02-12T20:28:29Z

The third parameter does not feel as explicit as it should.

On the other hand is the following format a bit overkill:

services:
    MyService:
        with:
            - [withLogger, '@logger']

Did you think about some other formats as well?

tsantos84 · 2019-02-12T22:41:34Z

Its ok to access private members as public ones? Sounds weird to me. Its ok this approach in this context?

nicolas-grekas · 2019-02-12T22:49:15Z

Did you think about some other formats as well?

None that clicked - that's the most simple I could think of - like for you, "with" doesn't click. I'm good with the 3rd arg - withers already start with "with" and that's enough maybe.

Its ok to access private members as public ones? Sounds weird to me. Its ok this approach in this context?

of course it is, that's pretty common for this and similar cases.

src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/autowiring_classes.php

src/Symfony/Component/DependencyInjection/Loader/XmlFileLoader.php

Tobion · 2019-02-13T01:43:01Z

services:
    MyService:
        calls:
            - [withLogger, '@logger', true]

It does not look like this works. The second array element needs to be an array of arguments (['@logger']). Ref. #25663
And the third element was not implemented in YamlFileLoader as far as I see (which is good IMO).

So it needs to be written in the following way which is also alot more readable:

services:
    MyService:
        calls:
            - 
                method: withLogger
                arguments: ['@logger']
                use_result: true

I would go so far that we should think about deprecating the yaml syntax with array list in favour of named properties (#13892)

nicolas-grekas · 2019-02-13T08:17:22Z

Thanks @Tobion and everyone, comments addressed, PR ready.

I would go so far that we should think about deprecating the yaml syntax with array list in favour of named properties

that's too far for me :) but that can be discussed in a RFC if you want to.

fancyweb · 2019-02-13T08:28:38Z

Shouldn't there be a check that the "wither" method actually returns an instance of the same class ? What prevents people from returning something else ?

nicolas-grekas · 2019-02-13T08:34:49Z

That's not the job of a DI container, eg we don't check you won't inject a logger where an event dispatcher is expected. That's a job for the language runtime, or a separate compiler pass / inspection process.

beoboo

I tried this locally and works very well.

stof · 2019-02-20T12:08:44Z

On the other hand is the following format a bit overkill:
services:
    MyService:
        with:
            - [withLogger, '@logger']
Did you think about some other formats as well?

@rvanlaak Registering withers separately from other calls would have a big drawback: if you have both with and calls, what is their order ? Do we call methods on the initial object or on the final one ?
Marking calls themselves as wither allows to support any order (even having withers in the middle of non-wither calls) as the order is explicit.

stof · 2019-02-20T12:10:26Z

src/Symfony/Component/DependencyInjection/Compiler/AnalyzeServiceReferencesPass.php

@@ -136,15 +136,27 @@ protected function processValue($value, $isRoot = false)
        }
        $this->lazy = false;

+        // Any calls before a "wither" are part of the constructor-instantiation graph


Aren't any call to a non-wither performed before a wither call also part of it ?

Please add some tests covering mixing wither calls with non-wither calls (in different orders) to make sure this works right.

I would argue that non-wither calls should happen after wither calls, on the off chance that some calls register themselves with other services and the object hashes differ and causes unintended problems.

Well, I would say that mixing things are an edge case indeed. But the current configuration syntax supports it, and so we should deal with it properly.

The code currently already respects the order of method calls, be them withers or no, when instantiating the service. Only this place is missing that.

Aren't any call to a non-wither performed before a wither call also part of it ?

sure, that'swhat I mean by "any calls" - regular setters or withers

non-wither calls should happen after wither calls

why not, but not something I would make a "must"

src/Symfony/Component/DependencyInjection/Definition.php

src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services_wither.php

nicolas-grekas · 2019-03-12T11:09:31Z

@stof thanks for the review, issue addressed.

Statuts: needs review

nicolas-grekas · 2019-03-26T18:52:14Z

friendly ping @symfony/deciders

fabpot

Looks good to me. Not a big fan of use-result though. use-returned-value would be more explicit IMHO, but perhaps a bit verbose. What about use-returned? Or anyone with a better idea?

nicolas-grekas · 2019-04-03T09:00:02Z

use-result? use-returned-value? use-returned?
is-wither-factory? is-wither?
as-factory? is-factory?
is-wither-factory?

nicolas-grekas · 2019-04-03T09:15:16Z

PR and description updated to use returns-clone, as discussed on Slack.

fabpot · 2019-04-03T10:10:03Z

Thank you @nicolas-grekas.

@required

…mutable services (nicolas-grekas) This PR was merged into the 4.3-dev branch. Discussion ---------- [DI] Add support for "wither" methods - for greater immutable services | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | symfony/symfony-docs#10991 Let's say we want to define an immutable service while still using traits for composing its optional features. A nice way to do so without hitting [the downsides of setters](https://symfony.com/doc/current/service_container/injection_types.html#setter-injection) is to use withers. Here would be an example: ```php class MyService { use LoggerAwareTrait; } trait LoggerAwareTrait { private $logger; /** * @required * @return static */ public function withLogger(LoggerInterface $logger) { $new = clone $this; $new->logger = $logger; return $new; } } $service = new MyService(); $service = $service->withLogger($logger); ``` As you can see, this nicely solves the setter issues. BUT how do you make the service container create such a service? Right now, you need to resort to complex gymnastic using the "factory" setting - manageable for only one wither, but definitely not when more are involved and not compatible with autowiring. So here we are: this PR allows configuring such services seamlessly. Using explicit configuration, it adds a 3rd parameter to method calls configuration: after the method name and its parameters, you can pass `true` and done, you just declared a wither: ```yaml services: MyService: calls: - [withLogger, ['@logger'], true] ``` In XML, you could use the new `returns-clone` attribute on the `<call>` tag. And when using autowiring, the code looks for the `@return static` annotation and turns the flag on if found. There is only one limitation: unlike services with regular setters, services with withers cannot be part of circular loops that involve calls to wither methods (unless they're declared lazy of course). Commits ------- f455d1b [DI] Add support for "wither" methods - for greater immutable services

@nicolas-grekas

This PR was merged into the 4.3 branch. Discussion ---------- [DIC] Static injection Hi everyone, As discussed with @nicolas-grekas, the DIC is planned to be capable of ensuring services immutability (using "wither" calls), the implementation can be found here: - symfony/symfony#30212 Commits ------- a598bc0 feat(DI): static injection

nicolas-grekas added this to the next milestone Feb 12, 2019

carsonbot added Status: Needs Review DependencyInjection Feature labels Feb 12, 2019

nicolas-grekas force-pushed the di-withers branch from 33bd906 to 0f5a1c8 Compare February 12, 2019 18:42

dunglas reviewed Feb 12, 2019

View reviewed changes

src/Symfony/Component/DependencyInjection/Compiler/AutowireRequiredMethodsPass.php Outdated Show resolved Hide resolved

theofidry reviewed Feb 12, 2019

View reviewed changes

src/Symfony/Component/DependencyInjection/Compiler/AnalyzeServiceReferencesPass.php Outdated Show resolved Hide resolved

nicolas-grekas force-pushed the di-withers branch from 0f5a1c8 to 82a2d2f Compare February 12, 2019 22:45

Tobion reviewed Feb 13, 2019

View reviewed changes

src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/autowiring_classes.php Show resolved Hide resolved

Tobion reviewed Feb 13, 2019

View reviewed changes

src/Symfony/Component/DependencyInjection/Loader/XmlFileLoader.php Outdated Show resolved Hide resolved

nicolas-grekas force-pushed the di-withers branch 2 times, most recently from 4ce5f60 to 1e41685 Compare February 13, 2019 08:14

Guikingone mentioned this pull request Feb 13, 2019

[DIC] Static injection symfony/symfony-docs#10991

Merged

beoboo approved these changes Feb 20, 2019

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Feb 20, 2019

stof requested changes Feb 20, 2019

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Reviewed labels Feb 20, 2019

nicolas-grekas force-pushed the di-withers branch 2 times, most recently from bb5c76d to 4c6ad1e Compare March 12, 2019 11:08

nicolas-grekas force-pushed the di-withers branch 2 times, most recently from eeb92bf to 12787bf Compare March 12, 2019 12:34

nicolas-grekas requested a review from stof March 12, 2019 13:16

carsonbot added Status: Needs Review and removed Status: Needs Work labels Mar 12, 2019

nicolas-grekas added the Ready label Mar 13, 2019

fabpot reviewed Mar 31, 2019

View reviewed changes

[DI] Add support for "wither" methods - for greater immutable services

f455d1b

nicolas-grekas force-pushed the di-withers branch from 12787bf to f455d1b Compare April 3, 2019 09:14

fabpot approved these changes Apr 3, 2019

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Apr 3, 2019

chalasr approved these changes Apr 3, 2019

View reviewed changes

fabpot merged commit f455d1b into symfony:master Apr 3, 2019

nicolas-grekas deleted the di-withers branch April 3, 2019 10:52

nicolas-grekas modified the milestones: next, 4.3 Apr 30, 2019

fabpot mentioned this pull request May 9, 2019

Release v4.3.0-BETA1 #31435

Merged

cs278 mentioned this pull request Dec 28, 2022

[DI] wither calls break services when used in certain configurations #48814

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DI] Add support for "wither" methods - for greater immutable services #30212

[DI] Add support for "wither" methods - for greater immutable services #30212

nicolas-grekas commented Feb 12, 2019 •

edited

Loading

rvanlaak commented Feb 12, 2019

tsantos84 commented Feb 12, 2019

nicolas-grekas commented Feb 12, 2019 •

edited

Loading

Tobion commented Feb 13, 2019 •

edited

Loading

nicolas-grekas commented Feb 13, 2019

fancyweb commented Feb 13, 2019

nicolas-grekas commented Feb 13, 2019

beoboo left a comment

stof commented Feb 20, 2019 •

edited

Loading

stof Feb 20, 2019

stof Feb 20, 2019

zanbaldwin Feb 20, 2019

stof Feb 20, 2019

nicolas-grekas Feb 20, 2019

nicolas-grekas commented Mar 12, 2019

nicolas-grekas commented Mar 26, 2019

fabpot left a comment

nicolas-grekas commented Apr 3, 2019 •

edited

Loading

nicolas-grekas commented Apr 3, 2019

fabpot commented Apr 3, 2019

[DI] Add support for "wither" methods - for greater immutable services #30212

[DI] Add support for "wither" methods - for greater immutable services #30212

Conversation

nicolas-grekas commented Feb 12, 2019 • edited Loading

rvanlaak commented Feb 12, 2019

tsantos84 commented Feb 12, 2019

nicolas-grekas commented Feb 12, 2019 • edited Loading

Tobion commented Feb 13, 2019 • edited Loading

nicolas-grekas commented Feb 13, 2019

fancyweb commented Feb 13, 2019

nicolas-grekas commented Feb 13, 2019

beoboo left a comment

Choose a reason for hiding this comment

stof commented Feb 20, 2019 • edited Loading

stof Feb 20, 2019

Choose a reason for hiding this comment

stof Feb 20, 2019

Choose a reason for hiding this comment

zanbaldwin Feb 20, 2019

Choose a reason for hiding this comment

stof Feb 20, 2019

Choose a reason for hiding this comment

nicolas-grekas Feb 20, 2019

Choose a reason for hiding this comment

nicolas-grekas commented Mar 12, 2019

nicolas-grekas commented Mar 26, 2019

fabpot left a comment

Choose a reason for hiding this comment

nicolas-grekas commented Apr 3, 2019 • edited Loading

nicolas-grekas commented Apr 3, 2019

fabpot commented Apr 3, 2019

nicolas-grekas commented Feb 12, 2019 •

edited

Loading

nicolas-grekas commented Feb 12, 2019 •

edited

Loading

Tobion commented Feb 13, 2019 •

edited

Loading

stof commented Feb 20, 2019 •

edited

Loading

nicolas-grekas commented Apr 3, 2019 •

edited

Loading