New architecture of the activity logging: Policies for summarization (and compression)

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/bind.h"
-#include "base/bind_helpers.h"
 #include "base/callback.h"
-#include "base/hash_tables.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_database.h"
+#include "chrome/browser/extensions/activity_log/activity_log_policy.h"
 #include "chrome/browser/extensions/tab_helper.h"
 #include "chrome/browser/profiles/profile.h"
 #include "components/browser_context_keyed_service/browser_context_dependency_manager.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 "content/public/browser/browser_thread.h"
 
 class Profile;
 using content::BrowserThread;
 
 namespace extensions {
 class Extension;
+class ActivityLogPolicy;
 
 // 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 ProfileKeyedService,
                     public TabHelper::ScriptExecutionObserver {
  public:
   enum Activity {
     ACTIVITY_EXTENSION_API_CALL,   // Extension API invocation is called.
     ACTIVITY_EXTENSION_API_BLOCK,  // Extension API invocation is blocked.
     ACTIVITY_CONTENT_SCRIPT,       // Content script is executing.
@@ skipping 44 matching lines @@
   void LogEventAction(const Extension* extension,
                       const std::string& name,    // e.g., tabs.onUpdate
                       ListValue* args,            // arguments to the callback
                       const std::string& extra);  // any extra logging info
 
   // Log a blocked API call made by an extension.
   // This will create a BlockedAction for storage in the database.
   void LogBlockedAction(const Extension* extension,
                         const std::string& blocked_call,  // e.g., tabs.get
                         ListValue* args,                  // argument values
-                        const BlockedAction::Reason reason,  // why it's blocked
+                        BlockedAction::Reason reason,     // why it's blocked
                         const std::string& extra);        // extra logging info
 
   // Log an interaction between an extension and a URL.
   // This will create a DOMAction for storage in the database.
   // The technical message might be the list of content scripts that have been
   // injected, or the DOM API call; it's what's shown under "More".
   void LogDOMAction(const Extension* extension,
                     const GURL& url,                      // target URL
                     const string16& url_title,            // title of the URL
                     const std::string& api_call,          // api call
@@ skipping 11 matching lines @@
   // Retrieves the list of actions for a given extension on a specific day.
   // Today is 0, yesterday is 1, etc. Returns one day at a time.
   // Response is sent to the method/function in the callback.
   // Use base::Bind to create the callback.
   void GetActions(const std::string& extension_id,
                   const int day,
                   const base::Callback
                       <void(scoped_ptr<std::vector<scoped_refptr<Action> > >)>&
                       callback);
 
-  // An error has happened; we want to rollback and close the db.
-  // Needs to be public so the error delegate can call it.
-  void KillActivityLogDatabase();
-
-  // For unit tests only.
-  void SetArgumentLoggingForTesting(bool log_arguments);
+  static void SetDefaultPolicy(ActivityLogPolicy::PolicyType policy_type) {

[felt, 2013/05/24 18:43:38]

Can you add a comment describing what this is used for?

[dbabic, 2013/05/28 21:11:49]

Done.

+    policy_type_ = policy_type;
+  }
 
  private:
   friend class ActivityLogFactory;
 
   explicit ActivityLog(Profile* profile);
   virtual ~ActivityLog();
 
   // We log callbacks and API calls very similarly, so we handle them the same
   // way internally.
   void LogAPIActionInternal(
@@ skipping 14 matching lines @@
                             DOMAction::DOMActionType verb);
 
   // TabHelper::ScriptExecutionObserver implementation.
   // Fires when a ContentScript is executed.
   virtual void OnScriptsExecuted(
       const content::WebContents* web_contents,
       const ExecutingScriptsMap& extension_ids,
       int32 page_id,
       const GURL& on_url) OVERRIDE;
 
-  // The callback when initializing the database.
-  void OnDBInitComplete();
-
   static const char* ActivityToString(Activity activity);
 
-  // The Schedule methods dispatch the calls to the database on a
-  // separate thread. We dispatch to the UI thread if the DB thread doesn't
-  // exist, which should only happen in tests where there is no DB thread.
-  template<typename DatabaseFunc>
-  void ScheduleAndForget(DatabaseFunc func) {
-    BrowserThread::PostTask(dispatch_thread_,
-                            FROM_HERE,
-                            base::Bind(func, base::Unretained(db_)));
-  }
-
-  template<typename DatabaseFunc, typename ArgA>
-  void ScheduleAndForget(DatabaseFunc func, ArgA a) {
-    BrowserThread::PostTask(dispatch_thread_,
-                            FROM_HERE,
-                            base::Bind(func, base::Unretained(db_), a));
-  }
-
-  template<typename DatabaseFunc, typename ArgA, typename ArgB>
-  void ScheduleAndForget(DatabaseFunc func, ArgA a, ArgB b) {
-    BrowserThread::PostTask(dispatch_thread_,
-                            FROM_HERE,
-                            base::Bind(func, base::Unretained(db_), a, b));
-  }
-
   typedef ObserverListThreadSafe<Observer> ObserverList;
   typedef std::map<const Extension*, scoped_refptr<ObserverList> >
       ObserverMap;
   // A map of extensions to activity observers for that extension.
   ObserverMap observers_;
 
-  // The database wrapper that does the actual database I/O.
-  // We initialize this on the same thread as the ActivityLog, but then
-  // subsequent operations occur on the DB thread. Instead of destructing the
-  // ActivityDatabase, we call its Close() method on the DB thread and it
-  // commits suicide.
-  extensions::ActivityDatabase* db_;
-
-  // Normally the DB thread. In some cases (tests), it might not exist
-  // we dispatch to the UI thread.
-  BrowserThread::ID dispatch_thread_;
+  // The policy object takes care of data summarization, compression, and
+  // logging
+  extensions::ActivityLogPolicy* policy_;
 
   // Whether to log activity to stdout or the UI. These are set by switches.
   bool log_activity_to_stdout_;
   bool log_activity_to_ui_;
 
-  // testing_mode_ controls whether to log API call arguments. By default, we
-  // don't log most arguments to avoid saving too much data. In testing mode,
-  // argument collection is enabled. We also whitelist some arguments for
-  // collection regardless of whether this bool is true.
-  bool testing_mode_;
-  base::hash_set<std::string> arg_whitelist_api_;
+  // TODO(dbabic,felt) change this into a list of policy types later.
+  static ActivityLogPolicy::PolicyType policy_type_;
 
   Profile* profile_;
 
   DISALLOW_COPY_AND_ASSIGN(ActivityLog);
 };
 
 // Each profile has different extensions, so we keep a different database for
 // each profile.
 class ActivityLogFactory : public ProfileKeyedServiceFactory {
  public:
@@ skipping 17 matching lines @@
   virtual content::BrowserContext* GetBrowserContextToUse(
       content::BrowserContext* context) const OVERRIDE;
 
   DISALLOW_COPY_AND_ASSIGN(ActivityLogFactory);
 };
 
 
 }  // namespace extensions
 
 #endif  // CHROME_BROWSER_EXTENSIONS_ACTIVITY_LOG_ACTIVITY_LOG_H_