Notify DataUseTabModel of navigations and tab closures

chrome/browser/android/data_usage/data_use_ui_tab_model.h

 // Copyright 2015 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 CHROME_BROWSER_ANDROID_DATA_USAGE_DATA_USE_UI_TAB_MODEL_H_
 #define CHROME_BROWSER_ANDROID_DATA_USAGE_DATA_USE_UI_TAB_MODEL_H_
 
 #include <stdint.h>
 
 #include <unordered_map>
 
 #include "base/gtest_prod_util.h"
 #include "base/macros.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/weak_ptr.h"
 #include "base/threading/thread_checker.h"
+#include "chrome/browser/android/data_usage/data_use_tab_model.h"
 #include "components/keyed_service/core/keyed_service.h"
 #include "ui/base/page_transition_types.h"
 
 class GURL;
 
 namespace chrome {
 
 namespace android {
 
 // DataUseUITabModel tracks data use tracking start and end transitions on the
 // browser's tabs. It serves as a bridge between the DataUseTabModel, which
 // lives on the IO thread, browser navigation events and tab closure events,
 // which are generated on the UI thread, and UI elements that appear when data
 // use tracking starts and ends in a Tab. DataUseUITabModel forwards navigation
 // and tab closure events to the DataUseTabModel, and receives tab tracking
 // transitions (start/end) from the DataUseTabModel, which it conveys to UI
 // notification logic. DataUseUITabModel is not thread-safe, and should be
 // accessed only on the UI thread.
 // TODO(tbansal): DataUseTabModel should notify DataUseUITabModel when a tab
 // is removed from the list of tabs.
-class DataUseUITabModel : public KeyedService {
+class DataUseUITabModel : public KeyedService,
+                          public DataUseTabModel::TabDataUseObserver {
  public:
   explicit DataUseUITabModel(
       scoped_refptr<base::SingleThreadTaskRunner> io_task_runner);
   ~DataUseUITabModel() override;
 
   // Reports a browser navigation to the DataUseTabModel on IO thread. Includes
   // the |page_transition|, |tab_id|, and |gurl| for the navigation. Tabs that
   // are restored when Chromium restarts are not reported.
   void ReportBrowserNavigation(const GURL& gurl,
                                ui::PageTransition page_transition,
                                int32_t tab_id) const;
 
   // Reports a tab closure for the tab with |tab_id| to the DataUseTabModel on
   // IO thread. The tab could either have been closed or evicted from the memory
   // by Android.
   void ReportTabClosure(int32_t tab_id);
 
   // Returns true if data use tracking has been started for the tab with id
   // |tab_id|. Calling this function resets the state of the tab.
   bool HasDataUseTrackingStarted(int32_t tab_id);
 
   // Returns true if data use tracking has ended for the tab with id |tab_id|.
   // Calling this function resets the state of the tab.
   bool HasDataUseTrackingEnded(int32_t tab_id);
 
+  // Sets the weak pointer to DataUseTabModel that can be used on IO thread.
+  void SetIODataUseTabModel(
+      base::WeakPtr<DataUseTabModel> io_data_use_tab_model);
+
+  // Sets the weak pointer to DataUseTabModel that can be used on UI thread,
+  // and registers as an observer to DataUseTabModel::TabDataUseObserver.
+  void SetUIDataUseTabModel(
+      base::WeakPtr<DataUseTabModel> ui_data_use_tab_model);

[sclittle, 2015/11/16 23:13:42]

I don't understand why the DataUseTabModel needs to be used on the UI thread.
Shouldn't all the UI thread logic be part of the DataUseUITabModel instead?

[tbansal1, 2015/11/17 21:12:33]

Done.

+
  private:
   FRIEND_TEST_ALL_PREFIXES(DataUseUITabModelTest, EntranceExitState);
+  FRIEND_TEST_ALL_PREFIXES(DataUseUITabModelTest, ConvertTransitionType);
+  FRIEND_TEST_ALL_PREFIXES(DataUseUITabModelTest, ReportTabEventsTest);
 
   // DataUseTrackingEvent indicates the state of a tab.
   enum DataUseTrackingEvent {
     // Indicates that data use tracking has started.
     DATA_USE_TRACKING_STARTED,
 
     // Indicates that data use tracking has ended.
     DATA_USE_TRACKING_ENDED,
   };
 
   typedef std::unordered_map<int32_t, DataUseTrackingEvent> TabEvents;
 
   // DataUseTabModel::Observer implementation:
-  // TODO(tbansal): Add override once DataUseTabModel is checked in.
-  void OnTrackingStarted(int32_t tab_id);
-  void OnTrackingEnded(int32_t tab_id);
+  void NotifyTrackingStarting(int32_t tab_id) override;
+  void NotifyTrackingEnding(int32_t tab_id) override;
 
   // Creates |event| for tab with id |tab_id| and value |event|, if there is no
   // existing entry for |tab_id|, and returns true. Otherwise, returns false
   // without modifying the entry.
   bool MaybeCreateTabEvent(int32_t tab_id, DataUseTrackingEvent event);
 
   // Removes event entry for |tab_id|, if the entry is equal to |event|, and
   // returns true. Otherwise, returns false without modifying the entry.
   bool RemoveTabEvent(int32_t tab_id, DataUseTrackingEvent event);
 
+  // Converts |page_transition| to DataUseTabModel::TransitionType enum.
+  // Returns true if conversion was successful, and updates |transition_type|.
+  // Otherwise, returns false, and |transition_type| is not changed.
+  // |transition_type| must not be null.

[Raj, 2015/11/16 22:00:09]

nits: 
rename transition_type to output_transition_type to be more clear.

[tbansal1, 2015/11/17 21:12:33]

I think |transition_type| is okay, since it  is a pointer and not getting passed
by a const ref (so it is clear that function may modify it). Also, the function
name makes it clear that something is getting converted.

+  bool ConvertTransitionType(
+      ui::PageTransition page_transition,
+      DataUseTabModel::TransitionType* transition_type) const;
+
+  // |io_data_use_tab_model_| is used to call DataUseTabModel methods.
+  // |ui_data_use_tab_model_| is used to register as an observer to
+  // DataUseTabModel::TabDataUseObserver.
+  base::WeakPtr<DataUseTabModel> io_data_use_tab_model_;
+  base::WeakPtr<DataUseTabModel> ui_data_use_tab_model_;

[sclittle, 2015/11/16 23:13:42]

It doesn't make sense to have a WeakPtr tied to a different thread than the
DataUseTabModel, since the DataUseTabModel will always be destroyed on the IO
thread. See my other comments about WeakPtr thread un-safety.

[tbansal1, 2015/11/17 21:12:33]

Done.

+
   // |tab_events_| stores tracking events of multiple tabs.
   TabEvents tab_events_;
 
+  // True if |this| is registered as an observer to
+  // DataUseTabModel::TabDataUseObserver.
+  bool registered_as_observer_;
+
   // |io_task_runner_| accesses DataUseTabModel members on IO thread.
   scoped_refptr<base::SingleThreadTaskRunner> io_task_runner_;
 
   base::ThreadChecker thread_checker_;
 
   DISALLOW_COPY_AND_ASSIGN(DataUseUITabModel);
 };
 
 }  // namespace android
 
 }  // namespace chrome
 
 #endif  // CHROME_BROWSER_ANDROID_DATA_USAGE_DATA_USE_UI_TAB_MODEL_H_