[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 mobile_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.
@@ skipping 16 matching lines @@
   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)
 
 
 class _NewsBrowsingStory(_BrowsingStory):

[petrcermak, 2016/07/21 19:38:42]

I suggest you move the _NewsBrowsingStory and _MediaBrowsingStory subclasses to
the relevant sections of this file (under the "######..." comments).

[Hannes Payer (out of office), 2016/07/26 16:02:09]

Done.

   """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.
   """
@@ skipping 13 matching lines @@
   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)
 

[petrcermak, 2016/07/21 19:38:42]

nit: add extra blank line (I added justification in a comment below)

[Hannes Payer (out of office), 2016/07/26 16:02:09]

Done.

+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 = 1
+  ITEMS_TO_VISIT = 30
+
+  def _DidLoadDocument(self, action_runner):
+    for i in xrange(self.ITEMS_TO_VISIT):
+      self._NavigateToItem(action_runner, self._ItemSelector(i))

[petrcermak, 2016/07/21 19:38:42]

Why do you define the _ItemSelector method when you always ignore the argument?
I would suggest defining an ITEM_SELECTOR_INDEX class constant instead.

Even better, you use non-zero indices in only two places. Is there any chance
you could somehow push the index into the selector (so that you could always
pass `0` here)? If it would make the selectors too complicated, I suggest you
set ITEM_SELECTOR_INDEX = 0 as default and override it only when necessary.

[Hannes Payer (out of office), 2016/07/26 16:02:09]

Done. That is was leftover code experimenting with different selector
strategies.

+      self._ViewMediaItem(action_runner)
+
+  def _ViewMediaItem(self, action_runner):
+    action_runner.tab.WaitForDocumentReadyStateToBeComplete()
+    action_runner.Wait(self.ITEM_VIEW_TIME_IN_SECONDS)
+
 
 ##############################################################################
 # 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/'
@@ skipping 84 matching lines @@
   NAME = 'browse:news:washingtonpost'
   URL = 'https://www.washingtonpost.com/pwa'
   IS_SINGLE_PAGE_APP = True
   ITEM_SELECTOR = '.hed > a'
   SUPPORTED_PLATFORMS = platforms.MOBILE_ONLY
 
   def _DidLoadDocument(self, action_runner):
     # Close the popup window.
     action_runner.ClickElement(selector='.close')
     super(WashingtonPostMobileStory, self)._DidLoadDocument(action_runner)
+

[petrcermak, 2016/07/21 19:38:42]

nit: There should be two spaces between top-level definitions (one extra blank
line here and one after the comment). That means there should also be an extra
blank line between each two class definitions below.

[Hannes Payer (out of office), 2016/07/26 16:02:09]

Done.

+##############################################################################
+# Media browsing stories.
+##############################################################################
+
+class FlickrMobileStory(_MediaBrowsingStory):
+  NAME = 'browse:media:flickr'
+  URL = ("https://www.flickr.com/photos/albertdros/27815579924/in/"

[petrcermak, 2016/07/21 19:38:42]

s/"/'/g everywhere

[Hannes Payer (out of office), 2016/07/26 16:02:09]

Done.

+         "explore-2016-07-20")
+  ITEM_SELECTOR = '.next-photo.photo-link'
+  SUPPORTED_PLATFORMS = platforms.MOBILE_ONLY
+  IS_SINGLE_PAGE_APP = True
+
+  def _ItemSelector(self, _):
+    return 0
+
+class FlickrDesktopStory(_MediaBrowsingStory):
+  NAME = 'browse:media:flickr'
+  URL = ("https://www.flickr.com/photos/albertdros/27815579924/in/"
+         "explore-2016-07-20")
+  ITEM_SELECTOR = '.navigate-target.navigate-next'
+  SUPPORTED_PLATFORMS = platforms.DESKTOP_ONLY
+  IS_SINGLE_PAGE_APP = True
+
+  def _ItemSelector(self, _):
+    return 0
+
+class ImgurMobileStory(_MediaBrowsingStory):
+  NAME = 'browse:media:imgur'
+  URL = 'http://imgur.com/gallery/e6gPQ'
+  ITEM_SELECTOR = '.Navbar-customAction'
+  SUPPORTED_PLATFORMS = platforms.MOBILE_ONLY
+  IS_SINGLE_PAGE_APP = True
+  def _ItemSelector(self, _):
+    return 0
+
+class ImgurDesktopStory(_MediaBrowsingStory):
+  NAME = 'browse:media:imgur'
+  URL = 'http://imgur.com/gallery/e6gPQ'
+  ITEM_SELECTOR = '.navNext'
+  SUPPORTED_PLATFORMS = platforms.DESKTOP_ONLY
+  IS_SINGLE_PAGE_APP = True
+  def _ItemSelector(self, _):
+    return 0
+
+class YoutubeMobileStory(_MediaBrowsingStory):

[charliea (OOO until 10-5), 2016/07/29 20:10:01]

I think it's worth noting that there are known issues with web page replay
(which is used to play back these stories) and YouTube: I don't think that we've
had any luck getting things to work on more than on platform yet.

[Hannes Payer (out of office), 2016/08/04 11:38:01]

Acknowledged.

+  NAME = 'browse:media:youtube'
+  URL = 'https://m.youtube.com/watch?v=njCDZWTI-xg'
+  ITEM_SELECTOR = '._mpfb > a'
+  IS_SINGLE_PAGE_APP = True
+  SUPPORTED_PLATFORMS = platforms.MOBILE_ONLY
+  ITEM_VIEW_TIME_IN_SECONDS = 2

[charliea (OOO until 10-5), 2016/07/29 20:10:01]

maybe petrcermak@chromium.org has an opinion here, but it might be nice to have
a comment about why two seconds was chosen here. This is the sort of magical
constant that can easily get lost to history if it's not documented.

[Hannes Payer (out of office), 2016/08/04 11:38:01]

I will change it for all to two seconds.

+  ITEMS_TO_VISIT = 15
+  def _ItemSelector(self, _):
+    return 3
+
+class YoutubeDesktopStory(_MediaBrowsingStory):
+  NAME = 'browse:media:youtube'
+  URL = 'https://www.youtube.com/watch?v=Ic07xTJoP34'
+  ITEM_SELECTOR = '.yt-uix-simple-thumb-related'
+  SUPPORTED_PLATFORMS = platforms.DESKTOP_ONLY
+  IS_SINGLE_PAGE_APP = True
+  ITEM_VIEW_TIME_IN_SECONDS = 2
+  ITEMS_TO_VISIT = 15
+  def _ItemSelector(self, _):
+    return 0
+
+class FacebookMobileStory(_MediaBrowsingStory):
+  NAME = 'browse:media:facebookphotos'
+  URL = ("https://facebook.com/photo.php?fbid=10154398154450513&"
+         "id=255110695512&set=a.406278500512.172778.255110695512&"
+         "source=54&refid=13")
+  ITEM_SELECTOR = '._57-p > a'
+  IS_SINGLE_PAGE_APP = True
+  SUPPORTED_PLATFORMS = platforms.MOBILE_ONLY
+  ITEM_VIEW_TIME_IN_SECONDS = 2
+  ITEMS_TO_VISIT = 20
+
+  def _ItemSelector(self, _):
+    return 1
+
+class FacebookDesktopStory(_MediaBrowsingStory):
+  NAME = 'browse:media:facebookphotos'
+  URL = ("https://www.facebook.com/NASA/photos/a.67899501771.69169.54971236771/"
+         "10154267233981772/?type=3&theater")
+  ITEM_SELECTOR = '.snowliftPager.next'
+  IS_SINGLE_PAGE_APP = True
+  SUPPORTED_PLATFORMS = platforms.DESKTOP_ONLY
+  ITEM_VIEW_TIME_IN_SECONDS = 2
+  ITEMS_TO_VISIT = 20
+
+  def _ItemSelector(self, _):
+    return 0
+
+  def _Login(self, action_runner):
+    mobile_facebook_login.LoginAccount(action_runner, 'facebook3',

[nednguyen, 2016/07/21 17:32:00]

Can you not use mobile_facebook_login here but:
1) Rename mobile_facebook_login to facebook_login
2) Change mobile_facebook_login.LoginAccount to
facebook_login.LoginWithMobileSite & facebook_login.LoginWithDesktopSite?

[Hannes Payer (out of office), 2016/07/26 16:02:09]

I experimented with that. The Desktop version gets stuck most of the time
because facebook login wants cookies enabled. I do not run into this login
problem using the mobile site, which after login transitions to non-mobile
facebook. Can I use the mobile login procedure? WDYT?

+                                       self.credentials_path)
+    action_runner.Navigate("https://www.facebook.com")
+    action_runner.tab.WaitForDocumentReadyStateToBeComplete()