Added caution alert when sorting criterion != priority

vjandrea · vjandrea · commit 49029ae2dc53 · 2020-07-11T08:49:14.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php
@@ -85,6 +85,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $container = $this->fileLinkFormatter ? \Closure::fromCallable([$this, 'getContainerBuilder']) : null;
         $sortOption = $input->getOption('sort');
         $routes = $this->sortRoutes($this->router->getRouteCollection(), $sortOption);
+        if ('priority' !== $sortOption) {
+            $io->caution('The routes list is not sorted in the parsing order.');
+        }
 
         if ($name) {
             if (!($route = $routes->get($name)) && $matchingRoutes = $this->findRouteNameContaining($name, $routes)) {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Command/RouterDebugCommandTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Command/RouterDebugCommandTest.php
@@ -21,6 +21,7 @@ public function testSortingByPriority()
         $result = $tester->execute(['--sort' => 'priority'], ['decorated' => false]);
         $this->assertSame(0, $result, 'Returns 0 in case of success');
         $this->assertRegExp('/(charlie).*\n\W*(alfa).*\n\W*(delta).*\n\W*(bravo)/m', $tester->getDisplay(true));
+        $this->assertStringNotContainsString('! [CAUTION] The routes list is not sorted in the parsing order.', $tester->getDisplay(true));
     }
 
     public function testSortingByName()
@@ -29,6 +30,7 @@ public function testSortingByName()
         $result = $tester->execute(['--sort' => 'name'], ['decorated' => false]);
         $this->assertSame(0, $result, 'Returns 0 in case of success');
         $this->assertRegExp('/(alfa).*\n\W*(bravo).*\n\W*(charlie).*\n\W*(delta)/m', $tester->getDisplay(true));
+        $this->assertStringContainsString('! [CAUTION] The routes list is not sorted in the parsing order.', $tester->getDisplay(true));
     }
 
     public function testSortingByPath()
@@ -37,6 +39,7 @@ public function testSortingByPath()
         $result = $tester->execute(['--sort' => 'path'], ['decorated' => false]);
         $this->assertSame(0, $result, 'Returns 0 in case of success');
         $this->assertRegExp('/(\/romeo).*\n.*(\/sierra).*\n.*(\/tango).*\n.*(\/uniform)/m', $tester->getDisplay(true));
+        $this->assertStringContainsString('! [CAUTION] The routes list is not sorted in the parsing order.', $tester->getDisplay(true));
     }
 
     public function testThrowsExceptionWithInvalidParameter()
@@ -59,6 +62,7 @@ public function testSortingByPriorityWithDuplicatePath()
         $result = $tester->execute(['--sort' => 'priority'], ['decorated' => false]);
         $this->assertSame(0, $result, 'Returns 0 in case of success');
         $this->assertRegExp('/(charlie).*\n\W*(alfa).*\n\W*(delta).*\n\W*(bravo).*\n\W*(echo)/m', $tester->getDisplay(true));
+        $this->assertStringNotContainsString('! [CAUTION] The routes list is not sorted in the parsing order.', $tester->getDisplay(true));
     }
 
     public function testSortingByNameWithDuplicatePath()
@@ -67,6 +71,7 @@ public function testSortingByNameWithDuplicatePath()
         $result = $tester->execute(['--sort' => 'name'], ['decorated' => false]);
         $this->assertSame(0, $result, 'Returns 0 in case of success');
         $this->assertRegExp('/(alfa).*\n\W*(bravo).*\n\W*(charlie).*\n\W*(delta).*\n\W*(echo)/m', $tester->getDisplay(true));
+        $this->assertStringContainsString('! [CAUTION] The routes list is not sorted in the parsing order.', $tester->getDisplay(true));
     }
 
     public function testSortingByPathWithDuplicatePath()
@@ -75,6 +80,7 @@ public function testSortingByPathWithDuplicatePath()
         $result = $tester->execute(['--sort' => 'path'], ['decorated' => false]);
         $this->assertSame(0, $result, 'Returns 0 in case of success');
         $this->assertRegExp('/(\/romeo).*\n.*(\/sierra).*\n.*(\/tango).*\n.*(\/uniform).*\n.*(\/uniform)/m', $tester->getDisplay(true));
+        $this->assertStringContainsString('! [CAUTION] The routes list is not sorted in the parsing order.', $tester->getDisplay(true));
     }
 
     public function testWithoutCallingSortOptionExplicitly()
@@ -83,6 +89,7 @@ public function testWithoutCallingSortOptionExplicitly()
         $result = $tester->execute([], ['decorated' => false]);
         $this->assertSame(0, $result, 'Returns 0 in case of success');
         $this->assertRegExp('/(charlie).*\n\W*(alfa).*\n\W*(delta).*\n\W*(bravo)/m', $tester->getDisplay(true));
+        $this->assertStringNotContainsString('! [CAUTION] The routes list is not sorted in the parsing order.', $tester->getDisplay(true));
     }
 
     private function createCommandTester(): CommandTester
