Refactor ArcSessionRunner part 2.

components/arc/arc_bridge_service.h

 // Copyright 2015 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_ARC_ARC_BRIDGE_SERVICE_H_
 #define COMPONENTS_ARC_ARC_BRIDGE_SERVICE_H_
 
-#include <iosfwd>
-#include <string>
-#include <vector>
+#include <memory>
 
 #include "base/macros.h"
 #include "base/observer_list.h"
-#include "components/arc/arc_session_observer.h"
 #include "components/arc/instance_holder.h"
 
 namespace base {
 class CommandLine;
 }  // namespace base
 
 namespace arc {
+
 namespace mojom {
 
 // Instead of including components/arc/common/arc_bridge.mojom.h, list all the
 // instance classes here for faster build.
 class AppInstance;
 class AudioInstance;
 class AuthInstance;
 class BluetoothInstance;
 class BootPhaseMonitorInstance;
 class ClipboardInstance;
@@ skipping 11 matching lines @@
 class PowerInstance;
 class PrintInstance;
 class ProcessInstance;
 class StorageManagerInstance;
 class TtsInstance;
 class VideoInstance;
 class WallpaperInstance;
 
 }  // namespace mojom
 
+class ArcSessionObserver;
+class ArcSessionRunner;
+
 // The Chrome-side service that handles ARC instances and ARC bridge creation.
 // This service handles the lifetime of ARC instances and sets up the
 // communication channel (the ARC bridge) used to send and receive messages.
 class ArcBridgeService {
  public:
   ArcBridgeService();
   virtual ~ArcBridgeService();
 
   // Return true if ARC has been enabled through a commandline
   // switch.
   static bool GetEnabled(const base::CommandLine* command_line);
 
   // Return true if ARC is available on the current board.
   static bool GetAvailable(const base::CommandLine* command_line);
 
-  // HandleStartup() should be called upon profile startup.  This will only
-  // launch an instance if the instance is enabled.
-  // This can only be called on the thread that this class was created on.
+  // Initializes the ArcSessionRunner with the given instance.
+  // This must be called before following proxy methods.
+  void InitializeArcSessionRunner(

[Luis Héctor Chávez, 2016/12/19 21:50:49]

Is there a reason why this is not passed in the constructor? You always call it
immediately after constructing ArcBridgeService and having an ArcBridgeService
without its ArcSessionRunner is kind of unusable.

If you still want to allow to pass in nullptr as the |arc_session_runner|, you
can keep the DCHECKs in the proxy methods.

[hidehiko, 2016/12/21 05:30:19]

Two reasons;
1) The real factory for ArcSessionRunner requires ArcBridgeService pointer. So,
this instance needs to be created before ArcSessionRunner creation. So, due to
the dependency, we cannot pass ArcSessionRunner pointer to the ArcBridgeService
ctor.
2) As you said, I'm refactoring this in a following CL. Because ArcBridgeService
is created in some unittests, we can avoid "to change the ctor once in this CL,
and to revert them in a following CL", which sounds a kind of noise to me.

+      std::unique_ptr<ArcSessionRunner> arc_session_runner);
 
-  // Starts the ARC service, then it will connect the Mojo channel. When the
-  // bridge becomes ready, OnBridgeReady() is called.
-  virtual void RequestStart();
-
-  // Stops the ARC service.
-  virtual void RequestStop();
-
-  // OnShutdown() should be called when the browser is shutting down. This can
-  // only be called on the thread that this class was created on. We assume that
-  // when this function is called, MessageLoop is no longer exists.
-  virtual void OnShutdown();
-
-  // Adds or removes observers. This can only be called on the thread that this
-  // class was created on. RemoveObserver does nothing if |observer| is not in
-  // the list.
+  // Proxies the method to ArcSessionRunner. See details in the
+  // ArcSessionRunner's comment.
+  // TODO(hidehiko): Move the ownership from ArcBridgeService to
+  // ArcSessionManager, and remove these methods.
   void AddObserver(ArcSessionObserver* observer);
   void RemoveObserver(ArcSessionObserver* observer);
+  void RequestStart();
+  void RequestStop();
+  void OnShutdown();
+  bool ready() const;

[hidehiko, 2016/12/19 09:21:10]

These methods will be gone in a following CL. So, let me keep those names
(ready() and stopped()) as is for now.

+  bool stopped() const;
 
   InstanceHolder<mojom::AppInstance>* app() { return &app_; }
   InstanceHolder<mojom::AudioInstance>* audio() { return &audio_; }
   InstanceHolder<mojom::AuthInstance>* auth() { return &auth_; }
   InstanceHolder<mojom::BluetoothInstance>* bluetooth() { return &bluetooth_; }
   InstanceHolder<mojom::BootPhaseMonitorInstance>* boot_phase_monitor() {
     return &boot_phase_monitor_;
   }
   InstanceHolder<mojom::ClipboardInstance>* clipboard() { return &clipboard_; }
   InstanceHolder<mojom::CrashCollectorInstance>* crash_collector() {
@@ skipping 22 matching lines @@
   InstanceHolder<mojom::PowerInstance>* power() { return &power_; }
   InstanceHolder<mojom::PrintInstance>* print() { return &print_; }
   InstanceHolder<mojom::ProcessInstance>* process() { return &process_; }
   InstanceHolder<mojom::StorageManagerInstance>* storage_manager() {
     return &storage_manager_;
   }
   InstanceHolder<mojom::TtsInstance>* tts() { return &tts_; }
   InstanceHolder<mojom::VideoInstance>* video() { return &video_; }
   InstanceHolder<mojom::WallpaperInstance>* wallpaper() { return &wallpaper_; }
 
-  // Gets if ARC is currently running.
-  bool ready() const { return state() == State::RUNNING; }
-
-  // Gets if ARC is currently stopped. This is not exactly !ready() since there
-  // are transient states between ready() and stopped().
-  bool stopped() const { return state() == State::STOPPED; }
-
- protected:
-  // TODO(hidehiko): Move ArcSessionRunner related part into ArcSessionRunner
-  // when we get rid of inheritance.
-  // The possible states of the bridge.  In the normal flow, the state changes
-  // in the following sequence:
-  //
-  // STOPPED
-  //   RequestStart() ->
-  // STARTING
-  //   OnSessionReady() ->
-  // READY
-  //
-  // The ArcSession state machine can be thought of being substates of
-  // ArcBridgeService's STARTING state.
-  // ArcBridgeService's state machine can be stopped at any phase.
-  //
-  // *
-  //   RequestStop() ->
-  // STOPPING
-  //   OnSessionStopped() ->
-  // STOPPED
-  enum class State {
-    // ARC instance is not currently running.
-    STOPPED,
-
-    // Request to start ARC instance is received. Starting an ARC instance.
-    STARTING,
-
-    // ARC instance has finished initializing, and is now ready for interaction
-    // with other services.
-    RUNNING,
-
-    // Request to stop ARC instance is recieved. Stopping the ARC instance.
-    STOPPING,
-  };
-
+ private:
   // Instance holders.
   InstanceHolder<mojom::AppInstance> app_;
   InstanceHolder<mojom::AudioInstance> audio_;
   InstanceHolder<mojom::AuthInstance> auth_;
   InstanceHolder<mojom::BluetoothInstance> bluetooth_;
   InstanceHolder<mojom::BootPhaseMonitorInstance> boot_phase_monitor_;
   InstanceHolder<mojom::ClipboardInstance> clipboard_;
   InstanceHolder<mojom::CrashCollectorInstance> crash_collector_;
   InstanceHolder<mojom::EnterpriseReportingInstance> enterprise_reporting_;
   InstanceHolder<mojom::FileSystemInstance> file_system_;
   InstanceHolder<mojom::ImeInstance> ime_;
   InstanceHolder<mojom::IntentHelperInstance> intent_helper_;
   InstanceHolder<mojom::KioskInstance> kiosk_;
   InstanceHolder<mojom::MetricsInstance> metrics_;
   InstanceHolder<mojom::NetInstance> net_;
   InstanceHolder<mojom::NotificationsInstance> notifications_;
   InstanceHolder<mojom::ObbMounterInstance> obb_mounter_;
   InstanceHolder<mojom::PolicyInstance> policy_;
   InstanceHolder<mojom::PowerInstance> power_;
   InstanceHolder<mojom::PrintInstance> print_;
   InstanceHolder<mojom::ProcessInstance> process_;
   InstanceHolder<mojom::StorageManagerInstance> storage_manager_;
   InstanceHolder<mojom::TtsInstance> tts_;
   InstanceHolder<mojom::VideoInstance> video_;
   InstanceHolder<mojom::WallpaperInstance> wallpaper_;
 
-  // Gets the current state of the bridge service.
-  State state() const { return state_; }
-
-  // Changes the current state and notifies all observers.
-  void SetState(State state);
-
-  // Sets the reason the bridge is stopped. This function must be always called
-  // before SetState(State::STOPPED) to report a correct reason with
-  // Observer::OnBridgeStopped().
-  void SetStopReason(ArcSessionObserver::StopReason stop_reason);
-
-  base::ObserverList<ArcSessionObserver>& observer_list() {
-    return observer_list_;
-  }
-
-  bool CalledOnValidThread();
-
- private:
-  base::ObserverList<ArcSessionObserver> observer_list_;
-
-  base::ThreadChecker thread_checker_;
-
-  // The current state of the bridge.
-  ArcBridgeService::State state_;
-
-  // The reason the bridge is stopped.
-  ArcSessionObserver::StopReason stop_reason_;
-
-  // WeakPtrFactory to use callbacks.
-  base::WeakPtrFactory<ArcBridgeService> weak_factory_;
+  std::unique_ptr<ArcSessionRunner> arc_session_runner_;
 
   DISALLOW_COPY_AND_ASSIGN(ArcBridgeService);
 };
 
 }  // namespace arc
 
 #endif  // COMPONENTS_ARC_ARC_BRIDGE_SERVICE_H_