[Payment Request] Adds a JourneyLogger instance to the PaymentRequest

ios/chrome/browser/payments/payment_request.h

 // Copyright 2017 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 IOS_CHROME_BROWSER_PAYMENTS_PAYMENT_REQUEST_H_
 #define IOS_CHROME_BROWSER_PAYMENTS_PAYMENT_REQUEST_H_
 
 #include <map>
 #include <memory>
 #include <set>
 #include <string>
 #include <vector>
 
 #include "base/macros.h"
 #include "base/memory/weak_ptr.h"
 #include "components/autofill/core/browser/credit_card.h"
+#include "components/payments/core/journey_logger.h"
 #include "components/payments/core/payment_options_provider.h"
 #include "components/payments/core/payment_request_base_delegate.h"
 #include "components/payments/core/payments_profile_comparator.h"
 #include "ios/web/public/payments/payment_request.h"
 
 namespace autofill {
 class AutofillProfile;
 class PersonalDataManager;
 class RegionDataLoader;
 }  // namespace autofill
 
 namespace payments {
 class AddressNormalizer;
 class AddressNormalizerImpl;
 class CurrencyFormatter;
 class PaymentInstrument;
 class AutofillPaymentInstrument;
 }  // namespace payments
 
 namespace ios {
 class ChromeBrowserState;
 }  // namepsace ios
 
+namespace web {
+class WebState;
+}  // namespace web
+
 // A protocol implementd by any UI classes that the PaymentRequest object
 // needs to communicate with in order to perform certain actions such as
 // initiating UI to request full card details for payment.
 @protocol PaymentRequestUIDelegate<NSObject>
 
 - (void)
 requestFullCreditCard:(const autofill::CreditCard&)creditCard
        resultDelegate:
            (base::WeakPtr<autofill::payments::FullCardRequest::ResultDelegate>)
                resultDelegate;
 
 @end
 
 namespace payments {
 
 // Has a copy of web::PaymentRequest as provided by the page invoking the
 // PaymentRequest API. Also caches credit cards and addresses provided by the
 // |personal_data_manager| and manages shared resources and user selections for
-// the current PaymentRequest flow. It must be initialized with a non-null
-// instance of |personal_data_manager| that outlives this class.
+// the current PaymentRequest flow. It must be initialized with non-null
+// instances of |browser_state|, |web_state|, and |personal_data_manager| that
+// outlive this class.
 class PaymentRequest : public PaymentOptionsProvider,
                        public PaymentRequestBaseDelegate {
  public:
   // |personal_data_manager| should not be null and should outlive this object.
   PaymentRequest(const web::PaymentRequest& web_payment_request,
-                 ios::ChromeBrowserState* browser_state_,
+                 ios::ChromeBrowserState* browser_state,
+                 web::WebState* web_state,
                  autofill::PersonalDataManager* personal_data_manager,
                  id<PaymentRequestUIDelegate> payment_request_ui_delegate);
   ~PaymentRequest() override;
 
   // PaymentRequestBaseDelegate:
   autofill::PersonalDataManager* GetPersonalDataManager() override;
   const std::string& GetApplicationLocale() const override;
   bool IsIncognito() const override;
   bool IsSslCertificateValid() override;
   const GURL& GetLastCommittedURL() const override;
@@ skipping 10 matching lines @@
   // Returns the web::PaymentRequest that was used to build this PaymentRequest.
   const web::PaymentRequest& web_payment_request() const {
     return web_payment_request_;
   }
 
   // Returns the payment details from |web_payment_request_|.
   const web::PaymentDetails& payment_details() const {
     return web_payment_request_.details;
   }
 
+  // Returns the JourneyLogger for this instance.
+  const JourneyLogger& journey_logger() const { return journey_logger_; }
+
   // Updates the payment details of the |web_payment_request_|. It also updates
   // the cached references to the shipping options in |web_payment_request_| as
   // well as the reference to the selected shipping option.
   void UpdatePaymentDetails(const web::PaymentDetails& details);
 
   // PaymentOptionsProvider:
   bool request_shipping() const override;
   bool request_payer_name() const override;
   bool request_payer_phone() const override;
   bool request_payer_email() const override;
@@ skipping 131 matching lines @@
   void SetSelectedShippingOption();
 
   // The web::PaymentRequest object as provided by the page invoking the Payment
   // Request API, owned by this object.
   web::PaymentRequest web_payment_request_;
 
   // Never null and outlives this object.
   ios::ChromeBrowserState* browser_state_;
 
   // Never null and outlives this object.
+  web::WebState* web_state_;
+
+  // Never null and outlives this object.
   autofill::PersonalDataManager* personal_data_manager_;
 
   // The PaymentRequestUIDelegate as provided by the UI object that originally
   // created this PaymentRequest object.
   __weak id<PaymentRequestUIDelegate> payment_request_ui_delegate_;
 
   // The address normalizer to use for the duration of the Payment Request.
   AddressNormalizerImpl* address_normalizer_;
 
   // The currency formatter instance for this PaymentRequest flow.
@@ skipping 35 matching lines @@
 
   // The set of supported card types (e.g., credit, debit, prepaid).
   std::set<autofill::CreditCard::CardType> supported_card_types_set_;
 
   // A vector of pointers to the shipping options in |web_payment_request_|.
   std::vector<web::PaymentShippingOption*> shipping_options_;
   web::PaymentShippingOption* selected_shipping_option_;
 
   PaymentsProfileComparator profile_comparator_;
 
+  // Keeps track of different stats during the lifetime of this object.
+  JourneyLogger journey_logger_;
+
   DISALLOW_COPY_AND_ASSIGN(PaymentRequest);
 };
 
 }  // namespace payments
 
 #endif  // IOS_CHROME_BROWSER_PAYMENTS_PAYMENT_REQUEST_H_