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

third_party/WebKit/Source/core/html/shadow/MediaControlsTest.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 "core/html/shadow/MediaControls.h"
 
 #include <limits>
 #include <memory>
 #include "core/HTMLNames.h"
 #include "core/css/StylePropertySet.h"
 #include "core/dom/Document.h"
 #include "core/dom/ElementTraversal.h"
 #include "core/dom/StyleEngine.h"
 #include "core/frame/Settings.h"
 #include "core/html/HTMLVideoElement.h"
 #include "core/html/shadow/MediaControlElementTypes.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/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 {
 
 namespace {
 
@@ skipping 82 matching lines @@
 enum DownloadActionMetrics {
   Shown = 0,
   Clicked,
   Count  // Keep last.
 };
 
 }  // namespace
 
 class MediaControlsTest : public ::testing::Test {
  protected:
-  virtual void SetUp() {
+  virtual void SetUp() { initializePage(); }
+
+  void initializePage() {
     m_pageHolder = DummyPageHolder::create(IntSize(800, 600), nullptr,
                                            StubLocalFrameClient::create());
     Document& document = this->document();
 
     document.write("<video>");
     HTMLVideoElement& video =
         toHTMLVideoElement(*document.querySelector("video"));
     m_mediaControls = 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 86 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(MediaControlsTest, 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(MediaControlsTest, CastOverlayDefault) {
   Element* castOverlayButton = getElementByShadowPseudoId(
       mediaControls(), "-internal-media-controls-overlay-cast-button");
   ASSERT_NE(nullptr, castOverlayButton);
 
-  simulateRouteAvailabe();
+  simulateRouteAvailable();
   ASSERT_TRUE(isElementVisible(*castOverlayButton));
 }
 
 TEST_F(MediaControlsTest, 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(MediaControlsTest, 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(MediaControlsTest, KeepControlsVisibleIfOverflowListVisible) {
@@ skipping 179 matching lines @@
   double duration = 600;
   loadMediaWithDuration(duration);
 
   // Simulate seeking the underlying range to 50%. Current time display should
   // update synchronously (rather than waiting for media to finish seeking).
   timeline->setValueAsNumber(duration / 2, ASSERT_NO_EXCEPTION);
   timeline->dispatchInputEvent();
   EXPECT_EQ(duration / 2, currentTimeDisplay->currentValue());
 }
 
+TEST_F(MediaControlsTest, ControlsRemainVisibleDuringKeyboardInteraction) {
+  ScopedTestingPlatformSupport<TestingPlatformSupportWithMockScheduler>
+      m_platform;
+  m_platform->advanceClockSeconds(1);

[johnme, 2017/04/06 17:15:28]

Can you add a comment explaining why you need to advance the clock at the
beginning of the test?

[steimel, 2017/04/07 16:47:16]

Done.

+
+  // Need to reinitialize page since we changed the platform.
+  initializePage();
+  ensureSizing();
+
+  Element* panel = getElementByShadowPseudoId(mediaControls(),

[johnme, 2017/04/06 17:15:28]

Nit: you can use mediaControls().panelElement() here (and shouldn't be necessary
to null check it)

[steimel, 2017/04/07 16:47:17]

Done.

+                                              "-webkit-media-controls-panel");
+  ASSERT_NE(nullptr, panel);
+
+  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