[Payments] Normalize billing address before sending to the merchant.

chrome/android/java/src/org/chromium/chrome/browser/payments/AutofillPaymentInstrument.java

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package org.chromium.chrome.browser.payments;
 
+import android.os.Handler;
 import android.text.TextUtils;
 import android.util.JsonWriter;
 
+import org.json.JSONObject;
+
 import org.chromium.chrome.browser.autofill.PersonalDataManager;
 import org.chromium.chrome.browser.autofill.PersonalDataManager.AutofillProfile;
 import org.chromium.chrome.browser.autofill.PersonalDataManager.CreditCard;
 import org.chromium.chrome.browser.autofill.PersonalDataManager.FullCardRequestDelegate;
+import org.chromium.chrome.browser.autofill.PersonalDataManager.NormalizedAddressRequestDelegate;
 import org.chromium.content_public.browser.WebContents;
 import org.chromium.payments.mojom.PaymentItem;
 
-import org.json.JSONObject;
-
 import java.io.IOException;
 import java.io.StringWriter;
 import java.util.List;
 
 import javax.annotation.Nullable;
 
 /**
  * The locally stored credit card payment instrument.
  */
-public class AutofillPaymentInstrument
-        extends PaymentInstrument implements FullCardRequestDelegate {
+public class AutofillPaymentInstrument extends PaymentInstrument
+        implements FullCardRequestDelegate, NormalizedAddressRequestDelegate {
     private final WebContents mWebContents;
+    private final Handler mHandler = new Handler();
     private CreditCard mCard;
     private boolean mIsComplete;
+    private String mSecurityCode;
     @Nullable private AutofillProfile mBillingAddress;
     @Nullable private DetailsCallback mCallback;
+    private boolean mIsWaitingForBillingNormalization;
+    private boolean mIsWaitingForFullCardDetails;
 
     /**
      * Builds a payment instrument for the given credit card.
      *
      * @param webContents    The web contents where PaymentRequest was invoked.
      * @param card           The autofill card that can be used for payment.
      * @param billingAddress The billing address for the card.
      */
     public AutofillPaymentInstrument(
             WebContents webContents, CreditCard card, @Nullable AutofillProfile billingAddress) {
         super(card.getGUID(), card.getObfuscatedNumber(), card.getName(),
                 card.getIssuerIconDrawableId());
         mWebContents = webContents;
         mCard = card;
         mIsComplete = false;
         mBillingAddress = billingAddress;
     }
 
     @Override
     public String getMethodName() {
         return mCard.getBasicCardPaymentType();
     }
 
     @Override
     public void getDetails(String unusedMerchantName, String unusedOrigin, PaymentItem unusedTotal,
             List<PaymentItem> unusedCart, JSONObject unusedDetails, DetailsCallback callback) {
+        // The billing address should never be null for a credit card.

[please use gerrit instead, 2016/10/18 17:30:31]

... at this point.


(A credit card can have a null billing address initially, but PaymentRequest UI
will force user to set a non-null billing address before the user can use that
card. This method is called when the user clicks Pay with this card selected as
the payment instrument.)

[sebsg, 2016/10/18 22:44:31]

Done.

+        assert mBillingAddress != null;
         assert mIsComplete;
         assert mCallback == null;
         mCallback = callback;
+
+        mIsWaitingForBillingNormalization = true;
+        mIsWaitingForFullCardDetails = true;
+
+        // Start the billing address normalization.
+        mIsWaitingForBillingNormalization =
+                PersonalDataManager.getInstance().normalizeAddress(mBillingAddress.getGUID(),
+                        AutofillAddress.getCountryCode(mBillingAddress), this);
+        if (mIsWaitingForBillingNormalization) {
+            // If the normalization was not done synchronously, start a timer to cancel the
+            // asynchronous normalization if it takes too long.
+            mHandler.postDelayed(new Runnable() {
+                @Override
+                public void run() {
+                    onAddressNormalized(null);
+                }
+            }, PersonalDataManager.getInstance().getNormalizationTimeoutMS());
+        }
+
+        // Start to get the full card details.
         PersonalDataManager.getInstance().getFullCard(mWebContents, mCard, this);
     }
 
+    // TODO(crbug.com/656981): Update the credit card expiration on file.

[please use gerrit instead, 2016/10/18 17:30:31]

crbug.com/656981 should be fixed in full_card_request.cc instead.

[sebsg, 2016/10/18 22:44:31]

Done.

     @Override
-    public void onFullCardDetails(CreditCard card, String cvc) {
+    public void onFullCardDetails(CreditCard updatedCard, String cvc) {
+        // Keep the cvc for after the normalization.
+        mSecurityCode = cvc;
+
+        // Update the card's expiration date.
+        mCard.setMonth(updatedCard.getMonth());
+        mCard.setYear(updatedCard.getYear());
+
+        mIsWaitingForFullCardDetails = false;
+
+        // Wait for the billing address normalization before sending the instrument details.
+        if (mIsWaitingForBillingNormalization) {
+            // Show the loading UI while the address gets normalized.
+            mCallback.loadingInstrumentDetails();
+            return;
+        }
+
+        sendIntrumentDetails();

[please use gerrit instead, 2016/10/18 17:30:31]

Instead of early-returning immediately before the end of a function, a better
style could be if-else statement. Consider:

void stuff() {
  if (x) {
    doY();
    return;
  }

  doZ();
}


vs:

void stuff() {
  if (x)
    doY();
  else
   doZ();
}

I think the latter is more clear to understand. Early returns are useful if
there are multiple points in the function that can prevent it from full
completion. What do you think?

[sebsg, 2016/10/18 22:44:31]

Done.

+    }
+
+    @Override
+    public void onAddressNormalized(AutofillProfile profile) {
+        if (!mIsWaitingForBillingNormalization) return;
+        mIsWaitingForBillingNormalization = false;
+
+        // If the normalization finished first, use the normalized address.
+        if (profile != null) mBillingAddress = profile;
+
+        // Wait for the full card details before sending the instrument details.
+        if (mIsWaitingForFullCardDetails) return;
+
+        sendIntrumentDetails();

[please use gerrit instead, 2016/10/18 17:30:31]

Shorter:

if (!mIsWatingForFullCardDetails) sendInstrumentDetails();

[sebsg, 2016/10/18 22:44:31]

Done.

+    }
+
+    /**
+     * Stringify the card details and send the resulting string and the method name to the
+     * registered callback.
+     */
+    private void sendIntrumentDetails() {
         StringWriter stringWriter = new StringWriter();
         JsonWriter json = new JsonWriter(stringWriter);
         try {
             json.beginObject();
 
-            json.name("cardholderName").value(card.getName());
-            json.name("cardNumber").value(card.getNumber());
-            json.name("expiryMonth").value(card.getMonth());
-            json.name("expiryYear").value(card.getYear());
-            json.name("cardSecurityCode").value(cvc);
+            json.name("cardholderName").value(mCard.getName());
+            json.name("cardNumber").value(mCard.getNumber());
+            json.name("expiryMonth").value(mCard.getMonth());
+            json.name("expiryYear").value(mCard.getYear());
+            json.name("cardSecurityCode").value(mSecurityCode);
 
             json.name("billingAddress").beginObject();
 
             json.name("country").value(ensureNotNull(mBillingAddress.getCountryCode()));
             json.name("region").value(ensureNotNull(mBillingAddress.getRegion()));
             json.name("city").value(ensureNotNull(mBillingAddress.getLocality()));
             json.name("dependentLocality")
                     .value(ensureNotNull(mBillingAddress.getDependentLocality()));
 
             json.name("addressLine").beginArray();
@@ skipping 11 matching lines @@
             json.name("languageCode").value(ensureNotNull(mBillingAddress.getLanguageCode()));
             json.name("organization").value(ensureNotNull(mBillingAddress.getCompanyName()));
             json.name("recipient").value(ensureNotNull(mBillingAddress.getFullName()));
             json.name("phone").value(ensureNotNull(mBillingAddress.getPhoneNumber()));
 
             json.endObject();
 
             json.endObject();
         } catch (IOException e) {
             onFullCardError();
+            mSecurityCode = "";

[please use gerrit instead, 2016/10/18 17:30:30]

Remove

[sebsg, 2016/10/18 22:44:31]

Wow, I still thought I had to keep that info before calling the callback (like
when I still used a mTempCard)... That's why I didn't do the finally... Sorry!

             return;
         }

[please use gerrit instead, 2016/10/18 17:30:31]

} finally {
    mSecurityCode = "";
}

[sebsg, 2016/10/18 22:44:31]

Done.

 
-        mCallback.onInstrumentDetailsReady(card.getBasicCardPaymentType(), stringWriter.toString());
+        mCallback.onInstrumentDetailsReady(
+                mCard.getBasicCardPaymentType(), stringWriter.toString());
+
+        mSecurityCode = "";

[please use gerrit instead, 2016/10/18 17:30:30]

Remove

[sebsg, 2016/10/18 22:44:31]

Done.

     }
 
     private static String ensureNotNull(@Nullable String value) {
         return value == null ? "" : value;
     }
 
     @Override
     public void onFullCardError() {
         mCallback.onInstrumentDetailsError();
         mCallback = null;
@@ skipping 30 matching lines @@
         mBillingAddress = billingAddress;
         mIsComplete = true;
         updateIdentifierLabelsAndIcon(card.getGUID(), card.getObfuscatedNumber(), card.getName(),
                 null, card.getIssuerIconDrawableId());
     }
 
     /** @return The credit card represented by this payment instrument. */
     public CreditCard getCard() {
         return mCard;
     }
-}
+
+    /** @return The billing address associated with this credit card. */
+    public AutofillProfile getBillingAddress() {
+        return mBillingAddress;
+    }
+}