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

chrome/android/java/src/org/chromium/chrome/browser/payments/PaymentRequestImpl.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.app.Activity;
 import android.graphics.Bitmap;
 import android.os.Handler;
 import android.text.TextUtils;
 
 import org.json.JSONException;
 import org.json.JSONObject;
 
 import org.chromium.base.Callback;
 import org.chromium.base.Log;
 import org.chromium.base.VisibleForTesting;
 import org.chromium.base.metrics.RecordHistogram;
 import org.chromium.chrome.R;
 import org.chromium.chrome.browser.ChromeActivity;
 import org.chromium.chrome.browser.autofill.PersonalDataManager;
 import org.chromium.chrome.browser.autofill.PersonalDataManager.AutofillProfile;
-import org.chromium.chrome.browser.autofill.PersonalDataManager.NormalizedAddressRequestDelegate;
 import org.chromium.chrome.browser.favicon.FaviconHelper;
 import org.chromium.chrome.browser.payments.ui.Completable;
 import org.chromium.chrome.browser.payments.ui.LineItem;
 import org.chromium.chrome.browser.payments.ui.PaymentInformation;
 import org.chromium.chrome.browser.payments.ui.PaymentOption;
 import org.chromium.chrome.browser.payments.ui.PaymentRequestUI;
 import org.chromium.chrome.browser.payments.ui.SectionInformation;
 import org.chromium.chrome.browser.payments.ui.ShoppingCart;
 import org.chromium.chrome.browser.profiles.Profile;
 import org.chromium.chrome.browser.tab.Tab;
@@ skipping 28 matching lines @@
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
 import java.util.Set;
 
 /**
  * Android implementation of the PaymentRequest service defined in
  * third_party/WebKit/public/platform/modules/payments/payment_request.mojom.
  */
 public class PaymentRequestImpl implements PaymentRequest, PaymentRequestUI.Client,
-        PaymentApp.InstrumentsCallback, PaymentInstrument.DetailsCallback,
-        NormalizedAddressRequestDelegate {
+                                           PaymentApp.InstrumentsCallback,
+                                           PaymentInstrument.DetailsCallback,
+                                           PaymentResponseHelper.PaymentResponseRequesterDelegate {

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

Eeek. Don't let Dan see this. Android engineers don't like this style of
indent... :-(

That is, please change back this indentation.

[sebsg, 2016/10/18 14:38:19]

Done.

     /**
      * Observer to be notified when PaymentRequest UI has been dismissed.
      */
     public interface PaymentRequestDismissObserver {
         /**
          * Called when PaymentRequest UI has been dismissed.
          */
         void onPaymentRequestDismissed();
     }
 
@@ skipping 101 matching lines @@
     private boolean mMerchantSupportsAutofillPaymentInstruments;
     private ContactEditor mContactEditor;
     private boolean mHasRecordedAbortReason;
 
     /** True if any of the requested payment methods are supported. */
     private boolean mArePaymentMethodsSupported;
 
     /** True if show() was called. */
     private boolean mIsShowing;
 
-    private boolean mIsWaitingForNormalization;
-    private PaymentResponse mPendingPaymentResponse;
+    /** The helper to create and fill the response to send to the merchant. */
+    private PaymentResponseHelper mPaymentResponseHelper;
 
     /**
      * Builds the PaymentRequest service implementation.
      *
      * @param context         The context where PaymentRequest has been invoked.
      * @param webContents     The web contents that have invoked the PaymentRequest API.
      * @param dismissObserver The observer to notify when PaymentRequest UI has been dismissed.
      */
     public PaymentRequestImpl(Activity context, WebContents webContents,
             PaymentRequestDismissObserver dismissObserver) {
@@ skipping 613 matching lines @@
                 } else if (toEdit == null) {
                     mPaymentMethodsSection.addAndSelectItem(completeCard);
                 }
 
                 mUI.updateSection(PaymentRequestUI.TYPE_PAYMENT_METHODS, mPaymentMethodsSection);
             }
         });
     }
 
     @Override
+    public void loadingInstrumentDetails() {
+        mUI.showProcessingMessage();
+    }
+
+    @Override
     public boolean onPayClicked(PaymentOption selectedShippingAddress,
             PaymentOption selectedShippingOption, PaymentOption selectedPaymentMethod) {
         assert selectedPaymentMethod instanceof PaymentInstrument;
         PaymentInstrument instrument = (PaymentInstrument) selectedPaymentMethod;
         mPaymentAppRunning = true;
+
+        PaymentOption selectedContact =
+                mContactSection != null ? mContactSection.getSelectedItem() : null;
+        mPaymentResponseHelper = new PaymentResponseHelper(
+                selectedShippingAddress, selectedShippingOption, selectedContact, this);
+
         instrument.getDetails(mMerchantName, mOrigin, mRawTotal, mRawLineItems,
                 mMethodData.get(instrument.getMethodName()), this);
         recordSuccessFunnelHistograms("PayClicked");
         return !(instrument instanceof AutofillPaymentInstrument);
     }
 
     @Override
     public void onDismiss() {
         disconnectFromClientWithDebugMessage("Dialog dismissed");
         closeUI(true);
@@ skipping 78 matching lines @@
                     instrument.dismiss();
                 }
             }
         }
 
         // Some payment apps still have not responded. Continue waiting for them.
         if (!mPendingApps.isEmpty()) return;
 
         if (disconnectIfNoPaymentMethodsSupported()) return;
 
+        // Load the validation rules for each unique region code in the credit card billing
+        // addresses.
+        Set<String> uniqueCountryCodes = new HashSet<>();
+        for (int i = 0; i < mPendingAutofillInstruments.size(); ++i) {
+            assert mPendingAutofillInstruments.get(i) instanceof AutofillPaymentInstrument;
+
+            String countryCode = AutofillAddress.getCountryCode((
+                    (AutofillPaymentInstrument) mPendingAutofillInstruments.get(
+                            i)).getBillingAddress());
+            if (!uniqueCountryCodes.contains(countryCode)) {
+                uniqueCountryCodes.add(countryCode);
+                PersonalDataManager.getInstance().loadRulesForRegion(countryCode);
+            }
+        }
+
         // List order:
         // > Non-autofill instruments.
         // > Complete autofill instruments.
         // > Incomplete autofill instruments.
         Collections.sort(mPendingAutofillInstruments, COMPLETENESS_COMPARATOR);
         mPendingInstruments.addAll(mPendingAutofillInstruments);
 
         mPendingAutofillInstruments.clear();
         mPendingAutofillInstruments = null;
 
@@ skipping 65 matching lines @@
         } else {
             mPendingInstruments.add(instrument);
         }
     }
 
     /**
      * Called after retrieving instrument details.
      */
     @Override
     public void onInstrumentDetailsReady(String methodName, String stringifiedDetails) {
-        if (mClient == null) return;
-
-        PaymentResponse response = new PaymentResponse();
-        response.methodName = methodName;
-        response.stringifiedDetails = stringifiedDetails;
-
-        if (mContactSection != null) {
-            PaymentOption selectedContact = mContactSection.getSelectedItem();
-            if (selectedContact != null) {
-                // Contacts are created in show(). These should all be instances of AutofillContact.
-                assert selectedContact instanceof AutofillContact;
-                response.payerPhone = ((AutofillContact) selectedContact).getPayerPhone();
-                response.payerEmail = ((AutofillContact) selectedContact).getPayerEmail();
-            }
-        }
-
-        if (mUiShippingOptions != null) {
-            PaymentOption selectedShippingOption = mUiShippingOptions.getSelectedItem();
-            if (selectedShippingOption != null && selectedShippingOption.getIdentifier() != null) {
-                response.shippingOption = selectedShippingOption.getIdentifier();
-            }
-        }
+        if (mClient == null || mPaymentResponseHelper == null) return;
 
         // Record the payment method used to complete the transaction. If the payment method was an
         // Autofill credit card with an identifier, record its use.
         PaymentOption selectedPaymentMethod = mPaymentMethodsSection.getSelectedItem();
         if (selectedPaymentMethod instanceof AutofillPaymentInstrument) {
             if (!selectedPaymentMethod.getIdentifier().isEmpty()) {
                 PersonalDataManager.getInstance().recordAndLogCreditCardUse(
                         selectedPaymentMethod.getIdentifier());
             }
             PaymentRequestMetrics.recordSelectedPaymentMethodHistogram(
                     PaymentRequestMetrics.SELECTED_METHOD_CREDIT_CARD);
         } else if (methodName.equals(ANDROID_PAY_METHOD_NAME)) {
             PaymentRequestMetrics.recordSelectedPaymentMethodHistogram(
                     PaymentRequestMetrics.SELECTED_METHOD_ANDROID_PAY);
         } else {
             PaymentRequestMetrics.recordSelectedPaymentMethodHistogram(
                     PaymentRequestMetrics.SELECTED_METHOD_OTHER_PAYMENT_APP);
         }
 
-        mUI.showProcessingMessage();
+        recordSuccessFunnelHistograms("ReceivedInstrumentDetails");
 
-        if (mShippingAddressesSection != null) {
-            PaymentOption selectedShippingAddress = mShippingAddressesSection.getSelectedItem();
-            if (selectedShippingAddress != null) {
-                // Shipping addresses are created in show(). These should all be instances of
-                // AutofillAddress.
-                assert selectedShippingAddress instanceof AutofillAddress;
-                AutofillAddress selectedAutofillAddress = (AutofillAddress) selectedShippingAddress;
+        mPaymentResponseHelper.onInstrumentDetailsReceived(methodName, stringifiedDetails);
+    }
 
-                // Addresses to be sent to the merchant should always be complete.
-                assert selectedAutofillAddress.isComplete();
-
-                // Record the use of the profile.
-                PersonalDataManager.getInstance().recordAndLogProfileUse(
-                        selectedAutofillAddress.getProfile().getGUID());
-
-                response.shippingAddress = selectedAutofillAddress.toPaymentAddress();
-
-                // Create the normalization task.
-                mPendingPaymentResponse = response;
-                mIsWaitingForNormalization = true;
-                boolean willNormalizeAsync = PersonalDataManager.getInstance().normalizeAddress(
-                        selectedAutofillAddress.getProfile().getGUID(),
-                        AutofillAddress.getCountryCode(selectedAutofillAddress.getProfile()), this);
-
-                if (willNormalizeAsync) {
-                    // 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());
-                }
-
-                // The payment response will be sent to the merchant in onAddressNormalized instead.
-                return;
-            }
-        }
-
+    @Override
+    public void onPaymentResponseReady(PaymentResponse response) {
         mClient.onPaymentResponse(response);
-        recordSuccessFunnelHistograms("ReceivedInstrumentDetails");
+        mPaymentResponseHelper = null;
+        PersonalDataManager.getInstance().cancelPendingAddressNormalizations();
     }
 
     /**
-     * Callback method called either when the address has finished normalizing or when the timeout
-     * triggers. Replaces the address in the response with the normalized version if present and
-     * sends the response to the merchant.
-     *
-     * @param profile The profile with the address normalized or a null profile if the timeout
-     *                triggered first.
-     */
-    @Override
-    public void onAddressNormalized(AutofillProfile profile) {
-        // Check if the other task finished first.
-        if (!mIsWaitingForNormalization) return;
-        mIsWaitingForNormalization = false;
-
-        // Check if the response was already sent to the merchant.
-        if (mClient == null || mPendingPaymentResponse == null) return;
-
-        if (profile != null && !TextUtils.isEmpty(profile.getGUID())) {
-            // The normalization finished first: use the normalized address.
-            mPendingPaymentResponse.shippingAddress =
-                    new AutofillAddress(profile, true /* isComplete */).toPaymentAddress();
-        } else {
-            // The timeout triggered first: cancel the normalization task.
-            PersonalDataManager.getInstance().cancelPendingAddressNormalization();
-        }
-
-        // Send the payment response to the merchant.
-        mClient.onPaymentResponse(mPendingPaymentResponse);
-
-        mPendingPaymentResponse = null;
-
-        recordSuccessFunnelHistograms("ReceivedInstrumentDetails");
-    }
-
-    /**
      * Called if unable to retrieve instrument details.
      */
     @Override
     public void onInstrumentDetailsError() {
         mUI.onPayButtonProcessingCancelled();
         mPaymentAppRunning = false;
     }
 
     /**
      * Closes the UI. If the client is still connected, then it's notified of UI hiding.
@@ skipping 57 matching lines @@
     private void recordAbortReasonHistogram(int abortReason) {
         assert abortReason < PaymentRequestMetrics.ABORT_REASON_MAX;
         if (mHasRecordedAbortReason) return;
 
         mHasRecordedAbortReason = true;
         RecordHistogram.recordEnumeratedHistogram(
                 "PaymentRequest.CheckoutFunnel.Aborted", abortReason,
                 PaymentRequestMetrics.ABORT_REASON_MAX);
     }
 }