Add cache_temperature state "HOT"

telemetry/telemetry/page/cache_temperature.py

Index: telemetry/telemetry/page/cache_temperature.py
diff --git a/telemetry/telemetry/page/cache_temperature.py b/telemetry/telemetry/page/cache_temperature.py
index 3e22d02eac6e41389f4778bb07582113bbae4631..92887442a6816935e4914921cd7b3c1ea7604ef4 100644
--- a/telemetry/telemetry/page/cache_temperature.py
+++ b/telemetry/telemetry/page/cache_temperature.py
@@ -12,17 +12,17 @@ https://docs.google.com/document/u/1/d/12D7tkhZi887g9d0U2askU9JypU_wYiEI7Lw0bfwx
 
 import logging
 
-import py_utils
-
 # Default Cache Temperature. The page doesn't care which browser cache state
 # it is run on.
 ANY = 'any'
 # Emulates cold runs. Clears various caches and data with using tab.ClearCache()
 # and tab.ClearDataForOrigin().
 COLD = 'cold'
-# Emulates warm runs. Ensures that the page was visited at least once just
-# before the run.
+# Emulates warm runs. Ensures that the page was visited once before the run.
 WARM = 'warm'
+# Emulates hot runs. Ensures that the page was visited at least twice before
+# the run.
+HOT = 'hot'
 
 # These regacy states will be removed after chromium test scripts are adapted
 # to new states.
@@ -46,7 +46,6 @@ class MarkTelemetryInternal(object):
   def __exit__(self, exception_type, exception_value, traceback):
     if exception_type:
       return True
-
     marker = 'telemetry.internal.%s.end' % self.identifier
     self.browser.tabs[0].ExecuteJavaScript(
         "console.time({{ marker }});", marker=marker)
@@ -54,16 +53,16 @@ class MarkTelemetryInternal(object):
         "console.timeEnd({{ marker }});", marker=marker)
     return True
 
-def ClearCache(browser):
+def ClearCacheAndData(browser, url):
   tab = browser.tabs[0]
   tab.ClearCache(force=True)
+  tab.ClearDataForOrigin(url)
 
 def WarmCache(page, browser):
   with MarkTelemetryInternal(browser, 'warm_cache'):
     tab = browser.tabs[0]
-    tab.Navigate(page.url)
-    py_utils.WaitFor(tab.HasReachedQuiescence, 60)
-    tab.WaitForDocumentReadyStateToBeComplete()
+    page.RunNavigateSteps(tab.action_runner)
+    page.RunPageInteractions(tab.action_runner)
     tab.Navigate("about:blank")
     tab.WaitForDocumentReadyStateToBeComplete()
 
@@ -84,12 +83,11 @@ def EnsurePageCacheTemperature(page, browser, previous_page=None):
         tab = browser.tabs[0]
         tab.Navigate("http://does.not.exist")
         tab.WaitForDocumentReadyStateToBeComplete()
-    ClearCache(browser)
+    ClearCacheAndData(browser, page.url)
   elif temperature == WARM:
     if (previous_page is not None and
         previous_page.url == page.url and
-        (previous_page.cache_temperature == COLD or
-         previous_page.cache_temperature == WARM)):
+        previous_page.cache_temperature == COLD):
       if '#' in page.url:
         # Navigate to inexistent URL to avoid in-page hash navigation.
         # Note: Unlike PCv1, PCv2 iterates the same URL for different cache
@@ -99,5 +97,29 @@ def EnsurePageCacheTemperature(page, browser, previous_page=None):
           tab = browser.tabs[0]
           tab.Navigate("http://does.not.exist")
           tab.WaitForDocumentReadyStateToBeComplete()
-      return
-    WarmCache(page, browser)
+    else:
+      ClearCacheAndData(browser, page.url)
+      WarmCache(page, browser)

[shimazu, 2017/09/25 02:30:35]

I'm wondering if it's correct though I'm not familiar with the problem of double
hash navigation.
Do we need to navigate to does.not.exist before each Navigate() if there is '#'
in the page.url? If it's correct, I guess we need to put
avoid_double_hash_navigation logic here, but it seems awkward...

I guess tab.Navigate or something might be a good place to put the
pre-navigation mechanism.
kouhei/ned: Do you have any ideas about it?

[shimazu, 2017/09/25 05:36:17]

Copied the reply from yukiy@:
Yeah, but if we need to call it after all of WarmCache(), I think it'd be better
to have it as a function and put a TODO comment.

[yukiy, 2017/09/25 08:59:05]

As we chatted, avoid_double_hash_navigation logic avoids completing the
navigation with only scrolling the page.
WarmCache() navigates to about:blank after main navigation, so calling this
logic is not needed.

+  elif temperature == HOT:
+    if (previous_page is not None and
+        previous_page.url == page.url and
+        previous_page.cache_temperature != ANY):
+      if previous_page.cache_temperature == COLD:
+        WarmCache(page, browser)
+      else:
+        if '#' in page.url:
+          # Navigate to inexistent URL to avoid in-page hash navigation.
+          # Note: Unlike PCv1, PCv2 iterates the same URL for different cache
+          #       configurations. This may issue blink in-page hash navigations,
+          #       which isn't intended here.
+          with MarkTelemetryInternal(browser, 'avoid_double_hash_navigation'):
+            tab = browser.tabs[0]
+            tab.Navigate("http://does.not.exist")
+            tab.WaitForDocumentReadyStateToBeComplete()
+    else:
+      ClearCacheAndData(browser, page.url)
+      WarmCache(page, browser)

[shimazu, 2017/09/25 02:30:35]

We need to stop workers for each WarmCache() since the number of script
evaluations for the service worker must be three or more when HOT
temperature/two for WARM to ensure existence of V8 code cache.

[yukiy, 2017/09/25 06:28:37]

I will do this with avoid_double_hash_navigation :D

[yukiy, 2017/09/25 08:59:05]

Done.

+      WarmCache(page, browser)
+  tab = browser.tabs[0]
+  tab.EnableServiceWorker()
+  tab.StopAllServiceWorkers()