feature: seata namingserver #5800

ggbocoder · 2023-08-25T03:21:24Z

I have registered the PR [[changes](typora://app/changes)](../changes).

Ⅰ. Describe what this PR did

1.实现了注册中心的基本功能，包括服务注册，服务发现，心跳检测等
2.设计并实现了领域模型的数据结构，包括集群，节点等
3.添加了部分单元测试/集成测试，并在seata-samples上进行验证

namingserver提供的HTTP接口如下：

接口名称	接口类型	说明	参数
registerInstance	Post	server服务注册接口	namespace 节点所属命名空间 clusterName 节点所属集群名称 unitName 节点所属unit名称 node 节点实体类
unregisterInstance	Post	server服务下线接口	unitName 节点所属命名空间 node 节点实体类
discovery	Get	client服务发现接口	namespace 命名空间 vGroup 事务分组
changeGroup	Post	控制台修改事务接口	namespace 命名空间 clusterName 集群名称 unitName unit名称 vGroup 事务分组
watch	Get	client服务订阅接口	clientTerm 客户端保存的订阅时间戳 vGroup 事务分组 timeout 超时时间 request 客户端HTTP请求
health	Get	namingserver健康检查接口	无
clusters	Get	控制台监控所有集群状态接口	namespace 命名空间

接口详情请查看[namingserver (getpostman.com)](https://documenter.getpostman.com/view/26098677/2s9YC31uAW)

Ⅱ. Does this pull request fix one issue?

Ⅲ. Why don't you add test cases (unit test/integration test)?

测试名称	测试功能	通过情况
testRegister1	测试server节点注册后能否被发现	通过
testRegister2	测试同一server节点注册两次，服务发现时是否只有唯一一条数据	通过
testRegister3	测试多个server节点注册后能否全部被发现	通过
testUnregister	测试server节点register后又unregister是否不会被发现	通过
testWatch	测试server节点注册信息改变能否在1s内通知到client	通过
testSubscribe	测试server节点注册信息改变是否被通知	通过
testUnsubscribe	测试取消订阅后server节点注册信息改变是否会通知client	通过

Ⅳ. Describe how to verify it

1.执行mvn clean install "-Dmaven.test.skip=true"打包项目

2.将seata-samples中的seata-all版本换成新打包的版本

3.在seata-samples中修改registry配置，修改成

  type = "namingserver"
  namingserver {
    serverAddr = "127.0.0.1:8080"  //namingserver节点地址
  }

4.启动NamingserverApplication

5.修改server端的配置

  registry:
    type: namingserver
    metadata:
      cluster-type: default
      weight: 1
    namingserver:
      server-addr:
        - 127.0.0.1:8080
      cluster: cluster2
      namespace: public

6.启动server端的ServerApplication

7.启动DubboStockServiceStarter,DubboAccountServiceStarter,DubboOrderServiceStarter,DubboBusinessTester

Ⅴ. Special notes for reviews

implement domain model data structure provide register,unregister,discovery,watch restful api to client

add tests

Disables disabled disabled tests

CLAassistant · 2023-08-25T03:21:30Z

All committers have signed the CLA.

converted 'node' to a singleton unified RaftCluster and DefaultCluster

codecov · 2023-09-17T05:09:47Z

Codecov Report

Merging #5800 (62785a3) into summer-code_namingServer (2626f24) will decrease coverage by 1.82%.
The diff coverage is 6.71%.

❗ Current head 62785a3 differs from pull request most recent head b880a9d. Consider uploading reports for the commit b880a9d to get more accurate results

Additional details and impacted files

@@                      Coverage Diff                       @@
##             summer-code_namingServer    #5800      +/-   ##
==============================================================
- Coverage                       49.78%   47.96%   -1.82%     
+ Complexity                       4545     4476      -69     
==============================================================
  Files                             854      837      -17     
  Lines                           29883    29287     -596     
  Branches                         3660     3630      -30     
==============================================================
- Hits                            14877    14048     -829     
- Misses                          13516    13781     +265     
+ Partials                         1490     1458      -32

Files	Coverage Δ
...ta/spring/boot/autoconfigure/StarterConstants.java	`100.00% <ø> (ø)`
...a/server/storage/db/store/LogStoreDataBaseDAO.java	`75.44% <83.33%> (ø)`
...java/io/seata/discovery/registry/RegistryType.java	`0.00% <0.00%> (ø)`
...try/namingserver/NamingserverRegistryProvider.java	`0.00% <0.00%> (ø)`
.../server/spring/listener/SeataPropertiesLoader.java	`90.69% <86.95%> (-4.76%)`	⬇️
...registry/namingserver/NamingRegistryException.java	`0.00% <0.00%> (ø)`
.../seata/server/store/VGroupMappingStoreManager.java	`0.00% <0.00%> (ø)`
...rc/main/java/io/seata/common/metadata/Cluster.java	`0.00% <0.00%> (ø)`
...in/java/io/seata/common/metadata/MetaResponse.java	`0.00% <0.00%> (ø)`
...e/src/main/java/io/seata/core/store/MappingDO.java	`0.00% <0.00%> (ø)`
... and 10 more

... and 65 files with indirect coverage changes

funky-eyes · 2023-10-21T14:21:08Z

common/src/main/java/io/seata/common/metadata/Cluster.java

+    private List<Unit> unitData;
+
+    public Cluster() {
+        unitData = new ArrayList<>();


Suggest deleting this line of code and assigning the value in line 24.

funky-eyes · 2023-10-21T14:22:31Z

common/src/main/java/io/seata/common/metadata/Instance.java

+
+    private Map<String, Object> metadata = new HashMap<>();
+
+    private static Instance instance;


Changing to a singleton pattern for static inner classes

funky-eyes · 2023-10-21T14:24:38Z

common/src/main/java/io/seata/common/metadata/Instance.java

+    }
+
+    public void addMetadata(String key, Object value) {
+        if (this.metadata == null) {


The value is already assigned when the instance is created, so why is it necessary to make a judgment here?

funky-eyes · 2023-10-21T14:29:09Z

common/src/main/java/io/seata/common/metadata/Instance.java

+                && Objects.equals(unit, instance.unit);
+    }
+
+    public String mapToJsonString(Map<String, Object> map) {


should be reused in CollectionUtils.

funky-eyes · 2023-10-21T14:35:56Z

common/src/main/java/io/seata/common/metadata/Node.java

+
+
+    // convert String to Object
+    public static Node fromJsonString(String jsonString) {


Delete useless code

funky-eyes · 2023-10-21T16:00:28Z

namingserver/.gitignore

No need for this file.

funky-eyes · 2023-10-21T16:04:40Z

namingserver/mvnw

No need for this file.

funky-eyes · 2023-10-21T16:04:52Z

namingserver/mvnw.cmd

No need for this file.

funky-eyes · 2023-10-21T16:05:38Z

namingserver/pom.xml

+        </dependency>
+        <dependency>
+            <groupId>io.seata</groupId>
+            <artifactId>seata-core</artifactId>


Should not rely on the seata-core module

funky-eyes · 2023-10-21T16:06:34Z

namingserver/src/main/java/io/seata/namingserver/NamingController.java

+public class NamingController {
+    private static final Logger LOGGER = LoggerFactory.getLogger(NamingController.class);
+
+    private static final String OK = "200";


Define a status code enumeration

funky-eyes · 2023-10-22T04:54:13Z

...a/io/seata/spring/boot/autoconfigure/properties/registry/RegistryNamingserverProperties.java

+@ConfigurationProperties(prefix = REGISTRY_NAMINGSERVER_PREFIX)
+public class RegistryNamingserverProperties {
+    private String namespace = "public";
+    private String serverAddr = "127.0.0.1:8500";


Why is the port 8500?

funky-eyes · 2023-10-22T05:48:53Z

server/src/main/java/io/seata/server/spring/listener/SeataPropertiesLoader.java

@@ -75,6 +92,47 @@ public void initialize(ConfigurableApplicationContext applicationContext) {
        // Load by priority
        System.setProperty("sessionMode", StoreConfig.getSessionMode().getName());
        System.setProperty("lockMode", StoreConfig.getLockMode().getName());
+
+        // load node properties
+        Instance instance = Instance.getInstance();


Don't have too much content in one method. Separate methods by role type.

funky-eyes · 2023-10-22T05:49:40Z

server/src/main/java/io/seata/server/spring/listener/SeataPropertiesLoader.java

+        }
+
+        // load vgroup mapping relationship
+        String storeType = ConfigurationFactory.getInstance().getConfig("store.mode", "db");


Read from SessionMode

funky-eyes · 2023-10-22T05:51:25Z

server/src/main/java/io/seata/server/storage/db/store/DataBaseVGroupMappingStoreManager.java

+    }
+
+    @Override
+    public HashMap<String, Object> load() {


change method name to loadVGroups

funky-eyes · 2023-10-22T05:52:06Z

server/src/main/java/io/seata/server/storage/db/store/LogStoreDataBaseDAO.java

This class has not been modified, please roll it back.

funky-eyes · 2023-10-22T06:07:41Z

server/src/main/java/io/seata/server/storage/file/store/FileVGroupMappingStoreManager.java

+        HashMap<String, Object> vGroupMapping = new HashMap<>();
+        try {
+            File fileToLoad = new File(path);
+            if (!fileToLoad.exists()) {


Did the file exist when you first started it?

funky-eyes · 2023-10-22T06:09:13Z

server/src/main/java/io/seata/server/storage/redis/store/RedisVGroupMappingStoreManager.java

+    public boolean addVGroup(MappingDO mappingDO) {
+        String vGroup = mappingDO.getVGroup();
+        try (Jedis jedis = JedisPooledFactory.getJedisInstance(); Pipeline pipelined = jedis.pipelined()) {
+            pipelined.hmset(vGroup, BeanUtils.objectToMap(mappingDO));


Is there a thread safety issue?

funky-eyes · 2023-10-22T06:10:45Z

server/src/main/resources/application.example.yml

-    # support: nacos 、 eureka 、 redis 、 zk  、 consul 、 etcd3 、 sofa
-    type: file
+    # support: nacos 、 eureka 、 redis 、 zk  、 consul 、 etcd3 、 sofa 、 namingserver
+    type: namingserver


Change to file

funky-eyes · 2023-10-22T06:11:48Z

server/src/main/resources/application.example.yml

-
+    namingserver:
+      server-addr:
+        - 127.0.0.1:8889


Why don't you use a string, but a list?

funky-eyes · 2023-10-22T06:12:15Z

server/src/main/resources/application.yml

  store:
    # support: file 、 db 、 redis
    mode: file
+#    db:


Please remove these test codes

# Conflicts: # server/pom.xml

funky-eyes · 2023-10-25T14:21:40Z

console/pom.xml

+        <dependency>
+            <groupId>io.seata</groupId>
+            <artifactId>seata-common</artifactId>
+            <version>2.0.0-SNAPSHOT</version>


I don't think you need to write the version number, do you?

funky-eyes · 2023-10-25T14:22:35Z

core/pom.xml

@@ -67,6 +67,10 @@
            <artifactId>fastjson</artifactId>
            <scope>test</scope>
        </dependency>
+        <dependency>
+            <groupId>org.apache.httpcomponents</groupId>
+            <artifactId>httpclient</artifactId>


Why does the core module depend on httpclient?

funky-eyes · 2023-10-25T14:23:04Z

discovery/seata-discovery-namingserver/pom.xml

+        <dependency>
+            <groupId>io.seata</groupId>
+            <artifactId>seata-common</artifactId>
+            <version>2.0.0-SNAPSHOT</version>


No need to write the version number

funky-eyes · 2023-10-25T14:27:40Z

script/config-center/config.txt

How do you remove all the original configurations here?

funky-eyes · 2023-10-25T14:28:15Z

script/server/db/mysql.sql

Other databases should also be supplemented with relevant table structures

funky-eyes · 2023-10-25T14:29:19Z

server/pom.xml

+        <dependency>
+            <groupId>org.codehaus.jackson</groupId>
+            <artifactId>jackson-mapper-asl</artifactId>
+            <version>1.9.13</version>


No version number should be added, all version dependencies should be handled in the dependencies module.

funky-eyes · 2023-10-25T14:30:00Z

server/pom.xml

@@ -344,11 +337,6 @@
                        </ports>
                        <labels>
                            <name>seata-server</name>
-                            <git.commit.message.full>${git.commit.message.full}</git.commit.message.full>


why remove?

funky-eyes · 2023-10-25T14:31:13Z

server/src/main/java/io/seata/server/Server.java

@@ -40,6 +53,60 @@
 * @author slievrly
 */
 public class Server {
+
+    private static final String SEATA_ROOT_KEY = "seata";


Why is he a static variable and not a local variable?

funky-eyes · 2023-10-25T14:32:35Z

server/src/main/resources/application.example.yml

+      weight: 1
+    namingserver:
+      server-addr: 127.0.0.1:8080,127.0.0.1:8081
+      cluster: cluster1


cluster1 change to default

funky-eyes · 2023-10-25T14:33:01Z

server/src/main/resources/application.example.yml

+    metadata:
+      weight: 1
+    namingserver:
+      server-addr: 127.0.0.1:8080,127.0.0.1:8081


why port is 8080?It is possible to write only one address here, because it is only an example.

funky-eyes

LGTM

ggbocoder added 5 commits August 25, 2023 09:32

Update server registry config with namingserver

03570b2

implement registry interface in client

7a19edb

initiate NamingserverApplication

7dabb65

implement domain model data structure provide register,unregister,discovery,watch restful api to client

update pom.xml

ddd1d72

add tests

update pom.xml

d93e172

Disables disabled disabled tests

funky-eyes and others added 5 commits September 5, 2023 17:36

Merge branch '2.x' into 2.x

100e5e5

Completed storage module

7bfa2bd

converted 'node' to a singleton unified RaftCluster and DefaultCluster

bugfix: check code style

175a481

bugfix: check code style again

788da31

bugfix: check code style again

1c51c70

ggbocoder added 7 commits September 17, 2023 14:09

Change the changeVGroup interface to POST

fbcda69

distinguish between registration and heartbeat

3b74034

add redis store mode

5b63524

bugfix: fix code style

8a088b8

bugfix: fix code style again

494faf0

bugfix: fix code style again

4239a38

Merge branch '2.x' of https://github.com/seata/seata into bugfix-2.x

62785a3

slievrly added the summer2023 label Oct 3, 2023

slievrly added this to the Summer Code 2023 milestone Oct 19, 2023

funky-eyes added type: feature Category issues or prs related to feature request. module/discovery discovery module module/server server module labels Oct 21, 2023

funky-eyes changed the base branch from 2.x to summer-code_namingServer October 21, 2023 14:49

funky-eyes reviewed Oct 21, 2023

View reviewed changes

funky-eyes reviewed Oct 22, 2023

View reviewed changes

ggbocoder added 3 commits October 24, 2023 09:39

Modify the code based on the review

c5e0b46

Merge remote-tracking branch 'origin/2.x' into 2.x

2b3ae98

# Conflicts: # server/pom.xml

resolve conflict with branch namingServer

7469a1d

ggbocoder and others added 7 commits October 24, 2023 09:59

remove useless file

a015c8b

change default registry type to file

489b0ae

rollback unchanged file LogStoreDataBaseDAO.java

cd78ef9

fix build test

02795bb

opt

5e2adef

opt format

d6fe37b

Merge branch 'summer-code_namingServer' into 2.x

c9aa371

funky-eyes reviewed Oct 25, 2023

View reviewed changes

ggbocoder added 4 commits October 26, 2023 15:42

opt the code based on the review

6717467

bugfix

e6177df

add client defaul config

fb97cd2

add client application.properties

b880a9d

funky-eyes approved these changes Oct 26, 2023

View reviewed changes

funky-eyes merged commit 8fd1df4 into apache:summer-code_namingServer Oct 26, 2023

open-digger-bot bot mentioned this pull request Oct 30, 2023

[WeeklyReport] Weekly report for seata 10/23/2023 to 10/30/2023 #5972

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: seata namingserver #5800

feature: seata namingserver #5800

ggbocoder commented Aug 25, 2023 •

edited

Loading

CLAassistant commented Aug 25, 2023 •

edited

Loading

codecov bot commented Sep 17, 2023 •

edited

Loading

funky-eyes Oct 21, 2023

funky-eyes Oct 21, 2023

funky-eyes Oct 21, 2023

funky-eyes Oct 21, 2023

funky-eyes Oct 21, 2023

funky-eyes Oct 21, 2023

funky-eyes Oct 21, 2023

funky-eyes Oct 21, 2023

funky-eyes Oct 21, 2023

funky-eyes Oct 21, 2023

funky-eyes Oct 22, 2023

funky-eyes Oct 22, 2023

funky-eyes Oct 22, 2023

funky-eyes Oct 22, 2023

funky-eyes Oct 22, 2023

funky-eyes Oct 22, 2023

funky-eyes Oct 22, 2023

funky-eyes Oct 22, 2023

funky-eyes Oct 22, 2023

funky-eyes Oct 22, 2023

funky-eyes Oct 25, 2023

funky-eyes Oct 25, 2023

funky-eyes Oct 25, 2023

funky-eyes Oct 25, 2023

funky-eyes Oct 25, 2023

funky-eyes Oct 25, 2023

funky-eyes Oct 25, 2023

funky-eyes Oct 25, 2023

funky-eyes Oct 25, 2023

funky-eyes Oct 25, 2023

funky-eyes left a comment


		private Map<String, Object> metadata = new HashMap<>();

		private static Instance instance;



		// convert String to Object
		public static Node fromJsonString(String jsonString) {

feature: seata namingserver #5800

feature: seata namingserver #5800

Conversation

ggbocoder commented Aug 25, 2023 • edited Loading

Ⅰ. Describe what this PR did

Ⅱ. Does this pull request fix one issue?

Ⅲ. Why don't you add test cases (unit test/integration test)?

Ⅳ. Describe how to verify it

Ⅴ. Special notes for reviews

CLAassistant commented Aug 25, 2023 • edited Loading

codecov bot commented Sep 17, 2023 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

funky-eyes left a comment

Choose a reason for hiding this comment

ggbocoder commented Aug 25, 2023 •

edited

Loading

CLAassistant commented Aug 25, 2023 •

edited

Loading

codecov bot commented Sep 17, 2023 •

edited

Loading