Bug 1060300: Match Marionette's navigation API docs to reality

r=dhunt

--HG--
extra : rebase_source : 1a2f0edf8df5728bf2d768fc8dc69d045f572021

testing/marionette/driver.js

@@ -1141,27 +1141,24 @@ GeckoDriver.prototype.executeWithCallback = function(cmd, resp, directInject) {
 };
 
 /**
- * Navigate to to given URL.
+ * Navigate to given URL.
  *
- * This will follow redirects issued by the server.  When the method
- * returns is based on the page load strategy that the user has
- * selected.
+ * Navigates the current browsing context to the given URL and waits for
+ * the document to load or the session's page timeout duration to elapse
+ * before returning.
  *
- * Documents that contain a META tag with the "http-equiv" attribute
- * set to "refresh" will return if the timeout is greater than 1
- * second and the other criteria for determining whether a page is
- * loaded are met.  When the refresh period is 1 second or less and
- * the page load strategy is "normal" or "conservative", it will
- * wait for the page to complete loading before returning.
+ * The command will return with a failure if there is an error loading
+ * the document or the URL is blocked.  This can occur if it fails to
+ * reach host, the URL is malformed, or if there is a certificate issue
+ * to name some examples.
  *
- * If any modal dialog box, such as those opened on
- * window.onbeforeunload or window.alert, is opened at any point in
- * the page load, it will return immediately.
+ * The document is considered successfully loaded when the
+ * DOMContentLoaded event on the frame element associated with the
+ * current window triggers and document.readyState is "complete".
  *
- * If a 401 response is seen by the browser, it will return
- * immediately.  That is, if BASIC, DIGEST, NTLM or similar
- * authentication is required, the page load is assumed to be
- * complete.  This does not include FORM-based authentication.
+ * In chrome context it will change the current window's location to
+ * the supplied URL and wait until document.readyState equals "complete"
+ * or the page timeout duration has elapsed.
  *
  * @param {string} url
  *     URL to navigate to.

testing/marionette/driver/marionette_driver/marionette.py

@@ -1182,35 +1182,29 @@ class Marionette(object):
         return response
 
     def navigate(self, url):
-        """Navigate to to given URL.
+        """Navigate to given `url`.
 
-        This will follow redirects issued by the server.  When the
-        method returns is based on the page load strategy that the
-        user has selected.
+        Navigates the current top-level browsing context's content
+        frame to the given URL and waits for the document to load or
+        the session's page timeout duration to elapse before returning.
 
-        Documents that contain a META tag with the "http-equiv"
-        attribute set to "refresh" will return if the timeout is
-        greater than 1 second and the other criteria for determining
-        whether a page is loaded are met.  When the refresh period is
-        1 second or less and the page load strategy is "normal" or
-        "conservative", it will wait for the page to complete loading
-        before returning.
+        The command will return with a failure if there is an error
+        loading the document or the URL is blocked.  This can occur if
+        it fails to reach the host, the URL is malformed, the page is
+        restricted (about:* pages), or if there is a certificate issue
+        to name some examples.
 
-        If any modal dialog box, such as those opened on
-        window.onbeforeunload or window.alert, is opened at any point
-        in the page load, it will return immediately.
+        The document is considered successfully loaded when the
+        `DOMContentLoaded` event on the frame element associated with the
+        `window` triggers and `document.readState` is "complete".
 
-        If a 401 response is seen by the browser, it will return
-        immediately.  That is, if BASIC, DIGEST, NTLM or similar
-        authentication is required, the page load is assumed to be
-        complete.  This does not include FORM-based authentication.
-
-        :param url: The url to navigate to.
+        In chrome context it will change the current `window`'s location
+        to the supplied URL and wait until `document.readState` equals
+        "complete" or the page timeout duration has elapsed.
 
+        :param url: The URL to navigate to.
         """
-
-        response = self._send_message("get", "ok", url=url)
-        return response
+        return self._send_message("get", "ok", url=url)
 
     def timeouts(self, timeout_type, ms):
         """An interface for managing timeout behaviour of a Marionette instance.

testing/marionette/listener.js

@@ -1209,9 +1209,9 @@ function pollForReadyState(msg, start, callback) {
 
 /**
  * Navigate to the given URL.  The operation will be performed on the
- * current browser context, and handles the case where we navigate
- * within an iframe.  All other navigation is handled by the server
- * (in chrome space).
+ * current browsing context, which means it handles the case where we
+ * navigate within an iframe.  All other navigation is handled by the
+ * driver (in chrome space).
  */
 function get(msg) {
   let start = new Date().getTime();