15d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)// Copyright 2014 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#ifndef COMPONENTS_SYNC_DRIVER_MODEL_ASSOCIATION_MANAGER_H__ 65d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#define COMPONENTS_SYNC_DRIVER_MODEL_ASSOCIATION_MANAGER_H__ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)#include <map> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/weak_ptr.h" 11eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "base/timer/timer.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 135d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#include "components/sync_driver/data_type_manager.h" 14868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)#include "sync/internal_api/public/data_type_association_stats.h" 152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "sync/internal_api/public/util/weak_handle.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 175f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)namespace sync_driver { 185f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles) 195f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)class DataTypeController; 205f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles) 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// |ModelAssociationManager| does the heavy lifting for doing the actual model 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// association. It instructs DataTypeControllers to load models, start 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// associating and stopping. Since the operations are async it uses an 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// interface to inform DataTypeManager the results of the operations. 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This class is owned by DataTypeManager. 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// |ModelAssociationManager| association functions are async. The results of 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// those operations are passed back via this interface. 28f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles)class ModelAssociationManagerDelegate { 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 30f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // Called when model association (MergeDataAndStartSyncing) has completed 31f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // for |type|, regardless of success or failure. 32868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) virtual void OnSingleDataTypeAssociationDone( 33868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) syncer::ModelType type, 34868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) const syncer::DataTypeAssociationStats& association_stats) = 0; 35f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 36f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // Called when the ModelAssociationManager has decided it must stop |type|, 37f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // likely because it is no longer a desired data type or sync is shutting 38f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // down. 396e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles) virtual void OnSingleDataTypeWillStop(syncer::ModelType type, 406e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles) const syncer::SyncError& error) = 0; 41f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 42f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // Called when the ModelAssociationManager has tried to perform model 43f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // association for all desired types and has nothing left to do. 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnModelAssociationDone( 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const DataTypeManager::ConfigureResult& result) = 0; 46f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) virtual ~ModelAssociationManagerDelegate() {} 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The class that is responsible for model association. 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ModelAssociationManager { 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 52868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) ModelAssociationManager(const DataTypeController::TypeMap* controllers, 53f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) ModelAssociationManagerDelegate* delegate); 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~ModelAssociationManager(); 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Initializes the state to do the model association in future. This 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // should be called before communicating with sync server. A subsequent call 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // of Initialize is only allowed if the ModelAssociationManager has invoked 59f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // |OnModelAssociationDone| on the |ModelAssociationManagerDelegate|. After 60868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) // this call, there should be several calls to StartAssociationAsync() 61868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) // to associate subset of |desired_types|. 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Initialize(syncer::ModelTypeSet desired_types); 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Can be called at any time. Synchronously stops all datatypes. 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Stop(); 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 67868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) // Should only be called after Initialize to start the actual association. 68868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) // |types_to_associate| should be subset of |desired_types| in Initialize(). 69868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) // When this is completed, |OnModelAssociationDone| will be invoked. 70868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) void StartAssociationAsync(const syncer::ModelTypeSet& types_to_associate); 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This is used for TESTING PURPOSE ONLY. The test case can inspect 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // and modify the timer. 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(sync) : This would go away if we made this class be able to do 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Dependency injection. crbug.com/129212. 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::OneShotTimer<ModelAssociationManager>* GetTimerForTesting(); 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum State { 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This is the state after |Initialize| is called. 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) INITIALIZED_TO_CONFIGURE, 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Starting a new configuration. 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CONFIGURING, 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // No configuration is in progress. 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) IDLE 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 885d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Called at the end of association to reset state to prepare for next 895d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // round of association. 905d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void ResetForNextAssociation(); 915d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 925d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Called by Initialize() to stop types that are not in |desired_types_|. 935d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void StopDisabledTypes(); 945d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 955d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Start loading non-running types that are in |desired_types_|. 965d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void LoadEnabledTypes(); 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Callback passed to each data type controller on starting association. This 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // callback will be invoked when the model association is done. 1005d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void TypeStartCallback(syncer::ModelType type, 1015d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) base::TimeTicks type_start_time, 1026e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles) DataTypeController::ConfigureResult start_result, 1032a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const syncer::SyncMergeResult& local_merge_result, 1042a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const syncer::SyncMergeResult& syncer_merge_result); 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Callback that will be invoked when the models finish loading. This callback 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // will be passed to |LoadModels| function. 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ModelLoadCallback(syncer::ModelType type, syncer::SyncError error); 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1105d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Called when all requested types are associated or association times out. 111f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // Notify |delegate_| of configuration results. 1125d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void ModelAssociationDone(); 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 114f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // A helper to stop an individual datatype. 1156e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles) void StopDatatype(const syncer::SyncError& error, DataTypeController* dtc); 116f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) State state_; 118868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) 1195d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Data types that are enabled. 1205d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) syncer::ModelTypeSet desired_types_; 1215d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1225d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Data types that are requested to associate. 1235d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) syncer::ModelTypeSet requested_types_; 1245d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1255d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Data types currently being associated, including types waiting for model 1265d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // load. 127868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) syncer::ModelTypeSet associating_types_; 128868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) 1295d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Data types that are loaded, i.e. ready to associate. 1305d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) syncer::ModelTypeSet loaded_types_; 1315d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1325d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Data types that are associated, i.e. no more action needed during 1335d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // reconfiguration if not disabled. 1345d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) syncer::ModelTypeSet associated_types_; 1355d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 136b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // Time when StartAssociationAsync() is called to associate for a set of data 137b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // types. 1385d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) base::TimeTicks association_start_time_; 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Set of all registered controllers. 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const DataTypeController::TypeMap* controllers_; 1422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // The processor in charge of handling model association results. 144f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) ModelAssociationManagerDelegate* delegate_; 1452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Timer to track and limit how long a datatype takes to model associate. 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::OneShotTimer<ModelAssociationManager> timer_; 1482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1495d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) DataTypeManager::ConfigureStatus configure_status_; 1505d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1511320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci base::WeakPtrFactory<ModelAssociationManager> weak_ptr_factory_; 1521320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(ModelAssociationManager); 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1555f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles) 1565f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)} // namespace sync_driver 1575f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles) 1585d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#endif // COMPONENTS_SYNC_DRIVER_MODEL_ASSOCIATION_MANAGER_H__ 159