[Sync] Refactor ModelSafeWorker::DoWorkAndWaitUntilDone() to avoid code duplication.

components/sync/engine/model_safe_worker.h

 // Copyright 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 COMPONENTS_SYNC_ENGINE_MODEL_SAFE_WORKER_H_
 #define COMPONENTS_SYNC_ENGINE_MODEL_SAFE_WORKER_H_
 
 #include <map>
 #include <memory>
 #include <string>
 
-#include "base/callback_forward.h"
+#include "base/callback.h"
 #include "base/macros.h"
 #include "base/memory/ref_counted.h"
-#include "base/synchronization/atomic_flag.h"
+#include "base/synchronization/lock.h"
+#include "base/synchronization/waitable_event.h"
 #include "components/sync/base/model_type.h"
 #include "components/sync/base/syncer_error.h"
 
 namespace base {
 class DictionaryValue;
 }  // namespace base
 
 namespace syncer {
 
 using WorkCallback = base::Callback<enum SyncerError(void)>;
@@ skipping 21 matching lines @@
 // The Syncer uses a ModelSafeWorker for all tasks that could potentially
 // modify syncable entries (e.g under a WriteTransaction). The ModelSafeWorker
 // only knows how to do one thing, and that is take some work (in a fully
 // pre-bound callback) and have it performed (as in Run()) from a thread which
 // is guaranteed to be "model-safe", where "safe" refers to not allowing us to
 // cause an embedding application model to fall out of sync with the
 // syncable::Directory due to a race. Each ModelSafeWorker is affiliated with
 // a thread and does actual work on that thread.
 class ModelSafeWorker : public base::RefCountedThreadSafe<ModelSafeWorker> {
  public:
-  // If not stopped, call DoWorkAndWaitUntilDoneImpl() to do work. Otherwise
-  // return CANNOT_DO_WORK.
+  class ScopedSignalWorkDoneOrAbandoned;
+
+  // If not stopped, calls ScheduleWork() to schedule |work| and waits until it
+  // is done or abandoned. Otherwise, returns CANNOT_DO_WORK.
   SyncerError DoWorkAndWaitUntilDone(const WorkCallback& work);
 
   // Soft stop worker by setting stopped_ flag. Called when sync is disabled
   // or browser is shutting down. Called on UI loop.
   virtual void RequestStop();
 
-  // Return true if the worker was stopped. Thread safe.
-  bool IsStopped();
-
   virtual ModelSafeGroup GetModelSafeGroup() = 0;
 
   // Returns true if called on the thread this worker works on.
   virtual bool IsOnModelThread() = 0;
 
  protected:
   ModelSafeWorker();
   virtual ~ModelSafeWorker();
 
-  // Any time the Syncer performs model modifications (e.g employing a
-  // WriteTransaction), it should be done by this method to ensure it is done
-  // from a model-safe thread.
-  virtual SyncerError DoWorkAndWaitUntilDoneImpl(const WorkCallback& work) = 0;
-
  private:
   friend class base::RefCountedThreadSafe<ModelSafeWorker>;
 
-  // Whether the worker should do more work. Set when sync is disabled.
-  base::AtomicFlag stopped_;
+  // Schedules |work| on the appropriate thread.
+  virtual void ScheduleWork(base::Closure work) = 0;
+
+  void DoWork(
+      const WorkCallback& work,

[skym, 2017/04/06 00:34:54]

The const& is back!

[fdoray, 2017/04/06 18:10:55]

Done.

+      ScopedSignalWorkDoneOrAbandoned scoped_signal_work_done_or_abandoned,
+      SyncerError* error,
+      bool* did_run);
+
+  // Synchronizes access to all members.
+  base::Lock lock_;
+
+  // Signaled when DoWorkAndWaitUntilDone() can return, either because the work
+  // is done, the work has been abandoned or RequestStop() was called while no
+  // work was running. Reset at the beginning of DoWorkAndWaitUntilDone().
+  base::WaitableEvent work_done_or_abandoned_;
+
+  // Whether a WorkCallback is currently running.
+  bool is_work_running_ = false;
+
+  // Whether the worker was stopped. No WorkCallback can start running when this
+  // is true.
+  bool stopped_ = false;
 
   DISALLOW_COPY_AND_ASSIGN(ModelSafeWorker);
 };
 
 // A map that details which ModelSafeGroup each ModelType
 // belongs to.  Routing info can change in response to the user enabling /
 // disabling sync for certain types, as well as model association completions.
 using ModelSafeRoutingInfo = std::map<ModelType, ModelSafeGroup>;
 
 // Caller takes ownership of return value.
 std::unique_ptr<base::DictionaryValue> ModelSafeRoutingInfoToValue(
     const ModelSafeRoutingInfo& routing_info);
 
 std::string ModelSafeRoutingInfoToString(
     const ModelSafeRoutingInfo& routing_info);
 
 ModelTypeSet GetRoutingInfoTypes(const ModelSafeRoutingInfo& routing_info);
 
 ModelSafeGroup GetGroupForModelType(const ModelType type,
                                     const ModelSafeRoutingInfo& routes);
 
 }  // namespace syncer
 
 #endif  // COMPONENTS_SYNC_ENGINE_MODEL_SAFE_WORKER_H_