From 11cb43a115a6feb240497075430454aeaa12a475 Mon Sep 17 00:00:00 2001
From: Andrii Landiak <andriylandiak@gmail.com>
Date: Tue, 31 Dec 2024 16:34:40 +0200
Subject: [PATCH 1/4] Redis-cache: relatedEdges changed key, lua improvement

---
 .../src/main/resources/thingsboard.yml        |  2 +-
 .../cache/RedisTbTransactionalCache.java      | 29 +++++++++++++++++++
 .../server/cache/VersionedRedisTbCache.java   | 28 ++----------------
 .../cache/edge/RelatedEdgesCacheKey.java      |  2 +-
 4 files changed, 33 insertions(+), 28 deletions(-)

diff --git a/application/src/main/resources/thingsboard.yml b/application/src/main/resources/thingsboard.yml
index 066c1468fb..32fd62670d 100644
--- a/application/src/main/resources/thingsboard.yml
+++ b/application/src/main/resources/thingsboard.yml
@@ -600,7 +600,7 @@ cache:
       maxSize: "${CACHE_SPECS_EDGE_SESSIONS_MAX_SIZE:10000}" # 0 means the cache is disabled
     relatedEdges:
       timeToLiveInMinutes: "${CACHE_SPECS_RELATED_EDGES_TTL:1440}" # Related Edges cache TTL
-      maxSize: "${CACHE_SPECS_RELATED_EDGES_MAX_SIZE:0}" # 0 means the cache is disabled
+      maxSize: "${CACHE_SPECS_RELATED_EDGES_MAX_SIZE:10000}" # 0 means the cache is disabled
     repositorySettings:
       timeToLiveInMinutes: "${CACHE_SPECS_REPOSITORY_SETTINGS_TTL:1440}" # Repository settings cache TTL
       maxSize: "${CACHE_SPECS_REPOSITORY_SETTINGS_MAX_SIZE:10000}" # 0 means the cache is disabled
diff --git a/common/cache/src/main/java/org/thingsboard/server/cache/RedisTbTransactionalCache.java b/common/cache/src/main/java/org/thingsboard/server/cache/RedisTbTransactionalCache.java
index 8ee58ab8eb..1eee03ccf9 100644
--- a/common/cache/src/main/java/org/thingsboard/server/cache/RedisTbTransactionalCache.java
+++ b/common/cache/src/main/java/org/thingsboard/server/cache/RedisTbTransactionalCache.java
@@ -19,9 +19,11 @@ import lombok.Getter;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.cache.support.NullValue;
+import org.springframework.dao.InvalidDataAccessApiUsageException;
 import org.springframework.data.redis.connection.RedisConnection;
 import org.springframework.data.redis.connection.RedisConnectionFactory;
 import org.springframework.data.redis.connection.RedisStringCommands;
+import org.springframework.data.redis.connection.ReturnType;
 import org.springframework.data.redis.connection.jedis.JedisClusterConnection;
 import org.springframework.data.redis.connection.jedis.JedisConnection;
 import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
@@ -269,4 +271,31 @@ public abstract class RedisTbTransactionalCache<K extends Serializable, V extend
         connection.stringCommands().set(rawKey, rawValue, this.cacheTtl, setOption);
     }
 
+    protected void loadLuaScript(byte[] expectedSha, byte[] luaScript) {
+        try (var connection = getConnection(expectedSha)) {
+            log.debug("Loading LUA with expected SHA [{}], connection [{}]", new String(expectedSha), connection.getNativeConnection());
+            String actualSha = connection.scriptingCommands().scriptLoad(luaScript);
+            if (!Arrays.equals(expectedSha, StringRedisSerializer.UTF_8.serialize(actualSha))) {
+                String message = String.format("SHA for LUA script wrong! Expected [%s], but actual [%s], connection [%s]",
+                        new String(expectedSha), actualSha, connection.getNativeConnection());
+                throw new IllegalStateException(message);
+            }
+        }
+    }
+
+    protected void executeScript(RedisConnection connection, byte[] scriptSha, byte[] luaScript, ReturnType returnType, int numKeys, byte[]... keysAndArgs) {
+        try {
+            connection.scriptingCommands().evalSha(scriptSha, returnType, numKeys, keysAndArgs);
+        } catch (InvalidDataAccessApiUsageException e) {
+            log.debug("Loading LUA [{}]", connection.getNativeConnection());
+            connection.scriptingCommands().scriptLoad(luaScript);
+            try {
+                connection.scriptingCommands().evalSha(scriptSha, returnType, numKeys, keysAndArgs);
+            } catch (InvalidDataAccessApiUsageException ignored) {
+                log.debug("Slowly executing eval instead of fast evalsha");
+                connection.scriptingCommands().eval(luaScript, returnType, numKeys, keysAndArgs);
+            }
+        }
+    }
+
 }
diff --git a/common/cache/src/main/java/org/thingsboard/server/cache/VersionedRedisTbCache.java b/common/cache/src/main/java/org/thingsboard/server/cache/VersionedRedisTbCache.java
index e9b64822e9..daf33bbc40 100644
--- a/common/cache/src/main/java/org/thingsboard/server/cache/VersionedRedisTbCache.java
+++ b/common/cache/src/main/java/org/thingsboard/server/cache/VersionedRedisTbCache.java
@@ -18,7 +18,6 @@ package org.thingsboard.server.cache;
 import jakarta.annotation.PostConstruct;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.NotImplementedException;
-import org.springframework.dao.InvalidDataAccessApiUsageException;
 import org.springframework.data.redis.connection.RedisConnection;
 import org.springframework.data.redis.connection.RedisConnectionFactory;
 import org.springframework.data.redis.connection.ReturnType;
@@ -27,7 +26,6 @@ import org.springframework.data.redis.serializer.StringRedisSerializer;
 import org.thingsboard.server.common.data.HasVersion;
 
 import java.io.Serializable;
-import java.util.Arrays;
 
 @Slf4j
 public abstract class VersionedRedisTbCache<K extends VersionedCacheKey, V extends Serializable & HasVersion> extends RedisTbTransactionalCache<K, V> implements VersionedTbCache<K, V> {
@@ -67,15 +65,7 @@ public abstract class VersionedRedisTbCache<K extends VersionedCacheKey, V exten
 
     @PostConstruct
     public void init() {
-        try (var connection = getConnection(SET_VERSIONED_VALUE_SHA)) {
-            log.debug("Loading LUA with expected SHA[{}], connection [{}]", new String(SET_VERSIONED_VALUE_SHA), connection.getNativeConnection());
-            String sha = connection.scriptingCommands().scriptLoad(SET_VERSIONED_VALUE_LUA_SCRIPT);
-            if (!Arrays.equals(SET_VERSIONED_VALUE_SHA, StringRedisSerializer.UTF_8.serialize(sha))) {
-                log.error("SHA for SET_VERSIONED_VALUE_LUA_SCRIPT wrong! Expected [{}], but actual [{}], connection [{}]", new String(SET_VERSIONED_VALUE_SHA), sha, connection.getNativeConnection());
-            }
-        } catch (Throwable t) {
-            log.error("Error on Redis versioned cache init", t);
-        }
+        loadLuaScript(SET_VERSIONED_VALUE_SHA, SET_VERSIONED_VALUE_LUA_SCRIPT);
     }
 
     @Override
@@ -129,21 +119,7 @@ public abstract class VersionedRedisTbCache<K extends VersionedCacheKey, V exten
         byte[] rawValue = getRawValue(value);
         byte[] rawVersion = StringRedisSerializer.UTF_8.serialize(String.valueOf(version));
         byte[] rawExpiration = StringRedisSerializer.UTF_8.serialize(String.valueOf(expiration.getExpirationTimeInSeconds()));
-        try {
-            connection.scriptingCommands().evalSha(SET_VERSIONED_VALUE_SHA, ReturnType.VALUE, 1, rawKey, rawValue, rawVersion, rawExpiration);
-        } catch (InvalidDataAccessApiUsageException e) {
-            log.debug("loading LUA [{}]", connection.getNativeConnection());
-            String sha = connection.scriptingCommands().scriptLoad(SET_VERSIONED_VALUE_LUA_SCRIPT);
-            if (!Arrays.equals(SET_VERSIONED_VALUE_SHA, StringRedisSerializer.UTF_8.serialize(sha))) {
-                log.error("SHA for SET_VERSIONED_VALUE_LUA_SCRIPT wrong! Expected [{}], but actual [{}]", new String(SET_VERSIONED_VALUE_SHA), sha);
-            }
-            try {
-                connection.scriptingCommands().evalSha(SET_VERSIONED_VALUE_SHA, ReturnType.VALUE, 1, rawKey, rawValue, rawVersion, rawExpiration);
-            } catch (InvalidDataAccessApiUsageException ignored) {
-                log.debug("Slowly executing eval instead of fast evalsha");
-                connection.scriptingCommands().eval(SET_VERSIONED_VALUE_LUA_SCRIPT, ReturnType.VALUE, 1, rawKey, rawValue, rawVersion, rawExpiration);
-            }
-        }
+        executeScript(connection, SET_VERSIONED_VALUE_SHA, SET_VERSIONED_VALUE_LUA_SCRIPT, ReturnType.VALUE, 1, rawKey, rawValue, rawVersion, rawExpiration);
     }
 
     @Override
diff --git a/common/cache/src/main/java/org/thingsboard/server/cache/edge/RelatedEdgesCacheKey.java b/common/cache/src/main/java/org/thingsboard/server/cache/edge/RelatedEdgesCacheKey.java
index 7fbf24bb40..afeecff0e8 100644
--- a/common/cache/src/main/java/org/thingsboard/server/cache/edge/RelatedEdgesCacheKey.java
+++ b/common/cache/src/main/java/org/thingsboard/server/cache/edge/RelatedEdgesCacheKey.java
@@ -39,7 +39,7 @@ public class RelatedEdgesCacheKey implements Serializable {
 
     @Override
     public String toString() {
-        return tenantId + "_" + entityId;
+        return "{" + tenantId + "}" + entityId;
     }
 
 }

From b5ca7e655fc33b5d1acc75a59e2306d62470ef93 Mon Sep 17 00:00:00 2001
From: Andrii Landiak <andriylandiak@gmail.com>
Date: Thu, 9 Jan 2025 10:29:38 +0200
Subject: [PATCH 2/4] Increate log level to warn for evalSha

---
 .../server/cache/RedisTbTransactionalCache.java           | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/common/cache/src/main/java/org/thingsboard/server/cache/RedisTbTransactionalCache.java b/common/cache/src/main/java/org/thingsboard/server/cache/RedisTbTransactionalCache.java
index 1eee03ccf9..c3ce4b356f 100644
--- a/common/cache/src/main/java/org/thingsboard/server/cache/RedisTbTransactionalCache.java
+++ b/common/cache/src/main/java/org/thingsboard/server/cache/RedisTbTransactionalCache.java
@@ -286,13 +286,13 @@ public abstract class RedisTbTransactionalCache<K extends Serializable, V extend
     protected void executeScript(RedisConnection connection, byte[] scriptSha, byte[] luaScript, ReturnType returnType, int numKeys, byte[]... keysAndArgs) {
         try {
             connection.scriptingCommands().evalSha(scriptSha, returnType, numKeys, keysAndArgs);
-        } catch (InvalidDataAccessApiUsageException e) {
-            log.debug("Loading LUA [{}]", connection.getNativeConnection());
+        } catch (InvalidDataAccessApiUsageException exception) {
+            log.warn("Loading LUA [{}]", connection.getNativeConnection(), exception);
             connection.scriptingCommands().scriptLoad(luaScript);
             try {
                 connection.scriptingCommands().evalSha(scriptSha, returnType, numKeys, keysAndArgs);
-            } catch (InvalidDataAccessApiUsageException ignored) {
-                log.debug("Slowly executing eval instead of fast evalsha");
+            } catch (InvalidDataAccessApiUsageException ex) {
+                log.warn("Slowly executing eval instead of fast evalSha", ex);
                 connection.scriptingCommands().eval(luaScript, returnType, numKeys, keysAndArgs);
             }
         }

From f4372feff999fbebb8b607807fc2af9f8730eed9 Mon Sep 17 00:00:00 2001
From: Andrii Landiak <andriylandiak@gmail.com>
Date: Thu, 9 Jan 2025 11:10:35 +0200
Subject: [PATCH 3/4] Improvement for logs in executeScript

---
 .../server/cache/RedisTbTransactionalCache.java           | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/common/cache/src/main/java/org/thingsboard/server/cache/RedisTbTransactionalCache.java b/common/cache/src/main/java/org/thingsboard/server/cache/RedisTbTransactionalCache.java
index c3ce4b356f..97fc36fe27 100644
--- a/common/cache/src/main/java/org/thingsboard/server/cache/RedisTbTransactionalCache.java
+++ b/common/cache/src/main/java/org/thingsboard/server/cache/RedisTbTransactionalCache.java
@@ -286,13 +286,13 @@ public abstract class RedisTbTransactionalCache<K extends Serializable, V extend
     protected void executeScript(RedisConnection connection, byte[] scriptSha, byte[] luaScript, ReturnType returnType, int numKeys, byte[]... keysAndArgs) {
         try {
             connection.scriptingCommands().evalSha(scriptSha, returnType, numKeys, keysAndArgs);
-        } catch (InvalidDataAccessApiUsageException exception) {
-            log.warn("Loading LUA [{}]", connection.getNativeConnection(), exception);
+        } catch (InvalidDataAccessApiUsageException ignored) {
+            log.debug("Loading LUA [{}]", connection.getNativeConnection());
             connection.scriptingCommands().scriptLoad(luaScript);
             try {
                 connection.scriptingCommands().evalSha(scriptSha, returnType, numKeys, keysAndArgs);
-            } catch (InvalidDataAccessApiUsageException ex) {
-                log.warn("Slowly executing eval instead of fast evalSha", ex);
+            } catch (InvalidDataAccessApiUsageException exception) {
+                log.warn("Slowly executing eval instead of fast evalSha", exception);
                 connection.scriptingCommands().eval(luaScript, returnType, numKeys, keysAndArgs);
             }
         }

From 5d07beb0dedcee4182f817130e21b5a20e9864be Mon Sep 17 00:00:00 2001
From: Andrii Landiak <andriylandiak@gmail.com>
Date: Mon, 20 Jan 2025 17:44:09 +0200
Subject: [PATCH 4/4] Refactor executeScript to not load script on init, but on
 execute

---
 .../cache/RedisTbTransactionalCache.java      | 21 +++++++------------
 .../server/cache/VersionedRedisTbCache.java   |  6 ------
 2 files changed, 7 insertions(+), 20 deletions(-)

diff --git a/common/cache/src/main/java/org/thingsboard/server/cache/RedisTbTransactionalCache.java b/common/cache/src/main/java/org/thingsboard/server/cache/RedisTbTransactionalCache.java
index 97fc36fe27..379f08af37 100644
--- a/common/cache/src/main/java/org/thingsboard/server/cache/RedisTbTransactionalCache.java
+++ b/common/cache/src/main/java/org/thingsboard/server/cache/RedisTbTransactionalCache.java
@@ -271,24 +271,17 @@ public abstract class RedisTbTransactionalCache<K extends Serializable, V extend
         connection.stringCommands().set(rawKey, rawValue, this.cacheTtl, setOption);
     }
 
-    protected void loadLuaScript(byte[] expectedSha, byte[] luaScript) {
-        try (var connection = getConnection(expectedSha)) {
-            log.debug("Loading LUA with expected SHA [{}], connection [{}]", new String(expectedSha), connection.getNativeConnection());
-            String actualSha = connection.scriptingCommands().scriptLoad(luaScript);
-            if (!Arrays.equals(expectedSha, StringRedisSerializer.UTF_8.serialize(actualSha))) {
-                String message = String.format("SHA for LUA script wrong! Expected [%s], but actual [%s], connection [%s]",
-                        new String(expectedSha), actualSha, connection.getNativeConnection());
-                throw new IllegalStateException(message);
-            }
-        }
-    }
-
     protected void executeScript(RedisConnection connection, byte[] scriptSha, byte[] luaScript, ReturnType returnType, int numKeys, byte[]... keysAndArgs) {
         try {
             connection.scriptingCommands().evalSha(scriptSha, returnType, numKeys, keysAndArgs);
         } catch (InvalidDataAccessApiUsageException ignored) {
-            log.debug("Loading LUA [{}]", connection.getNativeConnection());
-            connection.scriptingCommands().scriptLoad(luaScript);
+            log.debug("Loading LUA with expected SHA [{}], connection [{}]", new String(scriptSha), connection.getNativeConnection());
+            String actualSha = connection.scriptingCommands().scriptLoad(luaScript);
+            if (!Arrays.equals(scriptSha, StringRedisSerializer.UTF_8.serialize(actualSha))) {
+                String message = String.format("SHA for LUA script wrong! Expected [%s], but actual [%s], connection [%s]",
+                        new String(scriptSha), actualSha, connection.getNativeConnection());
+                throw new IllegalStateException(message);
+            }
             try {
                 connection.scriptingCommands().evalSha(scriptSha, returnType, numKeys, keysAndArgs);
             } catch (InvalidDataAccessApiUsageException exception) {
diff --git a/common/cache/src/main/java/org/thingsboard/server/cache/VersionedRedisTbCache.java b/common/cache/src/main/java/org/thingsboard/server/cache/VersionedRedisTbCache.java
index daf33bbc40..b73bd49762 100644
--- a/common/cache/src/main/java/org/thingsboard/server/cache/VersionedRedisTbCache.java
+++ b/common/cache/src/main/java/org/thingsboard/server/cache/VersionedRedisTbCache.java
@@ -15,7 +15,6 @@
  */
 package org.thingsboard.server.cache;
 
-import jakarta.annotation.PostConstruct;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.NotImplementedException;
 import org.springframework.data.redis.connection.RedisConnection;
@@ -63,11 +62,6 @@ public abstract class VersionedRedisTbCache<K extends VersionedCacheKey, V exten
         super(cacheName, cacheSpecsMap, connectionFactory, configuration, valueSerializer);
     }
 
-    @PostConstruct
-    public void init() {
-        loadLuaScript(SET_VERSIONED_VALUE_SHA, SET_VERSIONED_VALUE_LUA_SCRIPT);
-    }
-
     @Override
     protected byte[] doGet(K key, RedisConnection connection) {
         if (!key.isVersioned()) {