Fix singular/plural in pin dialog error message

Fix a typo in the pin dialog error message which read
"1 attempts left" instead of "1 attempt left" when the user has
attempted incorrect pins and there's only 1 attempt remaining.

This CL is the second attempt to solve the issue after being
reverted in commit 7672be058caa26d14678f8b0d4a06de56c155309
due to an issue in the error message format of the SAML login.
The first attempt only handled the normal login while this one
handles both the SAML login and the normal login.

Bug: 1060695
Change-Id: Ieac135c90ef6e20cf53bd26d2ab87cf0147c21a0
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2599814
Commit-Queue: Aya Nader Elgendy‎ <ayag@chromium.org>
Reviewed-by: Roman Sorokin [CET] <rsorokin@chromium.org>
Cr-Commit-Position: refs/heads/master@{#841990}

chrome/browser/chromeos/login/security_token_login_browsertest.cc

@@ -67,9 +67,9 @@ constexpr char kPinDialogDefaultTitle[] = "Smart card PIN";
 constexpr char kPinDialogInvalidPinTitle[] = "Invalid PIN.";
 constexpr char kPinDialogInvalidPin2AttemptsTitle[] =
     "Invalid PIN. 2 attempts left";
-// TODO(crbug.com/1060695): Fix the incorrect plural in the message.
+
 constexpr char kPinDialogInvalidPin1AttemptTitle[] =
-    "Invalid PIN. 1 attempts left";
+    "Invalid PIN. 1 attempt left";
 constexpr char kPinDialogNoAttemptsLeftTitle[] =
     "Maximum allowed attempts exceeded.";
 

chrome/browser/resources/chromeos/login/components/oobe_types.js

@@ -129,8 +129,10 @@ OobeTypes.SecurityTokenPinDialogErrorType = {
  * @typedef {{
  *   codeType: OobeTypes.SecurityTokenPinDialogType,
  *   enableUserInput: boolean,
- *   errorLabel: OobeTypes.SecurityTokenPinDialogErrorType,
  *   attemptsLeft: number,
+ *   hasError: boolean,
+ *   formattedError: string,
+ *   formattedAttemptsLeft: string,
  * }}
  */
 OobeTypes.SecurityTokenPinDialogParameters;

chrome/browser/resources/chromeos/login/security_token_pin.html

@@ -33,16 +33,14 @@
       <div slot="footer">
         <div id="pinKeyboardContainer" hidden="[[processingCompletion_]]">
           <pin-keyboard id="pinKeyboard" enable-letters allow-non-digit
-              has-error="[[isErrorLabelVisible_(errorLabelId_, userEdited_)]]"
-              aria-label="[[getLabel_(locale, parameters, errorLabelId_,
-                                      userEdited_)]]"
+              has-error="[[isErrorLabelVisible_(parameters, userEdited_)]]"
+              aria-label="[[getLabel_(parameters, userEdited_)]]"
               on-pin-change="onPinChange_" on-submit="onSubmit_"
               disabled="[[!canEdit_]]">
             <div id="errorContainer" role="alert" problem
                 invisible$="[[!isLabelVisible_(parameters, userEdited_)]]">
               <iron-icon id="errorIcon" icon="cr:error-outline"></iron-icon>
-              <span id="error">[[getLabel_(locale, parameters, errorLabelId_,
-                                           userEdited_)]]</span>
+              <span id="error">[[getLabel_(parameters, userEdited_)]]</span>
             </div>
           </pin-keyboard>
         </div>

chrome/browser/resources/chromeos/login/security_token_pin.js

@@ -34,16 +34,6 @@ Polymer({
       observer: 'onParametersChanged_',
     },
 
-    /**
-     * The i18n string ID containing the error label to be shown to the user.
-     * Is null when there's no error label.
-     * @private
-     */
-    errorLabelId_: {
-      type: String,
-      computed: 'computeErrorLabelId_(parameters)',
-    },
-
     /**
      * Whether the current state is the wait for the processing completion
      * (i.e., the backend is verifying the entered PIN).
@@ -80,7 +70,7 @@ Polymer({
     canEdit_: {
       type: Boolean,
       computed:
-          'computeCanEdit_(parameters.attemptsLeft, processingCompletion_)',
+          'computeCanEdit_(parameters.enableUserInput, processingCompletion_)',
     },
 
     /**
@@ -89,7 +79,7 @@ Polymer({
      */
     canSubmit_: {
       type: Boolean,
-      computed: 'computeCanSubmit_(parameters.attemptsLeft, ' +
+      computed: 'computeCanSubmit_(parameters.enableUserInput, ' +
           'hasValue_, processingCompletion_)',
     },
   },
@@ -101,52 +91,27 @@ Polymer({
     this.$.pinKeyboard.focusInputSynchronously();
   },
 
-  /**
-   * Returns the i18n string ID for the current error label.
-   * @param {OobeTypes.SecurityTokenPinDialogParameters} parameters
-   * @return {string|null}
-   * @private
-   */
-  computeErrorLabelId_(parameters) {
-    if (!parameters)
-      return null;
-    switch (parameters.errorLabel) {
-      case OobeTypes.SecurityTokenPinDialogErrorType.NONE:
-        return null;
-      case OobeTypes.SecurityTokenPinDialogErrorType.UNKNOWN:
-        return 'securityTokenPinDialogUnknownError';
-      case OobeTypes.SecurityTokenPinDialogErrorType.INVALID_PIN:
-        return 'securityTokenPinDialogUnknownInvalidPin';
-      case OobeTypes.SecurityTokenPinDialogErrorType.INVALID_PUK:
-        return 'securityTokenPinDialogUnknownInvalidPuk';
-      case OobeTypes.SecurityTokenPinDialogErrorType.MAX_ATTEMPTS_EXCEEDED:
-        return 'securityTokenPinDialogUnknownMaxAttemptsExceeded';
-      default:
-        assertNotReached(`Unexpected enum value: ${parameters.errorLabel}`);
-    }
-  },
-
   /**
    * Computes the value of the canEdit_ property.
-   * @param {number} attemptsLeft
+   * @param {boolean} enableUserInput
    * @param {boolean} processingCompletion
    * @return {boolean}
    * @private
    */
-  computeCanEdit_(attemptsLeft, processingCompletion) {
-    return attemptsLeft != 0 && !processingCompletion;
+  computeCanEdit_(enableUserInput, processingCompletion) {
+    return enableUserInput && !processingCompletion;
   },
 
   /**
    * Computes the value of the canSubmit_ property.
-   * @param {number} attemptsLeft
+   * @param {boolean} enableUserInput
    * @param {boolean} hasValue
    * @param {boolean} processingCompletion
    * @return {boolean}
    * @private
    */
-  computeCanSubmit_(attemptsLeft, hasValue, processingCompletion) {
-    return attemptsLeft != 0 && hasValue && !processingCompletion;
+  computeCanSubmit_(enableUserInput, hasValue, processingCompletion) {
+    return enableUserInput && hasValue && !processingCompletion;
   },
 
   /**
@@ -203,10 +168,7 @@ Polymer({
    * @private
    */
   isErrorLabelVisible_(parameters, userEdited) {
-    return parameters &&
-        parameters.errorLabel !==
-        OobeTypes.SecurityTokenPinDialogErrorType.NONE &&
-        !userEdited;
+    return parameters && parameters.hasError && !userEdited;
   },
 
   /**
@@ -234,14 +196,12 @@ Polymer({
 
   /**
    * Returns the label to be used for the PIN input field.
-   * @param {string} locale
    * @param {OobeTypes.SecurityTokenPinDialogParameters} parameters
-   * @param {string|null} errorLabelId
    * @param {boolean} userEdited
    * @return {string}
    * @private
    */
-  getLabel_(locale, parameters, errorLabelId, userEdited) {
+  getLabel_(parameters, userEdited) {
     if (!this.isLabelVisible_(parameters, userEdited)) {
       // Neither error nor the number of left attempts are to be displayed.
       return '';
@@ -249,20 +209,9 @@ Polymer({
     if (!this.isErrorLabelVisible_(parameters, userEdited) &&
         this.isAttemptsLeftVisible_(parameters)) {
       // There's no error, but the number of left attempts has to be displayed.
-      return this.i18n(
-          'securityTokenPinDialogAttemptsLeft', parameters.attemptsLeft);
-    }
-    // If we get here, |parameters| must be defined, and |parameters.errorLabel|
-    // != NONE, so |errorLabelId| will be defined.
-    assert(errorLabelId);
-    // Format the error and, if present, the number of left attempts.
-    if ((parameters && !parameters.enableUserInput) ||
-        !this.isAttemptsLeftVisible_(parameters)) {
-      return this.i18n(errorLabelId);
+      return parameters.formattedAttemptsLeft;
     }
-    return this.i18n(
-        'securityTokenPinDialogErrorAttempts', this.i18n(errorLabelId),
-        parameters.attemptsLeft);
+    return parameters.formattedError;
   },
 });
 })();

chrome/browser/ui/webui/chromeos/login/gaia_screen_handler.cc

@@ -13,6 +13,8 @@
 #include "base/containers/flat_set.h"
 #include "base/feature_list.h"
 #include "base/guid.h"
+#include "base/i18n/message_formatter.h"
+#include "base/i18n/number_formatting.h"
 #include "base/json/json_reader.h"
 #include "base/logging.h"
 #include "base/memory/ref_counted.h"
@@ -65,6 +67,7 @@
 #include "chrome/grit/generated_resources.h"
 #include "chrome/installer/util/google_update_settings.h"
 #include "chromeos/components/security_token_pin/constants.h"
+#include "chromeos/components/security_token_pin/error_generator.h"
 #include "chromeos/constants/chromeos_features.h"
 #include "chromeos/constants/chromeos_switches.h"
 #include "chromeos/constants/devicetype.h"
@@ -270,8 +273,17 @@ base::Value MakeSecurityTokenPinDialogParameters(
   base::Value params(base::Value::Type::DICTIONARY);
   params.SetIntKey("codeType", static_cast<int>(code_type));
   params.SetBoolKey("enableUserInput", enable_user_input);
-  params.SetIntKey("errorLabel", static_cast<int>(error_label));
   params.SetIntKey("attemptsLeft", attempts_left);
+  params.SetBoolKey("hasError",
+                    error_label != security_token_pin::ErrorLabel::kNone);
+  params.SetStringKey(
+      "formattedError",
+      GenerateErrorMessage(error_label, attempts_left, enable_user_input));
+  params.SetStringKey(
+      "formattedAttemptsLeft",
+      base::i18n::MessageFormatter::FormatWithNumberedArgs(
+          l10n_util::GetStringUTF16(IDS_REQUEST_PIN_DIALOG_ATTEMPTS_LEFT),
+          attempts_left));
   return params;
 }
 

chromeos/chromeos_strings.grd

@@ -322,10 +322,14 @@ Try tapping the mic to ask me anything.
         Unknown error.
       </message>
       <message name="IDS_REQUEST_PIN_DIALOG_ATTEMPTS_LEFT" desc="The text displayed in the certificate provider PIN request dialog about the number of attempts left">
-        <ph name="ATTEMPTS_LEFT">$1<ex>3</ex></ph> attempts left
+        {ATTEMPTS_LEFT, plural,
+        =1 {{0} attempt left}
+        other {{0} attempts left}}
       </message>
       <message name="IDS_REQUEST_PIN_DIALOG_ERROR_ATTEMPTS" desc="The text displayed in the certificate provider PIN request dialog when the previous login attempt was unsuccessful but there are more attempts remaining. Includes the reason for the previous failure.">
-        <ph name="ERROR_MESSAGE">$1<ex>Invalid PIN.</ex></ph> <ph name="ATTEMPTS_LEFT">$2<ex>3</ex></ph> attempts left
+        {ATTEMPTS_LEFT, plural,
+        =1 {<ph name="ERROR_MESSAGE">{1}<ex>Invalid PIN.</ex></ph> {0} attempt left}
+        other {<ph name="ERROR_MESSAGE">{1}<ex>Invalid PIN.</ex></ph> {0} attempts left}}
       </message>
 
       <!-- Print Management App -->

chromeos/chromeos_strings_grd/IDS_REQUEST_PIN_DIALOG_ATTEMPTS_LEFT.png.sha1

+3d613d7a3005a79de03176b1adcd93150b92b64c
\ No newline at end of file

chromeos/chromeos_strings_grd/IDS_REQUEST_PIN_DIALOG_ERROR_ATTEMPTS.png.sha1

-bff3e9c779eeec926cb2a4e6483f615b8b797900
+81517747d7433f99ec8277b79a4654f45d72ea68
\ No newline at end of file

chromeos/components/security_token_pin/error_generator.cc

@@ -4,6 +4,7 @@
 
 #include "chromeos/components/security_token_pin/error_generator.h"
 
+#include "base/i18n/message_formatter.h"
 #include "base/i18n/number_formatting.h"
 #include "chromeos/strings/grit/chromeos_strings.h"
 #include "ui/base/l10n/l10n_util.h"
@@ -48,12 +49,13 @@ base::string16 GenerateErrorMessage(ErrorLabel error_label,
     return error_message;
   }
   if (error_message.empty()) {
-    return l10n_util::GetStringFUTF16(IDS_REQUEST_PIN_DIALOG_ATTEMPTS_LEFT,
-                                      base::FormatNumber(attempts_left));
+    return base::i18n::MessageFormatter::FormatWithNumberedArgs(
+        l10n_util::GetStringUTF16(IDS_REQUEST_PIN_DIALOG_ATTEMPTS_LEFT),
+        attempts_left);
   }
-  return l10n_util::GetStringFUTF16(IDS_REQUEST_PIN_DIALOG_ERROR_ATTEMPTS,
-                                    error_message,
-                                    base::FormatNumber(attempts_left));
+  return base::i18n::MessageFormatter::FormatWithNumberedArgs(
+      l10n_util::GetStringUTF16(IDS_REQUEST_PIN_DIALOG_ERROR_ATTEMPTS),
+      attempts_left, error_message);
 }
 
 }  // namespace security_token_pin