Add http endpoint path configuration (#15)

Author: yoanm

features/demo-app.feature

@@ -89,23 +89,23 @@ Feature: demo symfony application
   Scenario: Use Bundle with default method resolver with JSON-RPC method tags
     Given DemoApp will use JsonRpcHttpServerBundle
     # Ensure the two methods with tag have been loaded
-    When I send following "POST" input on "/json-rpc" demoApp kernel endpoint:
+    When I send following "POST" input on "/my-custom-endpoint" demoApp kernel endpoint:
     """
     {"jsonrpc": "2.0", "method": "bundledMethodA", "id": 1}
     """
     Then I should have a "200" response from demoApp with following content:
     """
     {"jsonrpc":"2.0", "result":"MethodA", "id":1}
     """
-    When I send following "POST" input on "/json-rpc" demoApp kernel endpoint:
+    When I send following "POST" input on "/my-custom-endpoint" demoApp kernel endpoint:
     """
     {"jsonrpc": "2.0", "method": "bundledMethodAAlias", "id": 2}
     """
     Then I should have a "200" response from demoApp with following content:
     """
     {"jsonrpc":"2.0", "result":"MethodA", "id":2}
     """
-    When I send following "POST" input on "/json-rpc" demoApp kernel endpoint:
+    When I send following "POST" input on "/my-custom-endpoint" demoApp kernel endpoint:
     """
     {"jsonrpc": "2.0", "method": "bundledMethodB", "id": 3}
     """
@@ -118,15 +118,15 @@ Feature: demo symfony application
   Scenario: Use Bundle with default method resolver with JSON-RPC methods container injection
     Given DemoApp will use JsonRpcHttpServerBundle
     # Ensure the two injected methods have been injected
-    When I send following "POST" input on "/json-rpc" demoApp kernel endpoint:
+    When I send following "POST" input on "/my-custom-endpoint" demoApp kernel endpoint:
     """
     {"jsonrpc": "2.0", "method": "bundledGetDummy", "id": 1}
     """
     Then I should have a "200" response from demoApp with following content:
     """
     {"jsonrpc":"2.0", "result":"MethodC", "id":1}
     """
-    When I send following "POST" input on "/json-rpc" demoApp kernel endpoint:
+    When I send following "POST" input on "/my-custom-endpoint" demoApp kernel endpoint:
     """
     {"jsonrpc": "2.0", "method": "bundledGetAnotherDummy", "id": 2}
     """

features/demo_app/default_config_with_bundle/config.yaml

@@ -2,6 +2,7 @@ framework:
     secret: '%env(APP_SECRET)%'
 
 json_rpc_http_server:
+    http_endpoint_path: '/my-custom-endpoint'
     methods_mapping:
         bundledMethodA:
             service: '@jsonrpc.method.a'

src/DependencyInjection/Configuration.php

@@ -14,6 +14,10 @@ public function getConfigTreeBuilder()
 
         $rootNode
             ->children()
+                ->variableNode('http_endpoint_path')
+                    ->info('Your custom http endpoint path')
+                    ->defaultValue(JsonRpcHttpServerExtension::HTTP_ENDPOINT_PATH)
+                ->end()
                 ->variableNode('method_resolver')
                     ->info('Your custom method resolver service')
                     ->treatNullLike(false)

src/DependencyInjection/JsonRpcHttpServerExtension.php

@@ -347,6 +347,7 @@ private function checkJsonRpcMethodService(ContainerBuilder $container, string $
      */
     private function compileAndProcessConfigurations(array $configs, ContainerBuilder $container)
     {
+        $httpEndpointPath = self::HTTP_ENDPOINT_PATH;
         if (true === $this->parseConfig) {
             $configuration = new Configuration();
             $config = (new Processor())->processConfiguration($configuration, $configs);
@@ -360,9 +361,12 @@ private function compileAndProcessConfigurations(array $configs, ContainerBuilde
             if (array_key_exists('methods_mapping', $config) && is_array($config['methods_mapping'])) {
                 $container->setParameter(self::METHODS_MAPPING_CONTAINER_PARAM, $config['methods_mapping']);
             }
+            if (array_key_exists('http_endpoint_path', $config)) {
+                $httpEndpointPath = $config['http_endpoint_path'];
+            }
         }
 
-        $container->setParameter(self::HTTP_ENDPOINT_PATH_CONTAINER_PARAM, self::HTTP_ENDPOINT_PATH);
+        $container->setParameter(self::HTTP_ENDPOINT_PATH_CONTAINER_PARAM, $httpEndpointPath);
     }
 
     /**

tests/Common/DependencyInjection/AbstractTestClass.php

@@ -21,6 +21,8 @@ abstract class AbstractTestClass extends AbstractExtensionTestCase
     const EXPECTED_METHOD_MANAGER_SERVICE_ID = 'json_rpc_http_server.sdk.app.manager.method';
     const EXPECTED_METHOD_RESOLVER_STUB_SERVICE_ID = 'json_rpc_http_server.infra.resolver.method';
 
+    const EXPECTED_HTTP_ENDPOINT_PATH_CONTAINER_PARAM = 'json_rpc_http_server.http_endpoint_path';
+
     /**
      * {@inheritdoc}
      */

tests/Functional/DependencyInjection/JsonRpcHttpServerExtensionWithConfigParsedTest.php

@@ -20,6 +20,17 @@ protected function getContainerExtensions()
         ];
     }
 
+    public function testShouldManageCustomEndpointPathFromConfiguration()
+    {
+        $myCustomEndpoint = 'my-custom-endpoint';
+        $this->load(['http_endpoint_path' => $myCustomEndpoint]);
+
+        // Assert custom resolver is an alias of the stub
+        $this->assertContainerBuilderHasParameter(self::EXPECTED_HTTP_ENDPOINT_PATH_CONTAINER_PARAM, $myCustomEndpoint);
+
+        $this->assertEndpointIsUsable();
+    }
+
     public function testShouldManageCustomResolverFromConfiguration()
     {
         $myCustomResolverServiceId = 'my-custom-resolver';

tests/Technical/DependencyInjection/JsonRpcHttpServerExtensionWithConfigurationParsedTest.php

@@ -20,6 +20,19 @@ protected function getContainerExtensions()
         ];
     }
 
+    public function testShouldHaveADefaultEndpointConfigured()
+    {
+        $this->load();
+
+        // Assert custom resolver is an alias of the stub
+        $this->assertContainerBuilderHasParameter(
+            self::EXPECTED_HTTP_ENDPOINT_PATH_CONTAINER_PARAM,
+            JsonRpcHttpServerExtension::HTTP_ENDPOINT_PATH
+        );
+
+        $this->assertEndpointIsUsable();
+    }
+
     public function testShouldNormalizeExternalServiceIdStringPassedForMethodResolver()
     {
         $myCustomResolverServiceId = 'my-custom-resolver';