[SystemInfo API] Finish TODOs in SystemInfoProvider

chrome/browser/extensions/api/system_info/system_info_provider.h

 // Copyright 2013 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_API_SYSTEM_INFO_SYSTEM_INFO_PROVIDER_H_
 #define CHROME_BROWSER_EXTENSIONS_API_SYSTEM_INFO_SYSTEM_INFO_PROVIDER_H_
 
 #include <queue>
 
 #include "base/bind.h"
 #include "base/callback.h"
@@ skipping 22 matching lines @@
 // The class member |info_| is accessed on multiple threads, but that the whole
 // class is being guarded by SystemInfoProvider.
 //
 // |info_| is accessed on the UI thread while |is_waiting_for_completion_| is
 // false and on the BlockingPool under |worker_pool_token_| while
 // |is_waiting_for_completion_| is true.
 template<class T>
 class SystemInfoProvider
     : public base::RefCountedThreadSafe<SystemInfoProvider<T> > {
  public:
   // Callback type for completing to get information. The callback accepts

[Greg Billock, 2013/07/08 18:05:06]

Comment is now stale.

[Haojian Wu, 2013/07/09 13:45:04]

Done.

   // two arguments. The first one is the information got already, the second
   // one indicates whether its contents are valid, for example, no error
   // occurs in querying the information.
-  typedef base::Callback<void(const T&, bool)> QueryInfoCompletionCallback;
+  typedef base::Callback<void(bool)> QueryInfoCompletionCallback;
   typedef std::queue<QueryInfoCompletionCallback> CallbackQueue;
 
   SystemInfoProvider()
-    : is_waiting_for_completion_(false) {
-    worker_pool_token_ =
-      content::BrowserThread::GetBlockingPool()->GetSequenceToken();
-  }
+    : is_waiting_for_completion_(false) {}
 
   virtual ~SystemInfoProvider() {}
 
   // For testing
   static void InitializeForTesting(
       scoped_refptr<SystemInfoProvider<T> > provider) {
     DCHECK(provider.get() != NULL);
     single_shared_provider_.Get() = provider;
   }
 
   // Start to query the system information. Should be called on UI thread.
   // The |callback| will get called once the query is completed.
   void StartQueryInfo(const QueryInfoCompletionCallback& callback) {
     DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
     DCHECK(!callback.is_null());
 
     callbacks_.push(callback);
 
     if (is_waiting_for_completion_)
       return;
 
     is_waiting_for_completion_ = true;
 
     StartQueryInfoImpl();
   }
 
  protected:
-  // Default implementation of querying system information.
-  //
-  // While overriding, there are two things need to do:
-  //   1). Bind custom callback function for query system information.
-  //   2). Post the custom task to blocking pool.
+  // We can override this method with our own custom query info Callback

[Greg Billock, 2013/07/08 18:05:06]

I think you can just get rid of this comment.

[Jeffrey Yasskin, 2013/07/08 19:09:49]

If this function stays virtual, it does need a comment saying what guarantees an
overriding implementation has to provide. I agree that this comment isn't enough
to know how to override the function.

[Haojian Wu, 2013/07/09 13:45:04]

Done. Update the comments.

+  // function which type is bool().
   virtual void StartQueryInfoImpl() {
-    base::Closure callback =
-        base::Bind(&SystemInfoProvider<T>::QueryOnWorkerPool, this);
-    PostQueryTaskToBlockingPool(FROM_HERE, callback);
+    base::Callback<bool()> query_info_callback =

[Greg Billock, 2013/07/08 18:05:06]

You can put this in the PostQueryTaskToBlockingPool call directly and avoid the
temporary.

[Haojian Wu, 2013/07/09 13:45:04]

Done.

+        base::Bind(&SystemInfoProvider<T>::QueryInfo, this);
+    PostQueryTaskToBlockingPool(query_info_callback);
   }
 
-  // Post a task to blocking pool for information querying.
-  //
-  // The parameter query_callback should invoke QueryInfo directly or indirectly
-  // to query the system information and return to UI thread when the query is
-  // completed.
-  void PostQueryTaskToBlockingPool(const tracked_objects::Location& from_here,
-                                   const base::Closure& query_callback) {
-    DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
-    base::SequencedWorkerPool* worker_pool =
-        content::BrowserThread::GetBlockingPool();
-    // The query task posted to the worker pool won't block shutdown, and any
-    // running query task at shutdown time will be ignored.
-    worker_pool->PostSequencedWorkerTaskWithShutdownBehavior(
-          worker_pool_token_, from_here, query_callback,
-          base::SequencedWorkerPool::CONTINUE_ON_SHUTDOWN);
+  // Post the query info task to blocking pool.

[Greg Billock, 2013/07/08 18:05:06]

Your method name says this. Delete comment or replace with one indicating that
OnQueryCompleted will be the next thing we see called.

[Haojian Wu, 2013/07/09 13:45:04]

Done.

+  void PostQueryTaskToBlockingPool(
+      const base::Callback<bool()> & query_info_callback) {
+    base::SequencedWorkerPool* pool = content::BrowserThread::GetBlockingPool();
+    scoped_refptr<base::SequencedTaskRunner> blocking_task_runner_ =
+        pool->GetSequencedTaskRunnerWithShutdownBehavior(
+            pool->GetSequenceToken(),

[Jeffrey Yasskin, 2013/07/08 19:09:49]

Although this is one reading of what I suggested, it's not the reading that
preserves the sequencing behavior in your original code. Can you read the
documentation
(https://code.google.com/p/chromium/codesearch/#chromium/src/base/threading/se...
and
https://code.google.com/p/chromium/codesearch/#chromium/src/base/threading/se...)
and modify this so it does guarantee that all tasks are executed in sequence?

[Haojian Wu, 2013/07/09 13:45:04]

Done.

+            base::SequencedWorkerPool::CONTINUE_ON_SHUTDOWN);
+    // Post the custom query info task to blocking pool for information querying
+    // and reply with OnQueryCompleted.
+    base::PostTaskAndReplyWithResult(
+        blocking_task_runner_,
+        FROM_HERE,
+        query_info_callback,
+        base::Bind(&SystemInfoProvider<T>::OnQueryCompleted, this));
   }
 
-  // Query the system information synchronously and output the result to the
-  // |info| parameter. The |info| contents MUST be reset firstly in its
-  // platform specific implementation. Return true if it succeeds, otherwise
-  // false is returned.
-  // TODO(Haojian): Remove the parameter T-typed pointer, replacing with void
-  // QueryInfo().
-  virtual bool QueryInfo(T* info) = 0;
-
-  // Called on UI thread. The |success| parameter means whether it succeeds
-  // to get the information.
-  void OnQueryCompleted(bool success) {
-    DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
-
-    while (!callbacks_.empty()) {
-      QueryInfoCompletionCallback callback = callbacks_.front();
-      callback.Run(info_, success);
-      callbacks_.pop();
-    }
-
-    is_waiting_for_completion_ = false;
-  }
+  // Query the system information synchronously and put the result into |info_|.
+  // Return true if no error occurs.
+  virtual bool QueryInfo() = 0;
 
   // Template function for creating the single shared provider instance.
   // Template paramter I is the type of SystemInfoProvider implementation.
   template<class I>
   static I* GetInstance() {
     if (!single_shared_provider_.Get().get())
       single_shared_provider_.Get() = new I();
     return static_cast<I*>(single_shared_provider_.Get().get());
   }
 
   // The latest information filled up by QueryInfo implementation. Here we
   // assume the T is disallowed to copy constructor, aligns with the structure
   // type generated by IDL parser.
   T info_;

[Greg Billock, 2013/07/08 18:05:06]

This change is most of the way to de-templating the design. |info_| is basically
no longer used here, and there are direct accessors on subclasses. Lets get this
in and hold off on separating out the templating stuff. I think we'll be able to
nicely use subclasses after this.

[Haojian Wu, 2013/07/09 13:45:04]

Yes, I think so. I will separate a new CL to do it after this patch gets landed
since it also requires a big change of SystemInfo API.

 
  private:
-  // TODO(Haojian): Use PostBlockingPoolTaskAndReply to avoid unnecessary
-  // trampolines trip.
-  void QueryOnWorkerPool() {
-    bool success = QueryInfo(&info_);
-    content::BrowserThread::PostTask(content::BrowserThread::UI, FROM_HERE,
-        base::Bind(&SystemInfoProvider<T>::OnQueryCompleted, this, success));
+  // Called on UI thread. The |success| parameter means whether it succeeds
+  // to get the information.
+  void OnQueryCompleted(bool success) {
+    DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
+
+    while (!callbacks_.empty()) {
+      QueryInfoCompletionCallback callback = callbacks_.front();
+      callback.Run(success);
+      callbacks_.pop();
+    }
+
+    is_waiting_for_completion_ = false;

[Jeffrey Yasskin, 2013/07/08 19:09:49]

This is a bit subtle. Could you add a comment to StartQueryInfo(callback) saying
that if the callback itself calls StartQueryInfo(callback2), callback2 will be
called immediately rather than triggering another call to the system?

[Haojian Wu, 2013/07/09 13:45:04]

Done.

   }
 
   // The single shared provider instance. We create it only when needed.
   static typename base::LazyInstance<

[Jeffrey Yasskin, 2013/07/08 19:09:49]

You can't use static members of templates because Windows creates a separate
instance for each DLL the header appears in. You'll need each subclass to define
this in its .cc file.

[Haojian Wu, 2013/07/09 13:45:04]

Done.

       scoped_refptr<SystemInfoProvider<T> > > single_shared_provider_;
 
   // The queue of callbacks waiting for the info querying completion. It is
   // maintained on the UI thread.
   CallbackQueue callbacks_;
 
   // Indicates if it is waiting for the querying completion.
   bool is_waiting_for_completion_;
 
-  // Unqiue sequence token so that the operation of querying inforation can
-  // be executed in order.
-  base::SequencedWorkerPool::SequenceToken worker_pool_token_;
-
   DISALLOW_COPY_AND_ASSIGN(SystemInfoProvider<T>);
 };
 
 // Static member intialization.
 template<class T>
 typename base::LazyInstance<scoped_refptr<SystemInfoProvider<T> > >
   SystemInfoProvider<T>::single_shared_provider_ = LAZY_INSTANCE_INITIALIZER;

[Greg Billock, 2013/07/08 18:05:06]

This name makes it sound like there's only one provider, but really there's one
for each type. And its a LazyInstance already, and they have public GetInstance
methods, so how about just calling it "provider_".

[Haojian Wu, 2013/07/09 13:45:04]

Done.

 
 }  // namespace extensions
 
 #endif  // CHROME_BROWSER_EXTENSIONS_API_SYSTEM_INFO_SYSTEM_INFO_PROVIDER_H_