[DependencyInjection] Prepending extension configs with file loaders #52843

yceruto · 2023-12-01T07:03:35Z

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

#52636 continuation.

This is another try to simplify even more the prepending extension config strategy for Bundles and Extensions.

Feature: "Import and prepend an extension configuration from an external YAML, XML or PHP file"

Useful when you need to pre-configure some functionalities in your app, such as mapping some DBAL types provided by your bundle, or simply pre-configuring some default values automatically when your bundle is installed, without losing the ability to override them if desired in userland.

class AcmeFooBundle extends AbstractBundle
{
    public function prependExtension(ContainerConfigurator $container, ContainerBuilder $builder): void
    {
        // Before
        $config = Yaml::parse(file_get_contents(__DIR__.'/../config/doctrine.yaml'));
        $builder->prependExtensionConfig('doctrine', $config['doctrine']);

        // After
        $container->import('../config/doctrine.yaml');
    }
}

The "Before" section is limited to importing/parsing this kind of configuration by hand; it doesn't support features like when@env, recursive importing, or defining parameters/services in the same file. Further, you can't simply use ContainerConfigurator::import() or any *FileLoader::load() here, as they will append the extension config instead of prepending it, defeating the prepend method purpose and breaking your app's config strategy. Thus, you are forced to use $builder->prependExtensionConfig() as the only way.

This is because if you append any extension config using $container->import(), then you won't be able to change that config in your app as it's merged with priority. If anyone is doing that currently, it shouldn't be intentional.

Therefore, the "After" proposal changes that behavior for $container->import(). Now, all extension configurations encountered in your external file will be prepended instead. BUT, this will only happen here, at this moment, during the prependExtension() method.

Of course, this little behavior change is a "BC break". However, it is a behavior that makes more sense than the previous one, enabling the usage of ContainerConfigurator::import() here, which was previously ineffective.

This capability is also available for YamlFileLoader, XmlFileLoader and PhpFileLoader through a new boolean constructor argument:

class AcmeFooBundle extends AbstractBundle
{
    public function prependExtension(ContainerConfigurator $container, ContainerBuilder $builder): void
    {
        // Before
        // - It can't be used for prepending config purposes

        // After
        $loader = new YamlFileLoader($builder, new FileLocator(__DIR__.'/../config/'), prepend: true);
        $loader->load('doctrine.yaml'); // now it prepends extension configs as default behavior
        // or
        $loader->import('prepend/*.yaml');
    }
}

These changes only affect the loading strategy for extension configs; everything else keeps working as before.

Cheers!

nicolas-grekas

I'm just wondering about recursive imports: are they also reversed?

src/Symfony/Component/DependencyInjection/CHANGELOG.md

yceruto · 2023-12-01T14:13:52Z

I'm just wondering about recursive imports: are they also reversed?

The behavior is set up for the whole process, so yes, all extension configs imported recursively will be prepended too. However, unless there are split configs of the same extension distributed into several files matching the same config key, it doesn't matter.

yceruto · 2023-12-01T14:14:58Z

The behavior is set up for the whole process, so yes, all extension configs imported recursively will be prepended too.

Which is expected if you're importing from the prepend method.

nicolas-grekas · 2023-12-04T14:12:52Z

Maybe you already answered but just to be sure: if I have a yaml file that imports two other files, I'd expect them to be loaded in top-down order, is that going to be the case?

yceruto · 2023-12-04T14:28:50Z

Maybe you already answered but just to be sure: if I have a yaml file that imports two other files, I'd expect them to be loaded in top-down order, is that going to be the case?

I will confirm with a test case to ensure we know what the behavior will be.

src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/packages/ping.yaml

src/Symfony/Component/DependencyInjection/Tests/Extension/AbstractExtensionTest.php

nicolas-grekas

LGTM (small rebase needed)

yceruto · 2024-01-02T17:41:35Z

Thanks Nicolas! rebased done.

yceruto · 2024-01-14T12:34:53Z

Friendly ping @symfony/mergers, there is a BC behavior break on the table here; it would be great to have a double check in case we miss something.

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

yceruto · 2024-03-16T16:18:53Z

Hey @nicolas-grekas, I rebased, rechecked, and updated another part where when@env wasn't working as expected. I added another test case to cover it. So, after a while, this looks ready to me. Wdyt?

nicolas-grekas

Just some minor CS things and 🚀

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

nicolas-grekas · 2024-03-25T17:34:40Z

Anyone @symfony/mergers ? (after a small rebase)

nicolas-grekas · 2024-04-03T20:11:01Z

Thank you @yceruto.

…(OskarStark) This PR was squashed before being merged into the 7.1 branch. Discussion ---------- [DependencyInjection] Document BC break in UPGRADE file | Q | A | ------------- | --- | Branch? | 7.1 | Bug fix? | no | New feature? | no | Deprecations? | no | Issues | Follows #52843 | License | MIT Commits ------- 055892d [DependencyInjection] Document BC break in UPGRADE file

…ities (yceruto) This PR was merged into the 7.1 branch. Discussion ---------- [DependencyInjection] Updating prepend extension capabilities Fixes #19735 I'm also suggesting removing the append example in the prepend extension method. As explained in PR symfony/symfony#52843 and related issues, it's flawed and should be discouraged from the official documentation. I'll create a new PR to target the lower branch and remove it there too. Commits ------- 25c5adf Updating prepend extension capabilities

…nerConfigurator (MatTheCat) This PR was merged into the 7.1 branch. Discussion ---------- [DependencyInjection] Process PHP configs using the ContainerConfigurator | Q | A | ------------- | --- | Branch? | 7.1 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #54852 | License | MIT Since #52843, `ContainerConfigurator::extension` is not called anymore which means `ParamConfigurator`s are no longer processed and converted to strings, and make nodes validation fail: e.g. `framework.secret` would receive an `EnvConfigurator` and throw because it is not a scalar. Commits ------- e6dc6be [DependencyInjection] Process PHP configs using the ContainerConfigurator

…pend extension method (yceruto) This PR was merged into the 7.1 branch. Discussion ---------- [DependencyInjection] Fix importing PHP configs in the prepend extension method | Q | A | ------------- | --- | Branch? | 7.1 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #57936 | License | MIT I missed this nesting case during #52843. Commits ------- 94df570 Fix importing PHP config in prepend extension method

yceruto added the BC Break label Dec 1, 2023

yceruto added this to the 7.1 milestone Dec 1, 2023

yceruto requested a review from nicolas-grekas December 1, 2023 07:03

carsonbot added the Status: Needs Review label Dec 1, 2023

carsonbot changed the title ~~[DependencyInjection] Prepending extension configs with file loaders~~ Prepending extension configs with file loaders Dec 1, 2023

carsonbot added DependencyInjection Feature labels Dec 1, 2023

carsonbot changed the title ~~Prepending extension configs with file loaders~~ [DependencyInjection] Prepending extension configs with file loaders Dec 1, 2023

yceruto mentioned this pull request Dec 1, 2023

Allow prepending extension config in DI Loader (XML/YAML) #52789

Closed

yceruto force-pushed the prepend_extension_config branch from 058e3da to 1f62898 Compare December 1, 2023 07:14

yceruto added the DX DX = Developer eXperience (anything that improves the experience of using Symfony) label Dec 1, 2023

nicolas-grekas reviewed Dec 1, 2023

View reviewed changes

src/Symfony/Component/DependencyInjection/CHANGELOG.md Outdated Show resolved Hide resolved

yceruto force-pushed the prepend_extension_config branch from 1f62898 to b93e450 Compare December 1, 2023 14:06

yceruto commented Dec 4, 2023

View reviewed changes

src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/packages/ping.yaml Show resolved Hide resolved

yceruto commented Dec 4, 2023

View reviewed changes

src/Symfony/Component/DependencyInjection/Tests/Extension/AbstractExtensionTest.php Outdated Show resolved Hide resolved

yceruto requested a review from nicolas-grekas December 19, 2023 16:09

nicolas-grekas approved these changes Jan 2, 2024

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Jan 2, 2024

yceruto force-pushed the prepend_extension_config branch from f1f602a to 66bf43a Compare January 2, 2024 17:32

yceruto force-pushed the prepend_extension_config branch from 66bf43a to 80e97ea Compare January 24, 2024 20:06

yceruto mentioned this pull request Jan 24, 2024

Add support for importing YAML config in prepend method yceruto/micro-symfony#7

Merged

yceruto force-pushed the prepend_extension_config branch from 80e97ea to fffad85 Compare February 7, 2024 14:48

nicolas-grekas reviewed Feb 9, 2024

View reviewed changes

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

yceruto force-pushed the prepend_extension_config branch from fffad85 to c97b569 Compare February 9, 2024 15:29

yceruto force-pushed the prepend_extension_config branch from c97b569 to 8e2b365 Compare March 16, 2024 16:11

nicolas-grekas approved these changes Mar 18, 2024

View reviewed changes

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

src/Symfony/Component/DependencyInjection/Loader/FileLoader.php Show resolved Hide resolved

yceruto force-pushed the prepend_extension_config branch from 8e2b365 to 4d731be Compare March 18, 2024 13:18

prepend extension configs with file loaders

6ffd706

yceruto force-pushed the prepend_extension_config branch from 4d731be to 6ffd706 Compare March 25, 2024 20:45

yceruto added the ❄️ Feature Freeze Important Pull Requests to finish before the next Symfony "feature freeze" label Apr 2, 2024

nicolas-grekas merged commit 4ce4e5e into symfony:7.1 Apr 3, 2024

nicolas-grekas mentioned this pull request Apr 3, 2024

[DependencyInjection] Prepending extension configs with file loaders symfony/symfony-docs#19735

Closed

OskarStark mentioned this pull request Apr 3, 2024

[DependencyInjection] Document BC break in UPGRADE file #54481

Merged

yceruto deleted the prepend_extension_config branch April 3, 2024 20:57

yceruto mentioned this pull request Apr 3, 2024

[DependencyInjection] Updating prepend extension capabilities symfony/symfony-docs#19738

Merged

fabpot mentioned this pull request May 2, 2024

Release v7.1.0-BETA1 #54820

Merged

yceruto mentioned this pull request May 4, 2024

The configuration of packages in the application is ignored after they are applied inside prependExtension the bundle #54840

Closed

michaljusiega mentioned this pull request May 7, 2024

[Config] ParamConfigurator is not longer respected as scalar-string-value #54852

Closed

This was referenced May 17, 2024

[DependencyInjection] Expected scalar, but got ParamConfigurator (or EnvConfigurator) #54965

Closed

[DependencyInjection] Process PHP configs using the ContainerConfigurator #54970

Merged

yceruto mentioned this pull request Aug 6, 2024

[DependencyInjection] Fix importing PHP configs in the prepend extension method #57937

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DependencyInjection] Prepending extension configs with file loaders #52843

[DependencyInjection] Prepending extension configs with file loaders #52843

yceruto commented Dec 1, 2023 •

edited

Loading

nicolas-grekas left a comment

yceruto commented Dec 1, 2023

yceruto commented Dec 1, 2023 •

edited

Loading

nicolas-grekas commented Dec 4, 2023

yceruto commented Dec 4, 2023

nicolas-grekas left a comment

yceruto commented Jan 2, 2024

yceruto commented Jan 14, 2024 •

edited

Loading

yceruto commented Mar 16, 2024

nicolas-grekas left a comment

nicolas-grekas commented Mar 25, 2024

nicolas-grekas commented Apr 3, 2024

[DependencyInjection] Prepending extension configs with file loaders #52843

[DependencyInjection] Prepending extension configs with file loaders #52843

Conversation

yceruto commented Dec 1, 2023 • edited Loading

nicolas-grekas left a comment

Choose a reason for hiding this comment

yceruto commented Dec 1, 2023

yceruto commented Dec 1, 2023 • edited Loading

nicolas-grekas commented Dec 4, 2023

yceruto commented Dec 4, 2023

nicolas-grekas left a comment

Choose a reason for hiding this comment

yceruto commented Jan 2, 2024

yceruto commented Jan 14, 2024 • edited Loading

yceruto commented Mar 16, 2024

nicolas-grekas left a comment

Choose a reason for hiding this comment

nicolas-grekas commented Mar 25, 2024

nicolas-grekas commented Apr 3, 2024

yceruto commented Dec 1, 2023 •

edited

Loading

yceruto commented Dec 1, 2023 •

edited

Loading

yceruto commented Jan 14, 2024 •

edited

Loading