Implementing standard conformant protocol in firefox driver

Author: barancev

java/client/src/org/openqa/selenium/firefox/internal/NewProfileExtensionConnection.java

@@ -30,6 +30,7 @@
 import org.openqa.selenium.net.NetworkUtils;
 import org.openqa.selenium.remote.Command;
 import org.openqa.selenium.remote.HttpCommandExecutor;
+import org.openqa.selenium.remote.HttpCommandExecutorV1;
 import org.openqa.selenium.remote.Response;
 import org.openqa.selenium.remote.internal.CircularOutputStream;
 
@@ -90,7 +91,7 @@ public void start() throws IOException {
 
       process.clean(profile, profileDir);
 
-      delegate = new HttpCommandExecutor(buildUrl(host, port));
+      delegate = new HttpCommandExecutorV1(buildUrl(host, port));
       delegate.setLocalLogs(logs);
       String firefoxLogFile = System.getProperty("webdriver.firefox.logfile");
 
@@ -213,7 +214,7 @@ public void quit() {
   private static URL buildUrl(String host, int port) {
     String hostToUse = "localhost".equals(host) ? networkUtils.obtainLoopbackIp4Address() : host;
     try {
-      return new URL("http", hostToUse, port, "/hub");
+      return new URL("http", hostToUse, port, "/v1");
     } catch (MalformedURLException e) {
       throw new WebDriverException(e);
     }

java/client/src/org/openqa/selenium/remote/BUCK

@@ -40,6 +40,7 @@ java_library(name = 'remote',
     'ExecuteMethod.java',
     'FileDetector.java',
     'HttpCommandExecutor.java',
+    'HttpCommandExecutorV1.java',
     'HttpVerb.java',
     'JsonException.java',
     'JsonToBeanConverter.java',

java/client/src/org/openqa/selenium/remote/BeanToJsonConverter.java

@@ -47,6 +47,15 @@
 public class BeanToJsonConverter {
 
   private static final int MAX_DEPTH = 5;
+  private final boolean v1; // W3C WebDriver Level 1 compatibility flag
+
+  public BeanToJsonConverter() {
+    this(false);
+  }
+
+  public BeanToJsonConverter(boolean v1) {
+    this.v1 = v1;
+  }
 
   /**
    * Convert an object that may or may not be a JSONArray or JSONObject into its JSON string
@@ -190,9 +199,13 @@ private Object convertObject(Object toConvert, int maxDepth) throws Exception {
     }
 
     if (toConvert instanceof SessionId) {
-      JSONObject converted = new JSONObject();
-      converted.put("value", toConvert.toString());
-      return converted;
+      if (v1) {
+        return toConvert.toString();
+      } else {
+        JSONObject converted = new JSONObject();
+        converted.put("value", toConvert.toString());
+        return converted;
+      }
     }
 
     if (toConvert instanceof Capabilities) {

java/client/src/org/openqa/selenium/remote/HttpCommandExecutor.java

@@ -282,23 +282,11 @@ public Response execute(Command command) throws IOException {
       }
     }
 
-    CommandInfo info = nameToUrl.get(command.getName());
     try {
-      HttpUriRequest httpMethod = info.getMethod(remoteServer, command);
+      HttpUriRequest httpMethod = buildRequest(command);
 
       setAcceptHeader(httpMethod);
 
-      if (httpMethod instanceof HttpPost) {
-        String payload = new BeanToJsonConverter().convert(command.getParameters());
-        ((HttpPost) httpMethod).setEntity(new StringEntity(payload, "utf-8"));
-        httpMethod.addHeader("Content-Type", "application/json; charset=utf-8");
-      }
-
-      // Do not allow web proxy caches to cache responses to "get" commands
-      if (httpMethod instanceof HttpGet)  {
-        httpMethod.addHeader("Cache-Control", "no-cache");
-      }
-
       log(LogType.PROFILER, new HttpProfilerLogEntry(command.getName(), true));
       HttpResponse response = fallBackExecute(context, httpMethod);
       log(LogType.PROFILER, new HttpProfilerLogEntry(command.getName(), false));
@@ -318,6 +306,23 @@ public Response execute(Command command) throws IOException {
     }
   }
 
+  protected HttpUriRequest buildRequest(Command command) throws UnsupportedEncodingException {
+    HttpUriRequest httpMethod = nameToUrl.get(command.getName()).getMethod(remoteServer, command);
+
+    if (httpMethod instanceof HttpPost) {
+      String payload = new BeanToJsonConverter().convert(command.getParameters());
+      ((HttpPost) httpMethod).setEntity(new StringEntity(payload, "utf-8"));
+      httpMethod.addHeader("Content-Type", "application/json; charset=utf-8");
+    }
+
+    // Do not allow web proxy caches to cache responses to "get" commands
+    if (httpMethod instanceof HttpGet)  {
+      httpMethod.addHeader("Cache-Control", "no-cache");
+    }
+
+    return httpMethod;
+  }
+
   private HttpResponse fallBackExecute(HttpContext context, HttpUriRequest httpMethod)
       throws IOException {
     try {

java/client/src/org/openqa/selenium/remote/HttpCommandExecutorV1.java

@@ -0,0 +1,47 @@
+/*
+Copyright 2014 Selenium committers
+Copyright 2014 Software Freedom Conservancy
+
+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.openqa.selenium.remote;
+
+import org.apache.http.client.methods.HttpPost;
+import org.apache.http.client.methods.HttpUriRequest;
+import org.apache.http.entity.StringEntity;
+
+import java.io.UnsupportedEncodingException;
+import java.net.URL;
+
+/**
+ * This implementation reifies HttpCommandExecutor to ensure W3C WebDriver Level 1 conformance.
+ * To be merged to HttpCommandExecutor as soon as all drivers and the server are conformant.
+ */
+public class HttpCommandExecutorV1 extends HttpCommandExecutor {
+
+  public HttpCommandExecutorV1(URL addressOfRemoteServer) {
+    super(addressOfRemoteServer);
+  }
+
+  protected HttpUriRequest buildRequest(Command command) throws UnsupportedEncodingException {
+    HttpUriRequest httpMethod = new HttpPost(getAddressOfRemoteServer().toString());
+
+    String payload = new BeanToJsonConverter(true).convert(command);
+    ((HttpPost) httpMethod).setEntity(new StringEntity(payload, "utf-8"));
+    httpMethod.addHeader("Content-Type", "application/json; charset=utf-8");
+
+    return httpMethod;
+  }
+
+}

java/client/src/org/openqa/selenium/remote/build.desc

@@ -76,6 +76,7 @@ java_library(name = "remote",
     "ExecuteMethod.java",
     "FileDetector.java",
     "HttpCommandExecutor.java",
+    "HttpCommandExecutorV1.java",
     "HttpVerb.java",
     "LocalFileDetector.java",
     "RemoteExecuteMethod.java",

javascript/firefox-driver/js/dispatcher.js

@@ -49,6 +49,31 @@ Dispatcher.notImplemented = function(request, response) {
 };
 
 
+/**
+ * Execute a command
+ * @param {Request} request The request to respond to.
+ * @param {Response} response Class used to send the response.
+ */
+Dispatcher.prototype.execute_v1 = function(request, response) {
+  var callback = function(jsonResponseString) {
+    var jsonResponse = JSON.parse(jsonResponseString);
+    // Going to need more granularity here I think.
+    if (jsonResponse.status != bot.ErrorCode.SUCCESS) {
+      response.setStatus(Response.INTERNAL_ERROR);
+    }
+
+    response.setContentType('application/json');
+    response.setBody(jsonResponseString);
+    response.commit();
+  };
+
+  // Dispatch the command.
+  Components.classes['@googlecode.com/webdriver/command-processor;1'].
+      getService(Components.interfaces.nsICommandProcessor).
+      execute(request.getBody(), callback);
+};
+
+
 /**
  * Returns a function that translates a WebDriver HTTP request to a legacy
  * command.
@@ -261,11 +286,11 @@ Dispatcher.prototype.init_ = function() {
   this.bind_('/session/:sessionId/element/:id/click').
       on(Request.Method.POST, Dispatcher.executeAs('clickElement'));
   this.bind_('/session/:sessionId/moveto').
-      on(Request.Method.POST, Dispatcher.executeAs('mouseMove'));
+      on(Request.Method.POST, Dispatcher.executeAs('mouseMoveTo'));
   this.bind_('/session/:sessionId/buttondown').
-      on(Request.Method.POST, Dispatcher.executeAs('mouseDown'));
+      on(Request.Method.POST, Dispatcher.executeAs('mouseButtonDown'));
   this.bind_('/session/:sessionId/buttonup').
-      on(Request.Method.POST, Dispatcher.executeAs('mouseUp'));
+      on(Request.Method.POST, Dispatcher.executeAs('mouseButtonUp'));
   this.bind_('/session/:sessionId/click').
       on(Request.Method.POST, Dispatcher.executeAs('mouseClick'));
   this.bind_('/session/:sessionId/doubleclick').
@@ -308,6 +333,17 @@ Dispatcher.prototype.bind_ = function(path) {
 };
 
 
+/**
+ * Dispatches a request to the appropriately registered handler.
+ * @param {Request} request The request to dispatch.
+ * @param {Response} response The request response.
+ */
+Dispatcher.prototype.dispatch_v1 = function(request, response) {
+  var path = request.getPathInfo();
+  request.setServletPath('/v1');
+  this.execute_v1(request, response);
+};
+
 
 /**
  * Dispatches a request to the appropriately registered handler.

javascript/firefox-driver/js/firefoxDriver.js

@@ -1075,7 +1075,7 @@ FirefoxDriver.prototype.sendResponseFromSyntheticMouse_ = function(mouseReturnVa
   }
 };
 
-FirefoxDriver.prototype.mouseMove = function(respond, parameters) {
+FirefoxDriver.prototype.mouseMoveTo = function(respond, parameters) {
   // Coordinate spaces in use:
   //   * Owner document space: Coordinates are relative to the top-left of the
   //     top-level document contained by the window handle containing the
@@ -1198,7 +1198,7 @@ FirefoxDriver.prototype.mouseMove = function(respond, parameters) {
   }
 };
 
-FirefoxDriver.prototype.mouseDown = function(respond, parameters) {
+FirefoxDriver.prototype.mouseButtonDown = function(respond, parameters) {
   var doc = respond.session.getDocument();
 
   if (!this.enableNativeEvents) {
@@ -1236,7 +1236,7 @@ FirefoxDriver.prototype.mouseDown = function(respond, parameters) {
   respond.send();
 };
 
-FirefoxDriver.prototype.mouseUp = function(respond, parameters) {
+FirefoxDriver.prototype.mouseButtonUp = function(respond, parameters) {
   var doc = respond.session.getDocument();
 
   if (!this.enableNativeEvents) {

javascript/firefox-driver/js/webdriverserver.js

@@ -53,6 +53,10 @@ WebDriverServer = function() {
     response.processAsync();
     dispatcher_.dispatch(new Request(request), new Response(response));
   }});
+  this.server_.registerGlobHandler('.*/v1', { handle: function(request, response) {
+    response.processAsync();
+    dispatcher_.dispatch_v1(new Request(request), new Response(response));
+  }});
 };