[ISSUE #12017] Add console backend configuration handling #12420

RickonZhang0929 · 2024-07-24T09:26:22Z

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

What is the purpose of the change

For #12017

Add console backend configuration handling with proxy and handler layers.

Brief changelog

Add ConfigHandler interface for defining configuration operations.
Add ConfigInnerHandler to handle internal configuration logic.
Add ConfigProxy to delegate configuration tasks based on deployment type.
Add ConfigController to utilize ConfigProxy for configuration operations.
Update ConsoleConfig to get deployment type.
Update application.properties to add auth fields.

Verifying this change

The changes can be verified by checking the configuration handling operations in the console backend, ensuring that the proxy and handler layers function correctly based on deployment type. Additionally, verify that the authentication fields in application.properties are correctly utilized.

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.

… proxy and handler layers * Add ConfigHandler interface for defining configuration operations * Add ConfigInnerHandler to handle internal configuration logic * Add ConfigProxy to delegate configuration tasks based on deployment type * Add ConfigController to utilize ConfigProxy for configuration operations * Update ConsoleConfig to get development type

CLAassistant · 2024-07-24T09:26:29Z

All committers have signed the CLA.

* Fix checkstyle format * Add configuration file fields

KomachiSion · 2024-07-26T09:41:31Z

console/src/main/java/com/alibaba/nacos/console/controller/v3/ConsoleConfigController.java

+     * @throws IOException      IOException.
+     * @throws NacosException   NacosException.
+     */
+    @GetMapping("/configs")


configs可以抽到类的Mapping里

* Update ConsoleConfigController route

* Delete unnecessary comments

KomachiSion · 2024-07-31T09:18:43Z

console/src/main/java/com/alibaba/nacos/console/controller/v3/ConsoleConfigController.java

+ * @author zhangyukun
+ */
+@RestController
+@RequestMapping("/v3/console/cs/configs")


uri需要用复数形式吗？

v2使用单数形式，已修改

KomachiSion · 2024-07-31T09:19:34Z

console/src/main/java/com/alibaba/nacos/console/controller/v3/ConsoleConfigController.java

+     * @throws NacosException NacosException.
+     */
+    @GetMapping("/detail")
+    public ResponseEntity<?> detailConfigInfo(@RequestParam("dataId") String dataId,


API的返回内容最好使用规范化的RestResult或者com.alibaba.nacos.api.model.v2.Result

我参考了原有代码修改返回类型

1.抛出Throwable
2.使用RestResultUtils记录成功和失败
3.使用LOGGER记录失败日志
4.根据名称填写失败信息msg

* Update ConsoleConfigController return format

KomachiSion

Controller层一般情况下会要做的事：

参数类型的转换和封装
参数有效性的校验
返回内容的转换和封装。

目前提交的Controller基本都没有做到。

可以参考一下前一个同学写的ConfigControllerV2。

因为你是新增了一套新的接口，后面UI控制台会按照你新定的API进行调用，所以很多参数、规范不必拘泥于旧接口。可以按照标准的方式去设计。

KomachiSion · 2024-08-05T02:02:07Z

console/src/main/java/com/alibaba/nacos/console/controller/v3/ConsoleConfigController.java

+    @PostMapping
+    public RestResult<Boolean> publishConfig(HttpServletRequest request, HttpServletResponse response,
+            @RequestParam("dataId") String dataId, @RequestParam("group") String group,
+            @RequestParam(value = "tenant", required = false, defaultValue = "") String tenant,


新接口最好统一用namespaceId替换tenant

新的接口都已替换

KomachiSion · 2024-08-05T02:08:01Z

console/src/main/java/com/alibaba/nacos/console/controller/v3/ConsoleConfigController.java

+            return RestResultUtils.success(result);
+        } catch (Throwable e) {
+            LOGGER.error("publish configuration information fail", e);
+            return RestResultUtils.failed(500, result, "publish configuration information fail");


错误码需要判断是否是已知的问题，比如NacosException或者NacosRuntimeException等。

如果这里不确定的话，就不要做异常处理，交给ExceptionHandler来统一处理。

controller这里就不再异常处理了

* Update ConsoleConfigController publishConfig

KomachiSion · 2024-08-07T06:24:39Z

console/src/main/java/com/alibaba/nacos/console/controller/v3/ConsoleConfigController.java

+        ParamUtils.checkParam(dataId, group, "datumId", content);
+        ParamUtils.checkParam(tag);
+
+        ConfigForm configForm = new ConfigForm();


为什么不直接在方法上用ConfigForm？

KomachiSion · 2024-08-07T06:35:21Z

console/src/main/java/com/alibaba/nacos/console/controller/v3/ConsoleConfigController.java

+            Pair<String, String> pair = EncryptionHandler.encryptHandler(dataId, content);
+            content = pair.getSecond();
+            encryptedDataKeyFinal = pair.getFirst();
+        }


解密应该算是业务逻辑了，其他的发布配置的时候也是在controller里面吗？

这部分下放到了handler，已修改

…tion * Added parameter validation and return value encapsulation to the Controller section * Put business operations into the handler layer * A total of 9 APIs are involved in the config section.

KomachiSion

proxy和controller的命名看下是否调整一下，有几个method和api我看着有点难理解。

KomachiSion · 2024-08-15T01:49:41Z

console/src/main/java/com/alibaba/nacos/console/controller/v3/ConsoleConfigController.java

+     * @throws NacosApiException NacosApiException.
+     */
+    @GetMapping
+    @Secured(action = ActionTypes.READ, signType = SignType.CONFIG)


是不是少了AdminAPI的指定

KomachiSion · 2024-08-15T01:50:13Z

console/src/main/java/com/alibaba/nacos/console/controller/v3/ConsoleConfigController.java

+     */
+    @GetMapping
+    @Secured(action = ActionTypes.READ, signType = SignType.CONFIG)
+    public void getConfig(HttpServletRequest request, HttpServletResponse response,


getConfig却不返回内容吗？是不是有错误？

已解决，这个接口更新了，替换了底层方法，有返回值了

KomachiSion · 2024-08-15T01:50:49Z

console/src/main/resources/application.properties

-
+### If turn on auth system v3:
+nacos.auth.console.enabled=true
+nacos.auth.server.enabled=false


这个是鉴权的开关？

已删除，这是鉴权的开关，后面放到鉴权PR上提交

* Updating the config section backend methods

RickonZhang0929 · 2024-08-20T04:51:30Z

proxy和controller的命名看下是否调整一下，有几个method和api我看着有点难理解。

命名已调整

KomachiSion

最后一点小问题调整一下，

然后加一下单元测试。

KomachiSion · 2024-08-20T05:58:12Z

api/src/main/java/com/alibaba/nacos/api/model/v2/ErrorCode.java

+
+    NO_SELECTED_CONFIG(100006, "没有选择任何配置"),
+
+    API_NOT_ALLOWED_TEMPORARILY(405, "/v3/console/core/cluster/server/leave API not allowed to use temporarily.");


这个接口不是配置中心的吧，而且这个接口其实不需要在v3里加。废弃了

KomachiSion · 2024-08-20T06:14:34Z

...le/src/main/java/com/alibaba/nacos/console/controller/v3/config/ConsoleConfigController.java

+     * @throws IOException      If an I/O error occurs.
+     * @throws NacosException   If a Nacos-specific error occurs.
+     */
+    @GetMapping


一般来说， list接口用$parentPath/list, 下面的detail接口，及查询配置详情的接口，直接用GET 的$parentPath 比较好

* Add unit tests for the config section * Update uri of query method

* Delete redundant error codes

rickonzhang and others added 2 commits June 26, 2024 21:39

提交测试

053a5c2

[ISSUE alibaba#12017] Fix checkstyle format

8068dd0

* Fix checkstyle format * Add configuration file fields

KomachiSion requested changes Jul 26, 2024

View reviewed changes

KomachiSion changed the base branch from develop to summer-ospp#12017 July 26, 2024 09:43

KomachiSion added the Summer label Jul 26, 2024

[ISSUE alibaba#12017] Update ConsoleConfigController route

9b3f407

* Update ConsoleConfigController route

RickonZhang0929 requested a review from KomachiSion July 29, 2024 07:40

[ISSUE alibaba#12017] Fix CI PMD violation

079d82c

* Delete unnecessary comments

KomachiSion requested changes Jul 31, 2024

View reviewed changes

[ISSUE alibaba#12017] Update ConsoleConfigController return format

1942ffc

* Update ConsoleConfigController return format

RickonZhang0929 requested a review from KomachiSion August 3, 2024 10:21

KomachiSion requested changes Aug 5, 2024

View reviewed changes

[ISSUE alibaba#12017] Update ConsoleConfigController publishConfig

2389b56

* Update ConsoleConfigController publishConfig

KomachiSion requested changes Aug 7, 2024

View reviewed changes

[ISSUE alibaba#12017] Updated the backend of the console's config sec…

239097f

…tion * Added parameter validation and return value encapsulation to the Controller section * Put business operations into the handler layer * A total of 9 APIs are involved in the config section.

KomachiSion requested changes Aug 15, 2024

View reviewed changes

[ISSUE alibaba#12017] Updating the config section backend methods

e3a03eb

* Updating the config section backend methods

KomachiSion requested changes Aug 20, 2024

View reviewed changes

RickonZhang0929 added 2 commits August 21, 2024 12:45

[ISSUE alibaba#12017] Add unit tests for the config section

a201da9

* Add unit tests for the config section * Update uri of query method

[ISSUE alibaba#12017] Delete redundant error codes

c77918a

* Delete redundant error codes

KomachiSion approved these changes Aug 21, 2024

View reviewed changes

KomachiSion merged commit 95e9a22 into alibaba:summer-ospp#12017 Aug 21, 2024
1 check passed


		NO_SELECTED_CONFIG(100006, "没有选择任何配置"),

		API_NOT_ALLOWED_TEMPORARILY(405, "/v3/console/core/cluster/server/leave API not allowed to use temporarily.");

[ISSUE #12017] Add console backend configuration handling #12420

[ISSUE #12017] Add console backend configuration handling #12420

Uh oh!

Conversation

RickonZhang0929 commented Jul 24, 2024 • edited by KomachiSion Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What is the purpose of the change

Brief changelog

Verifying this change

Uh oh!

CLAassistant commented Jul 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

KomachiSion left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

KomachiSion left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RickonZhang0929 commented Aug 20, 2024

Uh oh!

KomachiSion left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

RickonZhang0929 commented Jul 24, 2024 •

edited by KomachiSion

Loading

CLAassistant commented Jul 24, 2024 •

edited

Loading