[TTS] Gather surrounding text on Tap before any UX.

chrome/android/javatests/src/org/chromium/chrome/browser/contextualsearch/ContextualSearchManagerTest.java

 // 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.
 
 package org.chromium.chrome.browser.contextualsearch;
 
 import static org.chromium.base.test.util.Restriction.RESTRICTION_TYPE_NON_LOW_END_DEVICE;
 import static org.chromium.content.browser.test.util.CriteriaHelper.DEFAULT_POLLING_INTERVAL;
 
 import android.app.Activity;
@@ skipping 784 matching lines @@
 
     /**
      * Scrolls the base page.
      */
     private void scrollBasePage() {
         // TODO(pedrosimonetti): Consider using a swipe method instead.
         fling(0.f, 0.75f, 0.f, 0.7f, 100);
     }
 
     /**
-     * Taps the base page near the top.
-     */
-    private void tapBasePageToClosePanel() throws InterruptedException {
-        // TODO(pedrosimonetti): This is not reliable. Find a better approach.
-        // We use the far right side (x == 0.9f) to prevent simulating a tap on top of an
-        // existing long-press selection (the pins are a tap target). This might not work on RTL.
-        // We are using y == 0.35f because otherwise it will fail for long press cases.
-        // It might be better to get the position of the Panel and tap just about outside
-        // the Panel. I suspect some Flaky tests are caused by this problem (ones involving
-        // long press and trying to close with the bar peeking, with a long press selection
-        // established).
-        tapBasePage(0.9f, 0.35f);
-        waitForPanelToClose();
-    }
-
-    /**
      * Taps the base page at the given x, y position.
      */
     private void tapBasePage(float x, float y) {

[Theresa, 2016/09/12 22:59:19]

Is this being used anywhere anymore? 

[Donn Denman, 2016/09/14 00:18:22]

Removed.  Also consolidated to methods just below. 

         View root = getActivity().getWindow().getDecorView().getRootView();
         x *= root.getWidth();
         y *= root.getHeight();
         TouchCommon.singleClickView(root, (int) x, (int) y);
     }
 
     /**
      * Click various places to cause the panel to show, expand, then close.
      */
     private void clickToExpandAndClosePanel() throws InterruptedException, TimeoutException {
         clickWordNode("states");
         tapBarToExpandAndClosePanel();
         waitForSelectionDissolved();
     }
 
     /**
      * Tap on the peeking Bar to expand the panel, then taps on the base page to close it.

[Theresa, 2016/09/12 22:59:19]

this comment needs to be updated.

[Donn Denman, 2016/09/14 00:18:22]

Removed due to consolidation.  

Cleaned up a few other similar comments.

      */
     private void tapBarToExpandAndClosePanel() throws InterruptedException {
         tapPeekingBarToExpandAndAssert();
-        tapBasePageToClosePanel();
+        closePanel();
     }
 
     /**
      * Generate a click in the panel's bar.
      * TODO(donnd): Replace this method with panelBarClick since this appears to be unreliable.
      * @barHeight The vertical position where the click should take place as a percentage
      *            of the screen size.
      */
     private void clickPanelBar(float barPositionVertical) {
         View root = getActivity().getWindow().getDecorView().getRootView();
@@ skipping 239 matching lines @@
 
         waitForPanelToPeek();
         assertLoadedNoUrl();
         assertNoContentViewCore();
         flingPanelUp();
         waitForPanelToExpand();
         assertContentViewCoreCreated();
         assertLoadedNormalPriorityUrl();
         assertEquals(1, mFakeServer.getLoadedUrlCount());
 
-        // tap the base page to close.
-        tapBasePageToClosePanel();
+        // close the panel.
+        closePanel();
         assertEquals(1, mFakeServer.getLoadedUrlCount());
         assertNoContentViewCore();
     }
 
     /**
      * Tests that only a single low-priority request is issued for a Tap/Open sequence.
      */
     @SmallTest
     @Feature({"ContextualSearch"})
     @Restriction({RESTRICTION_TYPE_NON_LOW_END_DEVICE})
@@ skipping 583 matching lines @@
     @Feature({"ContextualSearch"})
     @Restriction({ChromeRestriction.RESTRICTION_TYPE_PHONE, RESTRICTION_TYPE_NON_LOW_END_DEVICE})
     @DisableIf.Build(supported_abis_includes = "arm64-v8a", message = "crbug.com/596533")
     public void testAppMenuSuppressedWhenExpanded() throws InterruptedException, TimeoutException {
         clickWordNode("states");
         tapPeekingBarToExpandAndAssert();
 
         pressAppMenuKey();
         assertAppMenuVisibility(false);
 
-        tapBasePageToClosePanel();
+        closePanel();
 
         pressAppMenuKey();
         assertAppMenuVisibility(true);
     }
 
     /**
      * Tests that the App Menu gets suppressed when Search Panel is maximized.
      */
     @SmallTest
     @Feature({"ContextualSearch"})
@@ skipping 155 matching lines @@
     @SmallTest
     @Feature({"ContextualSearch"})
     @Restriction({ChromeRestriction.RESTRICTION_TYPE_PHONE, RESTRICTION_TYPE_NON_LOW_END_DEVICE})
     public void testNotifyObserverHideAfterLongPress()
             throws InterruptedException, TimeoutException {
         TestContextualSearchObserver observer = new TestContextualSearchObserver();
         mManager.addObserver(observer);
         longPressNode("states");
         assertEquals(0, observer.hideCount);
 
-        tapBasePageToClosePanel();
+        closePanel();
         assertEquals(1, observer.hideCount);
     }
 
     /**
      * Tests that ContextualSearchObserver gets notified when user brings up contextual search
      * panel via tap and then dismisses the panel by tapping on the base page.
      */
     @SmallTest
     @Feature({"ContextualSearch"})
     @Restriction({ChromeRestriction.RESTRICTION_TYPE_PHONE, RESTRICTION_TYPE_NON_LOW_END_DEVICE})
     public void testNotifyObserverHideAfterTap() throws InterruptedException, TimeoutException {
         TestContextualSearchObserver observer = new TestContextualSearchObserver();
         mManager.addObserver(observer);
         clickWordNode("states");
         assertEquals(0, observer.hideCount);
 
-        tapBasePageToClosePanel();
+        closePanel();
         assertEquals(1, observer.hideCount);
     }
 
     private void assertWaitForSelectActionBarVisible(final boolean visible)
             throws InterruptedException {
         CriteriaHelper.pollUiThread(Criteria.equals(visible, new Callable<Boolean>() {
             @Override
             public Boolean call() {
                 return getActivity().getActivityTab().getContentViewCore()
                         .isSelectActionBarShowing();
@@ skipping 195 matching lines @@
         longPressNode("intelligence");
         waitForPanelToPeek();
         assertTrue(mPanel.isPeekPromoVisible());
 
         // After expanding the Panel the Promo should be invisible.
         flingPanelUp();
         waitForPanelToExpand();
         assertFalse(mPanel.isPeekPromoVisible());
 
         // After closing the Panel the Promo should still be invisible.
-        tapBasePageToClosePanel();
+        closePanel();
         assertFalse(mPanel.isPeekPromoVisible());
 
         // Click elsewhere to clear the selection.
         clickNode("question-mark");
         waitForSelectionToBe(null);
 
         // Now that the Panel was opened at least once, the Promo should not show again.
         longPressNode("intelligence");
         waitForPanelToPeek();
         assertFalse(mPanel.isPeekPromoVisible());
@@ skipping 12 matching lines @@
     public void testTapContentVisibility() throws InterruptedException, TimeoutException {
         // Simulate a tap and make sure Content is not visible.
         simulateTapSearch("search");
         assertContentViewCoreCreatedButNeverMadeVisible();
 
         // Expanding the Panel should make the Content visible.
         tapPeekingBarToExpandAndAssert();
         assertContentViewCoreVisible();
 
         // Closing the Panel should destroy the Content.
-        tapBasePageToClosePanel();
+        closePanel();
         assertNoContentViewCore();
     }
 
     /**
      * Tests that long press followed by expand creates Content and makes it visible.
      *
      */
     @SmallTest
     @Feature({"ContextualSearch"})
     @Restriction({ChromeRestriction.RESTRICTION_TYPE_PHONE, RESTRICTION_TYPE_NON_LOW_END_DEVICE})
     public void testLongPressContentVisibility() throws InterruptedException, TimeoutException {
         // Simulate a long press and make sure no Content is created.
         simulateLongPressSearch("search");
         assertNoContentViewCore();
         assertNoSearchesLoaded();
 
         // Expanding the Panel should make the Content visible.
         tapPeekingBarToExpandAndAssert();
         assertContentViewCoreCreated();
         assertContentViewCoreVisible();
 
         // Closing the Panel should destroy the Content.
-        tapBasePageToClosePanel();
+        closePanel();
         assertNoContentViewCore();
     }
 
     /**
      * Tests swiping panel up and down after a tap search will only load the Content once.
      */
     @SmallTest
     @Feature({"ContextualSearch"})
     @Restriction({ChromeRestriction.RESTRICTION_TYPE_PHONE, RESTRICTION_TYPE_NON_LOW_END_DEVICE})
     public void testTapMultipleSwipeOnlyLoadsContentOnce()
@@ skipping 13 matching lines @@
         waitForPanelToPeek();
         assertContentViewCoreVisible();
         assertEquals(1, mFakeServer.getLoadedUrlCount());
 
         // Expanding the Panel should not change the visibility or load content again.
         tapPeekingBarToExpandAndAssert();
         assertContentViewCoreVisible();
         assertEquals(1, mFakeServer.getLoadedUrlCount());
 
         // Closing the Panel should destroy the Content.
-        tapBasePageToClosePanel();
+        closePanel();
         assertNoContentViewCore();
         assertEquals(1, mFakeServer.getLoadedUrlCount());
     }
 
     /**
      * Tests swiping panel up and down after a long press search will only load the Content once.
      */
     @SmallTest
     @Feature({"ContextualSearch"})
     @Restriction({ChromeRestriction.RESTRICTION_TYPE_PHONE, RESTRICTION_TYPE_NON_LOW_END_DEVICE})
@@ skipping 15 matching lines @@
         waitForPanelToPeek();
         assertContentViewCoreVisible();
         assertEquals(1, mFakeServer.getLoadedUrlCount());
 
         // Expanding the Panel should not change the visibility or load content again.
         tapPeekingBarToExpandAndAssert();
         assertContentViewCoreVisible();
         assertEquals(1, mFakeServer.getLoadedUrlCount());
 
         // Closing the Panel should destroy the Content.
-        tapBasePageToClosePanel();
+        closePanel();
         assertNoContentViewCore();
         assertEquals(1, mFakeServer.getLoadedUrlCount());
     }
 
     /**
      * Tests that chained tap searches create new Content.
      */
     @SmallTest
     @Feature({"ContextualSearch"})
     @Restriction(RESTRICTION_TYPE_NON_LOW_END_DEVICE)
@@ skipping 17 matching lines @@
         waitToPreventDoubleTapRecognition();
 
         // Simulate a new tap and make sure a new Content is created.
         simulateTapSearch("resolution");
         assertContentViewCoreCreatedButNeverMadeVisible();
         assertEquals(3, mFakeServer.getLoadedUrlCount());
         ContentViewCore cvc3 = getPanelContentViewCore();
         assertNotSame(cvc2, cvc3);
 
         // Closing the Panel should destroy the Content.
-        tapBasePageToClosePanel();
+        closePanel();
         assertNoContentViewCore();
         assertEquals(3, mFakeServer.getLoadedUrlCount());
     }
 
     /**
      * Tests that chained searches load correctly.
      */
     @DisabledTest(message = "crbug.com/551711")
     @SmallTest
     @Feature({"ContextualSearch"})
@@ skipping 25 matching lines @@
         // Expanding the Panel should load and display the new search.
         tapPeekingBarToExpandAndAssert();
         assertContentViewCoreCreated();
         assertContentViewCoreVisible();
         assertEquals(2, mFakeServer.getLoadedUrlCount());
         assertLoadedSearchTermMatches("Resolution");
         ContentViewCore cvc2 = getPanelContentViewCore();
         assertNotSame(cvc1, cvc2);
 
         // Closing the Panel should destroy the Content.
-        tapBasePageToClosePanel();
+        closePanel();
         assertNoContentViewCore();
         assertEquals(2, mFakeServer.getLoadedUrlCount());
     }
 
     /**
      * Tests that chained searches make Content visible when opening the Panel.
      */
     @SmallTest
     @Feature({"ContextualSearch"})
     @Restriction({RESTRICTION_TYPE_NON_LOW_END_DEVICE})
@@ skipping 32 matching lines @@
     @Feature({"ContextualSearch"})
     @Restriction(RESTRICTION_TYPE_NON_LOW_END_DEVICE)
     public void testTapCloseRemovedFromHistory()
             throws InterruptedException, TimeoutException {
         // Simulate a tap and make sure a URL was loaded.
         simulateTapSearch("search");
         assertEquals(1, mFakeServer.getLoadedUrlCount());
         String url = mFakeServer.getLoadedUrl();
 
         // Close the Panel without seeing the Content.
-        tapBasePageToClosePanel();
+        closePanel();
 
         // Now check that the URL has been removed from history.
         assertTrue(mFakeServer.hasRemovedUrl(url));
     }
 
     /**
      * Tests that a tap followed by opening the Panel does not remove the loaded URL from history.
      */
     @SmallTest
     @Feature({"ContextualSearch"})
     @Restriction({ChromeRestriction.RESTRICTION_TYPE_PHONE, RESTRICTION_TYPE_NON_LOW_END_DEVICE})
     public void testTapExpandNotRemovedFromHistory()
             throws InterruptedException, TimeoutException {
         // Simulate a tap and make sure a URL was loaded.
         simulateTapSearch("search");
         assertEquals(1, mFakeServer.getLoadedUrlCount());
         String url = mFakeServer.getLoadedUrl();
 
         // Expand Panel so that the Content becomes visible.
         tapPeekingBarToExpandAndAssert();
 
         // Close the Panel.
-        tapBasePageToClosePanel();
+        closePanel();
 
         // Now check that the URL has not been removed from history, since the Content was seen.
         assertFalse(mFakeServer.hasRemovedUrl(url));
     }
 
     /**
      * Tests that chained searches without opening the Panel removes all loaded URLs from history.
      */
     @SmallTest
     @Feature({"ContextualSearch"})
@@ skipping 13 matching lines @@
         assertNotSame(url1, url2);
 
         waitToPreventDoubleTapRecognition();
 
         // Simulate another tap and make sure another URL was loaded.
         simulateTapSearch("resolution");
         String url3 = mFakeServer.getLoadedUrl();
         assertNotSame(url2, url3);
 
         // Close the Panel without seeing any Content.
-        tapBasePageToClosePanel();
+        closePanel();
 
         // Now check that all three URLs have been removed from history.
         assertEquals(3, mFakeServer.getLoadedUrlCount());
         assertTrue(mFakeServer.hasRemovedUrl(url1));
         assertTrue(mFakeServer.hasRemovedUrl(url2));
         assertTrue(mFakeServer.hasRemovedUrl(url3));
     }
 
     //============================================================================================
     // Translate Tests
@@ skipping 113 matching lines @@
 
         // Simulate a tap and assert that the panel peeks.
         simulateTapSearch("search");
 
         // Expand the panel and assert that it ends up in the right place.
         tapPeekingBarToExpandAndAssert();
         assertEquals(mManager.getContextualSearchPanel().getHeight(),
                 mManager.getContextualSearchPanel().getPanelHeightFromState(PanelState.EXPANDED));
 
         // Tap the base page and assert that the panel is closed.
-        tapBasePageToClosePanel();
+        closePanel();
     }
 
     /**
      * Tests that the Contextual Search panel is dismissed when entering or exiting fullscreen.
      */
     @SmallTest
     @Feature({"ContextualSearch"})
     @Restriction({RESTRICTION_TYPE_NON_LOW_END_DEVICE})
     public void testPanelDismissedOnToggleFullscreen()
             throws InterruptedException, TimeoutException {
@@ skipping 10 matching lines @@
         // Simulate a tap and assert that the panel peeks.
         simulateTapSearch("search");
 
         // Toggle tab to non-fullscreen.
         FullscreenTestUtils.togglePersistentFullscreenAndAssert(tab, false, getActivity());
 
         // Assert that the panel is closed.
         waitForPanelToClose();
     }
 }