CLDR-16819 Change text of one notification; renaming; refactoring (#5099)

Author: btangmu

tools/cldr-apps/js/src/esm/cldrVote.mjs

@@ -190,13 +190,8 @@ function handleVoteSubmitted(json, tr, theRow, button, valToShow) {
       button.className = "ichoice-o";
       button.checked = false;
       cldrSurvey.hideLoader();
-      if (json.testResults && (json.testWarnings || json.testErrors)) {
-        // Tried to submit, have errs or warnings.
-        // Caution: even though json is defined, it is NOT used here as the 5th argument
-        // for showProposedItem, which apparently depends on the 5th argument being
-        // undefined when called from here (handleVoteSubmitted), and only defined
-        // when called from handleVoteNotSubmitted.
-        showProposedItem(tr, theRow, valToShow, json.testResults);
+      if (json.testResults && (json.hasTestWarnings || json.hasTestErrors)) {
+        showProposedItem(tr, theRow, valToShow, json);
       }
       if (CLDR_VOTE_DEBUG) {
         console.log(
@@ -217,9 +212,9 @@ function handleVoteSubmitted(json, tr, theRow, button, valToShow) {
 function handleVoteNotSubmitted(json, tr, theRow, button, valToShow) {
   if (
     (json.statusAction && json.statusAction != "ALLOW") ||
-    (json.testResults && (json.testWarnings || json.testErrors))
+    (json.testResults && (json.hasTestWarnings || json.hasTestErrors))
   ) {
-    showProposedItem(tr, theRow, valToShow, json.testResults, json);
+    showVoteNotSubmitted(tr, theRow, valToShow, json);
   }
   button.className = "ichoice-o";
   button.checked = false;
@@ -270,67 +265,64 @@ function getSubmitUrl(xpstrid) {
   return cldrAjax.makeApiUrl(api, null);
 }
 
-/**
- * Show an item that's not in the saved data, but has been proposed newly by the user.
- * Used for "+" button in table.
- *
- * Caution: if called from handleVoteSubmitted, the fifth argument (json) is undefined
- * (even though there is json from the server response), and that appears to be necessary
- * for this function to work right, as it stands. The fifth argument (json) is only defined
- * when called from handleVoteNotSubmitted. This function cries out to be thoroughly refactored,
- * but that may only be feasible in conjunction with a thorough analysis or refactoring of the
- * back end.
- */
-function showProposedItem(tr, theRow, value, tests, json) {
+function showVoteNotSubmitted(tr, theRow, value, json) {
+  if (!cldrSurvey.parseStatusAction(json.statusAction).vote) {
+    showVoteNotAllowed(theRow, value, json);
+  } else if (json.reasonNotSubmitted) {
+    const description = "Did not submit this value: " + json.reasonNotSubmitted;
+    cldrNotify.error("Not submitted", description);
+  } else {
+    showProposedItem(tr, theRow, value, json);
+  }
+}
+
+function showVoteNotAllowed(theRow, value, json) {
   const ourItem = cldrSurvey.findItemByValue(theRow.items, value);
-  if (json && !cldrSurvey.parseStatusAction(json.statusAction).vote) {
-    const replaceErrors =
-      json.statusAction === "FORBID_PERMANENT_WITHOUT_FORUM";
-    if (replaceErrors) {
-      /*
-       * Special case: for clarity, replace any warnings/errors that may be
-       * in tests[] with a single error message for this situation.
-       */
-      tests = [
-        {
-          type: "Error",
-          message: cldrText.get("StatusAction_" + json.statusAction),
-        },
-      ];
-    }
+  const replaceErrors = json.statusAction === "FORBID_PERMANENT_WITHOUT_FORUM";
+  let tests = json.testResults;
+  if (replaceErrors) {
+    /*
+     * Special case: for clarity, replace any warnings/errors that may be
+     * in tests[] with a single error message for this situation.
+     */
+    tests = [
+      {
+        type: "Error",
+        message: cldrText.get("StatusAction_" + json.statusAction),
+      },
+    ];
+  }
 
-    const valueMessage = value === "" ? "Abstention" : "Value: " + value;
+  const valueMessage = value === "" ? "Abstention" : "Value: " + value;
 
-    // TODO: modernize to obviate cldrSurvey.testsToHtml
-    // Reference: https://unicode-org.atlassian.net/browse/CLDR-18013
-    const testDescription = cldrSurvey.testsToHtml(tests);
-    if (ourItem || (replaceErrors && value === "") /* Abstain */) {
-      const statusAction = cldrText.get("StatusAction_" + json.statusAction);
-      const message = cldrText.sub("StatusAction_msg", [statusAction]);
-      /*
-       * This may happen if, for example, the user types a space (" ") in
-       * the input pop-up window and presses Enter. The value has been rejected
-       * by the server. Then we show an additional pop-up window with the error message
-       * from the server like "Input Processor Error: DAIP returned a 0 length string"
-       */
-      const statusMessage = cldrText.sub("StatusAction_popupmsg", [
-        statusAction,
-        theRow.code,
-      ]);
-      const description =
-        valueMessage + "<br>" + statusMessage + " " + testDescription;
-      cldrNotify.openWithHtml(message, description);
-    } else {
-      const description = valueMessage + "<br>" + testDescription;
-      cldrNotify.openWithHtml("Response to voting", description);
-    }
-    return;
-  } else if (json?.didNotSubmit) {
-    const description = "Did not submit this value: " + json.didNotSubmit;
-    cldrNotify.error("Not submitted", description);
-    return;
+  // TODO: modernize to obviate cldrSurvey.testsToHtml
+  // Reference: https://unicode-org.atlassian.net/browse/CLDR-18013
+  const testDescription = cldrSurvey.testsToHtml(tests);
+  if (ourItem || (replaceErrors && value === "") /* Abstain */) {
+    const statusAction = cldrText.get("StatusAction_" + json.statusAction);
+    const message = cldrText.sub("StatusAction_msg", [statusAction]);
+    /*
+     * This may happen if, for example, the user types a space (" ") in
+     * the input pop-up window and presses Enter. The value has been rejected
+     * by the server. Then we show an additional pop-up window with the error message
+     * from the server like "Input Processor Error: DAIP returned a 0 length string"
+     */
+    const statusMessage = cldrText.sub("StatusAction_popupmsg", [
+      statusAction,
+      theRow.code,
+    ]);
+    const description =
+      valueMessage + "<br>" + statusMessage + " " + testDescription;
+    cldrNotify.openWithHtml(message, description);
+  } else {
+    const description = valueMessage + "<br>" + testDescription;
+    cldrNotify.openWithHtml("Vote not allowed", description);
   }
-  // Note: it is possible to arrive here (as of 2025-09), for example, if the vote was accepted but has warnings
+}
+
+function showProposedItem(tr, theRow, value, json) {
+  const tests = json.testResults;
+  const ourItem = cldrSurvey.findItemByValue(theRow.items, value);
   const ourDiv = ourItem ? ourItem.div : document.createElement("div");
   const testKind = getTestKind(tests);
   cldrTable.setDivClassSelected(ourDiv, testKind);
@@ -345,7 +337,7 @@ function showProposedItem(tr, theRow, value, tests, json) {
     const newDiv = document.createElement("div");
     div3.appendChild(newDiv);
     newDiv.innerHTML = cldrSurvey.testsToHtml(tests);
-    if (json && !parseStatusAction(json.statusAction).vote) {
+    if (!json.didVote && !parseStatusAction(json.statusAction).vote) {
       const text = cldrText.sub("StatusAction_msg", [
         cldrText.get("StatusAction_" + json.statusAction),
       ]);

tools/cldr-apps/src/main/java/org/unicode/cldr/web/api/VoteAPI.java

@@ -177,7 +177,6 @@ public static final class RowResponse {
         public static final class Row {
 
             public static final class Candidate {
-                public String displayValue;
                 public String example;
                 public String history;
                 public boolean isBaselineValue;
@@ -418,7 +417,7 @@ public static final class VoteResponse {
         public boolean didVote;
 
         @Schema(description = "If set, some other reason why the submission failed.")
-        public String didNotSubmit;
+        public String reasonNotSubmitted;
 
         @Schema(description = "If not ALLOW_*, gives reason why the voting was not allowed.")
         public StatusAction statusAction = null;
@@ -427,15 +426,15 @@ public static final class VoteResponse {
         public CheckStatusSummary[] testResults;
 
         @Schema(description = "True if testResults include warnings.")
-        public boolean testWarnings;
+        public boolean hasTestWarnings;
 
         @Schema(description = "True if testResults include errors.")
-        public boolean testErrors;
+        public boolean hasTestErrors;
 
         void setTestResults(List<CheckStatus> testResults) {
             this.testResults = new CheckStatusSummary[testResults.size()];
-            this.testWarnings = has(testResults, CheckStatus.warningType);
-            this.testErrors = has(testResults, CheckStatus.errorType);
+            this.hasTestWarnings = has(testResults, CheckStatus.warningType);
+            this.hasTestErrors = has(testResults, CheckStatus.errorType);
             for (int i = 0; i < testResults.size(); i++) {
                 this.testResults[i] = new CheckStatusSummary(testResults.get(i));
             }

tools/cldr-apps/src/main/java/org/unicode/cldr/web/api/VoteAPIHelper.java

@@ -646,7 +646,7 @@ public static VoteResponse getHandleVoteForMissingResponse(
 
     private static void normalizedToZeroLengthError(VoteResponse r, List<CheckStatus> result) {
         final String message = "DAIP returned a 0 length string";
-        r.didNotSubmit = message;
+        r.reasonNotSubmitted = message;
         r.statusAction = CheckCLDR.StatusAction.FORBID_ERRORS;
         String[] list = {message};
         result.add(

tools/cldr-apps/src/test/java/org/unicode/cldr/web/DataDrivenSTTestHandler.java

@@ -484,11 +484,11 @@ private void handleElementApivote(
                         "exception="
                                 + needException
                                 + " but got status "
-                                + r.didNotSubmit
+                                + r.reasonNotSubmitted
                                 + " - "
                                 + r.toString());
             } else {
-                System.out.println(" status = " + r.didNotSubmit);
+                System.out.println(" status = " + r.reasonNotSubmitted);
             }
         } catch (Throwable iae) {
             if (needException == true) {