Add TODOs to remove legacy invalidations implementation

The old (Tango-based) implementation of invalidations has been (mostly)
replaced by a new (FCM-based) one. The old one can not quite be deleted
yet, so this CL marks all the old classes/files with a TODO for removal.
It also removes a few unnecessary includes of the to-be-removed files.

Bug: 1029481
Change-Id: Ic10da302ba20731487fc4784971c923bec07a88d
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1943177
Auto-Submit: Marc Treib <treib@chromium.org>
Reviewed-by: Tim Schumann <tschumann@chromium.org>
Commit-Queue: Marc Treib <treib@chromium.org>
Cr-Commit-Position: refs/heads/master@{#720194}

components/invalidation/impl/deprecated_invalidator_registrar.h

@@ -22,6 +22,8 @@ class ObjectIdInvalidationMap;
 // keep track of registered handlers and which object ID registrations are
 // associated with which handlers, so implementors can just reuse the logic
 // here to dispatch invalidations and other interesting notifications.
+// TODO(crbug.com/1029481): Part of the legacy implementation of invalidations,
+// scheduled for deletion.
 class INVALIDATION_EXPORT DeprecatedInvalidatorRegistrar {
  public:
   DeprecatedInvalidatorRegistrar();

components/invalidation/impl/fcm_invalidation_listener_unittest.cc

@@ -14,7 +14,6 @@
 #include "components/invalidation/impl/fake_invalidation_state_tracker.h"
 #include "components/invalidation/impl/fcm_invalidation_listener.h"
 #include "components/invalidation/impl/per_user_topic_registration_manager.h"
-#include "components/invalidation/impl/push_client_channel.h"
 #include "components/invalidation/impl/unacked_invalidation_set_test_util.h"
 #include "components/invalidation/public/invalidation_util.h"
 #include "components/invalidation/public/invalidator_state.h"

components/invalidation/impl/fcm_invalidation_service_unittest.cc

@@ -22,11 +22,8 @@
 #include "components/invalidation/impl/fcm_invalidation_listener.h"
 #include "components/invalidation/impl/fcm_network_handler.h"
 #include "components/invalidation/impl/fcm_sync_network_channel.h"
-#include "components/invalidation/impl/gcm_invalidation_bridge.h"
 #include "components/invalidation/impl/invalidation_prefs.h"
 #include "components/invalidation/impl/invalidation_service_test_template.h"
-#include "components/invalidation/impl/invalidation_state_tracker.h"
-#include "components/invalidation/impl/invalidator.h"
 #include "components/invalidation/impl/profile_identity_provider.h"
 #include "components/invalidation/public/topic_invalidation_map.h"
 #include "components/prefs/pref_registry_simple.h"

components/invalidation/impl/gcm_invalidation_bridge.h

@@ -35,6 +35,8 @@ class IdentityProvider;
 // Core lives on IO thread. Core implements GCMNetworkChannelDelegate and posts
 // all function calls to GCMInvalidationBridge which does actual work to perform
 // them.
+// TODO(crbug.com/1029481): Part of the legacy implementation of invalidations,
+// scheduled for deletion.
 class GCMInvalidationBridge : public gcm::GCMAppHandler,
                               public gcm::GCMConnectionObserver {
  public:

components/invalidation/impl/gcm_network_channel.h

@@ -50,6 +50,8 @@ struct GCMNetworkChannelDiagnostic {
 
 // GCMNetworkChannel is an implementation of SyncNetworkChannel that routes
 // messages through GCMService.
+// TODO(crbug.com/1029481): Part of the legacy implementation of invalidations,
+// scheduled for deletion.
 class INVALIDATION_EXPORT GCMNetworkChannel
     : public SyncNetworkChannel,
       public network::NetworkConnectionTracker::NetworkConnectionObserver {

components/invalidation/impl/gcm_network_channel_delegate.h

@@ -22,6 +22,8 @@ namespace syncer {
 // in HTTP message to server.
 // GCMNetworkChannel lives on IO thread therefore calls will be made on IO
 // thread and callbacks should be invoked there as well.
+// TODO(crbug.com/1029481): Part of the legacy implementation of invalidations,
+// scheduled for deletion.
 class GCMNetworkChannelDelegate {
  public:
   typedef base::Callback<void(const GoogleServiceAuthError& error,

components/invalidation/impl/invalidation_listener.h

@@ -9,7 +9,7 @@
 
 namespace syncer {
 
-// Handlers registration and message recieving events.
+// Handlers registration and message receiving events.
 class InvalidationListener {
  public:
   virtual ~InvalidationListener() {}

components/invalidation/impl/invalidation_notifier.h

@@ -31,6 +31,8 @@
 namespace syncer {
 
 // This class must live on the IO thread.
+// TODO(crbug.com/1029481): Part of the legacy implementation of invalidations,
+// scheduled for deletion.
 class INVALIDATION_EXPORT InvalidationNotifier
     : public Invalidator,
       public SyncInvalidationListener::Delegate {

components/invalidation/impl/invalidation_service_android.h

@@ -26,6 +26,8 @@ class InvalidationLogger;
 
 // This InvalidationService is used to deliver invalidations on Android.  The
 // Android operating system has its own mechanisms for delivering invalidations.
+// TODO(crbug.com/1029481): Part of the legacy implementation of invalidations,
+// scheduled for deletion.
 class InvalidationServiceAndroid : public InvalidationService {
  public:
   explicit InvalidationServiceAndroid();

components/invalidation/impl/invalidation_state_tracker.h

@@ -25,6 +25,8 @@
 
 namespace syncer {
 
+// TODO(crbug.com/1029481): Part of the legacy implementation of invalidations,
+// scheduled for deletion.
 class INVALIDATION_EXPORT InvalidationStateTracker {
  public:
   InvalidationStateTracker();

components/invalidation/impl/invalidator.h

@@ -20,6 +20,8 @@
 namespace syncer {
 class InvalidationHandler;
 
+// TODO(crbug.com/1029481): Part of the legacy implementation of invalidations,
+// scheduled for deletion.
 class INVALIDATION_EXPORT Invalidator {
  public:
   Invalidator();

components/invalidation/impl/invalidator_storage.h

@@ -22,6 +22,8 @@ namespace invalidation {
 // Wraps PrefService in an InvalidationStateTracker to allow SyncNotifiers
 // to use PrefService as persistence for invalidation state. It is not thread
 // safe, and lives on the UI thread.
+// TODO(crbug.com/1029481): Part of the legacy implementation of invalidations,
+// scheduled for deletion.
 class InvalidatorStorage : public syncer::InvalidationStateTracker {
  public:
   // |pref_service| may not be NULL and must outlive |this|.

components/invalidation/impl/non_blocking_invalidator.h

@@ -42,6 +42,8 @@ class GCMNetworkChannelDelegate;
 using NetworkChannelCreator =
     base::Callback<std::unique_ptr<SyncNetworkChannel>(void)>;
 
+// TODO(crbug.com/1029481): Part of the legacy implementation of invalidations,
+// scheduled for deletion.
 class INVALIDATION_EXPORT NonBlockingInvalidator
     : public Invalidator,
       public InvalidationStateTracker {

components/invalidation/impl/push_client_channel.h

@@ -24,6 +24,8 @@ namespace syncer {
 
 // A PushClientChannel is an implementation of NetworkChannel that
 // routes messages through a PushClient.
+// TODO(crbug.com/1029481): Part of the legacy implementation of invalidations,
+// scheduled for deletion.
 class INVALIDATION_EXPORT PushClientChannel
     : public SyncNetworkChannel,
       public notifier::PushClientObserver {

components/invalidation/impl/registration_manager.h

@@ -33,6 +33,8 @@ using ::invalidation::InvalidationListener;
 // implementations include the syncer thread (both versions) and XMPP
 // retries.  The most sophisticated one is URLRequestThrottler; making
 // that generic should work for everyone.
+// TODO(crbug.com/1029481): Part of the legacy implementation of invalidations,
+// scheduled for deletion.
 class INVALIDATION_EXPORT RegistrationManager {
  public:
   // Constants for exponential backoff (used by tests).

components/invalidation/impl/state_writer.h

@@ -13,6 +13,8 @@
 
 namespace syncer {
 
+// TODO(crbug.com/1029481): Part of the legacy implementation of invalidations,
+// scheduled for deletion.
 class INVALIDATION_EXPORT StateWriter {
  public:
   virtual ~StateWriter() {}

components/invalidation/impl/sync_invalidation_listener.h

@@ -32,6 +32,8 @@ class RegistrationManager;
 
 // SyncInvalidationListener is not thread-safe and lives on the sync
 // thread.
+// TODO(crbug.com/1029481): Part of the legacy implementation of invalidations,
+// scheduled for deletion.
 class INVALIDATION_EXPORT SyncInvalidationListener
     : public invalidation::InvalidationListener,
       public StateWriter,

components/invalidation/impl/sync_system_resources.h

@@ -31,6 +31,9 @@ class NetworkConnectionTracker;
 class SharedURLLoaderFactoryInfo;
 }  // namespace network
 
+// TODO(crbug.com/1029481): Part of the legacy implementation of invalidations,
+// scheduled for deletion.
+
 namespace syncer {
 
 class GCMNetworkChannelDelegate;

components/invalidation/impl/ticl_invalidation_service.h

@@ -44,6 +44,8 @@ class GCMInvalidationBridge;
 
 // This InvalidationService wraps the C++ Invalidation Client (TICL) library.
 // It provides invalidations for desktop platforms (Win, Mac, Linux).
+// TODO(crbug.com/1029481): Part of the legacy implementation of invalidations,
+// scheduled for deletion.
 class TiclInvalidationService : public InvalidationService,
                                 public IdentityProvider::Observer,
                                 public syncer::InvalidationHandler {

components/sync/driver/glue/sync_engine_impl_unittest.cc

@@ -23,7 +23,6 @@
 #include "build/build_config.h"
 #include "components/invalidation/impl/invalidation_logger.h"
 #include "components/invalidation/impl/invalidation_switches.h"
-#include "components/invalidation/impl/invalidator_storage.h"
 #include "components/invalidation/impl/profile_invalidation_provider.h"
 #include "components/invalidation/public/invalidation_service.h"
 #include "components/invalidation/public/invalidator_state.h"