[system health] Add media browsing stories.

tools/perf/page_sets/system_health/browsing_stories.py

 # Copyright 2016 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 page_sets.login_helpers import facebook_login
 from page_sets.system_health import platforms
 from page_sets.system_health import system_health_story
 
 
 class _BrowsingStory(system_health_story.SystemHealthStory):
   """Abstract base class for browsing stories.
 
   A browsing story visits items on the main page. Subclasses provide
   CSS selector to identify the items and implement interaction using
   the helper methods of this class.
   """
 
   IS_SINGLE_PAGE_APP = False
   ITEM_SELECTOR = NotImplemented
-  ITEMS_TO_VISIT = 4
   ABSTRACT_STORY = True
 
   def _WaitForNavigation(self, action_runner):
     if not self.IS_SINGLE_PAGE_APP:
       action_runner.WaitForNavigate()
 
   def _NavigateToItem(self, action_runner, index):
     item_selector = 'document.querySelectorAll("%s")[%d]' % (
         self.ITEM_SELECTOR, index)
     self._ClickLink(action_runner, item_selector)
 
   def _ClickLink(self, action_runner, element_function):
     action_runner.WaitForElement(element_function=element_function)
     action_runner.ClickElement(element_function=element_function)
     self._WaitForNavigation(action_runner)
 
   def _NavigateBack(self, action_runner):
     action_runner.ExecuteJavaScript('window.history.back()')
     self._WaitForNavigation(action_runner)
 
 
+##############################################################################
+# News browsing stories.
+##############################################################################
+
+
 class _NewsBrowsingStory(_BrowsingStory):
   """Abstract base class for news user stories.
 
   A news story imitates browsing a news website:
   1. Load the main page.
   2. Open and scroll the first news item.
   3. Go back to the main page and scroll it.
   4. Open and scroll the second news item.
   5. Go back to the main page and scroll it.
   6. etc.
   """
 
   ITEM_READ_TIME_IN_SECONDS = 3
   ITEM_SCROLL_REPEAT = 2
+  ITEMS_TO_VISIT = 4
   MAIN_PAGE_SCROLL_REPEAT = 0
   ABSTRACT_STORY = True
 
   def _DidLoadDocument(self, action_runner):
     for i in xrange(self.ITEMS_TO_VISIT):
       self._NavigateToItem(action_runner, i)
       self._ReadNewsItem(action_runner)
       self._NavigateBack(action_runner)
       self._ScrollMainPage(action_runner)
 
   def _ReadNewsItem(self, action_runner):
     action_runner.tab.WaitForDocumentReadyStateToBeComplete()
     action_runner.Wait(self.ITEM_READ_TIME_IN_SECONDS)
     action_runner.RepeatableBrowserDrivenScroll(
         repeat_count=self.ITEM_SCROLL_REPEAT)
 
   def _ScrollMainPage(self, action_runner):
     action_runner.tab.WaitForDocumentReadyStateToBeComplete()
     action_runner.RepeatableBrowserDrivenScroll(
         repeat_count=self.MAIN_PAGE_SCROLL_REPEAT)
 
 
-##############################################################################
-# News browsing stories.
-##############################################################################
-
-
 class CnnStory(_NewsBrowsingStory):
   """The second top website in http://www.alexa.com/topsites/category/News"""
   NAME = 'browse:news:cnn'
   URL = 'http://edition.cnn.com/'
   ITEM_SELECTOR = '.cd__content > h3 > a'
   ITEMS_TO_VISIT = 2
   # TODO(ulan): Enable this story on mobile once it uses less memory and
   # does not crash with OOM.
   SUPPORTED_PLATFORMS = platforms.DESKTOP_ONLY
 
@@ skipping 113 matching lines @@
   def _DidLoadDocument(self, action_runner):
     # Close the popup window. On Nexus 9 (and probably other tables) the popup
     # window does not have a "Close" button, instead it has only a "Send link
     # to phone" button. So on tablets we run with the popup window open. The
     # popup is transparent, so this is mostly an aesthetical issue.
     has_button = action_runner.EvaluateJavaScript(
         '!!document.querySelector("%s")' % self._CLOSE_BUTTON_SELECTOR)
     if has_button:
       action_runner.ClickElement(selector=self._CLOSE_BUTTON_SELECTOR)
     super(WashingtonPostMobileStory, self)._DidLoadDocument(action_runner)
+
+
+##############################################################################
+# Media browsing stories.
+##############################################################################
+
+
+class _MediaBrowsingStory(_BrowsingStory):
+  """Abstract base class for media user stories
+
+  A media story imitates browsing a website with photo or video content:
+  1. Load a page showing a media item
+  2. Click on the next link to go to the next media item
+  3. etc.
+  """
+
+  ABSTRACT_STORY = True
+  ITEM_VIEW_TIME_IN_SECONDS = 3
+  ITEMS_TO_VISIT = 15
+  ITEM_SELECTOR_INDEX = 0
+
+  def _DidLoadDocument(self, action_runner):
+    for _ in xrange(self.ITEMS_TO_VISIT):
+      self._NavigateToItem(action_runner, self.ITEM_SELECTOR_INDEX)
+      self._ViewMediaItem(action_runner)
+
+  def _ViewMediaItem(self, action_runner):
+    action_runner.tab.WaitForDocumentReadyStateToBeComplete()
+    action_runner.Wait(self.ITEM_VIEW_TIME_IN_SECONDS)
+
+
+class ImgurMobileStory(_MediaBrowsingStory):
+  NAME = 'browse:media:imgur'
+  URL = 'http://imgur.com/gallery/5UlBN'
+  ITEM_SELECTOR = '.Navbar-customAction'
+  SUPPORTED_PLATFORMS = platforms.MOBILE_ONLY
+  IS_SINGLE_PAGE_APP = True
+
+
+class ImgurDesktopStory(_MediaBrowsingStory):
+  NAME = 'browse:media:imgur'
+  URL = 'http://imgur.com/gallery/5UlBN'
+  ITEM_SELECTOR = '.navNext'
+  SUPPORTED_PLATFORMS = platforms.DESKTOP_ONLY
+  IS_SINGLE_PAGE_APP = True
+
+
+class YouTubeMobileStory(_MediaBrowsingStory):
+  NAME = 'browse:media:youtube'
+  URL = 'https://m.youtube.com/watch?v=QGfhS1hfTWw&autoplay=false'

[petrcermak, 2016/08/05 10:30:46]

Could you please update the loading stories to use this URL as well (you can do
that by simply reusing the WPR archive like you did with imgur)?

[petrcermak, 2016/08/05 10:32:08]

Please ignore this comment. I've just realized that these already are the same
URLs O:-)

[Hannes Payer (out of office), 2016/08/05 11:13:07]

Acknowledged.

+  ITEM_SELECTOR = '._mhgb > a'
+  SUPPORTED_PLATFORMS = platforms.MOBILE_ONLY
+  IS_SINGLE_PAGE_APP = True
+  ITEM_SELECTOR_INDEX = 3
+
+
+class YouTubeDesktopStory(_MediaBrowsingStory):
+  NAME = 'browse:media:youtube'
+  URL = 'https://www.youtube.com/watch?v=QGfhS1hfTWw&autoplay=false'
+  ITEM_SELECTOR = '.yt-uix-simple-thumb-related'
+  SUPPORTED_PLATFORMS = platforms.DESKTOP_ONLY
+  IS_SINGLE_PAGE_APP = True
+  # A longer view time allows videos to load and play.
+  ITEM_VIEW_TIME_IN_SECONDS = 5
+  ITEMS_TO_VISIT = 8
+  ITEM_SELECTOR_INDEX = 3
+
+
+class FacebookMobileStory(_MediaBrowsingStory):
+  NAME = 'browse:media:facebook_photos'

[petrcermak, 2016/08/05 10:30:46]

Could you please add facebook_photos loading stories (again, you can reuse the
WPR archive for the browsing ones)? We want to make sure that we have a loading
story for each browsing story.

[Hannes Payer (out of office), 2016/08/05 11:13:07]

This is why I navigate to the regular page before. See comment below.

I do not think that adding an additional facebook photo load story adds much
value. WDYT?

+  URL = (
+      'https://m.facebook.com/rihanna/photos/a.207477806675.138795.10092511675/10153911739606676/?type=3&source=54&ref=page_internal')
+  ITEM_SELECTOR = '._57-p > a'
+  SUPPORTED_PLATFORMS = platforms.MOBILE_ONLY
+  IS_SINGLE_PAGE_APP = True
+  ITEM_SELECTOR_INDEX = 1
+
+  def _Login(self, action_runner):
+    action_runner.Navigate('https://m.facebook.com/rihanna')

[petrcermak, 2016/08/05 10:30:46]

Why do you have this _Login hook at all? It just adds an unnecessary navigation
to https://m.facebook.com/rihanna. The story will automatically navigate to the
URL on line 286
(https://m.facebook.com/rihanna/photos/a.207477806675.138795.10092511675/10153...).

If there is a genuine reason for it, please document it in a comment. Otherwise,
please remove this hook completely.

[Hannes Payer (out of office), 2016/08/05 11:13:07]

To make it comparable to the load story. With that it will go to the page of the
load story first and will then start opening photos and clicking through them. I
am happy to remove it if you think that it is not necessary. 

[petrcermak, 2016/08/08 13:52:16]

That makes the mobile and desktop browsing stories inconsistent though:

  Mobile: 1) go to https://m.facebook.com/rihanna
          2) go to https://m.facebook.com/rihanna/photos/...

  Desktop: 1) log into Facebook
           2) go to https://www.facebook.com/rihanna/photos/...

Unless this is necessary for some reason, could you please:

* Either login or don't login in *all* Facebook stories (load, browse, mobile,
desktop), or describe why this is not possible.
* Either navigate to https://m.facebook.com/rihanna in both browsing stories, or
change the loading story to show
https://m.facebook.com/rihanna/photos/a.207477806675.138795.10092511675/10153....
In either case, the loading stories should be able to reuse the WPR of the
browsing stories.

[Hannes Payer (out of office), 2016/08/08 16:47:28]

I unified the facebook login and reuse the story also for load.

+    action_runner.tab.WaitForDocumentReadyStateToBeComplete()
+
+
+class FacebookDesktopStory(_MediaBrowsingStory):
+  NAME = 'browse:media:facebook_photos'
+  URL = (
+      'https://www.facebook.com/rihanna/photos/a.207477806675.138795.10092511675/10153911739606676/?type=3&theater')
+  ITEM_SELECTOR = '.snowliftPager.next'
+  # Recording currently does not work. The page gets stuck in the
+  # theater viewer.
+  SUPPORTED_PLATFORMS = platforms.NO_PLATFORMS
+  IS_SINGLE_PAGE_APP = True
+
+  def _Login(self, action_runner):
+    facebook_login.LoginWithDesktopSite(action_runner, 'facebook3',
+                                self.credentials_path)

[petrcermak, 2016/08/05 10:30:46]

nit: this should be indented so that it's vertically aligned with
"action_runner":

    facebook_login.LoginWithDesktopSite(action_runner, 'facebook3',
                                        self.credentials_path)
                                        ^
                                        |

[Hannes Payer (out of office), 2016/08/05 11:13:07]

Done.