[DependencyInjection] Fix a limitation of the PhpDumper #18167

GuilhemN · 2016-03-14T19:29:04Z

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	yes
Tests pass?	yes
Fixed tickets	#17801
License	MIT
Doc PR

The PhpDumper cannot currently dump several services' id containing characters unsupported by php.
This PR tries to solve this issue by removing the unsupported characters and by sufixing their camelized association to avoid conflicts.

javiereguiluz · 2016-03-14T19:31:04Z

I'm afraid that @xabbuh is already trying to fix this issue in #18028. Maybe you can join forces?

GuilhemN · 2016-03-14T19:36:38Z

@javiereguiluz yeah I know but as @stof said #18028 (comment), @xabbuh can't use a black list without this :-/

javiereguiluz · 2016-03-14T19:39:05Z

src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php

        $name = Container::camelize($id);
+        $finalName = $name = preg_replace('/[^a-zA-Z0-9_\x7f-\xff]/', '', $name);


I'd rename $finalName to $uniqueName

GuilhemN · 2016-03-14T19:41:37Z

Thank you @javiereguiluz, I fixed your comments

javiereguiluz · 2016-03-15T08:14:47Z

src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php

@@ -58,6 +58,7 @@ class PhpDumper extends Dumper
    private $targetDirRegex;
    private $targetDirMaxMatches;
    private $docStar;
+    private $existingNames = array();


Sorry for bothering you again about this ... but after looking at the code with more calm, I think the "right" name for this variable would be $serviceNames instead of $existingNames. Thanks!

No problem ;-)
Would you prefer $serviceIdToMethodNameMap as proposed by @xabbuh ?

It seems to describe the purpose of the variable with absolute precision, so it's probably a good idea to make that change ... and, after that change, it's probably a good idea to change $uniqueName to $methodName or $serviceMethodName too.

makes sense, changed

xabbuh · 2016-03-15T08:28:46Z

Thanks for taking care of this @Ener-Getick! I like the approach in general and just left some suggestions to improve it a bit.

stof · 2016-03-16T15:29:49Z

src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php

@@ -1349,13 +1351,22 @@ private function getServiceCall($id, Reference $reference = null)
     */
    private function camelize($id)


this private method should be renamed though, as it is not about camelizing anymore, but about generating the method name

stof · 2016-03-16T15:33:50Z

there is a another nice side-effect of this PR: Container::camelize can generate the same output for several service ids (due to method name being case insensitive), so this could allow fixing this case too

stof · 2016-03-16T15:37:20Z

src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php

        }
+        $this->serviceIdToMethodNameMap[$id] = $methodName;
+        $this->usedMethodNames[$methodName] = true;


method names must be considered as case insensitive in this array, as PHP treats them this way. Otherwise you will still generated conflicting names

GuilhemN · 2016-03-16T16:59:39Z

Status: Needs Review

GuilhemN · 2016-03-16T17:49:02Z

I updated the ProxyDumper as the method name was hardcoded.

xabbuh · 2016-03-16T17:49:57Z

src/Symfony/Bridge/ProxyManager/LazyProxy/PhpDumper/ProxyDumper.php

@@ -63,7 +63,7 @@ public function isProxyCandidate(Definition $definition)
    /**
     * {@inheritdoc}
     */
-    public function getProxyFactoryCode(Definition $definition, $id)
+    public function getProxyFactoryCode(Definition $definition, $id, $methodName = null)


Adding an argument here is a BC break.

even if it is optional ?

yes: https://3v4l.org/p726n

I thought this was allowed... Do you have an idea how to make it work otherwise ?

As child classes are allowed to add additional arguments (see https://3v4l.org/CmOt2) you could use func_num_args() and func_get_arg() to create a forward compatible layer.

well... you could do play with func_get_args and func_num_args : https://github.com/symfony/validator/blob/2.8/Validator/RecursiveValidator.php#L118 it isn't pretty though...

Maybe a cleaner solution would be to add a new method getMethodFor($id) in the compiled container. WDYT ?

Edit: after all, that's much more complicated so I did it with your method thank you @xabbuh @Taluu

fabpot · 2016-03-31T10:04:36Z

👍

stof · 2016-03-31T10:44:49Z

src/Symfony/Bridge/ProxyManager/LazyProxy/PhpDumper/ProxyDumper.php

@@ -71,7 +71,12 @@ public function getProxyFactoryCode(Definition $definition, $id)
            $instantiation .= " \$this->services['$id'] =";
        }

-        $methodName = 'get'.Container::camelize($id).'Service';
+        if (func_num_args() >= 3) {
+            $methodName = func_get_arg(2);


this could be written by adding $methodName = null in the signature of the method, and checking for null.

hmm, actually no. It would break BC for people extending the class. so forget it.

stof · 2016-03-31T10:46:52Z

👍

Status: reviewed

xabbuh · 2016-03-31T11:55:19Z

👍

GuilhemN · 2016-03-31T14:17:19Z

@trousers this issues aren't related to this PR as there were already present.

fabpot · 2016-04-01T06:52:37Z

Thank you @Ener-Getick.

carsonbot added the Status: Needs Review label Mar 14, 2016

GuilhemN force-pushed the DUMPER branch from 9f45283 to f14d84f Compare March 14, 2016 19:38

javiereguiluz reviewed Mar 14, 2016
View reviewed changes

GuilhemN force-pushed the DUMPER branch from f14d84f to b9b81fe Compare March 14, 2016 19:40

GuilhemN mentioned this pull request Mar 14, 2016

[DependencyInjection] deprecate most characters in service ids #18028

Closed

javiereguiluz reviewed Mar 15, 2016
View reviewed changes

javiereguiluz added DependencyInjection Feature labels Mar 15, 2016

nicolas-grekas added Status: Needs Work and removed Status: Needs Review labels Mar 15, 2016

GuilhemN force-pushed the DUMPER branch from 1aa4798 to c4cb879 Compare March 15, 2016 16:59

stof reviewed Mar 16, 2016
View reviewed changes

GuilhemN added 4 commits March 16, 2016 17:32

[DependencyInjection] Fix a limitation of the PhpDumper

b92439f

Improve performance

67dcb92

[PhpDumper] Fix method names conflicts

ae85387

Fix method conflicts with parent class

5efed7b

GuilhemN force-pushed the DUMPER branch from f901af6 to 5efed7b Compare March 16, 2016 16:32

carsonbot added Status: Needs Review and removed Status: Needs Work labels Mar 16, 2016

xabbuh reviewed Mar 16, 2016
View reviewed changes

GuilhemN force-pushed the DUMPER branch from 82fc826 to 69520c4 Compare March 16, 2016 18:28

Fix the lazy PhpDumper

795399a

GuilhemN force-pushed the DUMPER branch from 69520c4 to 795399a Compare March 16, 2016 18:50

stof reviewed Mar 31, 2016
View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Mar 31, 2016

fabpot closed this in 35be993 Apr 1, 2016

stof mentioned this pull request Apr 8, 2016

Prevent service names from including characters not supported by the dumper #17801

Closed

fabpot mentioned this pull request May 13, 2016

Release v3.1.0-BETA1 #18776

Merged

marcoalbarelli mentioned this pull request May 24, 2016

[DependencyInjection] Improved the validation of the service names for XML files #18855

Closed

GuilhemN deleted the DUMPER branch June 6, 2016 18:51

GuilhemN mentioned this pull request May 26, 2017

[DI] Remove deprecated case insensitive service ids #22811

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DependencyInjection] Fix a limitation of the PhpDumper #18167

[DependencyInjection] Fix a limitation of the PhpDumper #18167

GuilhemN commented Mar 14, 2016

javiereguiluz commented Mar 14, 2016

GuilhemN commented Mar 14, 2016

javiereguiluz Mar 14, 2016

GuilhemN commented Mar 14, 2016

javiereguiluz Mar 15, 2016

GuilhemN Mar 15, 2016

javiereguiluz Mar 15, 2016

GuilhemN Mar 15, 2016

xabbuh commented Mar 15, 2016

stof Mar 16, 2016

stof commented Mar 16, 2016

stof Mar 16, 2016

GuilhemN commented Mar 16, 2016

GuilhemN commented Mar 16, 2016

xabbuh Mar 16, 2016

GuilhemN Mar 16, 2016

xabbuh Mar 16, 2016

GuilhemN Mar 16, 2016

xabbuh Mar 16, 2016

Taluu Mar 16, 2016

GuilhemN Mar 16, 2016

fabpot commented Mar 31, 2016

stof Mar 31, 2016

stof Mar 31, 2016

stof commented Mar 31, 2016

xabbuh commented Mar 31, 2016

GuilhemN commented Mar 31, 2016

fabpot commented Apr 1, 2016

		$name = Container::camelize($id);
		$finalName = $name = preg_replace('/[^a-zA-Z0-9_\x7f-\xff]/', '', $name);

		@@ -1349,13 +1351,22 @@ private function getServiceCall($id, Reference $reference = null)
		*/
		private function camelize($id)

[DependencyInjection] Fix a limitation of the PhpDumper #18167

[DependencyInjection] Fix a limitation of the PhpDumper #18167

Conversation

GuilhemN commented Mar 14, 2016

javiereguiluz commented Mar 14, 2016

GuilhemN commented Mar 14, 2016

Choose a reason for hiding this comment

GuilhemN commented Mar 14, 2016

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

xabbuh commented Mar 15, 2016

Choose a reason for hiding this comment

stof commented Mar 16, 2016

Choose a reason for hiding this comment

GuilhemN commented Mar 16, 2016

GuilhemN commented Mar 16, 2016

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabpot commented Mar 31, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stof commented Mar 31, 2016

xabbuh commented Mar 31, 2016

GuilhemN commented Mar 31, 2016

fabpot commented Apr 1, 2016