chrome/blink: Add functionality for in-product help for media elements.

third_party/WebKit/Source/modules/media_controls/MediaControlsImplTest.cpp

 // 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 "modules/media_controls/MediaControlsImpl.h"
 
 #include <limits>
 #include <memory>
 
 #include "build/build_config.h"
@@ skipping 58 matching lines @@
   WebTimeRanges Seekable() const override { return seekable_; }
   bool HasVideo() const override { return true; }
 
   WebTimeRanges seekable_;
 };
 
 class MockLayoutObject : public LayoutObject {
  public:
   MockLayoutObject(Node* node) : LayoutObject(node) {}
 
+  void SetVisible(bool visible) { visible_ = visible; }
+
   const char* GetName() const override { return "MockLayoutObject"; }
   void UpdateLayout() override {}
   FloatRect LocalBoundingBoxRectForAccessibility() const override {
     return FloatRect();
   }
+  void AbsoluteQuads(Vector<FloatQuad>& quads,
+                     MapCoordinatesFlags mode) const override {
+    if (!visible_)
+      return;
+    quads.push_back(FloatQuad(FloatRect(0.f, 0.f, 10.f, 10.f)));
+  }
+
+ private:
+  bool visible_ = false;
 };
 
 class StubLocalFrameClient : public EmptyLocalFrameClient {
  public:
   static StubLocalFrameClient* Create() { return new StubLocalFrameClient; }
 
   std::unique_ptr<WebMediaPlayer> CreateWebMediaPlayer(
       HTMLMediaElement&,
       const WebMediaPlayerSource&,
       WebMediaPlayerClient*) override {
     return WTF::WrapUnique(new MockVideoWebMediaPlayer);
   }
 
   WebRemotePlaybackClient* CreateWebRemotePlaybackClient(
       HTMLMediaElement& element) override {
     return HTMLMediaElementRemotePlayback::remote(element);
   }
 };
 
 Element* GetElementByShadowPseudoId(Node& root_node,
                                     const char* shadow_pseudo_id) {
   for (Element& element : ElementTraversal::DescendantsOf(root_node)) {
     if (element.ShadowPseudoId() == shadow_pseudo_id)
       return &element;
   }
   return nullptr;
 }
 
+MediaControlDownloadButtonElement& GetDownloadButton(
+    MediaControlsImpl& controls) {
+  Element* element = GetElementByShadowPseudoId(
+      controls, "-internal-media-controls-download-button");
+  return static_cast<MediaControlDownloadButtonElement&>(*element);
+}
+
 bool IsElementVisible(Element& element) {
   const StylePropertySet* inline_style = element.InlineStyle();
 
   if (!inline_style)
     return true;
 
   if (inline_style->GetPropertyValue(CSSPropertyDisplay) == "none")
     return false;
 
   if (inline_style->HasProperty(CSSPropertyOpacity) &&
@@ skipping 442 matching lines @@
       MediaControls(), "-internal-media-controls-download-button");
   ASSERT_NE(nullptr, download_button);
 
   // Download button should not be displayed for HLS streams.
   MediaControls().MediaElement().SetSrc("https://example.com/foo.m3u8");
   testing::RunPendingTasks();
   SimulateLoadedMetadata();
   EXPECT_FALSE(IsElementVisible(*download_button));
 }
 
+TEST_F(MediaControlsImplTest, DownloadButtonInProductHelp_Settings) {
+  EnsureSizing();
+
+  // Inject the LayoutObject for the button to override the rect returned in
+  // visual viewport.
+  MediaControlDownloadButtonElement& button =
+      GetDownloadButton(MediaControls());
+  MockLayoutObject layout_object(&button);
+  layout_object.SetVisible(true);
+  button.SetLayoutObject(&layout_object);
+
+  // In-product help not triggered when disabled from the settings.
+  MediaControls().MediaElement().SetSrc("https://example.com/foo.mp4");
+  testing::RunPendingTasks();
+  SimulateLoadedMetadata();
+  MediaControls().MediaElement().Play();
+
+  ASSERT_TRUE(button.IsWanted());
+  EXPECT_FALSE(button.IsShowingInProductHelp());
+
+  // Enable the setting which should show the in-product help.
+  MediaControls()
+      .MediaElement()
+      .GetDocument()
+      .GetSettings()
+      ->SetMediaDownloadInProductHelpEnabled(true);
+  button.SetIsWanted(button.IsWanted());
+  EXPECT_TRUE(button.IsShowingInProductHelp());
+  EXPECT_TRUE(MediaControls().IsVisible());
+
+  // Disable the download button, which dismisses the in-product-help.
+  button.SetIsWanted(false);
+  EXPECT_FALSE(button.IsShowingInProductHelp());
+
+  // Re-enable. In-product-help should be restricted to once per element.
+  button.SetIsWanted(true);
+  EXPECT_FALSE(button.IsShowingInProductHelp());
+
+  button.SetLayoutObject(nullptr);
+}
+
+TEST_F(MediaControlsImplTest, DownloadButtonInProductHelp_ControlsVisibility) {
+  EnsureSizing();
+
+  // Inject the LayoutObject for the button to override the rect returned in
+  // visual viewport.
+  MediaControlDownloadButtonElement& button =
+      GetDownloadButton(MediaControls());
+  MockLayoutObject layout_object(&button);
+  layout_object.SetVisible(true);
+  button.SetLayoutObject(&layout_object);
+
+  MediaControls()
+      .MediaElement()
+      .GetDocument()
+      .GetSettings()
+      ->SetMediaDownloadInProductHelpEnabled(true);
+
+  // The in-product-help should not be shown while the controls are hidden.
+  MediaControls().Hide();
+  MediaControls().MediaElement().SetSrc("https://example.com/foo.mp4");
+  testing::RunPendingTasks();
+  SimulateLoadedMetadata();
+  MediaControls().MediaElement().Play();
+
+  ASSERT_TRUE(button.IsWanted());
+  EXPECT_FALSE(button.IsShowingInProductHelp());
+
+  // Showing the controls initiates showing in-product-help.
+  MediaControls().MaybeShow();
+  EXPECT_TRUE(button.IsShowingInProductHelp());
+  EXPECT_TRUE(MediaControls().IsVisible());
+
+  // Hiding the controls dismissed in-product-help.
+  MediaControls().Hide();
+  EXPECT_FALSE(button.IsShowingInProductHelp());
+
+  button.SetLayoutObject(nullptr);
+}
+
+TEST_F(MediaControlsImplTest, DownloadButtonInProductHelp_ButtonVisibility) {
+  EnsureSizing();
+
+  // Inject the LayoutObject for the button to override the rect returned in
+  // visual viewport.
+  MediaControlDownloadButtonElement& button =
+      GetDownloadButton(MediaControls());
+  MockLayoutObject layout_object(&button);
+  button.SetLayoutObject(&layout_object);
+
+  MediaControls()
+      .MediaElement()
+      .GetDocument()
+      .GetSettings()
+      ->SetMediaDownloadInProductHelpEnabled(true);
+
+  // The in-product-help should not be shown while the button is hidden.
+  layout_object.SetVisible(false);
+  MediaControls().MediaElement().SetSrc("https://example.com/foo.mp4");
+  testing::RunPendingTasks();
+  SimulateLoadedMetadata();
+  MediaControls().MediaElement().Play();
+
+  ASSERT_TRUE(button.IsWanted());
+  EXPECT_FALSE(button.IsShowingInProductHelp());
+
+  // Make the button visible to show in-product-help.
+  layout_object.SetVisible(true);
+  button.SetIsWanted(button.IsWanted());
+  EXPECT_TRUE(button.IsShowingInProductHelp());
+  EXPECT_TRUE(MediaControls().IsVisible());
+
+  button.SetLayoutObject(nullptr);
+}
+
 TEST_F(MediaControlsImplTest, TimelineSeekToRoundedEnd) {
   EnsureSizing();
 
   // Tests the case where the real length of the video, |exact_duration|, gets
   // rounded up slightly to |rounded_up_duration| when setting the timeline's
   // |max| attribute (crbug.com/695065).
   double exact_duration = 596.586667;
   double rounded_up_duration = 596.587;
   LoadMediaWithDuration(exact_duration);
 
@@ skipping 326 matching lines @@
   {
     Persistent<HTMLMediaElement> video_holder = element;
     page_holder->GetDocument().body()->RemoveChild(element);
     page_holder->GetDocument().body()->AppendChild(video_holder.Get());
     EXPECT_TRUE(remote_playback->HasEventListeners());
     EXPECT_TRUE(HasAvailabilityCallbacks(remote_playback));
   }
 }
 
 }  // namespace blink