chore: improved doctrine cache configuration

allow to spec out the store

Signed-off-by: [email protected] <[email protected]>
Change-Id: I1937d478f89662998eb5408ccd7036f87cee10d4

Author: smarcet

app/libs/Utils/Doctrine/DoctrineCacheServiceProvider.php

@@ -0,0 +1,48 @@
+<?php namespace App\libs\Utils\Doctrine;
+/*
+ * Copyright 2025 OpenStack Foundation
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ **/
+
+use Illuminate\Contracts\Cache\Factory;
+use Illuminate\Support\ServiceProvider;
+use LaravelDoctrine\ORM\Configuration\Cache\CacheManager;
+use LaravelDoctrine\ORM\Configuration\Cache\RedisCacheProvider;
+
+class CustomRedisCacheProvider extends RedisCacheProvider
+{
+
+    /**
+     * CustomRedisCacheProvider constructor.
+     */
+    public function __construct(protected Factory $cache)
+    {
+        parent::__construct($cache);
+        $this->store = null;
+    }
+}
+/**
+ * Class DoctrineCacheServiceProvider
+ * @package App\libs\Utils\Doctrine
+ */
+class DoctrineCacheServiceProvider extends ServiceProvider
+{
+    public function register()
+    {
+        $this->app->resolving(CacheManager::class, function (CacheManager $cache) {
+            // Override the 'redis' driver
+            $cache->extend('redis', function (array $settings, $app) {
+                $res = new CustomRedisCacheProvider($app->make(Factory::class));
+                return $res->resolve($settings);
+            });
+        });
+    }
+}

config/app.php

@@ -172,6 +172,7 @@
         // remove 'Laravel\Socialite\SocialiteServiceProvider',
         \SocialiteProviders\Manager\ServiceProvider::class, // add
         \App\libs\Utils\Html\HtmlServiceProvider::class,
+        App\libs\Utils\Doctrine\DoctrineCacheServiceProvider::class,
     ],
 
     /*

config/cache.php

@@ -63,6 +63,10 @@
             'connection' => env('CACHE_REDIS_CONN', 'cache'),
         ],
 
+        'doctrine_redis' => [
+            'driver' => 'redis',
+            'connection' => env('DOCTRINE_CACHE_REDIS_CONN', 'doctrine_cache'),
+        ],
     ],
 
     /*

config/database.php

@@ -138,6 +138,14 @@
             'timeout' => env('REDIS_TIMEOUT', 30.0),
             'scheme' => env('REDIS_SCHEME', 'tcp'),
         ],
+        'doctrine_cache' => [
+            'host' => env('REDIS_HOST'),
+            'port' => env('REDIS_PORT'),
+            'database' => env('REDIS_DOCTRINE_CACHE_DB', 5),
+            'password' => env('REDIS_PASSWORD'),
+            'timeout' => env('REDIS_TIMEOUT', 30.0),
+            'scheme' => env('REDIS_SCHEME', 'tcp'),
+        ],
     ],
     'allow_disabled_pk' => env('ALLOW_DISABLED_PK', false),
 ];

config/doctrine.php

@@ -227,22 +227,27 @@
             'region_lifetime'        => 3600,
             'region_lock_lifetime'   => 60,
             'regions'                => [
-
             ],
             'log_enabled'  => true,
             'file_lock_region_directory' => '/tmp'
         ],
         'metadata'         => [
             'driver'       => env('DOCTRINE_METADATA_CACHE', env('DOCTRINE_CACHE', 'redis')),
-            'namespace'    => null,
+            'namespace'    => 'meta',
+            'store'        => env('DOCTRINE_QUERY_CACHE_STORE', 'doctrine_redis'),
+            'lifetime'     => 7200, // 1 hour
         ],
         'query'            => [
             'driver'       => env('DOCTRINE_QUERY_CACHE', env('DOCTRINE_CACHE', 'redis')),
-            'namespace'    => null,
+            'namespace'    => 'qry',
+            'store'        => env('DOCTRINE_QUERY_CACHE_STORE', 'doctrine_redis'),
+            'lifetime'     => 3600, // 1 hour
         ],
         'result'           => [
             'driver'       => env('DOCTRINE_RESULT_CACHE', env('DOCTRINE_CACHE', 'redis')),
-            'namespace'    => null,
+            'namespace'    => 'res',
+            'store'        => env('DOCTRINE_QUERY_CACHE_STORE', 'doctrine_redis'),
+            'lifetime'     => 3600, // 1 hour
         ],
     ],