#1039 Redis Cache configuration

Author: dcoraboeuf

ontrack-model/src/main/java/net/nemerosa/ontrack/model/settings/SecuritySettings.kt

@@ -12,7 +12,7 @@ import net.nemerosa.ontrack.model.form.YesNo
  * @property isGrantProjectParticipationToAll `true` when all authenticated users have a participant access to all projects.
  */
 @APIDescription("General security settings")
-class SecuritySettings(
+data class SecuritySettings(
     @get:JsonProperty("grantProjectViewToAll")
     @APIDescription("Grants project view to all")
     val isGrantProjectViewToAll: Boolean,

ontrack-repository-impl/src/main/java/net/nemerosa/ontrack/repository/PropertyJdbcRepository.kt

@@ -8,8 +8,6 @@ import net.nemerosa.ontrack.model.structure.ProjectEntityType
 import net.nemerosa.ontrack.model.structure.PropertySearchArguments
 import net.nemerosa.ontrack.repository.support.AbstractJdbcRepository
 import org.apache.commons.lang3.StringUtils
-import org.springframework.cache.annotation.CacheEvict
-import org.springframework.cache.annotation.Cacheable
 import org.springframework.jdbc.core.namedparam.MapSqlParameterSource
 import org.springframework.stereotype.Repository
 import java.lang.String.format
@@ -36,7 +34,6 @@ class PropertyJdbcRepository(
         ).isNotEmpty()
     }
 
-    @Cacheable(cacheNames = ["properties"], key = "#typeName + #entityType.name() + #entityId.value")
     override fun loadProperty(typeName: String, entityType: ProjectEntityType, entityId: ID): TProperty? {
         return getFirstItem(
                 String.format(
@@ -47,7 +44,6 @@ class PropertyJdbcRepository(
         ) { rs, rowNum -> toProperty(rs) }
     }
 
-    @CacheEvict(cacheNames = ["properties"], key = "#typeName + #entityType.name() + #entityId.value")
     override fun saveProperty(typeName: String, entityType: ProjectEntityType, entityId: ID, data: JsonNode) {
         val params = params("type", typeName).addValue("entityId", entityId.value)
         // Any previous value?
@@ -78,7 +74,6 @@ class PropertyJdbcRepository(
         }// Creation
     }
 
-    @CacheEvict(cacheNames = ["properties"], key = "#typeName + #entityType.name() + #entityId.value")
     override fun deleteProperty(typeName: String, entityType: ProjectEntityType, entityId: ID): Ack {
         return Ack.one(
                 namedParameterJdbcTemplate!!.update(

ontrack-service/src/main/java/net/nemerosa/ontrack/service/CacheConfig.kt

@@ -1,8 +1,48 @@
 package net.nemerosa.ontrack.service
 
+import net.nemerosa.ontrack.common.Caches
+import net.nemerosa.ontrack.extension.api.CacheConfigExtension
+import org.springframework.boot.autoconfigure.cache.RedisCacheManagerBuilderCustomizer
 import org.springframework.cache.annotation.EnableCaching
+import org.springframework.context.annotation.Bean
 import org.springframework.context.annotation.Configuration
+import org.springframework.data.redis.cache.RedisCacheConfiguration
+import org.springframework.data.redis.serializer.RedisSerializationContext.SerializationPair
+import java.time.Duration
 
 @Configuration
 @EnableCaching
-class CacheConfig
+class CacheConfig {
+
+    @Bean
+    fun redisCacheManagerBuilderCustomizer(
+        cacheConfigExtensions: List<CacheConfigExtension>,
+    ) = RedisCacheManagerBuilderCustomizer { builder ->
+        // Core caches
+        builder.withCacheConfiguration(
+            Caches.SETTINGS,
+            RedisCacheConfiguration
+                .defaultCacheConfig(null)
+                .entryTtl(Duration.ofHours(1))
+                .serializeValuesWith(
+                    SerializationPair.fromSerializer(
+                        TypedJsonRedisSerializer.instance
+                    )
+                )
+        )
+        // Extensions
+        cacheConfigExtensions.forEach { extension ->
+            extension.caches.forEach { (name, config) ->
+                RedisCacheConfiguration
+                    .defaultCacheConfig(null)
+                    .entryTtl(config.ttl)
+                    .serializeValuesWith(
+                        SerializationPair.fromSerializer(
+                            TypedJsonRedisSerializer.instance
+                        )
+                    )
+            }
+        }
+    }
+
+}

ontrack-service/src/main/java/net/nemerosa/ontrack/service/CacheConfigCustomizer.kt

@@ -0,0 +1,36 @@
+package net.nemerosa.ontrack.service
+
+import com.fasterxml.jackson.databind.JsonNode
+import net.nemerosa.ontrack.json.*
+import org.springframework.data.redis.serializer.RedisSerializer
+
+class TypedJsonRedisSerializer private constructor() : RedisSerializer<Any> {
+
+    companion object {
+        val instance = TypedJsonRedisSerializer()
+    }
+
+    override fun serialize(t: Any?): ByteArray? = if (t != null) {
+        val data = TypedJson(
+            type = t::class.java.name,
+            value = t.asJson(),
+        )
+        data.asJson().asJsonString().toByteArray(Charsets.UTF_8)
+    } else {
+        null
+    }
+
+    override fun deserialize(bytes: ByteArray?): Any? = if (bytes != null) {
+        val data = bytes.toString(Charsets.UTF_8).parseAsJson().parse<TypedJson>()
+        val type = Class.forName(data.type)
+        JsonUtils.parse(data.value, type)
+    } else {
+        null
+    }
+
+    private data class TypedJson(
+        val type: String,
+        val value: JsonNode,
+    )
+
+}

ontrack-service/src/main/java/net/nemerosa/ontrack/service/TypedJsonRedisSerializer.kt

@@ -0,0 +1,28 @@
+package net.nemerosa.ontrack.service
+
+import net.nemerosa.ontrack.model.settings.SecuritySettings
+import org.junit.jupiter.api.Test
+import kotlin.test.assertEquals
+
+internal class TypedJsonRedisSerializerTest {
+
+    @Test
+    fun `Serialization and deserialization`() {
+        val serializer = TypedJsonRedisSerializer.instance
+        val settings = SecuritySettings(
+            isGrantProjectViewToAll = false,
+            isGrantProjectParticipationToAll = false,
+            builtInAuthenticationEnabled = false,
+        )
+        val loaded = serializer.deserialize(serializer.serialize(settings))
+        assertEquals(settings, loaded)
+    }
+
+    @Test
+    fun `Serialization and deserialization for null`() {
+        val serializer = TypedJsonRedisSerializer.instance
+        val loaded = serializer.deserialize(serializer.serialize(null))
+        assertEquals(null, loaded)
+    }
+
+}

ontrack-service/src/test/java/net/nemerosa/ontrack/service/TypedJsonRedisSerializerTest.kt

@@ -15,6 +15,10 @@ spring:
   # Default profile
   profiles:
     default: prod
+  # Cache configuration
+  cache:
+    redis:
+      enable-statistics: true
 
 # Compression of web resources
 server: