Merge pull request #662 from acelaya-forks/feature/rest-request-id

Feature/rest request

CHANGELOG.md

@@ -10,6 +10,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), and this
 
 * [#626](https://github.com/shlinkio/shlink/issues/626) Added support for Microsoft SQL Server.
 * [#556](https://github.com/shlinkio/shlink/issues/556) Short code lengths can now be customized, both globally and on a per-short URL basis.
+* [#541](https://github.com/shlinkio/shlink/issues/541) Added a request ID that is returned on `X-Request-Id` header, can be provided from outside and is set in log entries.
 
 #### Changed
 

composer.json

@@ -45,8 +45,10 @@
         "nikolaposa/monolog-factory": "^3.0",
         "ocramius/proxy-manager": "^2.7.0",
         "phly/phly-event-dispatcher": "^1.0",
+        "php-middleware/request-id": "^4.0",
         "predis/predis": "^1.1",
         "pugx/shortid-php": "^0.5",
+        "ramsey/uuid": "^3.9",
         "shlinkio/shlink-common": "^2.7.0",
         "shlinkio/shlink-event-dispatcher": "^1.3",
         "shlinkio/shlink-installer": "^4.2.0",

config/autoload/logger.global.php

@@ -9,6 +9,7 @@ use Monolog\Handler;
 use Monolog\Logger;
 use Monolog\Processor;
 use MonologFactory\DiContainerLoggerFactory;
+use PhpMiddleware\RequestId;
 use Psr\Log\LoggerInterface;
 
 use const PHP_EOL;
@@ -20,11 +21,12 @@ $processors = [
     'psr3' => [
         'name' => Processor\PsrLogMessageProcessor::class,
     ],
+    'request_id' => RequestId\MonologProcessor::class,
 ];
 $formatter = [
     'name' => Formatter\LineFormatter::class,
     'params' => [
-        'format' => '[%datetime%] %channel%.%level_name% - %message%' . PHP_EOL,
+        'format' => '[%datetime%] [%extra.request_id%] %channel%.%level_name% - %message%' . PHP_EOL,
         'allow_inline_line_breaks' => true,
     ],
 ];
@@ -80,6 +82,7 @@ return [
         'swoole-http-server' => [
             'logger' => [
                 'logger-name' => 'Logger_Access',
+                'format' => '%h %l %u "%r" %>s %b',
             ],
         ],
     ],

config/autoload/middleware-pipeline.global.php

@@ -7,6 +7,7 @@ namespace Shlinkio\Shlink;
 use Laminas\Stratigility\Middleware\ErrorHandler;
 use Mezzio;
 use Mezzio\ProblemDetails;
+use PhpMiddleware\RequestId\RequestIdMiddleware;
 
 return [
 
@@ -21,6 +22,7 @@ return [
             'path' => '/rest',
             'middleware' => [
                 Rest\Middleware\CrossDomainMiddleware::class,
+                RequestIdMiddleware::class,
                 ProblemDetails\ProblemDetailsMiddleware::class,
             ],
         ],

config/autoload/request_id.global.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+use Laminas\ServiceManager\AbstractFactory\ConfigAbstractFactory;
+use Laminas\ServiceManager\Factory\InvokableFactory;
+use PhpMiddleware\RequestId;
+
+return [
+
+    'request_id' => [
+        'allow_override' => true,
+        'header_name' => 'X-Request-Id',
+    ],
+
+    'dependencies' => [
+        'factories' => [
+            RequestId\Generator\RamseyUuid4StaticGenerator::class => InvokableFactory::class,
+            RequestId\RequestIdProviderFactory::class => ConfigAbstractFactory::class,
+            RequestId\RequestIdMiddleware::class => ConfigAbstractFactory::class,
+            RequestId\MonologProcessor::class => ConfigAbstractFactory::class,
+        ],
+    ],
+
+    ConfigAbstractFactory::class => [
+        RequestId\RequestIdProviderFactory::class => [
+            RequestId\Generator\RamseyUuid4StaticGenerator::class,
+            'config.request_id.allow_override',
+            'config.request_id.header_name',
+        ],
+        RequestId\RequestIdMiddleware::class => [RequestId\RequestIdProviderFactory::class],
+        RequestId\MonologProcessor::class => [RequestId\RequestIdMiddleware::class],
+    ],
+
+];

module/Core/src/Options/AppOptions.php

@@ -5,14 +5,11 @@ declare(strict_types=1);
 namespace Shlinkio\Shlink\Core\Options;
 
 use Laminas\Stdlib\AbstractOptions;
-use Shlinkio\Shlink\Common\Util\StringUtilsTrait;
 
 use function sprintf;
 
 class AppOptions extends AbstractOptions
 {
-    use StringUtilsTrait;
-
     private string $name = '';
     private string $version = '1.0';
     private ?string $disableTrackParam = null;

module/Rest/src/Entity/ApiKey.php

@@ -5,20 +5,18 @@ declare(strict_types=1);
 namespace Shlinkio\Shlink\Rest\Entity;
 
 use Cake\Chronos\Chronos;
+use Ramsey\Uuid\Uuid;
 use Shlinkio\Shlink\Common\Entity\AbstractEntity;
-use Shlinkio\Shlink\Common\Util\StringUtilsTrait;
 
 class ApiKey extends AbstractEntity
 {
-    use StringUtilsTrait;
-
     private string $key;
     private ?Chronos $expirationDate;
     private bool $enabled;
 
     public function __construct(?Chronos $expirationDate = null)
     {
-        $this->key = $this->generateV4Uuid();
+        $this->key = Uuid::uuid4()->toString();
         $this->expirationDate = $expirationDate;
         $this->enabled = true;
     }
@@ -30,11 +28,7 @@ class ApiKey extends AbstractEntity
 
     public function isExpired(): bool
     {
-        if ($this->expirationDate === null) {
-            return false;
-        }
-
-        return $this->expirationDate->lt(Chronos::now());
+        return $this->expirationDate !== null && $this->expirationDate->lt(Chronos::now());
     }
 
     public function isEnabled(): bool