Autocheckout: parse multiple clicks setting in autofill response.

components/autofill/browser/autocheckout_page_meta_data.h

 // Copyright (c) 2013 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.
 
 #ifndef COMPONENTS_AUTOFILL_BROWSER_AUTOCHECKOUT_PAGE_META_DATA_H_
 #define COMPONENTS_AUTOFILL_BROWSER_AUTOCHECKOUT_PAGE_META_DATA_H_
 
+#include <vector>
+
 #include "base/basictypes.h"
 #include "components/autofill/common/web_element_descriptor.h"
 
 namespace autofill {
 
 // Container for multipage Autocheckout data.
 struct AutocheckoutPageMetaData {
+  struct ClickElement{
+    WebElementDescriptor web_element;
+    // The time to wait after click the element which gives merchant's script a
+    // chance to execute. Usually we do not need to wait, but set it wisely if
+    // it is required.
+    int wait_time_ms;

[Ilya Sherman, 2013/05/21 04:25:04]

How are the times chosen?  What guarantees that the merchant's script will
complete in any specific amount of time?  The time required for the script to
run seems like it would depend a lot on the user's hardware and the load on that
hardware...

[benquan, 2013/05/21 17:17:08]

You are absolutely correct, the time required to complete merchant's script
depends on many factors, and there is no easy and clean way to detect that. So
we have to set it conservatively so that it covers majority of the users.

But, in the majority of the sites, we do not need to set a wait_time at all. If
we do need it for a few sites, I would expect merchant's script just simply
show/hide or enable/disable some DOM objects that are already loaded in the
page, it should be relatively quick. If the merchant use AJAX to bring in new
forms, we treats them as a new Autocheckout page, and query autofill server for
autofill-info for the new form, and thus a new AutocheckoutPageMetaData will be
retrieved, so wait_time_ms is not required.

[Ilya Sherman, 2013/05/21 22:48:41]

By this, you mean that for the majority of the sites, this entire CL is unneeded
-- right?
Let me reiterate: Relying on hardcoded timeouts is flaky (because even a
conservative setting will not cover all users) and slow (because a conservative
setting implies a lot of wasted time for most users).  We should block on
explicit DOM events instead, or find some other deterministic way to identify
when a step in the purchase flow has completed.

+  };
+
   AutocheckoutPageMetaData();
   ~AutocheckoutPageMetaData();
 
   // Returns true if the Autofill server says that the current page is start of
   // a multipage Autofill flow.
   bool IsStartOfAutofillableFlow() const;
 
   // Returns true if the Autofill server says that the current page is in a
   // multipage Autofill flow.
   bool IsInAutofillableFlow() const;
 
   // Returns true if the Autofill server says that the current page is the end
   // of a multipage Autofill flow.
   bool IsEndOfAutofillableFlow() const;
 
   // Page number of the multipage Autofill flow this form belongs to
   // (zero-indexed). If this form doesn't belong to any autofill flow, it is set
   // to -1.
   int current_page_number;
 
   // Total number of pages in the multipage Autofill flow. If this form doesn't
   // belong to any autofill flow, it is set to -1.
   int total_pages;
 
+  // A list of elements to click before filling form fields.
+  // Elements have to be clicked in order, and may wait between clicks.
+  std::vector<ClickElement> click_elements_before_formfill;
+
+  // A list of elements to click after filling form fields, and before clicking
+  // page_advance_button.
+  // Elements have to be clicked in order, and may wait between clicks.
+  std::vector<ClickElement> click_elements_after_formfill;
+
   // The proceed element of the multipage Autofill flow. It can be empty
   // if current page is the last page of a flow or isn't a member of a flow.
   WebElementDescriptor proceed_element_descriptor;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(AutocheckoutPageMetaData);
 };
 
 }  // namespace autofill
 
 #endif  // COMPONENTS_AUTOFILL_BROWSER_AUTOCHECKOUT_PAGE_META_DATA_H_