[Routing][Config] Allow patterns of resources to be excluded from config loading #31587

tristanbes · 2019-05-22T16:02:33Z

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

The PR will fix the following RFC: #31516

Like resource loading for services, this PR offers a way to exclude patterns of resources like:

// config/routes/annotations.yaml
controllers:
    resource: ../../src/Controller/*
    type: annotation
    exclude: '../src/Controller/{DebugEmailController}.php'

All the annotation routes inside Controller/ will be loaded in this example except all the one present inside the Controller/DebugEmailController.php

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

vudaltsov · 2019-05-24T14:06:41Z

If you change FileLoader in the Config component, you should test the new behavior in the Config component in the first place.

vudaltsov · 2019-05-27T13:03:49Z

Deprecations for 4.4 must be described in UPGRADE-4.4.md (create if it does not exist), BC breaks must be mentioned in UPGRADE-5.0.md. Duplicate this info in src/Symfony/Component/Config/CHANGELOG.md.

src/Symfony/Component/Config/CHANGELOG.md

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

UPGRADE-4.4.md

nicolas-grekas

what about RoutingConfigurator + XmlFileLoader?
also, do we want this in the DI component, where we also extend FileLoader?
rebase needed btw :)

UPGRADE-4.4.md

src/Symfony/Component/Config/CHANGELOG.md

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

src/Symfony/Component/Routing/Loader/YamlFileLoader.php

tristanbes · 2019-07-31T11:45:16Z

@nicolas-grekas I've just added the modifications for the RoutingConfigurator are the modifications correct ?

Also, I didn't find any BC rules reguarding a final method inside a non final class, so i'm not sure the $exclude parameter should be retrieved using fun_get_arg.

nicolas-grekas · 2019-07-31T12:20:37Z

Yes, you can change a final method, no need for the func_get_arg trick

nicolas-grekas · 2019-07-31T12:24:04Z

we can bc break a final function

No, we can't. This is not a BC break, that's why this change is OK :)

nicolas-grekas

I took over the PR and finished the implementation. fabbot failure is a false-positive

tristanbes · 2019-09-30T08:14:03Z

@nicolas-grekas Great, thank you; I just learnt that we're 1 week away from feature freeze ;)

tristanbes · 2019-10-10T17:22:36Z

is there anything missing to get this PR merged ?

…fig loading

tristanbes · 2019-10-24T11:57:48Z

I solved the conflicts on the PR. @fabpot is this PR good to merge ?

nicolas-grekas · 2019-11-04T10:53:34Z

Thank you @tristanbes.

…cluded from config loading (tristanbes) This PR was merged into the 4.4 branch. Discussion ---------- [Routing][Config] Allow patterns of resources to be excluded from config loading | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | #31516 | License | MIT | Doc PR | not yet The PR will fix the following RFC: #31516 Like resource loading for services, this PR offers a way to exclude patterns of resources like: ```yml // config/routes/annotations.yaml controllers: resource: ../../src/Controller/* type: annotation exclude: '../src/Controller/{DebugEmailController}.php' ``` All the annotation routes inside `Controller/` will be loaded in this example except all the one present inside the `Controller/DebugEmailController.php` Commits ------- 332ff88 [Routing][Config] Allow patterns of resources to be excluded from config loading

gharlan · 2020-02-11T17:37:49Z

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

        if (\is_string($resource) && \strlen($resource) !== $i = strcspn($resource, '*?{[')) {
+            $excluded = [];


Is it expected, that exclude is only handled when the resource contains glob patterns (*?{[)?
exclude does not have any effect when using a directory as resource, like in default recipe:
https://github.com/symfony/recipes/blob/b364e60751fba4fc5da103304c1f61259d370e10/doctrine/annotations/1.0/config/routes/annotations.yaml#L2

I stumbled upon the same issue and it cost me quite a lot of time to figure it out !

I do not believe this is working as intended, as it's different from what the documentation says.

To get my exclude to work, I had to change my resource too (add *):

controllers: resource: '../../src/Controller' exclude: '../../src/Controller/Backoffice/{HomepageController}.php'

does NOT work (HomepageController is not excluded)..

controllers: resource: '../../src/Controller/*' exclude: '../../src/Controller/Backoffice/{HomepageController}.php'

does work, the HomepageController is correctly excluded.

Without the *, the condition is not satisfied and the exclude is ignored totally, which makes no sense.

Should we open a new issue for this, @tristanbes ?

Thx @gharlan and @Growiel I stumbled upon this strange behaviour today and thanks to your hints I did not have to spend too much time debugging this :) Did you open an issue for this though?

Hello, I guess you should open an issue if you think it's a bug or if this case should be handled

It is indeed a bug. Do you need a new issue or handle it here ?

Please create a new issue. Comments on already merged pull requests are likely to get lost.

carsonbot added Status: Needs Review Routing Feature labels May 22, 2019

nicolas-grekas added this to the next milestone May 22, 2019

vudaltsov suggested changes May 24, 2019

View reviewed changes

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

carsonbot added Status: Needs Work and removed Status: Needs Review labels May 24, 2019

vudaltsov reviewed May 27, 2019

View reviewed changes

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

vudaltsov reviewed May 27, 2019

View reviewed changes

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

tristanbes marked this pull request as ready for review May 27, 2019 14:47

tristanbes force-pushed the feature/allow-exclude-controllers branch from fe50d64 to 3ffd4ee Compare May 27, 2019 15:19

tristanbes changed the title ~~[routing] Exclude patterns of resources to be excluded from route loading~~ [routing][config] Allow patterns of resources to be excluded from config loading May 27, 2019

nicolas-grekas changed the base branch from master to 4.4 June 2, 2019 20:12

nicolas-grekas reviewed Jun 6, 2019

View reviewed changes

UPGRADE-4.4.md Outdated Show resolved Hide resolved

tristanbes force-pushed the feature/allow-exclude-controllers branch 2 times, most recently from 3ffd4ee to af14114 Compare June 6, 2019 16:33

nicolas-grekas requested changes Jul 30, 2019

View reviewed changes

tristanbes force-pushed the feature/allow-exclude-controllers branch from af14114 to c15a7fe Compare July 31, 2019 11:23

tristanbes force-pushed the feature/allow-exclude-controllers branch from ce09b71 to 96579e8 Compare July 31, 2019 12:25

nicolas-grekas changed the title ~~[routing][config] Allow patterns of resources to be excluded from config loading~~ [Routing][Config] Allow patterns of resources to be excluded from config loading Sep 27, 2019

nicolas-grekas force-pushed the feature/allow-exclude-controllers branch from 96579e8 to c21f67b Compare September 27, 2019 18:53

nicolas-grekas approved these changes Sep 27, 2019

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Work labels Sep 27, 2019

javiereguiluz approved these changes Oct 14, 2019

View reviewed changes

[Routing][Config] Allow patterns of resources to be excluded from con…

332ff88

…fig loading

tristanbes force-pushed the feature/allow-exclude-controllers branch from c21f67b to 332ff88 Compare October 24, 2019 11:56

nicolas-grekas modified the milestones: next, 4.4 Oct 27, 2019

nicolas-grekas mentioned this pull request Nov 4, 2019

[Routing][Config] Allow patterns of resources to be excluded from confi… symfony/symfony-docs#12590

Closed

nicolas-grekas merged commit 332ff88 into symfony:4.4 Nov 4, 2019

tristanbes deleted the feature/allow-exclude-controllers branch November 4, 2019 12:36

This was referenced Nov 12, 2019

Release v4.4.0-BETA1 #34338

Merged

Release v5.0.0-BETA1 #34339

Merged

gharlan reviewed Feb 11, 2020

View reviewed changes

Pixelshaped mentioned this pull request Mar 2, 2021

Localized route prefixes behavior induces duplicate content and local switching issues #40344

Closed

camilleterol mentioned this pull request Jan 29, 2022

Document the exclude parameter symfony/symfony-docs#16456

Closed

HypeMC mentioned this pull request Mar 10, 2024

All resource exclude paths are completely ignored #54212

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Routing][Config] Allow patterns of resources to be excluded from config loading #31587

[Routing][Config] Allow patterns of resources to be excluded from config loading #31587

tristanbes commented May 22, 2019 •

edited

Loading

vudaltsov commented May 24, 2019

vudaltsov commented May 27, 2019

nicolas-grekas left a comment

tristanbes commented Jul 31, 2019

nicolas-grekas commented Jul 31, 2019

nicolas-grekas commented Jul 31, 2019

nicolas-grekas left a comment

tristanbes commented Sep 30, 2019

tristanbes commented Oct 10, 2019

tristanbes commented Oct 24, 2019

nicolas-grekas commented Nov 4, 2019

gharlan Feb 11, 2020 •

edited

Loading

Growiel Jun 10, 2020 •

edited

Loading

elkangaroo Aug 3, 2020

tristanbes Aug 3, 2020

Growiel Aug 3, 2020

xabbuh Aug 3, 2020

		if (\is_string($resource) && \strlen($resource) !== $i = strcspn($resource, '*?{[')) {
		$excluded = [];

[Routing][Config] Allow patterns of resources to be excluded from config loading #31587

[Routing][Config] Allow patterns of resources to be excluded from config loading #31587

Conversation

tristanbes commented May 22, 2019 • edited Loading

vudaltsov commented May 24, 2019

vudaltsov commented May 27, 2019

nicolas-grekas left a comment

Choose a reason for hiding this comment

tristanbes commented Jul 31, 2019

nicolas-grekas commented Jul 31, 2019

nicolas-grekas commented Jul 31, 2019

nicolas-grekas left a comment

Choose a reason for hiding this comment

tristanbes commented Sep 30, 2019

tristanbes commented Oct 10, 2019

tristanbes commented Oct 24, 2019

nicolas-grekas commented Nov 4, 2019

gharlan Feb 11, 2020 • edited Loading

Choose a reason for hiding this comment

Growiel Jun 10, 2020 • edited Loading

Choose a reason for hiding this comment

elkangaroo Aug 3, 2020

Choose a reason for hiding this comment

tristanbes Aug 3, 2020

Choose a reason for hiding this comment

Growiel Aug 3, 2020

Choose a reason for hiding this comment

xabbuh Aug 3, 2020

Choose a reason for hiding this comment

tristanbes commented May 22, 2019 •

edited

Loading

gharlan Feb 11, 2020 •

edited

Loading

Growiel Jun 10, 2020 •

edited

Loading