smoothness.scrolling_tough_ad_cases to use browser driven scrolls

tools/perf/page_sets/tough_ad_cases.py

 # 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.
 
-from telemetry.core import exceptions
+from page_sets import repeatable_synthesize_scroll_gesture_shared_state
+
 from telemetry.page import page as page_module
+from telemetry.web_perf import timeline_interaction_record
 from telemetry import story
 
 
 class SwiffyPage(page_module.Page):
 
   def __init__(self, url, page_set):
     super(SwiffyPage, self).__init__(url=url, page_set=page_set,
                                      make_javascript_deterministic=False)
 
   def RunNavigateSteps(self, action_runner):
@@ skipping 11 matching lines @@
     action_runner.EvaluateJavaScript(viewport_js)
 
   def RunPageInteractions(self, action_runner):
     with action_runner.CreateInteraction('ToughAd'):
       action_runner.Wait(10)
 
 
 class ScrollingPage(page_module.Page):
 
   def __init__(self, url, page_set, top_start_ratio=.5,
-               make_javascript_deterministic=True):
-    super(ScrollingPage, self).__init__(url=url, page_set=page_set,
-        make_javascript_deterministic=make_javascript_deterministic)
+               make_javascript_deterministic=True, scroll_multiplier=0.5):

[Sami, 2015/08/19 11:54:46]

What does it mean to scroll .5 times?-)

[alex clarke (OOO till 29th), 2015/08/19 15:40:58]

It's a distance multiplier, hopefully that is more obvious now.

+    super(ScrollingPage, self).__init__(
+        url=url,
+        page_set=page_set,
+        make_javascript_deterministic=make_javascript_deterministic,
+        shared_page_state_class=(
+            repeatable_synthesize_scroll_gesture_shared_state.\
+                RepeatableSynthesizeScrollGestureSharedState))
     self._top_start_ratio = top_start_ratio
+    self._scroll_multiplier = scroll_multiplier
+    self._screensize = []
 
   def RunNavigateSteps(self, action_runner):
     # Rewrite file urls to point to the replay server instead.
     if self.is_file:
       url = self.file_path_url_with_scheme
       url = action_runner.tab.browser.http_server.UrlOf(url[len('file://'):])
     else:
       url = self._url
     action_runner.tab.Navigate(url)
 
-    # Give the page one second to become interactive and start scrolling after
-    # the timeout regardless of the document's ready state.
-    try:
-      action_runner.tab.WaitForDocumentReadyStateToBeInteractiveOrBetter(1)
-    except exceptions.TimeoutException:
-      pass
-    # Wait for the document to have a body so that we can scroll.
-    # Simultaneously (to reduce latency), insert a no-op touch handler on the
-    # body. Most ads have touch handlers and we want to simulate the worst case
-    # of the user trying to scroll the page by grabbing an ad.
+    # Wait for the page to be scrollable.
     action_runner.WaitForJavaScriptCondition(
-        '!(document.body == null || '
-        '  document.body.addEventListener("touchstart", function() {}))')
+        'document.body != null && '
+        'document.body.scrollHeight > window.screen.height')
+
+    # Get the dimensions of the screen. Simultaneously (to reduce latency),
+    # insert a no-op touch handler on the body. Most ads have touch handlers
+    # and we want to simulate the worst case of the user trying to scroll the
+    # page by grabbing an ad.
+    js_result = action_runner.EvaluateJavaScript(
+        'window.screen.availWidth + "," + window.screen.availHeight + "," + '
+        '(document.body.addEventListener("touchstart", function() {}) ? 1 : 0)')
+    self._screensize = [int(n) for n in js_result.split(',')]
+
 
   def RunPageInteractions(self, action_runner):
-    for _ in range(10):
-      with action_runner.CreateGestureInteraction('ScrollAction',
-                                                  repeatable=True):
-        action_runner.ScrollPage(distance=500,
-                                 top_start_ratio=self._top_start_ratio)
-      action_runner.Wait(.25)
+    scroll_distance = int(self._scroll_multiplier * self._screensize[1])
 
+    # Set up a browser driven repeating scroll. The delay between the scrolls
+    # should be unaffected by render thread responsivness (or lack there of).
+    action_runner.tab.SynthesizeScrollGesture(
+        x=int(self._screensize[0] / 2),
+        y=self._screensize[1] - int(self._screensize[1] * 0.25),
+        xDistance=0,
+        yDistance=-scroll_distance,
+        repeatCount=9,
+        repeatDelayMs=250,
+        interactionMarkerName=timeline_interaction_record.GetJavaScriptMarker(
+            'Gesture_ScrollAction', [timeline_interaction_record.REPEATABLE]))
 
 class ScrollingForbesPage(ScrollingPage):
 
   def __init__(self, url, page_set):
     # forbes.com uses a strange dynamic transform on the body element,
     # which occasionally causes us to try scrolling from outside the
     # screen. Start at the very top of the viewport to avoid this.
     super(ScrollingForbesPage, self).__init__(
         url=url, page_set=page_set, top_start_ratio=0,
         make_javascript_deterministic=False)
@@ skipping 37 matching lines @@
 
 class ScrollingToughAdCasesPageSet(story.StorySet):
   """Pages for measuring scrolling performance with advertising content."""
 
   def __init__(self):
     super(ScrollingToughAdCasesPageSet, self).__init__(
         archive_data_file='data/tough_ad_cases.json',
         cloud_storage_bucket=story.INTERNAL_BUCKET)
 
     self.AddStory(ScrollingPage('file://tough_ad_cases/'
-        'swiffy_collection.html', self, make_javascript_deterministic=False))
+        'swiffy_collection.html', self, make_javascript_deterministic=False,
+        scroll_multiplier=0.25))
     self.AddStory(ScrollingPage('http://www.latimes.com', self))
     self.AddStory(ScrollingForbesPage('http://www.forbes.com/sites/parmyolson/'
         '2015/07/29/jana-mobile-data-facebook-internet-org/', self))
     self.AddStory(ScrollingPage('http://androidcentral.com', self))
     self.AddStory(ScrollingPage('http://mashable.com', self, top_start_ratio=0))
     self.AddStory(ScrollingPage('http://www.androidauthority.com/'
         'reduce-data-use-turn-on-data-compression-in-chrome-630064/', self))
     self.AddStory(ScrollingPage('http://www.cnn.com/2015/01/09/politics/'
         'nebraska-keystone-pipeline/index.html', self, top_start_ratio=0))
     # Disabled: crbug.com/520509
     #self.AddStory(ScrollingPage('http://time.com/3977891/'
     #    'donald-trump-debate-republican/', self))
     self.AddStory(ScrollingPage('http://www.theguardian.com/uk', self))
-    self.AddStory(ScrollingPage('http://m.tmz.com', self))
+    self.AddStory(ScrollingPage('http://m.tmz.com', self,
+        scroll_multiplier=0.25))
     self.AddStory(ScrollingPage('http://androidpolice.com', self,
         top_start_ratio=0))