Cleanup many APIs to use ProfileKeyedAPI.

chrome/browser/extensions/activity_log/activity_log.h

 // 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.
 
 #ifndef CHROME_BROWSER_EXTENSIONS_ACTIVITY_LOG_ACTIVITY_LOG_H_
 #define CHROME_BROWSER_EXTENSIONS_ACTIVITY_LOG_ACTIVITY_LOG_H_
 
 #include <map>
 #include <string>
 #include <vector>
 
 #include "base/callback.h"
-#include "base/memory/singleton.h"
 #include "base/observer_list_threadsafe.h"
 #include "base/synchronization/lock.h"
 #include "base/threading/thread.h"
 #include "chrome/browser/extensions/activity_log/activity_actions.h"
 #include "chrome/browser/extensions/activity_log/activity_log_policy.h"
+#include "chrome/browser/extensions/api/profile_keyed_api_factory.h"
 #include "chrome/browser/extensions/install_observer.h"
 #include "chrome/browser/extensions/tab_helper.h"
 #include "chrome/common/extensions/dom_action_types.h"
-#include "components/browser_context_keyed_service/browser_context_keyed_service.h"
-#include "components/browser_context_keyed_service/browser_context_keyed_service_factory.h"
 #include "extensions/browser/api_activity_monitor.h"
 
 class Profile;
 
 namespace content {
 class BrowserContext;
 }
 
 namespace user_prefs {
 class PrefRegistrySyncable;
 }
 
 namespace extensions {
 class Extension;
 class InstallTracker;
 
 // A utility for tracing interesting activity for each extension.
 // It writes to an ActivityDatabase on a separate thread to record the activity.
-class ActivityLog : public BrowserContextKeyedService,
+// Each profile has different extensions, so we keep a different database for
+// each profile.
+class ActivityLog : public ProfileKeyedAPI,
                     public ApiActivityMonitor,
                     public TabHelper::ScriptExecutionObserver,
                     public InstallObserver {
  public:
   // Observers can listen for activity events. There is probably only one
   // observer: the activityLogPrivate API.
   class Observer {
    public:
     virtual void OnExtensionActivity(scoped_refptr<Action> activity) = 0;
   };
 
-  // ActivityLog is a singleton, so don't instantiate it with the constructor;
-  // use GetInstance instead.
+  static ProfileKeyedAPIFactory<ActivityLog>* GetFactoryInstance();
+
+  // ActivityLog is a BrowserContextKeyedService, so don't instantiate it with
+  // the constructor; use GetInstance instead.
   static ActivityLog* GetInstance(content::BrowserContext* context);
 
   // Add/remove observer: the activityLogPrivate API only listens when the
   // ActivityLog extension is registered for an event.
   void AddObserver(Observer* observer);
   void RemoveObserver(Observer* observer);
 
   // Logs an extension action: passes it to any installed policy to be logged
   // to the database, to any observers, and logs to the console if in testing
   // mode.
@@ skipping 54 matching lines @@
   // If restrict_urls is empty then all URLs in the activity log database are
   // removed, otherwise only those in restrict_urls are removed.
   void RemoveURLs(const std::vector<GURL>& restrict_urls);
   void RemoveURLs(const std::set<GURL>& restrict_urls);
   void RemoveURL(const GURL& url);
 
   // Deletes the database associated with the policy that's currently in use.
   void DeleteDatabase();
 
  private:
-  friend class ActivityLogFactory;
   friend class ActivityLogTest;
+  friend class ProfileKeyedAPIFactory<ActivityLog>;
   friend class RenderViewActivityLogTest;
 
   explicit ActivityLog(Profile* profile);
   virtual ~ActivityLog();
 
   // Specifies if the Watchdog app is active (installed & enabled).
   // If so, we need to log to the database and stream to the API.
   bool IsWatchdogAppActive();
   // If we're in a browser test, we need to pretend that the watchdog app is
   // active.
@@ skipping 16 matching lines @@
       int32 page_id,
       const GURL& on_url) OVERRIDE;
 
   // At the moment, ActivityLog will use only one policy for summarization.
   // These methods are used to choose and set the most appropriate policy.
   // Changing policies at runtime is not recommended, and likely only should be
   // done for unit tests.
   void ChooseDatabasePolicy();
   void SetDatabasePolicy(ActivityLogPolicy::PolicyType policy_type);
 
+  // ProfileKeyedAPI implementation.
+  static const char* service_name() { return "ActivityLog"; }
+  static const bool kServiceRedirectedInIncognito = true;

[James Cook, 2014/02/27 00:37:34]

Not for this CL, but... The fact that these constants have different default
values than the defaults in BrowserContextKeyedServiceFactory is very confusing
for me.  I frequently have to look at both the BCKS header and the
ProfileKeyedAPI header to figure out what is actually going on for a class.

At the very least, some comments in ProfileKeyedAPI about which defaults are
being overridden might help.

[Yoyo Zhou, 2014/02/27 01:05:21]

Only one is different in ProfileKeyedAPI, but it's worth clarifying. It doesn't
help that BrowserContextKeyedBaseFactory was refactored so that e.g.
ServiceRedirectedInIncognito was replaced by GetBrowserContextToUse.

+  static const bool kServiceIsCreatedWithBrowserContext = false;
+
   typedef ObserverListThreadSafe<Observer> ObserverList;
   scoped_refptr<ObserverList> observers_;
 
   // Policy objects are owned by the ActivityLog, but cannot be scoped_ptrs
   // since they may need to do some cleanup work on the database thread.
   // Calling policy->Close() will free the object; see the comments on the
   // ActivityDatabase class for full details.
 
   // The database policy object takes care of recording & looking up data:
   // data summarization, compression, and logging. There should only be a
@@ skipping 30 matching lines @@
 
   FRIEND_TEST_ALL_PREFIXES(ActivityLogApiTest, TriggerEvent);
   FRIEND_TEST_ALL_PREFIXES(ActivityLogEnabledTest, AppAndCommandLine);
   FRIEND_TEST_ALL_PREFIXES(ActivityLogEnabledTest, CommandLineSwitch);
   FRIEND_TEST_ALL_PREFIXES(ActivityLogEnabledTest, NoSwitch);
   FRIEND_TEST_ALL_PREFIXES(ActivityLogEnabledTest, PrefSwitch);
   FRIEND_TEST_ALL_PREFIXES(ActivityLogEnabledTest, WatchdogSwitch);
   DISALLOW_COPY_AND_ASSIGN(ActivityLog);
 };
 
-// Each profile has different extensions, so we keep a different database for
-// each profile.
-class ActivityLogFactory : public BrowserContextKeyedServiceFactory {
- public:
-  static ActivityLog* GetForBrowserContext(content::BrowserContext* context) {
-    return static_cast<ActivityLog*>(
-        GetInstance()->GetServiceForBrowserContext(context, true));
-  }
-
-  static ActivityLogFactory* GetInstance();
-
- private:
-  friend struct DefaultSingletonTraits<ActivityLogFactory>;
-  ActivityLogFactory();
-  virtual ~ActivityLogFactory();
-
-  virtual BrowserContextKeyedService* BuildServiceInstanceFor(
-      content::BrowserContext* profile) const OVERRIDE;
-
-  virtual content::BrowserContext* GetBrowserContextToUse(
-      content::BrowserContext* context) const OVERRIDE;
-
-  DISALLOW_COPY_AND_ASSIGN(ActivityLogFactory);
-};
-
+template <>
+void ProfileKeyedAPIFactory<ActivityLog>::DeclareFactoryDependencies();
 
 }  // namespace extensions
 
 #endif  // CHROME_BROWSER_EXTENSIONS_ACTIVITY_LOG_ACTIVITY_LOG_H_