Non-Local Join for Media Router and Presentation API

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

 // 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.
 
 #include "chrome/browser/ui/webui/media_router/media_router_ui.h"
 
 #include <string>
 
 #include "base/guid.h"
 #include "base/strings/string_util.h"
@@ skipping 80 matching lines @@
   void OnIssueUpdated(const Issue* issue) override { ui_->SetIssue(issue); }
 
  private:
   // Reference back to the owning MediaRouterUI instance.
   MediaRouterUI* ui_;
 
   DISALLOW_COPY_AND_ASSIGN(UIIssuesObserver);
 };
 
 MediaRouterUI::UIMediaRoutesObserver::UIMediaRoutesObserver(
-    MediaRouter* router, const RoutesUpdatedCallback& callback)
-    : MediaRoutesObserver(router), callback_(callback) {
+    MediaRouter* router, const MediaSource::Id& source_id,
+    const RoutesUpdatedCallback& callback)
+    : MediaRoutesObserver(router, source_id), callback_(callback) {
   DCHECK(!callback_.is_null());
 }
 
 MediaRouterUI::UIMediaRoutesObserver::~UIMediaRoutesObserver() {}
 
 void MediaRouterUI::UIMediaRoutesObserver::OnRoutesUpdated(
-    const std::vector<MediaRoute>& routes) {
+    const std::vector<MediaRoute>& routes,
+    const std::vector<MediaRoute::Id>& joinable_route_ids) {
   std::vector<MediaRoute> routes_for_display;
+  std::vector<MediaRoute::Id> joinable_route_ids_for_display;
   for (const MediaRoute& route : routes) {
     if (route.for_display()) {
 #ifndef NDEBUG
       for (const MediaRoute& existing_route : routes_for_display) {
         if (existing_route.media_sink_id() == route.media_sink_id()) {
           DVLOG(2) << "Received another route for display with the same sink"
                    << " id as an existing route. " << route.media_route_id()
                    << " has the same sink id as "
                    << existing_route.media_sink_id() << ".";
         }
       }
 #endif
+      if (std::find(joinable_route_ids.begin(),

[mark a. foltz, 2015/12/09 00:48:17]

Shorter as ContainsValue from base/stl_util.h

[matt.boetger, 2015/12/15 19:21:20]

Done.

+          joinable_route_ids.end(), route.media_route_id()) !=
+          joinable_route_ids.end()) {
+        joinable_route_ids_for_display.push_back(route.media_route_id());
+      }
+
       routes_for_display.push_back(route);
     }
   }
 
-  callback_.Run(routes_for_display);
+  callback_.Run(routes_for_display, joinable_route_ids_for_display);
 }
 
 MediaRouterUI::MediaRouterUI(content::WebUI* web_ui)
     : ConstrainedWebDialogUI(web_ui),
       handler_(new MediaRouterWebUIMessageHandler(this)),
       ui_initialized_(false),
       requesting_route_for_default_source_(false),
       current_route_request_id_(-1),
       route_request_counter_(0),
       initiator_(nullptr),
@@ skipping 70 matching lines @@
   InitCommon(initiator);
   OnDefaultPresentationChanged(create_session_request_->presentation_request());
 }
 
 void MediaRouterUI::InitCommon(content::WebContents* initiator) {
   DCHECK(initiator);
   DCHECK(router_);
 
   TRACE_EVENT_NESTABLE_ASYNC_INSTANT1("media_router", "UI", initiator,
                                       "MediaRouterUI::InitCommon", this);
-  // Register for MediaRoute updates.
-  routes_observer_.reset(new UIMediaRoutesObserver(
-      router_,
-      base::Bind(&MediaRouterUI::OnRoutesUpdated, base::Unretained(this))));
-
   query_result_manager_.reset(new QueryResultManager(router_));
   query_result_manager_->AddObserver(this);
 
   // These modes are always available.
   query_result_manager_->StartSinksQuery(MediaCastMode::DESKTOP_MIRROR,
                                          MediaSourceForDesktop());
   initiator_ = initiator;
   MediaSource mirroring_source(
       MediaSourceForTab(SessionTabHelper::IdForTab(initiator)));
   query_result_manager_->StartSinksQuery(MediaCastMode::TAB_MIRROR,
                                          mirroring_source);
   UpdateCastModes();
 }
 
 void MediaRouterUI::OnDefaultPresentationChanged(
     const PresentationRequest& presentation_request) {
+  MediaSource source = presentation_request.GetMediaSource();
   presentation_request_.reset(new PresentationRequest(presentation_request));
-  query_result_manager_->StartSinksQuery(
-      MediaCastMode::DEFAULT, presentation_request_->GetMediaSource());
+  query_result_manager_->StartSinksQuery(MediaCastMode::DEFAULT, source);
+  // Register for MediaRoute updates.
+  routes_observer_.reset(new UIMediaRoutesObserver(

[mark a. foltz, 2015/12/09 00:48:17]

I assume the UIMediaRoutesObserver dtor handles de-registration of itself.

[matt.boetger, 2015/12/15 19:21:20]

Yes, all route observers handle de-registration of itself via the
MediaRoutesObserver destructor.

+      router_, source.id(),
+      base::Bind(&MediaRouterUI::OnRoutesUpdated, base::Unretained(this))));
+
   UpdateCastModes();
 }
 
 void MediaRouterUI::OnDefaultPresentationRemoved() {
   presentation_request_.reset();
   query_result_manager_->StopSinksQuery(MediaCastMode::DEFAULT);
+  routes_observer_.reset();
   UpdateCastModes();
 }
 
 void MediaRouterUI::UpdateCastModes() {
   // Gets updated cast modes from |query_result_manager_| and forwards it to UI.
   query_result_manager_->GetSupportedCastModes(&cast_modes_);
   if (ui_initialized_) {
     handler_->UpdateCastModes(cast_modes_, GetPresentationRequestSourceName());
   }
 }
@@ skipping 84 matching lines @@
   // Start the timer.
   route_creation_timer_.Start(
       FROM_HERE, base::TimeDelta::FromSeconds(kCreateRouteTimeoutSeconds), this,
       &MediaRouterUI::RouteCreationTimeout);
 
   router_->CreateRoute(source.id(), sink_id, origin, initiator_,
                        route_response_callbacks);
   return true;
 }
 
+bool MediaRouterUI::JoinRoute(const MediaSink::Id& sink_id,

[mark a. foltz, 2015/12/09 00:48:17]

I would like to name this ConnectRemoteRoute to make this clear this is a
different code path from reconnecting to a presentation via the presentation
API; i.e., PresentationRequest.connect(id).  That has nothing to do with the UI

[matt.boetger, 2015/12/15 19:21:20]

Done.

+                              const MediaRoute::Id& route_id) {
+  DCHECK(query_result_manager_.get());
+  DCHECK(initiator_);
+
+  current_route_request_id_ = ++route_request_counter_;
+  GURL origin = presentation_request_->frame_url().GetOrigin();
+  DCHECK(origin.is_valid());
+
+  MediaSource source =

[mark a. foltz, 2015/12/09 00:48:17]

Don't you need to check presentation_request_ as well?

It seems like you should refactor to share code between CreateRoute() and
ConnectRemoteRoute(), it looks like the main difference is what request is made
to router_.

[matt.boetger, 2015/12/15 19:21:20]

Done.

+      query_result_manager_->GetSourceForCastMode(MediaCastMode::DEFAULT);
+
+  if (source.Empty()) {
+    LOG(ERROR) << "No MediaSource to join";
+    return false;
+  }
+
+  std::vector<MediaRouteResponseCallback> route_response_callbacks;
+  route_response_callbacks.push_back(base::Bind(
+      &MediaRouterUI::OnRouteResponseReceived, weak_factory_.GetWeakPtr(),
+      current_route_request_id_, sink_id));
+
+  if (presentation_service_delegate_) {
+    route_response_callbacks.push_back(
+        base::Bind(&PresentationServiceDelegateImpl::OnRouteResponse,
+                   presentation_service_delegate_, *presentation_request_));
+  }
+
+  // Start the timer.
+  route_creation_timer_.Start(
+      FROM_HERE, base::TimeDelta::FromSeconds(kCreateRouteTimeoutSeconds), this,
+      &MediaRouterUI::RouteCreationTimeout);
+  router_->JoinRouteByRouteId(source.id(), route_id, origin,
+                     initiator_, route_response_callbacks);
+  return true;
+}
+
 void MediaRouterUI::CloseRoute(const MediaRoute::Id& route_id) {
   router_->CloseRoute(route_id);
 }
 
 void MediaRouterUI::AddIssue(const Issue& issue) { router_->AddIssue(issue); }
 
 void MediaRouterUI::ClearIssue(const std::string& issue_id) {
   router_->ClearIssue(issue_id);
 }
 
 void MediaRouterUI::OnResultsUpdated(
     const std::vector<MediaSinkWithCastModes>& sinks) {
   sinks_ = sinks;
   if (ui_initialized_) handler_->UpdateSinks(sinks_);
 }
 
 void MediaRouterUI::SetIssue(const Issue* issue) {
   if (ui_initialized_) handler_->UpdateIssue(issue);
 }
 
-void MediaRouterUI::OnRoutesUpdated(const std::vector<MediaRoute>& routes) {
+void MediaRouterUI::OnRoutesUpdated(
+    const std::vector<MediaRoute>& routes,
+    const std::vector<MediaRoute::Id>& joinable_route_ids) {
   routes_ = routes;
-  if (ui_initialized_) handler_->UpdateRoutes(routes_);
+  joinable_route_ids_ = joinable_route_ids;
+  if (ui_initialized_) handler_->UpdateRoutes(routes_, joinable_route_ids_);
 }
 
 void MediaRouterUI::OnRouteResponseReceived(const int route_request_id,
                                             const MediaSink::Id& sink_id,
                                             const MediaRoute* route,
                                             const std::string& presentation_id,
                                             const std::string& error) {
   DVLOG(1) << "OnRouteResponseReceived";
   // If we receive a new route that we aren't expecting, do nothing.
   if (route_request_id != current_route_request_id_) return;
@@ skipping 50 matching lines @@
              ? GetExtensionName(gurl, extensions::ExtensionRegistry::Get(
                                           Profile::FromWebUI(web_ui())))
              : TruncateHost(GetHostFromURL(gurl));
 }
 
 const std::string& MediaRouterUI::GetRouteProviderExtensionId() const {
   return router_->media_route_provider_extension_id();
 }
 
 }  // namespace media_router