Router bug fix (#91)

* introduced disable_alias parameter in config

* updated the documentation

* updated the tests

* fixed seo_routes configuration merging issue

* made supports return false in stead of an error

* implemented config of the ongr router priority

* added documentation about the router priority

Author: einorler

DependencyInjection/Compiler/SetRouterPass.php

@@ -19,7 +19,13 @@ class SetRouterPass implements CompilerPassInterface
 {
     public function process(ContainerBuilder $container)
     {
-        $container->setAlias('router', 'ongr_router.chain_router');
+        if (!$container->getParameter('ongr_router.disable_alias')) {
+            $container->setAlias('router', 'ongr_router.chain_router');
+        }
+
+        $container
+            ->getDefinition('ongr_router.dynamic_router')
+            ->addTag('router', ['priority' => $container->getParameter('ongr_router.router_priority')]);
         $container
             ->getDefinition('ongr_router.elasticsearch_route_provider')
             ->addMethodCall(

DependencyInjection/Configuration.php

@@ -32,13 +32,22 @@ public function getConfigTreeBuilder()
 
         $rootNode
             ->children()
+                ->booleanNode('disable_alias')
+                    ->info('disables aliasing of Symfony router in case it is done somewhere else')
+                    ->defaultFalse()
+                ->end()
+                ->integerNode('router_priority')
+                    ->defaultValue(-100)
+                    ->info('The priority with which the ONGR router is set to the chain router')
+                ->end()
                 ->scalarNode('manager')
                     ->defaultValue('es.manager.default')
                     ->info('Elasticsearch manager to use in the ONGR default router')
                     ->example('es.manager.default')
                 ->end()
                 ->arrayNode('seo_routes')
                     ->defaultValue([])
+                    ->useAttributeAsKey('name')
                     ->prototype('scalar')->end()
                 ->end()
             ->end();

DependencyInjection/ONGRRouterExtension.php

@@ -36,6 +36,8 @@ public function load(array $configs, ContainerBuilder $container)
         $loader->load('services.yml');
 
         $container->setParameter('ongr_router.manager', $config['manager']);
+        $container->setParameter('ongr_router.disable_alias', $config['disable_alias']);
         $container->setParameter('ongr_router.seo_routes', $config['seo_routes']);
+        $container->setParameter('ongr_router.router_priority', $config['router_priority']);
     }
 }

README.md

@@ -82,6 +82,8 @@ ongr_elasticsearch:
                 - AppBundle
 
 ongr_router:
+    #disable_alias: true    # defaults to false
+    #router_priority: 1000  # defaults to -100
     manager: es.manager.default
     seo_routes:
         'AppBundle:Product': AppBundle:Product:document
@@ -98,6 +100,13 @@ At `_controller` you define controller and action for every document type.
 
 `urlAnalyzer` at `ongr_elasticsearch` configuration defines how all url fields are analyzed by Elasticsearch.
 
+If you are using another third party bundle that also has an aliased Symfony router, you may set `disable_alias` to `true`. This
+prevents possible conflicts.
+
+`router_priority` parameter defines the priority with which the `ONGR` dynamic router
+is set to the chain router. It defaults to -100 in order to be called after the standard Symfony router
+but this value can be changed depending on your projects' need.
+
 Check [Elasticsearch bundle mappings docs](https://github.com/ongr-io/ElasticsearchBundle/blob/master/Resources/doc/mapping.md) for more information about the configuration.
 
 

Resources/config/services.yml

@@ -36,5 +36,3 @@ services:
     ongr_router.dynamic_router:
         class: Symfony\Cmf\Component\Routing\DynamicRouter
         arguments: ["@router.request_context", "@ongr_router.nested_matcher", "@ongr_router.url_generator", '', "@event_dispatcher", "@ongr_router.elasticsearch_route_provider"]
-        tags:
-            - { name: router, priority: -100 }

Routing/DocumentUrlGenerator.php

@@ -113,7 +113,7 @@ public function supports($name)
         if ($name instanceof SeoAwareInterface) {
             return true;
         } else {
-            throw new RouteNotFoundException('$name must be an instance of SeoAwareInterface');
+            return false;
         }
     }
     /**

Tests/Unit/DependencyInjection/ConfigurationTest.php

@@ -38,6 +38,8 @@ public function testConfiguration()
         $expectedConfiguration = [
             'manager' => 'es.manager.default',
             'seo_routes' => $configs['ongr_router']['seo_routes'],
+            'disable_alias' => false,
+            'router_priority' => -100,
         ];
         $this->assertEquals($expectedConfiguration, $processorConfig);
     }

Tests/Unit/DependencyInjection/RoutePassTest.php

@@ -49,11 +49,20 @@ public function getContainer()
                 ['routes to be changed']
             ]
         );
+        $dynamicRouter = new Definition(
+            'Symfony\Cmf\Component\Routing\DynamicRouter'
+        );
         $container->setDefinition(
             'ongr_router.elasticsearch_route_provider',
             $provider
         );
+        $container->setDefinition(
+            'ongr_router.dynamic_router',
+            $dynamicRouter
+        );
         $container->setParameter('ongr_router.seo_routes', $routes);
+        $container->setParameter('ongr_router.disable_alias', false);
+        $container->setParameter('ongr_router.router_priority', -100);
         $container->setParameter('ongr_router.manager', 'es.manager.default');
 
         return $container;

Tests/Unit/Routing/ElasticsearchRouteProviderTest.php

@@ -116,7 +116,6 @@ public function testNoRouteMapDefined()
             'GET'
         );
         $provider->getRouteCollectionForRequest($request);
-
     }
 
     /**
@@ -135,6 +134,5 @@ public function testNoManagerDefined()
             'GET'
         );
         $provider->getRouteCollectionForRequest($request);
-
     }
 }