Internationalize price drop formatted currency

The price formatting was originally hard coded for USD. It is now
internationalized. UX/PM requirements are not yet available for exact
formatting (e.g. commas, decimal places) so this change does not
finalize our price formatting but rather gives us the ability to
do some initial experimentation in other locales.

TBR=yusufo@chromium.org

Bug: 1130068
Change-Id: I075b035a560ad651ad166bc47a94031fc44859e1
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2556454
Commit-Queue: David Maunder <davidjm@chromium.org>
Reviewed-by: Sahel Sharify <sahel@chromium.org>
Reviewed-by: Wei-Yin Chen (陳威尹) <wychen@chromium.org>
Cr-Commit-Position: refs/heads/master@{#831129}

chrome/android/javatests/src/org/chromium/chrome/browser/tab/state/ShoppingPersistedTabDataTest.java

@@ -67,6 +67,9 @@ public class ShoppingPersistedTabDataTest {
     private static final long LOW_PRICE_MICROS = 100000000L;
     private static final String HIGH_PRICE_FORMATTED = "$141";
     private static final String LOW_PRICE_FORMATTED = "$100";
+    private static final String UNITED_STATES_CURRENCY_CODE = "USD";
+    private static final String GREAT_BRITAIN_CURRENCY_CODE = "GBP";
+    private static final String JAPAN_CURRENCY_CODE = "JPY";
 
     private static final String EMPTY_PRICE = "";
     private static final String ENDPOINT_RESPONSE_INITIAL =
@@ -136,6 +139,8 @@ public class ShoppingPersistedTabDataTest {
                         PRICE_MICROS, shoppingPersistedTabData.getPreviousPriceMicros());
                 Assert.assertEquals(mLastPriceChangeTimeMs,
                         shoppingPersistedTabData.getLastPriceChangeTimeMs());
+                Assert.assertEquals(
+                        UNITED_STATES_CURRENCY_CODE, shoppingPersistedTabData.getCurrencyCode());
                 semaphore.release();
             });
         });
@@ -150,6 +155,8 @@ public class ShoppingPersistedTabDataTest {
             ShoppingPersistedTabData.from(tab, (shoppingPersistedTabData) -> {
                 verifyEndpointFetcherCalled(1);
                 Assert.assertEquals(PRICE_MICROS, shoppingPersistedTabData.getPriceMicros());
+                Assert.assertEquals(
+                        UNITED_STATES_CURRENCY_CODE, shoppingPersistedTabData.getCurrencyCode());
                 Assert.assertEquals(ShoppingPersistedTabData.NO_PRICE_KNOWN,
                         shoppingPersistedTabData.getPreviousPriceMicros());
                 Assert.assertEquals(ShoppingPersistedTabData.NO_TRANSITIONS_OCCURRED,
@@ -190,6 +197,8 @@ public class ShoppingPersistedTabDataTest {
                 Assert.assertEquals(PRICE_MICROS, shoppingPersistedTabData.getPriceMicros());
                 Assert.assertEquals(ShoppingPersistedTabData.NO_PRICE_KNOWN,
                         shoppingPersistedTabData.getPreviousPriceMicros());
+                Assert.assertEquals(
+                        UNITED_STATES_CURRENCY_CODE, shoppingPersistedTabData.getCurrencyCode());
                 // By setting time to live to be a negative number, an update
                 // will be forced in the subsequent call
                 initialSemaphore.release();
@@ -218,8 +227,8 @@ public class ShoppingPersistedTabDataTest {
     @SmallTest
     @Test
     public void testPriceDrop() {
-        Tab tab = createTabOnUiThread(TAB_ID, IS_INCOGNITO);
-        ShoppingPersistedTabData shoppingPersistedTabData = new ShoppingPersistedTabData(tab);
+        ShoppingPersistedTabData shoppingPersistedTabData =
+                createShoppingPersistedTabDataWithDefaults();
         // Prices unknown is not a price drop
         Assert.assertNull(shoppingPersistedTabData.getPriceDrop());
 
@@ -246,7 +255,7 @@ public class ShoppingPersistedTabDataTest {
     @Test
     public void testPriceDropFilterSamePrice() {
         ShoppingPersistedTabData shoppingPersistedTabData =
-                new ShoppingPersistedTabData(createTabOnUiThread(TAB_ID, IS_INCOGNITO));
+                createShoppingPersistedTabDataWithDefaults();
 
         // $10 -> $10 is not a price drop (same price)
         shoppingPersistedTabData.setPreviousPriceMicrosForTesting(10_000_000L);
@@ -259,7 +268,7 @@ public class ShoppingPersistedTabDataTest {
     @Test
     public void testPriceDropFilterNoFormattedPriceDifference() {
         ShoppingPersistedTabData shoppingPersistedTabData =
-                new ShoppingPersistedTabData(createTabOnUiThread(TAB_ID, IS_INCOGNITO));
+                createShoppingPersistedTabDataWithDefaults();
 
         // $10.40 -> $10 (which would be displayed $10 -> $10 is not a price drop)
         shoppingPersistedTabData.setPreviousPriceMicrosForTesting(10_400_000L);
@@ -272,7 +281,7 @@ public class ShoppingPersistedTabDataTest {
     @Test
     public void testPriceDropFilterAbsoluteDifferenceTooSmall() {
         ShoppingPersistedTabData shoppingPersistedTabData =
-                new ShoppingPersistedTabData(createTabOnUiThread(TAB_ID, IS_INCOGNITO));
+                createShoppingPersistedTabDataWithDefaults();
 
         // $2 -> $1 ($1 price drop - less than $2. Not big enough)
         shoppingPersistedTabData.setPreviousPriceMicrosForTesting(1_000_000L);
@@ -285,7 +294,7 @@ public class ShoppingPersistedTabDataTest {
     @Test
     public void testPriceDropFilterPriceIncrease() {
         ShoppingPersistedTabData shoppingPersistedTabData =
-                new ShoppingPersistedTabData(createTabOnUiThread(TAB_ID, IS_INCOGNITO));
+                createShoppingPersistedTabDataWithDefaults();
 
         // $9.33 -> $9.66 price increase is not a price drop
         shoppingPersistedTabData.setPreviousPriceMicrosForTesting(9_330_000L);
@@ -298,7 +307,7 @@ public class ShoppingPersistedTabDataTest {
     @Test
     public void testPriceDropFilterPercentageDropNotEnough() {
         ShoppingPersistedTabData shoppingPersistedTabData =
-                new ShoppingPersistedTabData(createTabOnUiThread(TAB_ID, IS_INCOGNITO));
+                createShoppingPersistedTabDataWithDefaults();
 
         // $50 -> $46 (8% price drop (less than 10%) not big enough)
         shoppingPersistedTabData.setPreviousPriceMicrosForTesting(50_000_000L);
@@ -306,12 +315,27 @@ public class ShoppingPersistedTabDataTest {
         Assert.assertNull(shoppingPersistedTabData.getPriceDrop());
     }
 
+    private ShoppingPersistedTabData createShoppingPersistedTabDataWithDefaults() {
+        ShoppingPersistedTabData shoppingPersistedTabData =
+                new ShoppingPersistedTabData(createTabOnUiThread(TAB_ID, IS_INCOGNITO));
+        shoppingPersistedTabData.setCurrencyCode(UNITED_STATES_CURRENCY_CODE);
+        return shoppingPersistedTabData;
+    }
+
+    private ShoppingPersistedTabData createShoppingPersistedTabDataWithCurrencyCode(
+            int tabId, boolean isIncognito, String currencyCode) {
+        ShoppingPersistedTabData shoppingPersistedTabData =
+                new ShoppingPersistedTabData(createTabOnUiThread(tabId, isIncognito));
+        shoppingPersistedTabData.setCurrencyCode(currencyCode);
+        return shoppingPersistedTabData;
+    }
+
     @UiThreadTest
     @SmallTest
     @Test
     public void testPriceDropFilterAllowedPriceDrop1() {
         ShoppingPersistedTabData shoppingPersistedTabData =
-                new ShoppingPersistedTabData(createTabOnUiThread(TAB_ID, IS_INCOGNITO));
+                createShoppingPersistedTabDataWithDefaults();
 
         // $10 -> $7 (30% and $3 price drop is big enough)
         shoppingPersistedTabData.setPreviousPriceMicrosForTesting(10_000_000L);
@@ -326,7 +350,7 @@ public class ShoppingPersistedTabDataTest {
     @Test
     public void testPriceDropFilterAllowedPriceDrop2() {
         ShoppingPersistedTabData shoppingPersistedTabData =
-                new ShoppingPersistedTabData(createTabOnUiThread(TAB_ID, IS_INCOGNITO));
+                createShoppingPersistedTabDataWithDefaults();
 
         // $15.72 -> $4.80 (70% and $10.92 price drop is big enough)
         shoppingPersistedTabData.setPreviousPriceMicrosForTesting(15_720_000L);
@@ -341,7 +365,7 @@ public class ShoppingPersistedTabDataTest {
     @Test
     public void testPriceDropFilterAllowedPriceDrop3() {
         ShoppingPersistedTabData shoppingPersistedTabData =
-                new ShoppingPersistedTabData(createTabOnUiThread(TAB_ID, IS_INCOGNITO));
+                createShoppingPersistedTabDataWithDefaults();
 
         // $20 -> $10 (50% and $10 price drop is big enough)
         shoppingPersistedTabData.setPreviousPriceMicrosForTesting(20_000_000L);
@@ -356,7 +380,7 @@ public class ShoppingPersistedTabDataTest {
     @Test
     public void testPriceDropFilterAllowedPriceDrop4() {
         ShoppingPersistedTabData shoppingPersistedTabData =
-                new ShoppingPersistedTabData(createTabOnUiThread(TAB_ID, IS_INCOGNITO));
+                createShoppingPersistedTabDataWithDefaults();
 
         // $30 -> $27 (10% and $3 price drop is big enough)
         shoppingPersistedTabData.setPreviousPriceMicrosForTesting(30_000_000L);
@@ -371,7 +395,7 @@ public class ShoppingPersistedTabDataTest {
     @Test
     public void testPriceDropFilterAllowedPriceDrop5() {
         ShoppingPersistedTabData shoppingPersistedTabData =
-                new ShoppingPersistedTabData(createTabOnUiThread(TAB_ID, IS_INCOGNITO));
+                createShoppingPersistedTabDataWithDefaults();
 
         // $30.65 -> $25.50 (17% and $5.15 price drop is big enough)
         shoppingPersistedTabData.setPreviousPriceMicrosForTesting(30_650_000L);
@@ -386,7 +410,7 @@ public class ShoppingPersistedTabDataTest {
     @Test
     public void testPriceDropFilterAllowedPriceDrop6() {
         ShoppingPersistedTabData shoppingPersistedTabData =
-                new ShoppingPersistedTabData(createTabOnUiThread(TAB_ID, IS_INCOGNITO));
+                createShoppingPersistedTabDataWithDefaults();
 
         // $9.65 -> $3.80 (40% and $5.85 price drop is big enough)
         shoppingPersistedTabData.setPreviousPriceMicrosForTesting(9_650_000L);
@@ -401,7 +425,7 @@ public class ShoppingPersistedTabDataTest {
     @Test
     public void testPriceDropFilterAllowedPriceDrop7() {
         ShoppingPersistedTabData shoppingPersistedTabData =
-                new ShoppingPersistedTabData(createTabOnUiThread(TAB_ID, IS_INCOGNITO));
+                createShoppingPersistedTabDataWithDefaults();
 
         // $9.33 -> $0.90 (96% price drop and $8.43 price drop is big enough)
         shoppingPersistedTabData.setPreviousPriceMicrosForTesting(9_330_000L);
@@ -416,7 +440,7 @@ public class ShoppingPersistedTabDataTest {
     @Test
     public void testPriceDropFilterAllowedPriceDrop8() {
         ShoppingPersistedTabData shoppingPersistedTabData =
-                new ShoppingPersistedTabData(createTabOnUiThread(TAB_ID, IS_INCOGNITO));
+                createShoppingPersistedTabDataWithDefaults();
 
         // $20 -> $18 (10% price drop and $2 price drop is big enough)
         shoppingPersistedTabData.setPreviousPriceMicrosForTesting(20_000_000L);
@@ -431,7 +455,7 @@ public class ShoppingPersistedTabDataTest {
     @Test
     public void testPriceDropFilterAllowedPriceDrop9() {
         ShoppingPersistedTabData shoppingPersistedTabData =
-                new ShoppingPersistedTabData(createTabOnUiThread(TAB_ID, IS_INCOGNITO));
+                createShoppingPersistedTabDataWithDefaults();
 
         // $2 -> $0 ($2 price drop is big enough)
         shoppingPersistedTabData.setPreviousPriceMicrosForTesting(2_000_000L);
@@ -444,9 +468,40 @@ public class ShoppingPersistedTabDataTest {
     @UiThreadTest
     @SmallTest
     @Test
-    public void testStalePriceDrop() {
-        Tab tab = createTabOnUiThread(TAB_ID, IS_INCOGNITO);
-        ShoppingPersistedTabData shoppingPersistedTabData = new ShoppingPersistedTabData(tab);
+    public void testPriceDropGBP() {
+        ShoppingPersistedTabData shoppingPersistedTabData =
+                createShoppingPersistedTabDataWithCurrencyCode(
+                        TAB_ID, IS_INCOGNITO, GREAT_BRITAIN_CURRENCY_CODE);
+
+        shoppingPersistedTabData.setPreviousPriceMicrosForTesting(15_000_000L);
+        shoppingPersistedTabData.setPriceMicrosForTesting(9_560_000L);
+        Assert.assertNotNull(shoppingPersistedTabData.getPriceDrop());
+        Assert.assertEquals("£15", shoppingPersistedTabData.getPriceDrop().previousPrice);
+        Assert.assertEquals("£9.56", shoppingPersistedTabData.getPriceDrop().price);
+    }
+
+    @UiThreadTest
+    @SmallTest
+    @Test
+    public void testPriceDropJPY() {
+        ShoppingPersistedTabData shoppingPersistedTabData =
+                createShoppingPersistedTabDataWithCurrencyCode(
+                        TAB_ID, IS_INCOGNITO, JAPAN_CURRENCY_CODE);
+
+        shoppingPersistedTabData.setPreviousPriceMicrosForTesting(3_140_000_000_000L);
+        shoppingPersistedTabData.setPriceMicrosForTesting(287_000_000_000L);
+        Assert.assertNotNull(shoppingPersistedTabData.getPriceDrop());
+        Assert.assertEquals("¥3,140,000", shoppingPersistedTabData.getPriceDrop().previousPrice);
+        Assert.assertEquals("¥287,000", shoppingPersistedTabData.getPriceDrop().price);
+    }
+
+    @UiThreadTest
+    @SmallTest
+    @Test
+    public void testStalePriceDropUSD() {
+        ShoppingPersistedTabData shoppingPersistedTabData =
+                createShoppingPersistedTabDataWithCurrencyCode(
+                        TAB_ID, IS_INCOGNITO, UNITED_STATES_CURRENCY_CODE);
         // $10 -> $5 (50% and $5 price drop is big enough)
         shoppingPersistedTabData.setPreviousPriceMicrosForTesting(10000000L);
         shoppingPersistedTabData.setPriceMicrosForTesting(5000000L);

chrome/browser/tab/BUILD.gn

@@ -60,6 +60,7 @@ android_library("java") {
     "//components/external_intents/android:java",
     "//components/find_in_page/android:java",
     "//components/navigation_interception/android:navigation_interception_java",
+    "//components/payments/content/android:java",
     "//content/public/android:content_java",
     "//net/android:net_java",
     "//third_party/android_deps:androidx_annotation_annotation_java",

chrome/browser/tab/java/src/org/chromium/chrome/browser/tab/state/DEPS

 include_rules = [
   "+chrome/browser/tabpersistence",
+  "+components/payments/content/android",
 ]
 

chrome/browser/tab/java/src/org/chromium/chrome/browser/tab/state/ShoppingPersistedTabData.java

@@ -4,7 +4,6 @@
 
 package org.chromium.chrome.browser.tab.state;
 
-
 import androidx.annotation.Nullable;
 import androidx.annotation.VisibleForTesting;
 
@@ -15,11 +14,13 @@ import org.json.JSONException;
 import org.json.JSONObject;
 
 import org.chromium.base.Callback;
+import org.chromium.base.LocaleUtils;
 import org.chromium.base.Log;
 import org.chromium.chrome.browser.endpoint_fetcher.EndpointFetcher;
 import org.chromium.chrome.browser.profiles.Profile;
 import org.chromium.chrome.browser.tab.Tab;
 import org.chromium.chrome.browser.tab.proto.ShoppingPersistedTabData.ShoppingPersistedTabDataProto;
+import org.chromium.components.payments.CurrencyFormatter;
 
 import java.util.Locale;
 import java.util.concurrent.TimeUnit;
@@ -42,10 +43,12 @@ public class ShoppingPersistedTabData extends PersistedTabData {
     private static final String BUYABLE_PRODUCT_ANNOTATION_KEY = "BUYABLE_PRODUCT";
     private static final String BUYABLE_PRODUCT_KEY = "buyableProduct";
     private static final String CURRENT_PRICE_KEY = "currentPrice";
+    private static final String CURRENCY_CODE_KEY = "currencyCode";
     private static final String AMOUNT_MICROS_KEY = "amountMicros";
     private static final String ACCEPT_LANGUAGE_KEY = "Accept-Language";
-    // TODO(crbug.com/1130068) support all locales
-    private static final String ACCEPT_LANGUAGE_VALUE = "en-US";
+
+    private static final int FRACTIONAL_DIGITS_LESS_THAN_TEN_UNITS = 2;
+    private static final int FRACTIONAL_DIGITS_GREATER_THAN_TEN_UNITS = 0;
 
     private static final Class<ShoppingPersistedTabData> USER_DATA_KEY =
             ShoppingPersistedTabData.class;
@@ -69,6 +72,8 @@ public class ShoppingPersistedTabData extends PersistedTabData {
     private long mPriceMicros = NO_PRICE_KNOWN;
     private long mPreviousPriceMicros = NO_PRICE_KNOWN;
 
+    private String mCurrencyCode;
+
     /**
      * A price drop for the offer {@link ShoppingPersistedTabData}
      * refers to
@@ -124,7 +129,8 @@ public class ShoppingPersistedTabData extends PersistedTabData {
                             Profile.getLastUsedRegularProfile(),
                             String.format(ENDPOINT, tab.getUrlString()), HTTPS_METHOD, CONTENT_TYPE,
                             EMPTY_POST_DATA, TIMEOUT_MS,
-                            new String[] {ACCEPT_LANGUAGE_KEY, ACCEPT_LANGUAGE_VALUE});
+                            new String[] {
+                                    ACCEPT_LANGUAGE_KEY, LocaleUtils.getDefaultLocaleListString()});
                 },
                 ShoppingPersistedTabData.class, callback);
     }
@@ -142,6 +148,7 @@ public class ShoppingPersistedTabData extends PersistedTabData {
                     JSONObject priceMetadata = metadata.getJSONObject(CURRENT_PRICE_KEY);
                     res.setPriceMicros(Long.parseLong(priceMetadata.getString(AMOUNT_MICROS_KEY)),
                             previousShoppingPersistedTabData);
+                    res.setCurrencyCode(priceMetadata.getString(CURRENCY_CODE_KEY));
                     break;
                 }
             }
@@ -178,6 +185,15 @@ public class ShoppingPersistedTabData extends PersistedTabData {
         save();
     }
 
+    protected void setCurrencyCode(String currencyCode) {
+        mCurrencyCode = currencyCode;
+    }
+
+    @VisibleForTesting
+    protected String getCurrencyCode() {
+        return mCurrencyCode;
+    }
+
     @VisibleForTesting
     protected void setPreviousPriceMicros(long previousPriceMicros) {
         mPreviousPriceMicros = previousPriceMicros;
@@ -249,12 +265,21 @@ public class ShoppingPersistedTabData extends PersistedTabData {
     }
 
     // TODO(crbug.com/1130068) support all currencies
-    private static String formatPrice(long priceMicros) {
+    private String formatPrice(long priceMicros) {
+        CurrencyFormatter currencyFormatter =
+                new CurrencyFormatter(mCurrencyCode, Locale.getDefault());
+        String formattedPrice;
         if (priceMicros < TEN_UNITS) {
-            return String.format(Locale.US, "$%.2f", (100 * priceMicros / MICROS_TO_UNITS) / 100.0);
-        }
-        return String.format(Locale.US, "$%d",
-                (int) Math.floor((double) (priceMicros + MICROS_TO_UNITS / 2) / MICROS_TO_UNITS));
+            currencyFormatter.setMaximumFractionalDigits(FRACTIONAL_DIGITS_LESS_THAN_TEN_UNITS);
+            formattedPrice = String.format(
+                    Locale.getDefault(), "%.2f", (100 * priceMicros / MICROS_TO_UNITS) / 100.0);
+        } else {
+            currencyFormatter.setMaximumFractionalDigits(FRACTIONAL_DIGITS_GREATER_THAN_TEN_UNITS);
+            formattedPrice = String.format(Locale.getDefault(), "%d",
+                    (long) Math.floor(
+                            (double) (priceMicros + MICROS_TO_UNITS / 2) / MICROS_TO_UNITS));
+        }
+        return currencyFormatter.format(formattedPrice);
     }
 
     @Override

components/payments/content/android/currency_formatter_android.cc

@@ -34,6 +34,12 @@ void CurrencyFormatterAndroid::Destroy(JNIEnv* env,
   delete this;
 }
 
+void CurrencyFormatterAndroid::SetMaxFractionalDigits(
+    JNIEnv* env,
+    jint jmax_fractional_digits) {
+  currency_formatter_->SetMaxFractionalDigits(jmax_fractional_digits);
+}
+
 base::android::ScopedJavaLocalRef<jstring> CurrencyFormatterAndroid::Format(
     JNIEnv* env,
     const JavaParamRef<jobject>& jcaller,

components/payments/content/android/currency_formatter_android.h

@@ -29,6 +29,9 @@ class CurrencyFormatterAndroid {
   void Destroy(JNIEnv* env,
                const base::android::JavaParamRef<jobject>& jcaller);
 
+  // Set the maximum number of fractional digits.
+  void SetMaxFractionalDigits(JNIEnv* env, jint jnum_fractional_digits);
+
   // Refer to CurrencyFormatter::Format documentation.
   base::android::ScopedJavaLocalRef<jstring> Format(
       JNIEnv* env,

components/payments/content/android/java/src/org/chromium/components/payments/CurrencyFormatter.java

@@ -46,6 +46,15 @@ public class CurrencyFormatter {
         }
     }
 
+    /**
+     * Set the maximum number of fractional digits in the formatted price.
+     * @param maxFractionalDigits maximum number of fractional digits
+     */
+    public void setMaximumFractionalDigits(int maxFractionalDigits) {
+        CurrencyFormatterJni.get().setMaxFractionalDigits(
+                mCurrencyFormatterAndroid, maxFractionalDigits);
+    }
+
     /** @return The currency code formatted for display. */
     public String getFormattedCurrencyCode() {
         return CurrencyFormatterJni.get().getFormattedCurrencyCode(
@@ -76,6 +85,7 @@ public class CurrencyFormatter {
         void destroy(long nativeCurrencyFormatterAndroid, CurrencyFormatter caller);
         String format(
                 long nativeCurrencyFormatterAndroid, CurrencyFormatter caller, String amountValue);
+        void setMaxFractionalDigits(long nativeCurrencyFormatterAndroid, int maxFractionalDigits);
         String getFormattedCurrencyCode(
                 long nativeCurrencyFormatterAndroid, CurrencyFormatter caller);
     }

components/payments/core/currency_formatter.cc

@@ -85,6 +85,10 @@ CurrencyFormatter::CurrencyFormatter(const std::string& currency_code,
 
 CurrencyFormatter::~CurrencyFormatter() {}
 
+void CurrencyFormatter::SetMaxFractionalDigits(const int maxFractionalDigits) {
+  icu_formatter_->setMaximumFractionDigits(maxFractionalDigits);
+}
+
 base::string16 CurrencyFormatter::Format(const std::string& amount) {
   // It's possible that the ICU formatter didn't initialize properly.
   if (!icu_formatter_ || !icu_formatter_->getCurrency())

components/payments/core/currency_formatter.h

@@ -27,6 +27,10 @@ class CurrencyFormatter {
                     const std::string& locale_name);
   ~CurrencyFormatter();
 
+  // Set the maximum number of fractional digits. (kMaximumNumFractionalDigits
+  // is the default if unset)
+  void SetMaxFractionalDigits(const int maxFractionalDigits);
+
   // Formats the |amount| according to the currency code that was set. The
   // result will NOT contain the currency code, nor a subset of it. Rather, the
   // caller of this function should display the currency code separately. The