tools/perf/page_sets/polymer.py

   1 # Copyright 2014 The Chromium Authors. All rights reserved.
   2 # Use of this source code is governed by a BSD-style license that can be
   3 # found in the LICENSE file.
   4 from telemetry.page import page as page_module
   5 from telemetry.page import page_set as page_set_module
   6
   7 class PolymerPage(page_module.Page):
   8
   9   def __init__(self, url, page_set, run_no_page_interactions):
  10     """ Base class for all polymer pages.
  11
  12     Args:
  13       run_no_page_interactions: whether the page will run any interactions after
  14         navigate steps.
  15     """
  16     super(PolymerPage, self).__init__(
  17       url=url,
  18       page_set=page_set)
  19     self.script_to_evaluate_on_commit = '''
  20       document.addEventListener("polymer-ready", function() {
  21         window.__polymer_ready = true;
  22       });
  23     '''
  24     self._run_no_page_interactions = run_no_page_interactions
  25
  26   def RunPageInteractions(self, action_runner):
  27     # If a polymer page wants to customize its actions, it should
  28     # override the PerformPageInteractions method instead of this method.
  29     if self._run_no_page_interactions:
  30       return
  31     self.PerformPageInteractions(action_runner)
  32
  33   def PerformPageInteractions(self, action_runner):
  34     """ Override this to perform actions after the page has navigated. """
  35     pass
  36
  37   def RunNavigateSteps(self, action_runner):
  38     super(PolymerPage, self).RunNavigateSteps(action_runner)
  39     action_runner.WaitForJavaScriptCondition(
  40         'window.__polymer_ready')
  41
  42
  43 class PolymerCalculatorPage(PolymerPage):
  44
  45   def __init__(self, page_set, run_no_page_interactions):
  46     super(PolymerCalculatorPage, self).__init__(
  47       url=('http://www.polymer-project.org/components/paper-calculator/'
  48           'demo.html'),
  49       page_set=page_set, run_no_page_interactions=run_no_page_interactions)
  50
  51   def PerformPageInteractions(self, action_runner):
  52     self.TapButton(action_runner)
  53     self.SlidePanel(action_runner)
  54
  55   def TapButton(self, action_runner):
  56     with action_runner.CreateInteraction('PolymerAnimation', repeatable=True):
  57       action_runner.TapElement(element_function='''
  58           document.querySelector(
  59               'body /deep/ #outerPanels'
  60           ).querySelector(
  61               '#standard'
  62           ).shadowRoot.querySelector(
  63               'paper-calculator-key[label="5"]'
  64           )''')
  65       action_runner.Wait(2)
  66
  67   def SlidePanel(self, action_runner):
  68     # only bother with this interaction if the drawer is hidden
  69     opened = action_runner.EvaluateJavaScript('''
  70         (function() {
  71           var outer = document.querySelector("body /deep/ #outerPanels");
  72           return outer.opened || outer.wideMode;
  73           }());''')
  74     if not opened:
  75       with action_runner.CreateInteraction('PolymerAnimation', repeatable=True):
  76         action_runner.SwipeElement(
  77             left_start_ratio=0.1, top_start_ratio=0.2,
  78             direction='left', distance=300, speed_in_pixels_per_second=5000,
  79             element_function='''
  80                 document.querySelector(
  81                   'body /deep/ #outerPanels'
  82                 ).querySelector(
  83                   '#advanced'
  84                 ).shadowRoot.querySelector(
  85                   '.handle-bar'
  86                 )''')
  87         action_runner.WaitForJavaScriptCondition('''
  88             var outer = document.querySelector("body /deep/ #outerPanels");
  89             outer.opened || outer.wideMode;''')
  90
  91
  92 class PolymerShadowPage(PolymerPage):
  93
  94   def __init__(self, page_set, run_no_page_interactions):
  95     super(PolymerShadowPage, self).__init__(
  96       url='http://www.polymer-project.org/components/paper-shadow/demo.html',
  97       page_set=page_set, run_no_page_interactions=run_no_page_interactions)
  98
  99   def PerformPageInteractions(self, action_runner):
 100     with action_runner.CreateInteraction('ScrollAndShadowAnimation'):
 101       action_runner.ExecuteJavaScript(
 102           "document.getElementById('fab').scrollIntoView()")
 103       action_runner.Wait(5)
 104       self.AnimateShadow(action_runner, 'card')
 105       #FIXME(wiltzius) disabling until this issue is fixed:
 106       # https://github.com/Polymer/paper-shadow/issues/12
 107       #self.AnimateShadow(action_runner, 'fab')
 108
 109   def AnimateShadow(self, action_runner, eid):
 110     for i in range(1, 6):
 111       action_runner.ExecuteJavaScript(
 112           'document.getElementById("{0}").z = {1}'.format(eid, i))
 113       action_runner.Wait(1)
 114
 115
 116 class PolymerSampler(PolymerPage):
 117
 118   def __init__(self, page_set, anchor, run_no_page_interactions,
 119                scrolling_page=False):
 120     """Page exercising interactions with a single Paper Sampler subpage.
 121
 122     Args:
 123       page_set: Page set to inforporate this page into.
 124       anchor: string indicating which subpage to load (matches the element
 125           type that page is displaying)
 126       scrolling_page: Whether scrolling the content pane is relevant to this
 127           content page or not.
 128     """
 129     super(PolymerSampler, self).__init__(
 130       url=('http://www.polymer-project.org/components/%s/demo.html' % anchor),
 131       page_set=page_set, run_no_page_interactions=run_no_page_interactions)
 132     self.scrolling_page = scrolling_page
 133     self.iframe_js = 'document'
 134
 135   def RunNavigateSteps(self, action_runner):
 136     super(PolymerSampler, self).RunNavigateSteps(action_runner)
 137     waitForLoadJS = """
 138       window.Polymer.whenPolymerReady(function() {
 139         %s.contentWindow.Polymer.whenPolymerReady(function() {
 140           window.__polymer_ready = true;
 141         })
 142       });
 143       """ % self.iframe_js
 144     action_runner.ExecuteJavaScript(waitForLoadJS)
 145     action_runner.WaitForJavaScriptCondition(
 146         'window.__polymer_ready')
 147
 148   def PerformPageInteractions(self, action_runner):
 149     #TODO(wiltzius) Add interactions for input elements and shadow pages
 150     if self.scrolling_page:
 151       # Only bother scrolling the page if its been marked as worthwhile
 152       self.ScrollContentPane(action_runner)
 153     self.TouchEverything(action_runner)
 154
 155   def ScrollContentPane(self, action_runner):
 156     element_function = (self.iframe_js + '.querySelector('
 157         '"core-scroll-header-panel").$.mainContainer')
 158     with action_runner.CreateInteraction('Scroll_Page', repeatable=True):
 159       action_runner.ScrollElement(use_touch=True,
 160                                   direction='down',
 161                                   distance='900',
 162                                   element_function=element_function)
 163     with action_runner.CreateInteraction('Scroll_Page', repeatable=True):
 164       action_runner.ScrollElement(use_touch=True,
 165                                   direction='up',
 166                                   distance='900',
 167                                   element_function=element_function)
 168
 169   def TouchEverything(self, action_runner):
 170     tappable_types = [
 171         'paper-button',
 172         'paper-checkbox',
 173         'paper-fab',
 174         'paper-icon-button',
 175         # crbug.com/394756
 176         # 'paper-radio-button',
 177         'paper-tab',
 178         'paper-toggle-button',
 179         'x-shadow',
 180         ]
 181     for tappable_type in tappable_types:
 182       self.DoActionOnWidgetType(action_runner, tappable_type, self.TapWidget)
 183     swipeable_types = ['paper-slider']
 184     for swipeable_type in swipeable_types:
 185       self.DoActionOnWidgetType(action_runner, swipeable_type, self.SwipeWidget)
 186
 187   def DoActionOnWidgetType(self, action_runner, widget_type, action_function):
 188     # Find all widgets of this type, but skip any that are disabled or are
 189     # currently active as they typically don't produce animation frames.
 190     element_list_query = (self.iframe_js +
 191         ('.querySelectorAll("body %s:not([disabled]):'
 192          'not([active])")' % widget_type))
 193     roles_count_query = element_list_query + '.length'
 194     for i in range(action_runner.EvaluateJavaScript(roles_count_query)):
 195       element_query = element_list_query + ("[%d]" % i)
 196       if action_runner.EvaluateJavaScript(
 197           element_query + '.offsetParent != null'):
 198         # Only try to tap on visible elements (offsetParent != null)
 199         action_runner.ExecuteJavaScript(element_query + '.scrollIntoView()')
 200         action_runner.Wait(1) # wait for page to settle after scrolling
 201         action_function(action_runner, element_query)
 202
 203   def TapWidget(self, action_runner, element_function):
 204     with action_runner.CreateInteraction('Tap_Widget', repeatable=True):
 205       action_runner.TapElement(element_function=element_function)
 206       action_runner.Wait(1) # wait for e.g. animations on the widget
 207
 208   def SwipeWidget(self, action_runner, element_function):
 209     with action_runner.CreateInteraction('Swipe_Widget'):
 210       action_runner.SwipeElement(element_function=element_function,
 211                                  left_start_ratio=0.75,
 212                                  speed_in_pixels_per_second=300)
 213
 214
 215 class PolymerPageSet(page_set_module.PageSet):
 216
 217   def __init__(self, run_no_page_interactions=False):
 218     super(PolymerPageSet, self).__init__(
 219       user_agent_type='mobile',
 220       archive_data_file='data/polymer.json',
 221       bucket=page_set_module.PUBLIC_BUCKET)
 222
 223     self.AddUserStory(PolymerCalculatorPage(self, run_no_page_interactions))
 224     self.AddUserStory(PolymerShadowPage(self, run_no_page_interactions))
 225
 226     # Polymer Sampler subpages that are interesting to tap / swipe elements on
 227     TAPPABLE_PAGES = [
 228         'paper-button',
 229         'paper-checkbox',
 230         'paper-fab',
 231         'paper-icon-button',
 232         # crbug.com/394756
 233         # 'paper-radio-button',
 234         #FIXME(wiltzius) Disabling x-shadow until this issue is fixed:
 235         # https://github.com/Polymer/paper-shadow/issues/12
 236         #'paper-shadow',
 237         'paper-tabs',
 238         'paper-toggle-button',
 239         ]
 240     for p in TAPPABLE_PAGES:
 241       self.AddUserStory(PolymerSampler(
 242           self, p, run_no_page_interactions=run_no_page_interactions))
 243
 244     # Polymer Sampler subpages that are interesting to scroll
 245     SCROLLABLE_PAGES = [
 246         'core-scroll-header-panel',
 247         ]
 248     for p in SCROLLABLE_PAGES:
 249       self.AddUserStory(PolymerSampler(
 250           self, p, run_no_page_interactions=run_no_page_interactions,
 251           scrolling_page=True))
 252
 253     for page in self:
 254       assert (page.__class__.RunPageInteractions ==
 255               PolymerPage.RunPageInteractions), (
 256               'Pages in this page set must not override PolymerPage\' '
 257               'RunPageInteractions method.')