Optimize checkLocalConfig logic #11869

PleaseGiveMeTheCoke · 2024-03-25T05:53:41Z

Please do not create a Pull Request without creating an issue first.

What is the purpose of the change

issue：#11866

Brief changelog

XX

Verifying this change

XXXX

Follow this checklist to help us incorporate your contribution quickly and easily:

Make sure there is a Github issue filed for the change (usually before you start working on it). Trivial changes like typos do not require a Github issue. Your pull request should address just this issue, without pulling in other changes - one PR resolves one issue.
Format the pull request title like [ISSUE #123] Fix UnknownException when host config not exist. Each commit in the pull request should have a meaningful subject line and body.
Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
Write necessary unit-test to verify your logic correction, more mock a little better when cross module dependency exist. If the new feature or significant change is committed, please remember to add integration-test in test module.
Run mvn -B clean package apache-rat:check findbugs:findbugs -Dmaven.test.skip=true to make sure basic checks pass. Run mvn clean install -DskipITs to make sure unit-test pass. Run mvn clean test-compile failsafe:integration-test to make sure integration-test pass.

CLAassistant · 2024-03-25T05:53:46Z

All committers have signed the CLA.

stone-98 · 2024-03-25T08:21:20Z

LGTM

KomachiSion · 2024-03-25T09:25:50Z

Please sign CLA first.

PleaseGiveMeTheCoke · 2024-03-26T01:03:15Z

Please sign CLA first.

done

dongm2ez · 2024-03-27T02:27:48Z

The PR title may need to be updated to English.

dongm2ez · 2024-03-27T03:55:18Z

client/src/main/java/com/alibaba/nacos/client/config/impl/ClientWorker.java

+ boolean failOverFileCreated = !cacheData.isUseLocalConfigInfo() && file.exists();
+
+ // using local config info, but there is a change in local configuration
+ boolean failOverFileChanged= cacheData.isUseLocalConfigInfo() && file.exists() && cacheData.getLocalConfigInfoVersion() != file.lastModified();


= 号空格不一致

看上去是个负优化，原本比较清晰的逻辑，现在要看懂得不断的上下去找逻辑。当一个变量需要大段的注释去解释它的作用的时候要么是变量名字起的不好，要么是就不该用变量

感谢提出建议，我对 = 和 ; 的问题都做了相应修改

可能我作为Nacos的初学者经验不足，我一开始看到这段逻辑的时候觉得很迷惑，不太知道是否使用本地配置、文件是否存在、版本号是否一致等条件组合在一起的含义，后来仔细阅读才得以明确。于是我按照我阅读代码得到的理解把if括号中的内容提取成变量，相应的注释也提取成变量的注释，消除了冗余的逻辑，并且用一个比较直观的名字来命名这个变量，其实这个注释完全可以不要的

可以思考一下，failOverFileCreated 和 failOverFileChanged 对于使用的地方都是一样的处理逻辑，而 failOverFileDeleted 又是另一段逻辑，那是不是可以更抽象一下。

dongm2ez · 2024-03-27T04:04:30Z

client/src/main/java/com/alibaba/nacos/client/config/impl/ClientWorker.java

- envName, dataId, group, tenant, md5, ContentUtils.truncateContent(content));
- return;
+ "[{}] [failover-change] failover file {}. dataId={}, group={}, tenant={}, md5={}, content={}",
+ failOverFileCreated ? "created" : "changed", envName, dataId, group, tenant, md5, ContentUtils.truncateContent(content));;


多余的分号

KomachiSion

我重新读了一下逻辑，这个重构后的逻辑颠覆了之前的设计理念。

之前之所以不使用变量，是为了在获取failover后，再次进行文件存在的校验，换句话说进行了至少2次的文件存在校验。

而重构后的逻辑，只进行了一次校验，同时时间上也不太正确。

原：是否存在 -》存在读取 -〉再次校验-》存在则使用，不存在则不使用。
新：是否存在 -〉是否删除 -> 存在读取 -> 删除则不使用。

这可能导致某些极端情况下和之前的客户端会有不同的行为，我的建议是把校验逻辑和通用逻辑抽象成方法，而不是只用变量存储，并且不建议修改顺序。

shiyiyue1102 · 2024-04-01T07:52:25Z

fix checkstyle pls.

PleaseGiveMeTheCoke · 2024-04-02T05:21:21Z

我重新读了一下逻辑，这个重构后的逻辑颠覆了之前的设计理念。

之前之所以不使用变量，是为了在获取failover后，再次进行文件存在的校验，换句话说进行了至少2次的文件存在校验。

而重构后的逻辑，只进行了一次校验，同时时间上也不太正确。

原：是否存在 -》存在读取 -〉再次校验-》存在则使用，不存在则不使用。新：是否存在 -〉是否删除 -> 存在读取 -> 删除则不使用。

这可能导致某些极端情况下和之前的客户端会有不同的行为，我的建议是把校验逻辑和通用逻辑抽象成方法，而不是只用变量存储，并且不建议修改顺序。

好的，考虑的好细致，感谢提醒

2. 恢复之前的校验顺序 3. 抽象通用逻辑

KomachiSion · 2024-04-02T06:18:20Z

client/src/main/java/com/alibaba/nacos/client/config/impl/ClientWorker.java

@@ -866,44 +866,54 @@ public void checkLocalConfig(CacheData cacheData) {
 final String group = cacheData.group;
 final String tenant = cacheData.tenant;
 final String envName = cacheData.envName;
- 
+


麻烦使用nacos-code-style进行reformat，不需要删除缩紧

KomachiSion · 2024-04-02T06:18:26Z

client/src/main/java/com/alibaba/nacos/client/config/impl/ClientWorker.java

-
- // If use local config info, but the failover file is deleted, switch back to server config.
- if (cacheData.isUseLocalConfigInfo() && !file.exists()) {
+


PleaseGiveMeTheCoke · 2024-04-26T11:51:59Z

@KomachiSion 请问这个pr合并之前还有什么我需要改动的吗

KomachiSion · 2024-04-29T02:06:34Z

CICD通过的话就可以合并了

PleaseGiveMeTheCoke · 2024-04-29T12:49:49Z

CICD通过的话就可以合并了

现在应该通过了？

优化checkLocalConfig逻辑

bf32067

KomachiSion requested a review from shiyiyue1102 March 25, 2024 09:25

KomachiSion assigned shiyiyue1102 Mar 25, 2024

dongm2ez reviewed Mar 27, 2024

View reviewed changes

PleaseGiveMeTheCoke changed the title ~~优化checkLocalConfig逻辑~~ Optimize checkLocalConfig logic Mar 29, 2024

修改不规范的等号和分号

46b5cc9

KomachiSion requested changes Apr 1, 2024

View reviewed changes

shiyiyue1102 previously approved these changes Apr 1, 2024

View reviewed changes

1. 多次校验文件是否存在

90a9eaa

2. 恢复之前的校验顺序 3. 抽象通用逻辑

PleaseGiveMeTheCoke dismissed shiyiyue1102’s stale review via 90a9eaa April 2, 2024 05:52

KomachiSion requested changes Apr 2, 2024

View reviewed changes

format

8c109d8

KomachiSion approved these changes Apr 29, 2024

View reviewed changes

Merge branch 'alibaba:develop' into develop

dabda8a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Optimize checkLocalConfig logic #11869

Optimize checkLocalConfig logic #11869

PleaseGiveMeTheCoke commented Mar 25, 2024

CLAassistant commented Mar 25, 2024 •

edited

stone-98 commented Mar 25, 2024

KomachiSion commented Mar 25, 2024

PleaseGiveMeTheCoke commented Mar 26, 2024

dongm2ez commented Mar 27, 2024

dongm2ez Mar 27, 2024

PleaseGiveMeTheCoke Mar 29, 2024

dongm2ez Mar 29, 2024 •

edited

dongm2ez Mar 27, 2024

KomachiSion left a comment

shiyiyue1102 commented Apr 1, 2024

PleaseGiveMeTheCoke commented Apr 2, 2024

KomachiSion Apr 2, 2024

PleaseGiveMeTheCoke Apr 2, 2024

KomachiSion Apr 2, 2024

PleaseGiveMeTheCoke Apr 2, 2024

PleaseGiveMeTheCoke commented Apr 26, 2024

KomachiSion commented Apr 29, 2024

PleaseGiveMeTheCoke commented Apr 29, 2024


		// If use local config info, but the failover file is deleted, switch back to server config.
		if (cacheData.isUseLocalConfigInfo() && !file.exists()) {

Optimize checkLocalConfig logic #11869

Are you sure you want to change the base?

Optimize checkLocalConfig logic #11869

Conversation

PleaseGiveMeTheCoke commented Mar 25, 2024

What is the purpose of the change

Brief changelog

Verifying this change

CLAassistant commented Mar 25, 2024 • edited

stone-98 commented Mar 25, 2024

KomachiSion commented Mar 25, 2024

PleaseGiveMeTheCoke commented Mar 26, 2024

dongm2ez commented Mar 27, 2024

dongm2ez Mar 27, 2024

Choose a reason for hiding this comment

PleaseGiveMeTheCoke Mar 29, 2024

Choose a reason for hiding this comment

dongm2ez Mar 29, 2024 • edited

Choose a reason for hiding this comment

dongm2ez Mar 27, 2024

Choose a reason for hiding this comment

KomachiSion left a comment

Choose a reason for hiding this comment

shiyiyue1102 commented Apr 1, 2024

PleaseGiveMeTheCoke commented Apr 2, 2024

KomachiSion Apr 2, 2024

Choose a reason for hiding this comment

PleaseGiveMeTheCoke Apr 2, 2024

Choose a reason for hiding this comment

KomachiSion Apr 2, 2024

Choose a reason for hiding this comment

PleaseGiveMeTheCoke Apr 2, 2024

Choose a reason for hiding this comment

PleaseGiveMeTheCoke commented Apr 26, 2024

KomachiSion commented Apr 29, 2024

PleaseGiveMeTheCoke commented Apr 29, 2024

CLAassistant commented Mar 25, 2024 •

edited

dongm2ez Mar 29, 2024 •

edited