add request executionTime time for debugging purposes

rafrsr · Jan 25, 2021 · bd6b136 · bd6b136
1 parent 701e6a9
commit bd6b136
Show file tree

Hide file tree

Showing 5 changed files with 69 additions and 11 deletions.
diff --git a/src/Debug/ApiDebugger.php b/src/Debug/ApiDebugger.php
@@ -40,9 +40,12 @@ public function beginRequestProcess(RequestInterface $request)
      * @param RequestProcess    $process
      * @param ResponseInterface $response
      * @param Exception|null    $exception
+     * @param int               $executionTime
      */
-    public function finishRequestProcess(RequestProcess $process, ResponseInterface $response = null, Exception $exception = null)
+    public function finishRequestProcess(RequestProcess $process, ResponseInterface $response = null, Exception $exception = null, $executionTime = 0)
     {
+        $process->setExecutionTime($executionTime);
+
         if ($response) {
             $process->setResponse($response);
         }

diff --git a/src/Debug/RequestProcess.php b/src/Debug/RequestProcess.php
@@ -32,18 +32,25 @@ class RequestProcess
      */
     protected $exception;
 
+    /**
+     * @var int
+     */
+    protected $executionTime = 0;
+
     /**
      * RequestProcess constructor.
      *
      * @param RequestInterface  $request
      * @param ResponseInterface $response
      * @param Exception         $exception
+     * @param int               $executionTime
      */
-    public function __construct(RequestInterface $request = null, ResponseInterface $response = null, Exception $exception = null)
+    public function __construct(RequestInterface $request = null, ResponseInterface $response = null, Exception $exception = null, $executionTime = 0)
     {
         $this->request = $request;
         $this->response = $response;
         $this->exception = $exception;
+        $this->executionTime = $executionTime;
     }
 
     /**
@@ -105,4 +112,24 @@ public function setException(Exception $exception)
 
         return $this;
     }
+
+    /**
+     * @return int
+     */
+    public function getExecutionTime()
+    {
+        return $this->executionTime;
+    }
+
+    /**
+     * @param int $executionTime
+     *
+     * @return $this
+     */
+    public function setExecutionTime($executionTime)
+    {
+        $this->executionTime = $executionTime;
+
+        return $this;
+    }
 }
diff --git a/src/Event/OnResponseEvent.php b/src/Event/OnResponseEvent.php
@@ -33,6 +33,13 @@ class OnResponseEvent extends ApiEvent
      */
     protected $exception;
 
+    /**
+     * Request execution time in ms
+     *
+     * @var int
+     */
+    protected $executionTime = 0;
+
     /**
      * PreBuildRequestEvent constructor.
      *
@@ -41,13 +48,15 @@ class OnResponseEvent extends ApiEvent
      * @param ResponseInterface     $response
      * @param RequestInterface|null $request TODO: mark as required in v3.0
      * @param \Exception|null $exception
+     * @param int $executionTime
      */
-    public function __construct(ApiInterface $api, ApiServiceInterface $service, ResponseInterface $response, RequestInterface $request = null, \Exception $exception = null)
+    public function __construct(ApiInterface $api, ApiServiceInterface $service, ResponseInterface $response, RequestInterface $request = null, \Exception $exception = null, $executionTime = 0)
     {
         parent::__construct($api, $service);
         $this->response = $response;
         $this->request = $request;
         $this->exception = $exception;
+        $this->executionTime = $executionTime;
     }
 
     /**
@@ -73,4 +82,12 @@ public function getException()
     {
         return $this->exception;
     }
+
+    /**
+     * @return int
+     */
+    public function getExecutionTime()
+    {
+        return $this->executionTime;
+    }
 }
diff --git a/src/GenericApi.php b/src/GenericApi.php
@@ -150,6 +150,7 @@ public function process(ApiServiceInterface $service)
 
         $exception = null;
         $httpResponse = null;
+        $startTime = microtime(true) * 1000;
         try {
             $httpResponse = $this->sendRequest($request);
         } catch (RequestException $e) {
@@ -158,8 +159,10 @@ public function process(ApiServiceInterface $service)
             $exception = $e;
         }
 
+        $executionTime = number_format((microtime(true) * 1000) - $startTime, 0, '', '');
+
         if ($debugProcess !== null) {
-            $this->debugger->finishRequestProcess($debugProcess, $httpResponse, $exception);
+            $this->debugger->finishRequestProcess($debugProcess, $httpResponse, $exception, $executionTime);
         }
 
         $newResponse = null;
@@ -172,7 +175,7 @@ public function process(ApiServiceInterface $service)
         }
 
         if ($httpResponse) {
-            $this->getEventDispatcher()->dispatch(self::EVENT_ON_RESPONSE, new OnResponseEvent($this, $service, $httpResponse, $request, $exception));
+            $this->getEventDispatcher()->dispatch(self::EVENT_ON_RESPONSE, new OnResponseEvent($this, $service, $httpResponse, $request, $exception, $executionTime));
         }
 
         //has pending exception
@@ -249,7 +252,7 @@ protected function validate(ApiServiceInterface $service)
         foreach ($violations as $violation) {
             $errorMessage = $violation->getMessage();
             if ($violation->getPropertyPath()) {
-                $errorMessage = sprintf('Error in field "%s": ', $violation->getPropertyPath()) . $errorMessage;
+                $errorMessage = sprintf('Error in field "%s": ', $violation->getPropertyPath()).$errorMessage;
             }
             throw new InvalidApiDataException($errorMessage);
         }

diff --git a/tests/GenericApiTest.php b/tests/GenericApiTest.php
@@ -15,6 +15,7 @@
 use PHPUnit\Framework\TestCase;
 use Rafrsr\GenericApi\ApiInterface;
 use Rafrsr\GenericApi\ApiRequestBuilder;
+use Rafrsr\GenericApi\Event\OnResponseEvent;
 use Rafrsr\GenericApi\GenericApi;
 use Rafrsr\GenericApi\GenericApiMock;
 use Rafrsr\GenericApi\GenericApiService;
@@ -40,16 +41,23 @@ public function testGenericApi()
         $api = new GenericApi(ApiInterface::MODE_MOCK); //can use MODE_LIVE
 
         $mockCallback = function () {
-            return new Response(200, [], file_get_contents(__DIR__ . '/../sample/Fixtures/post1.json'));
+            return new Response(200, [], file_get_contents(__DIR__.'/../sample/Fixtures/post1.json'));
         };
 
         $request = ApiRequestBuilder::create()
-            ->withMethod('get')
-            ->withUri('http://jsonplaceholder.typicode.com/posts/1')
-            ->withMock(new GenericApiMock($mockCallback))
-            ->getRequest();
+                                    ->withMethod('get')
+                                    ->withUri('http://jsonplaceholder.typicode.com/posts/1')
+                                    ->withMock(new GenericApiMock($mockCallback))
+                                    ->getRequest();
 
         $service = new GenericApiService($request);
+
+        $api->onResponse(
+            function (OnResponseEvent $event) {
+                self::assertLessThan(10, $event->getExecutionTime());
+            }
+        );
+
         $response = $api->process($service);
 
         static::assertEquals('200', $response->getStatusCode());