Optimize ReplaceAliasByActualDefinitionPass #18265

ajb-in · 2016-03-22T13:56:44Z

Q	A
Branch?	2.3
Bug fix?	yes (performance)
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	-
License	MIT
Doc PR	-

Previous implementation passed over every definition for every alias (n*m runtime).
New implementation passes once over all aliases and once over all definitions (n+m).
Also removing needless "restart" logic.

ajb-in · 2016-03-22T14:02:09Z

Note: patch applies to master with minor modification (tested).

lstrojny · 2016-03-22T14:18:49Z

Improves container dump times from ~40s to ~16s in real world applications.

GuilhemN · 2016-03-22T14:40:55Z

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

        }

        return $arguments;
    }

-    private function updateFactoryServiceReference($factoryService, $currentId, $newId)
+    private function updateFactoryReferenceId($replacements, $referenceId)


What about adding a doc block here?

GuilhemN · 2016-03-22T15:13:55Z

This looks great 👍
Thank you @ajb-in 😄

ajb-in · 2016-03-22T15:17:02Z

Thanks @Ener-Getick ^_^

stof · 2016-03-22T15:58:09Z

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

            $aliasId = (string) $alias;
-
+            if (isset($replacements[$aliasId])) {
+                $container->setAlias($defId, $replacements[$aliasId]);


This must respect the visibility of the existing alias (allowing it to be removed in case of a private alias not being referenced anywhere anymore after other optimizations)

I tried to stick to the original behaviour, namely: remove the definition of the target, point the alias to the definition, and point every subsequent alias with the same target to the first alias.

ajb-in · 2016-03-23T13:22:19Z

@stof re chains: I played with the existing testcase for 2.3 to see what happens with chained aliases. I ran this code:

    $container = new ContainerBuilder();

    $aDefinition = $container->register('a', '\stdClass');
    $aDefinition->setFactory(array(new Reference('b'), 'createA'));

    $bDefinition = new Definition('\stdClass');
    $bDefinition->setPublic(false);
    $container->setDefinition('b', $bDefinition);

    $container->setAlias('a_alias', 'a');
    $container->setAlias('b_alias', 'b');

    // I added these three lines:
    $container->setAlias('c_alias', 'b');
    $container->setAlias('d_alias', 'c_alias');
    $container->setAlias('e_alias', 'd_alias');

    $this->process($container);

and it 'sploded on 2.3:

There was 1 error:
1) Symfony\Component\DependencyInjection\Tests\Compiler\ReplaceAliasByActualDefinitionPassTest::testProcess
Symfony\Component\DependencyInjection\Exception\InvalidArgumentException: Unable to replace alias "d_alias" with actual definition "c_alias".
/code/symfony/src/Symfony/Component/DependencyInjection/Compiler/ReplaceAliasByActualDefinitionPass.php:48
/code/symfony/src/Symfony/Component/DependencyInjection/Compiler/ReplaceAliasByActualDefinitionPass.php:63
/code/symfony/src/Symfony/Component/DependencyInjection/Tests/Compiler/ReplaceAliasByActualDefinitionPassTest.php:69
/code/symfony/src/Symfony/Component/DependencyInjection/Tests/Compiler/ReplaceAliasByActualDefinitionPassTest.php:40
Caused by
Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException: You have requested a non-existent service "c_alias".

ajb-in · 2016-03-23T13:28:19Z

It explodes also if I change the extra part to this:

    // I added these two lines:
    $container->setAlias('c_alias', 'b_alias');
    $container->setAlias('d_alias', 'c_alias');

tadcka · 2016-03-23T20:59:48Z

👍

egils · 2016-03-23T21:04:58Z

Lovely! 👍

xabbuh · 2016-03-25T11:58:12Z

@ajb-in Aliases that refer to other aliases should have been resolved in the ResolveReferencesToAliasesPass which is run before the ReplaceAliasByActualDefinitionPass.

Tobion · 2016-03-27T00:28:26Z

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

+     *
+     * @return string
+     */
+    private function updateFactoryReferenceId($replacements, $referenceId)


missing typehint array for $replacements

Tobion · 2016-03-27T00:46:14Z

👍 apart from those small doc fixes.

GuilhemN · 2016-03-27T10:45:54Z

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

-
+        $seenAliasTargets = array();
+        $replacements = array();
+        foreach ($container->getAliases() as $definitionID => $target) {


should be $definitionId as $targetId is used later

id is upper-cased (ID instead of Id), i think it should be changed for consistency.

i see, true

GuilhemN · 2016-03-27T10:47:44Z

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

            } catch (InvalidArgumentException $e) {
-                throw new InvalidArgumentException(sprintf('Unable to replace alias "%s" with actual definition "%s".', $id, $alias), null, $e);
+                throw new InvalidArgumentException(sprintf('Unable to replace alias "%s" with actual definition "%s".', $definitionID, $target), null, $e);


why not using $targetId here?

No idea :3 That's what the old code was doing though (using $alias instead of $aliasId). I'll change it.

ajb-in · 2016-03-27T11:39:37Z

@Tobion @Ener-Getick Did doc and variable name fixes; looks better?

ajb-in · 2016-03-27T11:40:38Z

@xabbuh @stof Then this pass doesn't need to be concerned with chains whatsoever, right?

fabpot · 2016-03-27T12:56:08Z

As this is not a bug fix, it should be merged in master, not 2.3

ajb-in · 2016-03-27T13:00:59Z

@fabpot When I asked in #symfony I was told that it could count as a performance bug, so that's why I went with 2.3; @javiereguiluz seemed to agree since he labeled this PR as 'bug'.
I'll rebase it onto master if needed, of course.

fabpot · 2016-03-27T13:05:21Z

Sorry about the confusion. It's true that we've been more willing to merge PRs that do not strictly fix bugs in maintained branches (and I probably merged some myself), but I think this is a mistake. First, we want old branches to be as stable as possible, and merging non-bug fixes can introduce subtle regressions (happened in the past). Then, improving performance in new versions is a great incentive for people to upgrade, which is always a good idea.

/cc @symfony/deciders

Tobion · 2016-03-28T19:23:41Z

I'd prefer to merge refactorings like this one in maitainance branches as it will make maintaining branches easier when they are more similar and do not diverge that much just because of refactorings.

Tobion · 2016-03-28T19:26:45Z

And introducing suble behavior changes should not be an argument. It just means we do not have enough tests (or it's really an edge case that wasn't meant to be like this). E.g. the refactoring in the templating parser actually revealed that people use absolute paths that wasn't intended that way.

fabpot · 2016-03-30T14:40:21Z

@ajb-in Can you rebase on current 2.3? Thanks.

weaverryan · 2016-03-30T15:42:35Z

In general, I'd prefer things like this to be merged into master. If this causes a subtle behavior change that isn't caught by our tests, that should be our problem, not a problem that is discovered by users in a patch update. We need users to have very high confidence in upgrading patch versions (otherwise, they may stay on insecure versions!)

But it's not black and white - a performance issue could be a bug, so we can do anything here.

ajb-in · 2016-03-31T08:55:26Z

Rebased on latest 2.3; also squashed, added a comment, and added a plug to this review on the commit message :3

fabpot · 2016-03-31T09:08:46Z

@ajb-in Can you remove the reference in the commit message? We already have everything in place to automatically get that in Git notes.

ajb-in · 2016-03-31T09:21:55Z

@fabpot Done; just wanted to give some due credit :3

fabpot · 2016-03-31T09:27:52Z

Tests are broken apparently.

Previous implementation passed over every alias and every definition, for every alias (n*(n+m) runtime). New implementation passes once over all aliases and once over all definitions (n+m). Also removing needless "restart" logic --- it has no real effect in either case.

ajb-in · 2016-03-31T09:30:52Z

@fabpot I forgot to rename a variable =P
Fixed it now

fabpot · 2016-03-31T09:37:15Z

Thank you @ajb-in.

This PR was merged into the 2.3 branch. Discussion ---------- Optimize ReplaceAliasByActualDefinitionPass | Q | A | ------------- | --- | Branch? | 2.3 | Bug fix? | yes (performance) | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Previous implementation passed over every definition for every alias (n*m runtime). New implementation passes once over all aliases and once over all definitions (n+m). Also removing needless "restart" logic. Commits ------- ab8dc0c Optimize ReplaceAliasByActualDefinitionPass

ajb-in · 2016-03-31T09:39:21Z

🍻 Thanks to everyone!

* Test were broken because of this PR introduced in symfony 2.3: symfony/symfony#18265 * We were passing an object instead of a string.

* Tests were broken because of this PR introduced in symfony 2.3: symfony/symfony#18265 * We were passing an object instead of a string.

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

javiereguiluz added DependencyInjection Bug labels Mar 22, 2016

GuilhemN reviewed Mar 22, 2016
View reviewed changes

stof reviewed Mar 22, 2016
View reviewed changes

Tobion reviewed Mar 27, 2016
View reviewed changes

GuilhemN reviewed Mar 27, 2016
View reviewed changes

fabpot merged commit ab8dc0c into symfony:2.3 Mar 31, 2016

GuilhemN mentioned this pull request Apr 6, 2016

[DependencyInjection] deprecate most characters in service ids #18028

Closed

This was referenced Apr 29, 2016

Release v2.3.40 #18669

Merged

Release v2.7.12 #18670

Merged

Release v2.8.5 #18674

Merged

Release v3.0.5 #18697

Merged

solivier pushed a commit to solivier/FOSElasticaBundle that referenced this pull request May 18, 2016

Fix tests

91e12f1

* Test were broken because of this PR introduced in symfony 2.3: symfony/symfony#18265 * We were passing an object instead of a string.

solivier mentioned this pull request May 18, 2016

Fix tests FriendsOfSymfony/FOSElasticaBundle#1077

Merged

solivier added a commit to solivier/FOSElasticaBundle that referenced this pull request May 18, 2016

Fix tests

f8425d0

* Tests were broken because of this PR introduced in symfony 2.3: symfony/symfony#18265 * We were passing an object instead of a string.

tadcka mentioned this pull request Jun 17, 2016

Twig dependency oroinc/platform#447

Closed

Optimize ReplaceAliasByActualDefinitionPass #18265

Optimize ReplaceAliasByActualDefinitionPass #18265

Conversation

ajb-in commented Mar 22, 2016

ajb-in commented Mar 22, 2016

lstrojny commented Mar 22, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GuilhemN commented Mar 22, 2016

ajb-in commented Mar 22, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ajb-in commented Mar 23, 2016

ajb-in commented Mar 23, 2016

tadcka commented Mar 23, 2016

egils commented Mar 23, 2016

xabbuh commented Mar 25, 2016

Choose a reason for hiding this comment

Tobion commented Mar 27, 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

ajb-in commented Mar 27, 2016

ajb-in commented Mar 27, 2016

fabpot commented Mar 27, 2016

ajb-in commented Mar 27, 2016

fabpot commented Mar 27, 2016

Tobion commented Mar 28, 2016

Tobion commented Mar 28, 2016

fabpot commented Mar 30, 2016

weaverryan commented Mar 30, 2016

ajb-in commented Mar 31, 2016

fabpot commented Mar 31, 2016

ajb-in commented Mar 31, 2016

fabpot commented Mar 31, 2016

ajb-in commented Mar 31, 2016

fabpot commented Mar 31, 2016

ajb-in commented Mar 31, 2016