[Media Router] Custom Controls 3 - add plumbing through MRUI and MRWebUIMessageHandler

chrome/browser/ui/webui/media_router/media_router_ui.h

Index: chrome/browser/ui/webui/media_router/media_router_ui.h
diff --git a/chrome/browser/ui/webui/media_router/media_router_ui.h b/chrome/browser/ui/webui/media_router/media_router_ui.h
index 2fb4a2c4fd65e0b547ed4290ce86f81b0f1676c6..90e05351f79a41accb0671a285d057465e03bf2c 100644
--- a/chrome/browser/ui/webui/media_router/media_router_ui.h
+++ b/chrome/browser/ui/webui/media_router/media_router_ui.h
@@ -14,6 +14,7 @@
 #include "base/macros.h"
 #include "base/memory/weak_ptr.h"
 #include "base/timer/timer.h"
+#include "chrome/browser/media/router/mojo/media_route_controller.h"
 #include "chrome/browser/media/router/presentation_service_delegate_impl.h"
 #include "chrome/browser/ui/webui/constrained_web_dialog_ui.h"
 #include "chrome/browser/ui/webui/media_router/media_cast_mode.h"
@@ -164,6 +165,22 @@ class MediaRouterUI : public ConstrainedWebDialogUI,
 
   void UpdateMaxDialogHeight(int height);
 
+  // Sends media commands to |route_controller_| if it is set. Marked virtual
+  // for tests.
+  virtual void PlayRoute();

[imcheng, 2017/04/22 00:22:51]

These are duplicated method signatures from MediaRouteController. Does the
implementation simply delegate to the actual MediaRouteController? Maybe this
class can expose a GetController() method that can be called from
MediaRouterWebUIMessageHandler.

[takumif, 2017/04/24 20:59:23]

I realized that we should sanitize the arguments for seek and set-volume here,
so leaving them here for now. We could also make the WebUIMessageHandler retain
the current MediaStatus and validate arguments, and call controller methods
directly. But at that point I feel like we could/should just have
WebUIMessageHandler (rather than MRUI) own an observer for the controller.

[imcheng, 2017/04/26 21:48:39]

I would have the MessageHandler parse/validate the arguments coming from WebUI
and then have it invoke the controller directly (obtained from MRUI). MRUI
already keeps track of various MediaRouter related objects so it's fine to put
the controller there.

[takumif, 2017/04/27 03:04:17]

Okay, making the MessageHandler call the controller methods.

+  virtual void PauseRoute();
+  virtual void SeekRoute(base::TimeDelta time);
+  virtual void SetRouteMute(bool mute);
+  virtual void SetRouteVolume(float volume);
+
+  // Gets a reference to the MediaRouteController for |route_id| and
+  // instantiates an observer for media status updates for the route. Marked
+  // virtual for tests.
+  virtual void OnUIDetailsViewOpened(MediaRoute::Id route_id);
+  // Resets |route_controller_| and |route_status_observer_|. Marked virtual for
+  // tests.
+  virtual void OnUIDetailsViewClosed();
+
   void InitForTest(MediaRouter* router,
                    content::WebContents* initiator,
                    MediaRouterWebUIMessageHandler* handler,
@@ -171,6 +188,8 @@ class MediaRouterUI : public ConstrainedWebDialogUI,
                        create_session_request);
 
  private:
+  friend class MediaRouterUITest;
+
   FRIEND_TEST_ALL_PREFIXES(MediaRouterUITest, SortedSinks);
   FRIEND_TEST_ALL_PREFIXES(MediaRouterUITest, SortSinksByIconType);
   FRIEND_TEST_ALL_PREFIXES(MediaRouterUITest, FilterNonDisplayRoutes);
@@ -187,6 +206,10 @@ class MediaRouterUI : public ConstrainedWebDialogUI,
   FRIEND_TEST_ALL_PREFIXES(MediaRouterUITest,
                            RouteCreationTimeoutForPresentation);
   FRIEND_TEST_ALL_PREFIXES(MediaRouterUITest, RouteRequestFromIncognito);
+  FRIEND_TEST_ALL_PREFIXES(MediaRouterUITest, OpenAndCloseUIDetailsView);
+  FRIEND_TEST_ALL_PREFIXES(MediaRouterUITest, SendMediaCommands);
+  FRIEND_TEST_ALL_PREFIXES(MediaRouterUITest, SendMediaStatusUpdate);
+  FRIEND_TEST_ALL_PREFIXES(MediaRouterUITest, IsValidRouteId);
 
   class UIIssuesObserver;
 
@@ -212,6 +235,23 @@ class MediaRouterUI : public ConstrainedWebDialogUI,
     DISALLOW_COPY_AND_ASSIGN(UIMediaRoutesObserver);
   };
 
+  class UIMediaRouteControllerObserver : public MediaRouteController::Observer {
+   public:
+    explicit UIMediaRouteControllerObserver(
+        MediaRouterUI* ui,
+        scoped_refptr<MediaRouteController> controller);
+    ~UIMediaRouteControllerObserver() override;
+
+    // MediaRouteController::Observer
+    void OnMediaStatusUpdated(const MediaStatus& status) override;
+    void OnControllerInvalidated() override;
+
+   private:
+    MediaRouterUI* ui_;
+
+    DISALLOW_COPY_AND_ASSIGN(UIMediaRouteControllerObserver);
+  };
+
   static std::string GetExtensionName(const GURL& url,
                                       extensions::ExtensionRegistry* registry);
 
@@ -291,6 +331,13 @@ class MediaRouterUI : public ConstrainedWebDialogUI,
   // opaque origin ("null") if |initiator_| is not set.
   std::string GetSerializedInitiatorOrigin() const;
 
+  // Returns true if |routes_| contains a route with |route_id|.
+  bool IsValidRouteId(const MediaRoute::Id& route_id) const;
+
+  // Destroys the route controller observer. Called when the route controller is
+  // invalidated.
+  void OnRouteControllerInvalidated();
+
   // Owned by the |web_ui| passed in the ctor, and guaranteed to be deleted
   // only after it has deleted |this|.
   MediaRouterWebUIMessageHandler* handler_ = nullptr;
@@ -348,6 +395,10 @@ class MediaRouterUI : public ConstrainedWebDialogUI,
   // been painted and initialized with initial data, this should be cleared.
   base::Time start_time_;
 
+  // The observer for the route controller. Notifies |handler_| of media status
+  // updates.
+  std::unique_ptr<UIMediaRouteControllerObserver> route_controller_observer_;
+
   // NOTE: Weak pointers must be invalidated before all other member variables.
   // Therefore |weak_factory_| must be placed at the end.
   base::WeakPtrFactory<MediaRouterUI> weak_factory_;