♻️ Refactor Lark Notice plugin for improved maintainability and localization

Author: 721806280

src/main/java/io/jenkins/plugins/lark/notice/config/LarkRobotConfig.java

@@ -5,7 +5,6 @@
 import hudson.model.Descriptor;
 import hudson.model.User;
 import hudson.util.FormValidation;
-import hudson.util.FormValidation.Kind;
 import hudson.util.Secret;
 import io.jenkins.plugins.lark.notice.Messages;
 import io.jenkins.plugins.lark.notice.enums.BuildStatusEnum;
@@ -210,11 +209,11 @@ public FormValidation doCheckWebhook(@QueryParameter String value) {
          * @return Returns the test result. If the test passes, it returns FormValidation.respond(Kind.OK); otherwise, it returns an error message.
          */
         @RequirePOST
-        public FormValidation doTest(@QueryParameter String id, @QueryParameter String name,
+        public String doTest(@QueryParameter String id, @QueryParameter String name,
                                      @QueryParameter String webhook, @QueryParameter String proxy,
                                      @QueryParameter String securityConfigs) {
             if (!Jenkins.get().hasPermission(Jenkins.ADMINISTER)) {
-                return FormValidation.error("You do not have permission to access this resource");
+                return "Error: You do not have permission to access this resource.";
             }
 
             List<LarkSecurityPolicyConfig> securityPolicyConfigs = JsonUtils.readList(securityConfigs, LarkSecurityPolicyConfig.class)
@@ -227,14 +226,13 @@ public FormValidation doTest(@QueryParameter String id, @QueryParameter String n
 
             RobotType robotType = robotConfig.obtainRobotType();
             if (Objects.isNull(robotType)) {
-                return FormValidation.error(Messages.form_validation_webhook());
+                return "Error: " + Messages.form_validation_webhook();
             }
 
             MessageSender sender = robotType.obtainInstance(RobotConfigModel.of(robotConfig, proxySelector));
             SendResult sendResult = sender.sendCard(buildTestMessage(robotType));
 
-            return !sendResult.isOk() ? FormValidation.error(sendResult.getMsg()) :
-                    FormValidation.respond(Kind.OK, "<span style='color:#52c41a;font-weight:bold;'>Test Successful</span>");
+            return sendResult.isOk() ? Messages.form_validation_test_success() : "Error: " + sendResult.getMsg();
         }
 
         /**

src/main/resources/io/jenkins/plugins/lark/notice/Messages.properties

@@ -1,28 +1,29 @@
-# \u63D2\u4EF6\u663E\u793A\u540D\u79F0
+# Plugin display name
 plugin.display.name=Lark Notice
-# \u63D2\u4EF6\u7BA1\u7406
-plugin.management.description=\u53D1\u9001\u6784\u5EFA\u901A\u77E5\u6D88\u606F
-# \u7528\u6237\u5C5E\u6027
-user.property.title=Lark\u4FE1\u606F
-# \u901A\u77E5\u4E8B\u4EF6
-notice.start=\u6784\u5EFA\u542F\u52A8\u65F6
-notice.aborted=\u6784\u5EFA\u4E2D\u65AD\u65F6
-notice.failure=\u6784\u5EFA\u5931\u8D25\u65F6
-notice.success=\u6784\u5EFA\u6210\u529F\u65F6
-notice.unstable=\u6784\u5EFA\u4E0D\u7A33\u5B9A\u65F6
-notice.not_built=\u672A\u6784\u5EFA\u65F6
-# \u6784\u5EFA\u72B6\u6001
-build.status.start=\u5F00\u59CB
-build.status.aborted=\u53D6\u6D88
-build.status.failure=\u5931\u8D25
-build.status.success=\u6210\u529F
-build.status.unstable=\u4E0D\u7A33\u5B9A
-build.status.not_built=\u672A\u6784\u5EFA
-build.status.unknown=\u672A\u77E5
-# \u5B89\u5168\u7B56\u7565\u7C7B\u578B
-security.policy.type.no_ssl=\u7981\u7528\u8BC1\u4E66\u9A8C\u8BC1
-security.policy.type.key=\u81EA\u5B9A\u4E49\u5173\u952E\u8BCD
-security.policy.type.secret=\u52A0\u7B7E\u5BC6\u94A5
-# \u8868\u5355\u9A8C\u8BC1
-form.validation.name=\u540D\u79F0\u4E0D\u80FD\u4E3A\u7A7A
-form.validation.webhook=\u65E0\u6548\u7684 Webhook
+# Management links
+plugin.management.description=Send Build Notice Message
+# User property
+user.property.title=Lark Info
+# Notice occasion
+notice.start=Start
+notice.aborted=Aborted
+notice.failure=Failure
+notice.success=Success
+notice.unstable=Unstable
+notice.not_built=Not built
+# Build status type
+build.status.start=Start
+build.status.aborted=Aborted
+build.status.failure=Failure
+build.status.success=Success
+build.status.unstable=Unstable
+build.status.not_built=Not built
+build.status.unknown=Unknown
+# Security policy type
+security.policy.type.no_ssl=Disable certificate verification
+security.policy.type.key=Custom keyword
+security.policy.type.secret=Signature key
+# Robot config form validation
+form.validation.name=Name cannot be empty
+form.validation.webhook=Invalid Webhook
+form.validation.test.success=Test success

src/main/resources/io/jenkins/plugins/lark/notice/Messages_en_unused.properties

@@ -0,0 +1,29 @@
+# \u63D2\u4EF6\u663E\u793A\u540D\u79F0
+plugin.display.name=Lark Notice
+# \u63D2\u4EF6\u7BA1\u7406
+plugin.management.description=\u53D1\u9001\u6784\u5EFA\u901A\u77E5\u6D88\u606F
+# \u7528\u6237\u5C5E\u6027
+user.property.title=Lark\u4FE1\u606F
+# \u901A\u77E5\u4E8B\u4EF6
+notice.start=\u6784\u5EFA\u542F\u52A8\u65F6
+notice.aborted=\u6784\u5EFA\u4E2D\u65AD\u65F6
+notice.failure=\u6784\u5EFA\u5931\u8D25\u65F6
+notice.success=\u6784\u5EFA\u6210\u529F\u65F6
+notice.unstable=\u6784\u5EFA\u4E0D\u7A33\u5B9A\u65F6
+notice.not_built=\u672A\u6784\u5EFA\u65F6
+# \u6784\u5EFA\u72B6\u6001
+build.status.start=\u5F00\u59CB
+build.status.aborted=\u53D6\u6D88
+build.status.failure=\u5931\u8D25
+build.status.success=\u6210\u529F
+build.status.unstable=\u4E0D\u7A33\u5B9A
+build.status.not_built=\u672A\u6784\u5EFA
+build.status.unknown=\u672A\u77E5
+# \u5B89\u5168\u7B56\u7565\u7C7B\u578B
+security.policy.type.no_ssl=\u7981\u7528\u8BC1\u4E66\u9A8C\u8BC1
+security.policy.type.key=\u81EA\u5B9A\u4E49\u5173\u952E\u8BCD
+security.policy.type.secret=\u52A0\u7B7E\u5BC6\u94A5
+# \u8868\u5355\u9A8C\u8BC1
+form.validation.name=\u540D\u79F0\u4E0D\u80FD\u4E3A\u7A7A
+form.validation.webhook=\u65E0\u6548\u7684 Webhook
+form.validation.test.success=\u6D4B\u8BD5\u6210\u529F

src/main/resources/io/jenkins/plugins/lark/notice/Messages_zh_CN.properties

@@ -0,0 +1,2 @@
+test=Test
+success=Test success

src/main/resources/io/jenkins/plugins/lark/notice/config/LarkGlobalConfig/config.properties

@@ -0,0 +1,2 @@
+test=\u6D4B\u8BD5
+success=\u6D4B\u8BD5\u6210\u529F

src/main/resources/io/jenkins/plugins/lark/notice/config/LarkGlobalConfig/config_zh_CN.properties

@@ -7,8 +7,6 @@
                 src="${rootURL}/plugin/lark-notice/scripts/robotConfigValidator.js"/>
     </st:once>
 
-    <link rel="stylesheet" href="${rootURL}/plugin/lark-notice/css/ui.css" type="text/css"/>
-
     <div class="robot-config-container">
         <f:entry title="id" field="id">
             <f:textbox name="id"/>
@@ -37,17 +35,19 @@
             </f:entry>
         </j:scope>
 
-        <div class="robot-config-validate-msg"><!-- this is where the error message goes --></div>
+        <st:adjunct includes="io.jenkins.plugins.lark.notice.config.LarkRobotConfig.validate-robot-config-onclick"/>
+        <div class="robot-config-validate-msg"
+             style="white-space: pre-wrap;"><!-- this is where the error message goes --></div>
         <div style="text-align: right;">
-            <input
+            <button
                     type="button"
-                    value="测试"
-                    class="robot-config-validate-btn"
+                    class="jenkins-button robot-config-validate-btn"
                     data-validate-button-descriptor-url="${descriptor.descriptorFullUrl}"
                     data-validate-button-method="test"
                     data-validate-button-with="${with}"
-                    onclick="validateRobotConfig(this)"
-            />
+            >
+                ${%test}
+            </button>
         </div>
     </div>
 </j:jelly>

src/main/resources/io/jenkins/plugins/lark/notice/config/LarkRobotConfig/config.jelly

@@ -0,0 +1,5 @@
+Behaviour.specify('.robot-config-validate-btn', 'validate-robot-config', 0, function (element) {
+    element.addEventListener('click', function () {
+        validateRobotConfig(this);
+    });
+});

src/main/resources/io/jenkins/plugins/lark/notice/config/LarkRobotConfig/validate-robot-config-onclick.js

@@ -1,7 +1,8 @@
 async function validateRobotConfig(_this) {
     var robot = _this.closest('.robot-config-container');
-    var msg = robot.querySelector('.robot-config-validate-msg');
-    msg.innerHTML = '';
+    var validateMsg = robot.querySelector('.robot-config-validate-msg');
+    validateMsg.innerHTML = '';
+    validateMsg.className = 'robot-config-validate-msg'
 
     try {
         var checkUrl = _this.getAttribute('data-validate-button-descriptor-url') + '/' + _this.getAttribute('data-validate-button-method');
@@ -18,13 +19,13 @@ async function validateRobotConfig(_this) {
 
         var message = await response.text();
         if (response.ok) {
-            msg.innerHTML = message;
-            layoutUpdateCallback.call();
-        } else {
-            var id = 'valerr' + iota++; // 这里的 iota 是一个全局计数器，你需要在其他地方定义并初始化它。
-            msg.innerHTML = '<a href="" onclick="document.getElementById(\'' + id + '\').style.display=\'block\';return false">ERROR</a><div id="' + id + '" style="display:none"><pre>' + message + '</pre></div>';
+            validateMsg.innerHTML = message;
         }
-        Behaviour.applySubtree(msg);
+
+        var classStyle = message.startsWith('Error:') ? 'danger' : 'success';
+        validateMsg.classList.add('jenkins-alert', 'jenkins-alert-' + classStyle)
+
+        Behaviour.applySubtree($validateMsg);
     } catch (error) {
         console.error(error);
     }