Make use of InvalidationService

sync/tools/sync_client.cc

 // Copyright (c) 2012 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.
 
 #include <cstddef>
 #include <cstdio>
 #include <string>
 
 #include "base/at_exit.h"
 #include "base/command_line.h"
 #include "base/compiler_specific.h"
 #include "base/debug/stack_trace.h"
 #include "base/files/scoped_temp_dir.h"
 #include "base/json/json_writer.h"
 #include "base/logging.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
 #include "base/message_loop.h"
+#include "base/rand_util.h"
 #include "base/task_runner.h"
 #include "base/threading/thread.h"
 #include "jingle/notifier/base/notification_method.h"
 #include "jingle/notifier/base/notifier_options.h"
 #include "net/base/host_port_pair.h"
 #include "net/base/network_change_notifier.h"
 #include "net/dns/host_resolver.h"
 #include "net/http/transport_security_state.h"
 #include "net/url_request/url_request_test_util.h"
 #include "sync/internal_api/public/base/model_type.h"
 #include "sync/internal_api/public/base_node.h"
 #include "sync/internal_api/public/engine/passive_model_worker.h"
 #include "sync/internal_api/public/http_bridge.h"
 #include "sync/internal_api/public/internal_components_factory_impl.h"
 #include "sync/internal_api/public/read_node.h"
 #include "sync/internal_api/public/sync_manager.h"
 #include "sync/internal_api/public/sync_manager_factory.h"
 #include "sync/internal_api/public/util/report_unrecoverable_error_function.h"
 #include "sync/internal_api/public/util/unrecoverable_error_handler.h"
 #include "sync/internal_api/public/util/weak_handle.h"
 #include "sync/js/js_event_details.h"
 #include "sync/js/js_event_handler.h"
 #include "sync/notifier/invalidation_state_tracker.h"
-#include "sync/notifier/invalidator.h"
-#include "sync/notifier/invalidator_factory.h"
+#include "sync/notifier/non_blocking_invalidator.h"
 #include "sync/test/fake_encryptor.h"
 #include "sync/tools/null_invalidation_state_tracker.h"
 
 #if defined(OS_MACOSX)
 #include "base/mac/scoped_nsautorelease_pool.h"
 #endif
 
 // This is a simple utility that initializes a sync client and
 // prints out any events.
 
@@ skipping 153 matching lines @@
   notifier_options.try_ssltcp_first =
       command_line.HasSwitch(kXmppTrySslTcpFirstSwitch);
   LOG_IF(INFO, notifier_options.try_ssltcp_first)
       << "Trying SSL/TCP port before XMPP port for notifications.";
 
   notifier_options.allow_insecure_connection =
       command_line.HasSwitch(kXmppAllowInsecureConnectionSwitch);
   LOG_IF(INFO, notifier_options.allow_insecure_connection)
       << "Allowing insecure XMPP connections.";
 
-  if (command_line.HasSwitch(kNotificationMethodSwitch)) {
-    notifier_options.notification_method =
-        notifier::StringToNotificationMethod(
-            command_line.GetSwitchValueASCII(kNotificationMethodSwitch));
-  }
+  return notifier_options;
+}
 
-  return notifier_options;
+void StubNetworkTimeUpdateCallback(const base::Time&,
+                                   const base::TimeDelta&,
+                                   const base::TimeDelta&) {
 }
 
 int SyncClientMain(int argc, char* argv[]) {
 #if defined(OS_MACOSX)
   base::mac::ScopedNSAutoreleasePool pool;
 #endif
   base::AtExitManager exit_manager;
   CommandLine::Init(argc, argv);
   logging::InitLogging(
       NULL,
@@ skipping 11 matching lines @@
   // Parse command line.
   const CommandLine& command_line = *CommandLine::ForCurrentProcess();
   SyncCredentials credentials;
   credentials.email = command_line.GetSwitchValueASCII(kEmailSwitch);
   credentials.sync_token = command_line.GetSwitchValueASCII(kTokenSwitch);
   // TODO(akalin): Write a wrapper script that gets a token for an
   // email and password and passes that in to this utility.
   if (credentials.email.empty() || credentials.sync_token.empty()) {
     std::printf("Usage: %s --%s=foo@bar.com --%s=token\n"
                 "[--%s=host:port] [--%s] [--%s]\n"
-                "[--%s=(server|p2p)]\n\n"
                 "Run chrome and set a breakpoint on\n"
                 "syncer::SyncManagerImpl::UpdateCredentials() "
                 "after logging into\n"
                 "sync to get the token to pass into this utility.\n",
                 argv[0],
                 kEmailSwitch, kTokenSwitch, kXmppHostPortSwitch,
                 kXmppTrySslTcpFirstSwitch,
-                kXmppAllowInsecureConnectionSwitch,
-                kNotificationMethodSwitch);
+                kXmppAllowInsecureConnectionSwitch);
     return -1;
   }
 
   // Set up objects that monitor the network.
   scoped_ptr<net::NetworkChangeNotifier> network_change_notifier(
       net::NetworkChangeNotifier::Create());
 
   // Set up sync notifier factory.
   const scoped_refptr<MyTestURLRequestContextGetter> context_getter =
       new MyTestURLRequestContextGetter(io_thread.message_loop_proxy());
   const notifier::NotifierOptions& notifier_options =
       ParseNotifierOptions(command_line, context_getter);
-  const char kClientInfo[] = "sync_listen_notifications";
+  const char kClientInfo[] = "standalone_sync_client";
+  std::string invalidator_id = base::RandBytesAsString(8);
   NullInvalidationStateTracker null_invalidation_state_tracker;
-  InvalidatorFactory invalidator_factory(
-      notifier_options, kClientInfo,
-      null_invalidation_state_tracker.AsWeakPtr());
+  Invalidator* invalidator = new NonBlockingInvalidator(

[akalin, 2013/05/24 22:58:46]

what owns the invalidator?

[rlarocque, 2013/05/29 00:37:55]

In this patch, no one owns it.  I'll change this to a scoped_ptr.

Even after that change, I think it might leak some memory during shutdown.  If
we stop the IO thread before the NonBlockingInvalidator is destroyed, then I
suspect it will be unable to destroy the blocking Invalidator that it owns.

On the other hand, how does this program shut down gracefully?  I've always
assumed that Ctrl+C was the only way to stop it.

[akalin, 2013/06/04 19:23:54]

Yeah, there's no graceful shutdown. But it's good to document ownership (via
using scoped_ptr, etc.)

+      notifier_options,
+      invalidator_id,
+      null_invalidation_state_tracker.GetAllInvalidationStates(),
+      null_invalidation_state_tracker.GetBootstrapData(),
+      WeakHandle<InvalidationStateTracker>(
+          null_invalidation_state_tracker.AsWeakPtr()),
+      kClientInfo);
 
   // Set up database directory for the syncer.
   base::ScopedTempDir database_dir;
   CHECK(database_dir.CreateUniqueTempDir());
 
-  // Set up model type parameters.
-  const ModelTypeSet model_types = ModelTypeSet::All();
+  // Developers often add types to ModelTypeSet::All() before the server
+  // supports them.  We need to be explicit about which types we want here.
+  ModelTypeSet model_types;
+  model_types.Put(BOOKMARKS);
+  model_types.Put(PREFERENCES);
+  model_types.Put(PASSWORDS);
+  model_types.Put(AUTOFILL);
+  model_types.Put(THEMES);
+  model_types.Put(TYPED_URLS);
+  model_types.Put(EXTENSIONS);
+  model_types.Put(NIGORI);
+  model_types.Put(SEARCH_ENGINES);
+  model_types.Put(SESSIONS);
+  model_types.Put(APPS);
+  model_types.Put(AUTOFILL_PROFILE);
+  model_types.Put(APP_SETTINGS);
+  model_types.Put(EXTENSION_SETTINGS);
+  model_types.Put(APP_NOTIFICATIONS);
+  model_types.Put(HISTORY_DELETE_DIRECTIVES);
+  model_types.Put(SYNCED_NOTIFICATIONS);
+  model_types.Put(DEVICE_INFO);
+  model_types.Put(EXPERIMENTS);
+  model_types.Put(PRIORITY_PREFERENCES);
+  model_types.Put(DICTIONARY);
+  model_types.Put(FAVICON_IMAGES);
+  model_types.Put(FAVICON_TRACKING);
+
   ModelSafeRoutingInfo routing_info;
   for (ModelTypeSet::Iterator it = model_types.First();
        it.Good(); it.Inc()) {
     routing_info[it.Get()] = GROUP_PASSIVE;
   }
   scoped_refptr<PassiveModelWorker> passive_model_safe_worker =
       new PassiveModelWorker(&sync_loop);
   std::vector<ModelSafeWorker*> workers;
   workers.push_back(passive_model_safe_worker.get());
 
   // Set up sync manager.
   SyncManagerFactory sync_manager_factory;
   scoped_ptr<SyncManager> sync_manager =
       sync_manager_factory.CreateSyncManager("sync_client manager");
   LoggingJsEventHandler js_event_handler;
   const char kSyncServerAndPath[] = "clients4.google.com/chrome-sync/dev";
   int kSyncServerPort = 443;
   bool kUseSsl = true;
   // Used only by InitialProcessMetadata(), so it's okay to leave this as NULL.
   const scoped_refptr<base::TaskRunner> blocking_task_runner = NULL;
   const char kUserAgent[] = "sync_client";
   // TODO(akalin): Replace this with just the context getter once
   // HttpPostProviderFactory is removed.
   scoped_ptr<HttpPostProviderFactory> post_factory(
       new HttpBridgeFactory(context_getter,
                             kUserAgent,
-                            NetworkTimeUpdateCallback()));
+                            base::Bind(&StubNetworkTimeUpdateCallback)));
   // Used only when committing bookmarks, so it's okay to leave this
   // as NULL.
   ExtensionsActivityMonitor* extensions_activity_monitor = NULL;
   LoggingChangeDelegate change_delegate;
   const char kRestoredKeyForBootstrapping[] = "";
   const char kRestoredKeystoreKeyForBootstrapping[] = "";
   NullEncryptor null_encryptor;
   LoggingUnrecoverableErrorHandler unrecoverable_error_handler;
   InternalComponentsFactoryImpl::Switches factory_switches = {
       InternalComponentsFactory::ENCRYPTION_KEYSTORE,
       InternalComponentsFactory::BACKOFF_NORMAL
   };
 
   sync_manager->Init(database_dir.path(),
                     WeakHandle<JsEventHandler>(
                         js_event_handler.AsWeakPtr()),
                     kSyncServerAndPath,
                     kSyncServerPort,
                     kUseSsl,
                     post_factory.Pass(),
                     workers,
                     extensions_activity_monitor,
                     &change_delegate,
                     credentials,
-                    scoped_ptr<Invalidator>(
-                        invalidator_factory.CreateInvalidator()),
-                    invalidator_factory.GetInvalidatorClientId(),
+                    invalidator_id,
                     kRestoredKeyForBootstrapping,
                     kRestoredKeystoreKeyForBootstrapping,
                     scoped_ptr<InternalComponentsFactory>(
                         new InternalComponentsFactoryImpl(factory_switches)),
                     &null_encryptor,
                     &unrecoverable_error_handler,
                     &LogUnrecoverableErrorContext);
   // TODO(akalin): Avoid passing in model parameters multiple times by
   // organizing handling of model types.
-  sync_manager->UpdateEnabledTypes(model_types);
+  invalidator->UpdateCredentials(credentials.email, credentials.sync_token);
+  invalidator->RegisterHandler(sync_manager.get());
+  invalidator->UpdateRegisteredIds(
+      sync_manager.get(), ModelTypeSetToObjectIdSet(model_types));
   sync_manager->StartSyncingNormally(routing_info);
 
   sync_loop.Run();
 
   io_thread.Stop();
   return 0;
 }
 
 }  // namespace
 }  // namespace syncer
 
 int main(int argc, char* argv[]) {
   return syncer::SyncClientMain(argc, argv);
 }