[DependencyInjection] Add `#[AutowireInline]` attribute to allow service definition at the class level #52820

DaDeather · 2023-11-30T11:12:19Z

Q	A
Branch	7.1
Bug fix	no
New feature	yes
Deprecations	no
Issues	Fix #52819
License	MIT

For the idea behind this feature see the issue that contains examples #52819

Example usage:

class SomeSourceAwareLogger
{
    public function __construct(
        private readonly LoggerInterface $logger,
        private readonly string $someSource,
    ) {
    }
}

class SomeSourceAwareLoggerFactory
{
    public function __construct(
        private readonly LoggerInterface $logger,
    ) {
    }

    public function create(string $someSource): SomeSourceAwareLogger
    {
        return new SomeSourceAwareLogger($this->logger, $someSource);
    }

    public static function staticCreate(LoggerInterface $logger, string $someSource): SomeSourceAwareLogger
    {
        return new SomeSourceAwareLogger($logger, $someSource);
    }
}

// -----------

class SomeClass1
{
    public function __construct(
        #[AutowireInline(class: SomeSourceAwareLogger::class, args: [new Reference(LoggerInterface::class), 'bar'])]
        public SomeSourceAwareLogger $someSourceAwareLogger,
    ) {
    }
}

// AND/OR

class SomeClass2
{
    public function __construct(
        #[AutowireInline(
            class: SomeSourceAwareLogger::class,
            factory: [SomeSourceAwareLoggerFactory::class, 'staticCreate'],
            args: [new Reference(LoggerInterface::class), 'someParam'],
        )]
        public SomeSourceAwareLogger $someSourceAwareLogger,
    ) {
    }
}

// AND/OR

class SomeClass3
{
    public function __construct(
        #[AutowireInline(
            class: SomeSourceAwareLogger::class,
            factory: [new Reference(SomeSourceAwareLoggerFactory::class), 'create'],
            args: ['someParam'],
        )]
        public SomeSourceAwareLogger $someSourceAwareLogger,
    ) {
    }
}

nicolas-grekas · 2023-11-30T19:14:37Z

Thanks for proposing and for submitting!

I'm wondering if we couldn't get rid of the interface and rename the proposed argument to e.g. AutowireInline?
To remove the interface, we could maybe make AutowireCallable extend AutowireInline.
Also, instead of a dedicated attribute for services built by factory, can't we add a factory argument to the AutowireInline attribute?

DaDeather · 2023-12-01T07:11:57Z

Thanks for proposing and for submitting!

I'm wondering if we couldn't get rid of the interface and rename the proposed argument to e.g. AutowireInline? To remove the interface, we could maybe make AutowireCallable extend AutowireInline. Also, instead of a dedicated attribute for services built by factory, can't we add a factory argument to the AutowireInline attribute?

Sure I was unsure about the naming anyway though 🙈.

About the interface:
Wouldn't it rather make sense to keep it to allow extending / allowing custom Attributes that may create definitions that could be used for the Autowiring to be handled?

I'd rather see it as a benefit there allowing one to implement the interface and go for it instead of extending the base classes like the AutowireInline (after renaming). Unless this may be undesired anyway 🤷. Just being curious here.

Combining the factory thing into the AutowireInline seems fine as well since both are inlined 👍.

I made the adjustments according to your comment unless the one with the Interface. Just let me know if I still should remove it / rename it or whatever 👍.

And thanks for your fast feedback on this!

nicolas-grekas

I'm not convinced by the interface, I'd prefer removing it.
I'm generally not convinced by interfaces for value objects and attributes are value objects.
Extending the class makes sense to me in this case.

src/Symfony/Component/DependencyInjection/Attribute/AutowireInline.php

src/Symfony/Component/DependencyInjection/CHANGELOG.md

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

DaDeather · 2023-12-01T09:19:59Z

I'm not convinced by the interface, I'd prefer removing it. I'm generally not convinced by interfaces for value objects and attributes are value objects. Extending the class makes sense to me in this case.

Alright 👍 I have removed the interface and based the AutowireCallable on the new AutowireInline as you proposed before.

src/Symfony/Component/DependencyInjection/Attribute/AutowireInline.php

stof · 2023-12-01T09:40:30Z

Please update the PR description to show usages of the feature. This makes it a lot easier for the documentation team (and also for reviewers)

nicolas-grekas · 2024-02-27T15:34:56Z

About my remaining concerns (ResolveNamedArgumentsPass, ResolveChildDefinitionPass and other pass not running), I'm wondering if we shouldn't add a new ResolveAutowireInlineAttributesPass that would scan autowired services for this attribute and would register definitions for each of them. Then, based on some naming convention (likely built on Container::hash($definition)), AutowirePass would just reference these definitions instead of calling AutowireInline::buildDefinition().

WDYT? Up to give it a try?

DaDeather · 2024-03-06T09:14:44Z

About my remaining concerns (ResolveNamedArgumentsPass, ResolveChildDefinitionPass and other pass not running), I'm wondering if we shouldn't add a new ResolveAutowireInlineAttributesPass that would scan autowired services for this attribute and would register definitions for each of them. Then, based on some naming convention (likely built on Container::hash($definition)), AutowirePass would just reference these definitions instead of calling AutowireInline::buildDefinition().

WDYT? Up to give it a try?

Sure!
Could you maybe give a few hints how / where to implement this correctly?
I'm struggling a bit with the input style and the expected outcome here and therefore maybe didn't understand what's really expected here.

Would you expect a definition be like this:

class AutowireInlineAttributesBar {
    public function __construct(Foo $foo, string $someString)
    {
    }
}

class AutowireInlineAttributes
{
    public function __construct(
        #[AutowireInline(AutowireInlineAttributesBar::class, [
            '$foo' => Foo::class,
            '$someString' => 'testString',
        ])]
        public AutowireInlineAttributesBar $inlined,
    ) {
    }
}

Where the class Foo then would be a autowired as the provided service name and the someString injected as a string or what would you rather expect here to happen?

Besides that if I got you right I would have to create a class called ResolveAutowireInlineAttributesPass which then checks for a passed Definition to be $definition->isAutowired() === true and check for it to have any AutowireInline attributes to be processed (calling ->buildDefinition(...) and registering those via $this->container->setDefinition(ContainerBuilder::hash($autowireInlineAttributeInstance), $definition);.

Is this assumption correct?

nicolas-grekas · 2024-03-06T11:19:39Z

You've got it right I think :)

DaDeather · 2024-03-07T07:05:44Z

You've got it right I think :)

I've prepared something that doesn't quite work 🤷 as mentioned before maybe I'm missing something here. Could you maybe take a look so that we may correct the issues there or my misunderstanding 🙈?

I would be grateful 👍 dd16390

@nicolas-grekas

nicolas-grekas

Thanks for the update, the path looks good to me.
Here are some comments to go to the next step.

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

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

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

...ony/Component/DependencyInjection/Tests/Compiler/ResolveAutowireInlineAttributesPassTest.php

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

src/Symfony/Component/DependencyInjection/Attribute/AutowireInline.php

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

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

chalasr · 2024-03-20T21:05:13Z

src/Symfony/Component/DependencyInjection/Attribute/AutowireInline.php

+ * @author Ismail Özgün Turan <[email protected]>
+ */
+#[\Attribute(\Attribute::TARGET_PARAMETER)]
+class AutowireInline extends Autowire


AutowireInline looks pretty cryptic, any newcomer wouldn't be able to get what the attribute is for by just looking at its name nor its description as it currently is. I think we either need to find a super self-explanatory name (I've no clue) or extend the description so that it tells what's the purpose of the attribute and when it should be used (inline service definition only means something to advanced Symfony's DIC hackers)

Naming things... :)
"inline" refers to "inline_service()" in the PHP-DSL

AutowireInlineService? but verbose
AutowireNew? AutowireObject? AutowireInstance? or keep AutowireInline?

of course, a top notch description is also desirable

I added a better description here feel free to request further suggestments to it 👍.

nicolas-grekas

PR is ready.
I added a second commit to make the implementation a bit more generic.
Reviews welcome 🙏

nicolas-grekas · 2024-04-22T13:54:18Z

src/Symfony/Component/DependencyInjection/ContainerBuilder.php

@@ -494,7 +494,9 @@ public function removeDefinition(string $id): void
    {
        if (isset($this->definitions[$id])) {
            unset($this->definitions[$id]);
-            $this->removedIds[$id] = true;
+            if ('.' !== ($id[0] ?? '-')) {


I added this rule so that we don't use internal service ids in error messages. This matters to this PR because the added code creates new removed-ids, which means fixtures have to be updated with (what I consider as) noise.

…ice definition at the class level

fabpot · 2024-05-02T09:07:39Z

Thank you @DaDeather.

DaDeather requested a review from dunglas as a code owner November 30, 2023 11:12

carsonbot added Status: Needs Review DependencyInjection labels Nov 30, 2023

carsonbot added this to the 6.4 milestone Nov 30, 2023

DaDeather force-pushed the 52819-dependency-injection-new-inline-attributes branch 2 times, most recently from 6ca710b to c547abc Compare November 30, 2023 11:19

DaDeather force-pushed the 52819-dependency-injection-new-inline-attributes branch 6 times, most recently from b9abcbc to 48fc63b Compare December 1, 2023 07:42

nicolas-grekas reviewed Dec 1, 2023

View reviewed changes

DaDeather force-pushed the 52819-dependency-injection-new-inline-attributes branch from 48fc63b to f21a70b Compare December 1, 2023 09:15

DaDeather force-pushed the 52819-dependency-injection-new-inline-attributes branch from f21a70b to 917a698 Compare December 1, 2023 09:21

DaDeather changed the title ~~[DependencyInjection] add InlineService and InlineFactory attributes to allow service configuration on class level~~ [DependencyInjection] add AutowireInline attribute to allow service configuration on class level Dec 1, 2023

nicolas-grekas reviewed Dec 1, 2023

View reviewed changes

src/Symfony/Component/DependencyInjection/Attribute/AutowireInline.php Outdated Show resolved Hide resolved

DaDeather force-pushed the 52819-dependency-injection-new-inline-attributes branch from 917a698 to 86b2806 Compare December 1, 2023 09:40

DaDeather requested review from xabbuh, lyrixx, yceruto, welcoMattic, kbond, chalasr and OskarStark as code owners December 1, 2023 09:40

DaDeather force-pushed the 52819-dependency-injection-new-inline-attributes branch 3 times, most recently from 5955b18 to 6a7e3fc Compare February 27, 2024 05:49

nicolas-grekas reviewed Mar 20, 2024

View reviewed changes

stof reviewed Mar 20, 2024

View reviewed changes

chalasr reviewed Mar 20, 2024

View reviewed changes

DaDeather force-pushed the 52819-dependency-injection-new-inline-attributes branch 3 times, most recently from 0ad67af to 5144cea Compare April 2, 2024 08:02

nicolas-grekas force-pushed the 52819-dependency-injection-new-inline-attributes branch 2 times, most recently from 964fe78 to 19b1076 Compare April 22, 2024 13:48

nicolas-grekas added Ready ❄️ Feature Freeze Important Pull Requests to finish before the next Symfony "feature freeze" and removed Status: Needs Work labels Apr 22, 2024

nicolas-grekas approved these changes Apr 22, 2024

View reviewed changes

carsonbot added the Status: Reviewed label Apr 22, 2024

nicolas-grekas reviewed Apr 22, 2024

View reviewed changes

DaDeather and others added 2 commits May 2, 2024 10:53

[DependencyInjection] Add #[AutowireInline] attribute to allow serv…

a596142

…ice definition at the class level

Finish implementing AutowireInline attribute

b9a838e

nicolas-grekas force-pushed the 52819-dependency-injection-new-inline-attributes branch from 19b1076 to b9a838e Compare May 2, 2024 08:54

fabpot merged commit 66faca6 into symfony:7.1 May 2, 2024
3 of 10 checks passed

fabpot mentioned this pull request May 2, 2024

[DependencyInjection] Add #[AutowireInline] attribute to allow servic… symfony/symfony-docs#19847

Closed

DaDeather deleted the 52819-dependency-injection-new-inline-attributes branch May 2, 2024 09:16

fabpot mentioned this pull request May 2, 2024

Release v7.1.0-BETA1 #54820

Merged

derrabus mentioned this pull request May 2, 2024

[DependencyInjection] Can not replace arguments if none have been configured yet - InlineAutowire #54823

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DependencyInjection] Add `#[AutowireInline]` attribute to allow service definition at the class level #52820

[DependencyInjection] Add `#[AutowireInline]` attribute to allow service definition at the class level #52820

DaDeather commented Nov 30, 2023 •

edited

Loading

nicolas-grekas commented Nov 30, 2023

DaDeather commented Dec 1, 2023

nicolas-grekas left a comment

DaDeather commented Dec 1, 2023

stof commented Dec 1, 2023 •

edited

Loading

nicolas-grekas commented Feb 27, 2024

DaDeather commented Mar 6, 2024

nicolas-grekas commented Mar 6, 2024

DaDeather commented Mar 7, 2024 •

edited

Loading

nicolas-grekas left a comment

chalasr Mar 20, 2024 •

edited

Loading

nicolas-grekas Mar 25, 2024

DaDeather Apr 2, 2024

nicolas-grekas left a comment

nicolas-grekas Apr 22, 2024

fabpot commented May 2, 2024

[DependencyInjection] Add #[AutowireInline] attribute to allow service definition at the class level #52820

[DependencyInjection] Add #[AutowireInline] attribute to allow service definition at the class level #52820

Conversation

DaDeather commented Nov 30, 2023 • edited Loading

Example usage:

nicolas-grekas commented Nov 30, 2023

DaDeather commented Dec 1, 2023

nicolas-grekas left a comment

Choose a reason for hiding this comment

DaDeather commented Dec 1, 2023

stof commented Dec 1, 2023 • edited Loading

nicolas-grekas commented Feb 27, 2024

DaDeather commented Mar 6, 2024

nicolas-grekas commented Mar 6, 2024

DaDeather commented Mar 7, 2024 • edited Loading

nicolas-grekas left a comment

Choose a reason for hiding this comment

chalasr Mar 20, 2024 • edited Loading

Choose a reason for hiding this comment

nicolas-grekas Mar 25, 2024

Choose a reason for hiding this comment

DaDeather Apr 2, 2024

Choose a reason for hiding this comment

nicolas-grekas left a comment

Choose a reason for hiding this comment

nicolas-grekas Apr 22, 2024

Choose a reason for hiding this comment

fabpot commented May 2, 2024

[DependencyInjection] Add `#[AutowireInline]` attribute to allow service definition at the class level #52820

[DependencyInjection] Add `#[AutowireInline]` attribute to allow service definition at the class level #52820

DaDeather commented Nov 30, 2023 •

edited

Loading

stof commented Dec 1, 2023 •

edited

Loading

DaDeather commented Mar 7, 2024 •

edited

Loading

chalasr Mar 20, 2024 •

edited

Loading