[Autoplay] Expose was activated to embedders

Adds a WasActivatedOption to allow embedders to override the
`was_activated` logic for browser initiated navigations.

This is for when a user activation occurs on a surface outside
of the page and we want this to be passed to a navigation as if
this had occured on a previous page.

BUG=884777

Change-Id: Ifc7ce9352c3736d9e5c5c7d6909b3c5b2ead0cd8
Reviewed-on: https://chromium-review.googlesource.com/1228502Reviewed-by: Camille Lamy <clamy@chromium.org>
Reviewed-by: Greg Kerr <kerrnel@chromium.org>
Reviewed-by: Peter Kasting <pkasting@chromium.org>
Commit-Queue: Becca Hughes <beccahughes@chromium.org>
Cr-Commit-Position: refs/heads/master@{#593614}

chrome/browser/media/unified_autoplay_browsertest.cc

@@ -234,6 +234,25 @@ IN_PROC_BROWSER_TEST_F(UnifiedAutoplayBrowserTest,
   EXPECT_TRUE(AttemptPlay(GetWebContents()));
 }
 
+IN_PROC_BROWSER_TEST_F(UnifiedAutoplayBrowserTest, ForceWasActivated_Default) {
+  const GURL kTestPageUrl = embedded_test_server()->GetURL(kTestPagePath);
+
+  NavigateParams params(browser(), kTestPageUrl, ui::PAGE_TRANSITION_LINK);
+  ui_test_utils::NavigateToURL(&params);
+
+  EXPECT_FALSE(AttemptPlay(GetWebContents()));
+}
+
+IN_PROC_BROWSER_TEST_F(UnifiedAutoplayBrowserTest, ForceWasActivated_Yes) {
+  const GURL kTestPageUrl = embedded_test_server()->GetURL(kTestPagePath);
+
+  NavigateParams params(browser(), kTestPageUrl, ui::PAGE_TRANSITION_LINK);
+  params.was_activated = content::WasActivatedOption::kYes;
+  ui_test_utils::NavigateToURL(&params);
+
+  EXPECT_TRUE(AttemptPlay(GetWebContents()));
+}
+
 // Integration tests for the new unified autoplay sound settings UI.
 
 class UnifiedAutoplaySettingBrowserTest : public UnifiedAutoplayBrowserTest {

chrome/browser/ui/browser_navigator.cc

@@ -326,6 +326,7 @@ void LoadURLInContents(WebContents* target_contents,
   load_url_params.has_user_gesture = params->user_gesture;
   load_url_params.blob_url_loader_factory = params->blob_url_loader_factory;
   load_url_params.input_start = params->input_start;
+  load_url_params.was_activated = params->was_activated;
 
   // |frame_tree_node_id| is kNoFrameTreeNodeId for main frame navigations.
   if (params->frame_tree_node_id ==

chrome/browser/ui/browser_navigator_params.h

@@ -15,6 +15,7 @@
 #include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/site_instance.h"
 #include "content/public/common/referrer.h"
+#include "content/public/common/was_activated_option.h"
 #include "services/network/public/cpp/resource_request_body.h"
 #include "services/network/public/cpp/shared_url_loader_factory.h"
 #include "ui/base/page_transition_types.h"
@@ -258,6 +259,14 @@ struct NavigateParams {
   // desktop omnibox.
   base::TimeTicks input_start;
 
+  // Indicates that the new page should have a propagated user activation.
+  // This should be used when we want to pass an activation that occurred
+  // outside of the page and pass it to the page as if it happened on a prior
+  // page. For example, if the assistant opens a page we should treat the
+  // user's interaction with the assistant as a previous user activation.
+  content::WasActivatedOption was_activated =
+      content::WasActivatedOption::kUnknown;
+
  private:
   NavigateParams();
   DISALLOW_COPY_AND_ASSIGN(NavigateParams);

content/browser/frame_host/navigation_controller_impl.cc

@@ -1849,7 +1849,7 @@ bool NavigationControllerImpl::StartHistoryNavigationInNewSubframe(
       render_frame_host->frame_tree_node(), *entry, frame_entry,
       ReloadType::NONE, false /* is_same_document_history_load */,
       true /* is_history_navigation_in_new_child */, nullptr, nullptr,
-      base::TimeTicks() /* input_start */);
+      base::TimeTicks() /* input_start */, WasActivatedOption::kUnknown);
 
   if (!request)
     return false;
@@ -1940,7 +1940,7 @@ void NavigationControllerImpl::NavigateFromFrameProxy(
       render_frame_host->frame_tree_node(), *entry, frame_entry.get(),
       ReloadType::NONE, false /* is_same_document_history_load */,
       false /* is_history_navigation_in_new_child */, post_body, nullptr,
-      base::TimeTicks() /* input_start */);
+      base::TimeTicks() /* input_start */, WasActivatedOption::kUnknown);
 
   if (!request)
     return;
@@ -2198,7 +2198,7 @@ void NavigationControllerImpl::NavigateToExistingPendingEntry(
             root, *pending_entry_, pending_entry_->GetFrameEntry(root),
             reload_type, false /* is_same_document_history_load */,
             false /* is_history_navigation_in_new_child */, nullptr, nullptr,
-            base::TimeTicks() /* input_start */);
+            base::TimeTicks() /* input_start */, WasActivatedOption::kUnknown);
     if (!navigation_request) {
       // This navigation cannot start (e.g. the URL is invalid), delete the
       // pending NavigationEntry.
@@ -2275,7 +2275,8 @@ void NavigationControllerImpl::FindFramesToNavigate(
               frame, *pending_entry_, new_item, reload_type,
               true /* is_same_document_history_load */,
               false /* is_history_navigation_in_new_child */, nullptr, nullptr,
-              base::TimeTicks() /* input_start */);
+              base::TimeTicks() /* input_start */,
+              WasActivatedOption::kUnknown);
       if (navigation_request) {
         // Only add the request if was properly created. It's possible for the
         // creation to fail in certain cases, e.g. when the URL is invalid.
@@ -2302,7 +2303,8 @@ void NavigationControllerImpl::FindFramesToNavigate(
               frame, *pending_entry_, new_item, reload_type,
               false /* is_same_document_history_load */,
               false /* is_history_navigation_in_new_child */, nullptr, nullptr,
-              base::TimeTicks() /* input_start */);
+              base::TimeTicks() /* input_start */,
+              WasActivatedOption::kUnknown);
       if (navigation_request) {
         // Only add the request if was properly created. It's possible for the
         // creation to fail in certain cases, e.g. when the URL is invalid.
@@ -2387,7 +2389,7 @@ void NavigationControllerImpl::NavigateWithoutEntry(
       false /* is_same_document_history_load */,
       false /* is_history_navigation_in_new_child */, nullptr,
       params.navigation_ui_data ? params.navigation_ui_data->Clone() : nullptr,
-      params.input_start);
+      params.input_start, params.was_activated);
 
   // If the navigation couldn't start, return immediately and discard the
   // pending NavigationEntry.
@@ -2550,7 +2552,8 @@ NavigationControllerImpl::CreateNavigationRequest(
     bool is_history_navigation_in_new_child,
     const scoped_refptr<network::ResourceRequestBody>& post_body,
     std::unique_ptr<NavigationUIData> navigation_ui_data,
-    base::TimeTicks input_start) {
+    base::TimeTicks input_start,
+    WasActivatedOption was_activated) {
   GURL dest_url = frame_entry->url();
   Referrer dest_referrer = frame_entry->referrer();
   if (reload_type == ReloadType::ORIGINAL_REQUEST_URL &&
@@ -2623,7 +2626,7 @@ NavigationControllerImpl::CreateNavigationRequest(
       frame_tree_node, dest_url, dest_referrer, *frame_entry, entry,
       navigation_type, previews_state, is_same_document_history_load,
       is_history_navigation_in_new_child, post_body, navigation_start, this,
-      std::move(navigation_ui_data), input_start);
+      std::move(navigation_ui_data), input_start, was_activated);
 }
 
 void NavigationControllerImpl::NotifyNavigationEntryCommitted(

content/browser/frame_host/navigation_controller_impl.h

@@ -26,6 +26,7 @@
 struct FrameHostMsg_DidCommitProvisionalLoad_Params;
 
 namespace content {
+enum class WasActivatedOption;
 class FrameTreeNode;
 class RenderFrameHostImpl;
 class NavigationEntryScreenshotManager;
@@ -294,7 +295,8 @@ class CONTENT_EXPORT NavigationControllerImpl : public NavigationController {
       bool is_history_navigation_in_new_child,
       const scoped_refptr<network::ResourceRequestBody>& post_body,
       std::unique_ptr<NavigationUIData> navigation_ui_data,
-      base::TimeTicks input_start);
+      base::TimeTicks input_start,
+      WasActivatedOption was_activated);
 
   // Returns whether there is a pending NavigationEntry whose unique ID matches
   // the given NavigationHandle's pending_nav_entry_id.

content/browser/frame_host/navigation_request.cc

@@ -293,7 +293,8 @@ std::unique_ptr<NavigationRequest> NavigationRequest::CreateBrowserInitiated(
     base::TimeTicks navigation_start,
     NavigationControllerImpl* controller,
     std::unique_ptr<NavigationUIData> navigation_ui_data,
-    base::TimeTicks input_start) {
+    base::TimeTicks input_start,
+    WasActivatedOption was_activated) {
   // A form submission happens either because the navigation is a
   // renderer-initiated form submission that took the OpenURL path or a
   // back/forward/reload navigation the does a form resubmission.
@@ -338,6 +339,7 @@ std::unique_ptr<NavigationRequest> NavigationRequest::CreateBrowserInitiated(
           controller->GetLastCommittedEntryIndex(),
           controller->GetEntryCount());
   request_params.post_content_type = post_content_type;
+  request_params.was_activated = was_activated;
 
   std::unique_ptr<NavigationRequest> navigation_request(new NavigationRequest(
       frame_tree_node, common_params,
@@ -990,23 +992,27 @@ void NavigationRequest::OnResponseStarted(
   //    context menu. This should apply to pages that open in a new tab and we
   //    have to follow the referrer. It means that the activation might not be
   //    transmitted if it should have.
-  request_params_.was_activated = false;
-  if (navigation_handle_->IsRendererInitiated() &&
-      frame_tree_node_->has_received_user_gesture() &&
-      ShouldPropagateUserActivation(
-          frame_tree_node_->current_origin(),
-          url::Origin::Create(navigation_handle_->GetURL()))) {
-    request_params_.was_activated = true;
-    // TODO(805871): the next check is relying on
-    // navigation_handle_->GetReferrer() but should ideally use a more reliable
-    // source for the originating URL when the navigation is renderer initiated.
-  } else if (((navigation_handle_->HasUserGesture() &&
-               navigation_handle_->IsRendererInitiated()) ||
-              navigation_handle_->WasStartedFromContextMenu()) &&
-             ShouldPropagateUserActivation(
-                 url::Origin::Create(navigation_handle_->GetReferrer().url),
-                 url::Origin::Create(navigation_handle_->GetURL()))) {
-    request_params_.was_activated = true;
+  if (request_params_.was_activated == WasActivatedOption::kUnknown) {
+    request_params_.was_activated = WasActivatedOption::kNo;
+
+    if (navigation_handle_->IsRendererInitiated() &&
+        frame_tree_node_->has_received_user_gesture() &&
+        ShouldPropagateUserActivation(
+            frame_tree_node_->current_origin(),
+            url::Origin::Create(navigation_handle_->GetURL()))) {
+      request_params_.was_activated = WasActivatedOption::kYes;
+      // TODO(805871): the next check is relying on
+      // navigation_handle_->GetReferrer() but should ideally use a more
+      // reliable source for the originating URL when the navigation is renderer
+      // initiated.
+    } else if (((navigation_handle_->HasUserGesture() &&
+                 navigation_handle_->IsRendererInitiated()) ||
+                navigation_handle_->WasStartedFromContextMenu()) &&
+               ShouldPropagateUserActivation(
+                   url::Origin::Create(navigation_handle_->GetReferrer().url),
+                   url::Origin::Create(navigation_handle_->GetURL()))) {
+      request_params_.was_activated = WasActivatedOption::kYes;
+    }
   }
 
   // Update the previews state of the request.

content/browser/frame_host/navigation_request.h

@@ -94,7 +94,8 @@ class CONTENT_EXPORT NavigationRequest : public NavigationURLLoaderDelegate {
       base::TimeTicks navigation_start,
       NavigationControllerImpl* controller,
       std::unique_ptr<NavigationUIData> navigation_ui_data,
-      base::TimeTicks input_start);
+      base::TimeTicks input_start,
+      WasActivatedOption was_activated);
 
   // Creates a request for a renderer-intiated navigation.
   // Note: |body| is sent to the IO thread when calling BeginNavigation, and

content/browser/frame_host/render_frame_host_manager_unittest.cc

@@ -450,7 +450,8 @@ class RenderFrameHostManagerTest : public RenderViewHostImplTestHarness {
             manager->frame_tree_node_, frame_entry->url(),
             frame_entry->referrer(), *frame_entry, entry, navigate_type,
             PREVIEWS_UNSPECIFIED, false, false, nullptr, base::TimeTicks::Now(),
-            controller, nullptr, base::TimeTicks());
+            controller, nullptr, base::TimeTicks(),
+            WasActivatedOption::kUnknown);
 
     // Simulates request creation that triggers the 1st internal call to
     // GetFrameHostForNavigation.
@@ -2824,7 +2825,7 @@ TEST_F(RenderFrameHostManagerTestWithBrowserSideNavigation,
           FrameMsg_Navigate_Type::DIFFERENT_DOCUMENT, PREVIEWS_UNSPECIFIED,
           false, false, nullptr, base::TimeTicks::Now(),
           static_cast<NavigationControllerImpl*>(&controller()), nullptr,
-          base::TimeTicks());
+          base::TimeTicks(), WasActivatedOption::kUnknown);
   manager->DidCreateNavigationRequest(navigation_request.get());
 
   // As the initial RenderFrame was not live, the new RenderFrameHost should be
@@ -2887,7 +2888,7 @@ TEST_F(RenderFrameHostManagerTestWithBrowserSideNavigation,
           FrameMsg_Navigate_Type::DIFFERENT_DOCUMENT, PREVIEWS_UNSPECIFIED,
           false, false, nullptr, base::TimeTicks::Now(),
           static_cast<NavigationControllerImpl*>(&controller()), nullptr,
-          base::TimeTicks());
+          base::TimeTicks(), WasActivatedOption::kUnknown);
   manager->DidCreateNavigationRequest(navigation_request.get());
 
   // The current WebUI should still be in place and the pending WebUI should be
@@ -2947,7 +2948,7 @@ TEST_F(RenderFrameHostManagerTestWithBrowserSideNavigation,
           FrameMsg_Navigate_Type::DIFFERENT_DOCUMENT, PREVIEWS_UNSPECIFIED,
           false, false, nullptr, base::TimeTicks::Now(),
           static_cast<NavigationControllerImpl*>(&controller()), nullptr,
-          base::TimeTicks());
+          base::TimeTicks(), WasActivatedOption::kUnknown);
   manager->DidCreateNavigationRequest(navigation_request.get());
 
   // The current WebUI should still be in place and there should be a new

content/common/frame_messages.h

@@ -50,6 +50,7 @@
 #include "content/public/common/screen_info.h"
 #include "content/public/common/stop_find_action.h"
 #include "content/public/common/three_d_api_types.h"
+#include "content/public/common/was_activated_option.h"
 #include "ipc/ipc_message_macros.h"
 #include "ipc/ipc_platform_file.h"
 #include "mojo/public/cpp/system/message_pipe.h"
@@ -142,6 +143,8 @@ IPC_ENUM_TRAITS_MAX_VALUE(blink::UserActivationUpdateType,
                           blink::UserActivationUpdateType::kMaxValue)
 IPC_ENUM_TRAITS_MAX_VALUE(blink::WebMediaPlayerAction::Type,
                           blink::WebMediaPlayerAction::Type::kTypeLast)
+IPC_ENUM_TRAITS_MAX_VALUE(content::WasActivatedOption,
+                          content::WasActivatedOption::kMaxValue)
 IPC_ENUM_TRAITS_MIN_MAX_VALUE(blink::WebScrollDirection,
                               blink::kFirstScrollDirection,
                               blink::kLastScrollDirection)

content/common/navigation_params.h

@@ -23,6 +23,7 @@
 #include "content/public/common/page_state.h"
 #include "content/public/common/previews_state.h"
 #include "content/public/common/referrer.h"
+#include "content/public/common/was_activated_option.h"
 #include "net/url_request/redirect_info.h"
 #include "services/network/public/cpp/resource_request_body.h"
 #include "services/network/public/cpp/resource_response.h"
@@ -300,15 +301,15 @@ struct CONTENT_EXPORT RequestNavigationParams {
   // The AppCache host id to be used to identify this navigation.
   int appcache_host_id = kAppCacheNoHostId;
 
-  // True if a navigation is following the rules of user activation propagation.
-  // This is different from |has_user_gesture| (in CommonNavigationParams) as
-  // the activation may have happened before the navigation was triggered, for
-  // example.
+  // Set to |kYes| if a navigation is following the rules of user activation
+  // propagation. This is different from |has_user_gesture|
+  // (in CommonNavigationParams) as the activation may have happened before
+  // the navigation was triggered, for example.
   // In other words, the distinction isn't regarding user activation and user
   // gesture but whether there was an activation prior to the navigation or to
   // start it. `was_activated` will answer the former question while
   // `user_gesture` will answer the latter.
-  bool was_activated = false;
+  WasActivatedOption was_activated = WasActivatedOption::kUnknown;
 
 #if defined(OS_ANDROID)
   // The real content of the data: URL. Only used in Android WebView for

content/public/browser/navigation_controller.cc

@@ -7,6 +7,7 @@
 #include "base/memory/ref_counted_memory.h"
 #include "build/build_config.h"
 #include "content/public/browser/render_frame_host.h"
+#include "content/public/common/was_activated_option.h"
 
 namespace content {
 
@@ -23,8 +24,8 @@ NavigationController::LoadURLParams::LoadURLParams(const GURL& url)
       has_user_gesture(false),
       should_clear_history_list(false),
       started_from_context_menu(false),
-      navigation_ui_data(nullptr) {
-}
+      navigation_ui_data(nullptr),
+      was_activated(WasActivatedOption::kUnknown) {}
 
 NavigationController::LoadURLParams::~LoadURLParams() {
 }

content/public/browser/navigation_controller.h

@@ -36,6 +36,7 @@ class RefCountedString;
 
 namespace content {
 
+enum class WasActivatedOption;
 class BrowserContext;
 class NavigationEntry;
 class WebContents;
@@ -202,6 +203,10 @@ class NavigationController {
     // it for navigations it initiates.
     base::TimeTicks input_start;
 
+    // Set to |kYes| if the navigation should propagate user activation. This
+    // is used by embedders where the activation has occurred outside the page.
+    WasActivatedOption was_activated;
+
     explicit LoadURLParams(const GURL& url);
     ~LoadURLParams();
 

content/public/common/BUILD.gn

@@ -216,6 +216,7 @@ jumbo_source_set("common_sources") {
     "use_zoom_for_dsf_policy.cc",
     "use_zoom_for_dsf_policy.h",
     "user_agent.h",
+    "was_activated_option.h",
     "web_preferences.cc",
     "web_preferences.h",
     "webplugininfo.cc",

content/public/common/was_activated_option.h

+// Copyright 2018 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 CONTENT_PUBLIC_COMMON_WAS_ACTIVATED_OPTION_H_
+#define CONTENT_PUBLIC_COMMON_WAS_ACTIVATED_OPTION_H_
+
+namespace content {
+
+// Whether the navigation should propagate user activation. This can be
+// specified by embedders in NavigationController::LoadURLParams.
+enum class WasActivatedOption {
+  // The content layer should make a decision about whether to propagate user
+  // activation.
+  kUnknown,
+
+  // The navigation should propagate user activation.
+  kYes,
+
+  // The navigation should not propagate user activation.
+  kNo,
+  kMaxValue = kNo,
+};
+
+}  // namespace content
+
+#endif  // CONTENT_PUBLIC_COMMON_WAS_ACTIVATED_OPTION_H_

content/renderer/render_frame_impl.cc

@@ -964,7 +964,8 @@ std::unique_ptr<blink::WebNavigationParams> BuildNavigationParams(
         common_params.source_location->column_number;
   }
 
-  navigation_params->is_user_activated = request_params.was_activated;
+  navigation_params->is_user_activated =
+      request_params.was_activated == WasActivatedOption::kYes;
   navigation_params->service_worker_network_provider =
       std::move(service_worker_network_provider);
   return navigation_params;