Prevent Media Controls from hiding when the user is interacting via the keyboard

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 "core/HTMLNames.h"
 #include "core/css/StylePropertySet.h"
 #include "core/dom/ClientRect.h"
 #include "core/dom/Document.h"
 #include "core/dom/ElementTraversal.h"
 #include "core/dom/StyleEngine.h"
 #include "core/events/Event.h"
 #include "core/frame/Settings.h"
 #include "core/html/HTMLElement.h"
 #include "core/html/HTMLVideoElement.h"
 #include "core/html/shadow/MediaControlElementTypes.h"
 #include "core/input/EventHandler.h"
 #include "core/layout/LayoutObject.h"
 #include "core/loader/EmptyClients.h"
 #include "core/testing/DummyPageHolder.h"
 #include "platform/heap/Handle.h"
 #include "platform/testing/EmptyWebMediaPlayer.h"
 #include "platform/testing/HistogramTester.h"
+#include "platform/testing/TestingPlatformSupport.h"
 #include "platform/testing/UnitTestHelpers.h"
 #include "public/platform/WebMouseEvent.h"
 #include "public/platform/WebScreenInfo.h"
 #include "public/platform/WebSize.h"
 #include "public/platform/modules/remoteplayback/WebRemotePlaybackAvailability.h"
 #include "public/platform/modules/remoteplayback/WebRemotePlaybackClient.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace blink {
 
@@ skipping 116 matching lines @@
 enum DownloadActionMetrics {
   Shown = 0,
   Clicked,
   Count  // Keep last.
 };
 
 }  // namespace
 
 class MediaControlsImplTest : public ::testing::Test {
  protected:
-  virtual void SetUp() {
+  virtual void SetUp() { initializePage(); }
+
+  void initializePage() {
     Page::PageClients clients;
     fillWithEmptyClients(clients);
     clients.chromeClient = new MockChromeClient();
     m_pageHolder = DummyPageHolder::create(IntSize(800, 600), &clients,
                                            StubLocalFrameClient::create());
 
     document().write("<video>");
     HTMLVideoElement& video =
         toHTMLVideoElement(*document().querySelector("video"));
     m_mediaControls = static_cast<MediaControlsImpl*>(video.mediaControls());
 
     // If scripts are not enabled, controls will always be shown.
     m_pageHolder->frame().settings()->setScriptEnabled(true);
   }
 
-  void simulateRouteAvailabe() {
+  void simulateRouteAvailable() {
     m_mediaControls->mediaElement().remoteRouteAvailabilityChanged(
         WebRemotePlaybackAvailability::DeviceAvailable);
   }
 
   void ensureSizing() {
     // Fire the size-change callback to ensure that the controls have
     // been properly notified of the video size.
     m_mediaControls->notifyElementSizeChanged(
         m_mediaControls->mediaElement().getBoundingClientRect());
   }
@@ skipping 124 matching lines @@
   ensureSizing();
   mediaControls().mediaElement().setBooleanAttribute(HTMLNames::controlsAttr,
                                                      true);
 
   Element* castButton = getElementByShadowPseudoId(
       mediaControls(), "-internal-media-controls-cast-button");
   ASSERT_NE(nullptr, castButton);
 
   ASSERT_FALSE(isElementVisible(*castButton));
 
-  simulateRouteAvailabe();
+  simulateRouteAvailable();
   ASSERT_TRUE(isElementVisible(*castButton));
 }
 
 TEST_F(MediaControlsImplTest, CastButtonDisableRemotePlaybackAttr) {
   ensureSizing();
   mediaControls().mediaElement().setBooleanAttribute(HTMLNames::controlsAttr,
                                                      true);
 
   Element* castButton = getElementByShadowPseudoId(
       mediaControls(), "-internal-media-controls-cast-button");
   ASSERT_NE(nullptr, castButton);
 
   ASSERT_FALSE(isElementVisible(*castButton));
-  simulateRouteAvailabe();
+  simulateRouteAvailable();
   ASSERT_TRUE(isElementVisible(*castButton));
 
   mediaControls().mediaElement().setBooleanAttribute(
       HTMLNames::disableremoteplaybackAttr, true);
   ASSERT_FALSE(isElementVisible(*castButton));
 
   mediaControls().mediaElement().setBooleanAttribute(
       HTMLNames::disableremoteplaybackAttr, false);
   ASSERT_TRUE(isElementVisible(*castButton));
 }
 
 TEST_F(MediaControlsImplTest, CastOverlayDefault) {
   Element* castOverlayButton = getElementByShadowPseudoId(
       mediaControls(), "-internal-media-controls-overlay-cast-button");
   ASSERT_NE(nullptr, castOverlayButton);
 
-  simulateRouteAvailabe();
+  simulateRouteAvailable();
   ASSERT_TRUE(isElementVisible(*castOverlayButton));
 }
 
 TEST_F(MediaControlsImplTest, CastOverlayDisableRemotePlaybackAttr) {
   Element* castOverlayButton = getElementByShadowPseudoId(
       mediaControls(), "-internal-media-controls-overlay-cast-button");
   ASSERT_NE(nullptr, castOverlayButton);
 
   ASSERT_FALSE(isElementVisible(*castOverlayButton));
-  simulateRouteAvailabe();
+  simulateRouteAvailable();
   ASSERT_TRUE(isElementVisible(*castOverlayButton));
 
   mediaControls().mediaElement().setBooleanAttribute(
       HTMLNames::disableremoteplaybackAttr, true);
   ASSERT_FALSE(isElementVisible(*castOverlayButton));
 
   mediaControls().mediaElement().setBooleanAttribute(
       HTMLNames::disableremoteplaybackAttr, false);
   ASSERT_TRUE(isElementVisible(*castOverlayButton));
 }
 
 TEST_F(MediaControlsImplTest, CastOverlayMediaControlsDisabled) {
   Element* castOverlayButton = getElementByShadowPseudoId(
       mediaControls(), "-internal-media-controls-overlay-cast-button");
   ASSERT_NE(nullptr, castOverlayButton);
 
   EXPECT_FALSE(isElementVisible(*castOverlayButton));
-  simulateRouteAvailabe();
+  simulateRouteAvailable();
   EXPECT_TRUE(isElementVisible(*castOverlayButton));
 
   document().settings()->setMediaControlsEnabled(false);
   EXPECT_FALSE(isElementVisible(*castOverlayButton));
 
   document().settings()->setMediaControlsEnabled(true);
   EXPECT_TRUE(isElementVisible(*castOverlayButton));
 }
 
 TEST_F(MediaControlsImplTest, KeepControlsVisibleIfOverflowListVisible) {
@@ skipping 392 matching lines @@
   histogramTester().expectTotalCount(
       "Media.Timeline.DragGestureDuration.128_255", 1);
   histogramTester().expectUniqueSample("Media.Timeline.DragPercent.128_255",
                                        8 /* (-35.0%, -30.0%] */, 1);
   histogramTester().expectUniqueSample(
       "Media.Timeline.DragSumAbsTimeDelta.128_255", 17 /* [8m, 15m) */, 1);
   histogramTester().expectUniqueSample("Media.Timeline.DragTimeDelta.128_255",
                                        9 /* (-4m, -2m] */, 1);
 }
 
+TEST_F(MediaControlsImplTest, ControlsRemainVisibleDuringKeyboardInteraction) {
+  ScopedTestingPlatformSupport<TestingPlatformSupportWithMockScheduler>
+      m_platform;
+
+  // DocumentParserTiming has DCHECKS to make sure time > 0.0.
+  m_platform->advanceClockSeconds(1);
+
+  // Need to reinitialize page since we changed the platform.
+  initializePage();
+  ensureSizing();
+
+  Element* panel = mediaControls().panelElement();
+
+  mediaControls().mediaElement().setBooleanAttribute(HTMLNames::controlsAttr,
+                                                     true);
+  mediaControls().mediaElement().setSrc("http://example.com");
+  mediaControls().mediaElement().play();
+
+  // Controls start out visible.
+  EXPECT_TRUE(isElementVisible(*panel));
+
+  // Tabbing between controls prevents controls from hiding.
+  m_platform->runForPeriodSeconds(2);
+  mediaControls().dispatchEvent(Event::create("focusin"));
+  m_platform->runForPeriodSeconds(2);
+  EXPECT_TRUE(isElementVisible(*panel));
+
+  // Seeking on the timeline or volume bar prevents controls from hiding.
+  mediaControls().dispatchEvent(Event::create("input"));
+  m_platform->runForPeriodSeconds(2);
+  EXPECT_TRUE(isElementVisible(*panel));
+
+  // Pressing a key prevents controls from hiding.
+  mediaControls().panelElement()->dispatchEvent(Event::create("keypress"));
+  m_platform->runForPeriodSeconds(2);
+  EXPECT_TRUE(isElementVisible(*panel));
+
+  // Once user interaction stops, controls can hide.
+  m_platform->runForPeriodSeconds(2);
+  EXPECT_FALSE(isElementVisible(*panel));
+}
+
 }  // namespace blink