creating a new server side driver using the force native flag to prevent un necessary context switching

Author: freynaud

client/src/main/java/org/uiautomation/ios/client/uiamodels/impl/AttachRemoteUIADriver.java

@@ -13,16 +13,20 @@
  */
 package org.uiautomation.ios.client.uiamodels.impl;
 
-import java.net.URL;
-import java.util.Map;
+import com.google.common.collect.ImmutableBiMap;
+import com.google.common.collect.ImmutableMap;
 
 import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.remote.HttpCommandExecutor;
 import org.openqa.selenium.remote.SessionId;
 import org.uiautomation.ios.IOSCapabilities;
+import org.uiautomation.ios.communication.Path;
 import org.uiautomation.ios.communication.WebDriverLikeCommand;
 import org.uiautomation.ios.communication.WebDriverLikeRequest;
 
+import java.net.URL;
+import java.util.Map;
+
 public class AttachRemoteUIADriver extends RemoteUIADriver {
 
   @Override
@@ -55,4 +59,5 @@ private IOSCapabilities loadCapabilities() {
     return new IOSCapabilities(c);
   }
 
+
 }

client/src/main/java/org/uiautomation/ios/client/uiamodels/impl/RemoteUIADriver.java

@@ -285,9 +285,6 @@ private <T> T cast(Object o) {
     if (o == null) {
       return null;
     }
-    if (o instanceof String) {
-      return (T) o;
-    }
     if (o instanceof Map) {
       Map<String, Object> map = (Map<String, Object>) o;
       if (map.containsKey("ELEMENT")) {
@@ -311,8 +308,7 @@ private <T> T cast(Object o) {
       }
       return (T) res;
     }
-
-    return null;
+    return (T) o;
   }
 
   /*
@@ -351,12 +347,13 @@ public Object executeScript(String script, Object... args) {
     Iterable<Object>
         convertedArgs =
         Iterables.transform(Lists.newArrayList(args), new WebElementToJsonConverter());
-
     Map<String, ?>
         params =
         ImmutableMap.of("script", script, "args", Lists.newArrayList(convertedArgs));
+    WebDriverLikeRequest request = buildRequest(WebDriverLikeCommand.EXECUTE_SCRIPT, params);
 
-    return execute(DriverCommand.EXECUTE_SCRIPT, params).getValue();
+    return execute(request);
+    //return execute(DriverCommand.EXECUTE_SCRIPT, params).getValue();
   }
 
   @Override

client/src/main/java/org/uiautomation/ios/client/uiamodels/impl/ServerSideNativeDriver.java

@@ -0,0 +1,61 @@
+/*
+ * Copyright 2013 ios-driver committers.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+package org.uiautomation.ios.client.uiamodels.impl;
+
+
+import com.google.common.collect.ImmutableMap;
+
+import org.openqa.selenium.remote.SessionId;
+import org.uiautomation.ios.communication.Path;
+import org.uiautomation.ios.communication.WebDriverLikeCommand;
+import org.uiautomation.ios.communication.WebDriverLikeRequest;
+
+import java.net.URL;
+import java.util.Map;
+
+
+/**
+ * attaches itself to an existing session, and forces all requests to be executed in native mode.
+ * This is useful on the server side to bypass the current working mode. If a user is currently
+ * using the web mode, but using native clicks, using this driver to click will force the click to
+ * be native without impacting the working mode, making it safely usable in threads.
+ */
+public class ServerSideNativeDriver extends AttachRemoteUIADriver {
+
+  public ServerSideNativeDriver(URL url, SessionId session) {
+    super(url, session);
+  }
+
+  /**
+   * forces the requests to be executed native by adding the native flag in the param list.
+   */
+  @Override
+  public WebDriverLikeRequest buildRequest(WebDriverLikeCommand command, RemoteUIAElement element,
+                                           Map<String, ?> params) {
+    String method = command.method();
+    Path p = new Path(command).withSession(getSessionId());
+    if (element != null) {
+      p.withReference(element.getReference());
+    }
+
+    ImmutableMap.Builder<String, Object> builder = new ImmutableMap.Builder<String, Object>();
+    builder.put("native", true);
+    if (params != null) {
+      builder.putAll(params).build();
+    }
+    WebDriverLikeRequest request = new WebDriverLikeRequest(method, p, builder.build());
+    return request;
+  }
+}

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

@@ -300,7 +300,7 @@ private boolean isNative(IOSDriver driver, WebDriverLikeRequest request) {
       return request.getPayload().optBoolean("native");
     }
 
-    // else, get it from the current mode.Ò
+    // else, get it from the current mode.
     boolean isNative = true;
     WebDriverLikeCommand command = request.getGenericCommand();
 

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

@@ -27,6 +27,7 @@
 import org.uiautomation.ios.UIAModels.configuration.WorkingMode;
 import org.uiautomation.ios.client.uiamodels.impl.AttachRemoteUIADriver;
 import org.uiautomation.ios.client.uiamodels.impl.RemoteUIADriver;
+import org.uiautomation.ios.client.uiamodels.impl.ServerSideNativeDriver;
 import org.uiautomation.ios.communication.WebDriverLikeCommand;
 import org.uiautomation.ios.communication.device.Device;
 import org.uiautomation.ios.mobileSafari.WebInspector;
@@ -50,10 +51,11 @@ public class ServerSideSession extends Session {
 
   private final DriverConfiguration configuration;
 
-  
-  public IOSCapabilities getCapabilities(){
+
+  public IOSCapabilities getCapabilities() {
     return capabilities;
   }
+
   ServerSideSession(IOSDriver driver, IOSCapabilities capabilities) {
     super(UUID.randomUUID().toString());
     this.driver = driver;
@@ -72,7 +74,7 @@ public IOSCapabilities getCapabilities(){
 
       if (!driver.getHostInfo().getInstalledSDKs().contains(version)) {
         throw new SessionNotCreatedException("Cannot start on version " + version + ".Installed : "
-            + driver.getHostInfo().getInstalledSDKs());
+                                             + driver.getHostInfo().getInstalledSDKs());
       }
     }
     instruments = new InstrumentsManager(driver.getPort());
@@ -126,18 +128,22 @@ public InstrumentsManager getInstruments() {
   }
 
   public void start() {
-    String appleLanguage = application.getAppleLocaleFromLanguageCode(capabilities.getLanguage()).getAppleLanguagesForPreferencePlist();
-    instruments.startSession(capabilities.getDevice(),capabilities.getDeviceVariation(), capabilities.getSDKVersion(), capabilities.getLocale(),
-        appleLanguage, application, getSessionId(), capabilities.isTimeHack(),
-        capabilities.getExtraSwitches());
+    String
+        appleLanguage =
+        application.getAppleLocaleFromLanguageCode(capabilities.getLanguage())
+            .getAppleLanguagesForPreferencePlist();
+    instruments.startSession(capabilities.getDevice(), capabilities.getDeviceVariation(),
+                             capabilities.getSDKVersion(), capabilities.getLocale(),
+                             appleLanguage, application, getSessionId(), capabilities.isTimeHack(),
+                             capabilities.getExtraSwitches());
 
     URL url = null;
     try {
       url = new URL("http://localhost:" + driver.getHostInfo().getPort() + "/wd/hub");
     } catch (Exception e) {
       e.printStackTrace();
     }
-    nativeDriver = new AttachRemoteUIADriver(url, new SessionId(instruments.getSessionId()));
+    nativeDriver = new ServerSideNativeDriver(url, new SessionId(instruments.getSessionId()));
   }
 
   public WebInspector getWebInspector() {

server/src/main/java/org/uiautomation/ios/webInspector/DOM/RemoteWebElement.java

@@ -103,13 +103,13 @@ private void clickAtom() throws Exception {
   }
 
   private void clickNative() throws Exception {
-    WorkingMode origin = session.getMode();
-    session.setMode(WorkingMode.Native);
+
     ((JavascriptExecutor) nativeDriver).executeScript(getNativeElementClickOnIt());
-    session.setMode(origin);
-    long start = System.currentTimeMillis();
 
-    /*while (true) {
+
+
+    /* long start = System.currentTimeMillis();
+    while (true) {
       long end = System.currentTimeMillis();
       System.out.println((end-start)+"ms,is loading? :" + session.getContext().getDOMContext().isLoading());
     } */
@@ -185,7 +185,6 @@ private String getNativeElementClickOnIt() throws Exception {
     // web stuff.
     scrollIntoViewIfNeeded();
     Point po = findPosition();
-    System.out.println("click native on po :" + po.toString());
 
     Dimension dim = inspector.getSize();
     int webPageWidth = inspector.getInnerWidth();
@@ -320,27 +319,24 @@ private UIAElement getNativeElement() throws Exception {
 
       UIARect rect = null;
       UIARect offset = null;
-      try {
-        session.setMode(WorkingMode.Native);
-        UIAElement sv = nativeDriver.findElement(new TypeCriteria(UIAWebView.class));
-
-        // scrollview container. Doesn't start in 0,0 // x=0,y=96,h=928w=768
-        // TODO freynaud : should save the current value, and reset to that at
-        // the end. Not to false.
-        nativeDriver.configure(WebDriverLikeCommand.RECT).set("checkForStale", false);
-        rect = sv.getRect();
-
-        UIAElement addressBar = nativeDriver
-            .findElement(
-                new AndCriteria(new TypeCriteria(UIAElement.class), new NameCriteria("Address",
-                                                                                     L10NStrategy.serverL10N),
-                                new LabelCriteria("Address", L10NStrategy.serverL10N)));
-        offset = addressBar.getRect();
-        nativeDriver.configure(WebDriverLikeCommand.RECT).set("checkForStale", true);
-        // rect = sv.getRect();
-      } finally {
-        session.setMode(origin);
-      }
+
+      session.setMode(WorkingMode.Native);
+      UIAElement sv = nativeDriver.findElement(new TypeCriteria(UIAWebView.class));
+
+      // scrollview container. Doesn't start in 0,0 // x=0,y=96,h=928w=768
+      // TODO freynaud : should save the current value, and reset to that at
+      // the end. Not to false.
+      nativeDriver.configure(WebDriverLikeCommand.RECT).set("checkForStale", false);
+      rect = sv.getRect();
+
+      UIAElement addressBar = nativeDriver
+          .findElement(
+              new AndCriteria(new TypeCriteria(UIAElement.class), new NameCriteria("Address",
+                                                                                   L10NStrategy.serverL10N),
+                              new LabelCriteria("Address", L10NStrategy.serverL10N)));
+      offset = addressBar.getRect();
+      nativeDriver.configure(WebDriverLikeCommand.RECT).set("checkForStale", true);
+      // rect = sv.getRect();
 
       int top = po.getY();
       int left = po.getX();
@@ -361,12 +357,9 @@ private UIAElement getNativeElement() throws Exception {
         delta = 96;
       }
       int y = delta + top;
-      try {
-        session.setMode(WorkingMode.Native);
-        nativeElement = nativeDriver.findElement(new LocationCriteria(x, y));
-      } finally {
-        session.setMode(origin);
-      }
+
+      nativeElement = nativeDriver.findElement(new LocationCriteria(x, y));
+
 
     }
     return nativeElement;
@@ -833,11 +826,9 @@ public void setValueNative(String value) throws Exception {
      * session.getNativeDriver().pinchClose(300, 400, 50, 100, 1); } finally {
      * session.setMode(origin); }
      */
-    WorkingMode origin = session.getMode();
-    session.setMode(WorkingMode.Native);
+
     ((JavascriptExecutor) nativeDriver)
         .executeScript(getNativeElementClickOnItAndTypeUsingKeyboardScript(value));
-    session.setMode(origin);
   }
 
   public void scrollIntoViewIfNeeded() throws Exception {