From 63a68f5df29907fa717e726bbe54f0d4583b73f7 Mon Sep 17 00:00:00 2001
From: Luke0125 <348358584@qq.com>
Date: Sat, 13 Jan 2024 19:30:50 +0800
Subject: [PATCH] Add comment for clusters and UI display (#5072)

* Complete the feature initially

* reformat ui terms from 'comment' to 'remarks'

* add brackets for RemarksTips

* update CHANGES.md
---
 CHANGES.md                                    |  1 +
 .../framework/apollo/biz/entity/Cluster.java  | 13 +++++++++++-
 .../apollo/common/dto/ClusterDTO.java         | 10 +++++++++
 .../src/main/resources/static/cluster.html    |  9 ++++++++
 .../src/main/resources/static/i18n/en.json    |  2 ++
 .../src/main/resources/static/i18n/zh-CN.json |  2 ++
 .../scripts/controller/ClusterController.js   |  2 ++
 .../config/ConfigBaseInfoController.js        | 12 +++++++++++
 scripts/sql/apolloconfigdb.sql                |  1 +
 .../v220-v230/apolloconfigdb-v220-v230.sql    | 21 +++++++++++++++++++
 10 files changed, 72 insertions(+), 1 deletion(-)
 create mode 100644 scripts/sql/delta/v220-v230/apolloconfigdb-v220-v230.sql

diff --git a/CHANGES.md b/CHANGES.md
index ec4d138378b..6a4930af5d0 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -6,6 +6,7 @@ Apollo 2.3.0
 
 ------------------
 * [Fix circular references on LdapAutoConfiguration](https://github.com/apolloconfig/apollo/pull/5055)
+* [Add comment for clusters and UI display](https://github.com/apolloconfig/apollo/pull/5072)
 
 
 ------------------
diff --git a/apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/Cluster.java b/apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/Cluster.java
index af41b1951dd..e69b8019e66 100644
--- a/apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/Cluster.java
+++ b/apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/Cluster.java
@@ -43,6 +43,9 @@ public class Cluster extends BaseEntity implements Comparable<Cluster> {
   @Column(name = "`ParentClusterId`", nullable = false)
   private long parentClusterId;
 
+  @Column(name = "`Comment`")
+  private String comment;
+
   public String getAppId() {
     return appId;
   }
@@ -67,9 +70,17 @@ public void setParentClusterId(long parentClusterId) {
     this.parentClusterId = parentClusterId;
   }
 
+  public String getComment() {
+    return comment;
+  }
+
+  public void setComment(String comment) {
+    this.comment = comment;
+  }
+
   public String toString() {
     return toStringHelper().add("name", name).add("appId", appId)
-        .add("parentClusterId", parentClusterId).toString();
+        .add("parentClusterId", parentClusterId).add("comment", comment).toString();
   }
 
   @Override
diff --git a/apollo-common/src/main/java/com/ctrip/framework/apollo/common/dto/ClusterDTO.java b/apollo-common/src/main/java/com/ctrip/framework/apollo/common/dto/ClusterDTO.java
index f78dd56ca01..ac2ae3fc662 100644
--- a/apollo-common/src/main/java/com/ctrip/framework/apollo/common/dto/ClusterDTO.java
+++ b/apollo-common/src/main/java/com/ctrip/framework/apollo/common/dto/ClusterDTO.java
@@ -36,6 +36,8 @@ public class ClusterDTO extends BaseDTO{
 
   private long parentClusterId;
 
+  private String comment;
+
   public long getId() {
     return id;
   }
@@ -67,4 +69,12 @@ public long getParentClusterId() {
   public void setParentClusterId(long parentClusterId) {
     this.parentClusterId = parentClusterId;
   }
+
+  public String getComment() {
+    return comment;
+  }
+
+  public void setComment(String comment) {
+    this.comment = comment;
+  }
 }
diff --git a/apollo-portal/src/main/resources/static/cluster.html b/apollo-portal/src/main/resources/static/cluster.html
index 825e7aa8760..ed1a01a5a60 100644
--- a/apollo-portal/src/main/resources/static/cluster.html
+++ b/apollo-portal/src/main/resources/static/cluster.html
@@ -80,6 +80,15 @@ <h4>{{'Cluster.CreateCluster' | translate }}</h4>
                                 <small>{{'Cluster.CreateNameTips' | translate }}</small>
                             </div>
                         </div>
+                        <div class="form-group" valdr-form-group>
+                            <label class="col-sm-2 control-label">
+                                {{'Common.ClusterRemarks' | translate }}</label>
+                            <div class="col-sm-6">
+                                <textarea class="form-control" rows="3" name="clusterComment"
+                                          ng-model="clusterComment"></textarea>
+                                <small>{{'Cluster.CreateRemarksTips' | translate }}</small>
+                            </div>
+                        </div>
                         <div class="form-group">
                             <label class="col-sm-2 control-label">
                                 <apollorequiredfield></apollorequiredfield>
diff --git a/apollo-portal/src/main/resources/static/i18n/en.json b/apollo-portal/src/main/resources/static/i18n/en.json
index 4829d6cd11d..dbe1d698520 100644
--- a/apollo-portal/src/main/resources/static/i18n/en.json
+++ b/apollo-portal/src/main/resources/static/i18n/en.json
@@ -27,6 +27,7 @@
   "Common.AppOwnerLong": "App Owner",
   "Common.AppAdmin": "App Administrators",
   "Common.ClusterName": "Cluster Name",
+  "Common.ClusterRemarks": "Remarks",
   "Common.Submit": "Submit",
   "Common.Save": "Save",
   "Common.Created": "Create Successfully",
@@ -352,6 +353,7 @@
   "Cluster.Tips.3": "By default, Apollo reads IDC attributes in /opt/settings/server.properties(Linux) or C:\\opt\\settings\\server.properties(Windows) files on the machine as cluster names, such as SHAJQ (Jinqiao Data Center), SHAOY (Ouyang Data Center)",
   "Cluster.Tips.4": "The cluster name created here should be consistent with the IDC attribute in server.properties on the machine",
   "Cluster.CreateNameTips": "(Cluster names such as SHAJQ, SHAOY or customized clusters such as SHAJQ-xx, SHAJQ-yy)",
+  "Cluster.CreateRemarksTips": "(Adding remarks to clusters can help users better understand the purpose of each cluster.)",
   "Cluster.ChooseEnvironment": "Environment",
   "Cluster.LoadingEnvironmentError": "Error in loading environment information",
   "Cluster.ClusterCreated": "Create cluster successfully",
diff --git a/apollo-portal/src/main/resources/static/i18n/zh-CN.json b/apollo-portal/src/main/resources/static/i18n/zh-CN.json
index df84bf07269..e166237c306 100644
--- a/apollo-portal/src/main/resources/static/i18n/zh-CN.json
+++ b/apollo-portal/src/main/resources/static/i18n/zh-CN.json
@@ -27,6 +27,7 @@
   "Common.AppOwnerLong": "应用负责人",
   "Common.AppAdmin": "应用管理员",
   "Common.ClusterName": "集群名称",
+  "Common.ClusterRemarks": "集群备注",
   "Common.Submit": "提交",
   "Common.Save": "保存",
   "Common.Created": "创建成功",
@@ -352,6 +353,7 @@
   "Cluster.Tips.3": "Apollo 默认会读取机器上 /opt/settings/server.properties（linux）或C:\\opt\\settings\\server.properties（windows）文件中的 idc 属性作为集群名字，  如 SHAJQ（金桥数据中心）、SHAOY（欧阳数据中心）",
   "Cluster.Tips.4": "在这里创建的集群名字需要和机器上 server.properties 中的 idc 属性一致",
   "Cluster.CreateNameTips": "（部署集群如: SHAJQ,SHAOY 或自定义集群如: SHAJQ-xx,SHAJQ-yy）",
+  "Cluster.CreateRemarksTips": "（为新建集群增加备注说明可以帮助用户更好地理解每个集群的用途）",
   "Cluster.ChooseEnvironment": "选择环境",
   "Cluster.LoadingEnvironmentError": "加载环境信息出错",
   "Cluster.ClusterCreated": "集群创建成功",
diff --git a/apollo-portal/src/main/resources/static/scripts/controller/ClusterController.js b/apollo-portal/src/main/resources/static/scripts/controller/ClusterController.js
index 1fbf3346996..6f19aaee48d 100644
--- a/apollo-portal/src/main/resources/static/scripts/controller/ClusterController.js
+++ b/apollo-portal/src/main/resources/static/scripts/controller/ClusterController.js
@@ -39,6 +39,7 @@ cluster_module.controller('ClusterController',
             });
 
             $scope.clusterName = '';
+            $scope.clusterComment = '';
 
             $scope.switchChecked = function (env, $event) {
                 env.checked = !env.checked;
@@ -59,6 +60,7 @@ cluster_module.controller('ClusterController',
                         ClusterService.create_cluster($scope.appId, env.name,
                             {
                                 name: $scope.clusterName,
+                                comment: $scope.clusterComment,
                                 appId: $scope.appId
                             }).then(function (result) {
                                 toastr.success(env.name, $translate.instant('Cluster.ClusterCreated'));
diff --git a/apollo-portal/src/main/resources/static/scripts/controller/config/ConfigBaseInfoController.js b/apollo-portal/src/main/resources/static/scripts/controller/config/ConfigBaseInfoController.js
index c2a1039865a..59f7f30d84d 100644
--- a/apollo-portal/src/main/resources/static/scripts/controller/config/ConfigBaseInfoController.js
+++ b/apollo-portal/src/main/resources/static/scripts/controller/config/ConfigBaseInfoController.js
@@ -241,6 +241,7 @@ function ConfigBaseInfoController($rootScope, $scope, $window, $location, $trans
                         parentNode.push(node.text);
                         clusterNode.tags = [$translate.instant('Common.Cluster')];
                         clusterNode.parentNode = parentNode;
+                        clusterNode.comment = cluster.comment;
                         clusterNodes.push(clusterNode);
 
                     });
@@ -287,6 +288,17 @@ function ConfigBaseInfoController($rootScope, $scope, $window, $location, $trans
                     $rootScope.showSideBar = false;
                 }
             });
+            $('#treeview .node-treeview').hover(
+                function () {
+                    // get comment by nodeid
+                    var commentValue = $('#treeview').treeview('getNode', $(this).data('nodeid')).comment;
+                    if (typeof commentValue !== 'undefined') {
+                        $(this).attr('title', commentValue);
+                    }
+                },
+                function () {
+                }
+            );
 
             var envMapClusters = {};
             navTree.forEach(function (node) {
diff --git a/scripts/sql/apolloconfigdb.sql b/scripts/sql/apolloconfigdb.sql
index cd2b8d1310e..301f1ebe838 100644
--- a/scripts/sql/apolloconfigdb.sql
+++ b/scripts/sql/apolloconfigdb.sql
@@ -113,6 +113,7 @@ CREATE TABLE `Cluster` (
   `Name` varchar(32) NOT NULL DEFAULT '' COMMENT '集群名字',
   `AppId` varchar(64) NOT NULL DEFAULT '' COMMENT 'App id',
   `ParentClusterId` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '父cluster',
+  `Comment` varchar(64) DEFAULT NULL COMMENT '备注',
   `IsDeleted` bit(1) NOT NULL DEFAULT b'0' COMMENT '1: deleted, 0: normal',
   `DeletedAt` BIGINT(20) NOT NULL DEFAULT '0' COMMENT 'Delete timestamp based on milliseconds',
   `DataChange_CreatedBy` varchar(64) NOT NULL DEFAULT 'default' COMMENT '创建人邮箱前缀',
diff --git a/scripts/sql/delta/v220-v230/apolloconfigdb-v220-v230.sql b/scripts/sql/delta/v220-v230/apolloconfigdb-v220-v230.sql
new file mode 100644
index 00000000000..412b67f5fd2
--- /dev/null
+++ b/scripts/sql/delta/v220-v230/apolloconfigdb-v220-v230.sql
@@ -0,0 +1,21 @@
+--
+-- Copyright 2024 Apollo 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.
+--
+# delta schema to upgrade apollo config db from v2.2.0 to v2.3.0
+
+Use ApolloConfigDB;
+
+ALTER TABLE `Cluster`
+    ADD COLUMN `Comment` varchar(64) DEFAULT NULL COMMENT '备注';
\ No newline at end of file