Code cleanup/simplification

Author: jleyba

javascript/webdriver/abstractbuilder.js

@@ -14,57 +14,107 @@
 
 goog.provide('webdriver.Builder');
 
+goog.require('goog.Uri');
 goog.require('goog.userAgent');
-goog.require('webdriver.AbstractBuilder');
+goog.require('webdriver.Capabilities');
 goog.require('webdriver.FirefoxDomExecutor');
 goog.require('webdriver.WebDriver');
 goog.require('webdriver.http.CorsClient');
 goog.require('webdriver.http.Executor');
 goog.require('webdriver.http.XhrClient');
-goog.require('webdriver.process');
 
 
 
 /**
+ * Creates new {@code webdriver.WebDriver} clients for use in a browser
+ * environment. Upon instantiation, each Builder will configure itself based
+ * on the following query parameters:
+ * <dl>
+ *   <dt>wdurl
+ *   <dd>Defines the WebDriver server to send commands to. If this is a
+ *       relative URL, the builder will use the standard WebDriver wire
+ *       protocol and a {@link webdriver.http.XhrClient}. Otherwise, it will
+ *       use a {@link webdriver.http.CorsClient}; this only works when
+ *       connecting to an instance of the Java Selenium server. The server URL
+ *       may be changed using {@code #usingServer}.
+ *
+ *   <dt>wdsid
+ *   <dd>Defines the session to connect to. If omitted, will request a new
+ *       session from the server.
+ * </dl>
+ *
+ * @param {Window=} opt_window The window to extract query parameters from.
  * @constructor
- * @extends {webdriver.AbstractBuilder}
+ * @final
+ * @struct
  */
-webdriver.Builder = function() {
-  goog.base(this);
-
-  /**
-   * ID of an existing WebDriver session that new clients should use.
-   * Initialized from the value of the
-   * {@link webdriver.AbstractBuilder.SESSION_ID_ENV} environment variable, but
-   * may be overridden using
-   * {@link webdriver.AbstractBuilder#usingSession}.
-   * @private {string}
-   */
+webdriver.Builder = function(opt_window) {
+  var win = opt_window || window;
+  var data = new goog.Uri(win.location).getQueryData();
+
+  /** @private {string} */
+  this.serverUrl_ =
+      /** @type {string} */ (data.get(webdriver.Builder.SERVER_URL_PARAM,
+      webdriver.Builder.DEFAULT_SERVER_URL));
+
+  /** @private {string} */
   this.sessionId_ =
-      webdriver.process.getEnv(webdriver.Builder.SESSION_ID_ENV);
+      /** @type {string} */ (data.get(webdriver.Builder.SESSION_ID_PARAM));
+
+  /** @private {!webdriver.Capabilities} */
+  this.capabilities_ = new webdriver.Capabilities();
 };
-goog.inherits(webdriver.Builder, webdriver.AbstractBuilder);
 
 
 /**
- * Environment variable that defines the session ID of an existing WebDriver
- * session to use when creating clients. If set, all new Builder instances will
- * default to creating clients that use this session. To create a new session,
- * use {@code #useExistingSession(boolean)}. The use of this environment
- * variable requires that {@link webdriver.AbstractBuilder.SERVER_URL_ENV} also
- * be set.
+ * Query parameter that defines which session to connect to.
+ * @type {string}
+ * @const
+ */
+webdriver.Builder.SESSION_ID_PARAM = 'wdsid';
+
+
+/**
+ * Query parameter that defines the URL of the remote server to connect to.
+ * @type {string}
+ * @const
+ */
+webdriver.Builder.SERVER_URL_PARAM = 'wdurl';
+
+
+/**
+ * The default server URL to use.
  * @type {string}
  * @const
- * @see webdriver.process.getEnv
  */
-webdriver.Builder.SESSION_ID_ENV = 'wdsid';
+webdriver.Builder.DEFAULT_SERVER_URL = 'http://localhost:4444/wd/hub';
+
+
+/**
+ * Configures which WebDriver server should be used for new sessions.
+ * @param {string} url URL of the server to use.
+ * @return {!webdriver.Builder} This Builder instance for chain calling.
+ */
+webdriver.Builder.prototype.usingServer = function(url) {
+  this.serverUrl_ = url;
+  return this;
+};
+
+
+/**
+ * @return {string} The URL of the WebDriver server this instance is configured
+ *     to use.
+ */
+webdriver.Builder.prototype.getServerUrl = function() {
+  return this.serverUrl_;
+};
 
 
 /**
  * Configures the builder to create a client that will use an existing WebDriver
  * session.
  * @param {string} id The existing session ID to use.
- * @return {!webdriver.AbstractBuilder} This Builder instance for chain calling.
+ * @return {!webdriver.Builder} This Builder instance for chain calling.
  */
 webdriver.Builder.prototype.usingSession = function(id) {
   this.sessionId_ = id;
@@ -82,7 +132,22 @@ webdriver.Builder.prototype.getSession = function() {
 
 
 /**
- * @override
+ * Sets the desired capabilities when requesting a new session. This will
+ * overwrite any previously set desired capabilities.
+ * @param {!(Object|webdriver.Capabilities)} capabilities The desired
+ *     capabilities for a new session.
+ * @return {!webdriver.Builder} This Builder instance for chain calling.
+ */
+webdriver.Builder.prototype.withCapabilities = function(capabilities) {
+  this.capabilities_ = new webdriver.Capabilities(capabilities);
+  return this;
+};
+
+
+/**
+ * Builds a new {@link webdriver.WebDriver} instance using this builder's
+ * current configuration.
+ * @return {!webdriver.WebDriver} A new WebDriver client.
  */
 webdriver.Builder.prototype.build = function() {
   if (goog.userAgent.GECKO && document.readyState != 'complete') {
@@ -93,10 +158,9 @@ webdriver.Builder.prototype.build = function() {
 
   if (webdriver.FirefoxDomExecutor.isAvailable()) {
     executor = new webdriver.FirefoxDomExecutor();
-    return webdriver.WebDriver.createSession(executor, this.getCapabilities());
+    return webdriver.WebDriver.createSession(executor, this.capabilities_);
   } else {
-    var url = this.getServerUrl() ||
-        webdriver.AbstractBuilder.DEFAULT_SERVER_URL;
+    var url = this.serverUrl_;
     var client;
     if (url[0] == '/') {
       var origin = window.location.origin ||
@@ -107,8 +171,8 @@ webdriver.Builder.prototype.build = function() {
     }
     executor = new webdriver.http.Executor(client);
 
-    if (this.getSession()) {
-      return webdriver.WebDriver.attachToSession(executor, this.getSession());
+    if (this.sessionId_) {
+      return webdriver.WebDriver.attachToSession(executor, this.sessionId_);
     } else {
       throw new Error('Unable to create a new client for this browser. The ' +
           'WebDriver session ID has not been defined.');

javascript/webdriver/builder.js

@@ -38,7 +38,6 @@ goog.require('webdriver.http.Executor');
 goog.require('webdriver.http.Request');
 goog.require('webdriver.http.Response');
 goog.require('webdriver.http.XhrClient');
-goog.require('webdriver.process');
 goog.require('webdriver.promise');
 goog.require('webdriver.stacktrace');
 goog.require('webdriver.testing.assert');
@@ -71,11 +70,6 @@ exports.http.XhrClient = webdriver.http.XhrClient;
 
 exports.response = bot.response;
 
-exports.process = {
-  getEnv: webdriver.process.getEnv,
-  setEnv: webdriver.process.setEnv
-};
-
 exports.promise = webdriver.promise;
 exports.stacktrace = webdriver.stacktrace;