updated page load detection mechanism that doesn't forget selected frames.

Author: freynaud

release.notes

@@ -28,9 +28,9 @@
 - handle alerts for web
 - cleanup and document setValue vs sendKeys
 - send info to jason to start / compile etc + feature list.
-- implicit wait for web ( would help with pageLoad issues )
-- avoid switching between native and web for internal command.
-
++ implicit wait for web ( would help with pageLoad issues )
++ avoid switching between native and web for internal command.
+- make an executable
 
 
 TODOs:
@@ -51,9 +51,11 @@ TODOs:
 - add selenium tests for the inspector ( update mocks ? )
 - confusion between locale and languages
 - real device for web.
+- setup and teardown for device.
 - encapsulate result of logEleemntTree.
 - inspector should save the tmp screenshot in tmp dir
 - nativeDriver.executeScript should return UIAElement cast to what they are rather than WebElements.
 - use implicit wait to wait for the native keyboard 
 - remove all calls to plutil
 - instruments crash from user define script. stackoverflow for method def for instance.
+- investigate why safari is slow to start

server/src/main/java/org/uiautomation/ios/server/DOMContext.java

@@ -13,9 +13,6 @@
  */
 package org.uiautomation.ios.server;
 
-import java.util.List;
-import java.util.logging.Logger;
-
 import org.json.JSONArray;
 import org.json.JSONObject;
 import org.openqa.selenium.TimeoutException;
@@ -27,6 +24,11 @@
 import org.uiautomation.ios.mobileSafari.events.inserted.ChildIframeInserted;
 import org.uiautomation.ios.webInspector.DOM.RemoteWebElement;
 
+import java.util.List;
+import java.util.logging.Logger;
+
+
+// TODO freynaud revisit pageLoad, reset, setFrame and newContext and expose only 1 thing.
 public class DOMContext implements EventListener {
 
   private static final Logger log = Logger.getLogger(DOMContext.class.getName());
@@ -70,13 +72,42 @@ public RemoteWebElement getWindow() {
     return window;
   }
 
-  public void reset() {
+  public void newContext() {
     window = null;
     document = null;
     iframe = null;
     mainDocument = null;
   }
 
+  public String toString() {
+    StringBuilder b = new StringBuilder();
+    b.append("window " + window);
+    b.append("document " + document);
+    b.append("iframe " + iframe);
+    b.append("mainDocument " + mainDocument);
+    return b.toString();
+  }
+
+  // TODO freynaud reset() != pageLoad
+  public void reset() {
+    RemoteWebElement newDocument = null;
+    RemoteWebElement newWindow = null;
+
+    // check is what changed was the context for the current frame.
+    if (iframe != null) {
+      try {
+        newDocument = iframe.getContentDocument();
+        newWindow = iframe.getContentWindow();
+        setCurrentFrame(iframe, newDocument, newWindow);
+        return;
+      } catch (Exception e) {
+        e.printStackTrace();
+      }
+    }
+    // couldn't update the current frame. Reseting everything.
+    newContext();
+  }
+
   // TODO freynaud. Cleanup. A reference to the main document of the page needs
   // to be kept.
   // calling getDocument again to have the document after siwtching to an iframe
@@ -117,6 +148,7 @@ public RemoteWebElement getCurrentFrame() {
 
   @Override
   public void onPageLoad() {
+    System.err.println("new page loaded");
     pageLoaded = true;
     reset();
   }
@@ -145,17 +177,31 @@ public boolean isLoading() {
     return !isReady();
   }
 
-  private boolean isReady() {
+  public String getDocumentReadyState() {
+    String state = null;
     try {
-      String state = (String) session.getWebInspector().executeScript(
+      state = (String) session.getWebInspector().executeScript(
           "var state = document.readyState; return state",
           new JSONArray());
-      boolean ready = "complete".equals(state);
-      return ready; ///*"interactive".equals(state) || */"complete".equals(state);
     } catch (Exception e) {
-      // TODO detect frame gone and call  getSession().getContext().getDOMContext().reset();
-      return false;
+      // Arguments should belong to the same JavaScript world as the target object.
+      System.err.println("error, resetting because " + e.getMessage());
+      reset();
+      return "unknown";
     }
+    return state; ///*"interactive".equals(state)
+    /*String state = null;
+    try {
+      state = (String)session.getWebInspector().evaluate("document.readyState;");
+    } catch (Exception e) {
+      e.printStackTrace();  //To change body of catch statement use File | Settings | File Templates.
+    }
+    System.out.println("state:"+state);
+    return state; */
+  }
+
+  private boolean isReady() {
+    return "complete".equals(getDocumentReadyState());
   }
 
   private void waitForDocumentReady(long deadLine) {

server/src/main/java/org/uiautomation/ios/server/command/BaseWebCommandHandler.java

@@ -13,8 +13,11 @@
  */
 package org.uiautomation.ios.server.command;
 
+import org.openqa.selenium.TimeoutException;
 import org.uiautomation.ios.UIAModels.configuration.WorkingMode;
+import org.uiautomation.ios.communication.WebDriverLikeCommand;
 import org.uiautomation.ios.communication.WebDriverLikeRequest;
+import org.uiautomation.ios.mobileSafari.WebInspector;
 import org.uiautomation.ios.server.IOSDriver;
 
 public abstract class BaseWebCommandHandler extends BaseCommandHandler {
@@ -30,7 +33,20 @@ protected <T> T getConfiguration(String key) {
 
   protected void waitForPageToLoad() throws InterruptedException {
     boolean loadHappened = false;
-    while (getSession().getContext().getDOMContext().isLoading()) {
+    long
+        timeout =
+        (Long) getSession().configure(WebDriverLikeCommand.URL)
+            .opt("page load", WebInspector.defaultPageLoadTimeoutInMs);
+
+    long deadline = System.currentTimeMillis() + timeout;
+    while (getSession().getContext().getDOMContext()
+        .isLoading()) {
+
+      if (System.currentTimeMillis() > deadline) {
+        throw new TimeoutException(
+            "failed to load the page after " + timeout + " ms. Page is currently is state : "
+            + getSession().getContext().getDOMContext().getDocumentReadyState());
+      }
       loadHappened = true;
       Thread.sleep(500);
     }

server/src/main/java/org/uiautomation/ios/server/command/web/BackHandler.java

@@ -37,7 +37,7 @@ public Response handle() throws Exception {
     } else {
       backWeb();
     }
-    getSession().getContext().getDOMContext().reset();
+    getSession().getContext().getDOMContext().newContext();
     getSession().getWebInspector().waitForPageToLoad();
     Response resp = new Response();
     resp.setSessionId(getSession().getSessionId());

server/src/main/java/org/uiautomation/ios/server/command/web/ForwardHandler.java

@@ -32,7 +32,7 @@ public ForwardHandler(IOSDriver driver, WebDriverLikeRequest request) {
   @Override
   public Response handle() throws Exception {
     boolean useNativeEvents = getConfiguration("nativeEvents", nativeEvents);
-    getSession().getContext().getDOMContext().reset();
+    getSession().getContext().getDOMContext().newContext();
     if (useNativeEvents) {
       // forwardNative();
     } else {
@@ -54,8 +54,8 @@ public JSONObject configurationDescription() throws JSONException {
     desc.put(
         "nativeEvents",
         "{boolean}, default to "
-            + nativeEvents
-            + ".true = UIAutomation native events will be used to enter click the forward arrow (slow) , Web =  WebKit remote debugging will be used.Faster.");
+        + nativeEvents
+        + ".true = UIAutomation native events will be used to enter click the forward arrow (slow) , Web =  WebKit remote debugging will be used.Faster.");
     return desc;
   }
 

server/src/main/java/org/uiautomation/ios/server/command/web/GetHandler.java

@@ -18,7 +18,6 @@
 import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.remote.Response;
 import org.uiautomation.ios.UIAModels.UIAElement;
-import org.uiautomation.ios.UIAModels.configuration.WorkingMode;
 import org.uiautomation.ios.UIAModels.predicate.AndCriteria;
 import org.uiautomation.ios.UIAModels.predicate.Criteria;
 import org.uiautomation.ios.UIAModels.predicate.NameCriteria;
@@ -72,7 +71,7 @@ public Response handle() throws Exception {
     }
 
     if (newPageWillBeLoaded) {
-      getSession().getContext().getDOMContext().reset();
+      getSession().getContext().getDOMContext().newContext();
     }
 
     boolean useNativeEvents = getConfiguration("nativeEvents", nativeEvents);
@@ -101,19 +100,10 @@ private UIAElement getAddressBar() {
   }
 
   private void typeURLNative(String url) {
-
-    WorkingMode base = getSession().getMode();
-    try {
-
-      getSession().setMode(WorkingMode.Native);
-      getAddressBar().tap();
-      RemoteUIAKeyboard keyboard = (RemoteUIAKeyboard) getSession().getNativeDriver().getKeyboard();
-      keyboard.sendKeys(url);
-      keyboard.findElement(new NameCriteria("Go")).tap();
-
-    } finally {
-      getSession().setMode(base);
-    }
+    getAddressBar().tap();
+    RemoteUIAKeyboard keyboard = (RemoteUIAKeyboard) getSession().getNativeDriver().getKeyboard();
+    keyboard.sendKeys(url);
+    keyboard.findElement(new NameCriteria("Go")).tap();
   }
 
   private void fakeTypeURL(String url) {

server/src/main/java/org/uiautomation/ios/server/command/web/RefreshHandler.java

@@ -28,7 +28,7 @@ public RefreshHandler(IOSDriver driver, WebDriverLikeRequest request) {
 
   @Override
   public Response handle() throws Exception {
-    getSession().getContext().getDOMContext().reset();
+    getSession().getContext().getDOMContext().newContext();
     getSession().getWebInspector().refresh();
     getSession().getWebInspector().waitForPageToLoad();
     Response res = new Response();