Add GetURL() and WaitForJSExpression() functions

tools/chrome_proxy/webdriver/common.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.
 
 import argparse
 import json
 import os
 import re
 import socket
 import shlex
@@ skipping 201 matching lines @@
     given URL.
 
     Args:
       timeout: Page load timeout in seconds.
     """
     if not self._driver:
       self._StartDriver()
     self._driver.set_page_load_timeout(timeout)
     self._driver.get(self._url)
 
+  def GetURL(self, url, timeout=30):

[RyanSturm, 2016/12/12 20:02:46]

I'd prefer LoadURL. This seems a little backwards based on the API of selenium.

Read my other comment about removing LoadPage/SetURL.

[Robert Ogden, 2016/12/13 16:36:31]

Done.

+    """Convenience function for SetURL() followed by LoadPage()
+      Args:
+        url: the URL to navigate to
+        timeout: the time in seconds to load the page before timing out
+    """
+    self.SetURL(url)

[RyanSturm, 2016/12/12 20:02:46]

For now, forcing us to use GetURL with a param everytime might be best.

I don't think there is a strong need to introduce a convenience function, so
maybe just keep it to one method.

Let me know if there are other uses for self._url that I am not thinking of, but
it seems unneccesary since the test will manage what urls it is navigating to.

This use case is sort of ambiguously defined:
SetURL("a")
LoadPage() 
GetURL("b")
LoadPage()

I think I'd prefer the final LoadPage() to load the page from SetURL (i.e. "a"),
but if we are forced to only use GetURL, it would have to look like:
GetURL("a")
GetURL("b")
GetURL("a"/"b") (depending on what the consumer wanted)

[Robert Ogden, 2016/12/13 16:36:31]

Acknowledged.

+    self.LoadPage(timeout)
+
   def ExecuteJavascript(self, script, timeout=30):
     """Executes the given javascript in the browser's current page in an
     anonymous function.
 
     If you expect a result and don't get one, try adding a return statement or
     using ExecuteJavascriptStatement() below.
 
     Args:
       script: A string of Javascript code.
       timeout: Timeout for the Javascript code to return in seconds.
@@ skipping 21 matching lines @@
     Returns:
       A string of the verbatim output from the Javascript execution.
     """
     return self.ExecuteJavascript("return " + script, timeout)
 
   def GetHistogram(self, histogram):
     js_query = 'statsCollectionController.getBrowserHistogram("%s")' % histogram
     string_response = self.ExecuteJavascriptStatement(js_query)
     return json.loads(string_response)
 
+  def WaitForJavascriptExpression(self, expression, timeout, min_poll=0.1,
+      max_poll=1):
+    """Waits for the given Javascript expression to evaluate to True within the
+    given timeout. This method polls the Javascript expression within the range
+    of min_poll and max_poll.
+
+    Args:
+      expression: The Javascript expression to poll, as a string
+      min_poll: The most frequently to poll as a float
+      max_poll: The least frequently to poll as a float
+    Returns: the result of the expression
+    """
+    poll_interval = max(min(max_poll, float(timeout) / 10.0), min_poll)
+    result = self.ExecuteJavascriptStatement(expression)
+    total_waited_time = 0
+    while not result and total_waited_time < timeout:
+      time.sleep(poll_interval)
+      total_waited_time += poll_interval
+      result = self.ExecuteJavascriptStatement(expression)
+    if not result:
+      raise Exception('%s not true after %f seconds' % (expression, timeout))
+    return result
+
   def GetPerformanceLogs(self, method_filter=r'Network\.responseReceived'):
     """Returns all logged Performance events from Chrome.
 
     Args:
       method_filter: A regex expression to match the method of logged events
         against. Only logs who's method matches the regex will be returned.
     Returns:
       Performance logs as a list of dicts, since the last time this function was
       called.
     """
@@ skipping 88 matching lines @@
   @property
   def request_type(self):
     return self._request_type
 
   def ResponseHasViaHeader(self):
     return 'via' in self._response_headers and (self._response_headers['via'] ==
       self._flags.via_header_value)
 
   def WasXHR(self):
     return self.request_type == 'XHR'