src/sync/internal_api/debug_info_event_listener.h

   1 // Copyright 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef SYNC_INTERNAL_API_DEBUG_INFO_EVENT_LISTENER_H_
   6 #define SYNC_INTERNAL_API_DEBUG_INFO_EVENT_LISTENER_H_
   7
   8 #include <deque>
   9 #include <string>
  10
  11 #include "base/compiler_specific.h"
  12 #include "sync/base/sync_export.h"
  13 #include "sync/internal_api/public/base/model_type.h"
  14 #include "sync/internal_api/public/data_type_debug_info_listener.h"
  15 #include "sync/internal_api/public/sessions/sync_session_snapshot.h"
  16 #include "sync/internal_api/public/sync_encryption_handler.h"
  17 #include "sync/internal_api/public/sync_manager.h"
  18 #include "sync/internal_api/public/util/weak_handle.h"
  19 #include "sync/js/js_backend.h"
  20 #include "sync/protocol/sync.pb.h"
  21 #include "sync/sessions/debug_info_getter.h"
  22
  23 namespace syncer {
  24
  25 // In order to track datatype association results, we need at least as many
  26 // entries as datatypes. Reserve additional space for other kinds of events that
  27 // are likely to happen during first sync or startup.
  28 const unsigned int kMaxEntries = MODEL_TYPE_COUNT + 10;
  29
  30 // Listens to events and records them in a queue. And passes the events to
  31 // syncer when requested.
  32 // This class is not thread safe and should only be accessed on the sync thread.
  33 class SYNC_EXPORT_PRIVATE DebugInfoEventListener
  34     : public SyncManager::Observer,
  35       public SyncEncryptionHandler::Observer,
  36       public sessions::DebugInfoGetter,
  37       public DataTypeDebugInfoListener {
  38  public:
  39   DebugInfoEventListener();
  40   virtual ~DebugInfoEventListener();
  41
  42   // SyncManager::Observer implementation.
  43   virtual void OnSyncCycleCompleted(
  44     const sessions::SyncSessionSnapshot& snapshot) OVERRIDE;
  45   virtual void OnInitializationComplete(
  46       const WeakHandle<JsBackend>& js_backend,
  47       const WeakHandle<DataTypeDebugInfoListener>& debug_listener,
  48       bool success, ModelTypeSet restored_types) OVERRIDE;
  49   virtual void OnConnectionStatusChange(
  50       ConnectionStatus connection_status) OVERRIDE;
  51   virtual void OnActionableError(
  52       const SyncProtocolError& sync_error) OVERRIDE;
  53   virtual void OnMigrationRequested(ModelTypeSet types) OVERRIDE;
  54   virtual void OnProtocolEvent(const ProtocolEvent& event) OVERRIDE;
  55
  56   // SyncEncryptionHandler::Observer implementation.
  57   virtual void OnPassphraseRequired(
  58       PassphraseRequiredReason reason,
  59       const sync_pb::EncryptedData& pending_keys) OVERRIDE;
  60   virtual void OnPassphraseAccepted() OVERRIDE;
  61   virtual void OnBootstrapTokenUpdated(
  62       const std::string& bootstrap_token,
  63       BootstrapTokenType type) OVERRIDE;
  64   virtual void OnEncryptedTypesChanged(
  65       ModelTypeSet encrypted_types,
  66       bool encrypt_everything) OVERRIDE;
  67   virtual void OnEncryptionComplete() OVERRIDE;
  68   virtual void OnCryptographerStateChanged(
  69       Cryptographer* cryptographer) OVERRIDE;
  70   virtual void OnPassphraseTypeChanged(
  71       PassphraseType type,
  72       base::Time explicit_passphrase_time) OVERRIDE;
  73
  74   // Sync manager events.
  75   void OnNudgeFromDatatype(ModelType datatype);
  76   void OnIncomingNotification(const ObjectIdInvalidationMap& invalidations);
  77
  78   // DebugInfoGetter implementation.
  79   virtual void GetDebugInfo(sync_pb::DebugInfo* debug_info) OVERRIDE;
  80
  81   // DebugInfoGetter implementation.
  82   virtual void ClearDebugInfo() OVERRIDE;
  83
  84   // DataTypeDebugInfoListener implementation.
  85   virtual void OnDataTypeConfigureComplete(
  86       const std::vector<DataTypeConfigurationStats>& configuration_stats)
  87       OVERRIDE;
  88
  89   // Returns a weak pointer to this object.
  90   base::WeakPtr<DataTypeDebugInfoListener> GetWeakPtr();
  91
  92  private:
  93   FRIEND_TEST_ALL_PREFIXES(DebugInfoEventListenerTest, VerifyEventsAdded);
  94   FRIEND_TEST_ALL_PREFIXES(DebugInfoEventListenerTest, VerifyQueueSize);
  95   FRIEND_TEST_ALL_PREFIXES(DebugInfoEventListenerTest, VerifyGetEvents);
  96   FRIEND_TEST_ALL_PREFIXES(DebugInfoEventListenerTest, VerifyClearEvents);
  97
  98   void AddEventToQueue(const sync_pb::DebugEventInfo& event_info);
  99   void CreateAndAddEvent(sync_pb::SyncEnums::SingletonDebugEventType type);
 100
 101   typedef std::deque<sync_pb::DebugEventInfo> DebugEventInfoQueue;
 102   DebugEventInfoQueue events_;
 103
 104   // True indicates we had to drop one or more events to keep our limit of
 105   // |kMaxEntries|.
 106   bool events_dropped_;
 107
 108   // Cryptographer has keys that are not yet decrypted.
 109   bool cryptographer_has_pending_keys_;
 110
 111   // Cryptographer is initialized and does not have pending keys.
 112   bool cryptographer_ready_;
 113
 114   base::ThreadChecker thread_checker_;
 115
 116   base::WeakPtrFactory<DebugInfoEventListener> weak_ptr_factory_;
 117
 118   DISALLOW_COPY_AND_ASSIGN(DebugInfoEventListener);
 119 };
 120
 121 }  // namespace syncer
 122
 123 #endif  // SYNC_INTERNAL_API_DEBUG_INFO_EVENT_LISTENER_H_