[ISSUE#11659] Develop config query chain of responsibility. #12892

MatthewAden · 2024-11-25T05:05:08Z

it closes #11659

What is the purpose of the change

XXXXX

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.

modified: config/src/main/java/com/alibaba/nacos/config/server/controller/ConfigController.java modified: config/src/main/java/com/alibaba/nacos/config/server/controller/ConfigServletInner.java modified: config/src/main/java/com/alibaba/nacos/config/server/controller/v2/ConfigControllerV2.java new file: config/src/main/java/com/alibaba/nacos/config/server/enums/ApiVersionEnum.java new file: config/src/main/java/com/alibaba/nacos/config/server/model/ConfigQueryChainRequest.java new file: config/src/main/java/com/alibaba/nacos/config/server/model/ConfigQueryChainResponse.java modified: config/src/main/java/com/alibaba/nacos/config/server/remote/ConfigQueryRequestHandler.java new file: config/src/main/java/com/alibaba/nacos/config/server/remote/query/ConfigQueryChainService.java new file: config/src/main/java/com/alibaba/nacos/config/server/remote/query/ConfigQueryHandlerChain.java new file: config/src/main/java/com/alibaba/nacos/config/server/remote/query/ConfigQueryHandlerChainBuilder.java new file: config/src/main/java/com/alibaba/nacos/config/server/remote/query/DefaultConfigQueryHandlerChainBuilder.java new file: config/src/main/java/com/alibaba/nacos/config/server/remote/query/handler/AbstractConfigQueryHandler.java new file: config/src/main/java/com/alibaba/nacos/config/server/remote/query/handler/ConfigChainEntryHandler.java new file: config/src/main/java/com/alibaba/nacos/config/server/remote/query/handler/ConfigQueryHandler.java new file: config/src/main/java/com/alibaba/nacos/config/server/remote/query/handler/FormalHandler.java new file: config/src/main/java/com/alibaba/nacos/config/server/remote/query/handler/GrayRuleMatchHandler.java modified: config/src/main/java/com/alibaba/nacos/config/server/controller/ConfigController.java modified: config/src/main/java/com/alibaba/nacos/config/server/controller/ConfigServletInner.java modified: config/src/main/java/com/alibaba/nacos/config/server/controller/v2/ConfigControllerV2.java new file: config/src/main/java/com/alibaba/nacos/config/server/enums/ApiVersionEnum.java new file: config/src/main/java/com/alibaba/nacos/config/server/model/ConfigQueryChainRequest.java new file: config/src/main/java/com/alibaba/nacos/config/server/model/ConfigQueryChainResponse.java modified: config/src/main/java/com/alibaba/nacos/config/server/remote/ConfigQueryRequestHandler.java new file: config/src/main/java/com/alibaba/nacos/config/server/remote/query/ConfigQueryChainService.java new file: config/src/main/java/com/alibaba/nacos/config/server/remote/query/ConfigQueryHandlerChain.java new file: config/src/main/java/com/alibaba/nacos/config/server/remote/query/ConfigQueryHandlerChainBuilder.java new file: config/src/main/java/com/alibaba/nacos/config/server/remote/query/DefaultConfigQueryHandlerChainBuilder.java new file: config/src/main/java/com/alibaba/nacos/config/server/remote/query/handler/AbstractConfigQueryHandler.java new file: config/src/main/java/com/alibaba/nacos/config/server/remote/query/handler/ConfigChainEntryHandler.java new file: config/src/main/java/com/alibaba/nacos/config/server/remote/query/handler/ConfigQueryHandler.java new file: config/src/main/java/com/alibaba/nacos/config/server/remote/query/handler/FormalHandler.java new file: config/src/main/java/com/alibaba/nacos/config/server/remote/query/handler/GrayRuleMatchHandler.java new file: config/src/main/java/com/alibaba/nacos/config/server/remote/query/handler/TagNotFoundHandler.java new file: config/src/main/resources/META-INF/services/com.alibaba.nacos.config.server.remote.query.ConfigQueryHandlerChainBuilder modified: config/src/test/java/com/alibaba/nacos/config/server/controller/ConfigServletInnerTest.java modified: config/src/test/java/com/alibaba/nacos/config/server/controller/v2/ConfigControllerV2Test.java modified: config/src/test/java/com/alibaba/nacos/config/server/remote/ConfigQueryRequestHandlerTest.java

github-actions · 2024-11-25T05:05:20Z

Thanks for your this PR. 🙏
Please check again for your PR changes whether contains any usage/api/configuration change such as Add new API , Add new configuration, Change default value of configuration.
If so, please add or update documents(markdown type) in docs/next/ for repository nacos-group/nacos-group.github.io

感谢您提交的PR。 🙏
请再次查看您的PR内容，确认是否包含任何使用方式/API/配置参数的变更，如：新增API、新增配置参数、修改默认配置等操作。
如果是，请确保在提交之前，在仓库nacos-group/nacos-group.github.io中的docs/next/目录下添加或更新文档（markdown格式）。

shiyiyue1102 · 2024-11-25T06:09:32Z

config/src/main/java/com/alibaba/nacos/config/server/remote/ConfigQueryRequestHandler.java

+        if (StringUtils.isNotBlank(tag)) {
+            appLabels.put(TagGrayRule.VIP_SERVER_TAG_LABEL, tag);
+        } else {
+            appLabels = new HashMap<>(meta.getAppLabels());


appLabels.putAll(meta.getAppLabels());

shiyiyue1102 · 2024-11-25T06:12:38Z

config/src/main/java/com/alibaba/nacos/config/server/model/ConfigQueryChainResponse.java

+    public enum ConfigQueryStatus {
+        BETA,
+        TAG,
+        TAG_NOT_FOUND,


beta,tag-> gray

shiyiyue1102 · 2024-11-25T06:21:14Z

config/src/main/java/com/alibaba/nacos/config/server/remote/query/ConfigQueryChainService.java

+    private final ConfigQueryHandlerChain configQueryHandlerChain;
+
+    public ConfigQueryChainService() {
+        Collection<ConfigQueryHandlerChainBuilder> configQueryHandlerChainBuilders =


ConfigQueryHandlerChainBuilder should load multi , but use only one with specific name which's default value is nacos.

shiyiyue1102 · 2024-11-25T06:21:56Z

config/src/main/java/com/alibaba/nacos/config/server/remote/query/ConfigQueryChainService.java

+        configQueryHandlerChain = builder.addHandler(new ConfigChainEntryHandler())
+                .addHandler(new GrayRuleMatchHandler())
+                .addHandler(new TagNotFoundHandler())
+                .addHandler(new FormalHandler())


should be extracted to DefaultConfigQueryHandlerChainBuilder with name of 'nacos.'

shiyiyue1102 · 2024-11-25T06:28:15Z

...src/main/java/com/alibaba/nacos/config/server/remote/query/handler/GrayRuleMatchHandler.java

+
+    private static final String GRAY_RULE_MATCH_HANDLER = "grayRuleMatchHandler";
+
+    private ConfigCacheGray matchedGray;


not Thread Safe.
Every handler should be stateless.

shiyiyue1102 · 2024-11-25T06:31:57Z

...src/main/java/com/alibaba/nacos/config/server/remote/query/handler/GrayRuleMatchHandler.java

+            response.setStatus(ConfigQueryChainResponse.ConfigQueryStatus.BETA);
+        } else if (TagGrayRule.TYPE_TAG.equals(matchedGray.getGrayRule().getType())) {
+            response.setStatus(ConfigQueryChainResponse.ConfigQueryStatus.TAG);
+        }


set match gray only, ignore beta& tag

shiyiyue1102 · 2024-11-25T06:33:18Z

...g/src/main/java/com/alibaba/nacos/config/server/remote/query/handler/TagNotFoundHandler.java

+ *
+ * @author Nacos
+ */
+public class TagNotFoundHandler extends AbstractConfigQueryHandler {


change to SpecificTagConfigQueryHandler

shiyiyue1102 · 2024-11-25T06:35:12Z

config/src/main/java/com/alibaba/nacos/config/server/remote/ConfigQueryRequestHandler.java

+                    delayed, clientIp, notify, "grpc");
+
+            return response;
+
        } catch (Exception e) {
            return ConfigQueryResponse.buildFailResponse(ResponseCode.FAIL.getCode(), e.getMessage());


add error log to nacos.log

shiyiyue1102 · 2024-11-25T06:42:32Z

...java/com/alibaba/nacos/config/server/remote/query/DefaultConfigQueryHandlerChainBuilder.java

+
+    @Override
+    public ConfigQueryHandlerChain build() {
+        return new ConfigQueryHandlerChain(head);


ConfigQueryHandlerChain chain =new ConfigQueryHandlerChain();
chain.addHandler(new ConfigChainEntryHandler())
.addHandler(new GrayRuleMatchHandler())
.addHandler(new TagNotFoundHandler())
.addHandler(new FormalHandler());
return chain;

shiyiyue1102 · 2024-11-25T06:43:10Z

...java/com/alibaba/nacos/config/server/remote/query/DefaultConfigQueryHandlerChainBuilder.java

+            tail.setNextHandler(handler);
+            tail = handler;
+        }
+


move to ConfigQueryHandlerChain#addHandler

shiyiyue1102 · 2024-11-25T06:46:43Z

...c/main/java/com/alibaba/nacos/config/server/remote/query/ConfigQueryHandlerChainBuilder.java

+     * @param handler the handler to be added
+     * @return the current builder instance
+     */
+    ConfigQueryHandlerChainBuilder addHandler(ConfigQueryHandler handler);


move to ConfigQueryHandlerChain#addHandler

shiyiyue1102 · 2024-11-25T06:48:12Z

...in/java/com/alibaba/nacos/config/server/remote/query/handler/AbstractConfigQueryHandler.java

+
+    private static final Logger LOGGER = LoggerFactory.getLogger(AbstractConfigQueryHandler.class);
+
+    public ConfigQueryHandler nextHandler;


add prevHandler

wuyfee · 2024-11-25T07:02:17Z

$\color{green}{SUCCESS}$
DETAILS
✅ - docker: success
✅ - deploy (standalone & cluster & standalone_auth): success
✅ - e2e-java-test (standalone & cluster & standalone_auth): success
✅ - e2e-go-test (standalone & cluster): success
✅ - e2e-cpp-test (standalone & cluster): success
✅ - e2e-csharp-test (standalone & cluster): success
✅ - e2e-nodejs-test (standalone & cluster): success
✅ - e2e-python-test (standalone & cluster): success
✅ - clean (standalone & cluster & standalone_auth): success

shiyiyue1102 · 2024-11-25T08:32:35Z

config/src/main/java/com/alibaba/nacos/config/server/remote/query/ConfigQueryHandlerChain.java

+ * @author Nacos
+ */
+public class ConfigQueryHandlerChain {
+


这些类迁移到service包下，不应该放在remote下

shiyiyue1102 · 2024-11-25T08:35:12Z

config/src/main/java/com/alibaba/nacos/config/server/remote/query/ConfigQueryChainService.java

+            return configQueryHandlerChain.handle(request);
+        } catch (Exception e) {
+            LOGGER.error("[Error] Fail to handle ConfigQueryChainRequest", e);
+            return new ConfigQueryChainResponse();


should return error response with error info

shiyiyue1102 · 2024-11-25T08:36:28Z

...g/src/main/java/com/alibaba/nacos/config/server/remote/query/handler/ConfigQueryHandler.java

+     * Gets the name of the handler.
+     * @return The name of the handler.
+     */
+    String getQueryHandlerName();


change to getName()

shiyiyue1102 · 2024-11-25T08:44:56Z

config/src/main/java/com/alibaba/nacos/config/server/remote/ConfigQueryRequestHandler.java

+     * @param meta the request meta
+     * @return the constructed ConfigQueryChainRequest object
+     */
+    public ConfigQueryChainRequest buildChainRequest(ConfigQueryRequest request, RequestMeta meta) {


extract a new spi component which named ConfigQueryChainRequestExtractor, with two method.

ConfigQueryChainRequest extract(HttpServerletRequest request) , ConfigQueryChainRequest extract(ConfigQueryRequest request, RequestMeta requestMeta)

shiyiyue1102 reviewed Nov 25, 2024

View reviewed changes

Resolving PMD warnings.

a36575e

shiyiyue1102 reviewed Nov 25, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ISSUE#11659] Develop config query chain of responsibility. #12892

[ISSUE#11659] Develop config query chain of responsibility. #12892

MatthewAden commented Nov 25, 2024

github-actions bot commented Nov 25, 2024

shiyiyue1102 Nov 25, 2024

shiyiyue1102 Nov 25, 2024

shiyiyue1102 Nov 25, 2024

shiyiyue1102 Nov 25, 2024

shiyiyue1102 Nov 25, 2024 •

edited

Loading

shiyiyue1102 Nov 25, 2024

shiyiyue1102 Nov 25, 2024

shiyiyue1102 Nov 25, 2024

shiyiyue1102 Nov 25, 2024

shiyiyue1102 Nov 25, 2024

shiyiyue1102 Nov 25, 2024

shiyiyue1102 Nov 25, 2024

wuyfee commented Nov 25, 2024

shiyiyue1102 Nov 25, 2024 •

edited

Loading

shiyiyue1102 Nov 25, 2024

shiyiyue1102 Nov 25, 2024

shiyiyue1102 Nov 25, 2024 •

edited

Loading


		private static final String GRAY_RULE_MATCH_HANDLER = "grayRuleMatchHandler";

		private ConfigCacheGray matchedGray;


		private static final Logger LOGGER = LoggerFactory.getLogger(AbstractConfigQueryHandler.class);

		public ConfigQueryHandler nextHandler;

[ISSUE#11659] Develop config query chain of responsibility. #12892

Are you sure you want to change the base?

[ISSUE#11659] Develop config query chain of responsibility. #12892

Conversation

MatthewAden commented Nov 25, 2024

What is the purpose of the change

Brief changelog

Verifying this change

github-actions bot commented Nov 25, 2024

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

shiyiyue1102 Nov 25, 2024 • edited Loading

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

wuyfee commented Nov 25, 2024

shiyiyue1102 Nov 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shiyiyue1102 Nov 25, 2024 • edited Loading

Choose a reason for hiding this comment

shiyiyue1102 Nov 25, 2024 •

edited

Loading

shiyiyue1102 Nov 25, 2024 •

edited

Loading

shiyiyue1102 Nov 25, 2024 •

edited

Loading