[ExpandablePaymentHandler] Resolve OpenWindow on WebContents created

Context:
PaymentRequestEvent.OpenWindow() promise should be resolved to be a
window client. With ExpandablePaymentHandler enabled, OpenWindow is
never resolved. This makes a payment app service worker fail to send a
message to the payment app js since it relies on the resolved
WindowClient.

Before Change:
With ExpandablePaymentHandler enabled, PaymentRequestEvent.OpenWindow()
is never resolved.

After Change:
With ExpandablePaymentHandler enabled, OpenWindow is resolved upon
initializing the WebContents of PaymentHandler.

Change:
Notify ServiceTabLaunch when Expandable PH UI has initialized
WebContents, so that ServiceTabLaunch can resolve the OpenWindow()
promise.

Bug: 1045955

Change-Id: I3fae5f90d144d27e97044f175478072743de05aa
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2037643Reviewed-by: Ted Choc <tedchoc@chromium.org>
Reviewed-by: Rouslan Solomakhin <rouslan@chromium.org>
Commit-Queue: Liquan (Max) Gu <maxlg@chromium.org>
Cr-Commit-Position: refs/heads/master@{#738572}

chrome/android/java/src/org/chromium/chrome/browser/ServiceTabLauncher.java

@@ -81,9 +81,13 @@ public class ServiceTabLauncher {
         if (disposition == WindowOpenDisposition.NEW_POPUP) {
             boolean success = false;
             try {
-                success = PaymentHandlerCoordinator.isEnabled()
-                        ? PaymentRequestImpl.openPaymentHandlerWindow(new URI(url))
-                        : createPopupCustomTab(requestId, url, incognito);
+                if (PaymentHandlerCoordinator.isEnabled()) {
+                    success = PaymentRequestImpl.openPaymentHandlerWindow(new URI(url),
+                            (webContents)
+                                    -> onWebContentsForRequestAvailable(requestId, webContents));
+                } else {
+                    success = createPopupCustomTab(requestId, url, incognito);
+                }
             } catch (URISyntaxException e) { /* Intentionally leave blank, so success is false. */
             }
             if (!success) {

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

@@ -32,6 +32,7 @@ import org.chromium.chrome.browser.flags.ChromeFeatureList;
 import org.chromium.chrome.browser.page_info.CertificateChainHelper;
 import org.chromium.chrome.browser.payments.handler.PaymentHandlerCoordinator;
 import org.chromium.chrome.browser.payments.handler.PaymentHandlerCoordinator.PaymentHandlerUiObserver;
+import org.chromium.chrome.browser.payments.handler.PaymentHandlerCoordinator.PaymentHandlerWebContentsObserver;
 import org.chromium.chrome.browser.payments.micro.MicrotransactionCoordinator;
 import org.chromium.chrome.browser.payments.ui.ContactDetailsSection;
 import org.chromium.chrome.browser.payments.ui.LineItem;
@@ -1291,21 +1292,28 @@ public class PaymentRequestImpl
     }
 
     /**
-     *  Called to open a new PaymentHandler UI on the showing PaymentRequest.
-     *  @param url The url of the payment app to be displayed in the UI.
-     *  @return Whether the opening is successful.
+     * Called to open a new PaymentHandler UI on the showing PaymentRequest.
+     * @param url The url of the payment app to be displayed in the UI.
+     * @param paymentHandlerWebContentsObserver The observer of the WebContents of the
+     * PaymentHandler.
+     * @return Whether the opening is successful.
      */
-    public static boolean openPaymentHandlerWindow(URI url) {
+    public static boolean openPaymentHandlerWindow(
+            URI url, PaymentHandlerWebContentsObserver paymentHandlerWebContentsObserver) {
         return sShowingPaymentRequest != null
-                && sShowingPaymentRequest.openPaymentHandlerWindowInternal(url);
+                && sShowingPaymentRequest.openPaymentHandlerWindowInternal(
+                        url, paymentHandlerWebContentsObserver);
     }
 
     /**
-     *  Called to open a new PaymentHandler UI on this PaymentRequest.
-     *  @param url The url of the payment app to be displayed in the UI.
-     *  @return Whether the opening is successful.
+     * Called to open a new PaymentHandler UI on this PaymentRequest.
+     * @param url The url of the payment app to be displayed in the UI.
+     * @param paymentHandlerWebContentsObserver The observer of the WebContents of the
+     * PaymentHandler.
+     * @return Whether the opening is successful.
      */
-    private boolean openPaymentHandlerWindowInternal(URI url) {
+    private boolean openPaymentHandlerWindowInternal(
+            URI url, PaymentHandlerWebContentsObserver paymentHandlerWebContentsObserver) {
         assert mInvokedPaymentInstrument != null;
         assert mInvokedPaymentInstrument instanceof ServiceWorkerPaymentApp;
         assert org.chromium.chrome.browser.browserservices.Origin.create(url.toString())
@@ -1318,7 +1326,8 @@ public class PaymentRequestImpl
         mPaymentHandlerUi = new PaymentHandlerCoordinator();
         ChromeActivity chromeActivity = ChromeActivity.fromWebContents(mWebContents);
         if (chromeActivity == null) return false;
-        return mPaymentHandlerUi.show(chromeActivity, url, mIsIncognito, /*observer=*/this);
+        return mPaymentHandlerUi.show(chromeActivity, url, mIsIncognito,
+                paymentHandlerWebContentsObserver, /*uiObserver=*/this);
     }
 
     @Override

chrome/android/java/src/org/chromium/chrome/browser/payments/handler/PaymentHandlerCoordinator.java

@@ -44,6 +44,15 @@ public class PaymentHandlerCoordinator {
         void onPaymentHandlerUiShown();
     }
 
+    /** Observes the WebContents of the payment-handler UI. */
+    public interface PaymentHandlerWebContentsObserver {
+        /**
+         * Called when the WebContents has been initialized.
+         * @param webContents The WebContents of the PaymentHandler.
+         */
+        void onWebContentsInitialized(WebContents webContents);
+    }
+
     /**
      * Shows the payment-handler UI.
      *
@@ -51,11 +60,14 @@ public class PaymentHandlerCoordinator {
      * @param url The url of the payment handler app, i.e., that of
      *         "PaymentRequestEvent.openWindow(url)".
      * @param isIncognito Whether the tab is in incognito mode.
-     * @param observer The {@link PaymentHandlerUiObserver} that observes this Payment Handler UI.
+     * @param webContentsObserver The observer of the WebContents of the
+     *         PaymentHandler.
+     * @param uiObserver The {@link PaymentHandlerUiObserver} that observes this Payment Handler UI.
      * @return Whether the payment-handler UI was shown. Can be false if the UI was suppressed.
      */
     public boolean show(ChromeActivity activity, URI url, boolean isIncognito,
-            PaymentHandlerUiObserver observer) {
+            PaymentHandlerWebContentsObserver webContentsObserver,
+            PaymentHandlerUiObserver uiObserver) {
         assert mHider == null : "Already showing payment-handler UI";
 
         mWebContents = WebContentsFactory.createWebContents(isIncognito, /*initiallyHidden=*/false);
@@ -63,11 +75,12 @@ public class PaymentHandlerCoordinator {
         mWebContents.initialize(ChromeVersionInfo.getProductVersion(),
                 ViewAndroidDelegate.createBasicDelegate(webContentView), webContentView,
                 activity.getWindowAndroid(), WebContents.createDefaultInternalsHolder());
+        webContentsObserver.onWebContentsInitialized(mWebContents);
         mWebContents.getNavigationController().loadUrl(new LoadUrlParams(url.toString()));
 
         PropertyModel model = new PropertyModel.Builder(PaymentHandlerProperties.ALL_KEYS).build();
         PaymentHandlerMediator mediator =
-                new PaymentHandlerMediator(model, this::hide, mWebContents, observer);
+                new PaymentHandlerMediator(model, this::hide, mWebContents, uiObserver);
         BottomSheetController bottomSheetController = activity.getBottomSheetController();
         bottomSheetController.addObserver(mediator);
         mWebContents.addObserver(mediator);
@@ -84,7 +97,7 @@ public class PaymentHandlerCoordinator {
             bottomSheetController.removeObserver(mediator);
             bottomSheetController.hideContent(/*content=*/view, /*animate=*/true);
             mWebContents.destroy();
-            observer.onPaymentHandlerUiClosed();
+            uiObserver.onPaymentHandlerUiClosed();
         };
         return bottomSheetController.requestShowContent(view, /*animate=*/true);
     }

chrome/browser/payments/expandable_payment_handler_browsertest.cc

@@ -118,5 +118,20 @@ IN_PROC_BROWSER_TEST_F(ExpandablePaymentHandlerBrowserTest,
                 GetActiveWebContents(),
                 "launchAndWaitUntilReady('" + GetHttpPageUrl().spec() + "')"));
 }
+
+// Make sure openWindow() can be resolved into window client.
+IN_PROC_BROWSER_TEST_F(ExpandablePaymentHandlerBrowserTest, WindowClientReady) {
+  std::string expected = "success";
+  EXPECT_EQ(expected, content::EvalJs(GetActiveWebContents(), "install()"));
+  EXPECT_EQ("app_is_ready",
+            content::EvalJs(
+                GetActiveWebContents(),
+                "launchAndWaitUntilReady('./payment_handler_window.html')"));
+
+  DCHECK(test_controller_.GetPaymentHandlerWebContents());
+  EXPECT_EQ(true,
+            content::EvalJs(test_controller_.GetPaymentHandlerWebContents(),
+                            "isWindowClientReady()"));
+}
 }  // namespace
 }  // namespace payments

components/test/data/payments/maxpay.com/payment_handler_sw.js

@@ -38,16 +38,20 @@ self.addEventListener('paymentrequest', (evt) => {
   evt.respondWith(new Promise((responder) => {
     paymentRequestResponder = responder;
     const errorString = 'open_window_failed';
-    evt.openWindow(url).then((result) => {
-      if (!result) {
-        paymentRequestEvent.changePaymentMethod(methodName, {
-          status: errorString,
+    evt.openWindow(url)
+        .then((windowClient) => {
+          if (!windowClient) {
+            paymentRequestEvent.changePaymentMethod(methodName, {
+              status: errorString,
+            });
+          } else {
+            windowClient.postMessage('window_client_ready');
+          }
+        })
+        .catch((error) => {
+          paymentRequestEvent.changePaymentMethod(methodName, {
+            status: errorString,
+          });
         });
-      }
-    }).catch((error) => {
-      paymentRequestEvent.changePaymentMethod(methodName, {
-        status: errorString,
-      });
-    });
   }));
 });

components/test/data/payments/maxpay.com/payment_handler_window.html

@@ -16,6 +16,8 @@ found in the LICENSE file.
 </body>
 
 <script>
+let window_client_ready = false;
+
 /**
  * Insert a message to the widget called 'log'.
  * @param {string} text - the text that is intended to be inserted
@@ -44,8 +46,24 @@ function cancel() {
   return 'canceled';
 }
 
+function isWindowClientReady() {
+  return window_client_ready;
+}
+
 window.onload = function() {
   navigator.serviceWorker.controller.postMessage('app_is_ready');
   updateLogView('app is ready.');
 }
+
+navigator.serviceWorker.addEventListener('message', (evt) => {
+  if (!evt.data) {
+    updateLogView('Received an empty message');
+    return;
+  }
+
+  if (evt.data === 'window_client_ready') {
+    window_client_ready = true;
+  }
+  updateLogView(evt.data);
+});
 </script>