[Telemetry] Replace RunStressMemorey with RunPageInteraction

tools/perf/page_sets/top_25.py

 # Copyright 2014 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.page import page as page_module
 from telemetry.page import page_set as page_set_module
 
 
 def _GetCurrentLocation(action_runner):
   return action_runner.EvaluateJavaScript('document.location.href')
 
@@ skipping 27 matching lines @@
 
   def __init__(self, page_set):
     super(GoogleWebSearchPage, self).__init__(
       url='https://www.google.com/#hl=en&q=barack+obama',
       page_set=page_set)
 
   def RunNavigateSteps(self, action_runner):
     action_runner.NavigateToPage(self)
     action_runner.WaitForElement(text='Next')
 
-  def RunStressMemory(self, action_runner):
+  def RunPageInteractions(self, action_runner):

[tonyg, 2014/10/06 21:06:36]

This was a nice, general purpose page set. But now we're closely coupling it to
the memory measurement's script. Is there another way we can preserve the
generality of page sets like this?

[nednguyen, 2014/10/06 21:40:40]

The coupling already exists with these RunStressMemory function that can be run
if we use memory measurement. 

To me, the real bug that causes the coupling is that we have the mindset "write
a user story A for measurement Y", whereas the better model should be: user
stories describe what user actually do in the real world, and we take various
measurements around each of them.

Even though the URLs are the same, the user stories in this page set are
actually different for memory vs smoothness. This movement will only reduce the
coupling, make the page set *more* general since it allows other measurement to
run user stories with actions which once were only issued in 'RunStressMemory".

[nduca, 2014/10/07 17:46:48]

backin gup... maybe the thing to think of here is that a user story has a single
run method... you call run on it and it runs the story. start to finish.

so, a user story set is a list of many stories. some scroll. some just navigate.
some just open and close gmail.

pagesets are just sets of user stories about web pages.


right now we have "one page can has many stories in it" --- thats the core thing
I think we want to do away with. Rather, if you want the same URL to be
scrollable and be able to open/close discard, then make it have two user
stories.


some measurements make no sense on some kinds of stories. e.g. there's no point
in calculating memory levels on smoothness. so, then you need a mechanism to
tell if a story is useful to a measurement. i think that's whats being lost in
this refactoring --- ned, how does memory measurement's canRunForPage know that
a page stresses memory?

     interaction = action_runner.BeginGestureInteraction(
         'ScrollAction', is_smooth=True)
     action_runner.ScrollPage()
     interaction.End()
     old_href = _GetCurrentLocation(action_runner)
     action_runner.ClickElement(text='Next')
     _WaitForLocationChange(action_runner, old_href)
     action_runner.WaitForElement(text='Next')
     interaction = action_runner.BeginGestureInteraction(
         'ScrollAction', is_smooth=True)
@@ skipping 55 matching lines @@
       page_set=page_set)
 
     self.credentials = 'google'
 
   def RunNavigateSteps(self, action_runner):
     action_runner.NavigateToPage(self)
     action_runner.WaitForJavaScriptCondition(
         'window.gmonkey !== undefined &&'
         'document.getElementById("gb") !== null')
 
-  def RunStressMemory(self, action_runner):
+  def RunPageInteractions(self, action_runner):
     old_href = _GetCurrentLocation(action_runner)
     action_runner.ClickElement(
         'a[href="https://mail.google.com/mail/u/0/?shva=1#starred"]')
     _WaitForLocationChange(action_runner, old_href)
     old_href = _GetCurrentLocation(action_runner)
     action_runner.ClickElement(
         'a[href="https://mail.google.com/mail/u/0/?shva=1#inbox"]')
     _WaitForLocationChange(action_runner, old_href)
 
   def RunSmoothness(self, action_runner):

[tonyg, 2014/10/06 21:06:36]

Case-in point, I'm not sure how we're going to handle these two different sets
of actions with this approach.

[nednguyen, 2014/10/06 21:40:41]

In the short term, we will keep the general top_25 for smoothness, repaint ...
and other metrics that are already migrated to timeline based measurement. For
memory, we can make a top_25_memory_intensive page set. 

Once we move memory to timeline based measurement, then we can consider either
change memory benchmark to use the top_25 that other measurements use, or extend
the pages in top_25 to include memory intensive scenarios.

     action_runner.ExecuteJavaScript('''
         gmonkey.load('2.0', function(api) {
           window.__scrollableElementForTelemetry = api.getScrollableElement();
         });''')
     action_runner.WaitForJavaScriptCondition(
         'window.__scrollableElementForTelemetry != null')
     interaction = action_runner.BeginGestureInteraction(
         'ScrollAction', is_smooth=True)
     action_runner.ScrollElement(
         element_function='window.__scrollableElementForTelemetry')
@@ skipping 17 matching lines @@
     action_runner.WaitForElement('div[class~="navForward"]')
     action_runner.ExecuteJavaScript('''
         (function() {
           var elem = document.createElement('meta');
           elem.name='viewport';
           elem.content='initial-scale=1';
           document.body.appendChild(elem);
         })();''')
     action_runner.Wait(1)
 
-  def RunStressMemory(self, action_runner):
+  def RunPageInteractions(self, action_runner):
     action_runner.ClickElement('div[class~="navForward"]')
     action_runner.Wait(2)
     action_runner.WaitForElement('div[class~="navForward"]')
     action_runner.ClickElement('div[class~="navForward"]')
     action_runner.Wait(2)
     action_runner.WaitForElement('div[class~="navForward"]')
     action_runner.ClickElement('div[class~="navForward"]')
     action_runner.Wait(2)
     action_runner.WaitForElement('div[class~="navForward"]')
     action_runner.ClickElement('div[class~="navForward"]')
@@ skipping 65 matching lines @@
     super(GooglePlusPage, self).__init__(
       url='https://plus.google.com/110031535020051778989/posts',
       page_set=page_set)
 
     self.credentials = 'google'
 
   def RunNavigateSteps(self, action_runner):
     action_runner.NavigateToPage(self)
     action_runner.WaitForElement(text='Home')
 
-  def RunStressMemory(self, action_runner):
+  def RunPageInteractions(self, action_runner):
     action_runner.ClickElement(text='Home')
     action_runner.Wait(2)
     action_runner.WaitForElement(text='Profile')
     action_runner.ClickElement(text='Profile')
     action_runner.Wait(2)
     action_runner.WaitForElement(text='Explore')
     action_runner.ClickElement(text='Explore')
     action_runner.Wait(2)
     action_runner.WaitForElement(text='Events')
     action_runner.ClickElement(text='Events')
@@ skipping 34 matching lines @@
   def __init__(self, page_set):
     super(BlogspotPage, self).__init__(
       url='http://googlewebmastercentral.blogspot.com/',
       page_set=page_set,
       name='Blogger')
 
   def RunNavigateSteps(self, action_runner):
     action_runner.NavigateToPage(self)
     action_runner.WaitForElement(text='accessibility')
 
-  def RunStressMemory(self, action_runner):
+  def RunPageInteractions(self, action_runner):
     action_runner.ClickElement(text='accessibility')
     action_runner.WaitForNavigate()
     interaction = action_runner.BeginGestureInteraction(
         'ScrollAction', is_smooth=True)
     action_runner.ScrollPage()
     interaction.End()
     action_runner.ClickElement(text='advanced')
     action_runner.WaitForNavigate()
     interaction = action_runner.BeginGestureInteraction(
         'ScrollAction', is_smooth=True)
@@ skipping 19 matching lines @@
       url='http://en.blog.wordpress.com/2012/09/04/freshly-pressed-editors-picks-for-august-2012/',
       page_set=page_set,
       name='Wordpress')
 
   def RunNavigateSteps(self, action_runner):
     action_runner.NavigateToPage(self)
     action_runner.WaitForElement(
         # pylint: disable=C0301
         'a[href="http://en.blog.wordpress.com/2012/08/30/new-themes-able-and-sight/"]')
 
-  def RunStressMemory(self, action_runner):
+  def RunPageInteractions(self, action_runner):
     interaction = action_runner.BeginGestureInteraction(
         'ScrollAction', is_smooth=True)
     action_runner.ScrollPage()
     interaction.End()
     action_runner.ClickElement(
         # pylint: disable=C0301
         'a[href="http://en.blog.wordpress.com/2012/08/30/new-themes-able-and-sight/"]')
     action_runner.WaitForNavigate()
     interaction = action_runner.BeginGestureInteraction(
         'ScrollAction', is_smooth=True)
@@ skipping 21 matching lines @@
     super(FacebookPage, self).__init__(
       url='http://www.facebook.com/barackobama',
       page_set=page_set,
       name='Facebook')
     self.credentials = 'facebook'
 
   def RunNavigateSteps(self, action_runner):
     action_runner.NavigateToPage(self)
     action_runner.WaitForElement(text='About')
 
-  def RunStressMemory(self, action_runner):
+  def RunPageInteractions(self, action_runner):
     action_runner.ClickElement(text='About')
     action_runner.WaitForNavigate()
     action_runner.ClickElement(text='The Audacity of Hope')
     action_runner.WaitForNavigate()
     action_runner.ClickElement(text='Back to Barack Obama\'s Timeline')
     action_runner.WaitForNavigate()
     action_runner.ClickElement(text='About')
     action_runner.WaitForNavigate()
     action_runner.ClickElement(text='Elected to U.S. Senate')
     action_runner.WaitForNavigate()
@@ skipping 154 matching lines @@
       # Why: #1 Alexa reference
       'http://answers.yahoo.com',
       # Why: #1 Alexa sports
       'http://sports.yahoo.com/',
       # Why: top tech blog
       'http://techcrunch.com'
     ]
 
     for url in other_urls:
       self.AddPage(Top25Page(url, self))