[Media Router] 2nd take on fix route response callback lifetime in UI.

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/strings/string_util.h"
-#include "chrome/browser/media/router/create_session_request.h"
+#include "chrome/browser/media/router/create_presentation_session_request.h"
 #include "chrome/browser/media/router/issue.h"
 #include "chrome/browser/media/router/issues_observer.h"
 #include "chrome/browser/media/router/media_route.h"
 #include "chrome/browser/media/router/media_router.h"
 #include "chrome/browser/media/router/media_router_mojo_impl.h"
 #include "chrome/browser/media/router/media_router_mojo_impl_factory.h"
 #include "chrome/browser/media/router/media_routes_observer.h"
 #include "chrome/browser/media/router/media_sink.h"
 #include "chrome/browser/media/router/media_sinks_observer.h"
 #include "chrome/browser/media/router/media_source.h"
 #include "chrome/browser/media/router/media_source_helper.h"
 #include "chrome/browser/media/router/presentation_service_delegate_impl.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/sessions/session_tab_helper.h"
+#include "chrome/browser/ui/webui/media_router/media_router_dialog_controller.h"
 #include "chrome/browser/ui/webui/media_router/media_router_localized_strings_provider.h"
 #include "chrome/browser/ui/webui/media_router/media_router_resources_provider.h"
 #include "chrome/browser/ui/webui/media_router/media_router_webui_message_handler.h"
 #include "chrome/common/url_constants.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/browser/web_ui.h"
 #include "content/public/browser/web_ui_data_source.h"
 #include "ui/web_dialogs/web_dialog_delegate.h"
 
 namespace media_router {
 
 namespace {
 
+void HandleRouteResponseForPresentationApi(
+    scoped_ptr<CreatePresentationSessionRequest> presentation_request,
+    const MediaRoute* route,
+    const std::string& error) {
+  DCHECK(presentation_request);
+  if (!route) {
+    presentation_request->MaybeInvokeErrorCallback(
+        content::PresentationError(content::PRESENTATION_ERROR_UNKNOWN, error));
+  } else {
+    presentation_request->MaybeInvokeSuccessCallback(route->media_route_id());
+  }
+}
+
 std::string GetHostFromURL(const GURL& gurl) {
   if (gurl.is_empty())
     return std::string();
   std::string host = gurl.host();
   if (base::StartsWith(host, "www.", base::CompareCase::INSENSITIVE_ASCII))
     host = host.substr(4);
   return host;
 }
 
 }  // namespace
@@ skipping 66 matching lines @@
 
   // Ownership of |handler_| is transferred to |web_ui|.
   web_ui->AddMessageHandler(handler_);
 }
 
 MediaRouterUI::~MediaRouterUI() {
   if (query_result_manager_.get())
     query_result_manager_->RemoveObserver(this);
   if (presentation_service_delegate_.get())
     presentation_service_delegate_->RemoveDefaultMediaSourceObserver(this);
+  // If |presentation_request_| still exists, then it means presentation route
+  // request was never attempted.
+  if (presentation_request_) {
+    presentation_request_->MaybeInvokeErrorCallback(content::PresentationError(
+        content::PRESENTATION_ERROR_SESSION_REQUEST_CANCELLED,
+        "Dialog closed."));
+  }
 }
 
 void MediaRouterUI::InitWithDefaultMediaSource(
-    PresentationServiceDelegateImpl* delegate) {
+    const base::WeakPtr<PresentationServiceDelegateImpl>& delegate) {
   DCHECK(delegate);
   DCHECK(!presentation_service_delegate_);
   DCHECK(!query_result_manager_.get());
 
-  presentation_service_delegate_ = delegate->GetWeakPtr();
+  presentation_service_delegate_ = delegate;
   presentation_service_delegate_->AddDefaultMediaSourceObserver(this);
   InitCommon(presentation_service_delegate_->web_contents(),
              presentation_service_delegate_->default_source(),
              presentation_service_delegate_->default_frame_url());
 }
 
 void MediaRouterUI::InitWithPresentationSessionRequest(
-    const content::WebContents* initiator,
-    scoped_ptr<CreateSessionRequest> request) {
-  DCHECK(request.get());
-  DCHECK(!presentation_session_request_.get());
-  DCHECK(!query_result_manager_.get());
+    content::WebContents* initiator,
+    scoped_ptr<CreatePresentationSessionRequest> presentation_request) {
+  DCHECK(initiator);
+  DCHECK(presentation_request);
+  DCHECK(!presentation_request_);
+  DCHECK(!query_result_manager_);
 
-  presentation_session_request_ = request.Pass();
-  InitCommon(initiator, presentation_session_request_->GetMediaSource(),
-             presentation_session_request_->frame_url());
+  presentation_request_ = presentation_request.Pass();
+  InitCommon(initiator, presentation_request_->GetMediaSource(),
+             presentation_request_->frame_url());
 }
 
-void MediaRouterUI::InitCommon(const content::WebContents* initiator,
+void MediaRouterUI::InitCommon(content::WebContents* initiator,
                                const MediaSource& default_source,
                                const GURL& default_frame_url) {
   DCHECK(initiator);
 
   // Register for Issue and MediaRoute updates.
   issues_observer_.reset(new UIIssuesObserver(router_, this));
   routes_observer_.reset(new UIMediaRoutesObserver(router_, this));
 
   query_result_manager_.reset(new QueryResultManager(router_));
   query_result_manager_->AddObserver(this);
@@ skipping 13 matching lines @@
 void MediaRouterUI::OnDefaultMediaSourceChanged(const MediaSource& source,
                                                 const GURL& frame_url) {
   if (source.Empty()) {
     query_result_manager_->StopSinksQuery(MediaCastMode::DEFAULT);
   } else {
     query_result_manager_->StartSinksQuery(MediaCastMode::DEFAULT, source);
   }
   UpdateSourceHostAndCastModes(frame_url);
 }
 
-void MediaRouterUI::HandleRouteResponseForPresentation(
-    const MediaRoute* route,
-    const std::string& error) {
-  if (!route) {
-    presentation_session_request_->MaybeInvokeErrorCallback(
-        content::PresentationError(content::PRESENTATION_ERROR_UNKNOWN, error));
-  } else {
-    // TODO(imcheng): Presentation ID should come from the response
-    // as the IDs might not be the same.
-    presentation_session_request_->MaybeInvokeSuccessCallback(
-        route->media_route_id());
-  }
-}
-
 void MediaRouterUI::UpdateSourceHostAndCastModes(const GURL& frame_url) {
   DCHECK(query_result_manager_);
   frame_url_ = frame_url;
   query_result_manager_->GetSupportedCastModes(&cast_modes_);
   if (ui_initialized_)
     handler_->UpdateCastModes(cast_modes_, GetHostFromURL(frame_url_));
 }
 
 void MediaRouterUI::Close() {
-  if (presentation_session_request_.get()) {
-    presentation_session_request_->MaybeInvokeErrorCallback(
-        content::PresentationError(
-            content::PRESENTATION_ERROR_SESSION_REQUEST_CANCELLED,
-            "Dialog closed."));
-  }
-
   ConstrainedWebDialogDelegate* delegate = GetConstrainedDelegate();
   if (delegate) {
     delegate->GetWebDialogDelegate()->OnDialogClosed(std::string());
     delegate->OnDialogCloseFromWebUI();
   }
 }
 
 void MediaRouterUI::UIInitialized() {
   ui_initialized_ = true;
 }
@@ skipping 37 matching lines @@
   if (ui_initialized_)
     handler_->UpdateIssue(issue);
 }
 
 void MediaRouterUI::OnRoutesUpdated(const std::vector<MediaRoute>& routes) {
   routes_ = routes;
   if (ui_initialized_)
     handler_->UpdateRoutes(routes_);
 }
 
-void MediaRouterUI::OnRouteResponseReceived(scoped_ptr<MediaRoute> route,
+void MediaRouterUI::OnRouteResponseReceived(const MediaRoute* route,
                                             const std::string& error) {
   DVLOG(1) << "OnRouteResponseReceived";
   // TODO(imcheng): Display error in UI. (crbug.com/490372)
   if (!route)
     LOG(ERROR) << "MediaRouteResponse returned error: " << error;
   else
     handler_->AddRoute(*route);
 
-  if (requesting_route_for_default_source_) {
-    if (presentation_session_request_.get()) {
-      HandleRouteResponseForPresentation(route.get(), error);
-    } else {
-      // Dialog initiated via browser action. Let
-      // PresentationServiceDelegateImpl perform the match against the default
-      // presentation URL.
-      if (route && presentation_service_delegate_.get())
-        presentation_service_delegate_->OnRouteCreated(*route);
-    }
-  }
-
   has_pending_route_request_ = false;
   requesting_route_for_default_source_ = false;
 }
 
 bool MediaRouterUI::DoCreateRoute(const MediaSink::Id& sink_id,
                                   MediaCastMode cast_mode) {
   DCHECK(query_result_manager_.get());
   DCHECK(initiator_);
 
   // Note that there is a rarely-encountered bug, where the MediaCastMode to
@@ skipping 15 matching lines @@
   if (requesting_route_for_default_source_) {
     origin = frame_url_.GetOrigin();
   } else {
     // Requesting route for mirroring. Use a placeholder URL as origin.
     origin = GURL(chrome::kChromeUIMediaRouterURL);
   }
   DCHECK(origin.is_valid());
 
   DVLOG(1) << "DoCreateRoute: origin: " << origin;
 
+  // There are 3 cases. In all cases the MediaRouterUI will need to be notified.
+  // (1) Non-presentation route request (e.g., mirroring). No additional
+  // notification necessary.
+  // (2) Presentation route request for a Presentation API startSession call.
+  // The startSession (CreatePresentationSessionRequest) will need to be
+  // answered with the
+  // route response.
+  // (3) Browser-initiated presentation route request. If successful,
+  // PresentationServiceDelegateImpl will have to be notified.
+  std::vector<MediaRouteResponseCallback> route_response_callbacks;
+  route_response_callbacks.push_back(base::Bind(
+      &MediaRouterUI::OnRouteResponseReceived, weak_factory_.GetWeakPtr()));
+  if (requesting_route_for_default_source_) {
+    if (presentation_request_) {
+      // |presentation_request_| will be nullptr after this call, as the
+      // object will be transferred to the callback.
+      route_response_callbacks.push_back(
+          base::Bind(&HandleRouteResponseForPresentationApi,
+                     base::Passed(&presentation_request_)));
+    } else if (presentation_service_delegate_) {
+      route_response_callbacks.push_back(
+          base::Bind(&PresentationServiceDelegateImpl::OnRouteResponse,
+                     presentation_service_delegate_));
+    }
+  }
+
   router_->CreateRoute(source.id(), sink_id, origin,
                        SessionTabHelper::IdForTab(initiator_),
-                       base::Bind(&MediaRouterUI::OnRouteResponseReceived,
-                                  weak_factory_.GetWeakPtr()));
+                       route_response_callbacks);
   return true;
 }
 
 std::string MediaRouterUI::GetFrameURLHost() const {
   return GetHostFromURL(frame_url_);
 }
 
 }  // namespace media_router