Implement logs and redis keys endpoint

.env.example

@@ -15,6 +15,7 @@ DB_DATABASE=laravel
 DB_USERNAME=root
 DB_PASSWORD=secret
 
+REDIS_CONNECTION=default
 REDIS_HOST=redis
 REDIS_PASSWORD=redis
 

app/Http/Controllers/Admin/RedisController.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace App\Http\Controllers\Admin;
+
+use App\Http\Controllers\Controller;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Facades\Redis;
+use OpenApi\Attributes as OA;
+
+class RedisController extends Controller
+{
+    #[OA\Get(
+        path: '/api/admin/redis/keys',
+        tags: ['admin'],
+        responses: [
+            new OA\Response(response: 200, description: 'List of Redis keys and values')
+        ]
+    )]
+    public function keys(): JsonResponse
+    {
+        $redis = Redis::connection(config('database.redis.connection'));
+        $prefix = config('database.redis.options.prefix');
+        $keys = $redis->keys('*');
+        $data = [];
+
+        foreach ($keys as $key) {
+            $value = $redis->get(
+                str_replace($prefix, '', $key)
+            );
+
+            $data[$key] = substr($value, 0, 100) . '...';
+        }
+
+        return response()->json($data);
+    }
+}

app/Providers/AppServiceProvider.php

@@ -39,7 +39,7 @@ private function setHealthCheck(): void
     {
         $env = match (config('app.url')) {
             'http://gamewatch.local' => 'local',
-            default                  => 'prod'
+            default                  => 'production'
         };
 
         Health::checks([

app/Services/Rawg/RawgBaseService.php

@@ -3,6 +3,7 @@
 namespace App\Services\Rawg;
 
 use GuzzleHttp\Client;
+use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Facades\Redis;
 
 abstract class RawgBaseService
@@ -11,13 +12,18 @@ abstract class RawgBaseService
 
     protected string $apiKey;
     protected string $apiUrl;
+    private $redis;
 
     public function __construct(
         protected RawgFilterService $filterService,
         protected Client $client
     ) {
         $this->apiUrl = config('services.rawg.host') . '/api/';
         $this->apiKey = config('services.rawg.key');
+
+        $this->redis = Redis::connection(
+            config('database.redis.connection')
+        );
     }
 
     /**
@@ -57,7 +63,7 @@ protected function call(
     private function getCacheContents(string $uri, array $data): ?string
     {
         $key = $this->getCacheKey($uri, $data['query']);
-        return Redis::get($key);
+        return $this->redis->get($key);
     }
 
     /**
@@ -69,7 +75,13 @@ private function getCacheContents(string $uri, array $data): ?string
     private function setCacheContents(string $uri, array $data, string $contents): void
     {
         $key = $this->getCacheKey($uri, $data['query']);
-        Redis::setEx($key, self::CACHE_TTL, $contents);
+        $result = $this->redis->setEx($key, self::CACHE_TTL, $contents);
+
+        Log::debug(sprintf(
+            'Redis cache set [key: %s, result: %s]',
+            $key,
+            $result
+        ));
     }
 
     /**

app/Swagger/Application.php

@@ -24,6 +24,10 @@ class Application
         name: 'application',
         description: 'health and other application routes'
     )]
+    #[OA\Tag(
+        name: 'admin',
+        description: 'admin panel routes'
+    )]
     #[OA\Tag(
         name: 'domain',
         description: 'rawg domain routes'

config/database.php

@@ -142,6 +142,8 @@
 
         'client' => env('REDIS_CLIENT', 'phpredis'),
 
+        'connection' => env('REDIS_CONNECTION', 'default'),
+
         'options' => [
             'cluster' => env('REDIS_CLUSTER', 'redis'),
             'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
@@ -156,6 +158,19 @@
             'database' => env('REDIS_DB', '0'),
         ],
 
+        'clusters' => [
+            'default' => [
+                [
+                    'url' => env('REDIS_URL'),
+                    'host' => env('REDIS_HOST', '127.0.0.1'),
+                    'username' => env('REDIS_USERNAME'),
+                    'password' => env('REDIS_PASSWORD'),
+                    'port' => env('REDIS_PORT', '6379'),
+                    'database' => env('REDIS_DB', '0'),
+                ],
+            ],
+        ],
+
         'cache' => [
             'url' => env('REDIS_URL'),
             'host' => env('REDIS_HOST', '127.0.0.1'),

ecs/deployment-task.json

@@ -79,6 +79,10 @@
           "name": "DB_PASSWORD",
           "valueFrom": "<SSM_NAMESPACE>/DB_PASSWORD"
         },
+        {
+          "name": "REDIS_CONNECTION",
+          "valueFrom": "<SSM_NAMESPACE>/REDIS_CONNECTION"
+        },
         {
           "name": "REDIS_HOST",
           "valueFrom": "<SSM_NAMESPACE>/REDIS_HOST"

phpunit.xml

@@ -29,5 +29,6 @@
         <env name="QUEUE_CONNECTION" value="sync"/>
         <env name="SESSION_DRIVER" value="array"/>
         <env name="TELESCOPE_ENABLED" value="false"/>
+        <env name="LOG_LEVEL" value="error"/>
     </php>
 </phpunit>

public/swagger.yaml

@@ -117,6 +117,14 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/User'
+  /api/admin/redis/keys:
+    get:
+      tags:
+        - admin
+      operationId: 519129f3cdf7eea66301bd70ced39c8c
+      responses:
+        '200':
+          description: 'List of Redis keys and values'
   /api/auth/login:
     post:
       tags:
@@ -606,6 +614,9 @@ tags:
   -
     name: application
     description: 'health and other application routes'
+  -
+    name: admin
+    description: 'admin panel routes'
   -
     name: domain
     description: 'rawg domain routes'

routes/api.php

@@ -4,6 +4,7 @@
 use App\Enums\Rawg\RawgGenre;
 use App\Enums\Scope;
 use App\Http\Controllers\AccountController;
+use App\Http\Controllers\Admin\RedisController;
 use App\Http\Controllers\AuthController;
 use App\Http\Controllers\DiscordController;
 use App\Http\Controllers\RawgGamesController;
@@ -34,6 +35,13 @@
 
         Route::middleware('scopes:' . Scope::Root->value)->group(function () {
             Route::post('/account/register', [AccountController::class, 'register']);
+
+            Route::prefix('admin')
+                ->group(function () {
+                    Route::prefix('redis')->controller(RedisController::class)->group(function() {
+                        Route::get('/keys', 'keys');
+                    });
+                });
 
             Route::prefix('rawg')
                 ->group(function () {

tests/TestCase.php

@@ -66,6 +66,10 @@ protected function prepRawgForUnitTesting(): void
 
     protected function mockRedis(): void
     {
+        Redis::shouldReceive('connection')
+            ->once()
+            ->andReturnSelf();
+
         Redis::shouldReceive('get')
         ->once()
         ->andReturn(null);