Merge pull request #4 from pawgre/feature/generate_request_id

Generating the request id for the request other than http

Author: snapshotpl

src/RequestIdListener.php

@@ -2,7 +2,7 @@
 namespace RstGroup\RequestIdModule;
 
 use PhpMiddleware\RequestId\Exception\MissingRequestId;
-use PhpMiddleware\RequestId\Exception\RequestIdExceptionInterface;
+use PhpMiddleware\RequestId\Generator\GeneratorInterface;
 use PhpMiddleware\RequestId\RequestIdProviderInterface;
 use Zend\EventManager\AbstractListenerAggregate;
 use Zend\EventManager\EventManagerInterface;
@@ -29,13 +29,18 @@ final class RequestIdListener extends AbstractListenerAggregate implements Reque
 
     protected $requestIdProviderFactory;
 
-    public function __construct(RequestIdProviderFactoryInterface $requestIdProviderFactory, $requestIdHeaderName = self::DEFAULT_REQUEST_ID_HEADER)
+    private $requestIdGenerator;
+
+    public function __construct(RequestIdProviderFactoryInterface $requestIdProviderFactory,
+                                $requestIdHeaderName = self::DEFAULT_REQUEST_ID_HEADER,
+                                GeneratorInterface $requestIdGenerator = null)
     {
         $this->requestIdProviderFactory = $requestIdProviderFactory;
         $this->requestIdHeaderName = $requestIdHeaderName;
+        $this->requestIdGenerator = $requestIdGenerator;
     }
 
-    public function attach(EventManagerInterface $events)
+    public function attach(EventManagerInterface $events, $priority = 1)
     {
         $this->listeners[] = $events->attach(MvcEvent::EVENT_BOOTSTRAP, [$this, 'loadRequestId']);
         $this->listeners[] = $events->attach(MvcEvent::EVENT_FINISH, [$this, 'addRequestIdToResponse']);
@@ -45,16 +50,16 @@ public function loadRequestId(MvcEvent $event)
     {
         $request = $event->getRequest();
 
-        if (!$request instanceof HttpRequest) {
-            return;
-        }
-        $psr7Request = Psr7ServerRequest::fromZend($request);
-
-        $requestIdProvider = $this->requestIdProviderFactory->create($psr7Request);
+        if ($request instanceof HttpRequest) {
+            $psr7Request = Psr7ServerRequest::fromZend($request);
+            $requestIdProvider = $this->requestIdProviderFactory->create($psr7Request);
+            $this->requestId = $requestIdProvider->getRequestId();
 
-        $this->requestId = $requestIdProvider->getRequestId();
+        } elseif ($this->requestIdGenerator !== null) {
+            $this->requestId = $this->requestIdGenerator->generateRequestId();
+        }
 
-        return $this->requestId ;
+        return $this->requestId;
     }
 
     public function getRequestId()

src/RequestIdListenerFactory.php

@@ -1,17 +1,19 @@
 <?php
 namespace RstGroup\RequestIdModule;
 
+use PhpMiddleware\RequestId\Generator\GeneratorInterface;
 use PhpMiddleware\RequestId\RequestIdProviderFactoryInterface;
 
 class RequestIdListenerFactory
 {
     public function __invoke($services)
     {
+        $requestIdGenerator = $services->get(GeneratorInterface::class);
         $requestIdProviderFactory = $services->get(RequestIdProviderFactoryInterface::class);
 
         $config = $services->get('Config');
         $requestIdHeaderName = $config['rst_group']['request_id_module']['header_name'];
 
-        return new RequestIdListener($requestIdProviderFactory, $requestIdHeaderName);
+        return new RequestIdListener($requestIdProviderFactory, $requestIdHeaderName, $requestIdGenerator);
     }
-}
+}

test/RequestIdListenerTest.php

@@ -2,6 +2,7 @@
 namespace RstGroup\RequestIdModule\Test;
 
 use PhpMiddleware\RequestId\Exception\MissingRequestId;
+use PhpMiddleware\RequestId\Generator\GeneratorInterface;
 use PhpMiddleware\RequestId\RequestIdProviderFactoryInterface;
 use PhpMiddleware\RequestId\RequestIdProviderInterface;
 use RstGroup\RequestIdModule\RequestIdListener;
@@ -85,7 +86,7 @@ public function it_not_add_request_id_to_response_after_load_request_id()
     /**
      * @test
      */
-    public function it_not_load_request_id_if_not_http_request()
+    public function it_not_load_request_id_if_not_http_request_and_generator_is_undefined()
     {
         $requestIdListener = new RequestIdListener($this->requestIdProviderFactoryInterface);
 
@@ -100,6 +101,25 @@ public function it_not_load_request_id_if_not_http_request()
         $this->assertNull($requestId);
     }
 
+    /**
+     * @test
+     */
+    public function it_create_request_id_if_not_http_request()
+    {
+        $requestId = 'e5dd58f4-b72d-4d7e-b0c9-d99040386a58';
+        $requestIdGenerator = $this->getMock(GeneratorInterface::class);
+        $requestIdGenerator->method('generateRequestId')->willReturn($requestId);
+
+        $requestIdListener = new RequestIdListener($this->requestIdProviderFactoryInterface, RequestIdListener::DEFAULT_REQUEST_ID_HEADER, $requestIdGenerator);
+
+        $mvcEvent = new MvcEvent();
+        $mvcEvent->setRequest(new ConsoleRequest());
+
+        $requestIdListener->loadRequestId($mvcEvent);
+
+        $this->assertSame($requestId, $requestIdListener->getRequestId());
+    }
+
     /**
      * @test
      */