CLI routing refactoring

config/common/cli/services.php

@@ -4,9 +4,11 @@
     'uri_path_start_index' => 0,
     'services' => [
         // all requests starting with /example (php console.php /worker)
-        'worker' => [
-            'class' => \App\ExampleCli\ExampleService::class
+        'cli' => [
+            'class' => \App\Example\ExampleService::class,
+            // path to service dependency config related to service directory
+            'dependency' => 'config/cli/dependency.php'
         ],
     ],
-    'default_service' => 'worker'
+    'default_service' => 'cli'
 ];

config/common/web/services.php

@@ -5,7 +5,9 @@
     'services' => [
         // all requests starting with /example (http:://my.host/example/api)
         'example' => [
-            'class' => \App\Example\ExampleService::class
+            'class' => \App\Example\ExampleService::class,
+            // path to service dependency config related to service directory
+            'dependency' => 'config/web/dependency.php'
         ],
     ],
     'default_service' => 'example'

docs/add_service.md

@@ -4,12 +4,23 @@ Creat directory `services/example`
 
 Service files structure:
 
-        config/                       // settings
-            dependency.php            // DependencyConteiner configuration
-            routes.php                // routing settings
+        config/                       
+
+            cli/                      // CLI settings
+                dependency.php        // DependencyConteiner configuration
+                routes.php            // routing settings
+
+            web/                      // WEB settings
+                dependency.php        // DependencyConteiner configuration
+                routes.php            // routing settings
+
         src/                          // code
-            Action                    // Actions directory (if needed)
-            ExampleService.php      // Service class 
+            Action/                   // Actions directory (if needed)
+                Cli/                  // Comand line actions
+                Web/                  // http api actions
+
+            ExampleService.php        // Service class 
+
         docs/                         // documentation
         readme.md                     // documentation index file
 
@@ -31,14 +42,14 @@ For example: adding RuntimeCache for dictionaries and other static application d
 ### DI Container
 Every service using own DependencyContainer. [ExampleService](../services/example/src/ExampleService.php)
 
-Specialized service configurations should be registered as service dependencies. [Example dependencies](../services/example/config/dependency.php)
+Specialized service configurations should be registered as service dependencies. [Example dependencies](../services/example/config/web/dependency.php)
 
 
 ### Service routing
 Use ```KSamuel\RrService\Service\ActionRouter``` to specify service routes
 
 [ExampleService](../services/example/src/ExampleService.php)
 
-[Example routes](../services/example/config/routes.php)
+[Example routes](../services/example/config/web/routes.php)
 
-Action Router should be added into [Example dependencies](../services/example/config/dependency.php)
+Action Router should be added into [Example dependencies](../services/example/config/web/dependency.php)

docs/index.md

@@ -3,6 +3,7 @@ Documentation
 * [Installation](install.md)
 * [Application manifest](manifest.md)
 * [Project files structure](fs.md)
+* [Routing](routing.md)
 * [How to add new service](add_service.md)
 * [Caching](cache.md)
-* [Testing](tests.md)
+* [Testing](tests.md)

docs/routing.md

@@ -22,7 +22,9 @@ return [
     'services' => [
         // All requests starting with /example/
         'example' => [
-            'class' => \App\Example\ExampleService::class
+            'class' => \App\Example\ExampleService::class,
+            // path to service dependency config related to service directory
+            'dependency' => 'config/web/dependency.php'
         ],
     ],
     'default_service' => 'example'
@@ -49,7 +51,7 @@ specific action route: /example/api
 
 In the Action routing settings, specify only `api`
 
-Settings example: services/example/config/routes.php
+Settings example: services/example/config/web/routes.php
 ```php
 <?php
 return [

services/example/config/cli/routes.php

@@ -0,0 +1,18 @@
+<?php
+
+return [
+    // uri path part with service code (other parts routes in service)
+    'uri_path_start_index' => 0,
+    'services' => [
+        'worker1' => [
+            'class' => \App\Example\Action\Cli\LongWorker::class
+        ],
+        'worker2' => [
+            'class' => \App\Example\Action\Cli\FastWorker::class
+        ],
+        'index' => [
+            'class' => \App\Example\Action\Cli\Index::class
+        ]
+    ],
+    'default_route' => 'index'
+];

services/example/config/routes.php → services/example/config/web/routes.php

@@ -5,10 +5,10 @@
     'uri_path_start_index' => 1,
     'services' => [
         'index' => [
-            'class' => \App\Example\Action\Index::class
+            'class' => \App\Example\Action\Web\Index::class
         ],
         'api' => [
-            'class' => \App\Example\Action\Api::class
+            'class' => \App\Example\Action\Web\Api::class
         ],
     ],
     'default_route' => 'index'

services/example-cli/src/Action/Index.php → services/example/src/Action/Cli/FastWorker.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace App\ExampleCli\Action;
+namespace App\Example\Action\Cli;
 
 use KSamuel\RrService\Service\ActionInterface;
 use KSamuel\RrService\Service\ResultInterface;
@@ -12,7 +12,7 @@
 /**
  * Example console worker
  */
-class Index implements ActionInterface
+class FastWorker implements ActionInterface
 {
     /**
      * @param ServerRequestInterface $req
@@ -22,6 +22,7 @@ class Index implements ActionInterface
      */
     public function run(ServerRequestInterface $req, ResultInterface $res, ContainerInterface $container): void
     {
-        $res->setData(['message' => 'Please select console action']);
+        $result = ['success' => true];
+        $res->setData($result);
     }
 }

services/example/src/Action/Cli/Index.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Example\Action\Cli;
+
+use KSamuel\RrService\Service\ActionInterface;
+use KSamuel\RrService\Service\ResultInterface;
+use Psr\Container\ContainerInterface;
+use Psr\Http\Message\ServerRequestInterface;
+
+/**
+ * Example action for web API
+ */
+class Index implements ActionInterface
+{
+    /**
+     * @param ServerRequestInterface $req
+     * @param ResultInterface $res
+     * @param ContainerInterface $container
+     * @throws \Exception
+     */
+    public function run(ServerRequestInterface $req, ResultInterface $res, ContainerInterface $container): void
+    {
+        $res->setData(
+            [
+                'success' => true,
+                'message' => 'Please select worker action',
+            ]
+        );
+    }
+}

services/example-cli/src/Action/Worker.php → services/example/src/Action/Cli/LongWorker.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace App\ExampleCli\Action;
+namespace App\Example\Action\Cli;
 
 use KSamuel\RrService\Service\ActionInterface;
 use KSamuel\RrService\Service\ResultInterface;
@@ -12,7 +12,7 @@
 /**
  * Example console worker
  */
-class Worker implements ActionInterface
+class LongWorker implements ActionInterface
 {
     /**
      * @param ServerRequestInterface $req

services/example/src/Action/Api.php → services/example/src/Action/Web/Api.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace App\Example\Action;
+namespace App\Example\Action\Web;
 
 use KSamuel\RrService\Service\ActionInterface;
 use KSamuel\RrService\Service\ResultInterface;

services/example/src/Action/Index.php → services/example/src/Action/Web/Index.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace App\Example\Action;
+namespace App\Example\Action\Web;
 
 use KSamuel\RrService\Service\ActionInterface;
 use KSamuel\RrService\Service\ResultInterface;

services/example/src/ExampleService.php

@@ -21,13 +21,19 @@ class ExampleService implements ServiceInterface
     public function __construct(
         Connection\Manager $connectionManager,
         LoggerInterface $logger,
-        Config\Storage $configStorage
+        Config\Storage $configStorage,
+        array $serviceConfig
     ) {
         $container = new DependencyContainer();
         $container->bind(LoggerInterface::class, $logger);
         $container->bind(Connection\Manager::class, $connectionManager);
         $container->bind(Config\Storage::class, $configStorage);
-        $container->bindPhpConfig(dirname(__DIR__) . '/config/dependency.php');
+
+        if (!isset($serviceConfig['dependency'])) {
+            throw new \InvalidArgumentException('Undefined service dependency config');
+        }
+
+        $container->bindPhpConfig(dirname(__DIR__) . '/' . $serviceConfig['dependency']);
 
         $this->di = $container;
     }

src/Service/Loader/Loader.php

@@ -27,11 +27,11 @@ public function __construct(Manager $connections, Storage $configStore, LoggerIn
     }
 
     /**
-     * @param array<string,mixed> $serviceConfig
+     * @param array{class:string,dependency:string} $serviceConfig
      * @return ServiceInterface
      */
     public function loadService(array $serviceConfig): ServiceInterface
     {
-        return new $serviceConfig['class']($this->connections, $this->log, $this->configStore);
+        return new $serviceConfig['class']($this->connections, $this->log, $this->configStore, $serviceConfig);
     }
 }

src/Service/Loader/LoaderContainer.php

@@ -31,18 +31,20 @@ public function __construct(Manager $connections, Storage $configStore, LoggerIn
     }
 
     /**
-     * @param array<string,mixed> $serviceConfig
+     * @param array{class:string,dependency:string} $serviceConfig
      * @return ServiceInterface
      */
     public function loadService(array $serviceConfig): ServiceInterface
     {
-        if (!isset($this->services[$serviceConfig['class']])) {
-            $this->services[$serviceConfig['class']] = new $serviceConfig['class'](
+        $key = $serviceConfig['class'] . '::' . $serviceConfig['dependency'];
+        if (!isset($this->services[$key])) {
+            $this->services[$key] = new $serviceConfig['class'](
                 $this->connections,
                 $this->log,
-                $this->configStore
+                $this->configStore,
+                $serviceConfig
             );
         }
-        return $this->services[$serviceConfig['class']];
+        return $this->services[$key];
     }
 }

src/Service/Loader/LoaderInterface.php

@@ -16,7 +16,7 @@
 interface LoaderInterface
 {
     /**
-     * @param array<string,mixed> $serviceConfig
+     * @param array{class:string,dependency:string} $serviceConfig
      * @return ServiceInterface
      */
     public function loadService(array $serviceConfig): ServiceInterface;

src/Service/ServiceInterface.php

@@ -20,8 +20,14 @@ interface ServiceInterface
      * @param Connection\Manager $connectionManager
      * @param LoggerInterface $logger
      * @param Storage $configStorage
+     * @param array{class:string,dependency:string} $serviceConfig
      */
-    public function __construct(Connection\Manager $connectionManager, LoggerInterface $logger, Storage $configStorage);
+    public function __construct(
+        Connection\Manager $connectionManager,
+        LoggerInterface $logger,
+        Storage $configStorage,
+        array $serviceConfig
+    );
 
     /**
      * Warm up service cache, load static dictionaries