Merge branch 'feature/#112-#113-improve-set-alias-and-set-factory-performance' into develop

Close #113

Author: Ocramius

CHANGELOG.md

@@ -11,6 +11,9 @@ All notable changes to this project will be documented in this file, in reverse
   `zendframework/zend-servicemanager`.
 - [#103](https://github.com/zendframework/zend-servicemanager/pull/103) Disallowing
   test failures when running tests against PHP `7.0.*`.
+- [#103](https://github.com/zendframework/zend-servicemanager/pull/103) Improved performance
+  when dealing with registering aliases and factories via `ServiceManager#setFactory()` and
+  `ServiceManager#setAlias()`
 
 ### Deprecated
 

benchmarks/SetNewServicesBench.php

@@ -0,0 +1,77 @@
+<?php
+
+namespace ZendBench\ServiceManager;
+
+use PhpBench\Benchmark\Metadata\Annotations\Iterations;
+use PhpBench\Benchmark\Metadata\Annotations\Revs;
+use PhpBench\Benchmark\Metadata\Annotations\Warmup;
+use Zend\ServiceManager\ServiceManager;
+
+/**
+ * @Revs(1000)
+ * @Iterations(10)
+ * @Warmup(2)
+ */
+class SetNewServicesBench
+{
+    const NUM_SERVICES = 100;
+
+    /**
+     * @var ServiceManager
+     */
+    private $sm;
+
+    public function __construct()
+    {
+        $config = [
+            'factories'          => [
+                'factory1' => BenchAsset\FactoryFoo::class,
+            ],
+            'invokables'         => [
+                'invokable1' => BenchAsset\Foo::class,
+            ],
+            'services'           => [
+                'service1' => new \stdClass(),
+            ],
+            'aliases'            => [
+                'factoryAlias1'          => 'factory1',
+                'recursiveFactoryAlias1' => 'factoryAlias1',
+                'recursiveFactoryAlias2' => 'recursiveFactoryAlias1',
+            ],
+            'abstract_factories' => [
+                BenchAsset\AbstractFactoryFoo::class
+            ],
+        ];
+
+        for ($i = 0; $i <= self::NUM_SERVICES; $i++) {
+            $config['factories']["factory_$i"] = BenchAsset\FactoryFoo::class;
+            $config['aliases']["alias_$i"]     = "service_$i";
+        }
+
+        $this->sm = new ServiceManager($config);
+    }
+
+    public function benchSetFactory()
+    {
+        // @todo @link https://github.com/phpbench/phpbench/issues/304
+        $sm = clone $this->sm;
+
+        $sm->setFactory('factory2', BenchAsset\FactoryFoo::class);
+    }
+
+    public function benchSetAlias()
+    {
+        // @todo @link https://github.com/phpbench/phpbench/issues/304
+        $sm = clone $this->sm;
+
+        $sm->setAlias('factoryAlias2', 'factory1');
+    }
+
+    public function benchSetAliasOverrided()
+    {
+        // @todo @link https://github.com/phpbench/phpbench/issues/304
+        $sm = clone $this->sm;
+
+        $sm->setAlias('recursiveFactoryAlias1', 'factory1');
+    }
+}

src/ServiceManager.php

@@ -343,10 +343,8 @@ public function configure(array $config)
         }
 
         if (isset($config['aliases'])) {
-            $this->aliases = $config['aliases'] + $this->aliases;
-        }
-
-        if (! empty($this->aliases)) {
+            $this->configureAliases($config['aliases']);
+        } elseif (! $this->configured && ! empty($this->aliases)) {
             $this->resolveAliases($this->aliases);
         }
 
@@ -376,6 +374,35 @@ public function configure(array $config)
         return $this;
     }
 
+    /**
+     * @param string[] $aliases
+     *
+     * @return void
+     */
+    private function configureAliases(array $aliases)
+    {
+        if (! $this->configured) {
+            $this->aliases = $aliases + $this->aliases;
+
+            $this->resolveAliases($this->aliases);
+
+            return;
+        }
+
+        // Performance optimization. If there are no collisions, then we don't need to recompute loops
+        $intersecting  = $this->aliases && \array_intersect_key($this->aliases, $aliases);
+        $this->aliases = $this->aliases ? \array_merge($this->aliases, $aliases) : $aliases;
+
+        if ($intersecting) {
+            $this->resolveAliases($this->aliases);
+
+            return;
+        }
+
+        $this->resolveAliases($aliases);
+        $this->resolveNewAliasesWithPreviouslyResolvedAliases($aliases);
+    }
+
     /**
      * Add an alias.
      *
@@ -570,7 +597,11 @@ private function resolveInitializers(array $initializers)
     }
 
     /**
-     * Resolve all aliases to their canonical service names.
+     * Resolve aliases to their canonical service names.
+     *
+     * @param string[] $aliases
+     *
+     * @returns void
      */
     private function resolveAliases(array $aliases)
     {
@@ -591,6 +622,23 @@ private function resolveAliases(array $aliases)
         }
     }
 
+    /**
+     * Rewrites the map of aliases by resolving the given $aliases with the existing resolved ones.
+     * This is mostly done for performance reasons.
+     *
+     * @param string[] $aliases
+     *
+     * @return void
+     */
+    private function resolveNewAliasesWithPreviouslyResolvedAliases(array $aliases)
+    {
+        foreach ($this->resolvedAliases as $name => $target) {
+            if (isset($aliases[$target])) {
+                $this->resolvedAliases[$name] = $this->resolvedAliases[$target];
+            }
+        }
+    }
+
     /**
      * Get a factory for the given service name
      *

test/ServiceManagerTest.php

@@ -236,4 +236,29 @@ public function testAliasToAnExplicitServiceShouldWork()
 
         $this->assertSame($service, $alias);
     }
+
+    /**
+     * @depends testAliasToAnExplicitServiceShouldWork
+     */
+    public function testSetAliasShouldWorkWithRecursiveAlias()
+    {
+        $config = [
+            'aliases' => [
+                'Alias' => 'TailInvokable',
+            ],
+            'services' => [
+                InvokableObject::class => new InvokableObject(),
+            ],
+        ];
+        $serviceManager = new ServiceManager($config);
+        $serviceManager->setAlias('HeadAlias', 'Alias');
+        $serviceManager->setAlias('TailInvokable', InvokableObject::class);
+
+        $service   = $serviceManager->get(InvokableObject::class);
+        $alias     = $serviceManager->get('Alias');
+        $headAlias = $serviceManager->get('HeadAlias');
+
+        $this->assertSame($service, $alias);
+        $this->assertSame($service, $headAlias);
+    }
 }