version upgrade: cache cleanup service added to clear caches that can not deserialize anymore due to schema upgrade

application/src/main/java/org/thingsboard/server/install/ThingsboardInstallService.java

@@ -31,6 +31,7 @@ import org.thingsboard.server.service.install.TsDatabaseSchemaService;
 import org.thingsboard.server.service.install.TsLatestDatabaseSchemaService;
 import org.thingsboard.server.service.install.migrate.EntitiesMigrateService;
 import org.thingsboard.server.service.install.migrate.TsLatestMigrateService;
+import org.thingsboard.server.service.install.update.CacheCleanupService;
 import org.thingsboard.server.service.install.update.DataUpdateService;
 
 @Service
@@ -74,6 +75,9 @@ public class ThingsboardInstallService {
     @Autowired
     private DataUpdateService dataUpdateService;
 
+    @Autowired
+    private CacheCleanupService cacheCleanupService;
+
     @Autowired(required = false)
     private EntitiesMigrateService entitiesMigrateService;
 
@@ -85,6 +89,8 @@ public class ThingsboardInstallService {
             if (isUpgrade) {
                 log.info("Starting ThingsBoard Upgrade from version {} ...", upgradeFromVersion);
 
+                cacheCleanupService.clearCache(upgradeFromVersion);
+
                 if ("2.5.0-cassandra".equals(upgradeFromVersion)) {
                     log.info("Migrating ThingsBoard entities data from cassandra to SQL database ...");
                     entitiesMigrateService.migrate();
@@ -207,6 +213,9 @@ public class ThingsboardInstallService {
                             log.info("Updating system data...");
                             systemDataLoaderService.updateSystemWidgets();
                             break;
+
+                        //TODO update CacheCleanupService on the next version upgrade
+
                         default:
                             throw new RuntimeException("Unable to upgrade ThingsBoard, unsupported fromVersion: " + upgradeFromVersion);
 

application/src/main/java/org/thingsboard/server/service/install/update/CacheCleanupService.java

@@ -0,0 +1,22 @@
+/**
+ * Copyright © 2016-2021 The Thingsboard Authors
+ *
+ * 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.
+ */
+package org.thingsboard.server.service.install.update;
+
+public interface CacheCleanupService {
+
+    void clearCache(String fromVersion) throws Exception;
+
+}

application/src/main/java/org/thingsboard/server/service/install/update/DefaultCacheCleanupService.java

@@ -0,0 +1,75 @@
+/**
+ * Copyright © 2016-2021 The Thingsboard Authors
+ *
+ * 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.
+ */
+package org.thingsboard.server.service.install.update;
+
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.cache.Cache;
+import org.springframework.cache.CacheManager;
+import org.springframework.context.annotation.Profile;
+import org.springframework.stereotype.Service;
+
+import java.util.Objects;
+
+@Service
+@Profile("install")
+@Slf4j
+public class DefaultCacheCleanupService implements CacheCleanupService {
+
+    @Autowired
+    CacheManager cacheManager;
+
+    /**
+     * Cleanup caches that can not deserialize anymore due to schema upgrade or data update using sql scripts.
+     * Refer to SqlDatabaseUpgradeService and /data/upgrage/*.sql
+     * to discover which tables were changed
+     * */
+    @Override
+    public void clearCache(String fromVersion) throws Exception {
+        switch (fromVersion) {
+            case "3.0.1":
+                log.info("Clear cache to upgrade from version 3.0.1 to 3.1.0 ...");
+                clearAllCaches();
+                //do not break to show explicit calls for next versions
+            case "3.1.1":
+                log.info("Clear cache to upgrade from version 3.1.1 to 3.2.0 ...");
+                clearCacheByName("devices");
+                clearCacheByName("deviceProfiles");
+                clearCacheByName("tenantProfiles");
+            case "3.2.2":
+                log.info("Clear cache to upgrade from version 3.2.2 to 3.3.0 ...");
+                clearCacheByName("devices");
+                clearCacheByName("deviceProfiles");
+                clearCacheByName("tenantProfiles");
+                clearCacheByName("relations");
+
+                break;
+            default:
+                throw new RuntimeException("Unable to update cache, unsupported fromVersion: " + fromVersion);
+        }
+    }
+
+    void clearAllCaches() {
+        cacheManager.getCacheNames().forEach(this::clearCacheByName);
+    }
+
+    void clearCacheByName(final String cacheName) {
+        Cache cache = cacheManager.getCache(cacheName);
+        Objects.requireNonNull(cache, "Cache does not exist for name " + cacheName);
+        cache.clear();
+    }
+
+}