Refactoring - implement method to find latest edge version instead of hardcoded

application/src/main/java/org/thingsboard/server/service/edge/instructions/BaseEdgeInstallUpgradeInstructionsService.java

@@ -18,7 +18,6 @@ package org.thingsboard.server.service.edge.instructions;
 import lombok.RequiredArgsConstructor;
 import lombok.Setter;
 import lombok.extern.slf4j.Slf4j;
-import org.thingsboard.server.gen.edge.v1.EdgeVersion;
 import org.thingsboard.server.service.install.InstallScripts;
 
 import java.io.IOException;
@@ -26,6 +25,8 @@ import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 
+import static org.thingsboard.edge.rpc.EdgeGrpcClient.getNewestEdgeVersion;
+
 @Slf4j
 @RequiredArgsConstructor
 public abstract class BaseEdgeInstallUpgradeInstructionsService {
@@ -36,7 +37,7 @@ public abstract class BaseEdgeInstallUpgradeInstructionsService {
     private final InstallScripts installScripts;
 
     @Setter
-    protected String edgeVersion = convertEdgeVersionToDocsFormat(EdgeVersion.V_4_2_0.name());
+    protected String platformEdgeVersion = convertEdgeVersionToDocsFormat(getNewestEdgeVersion().name());
 
     protected String convertEdgeVersionToDocsFormat(String edgeVersion) {
         return edgeVersion.replace("_", ".").substring(2);

application/src/main/java/org/thingsboard/server/service/edge/instructions/DefaultEdgeInstallInstructionsService.java

@@ -65,7 +65,7 @@ public class DefaultEdgeInstallInstructionsService extends BaseEdgeInstallUpgrad
             dockerInstallInstructions = dockerInstallInstructions.replace("${EXTRA_HOSTS}", "");
             dockerInstallInstructions = dockerInstallInstructions.replace("${BASE_URL}", baseUrl);
         }
-        dockerInstallInstructions = dockerInstallInstructions.replace("${TB_EDGE_VERSION}", edgeVersion + "EDGE");
+        dockerInstallInstructions = dockerInstallInstructions.replace("${TB_EDGE_VERSION}", platformEdgeVersion + "EDGE");
         dockerInstallInstructions = replacePlaceholders(dockerInstallInstructions, edge);
         return new EdgeInstructions(dockerInstallInstructions);
     }
@@ -74,8 +74,8 @@ public class DefaultEdgeInstallInstructionsService extends BaseEdgeInstallUpgrad
         String ubuntuInstallInstructions = readFile(resolveFile(os, "instructions.md"));
         ubuntuInstallInstructions = replacePlaceholders(ubuntuInstallInstructions, edge);
         ubuntuInstallInstructions = ubuntuInstallInstructions.replace("${BASE_URL}", request.getServerName());
-        ubuntuInstallInstructions = ubuntuInstallInstructions.replace("${TB_EDGE_VERSION}", edgeVersion);
+        ubuntuInstallInstructions = ubuntuInstallInstructions.replace("${TB_EDGE_VERSION}", platformEdgeVersion);
-        ubuntuInstallInstructions = ubuntuInstallInstructions.replace("${TB_EDGE_TAG}", getTagVersion(edgeVersion));
+        ubuntuInstallInstructions = ubuntuInstallInstructions.replace("${TB_EDGE_TAG}", getTagVersion(platformEdgeVersion));
         return new EdgeInstructions(ubuntuInstallInstructions);
     }
 

application/src/main/java/org/thingsboard/server/service/edge/instructions/DefaultEdgeUpgradeInstructionsService.java

@@ -54,9 +54,9 @@ public class DefaultEdgeUpgradeInstructionsService extends BaseEdgeInstallUpgrad
     public EdgeInstructions getUpgradeInstructions(String edgeVersion, String upgradeMethod) {
         String currentEdgeVersion = convertEdgeVersionToDocsFormat(edgeVersion);
         return switch (upgradeMethod.toLowerCase()) {
-            case "docker" -> getDockerUpgradeInstructions(this.edgeVersion, currentEdgeVersion);
+            case "docker" -> getDockerUpgradeInstructions(this.platformEdgeVersion, currentEdgeVersion);
             case "ubuntu", "centos" ->
-                    getLinuxUpgradeInstructions(this.edgeVersion, currentEdgeVersion, upgradeMethod.toLowerCase());
+                    getLinuxUpgradeInstructions(this.platformEdgeVersion, currentEdgeVersion, upgradeMethod.toLowerCase());
             default -> throw new IllegalArgumentException("Unsupported upgrade method for Edge: " + upgradeMethod);
         };
     }
@@ -73,7 +73,7 @@ public class DefaultEdgeUpgradeInstructionsService extends BaseEdgeInstallUpgrad
         Optional<AttributeKvEntry> attributeKvEntryOpt = attributesService.find(tenantId, edgeId, AttributeScope.SERVER_SCOPE, DataConstants.EDGE_VERSION_ATTR_KEY).get();
         if (attributeKvEntryOpt.isPresent()) {
             String edgeVersionFormatted = convertEdgeVersionToDocsFormat(attributeKvEntryOpt.get().getValueAsString());
-            return isVersionGreaterOrEqualsThan(edgeVersionFormatted, "3.6.0") && !isVersionGreaterOrEqualsThan(edgeVersionFormatted, edgeVersion);
+            return isVersionGreaterOrEqualsThan(edgeVersionFormatted, "3.6.0") && !isVersionGreaterOrEqualsThan(edgeVersionFormatted, platformEdgeVersion);
         }
         return false;
     }
@@ -96,13 +96,13 @@ public class DefaultEdgeUpgradeInstructionsService extends BaseEdgeInstallUpgrad
         return true;
     }
 
-    private EdgeInstructions getDockerUpgradeInstructions(String tbVersion, String currentEdgeVersion) {
+    private EdgeInstructions getDockerUpgradeInstructions(String platformEdgeVersion, String currentEdgeVersion) {
         EdgeUpgradeInfo edgeUpgradeInfo = upgradeVersionHashMap.get(currentEdgeVersion);
-        if (edgeUpgradeInfo == null || edgeUpgradeInfo.getNextEdgeVersion() == null || tbVersion.equals(currentEdgeVersion)) {
+        if (edgeUpgradeInfo == null || edgeUpgradeInfo.getNextEdgeVersion() == null || platformEdgeVersion.equals(currentEdgeVersion)) {
             return new EdgeInstructions("Edge upgrade instruction for " + currentEdgeVersion + "EDGE is not available.");
         }
         StringBuilder result = new StringBuilder(readFile(resolveFile("docker", "upgrade_preparing.md")));
-        while (edgeUpgradeInfo.getNextEdgeVersion() != null && !tbVersion.equals(currentEdgeVersion)) {
+        while (edgeUpgradeInfo.getNextEdgeVersion() != null && !platformEdgeVersion.equals(currentEdgeVersion)) {
             String edgeVersion = edgeUpgradeInfo.getNextEdgeVersion();
             String dockerUpgradeInstructions = readFile(resolveFile("docker", "instructions.md"));
             if (edgeUpgradeInfo.isRequiresUpdateDb()) {
@@ -123,15 +123,15 @@ public class DefaultEdgeUpgradeInstructionsService extends BaseEdgeInstallUpgrad
         return new EdgeInstructions(result.toString());
     }
 
-    private EdgeInstructions getLinuxUpgradeInstructions(String tbVersion, String currentEdgeVersion, String os) {
+    private EdgeInstructions getLinuxUpgradeInstructions(String platformEdgeVersion, String currentEdgeVersion, String os) {
         EdgeUpgradeInfo edgeUpgradeInfo = upgradeVersionHashMap.get(currentEdgeVersion);
-        if (edgeUpgradeInfo == null || edgeUpgradeInfo.getNextEdgeVersion() == null || tbVersion.equals(currentEdgeVersion)) {
+        if (edgeUpgradeInfo == null || edgeUpgradeInfo.getNextEdgeVersion() == null || platformEdgeVersion.equals(currentEdgeVersion)) {
             return new EdgeInstructions("Edge upgrade instruction for " + currentEdgeVersion + "EDGE is not available.");
         }
         String upgrade_preparing = readFile(resolveFile("upgrade_preparing.md"));
         upgrade_preparing = upgrade_preparing.replace("${OS}", os.equals("centos") ? "RHEL/CentOS 7/8" : "Ubuntu");
         StringBuilder result = new StringBuilder(upgrade_preparing);
-        while (edgeUpgradeInfo.getNextEdgeVersion() != null && !tbVersion.equals(currentEdgeVersion)) {
+        while (edgeUpgradeInfo.getNextEdgeVersion() != null && !platformEdgeVersion.equals(currentEdgeVersion)) {
             String edgeVersion = edgeUpgradeInfo.getNextEdgeVersion();
             String linuxUpgradeInstructions = readFile(resolveFile(os, "instructions.md"));
             if (edgeUpgradeInfo.isRequiresUpdateDb()) {

application/src/main/java/org/thingsboard/server/service/edge/instructions/EdgeInstallInstructionsService.java

@@ -23,6 +23,6 @@ public interface EdgeInstallInstructionsService {
 
     EdgeInstructions getInstallInstructions(Edge edge, String installationMethod, HttpServletRequest request);
 
-    void setEdgeVersion(String version);
+    void setPlatformEdgeVersion(String version);
 
 }

application/src/main/java/org/thingsboard/server/service/edge/instructions/EdgeUpgradeInstructionsService.java

@@ -28,7 +28,7 @@ public interface EdgeUpgradeInstructionsService {
 
     void updateInstructionMap(Map<String, EdgeUpgradeInfo> upgradeVersions);
 
-    void setEdgeVersion(String version);
+    void setPlatformEdgeVersion(String version);
 
     boolean isUpgradeAvailable(TenantId tenantId, EdgeId edgeId) throws Exception;
 

application/src/main/java/org/thingsboard/server/service/update/DefaultUpdateService.java

@@ -150,10 +150,10 @@ public class DefaultUpdateService implements UpdateService {
                         .build());
             }
             ObjectNode edgeRequest = JacksonUtil.newObjectNode().put(VERSION_PARAM, version);
-            String edgeInstallVersion = restClient.postForObject(UPDATE_SERVER_BASE_URL + "/api/v1/edge/installMapping", new HttpEntity<>(edgeRequest.toString(), headers), String.class);
+            String edgePlatformVersion = restClient.postForObject(UPDATE_SERVER_BASE_URL + "/api/v1/edge/installMapping", new HttpEntity<>(edgeRequest.toString(), headers), String.class);
-            if (edgeInstallVersion != null) {
+            if (edgePlatformVersion != null) {
-                edgeInstallInstructionsService.setEdgeVersion(edgeInstallVersion);
+                edgeInstallInstructionsService.setPlatformEdgeVersion(edgePlatformVersion);
-                edgeUpgradeInstructionsService.setEdgeVersion(edgeInstallVersion);
+                edgeUpgradeInstructionsService.setPlatformEdgeVersion(edgePlatformVersion);
             }
             EdgeUpgradeMessage edgeUpgradeMessage = restClient.postForObject(UPDATE_SERVER_BASE_URL + "/api/v1/edge/upgradeMapping", new HttpEntity<>(edgeRequest.toString(), headers), EdgeUpgradeMessage.class);
             if (edgeUpgradeMessage != null) {

application/src/test/java/org/thingsboard/server/controller/EdgeControllerTest.java

@@ -1278,7 +1278,7 @@ public class EdgeControllerTest extends AbstractControllerTest {
 
     @Test
     public void testGetEdgeUpgradeInstructions() throws Exception {
-        // UpdateInfo config is updating from Thingsboard Update server
+        // UpdateInfo config is updating from the Thingsboard Update server
         HashMap<String, EdgeUpgradeInfo> upgradeInfoHashMap = new HashMap<>();
         upgradeInfoHashMap.put("3.6.0", new EdgeUpgradeInfo(true, "3.6.1"));
         upgradeInfoHashMap.put("3.6.1", new EdgeUpgradeInfo(true, "3.6.2"));
@@ -1301,35 +1301,31 @@ public class EdgeControllerTest extends AbstractControllerTest {
         // Test 3.5.0 Edge - upgrade not available
         String body = "{\"edgeVersion\": \"V_3_5_0\"}";
         doPostAsync("/api/plugins/telemetry/EDGE/" + savedEdge.getId().getId() + "/attributes/SERVER_SCOPE", body, String.class, status().isOk());
-        edgeUpgradeInstructionsService.setAppVersion("3.6.0");
+        edgeUpgradeInstructionsService.setPlatformEdgeVersion("3.6.0");
         Assert.assertFalse(edgeUpgradeInstructionsService.isUpgradeAvailable(savedEdge.getTenantId(), savedEdge.getId()));
-        edgeUpgradeInstructionsService.setAppVersion("3.6.2");
+        edgeUpgradeInstructionsService.setPlatformEdgeVersion("3.6.2");
         Assert.assertFalse(edgeUpgradeInstructionsService.isUpgradeAvailable(savedEdge.getTenantId(), savedEdge.getId()));
-        edgeUpgradeInstructionsService.setAppVersion("3.6.2.7");
+        edgeUpgradeInstructionsService.setPlatformEdgeVersion("3.6.2.7");
         Assert.assertFalse(edgeUpgradeInstructionsService.isUpgradeAvailable(savedEdge.getTenantId(), savedEdge.getId()));
 
         // Test 3.6.0 Edge - upgrade available
         body = "{\"edgeVersion\": \"V_3_6_0\"}";
         doPostAsync("/api/plugins/telemetry/EDGE/" + savedEdge.getId().getId() + "/attributes/SERVER_SCOPE", body, String.class, status().isOk());
-        edgeUpgradeInstructionsService.setAppVersion("3.6.0");
+        edgeUpgradeInstructionsService.setPlatformEdgeVersion("3.6.0");
         Assert.assertFalse(edgeUpgradeInstructionsService.isUpgradeAvailable(savedEdge.getTenantId(), savedEdge.getId()));
-        edgeUpgradeInstructionsService.setAppVersion("3.6.1.5");
+        edgeUpgradeInstructionsService.setPlatformEdgeVersion("3.6.1.5");
         Assert.assertTrue(edgeUpgradeInstructionsService.isUpgradeAvailable(savedEdge.getTenantId(), savedEdge.getId()));
-        edgeUpgradeInstructionsService.setAppVersion("3.6.1.6-SNAPSHOT");
+        edgeUpgradeInstructionsService.setPlatformEdgeVersion("3.6.2");
-        Assert.assertTrue(edgeUpgradeInstructionsService.isUpgradeAvailable(savedEdge.getTenantId(), savedEdge.getId()));
-        edgeUpgradeInstructionsService.setAppVersion("3.6.2");
         Assert.assertTrue(edgeUpgradeInstructionsService.isUpgradeAvailable(savedEdge.getTenantId(), savedEdge.getId()));
 
         // Test 3.6.1 Edge - upgrade available
         body = "{\"edgeVersion\": \"V_3_6_1\"}";
         doPostAsync("/api/plugins/telemetry/EDGE/" + savedEdge.getId().getId() + "/attributes/SERVER_SCOPE", body, String.class, status().isOk());
-        edgeUpgradeInstructionsService.setAppVersion("3.6.1");
+        edgeUpgradeInstructionsService.setPlatformEdgeVersion("3.6.1");
         Assert.assertFalse(edgeUpgradeInstructionsService.isUpgradeAvailable(savedEdge.getTenantId(), savedEdge.getId()));
-        edgeUpgradeInstructionsService.setAppVersion("3.6.2");
+        edgeUpgradeInstructionsService.setPlatformEdgeVersion("3.6.2");
-        Assert.assertTrue(edgeUpgradeInstructionsService.isUpgradeAvailable(savedEdge.getTenantId(), savedEdge.getId()));
-        edgeUpgradeInstructionsService.setAppVersion("3.6.2-SNAPSHOT");
         Assert.assertTrue(edgeUpgradeInstructionsService.isUpgradeAvailable(savedEdge.getTenantId(), savedEdge.getId()));
-        edgeUpgradeInstructionsService.setAppVersion("3.6.2.6");
+        edgeUpgradeInstructionsService.setPlatformEdgeVersion("3.6.2.6");
         Assert.assertTrue(edgeUpgradeInstructionsService.isUpgradeAvailable(savedEdge.getTenantId(), savedEdge.getId()));
     }
 

common/edge-api/src/main/java/org/thingsboard/edge/rpc/EdgeGrpcClient.java

@@ -136,12 +136,25 @@ public class EdgeGrpcClient implements EdgeRpcClient {
                 .setConnectRequestMsg(ConnectRequestMsg.newBuilder()
                         .setEdgeRoutingKey(edgeKey)
                         .setEdgeSecret(edgeSecret)
-                        .setEdgeVersion(EdgeVersion.V_4_2_0)
+                        .setEdgeVersion(getNewestEdgeVersion())
                         .setMaxInboundMessageSize(maxInboundMessageSize)
                         .build())
                 .build());
     }
 
+    public static EdgeVersion getNewestEdgeVersion() {
+        EdgeVersion newest = null;
+        for (EdgeVersion v : EdgeVersion.values()) {
+            if (v == EdgeVersion.V_LATEST || v == EdgeVersion.UNRECOGNIZED) {
+                continue;
+            }
+            if (newest == null || v.getNumber() > newest.getNumber()) {
+                newest = v;
+            }
+        }
+        return newest;
+    }
+
     private StreamObserver<ResponseMsg> initOutputStream(String edgeKey,
                                                          Consumer<UplinkResponseMsg> onUplinkResponse,
                                                          Consumer<EdgeConfiguration> onEdgeUpdate,