Merge pull request #32 from tochka-developers/v4-log-middleware-allow…

…-headres-log Возможность логировать заголовки запроса, при необходимости
tochka-developers · Jul 31, 2023 · e127515 · e127515
2 parents f477148 + 605816c
commit e127515
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -119,6 +119,8 @@ return [
             Tochka\JsonRpc\Middleware\LogMiddleware::class               => [
                 // Канал лога, в который будут записываться все логи
                 'channel' => 'default',
+                // Заголовки которые нужно писать в лог
+                'headers' => ['accept', 'encoding']
             ],
              Tochka\JsonRpc\Middleware\TokenAuthMiddleware::class         => [
                  'headerName' => 'X-Tochka-Access-Key',

diff --git a/config/jsonrpc.php b/config/jsonrpc.php
@@ -71,6 +71,13 @@
                 //    'App\\Http\\TestController1@method' => ['password', 'data.phone_number'],
                 //    'App\\Http\\TestController2' => ['password', 'data.phone_number']
                 //]
+                /**
+                 * Заголовки которые необходимо логировать
+                 */
+                //'headers' => [
+                //    'accept',
+                //    'encoding'
+                //]
             ],
             TokenAuthMiddleware::class         => [
                 'headerName' => 'X-Tochka-Access-Key',

diff --git a/src/Middleware/LogMiddleware.php b/src/Middleware/LogMiddleware.php
@@ -2,15 +2,22 @@
 
 namespace Tochka\JsonRpc\Middleware;
 
+use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Log;
 use Tochka\JsonRpc\Helpers\ArrayHelper;
 use Tochka\JsonRpc\Helpers\LogHelper;
 use Tochka\JsonRpc\Support\JsonRpcRequest;
 
 class LogMiddleware
 {
-    public function handle(JsonRpcRequest $request, $next, string $channel = 'default', array $hideParams = [])
-    {
+    public function handle(
+        JsonRpcRequest $request,
+        $next,
+        Request $httpRequest,
+        string $channel = 'default',
+        array $hideParams = [],
+        array $headers = []
+    ) {
         $logContext = [
             'id' => $request->getId(),
         ];
@@ -31,6 +38,10 @@ public function handle(JsonRpcRequest $request, $next, string $channel = 'defaul
             $rules = array_merge($globalRules, $controllerRules, $methodRules);
             $logRequest['params'] = LogHelper::hidePrivateData((array) ($request->getRawRequest()->params ?? []), $rules);
         }
+
+        if (!empty($headers)) {
+            $logContext['headers'] = $this->addHeaders($httpRequest, $headers);
+        }
 
         Log::channel($channel)->info('New request', $logContext + ['request' => $logRequest]);
 
@@ -49,4 +60,14 @@ public function handle(JsonRpcRequest $request, $next, string $channel = 'defaul
 
         return $result;
     }
+
+    protected function addHeaders(Request $httpRequest, array $headers = []): array
+    {
+        $result = [];
+        foreach ($headers as $header) {
+            $result[$header] = $httpRequest->header($header);
+        }
+
+        return $result;
+    }
 }