Merge pull request symfony#11 from lolautruche/chainRouterSorting

dbu · dbu · commit 7d304078611d · 2012-07-03T23:25:34.000-07:00
Performance improvement: Ensures that routers sorting is being done only once in ChainRouter
diff --git a/ChainRouter.php b/ChainRouter.php
@@ -25,6 +25,11 @@ class ChainRouter implements RouterInterface, WarmableInterface
     private $context;
     private $logger;
 
+    /**
+     * @var \Symfony\Component\Routing\RouterInterface[] Array of routers, sorted by priority
+     */
+    protected $sortedRouters;
+
     public function __construct(LoggerInterface $logger = null)
     {
         $this->logger = $logger;
@@ -53,6 +58,7 @@ public function add(RouterInterface $router, $priority = 0)
         }
 
         $this->routers[$priority][] = $router;
+        $this->sortedRouters = array();
     }
 
     /**
@@ -62,14 +68,29 @@ public function add(RouterInterface $router, $priority = 0)
      */
     public function all()
     {
+        if (empty($this->sortedRouters)) {
+            $this->sortedRouters = $this->sortRouters();
+        }
+
+        return $this->sortedRouters;
+    }
+
+    /**
+     * Sort routers by priority.
+     * The highest priority number is the highest priority (reverse sorting)
+     *
+     * @return \Symfony\Component\Routing\RouterInterface[]
+     */
+    protected function sortRouters()
+    {
+        $sortedRouters = array();
         krsort($this->routers);
-        $routers = array();
 
-        foreach ($this->routers as $all) {
-            $routers = array_merge($routers, $all);
+        foreach ($this->routers as $routers) {
+            $sortedRouters = array_merge($sortedRouters, $routers);
         }
 
-        return $routers;
+        return $sortedRouters;
     }
 
     /**
diff --git a/Tests/Routing/ChainRouterTest.php b/Tests/Routing/ChainRouterTest.php
@@ -30,6 +30,81 @@ public function testPriority()
         ), $this->router->all());
     }
 
+    /**
+     * Routers are supposed to be sorted only once.
+     * This test will check that by trying to get all routers several times.
+     *
+     * @covers \Symfony\Cmf\Component\Routing\ChainRouter::sortRouters
+     * @covers \Symfony\Cmf\Component\Routing\ChainRouter::all
+     */
+    public function testSortRouters()
+    {
+        list($low, $medium, $high) = $this->createRouterMocks();
+        // We're using a mock here and not $this->router because we need to ensure that the sorting operation is done only once.
+        $router = $this->buildMock('Symfony\\Cmf\\Component\\Routing\\ChainRouter', array('sortRouters'));
+        $router
+            ->expects($this->once())
+            ->method('sortRouters')
+            ->will(
+                $this->returnValue(
+                    array($high, $medium, $low)
+                )
+            )
+        ;
+
+        $router->add($low, 10);
+        $router->add($medium, 50);
+        $router->add($high, 100);
+        $expectedSortedRouters = array($high, $medium, $low);
+        // Let's get all routers 5 times, we should only sort once.
+        for ($i = 0; $i < 5; ++$i) {
+            $this->assertSame($expectedSortedRouters, $router->all());
+        }
+    }
+
+    /**
+     * This test ensures that if a router is being added on the fly, the sorting is reset.
+     *
+     * @covers \Symfony\Cmf\Component\Routing\ChainRouter::sortRouters
+     * @covers \Symfony\Cmf\Component\Routing\ChainRouter::all
+     * @covers \Symfony\Cmf\Component\Routing\ChainRouter::add
+     */
+    public function testReSortRouters()
+    {
+        list($low, $medium, $high) = $this->createRouterMocks();
+        $highest = clone $high;
+        // We're using a mock here and not $this->router because we need to ensure that the sorting operation is done only once.
+        $router = $this->buildMock('Symfony\\Cmf\\Component\\Routing\\ChainRouter', array('sortRouters'));
+        $router
+            ->expects($this->at(0))
+            ->method('sortRouters')
+            ->will(
+                $this->returnValue(
+                    array($high, $medium, $low)
+                )
+            )
+        ;
+        // The second time sortRouters() is called, we're supposed to get the newly added router ($highest)
+        $router
+            ->expects($this->at(1))
+            ->method('sortRouters')
+            ->will(
+                $this->returnValue(
+                    array($highest, $high, $medium, $low)
+                )
+            )
+        ;
+
+        $router->add($low, 10);
+        $router->add($medium, 50);
+        $router->add($high, 100);
+        $this->assertSame(array($high, $medium, $low), $router->all());
+
+        // Now adding another router on the fly, sorting must have been reset
+        $router->add($highest, 101);
+        $this->assertSame(array($highest, $high, $medium, $low), $router->all());
+    }
+
     /**
      * context must be propagated to chained routers and be stored locally
      */
