selenium-webdriver 3.5.0 → 4.0.0-alpha.4

package/safari.js

@@ -21,17 +21,28 @@
 
 'use strict';
 
-const http = require('./http');
-const io = require('./io');
-const {Capabilities, Capability} = require('./lib/capabilities');
 const command = require('./lib/command');
 const error = require('./lib/error');
-const logging = require('./lib/logging');
+const http = require('./http');
+const io = require('./io');
+const portprober = require('./net/portprober');
 const promise = require('./lib/promise');
+const remote = require('./remote');
 const Symbols = require('./lib/symbols');
 const webdriver = require('./lib/webdriver');
-const portprober = require('./net/portprober');
-const remote = require('./remote');
+const {Browser, Capabilities, Capability} = require('./lib/capabilities');
+
+
+/**
+ * _Synchronously_ attempts to locate the IE driver executable on the current
+ * system.
+ *
+ * @return {?string} the located executable, or `null`.
+ */
+function locateSynchronously() {
+  return process.platform === 'darwin'
+      ? io.findInPath('safaridriver', true) : null;
+}
 
 
 /**
@@ -39,7 +50,7 @@ const remote = require('./remote');
  * @throws {Error}
  */
 function findSafariDriver() {
-  let exe = io.findInPath('safaridriver', true);
+  let exe = locateSynchronously();
   if (!exe) {
     throw Error(
       `The safaridriver executable could not be found on the current PATH.
@@ -73,80 +84,19 @@ const TECHNOLOGY_PREVIEW_OPTIONS_KEY = 'technologyPreview';
 /**
  * Configuration options specific to the {@link Driver SafariDriver}.
  */
-class Options {
-  constructor() {
-    /** @private {Object<string, *>} */
-    this.options_ = null;
-
-    /** @private {./lib/logging.Preferences} */
-    this.logPrefs_ = null;
-
-    /** @private {?./lib/capabilities.ProxyConfig} */
-    this.proxy_ = null;
-  }
-
+class Options extends Capabilities {
   /**
-   * Extracts the SafariDriver specific options from the given capabilities
-   * object.
-   * @param {!Capabilities} capabilities The capabilities object.
-   * @return {!Options} The SafariDriver options.
-   */
-  static fromCapabilities(capabilities) {
-    var options = new Options();
-    var o = capabilities.get(OPTIONS_CAPABILITY_KEY);
-
-    if (o instanceof Options) {
-      options = o;
-    } else if (o) {
-      options.setCleanSession(o.cleanSession);
-      options.setTechnologyPreview(o[TECHNOLOGY_PREVIEW_OPTIONS_KEY]);
-    }
-
-    if (capabilities.has(Capability.PROXY)) {
-      options.setProxy(capabilities.get(Capability.PROXY));
-    }
-
-    if (capabilities.has(Capability.LOGGING_PREFS)) {
-      options.setLoggingPrefs(capabilities.get(Capability.LOGGING_PREFS));
-    }
-
-    return options;
-  }
-
-  /**
-   * Sets whether to force Safari to start with a clean session. Enabling this
-   * option will cause all global browser data to be deleted.
-   * @param {boolean} clean Whether to make sure the session has no cookies,
-   *     cache entries, local storage, or databases.
-   * @return {!Options} A self reference.
+   * @param {(Capabilities|Map<string, ?>|Object)=} other Another set of
+   *     capabilities to initialize this instance from.
    */
-  setCleanSession(clean) {
-    if (!this.options_) {
-      this.options_ = {};
-    }
-    this.options_['cleanSession'] = clean;
-    return this;
-  }
+  constructor(other = undefined) {
+    super(other);
 
-  /**
-   * Sets the logging preferences for the new session.
-   * @param {!./lib/logging.Preferences} prefs The logging preferences.
-   * @return {!Options} A self reference.
-   */
-  setLoggingPrefs(prefs) {
-    this.logPrefs_ = prefs;
-    return this;
-  }
+    /** @private {!Object} */
+    this.options_ = this.get(OPTIONS_CAPABILITY_KEY) || {};
 
-  /**
-   * Sets the proxy to use.
-   *
-   * @param {./lib/capabilities.ProxyConfig} proxy The proxy configuration to use.
-   * @return {!Options} A self reference.
-   */
-  setProxy(proxy) {
-    this.proxy_ = proxy;
-    return this;
+    this.set(OPTIONS_CAPABILITY_KEY, this.options_);
+    this.setBrowserName(Browser.SAFARI);
   }
 
   /**
@@ -157,52 +107,19 @@ class Options {
    * @return {!Options} A self reference.
    */
   setTechnologyPreview(useTechnologyPreview) {
-    if (!this.options_) {
-      this.options_ = {};
-    }
-
     this.options_[TECHNOLOGY_PREVIEW_OPTIONS_KEY] = !!useTechnologyPreview;
     return this;
   }
-
-  /**
-   * Converts this options instance to a {@link Capabilities} object.
-   * @param {Capabilities=} opt_capabilities The capabilities to
-   *     merge these options into, if any.
-   * @return {!Capabilities} The capabilities.
-   */
-  toCapabilities(opt_capabilities) {
-    var caps = opt_capabilities || Capabilities.safari();
-    if (this.logPrefs_) {
-      caps.set(Capability.LOGGING_PREFS, this.logPrefs_);
-    }
-    if (this.proxy_) {
-      caps.set(Capability.PROXY, this.proxy_);
-    }
-    if (this.options_) {
-      caps.set(OPTIONS_CAPABILITY_KEY, this);
-    }
-    return caps;
-  }
-
-  /**
-   * Converts this instance to its JSON wire protocol representation. Note this
-   * function is an implementation detail not intended for general use.
-   * @return {!Object<string, *>} The JSON wire protocol representation of this
-   *     instance.
-   */
-  [Symbols.serialize]() {
-    return this.options_ || {};
-  }
 }
 
 /**
- * @param  {(Options|Object<string, *>)=} o The options object
+ * @param  {(Capabilities|Object<string, *>)=} o The options object
  * @return {boolean}
  */
 function useTechnologyPreview(o) {
-  if (o instanceof Options) {
-    return !!(o.options_ && o.options_[TECHNOLOGY_PREVIEW_OPTIONS_KEY]);
+  if (o instanceof Capabilities) {
+    let options = o.get(OPTIONS_CAPABILITY_KEY);
+    return !!(options && options[TECHNOLOGY_PREVIEW_OPTIONS_KEY]);
   }
 
   if (o && typeof o === 'object') {
@@ -212,7 +129,10 @@ function useTechnologyPreview(o) {
   return false;
 }
 
-const SAFARIDRIVER_TECHNOLOGY_PREVIEW_EXE = '/Applications/Safari Technology Preview.app/Contents/MacOS/safaridriver';
+
+const SAFARIDRIVER_TECHNOLOGY_PREVIEW_EXE =
+    '/Applications/Safari Technology Preview.app/Contents/MacOS/safaridriver';
+
 
 /**
  * A WebDriver client for Safari. This class should never be instantiated
@@ -227,21 +147,13 @@ class Driver extends webdriver.WebDriver {
   /**
    * Creates a new Safari session.
    *
-   * @param {(Options|Capabilities)=} opt_config The configuration
-   *     options for the new session.
-   * @param {promise.ControlFlow=} opt_flow The control flow to create
-   *     the driver under.
+   * @param {(Options|Capabilities)=} options The configuration options.
    * @return {!Driver} A new driver instance.
    */
-  static createSession(opt_config, opt_flow) {
-    let caps, exe;
-
-    if (opt_config instanceof Options) {
-      caps = opt_config.toCapabilities();
-    } else {
-      caps = opt_config || Capabilities.safari();
-    }
+  static createSession(options) {
+    let caps = options || new Options();
 
+    let exe;
     if (useTechnologyPreview(caps.get(OPTIONS_CAPABILITY_KEY))) {
       exe = SAFARIDRIVER_TECHNOLOGY_PREVIEW_EXE;
     }
@@ -251,7 +163,7 @@ class Driver extends webdriver.WebDriver {
         service.start().then(url => new http.HttpClient(url)));
 
     return /** @type {!Driver} */(super.createSession(
-        executor, caps, opt_flow, () => service.kill()));
+        executor, caps, () => service.kill()));
   }
 }
 
@@ -262,3 +174,4 @@ class Driver extends webdriver.WebDriver {
 exports.Driver = Driver;
 exports.Options = Options;
 exports.ServiceBuilder = ServiceBuilder;
+exports.locateSynchronously = locateSynchronously;