[Telemetry] Convert long running user stories to the System Health format.

tools/perf/page_sets/system_health/long_running_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 google_login
+from page_sets.system_health import platforms
+from page_sets.system_health import system_health_story
+
+
+IDLE_TIME_IN_SECONDS = 100

[charliea (OOO until 10-5), 2016/08/29 17:36:00]

Why are these constants up at the top of the file and another constant is
defined within  LongRunningGmailBase?

[rnephew (Reviews Here), 2016/08/29 17:42:17]

The ABSTRACT_STORY is used by the superclass, and background needs to be set on
a per-story basis. I only named background all caps to match the style of the
other class variables (like abstract_story).

[petrcermak, 2016/08/30 12:04:01]

I think that the current "layout" is correct.

[rnephew (Reviews Here), 2016/08/31 15:58:00]

Acknowledged.

+SAMPLING_INTERVAL_IN_SECONDS = 1
+STEPS = IDLE_TIME_IN_SECONDS / SAMPLING_INTERVAL_IN_SECONDS
+
+
+class _LongRunningStory(system_health_story.SystemHealthStory):
+  """Abstract base class for long running stories."""
+  ABSTRACT_STORY = True
+  BACKGROUND = False
+
+  def RunPageInteractions(self, action_runner):
+    super(_LongRunningStory, self).RunPageInteractions(action_runner)
+    if self.BACKGROUND:
+      action_runner.tab.browser.tabs.New()
+    if self._take_memory_measurement:
+      action_runner.MeasureMemory()
+    for _ in xrange(STEPS):

[charliea (OOO until 10-5), 2016/08/29 17:36:00]

If the memory measurement takes any significant amount of time, this is likely
to cause some weird problems.

For example, if it takes 0.25s, and there are 100 steps, then the first sample
will start at 1s and end at 1.25s, the second sample will start at 2.25s and end
at 2.5s, the third sample will start at 3.5s and end at 3.75s, etc.

Probably the expected behavior would be that you'd generate the sampling times
beforehand (1s, 2s, 3s, 4s), and only wait until the next sampling time. (Or use
some other algorithm that yields the same result.)

[rnephew (Reviews Here), 2016/08/29 17:42:17]

This is the behavior of the old version as well though. Juan, is this ok? Or
should it be fixed.

[petrcermak, 2016/08/30 12:04:01]

I'm fine either way. Juan: Any thoughts?

[perezju, 2016/08/30 17:05:50]

I think it should be fine to keep as is.

[rnephew (Reviews Here), 2016/08/31 15:58:00]

Acknowledged.

+      action_runner.Wait(SAMPLING_INTERVAL_IN_SECONDS)
+      if self._take_memory_measurement:
+        action_runner.MeasureMemory()
+
+
+##############################################################################
+# Long running Gmail stories.
+##############################################################################
+
+# TODO(rnephew): Merge _Login() and _DidLoadDocument() with methods in
+# loading_stories.
+class _LongRunningGmailBase(_LongRunningStory):
+  URL = 'https://mail.google.com/mail/'
+  ABSTRACT_STORY = True
+
+  def _Login(self, action_runner):
+    google_login.LoginGoogleAccount(action_runner, 'googletest',
+                                    self.credentials_path)
+
+    # Navigating to https://mail.google.com immediately leads to an infinite
+    # redirection loop due to a bug in WPR (see
+    # https://github.com/chromium/web-page-replay/issues/70). We therefore first
+    # navigate to a sub-URL to set up the session and hit the resulting
+    # redirection loop. Afterwards, we can safely navigate to
+    # https://mail.google.com.
+    action_runner.Navigate(
+        'https://mail.google.com/mail/mu/mp/872/trigger_redirection_loop')
+    action_runner.tab.WaitForDocumentReadyStateToBeComplete()
+
+class _LongRunningGmailMobileBase(_LongRunningGmailBase):
+  SUPPORTED_PLATFORMS = platforms.MOBILE_ONLY
+
+  def _DidLoadDocument(self, action_runner):
+    # Close the "Get Inbox by Gmail" interstitial.
+    action_runner.WaitForJavaScriptCondition(
+        'document.querySelector("#isppromo a") !== null')
+    action_runner.ExecuteJavaScript(
+        'document.querySelector("#isppromo a").click()')
+    # Wait until the UI loads.
+    action_runner.WaitForJavaScriptCondition(
+        'document.getElementById("apploadingdiv").style.height === "0px"')
+
+
+class _LongRunningGmailDesktopBase(_LongRunningGmailBase):
+  SUPPORTED_PLATFORMS = platforms.DESKTOP_ONLY
+
+  def _DidLoadDocument(self, action_runner):
+    # Wait until the UI loads.
+    action_runner.WaitForJavaScriptCondition(
+        'document.getElementById("loading").style.display === "none"')
+
+
+class LongRunningGmailMobileForegroundStory(_LongRunningGmailMobileBase):
+  NAME = 'long_running:tools:gmail-foreground'
+
+
+class LongRunningGmailDesktopForegroundStory(_LongRunningGmailDesktopBase):
+  NAME = 'long_running:tools:gmail-foreground'
+
+
+class LongRunningGmailMobileBackgroundStory(_LongRunningGmailMobileBase):
+  BACKGROUND = True
+  NAME = 'long_running:tools:gmail-background'
+
+
+class LongRunningGmailDesktopBackgroundStory(_LongRunningGmailDesktopBase):
+  BACKGROUND = True
+  NAME = 'long_running:tools:gmail-background'