selenium-webdriver 2.43.5 → 2.44.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (219) hide show
  1. package/CHANGES.md +20 -0
  2. package/README.md +8 -13
  3. package/builder.js +4 -3
  4. package/docs/class_webdriver_Alert.html +6 -6
  5. package/docs/class_webdriver_AlertPromise.html +6 -6
  6. package/docs/class_webdriver_UnhandledAlertError.html +4 -4
  7. package/docs/class_webdriver_WebDriver.html +39 -37
  8. package/docs/class_webdriver_WebDriver_Logs.html +3 -3
  9. package/docs/class_webdriver_WebDriver_Navigation.html +5 -5
  10. package/docs/class_webdriver_WebDriver_Options.html +9 -9
  11. package/docs/class_webdriver_WebDriver_TargetLocator.html +6 -6
  12. package/docs/class_webdriver_WebDriver_Timeouts.html +4 -4
  13. package/docs/class_webdriver_WebDriver_Window.html +6 -6
  14. package/docs/class_webdriver_WebElement.html +23 -23
  15. package/docs/class_webdriver_WebElementPromise.html +22 -22
  16. package/docs/class_webdriver_promise_CancellationError.html +3 -0
  17. package/docs/class_webdriver_promise_ControlFlow.html +32 -32
  18. package/docs/class_webdriver_promise_Deferred.html +7 -8
  19. package/docs/class_webdriver_promise_Frame_.html +14 -30
  20. package/docs/class_webdriver_promise_Promise.html +2 -2
  21. package/docs/class_webdriver_promise_Task_.html +12 -12
  22. package/docs/class_webdriver_until_Condition.html +3 -0
  23. package/docs/enum_webdriver_Key.html +1 -1
  24. package/docs/enum_webdriver_promise_ControlFlow_EventType.html +1 -1
  25. package/docs/enum_webdriver_promise_Deferred_State_.html +1 -1
  26. package/docs/index.html +8 -13
  27. package/docs/interface_webdriver_promise_Thenable.html +8 -10
  28. package/docs/license.html +1 -1
  29. package/docs/module_selenium-webdriver.html +2 -2
  30. package/docs/module_selenium-webdriver__base.html +1 -1
  31. package/docs/module_selenium-webdriver__base_class_Context.html +1 -1
  32. package/docs/module_selenium-webdriver_builder.html +1 -1
  33. package/docs/module_selenium-webdriver_builder_class_Builder.html +1 -1
  34. package/docs/module_selenium-webdriver_chrome.html +1 -1
  35. package/docs/module_selenium-webdriver_chrome_class_Driver.html +2 -2
  36. package/docs/module_selenium-webdriver_chrome_class_Options.html +2 -2
  37. package/docs/module_selenium-webdriver_chrome_class_ServiceBuilder.html +1 -1
  38. package/docs/module_selenium-webdriver_error.html +1 -1
  39. package/docs/module_selenium-webdriver_executors.html +1 -1
  40. package/docs/module_selenium-webdriver_firefox.html +1 -1
  41. package/docs/module_selenium-webdriver_firefox_binary.html +1 -1
  42. package/docs/module_selenium-webdriver_firefox_binary_class_Binary.html +1 -1
  43. package/docs/module_selenium-webdriver_firefox_class_Driver.html +2 -2
  44. package/docs/module_selenium-webdriver_firefox_class_Options.html +1 -1
  45. package/docs/module_selenium-webdriver_firefox_extension.html +1 -1
  46. package/docs/module_selenium-webdriver_firefox_profile.html +1 -1
  47. package/docs/module_selenium-webdriver_firefox_profile_class_Profile.html +1 -1
  48. package/docs/module_selenium-webdriver_http.html +1 -1
  49. package/docs/module_selenium-webdriver_http_class_HttpClient.html +1 -1
  50. package/docs/module_selenium-webdriver_http_util.html +1 -1
  51. package/docs/module_selenium-webdriver_io.html +1 -1
  52. package/docs/module_selenium-webdriver_io_exec.html +1 -1
  53. package/docs/module_selenium-webdriver_net.html +1 -1
  54. package/docs/module_selenium-webdriver_net_portprober.html +1 -1
  55. package/docs/module_selenium-webdriver_phantomjs.html +1 -1
  56. package/docs/module_selenium-webdriver_phantomjs_class_Driver.html +2 -2
  57. package/docs/module_selenium-webdriver_proxy.html +1 -1
  58. package/docs/module_selenium-webdriver_remote.html +1 -1
  59. package/docs/module_selenium-webdriver_remote_class_DriverService.html +2 -2
  60. package/docs/module_selenium-webdriver_remote_class_SeleniumServer.html +2 -2
  61. package/docs/module_selenium-webdriver_testing.html +16 -29
  62. package/docs/module_selenium-webdriver_testing_assert.html +1 -1
  63. package/docs/namespace_webdriver_promise.html +18 -20
  64. package/docs/namespace_webdriver_stacktrace.html +15 -15
  65. package/docs/namespace_webdriver_until.html +32 -0
  66. package/docs/source/_base.js.src.html +1 -1
  67. package/docs/source/builder.js.src.html +1 -1
  68. package/docs/source/chrome.js.src.html +1 -1
  69. package/docs/source/error.js.src.html +1 -1
  70. package/docs/source/executors.js.src.html +1 -1
  71. package/docs/source/firefox/binary.js.src.html +1 -1
  72. package/docs/source/firefox/extension.js.src.html +1 -1
  73. package/docs/source/firefox/index.js.src.html +1 -1
  74. package/docs/source/firefox/profile.js.src.html +1 -1
  75. package/docs/source/http/index.js.src.html +1 -1
  76. package/docs/source/http/util.js.src.html +1 -1
  77. package/docs/source/index.js.src.html +1 -1
  78. package/docs/source/io/exec.js.src.html +1 -1
  79. package/docs/source/io/index.js.src.html +1 -1
  80. package/docs/source/lib/atoms/error.js.src.html +1 -1
  81. package/docs/source/lib/atoms/json.js.src.html +1 -1
  82. package/docs/source/lib/atoms/response.js.src.html +1 -1
  83. package/docs/source/lib/atoms/userAgent.js.src.html +1 -1
  84. package/docs/source/lib/goog/array/array.js.src.html +1 -1
  85. package/docs/source/lib/goog/asserts/asserts.js.src.html +1 -1
  86. package/docs/source/lib/goog/async/nexttick.js.src.html +1 -1
  87. package/docs/source/lib/goog/async/run.js.src.html +1 -1
  88. package/docs/source/lib/goog/base.js.src.html +1 -1
  89. package/docs/source/lib/goog/debug/debug.js.src.html +1 -1
  90. package/docs/source/lib/goog/debug/entrypointregistry.js.src.html +1 -1
  91. package/docs/source/lib/goog/debug/error.js.src.html +1 -1
  92. package/docs/source/lib/goog/debug/logbuffer.js.src.html +1 -1
  93. package/docs/source/lib/goog/debug/logger.js.src.html +1 -1
  94. package/docs/source/lib/goog/debug/logrecord.js.src.html +1 -1
  95. package/docs/source/lib/goog/deps.js.src.html +1 -1
  96. package/docs/source/lib/goog/disposable/disposable.js.src.html +1 -1
  97. package/docs/source/lib/goog/disposable/idisposable.js.src.html +1 -1
  98. package/docs/source/lib/goog/dom/browserfeature.js.src.html +1 -1
  99. package/docs/source/lib/goog/dom/dom.js.src.html +1 -1
  100. package/docs/source/lib/goog/dom/nodetype.js.src.html +1 -1
  101. package/docs/source/lib/goog/dom/tagname.js.src.html +1 -1
  102. package/docs/source/lib/goog/dom/vendor.js.src.html +1 -1
  103. package/docs/source/lib/goog/events/browserevent.js.src.html +1 -1
  104. package/docs/source/lib/goog/events/browserfeature.js.src.html +1 -1
  105. package/docs/source/lib/goog/events/event.js.src.html +1 -1
  106. package/docs/source/lib/goog/events/eventid.js.src.html +1 -1
  107. package/docs/source/lib/goog/events/events.js.src.html +1 -1
  108. package/docs/source/lib/goog/events/eventtarget.js.src.html +1 -1
  109. package/docs/source/lib/goog/events/eventtype.js.src.html +1 -1
  110. package/docs/source/lib/goog/events/keycodes.js.src.html +1 -1
  111. package/docs/source/lib/goog/events/listenable.js.src.html +1 -1
  112. package/docs/source/lib/goog/events/listener.js.src.html +1 -1
  113. package/docs/source/lib/goog/events/listenermap.js.src.html +1 -1
  114. package/docs/source/lib/goog/functions/functions.js.src.html +1 -1
  115. package/docs/source/lib/goog/iter/iter.js.src.html +1 -1
  116. package/docs/source/lib/goog/json/json.js.src.html +1 -1
  117. package/docs/source/lib/goog/labs/testing/assertthat.js.src.html +1 -1
  118. package/docs/source/lib/goog/labs/testing/logicmatcher.js.src.html +1 -1
  119. package/docs/source/lib/goog/labs/testing/matcher.js.src.html +1 -1
  120. package/docs/source/lib/goog/labs/testing/numbermatcher.js.src.html +1 -1
  121. package/docs/source/lib/goog/labs/testing/objectmatcher.js.src.html +1 -1
  122. package/docs/source/lib/goog/labs/testing/stringmatcher.js.src.html +1 -1
  123. package/docs/source/lib/goog/labs/useragent/browser.js.src.html +1 -1
  124. package/docs/source/lib/goog/labs/useragent/engine.js.src.html +1 -1
  125. package/docs/source/lib/goog/labs/useragent/util.js.src.html +1 -1
  126. package/docs/source/lib/goog/math/box.js.src.html +1 -1
  127. package/docs/source/lib/goog/math/coordinate.js.src.html +1 -1
  128. package/docs/source/lib/goog/math/math.js.src.html +1 -1
  129. package/docs/source/lib/goog/math/rect.js.src.html +1 -1
  130. package/docs/source/lib/goog/math/size.js.src.html +1 -1
  131. package/docs/source/lib/goog/net/wrapperxmlhttpfactory.js.src.html +1 -1
  132. package/docs/source/lib/goog/net/xhrlike.js.src.html +1 -1
  133. package/docs/source/lib/goog/net/xmlhttp.js.src.html +1 -1
  134. package/docs/source/lib/goog/net/xmlhttpfactory.js.src.html +1 -1
  135. package/docs/source/lib/goog/object/object.js.src.html +1 -1
  136. package/docs/source/lib/goog/reflect/reflect.js.src.html +1 -1
  137. package/docs/source/lib/goog/string/string.js.src.html +1 -1
  138. package/docs/source/lib/goog/structs/collection.js.src.html +1 -1
  139. package/docs/source/lib/goog/structs/map.js.src.html +1 -1
  140. package/docs/source/lib/goog/structs/set.js.src.html +1 -1
  141. package/docs/source/lib/goog/structs/structs.js.src.html +1 -1
  142. package/docs/source/lib/goog/style/style.js.src.html +1 -1
  143. package/docs/source/lib/goog/testing/asserts.js.src.html +1 -1
  144. package/docs/source/lib/goog/testing/asynctestcase.js.src.html +1 -1
  145. package/docs/source/lib/goog/testing/events/events.js.src.html +1 -1
  146. package/docs/source/lib/goog/testing/functionmock.js.src.html +1 -1
  147. package/docs/source/lib/goog/testing/jsunit.js.src.html +1 -1
  148. package/docs/source/lib/goog/testing/loosemock.js.src.html +1 -1
  149. package/docs/source/lib/goog/testing/mock.js.src.html +1 -1
  150. package/docs/source/lib/goog/testing/mockclock.js.src.html +1 -1
  151. package/docs/source/lib/goog/testing/mockcontrol.js.src.html +1 -1
  152. package/docs/source/lib/goog/testing/mockinterface.js.src.html +1 -1
  153. package/docs/source/lib/goog/testing/mockmatchers.js.src.html +1 -1
  154. package/docs/source/lib/goog/testing/objectpropertystring.js.src.html +1 -1
  155. package/docs/source/lib/goog/testing/propertyreplacer.js.src.html +1 -1
  156. package/docs/source/lib/goog/testing/recordfunction.js.src.html +1 -1
  157. package/docs/source/lib/goog/testing/stacktrace.js.src.html +1 -1
  158. package/docs/source/lib/goog/testing/strictmock.js.src.html +1 -1
  159. package/docs/source/lib/goog/testing/testcase.js.src.html +1 -1
  160. package/docs/source/lib/goog/testing/testrunner.js.src.html +1 -1
  161. package/docs/source/lib/goog/testing/watchers.js.src.html +1 -1
  162. package/docs/source/lib/goog/uri/uri.js.src.html +1 -1
  163. package/docs/source/lib/goog/uri/utils.js.src.html +1 -1
  164. package/docs/source/lib/goog/useragent/product.js.src.html +1 -1
  165. package/docs/source/lib/goog/useragent/product_isversion.js.src.html +1 -1
  166. package/docs/source/lib/goog/useragent/useragent.js.src.html +1 -1
  167. package/docs/source/lib/webdriver/abstractbuilder.js.src.html +1 -1
  168. package/docs/source/lib/webdriver/actionsequence.js.src.html +1 -1
  169. package/docs/source/lib/webdriver/builder.js.src.html +1 -1
  170. package/docs/source/lib/webdriver/button.js.src.html +1 -1
  171. package/docs/source/lib/webdriver/capabilities.js.src.html +1 -1
  172. package/docs/source/lib/webdriver/command.js.src.html +1 -1
  173. package/docs/source/lib/webdriver/events.js.src.html +1 -1
  174. package/docs/source/lib/webdriver/firefoxdomexecutor.js.src.html +1 -1
  175. package/docs/source/lib/webdriver/http/corsclient.js.src.html +1 -1
  176. package/docs/source/lib/webdriver/http/http.js.src.html +1 -1
  177. package/docs/source/lib/webdriver/http/xhrclient.js.src.html +1 -1
  178. package/docs/source/lib/webdriver/key.js.src.html +1 -1
  179. package/docs/source/lib/webdriver/locators.js.src.html +1 -1
  180. package/docs/source/lib/webdriver/logging.js.src.html +1 -1
  181. package/docs/source/lib/webdriver/process.js.src.html +1 -1
  182. package/docs/source/lib/webdriver/promise.js.src.html +1 -1
  183. package/docs/source/lib/webdriver/session.js.src.html +1 -1
  184. package/docs/source/lib/webdriver/stacktrace.js.src.html +1 -1
  185. package/docs/source/lib/webdriver/testing/asserts.js.src.html +1 -1
  186. package/docs/source/lib/webdriver/testing/testcase.js.src.html +1 -1
  187. package/docs/source/lib/webdriver/until.js.src.html +1 -0
  188. package/docs/source/lib/webdriver/webdriver.js.src.html +1 -1
  189. package/docs/source/net/index.js.src.html +1 -1
  190. package/docs/source/net/portprober.js.src.html +1 -1
  191. package/docs/source/phantomjs.js.src.html +1 -1
  192. package/docs/source/proxy.js.src.html +1 -1
  193. package/docs/source/remote/index.js.src.html +1 -1
  194. package/docs/source/testing/assert.js.src.html +1 -1
  195. package/docs/source/testing/index.js.src.html +1 -1
  196. package/docs/types.js +1 -1
  197. package/example/google_search.js +9 -17
  198. package/example/google_search_generator.js +6 -7
  199. package/example/google_search_test.js +10 -18
  200. package/example/parallel_flows.js +4 -7
  201. package/index.js +6 -0
  202. package/lib/firefox/webdriver.xpi +0 -0
  203. package/lib/goog/deps.js +7 -5
  204. package/lib/test/index.js +0 -8
  205. package/lib/webdriver/promise.js +263 -251
  206. package/lib/webdriver/stacktrace.js +15 -1
  207. package/lib/webdriver/test/promise_flow_test.js +82 -76
  208. package/lib/webdriver/test/promise_test.js +22 -62
  209. package/lib/webdriver/test/stacktrace_test.js +18 -0
  210. package/lib/webdriver/test/until_test.js +388 -0
  211. package/lib/webdriver/test/webdriver_test.js +41 -0
  212. package/lib/webdriver/until.js +408 -0
  213. package/lib/webdriver/webdriver.js +91 -29
  214. package/package.json +2 -2
  215. package/test/element_finding_test.js +6 -6
  216. package/test/http/util_test.js +4 -5
  217. package/test/page_loading_test.js +7 -7
  218. package/test/stale_element_test.js +2 -10
  219. package/testing/index.js +9 -22
package/docs/source/chrome.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>chrome.js</title><link href="../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>chrome.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2013 Selenium committers<tr><td><a name="l2" href="#l2">2</a><td>// Copyright 2013 Software Freedom Conservancy<tr><td><a name="l3" href="#l3">3</a><td>//<tr><td><a name="l4" href="#l4">4</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l5" href="#l5">5</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l6" href="#l6">6</a><td>// You may obtain a copy of the License at<tr><td><a name="l7" href="#l7">7</a><td>//<tr><td><a name="l8" href="#l8">8</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l9" href="#l9">9</a><td>//<tr><td><a name="l10" href="#l10">10</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l11" href="#l11">11</a><td>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<tr><td><a name="l12" href="#l12">12</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l13" href="#l13">13</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l14" href="#l14">14</a><td>// limitations under the License.<tr><td><a name="l15" href="#l15">15</a><td><tr><td><a name="l16" href="#l16">16</a><td>&#39;use strict&#39;;<tr><td><a name="l17" href="#l17">17</a><td><tr><td><a name="l18" href="#l18">18</a><td>var fs = require(&#39;fs&#39;),<tr><td><a name="l19" href="#l19">19</a><td> util = require(&#39;util&#39;);<tr><td><a name="l20" href="#l20">20</a><td><tr><td><a name="l21" href="#l21">21</a><td>var webdriver = require(&#39;./index&#39;),<tr><td><a name="l22" href="#l22">22</a><td> executors = require(&#39;./executors&#39;),<tr><td><a name="l23" href="#l23">23</a><td> io = require(&#39;./io&#39;),<tr><td><a name="l24" href="#l24">24</a><td> portprober = require(&#39;./net/portprober&#39;),<tr><td><a name="l25" href="#l25">25</a><td> remote = require(&#39;./remote&#39;);<tr><td><a name="l26" href="#l26">26</a><td><tr><td><a name="l27" href="#l27">27</a><td><tr><td><a name="l28" href="#l28">28</a><td>/**<tr><td><a name="l29" href="#l29">29</a><td> * Name of the ChromeDriver executable.<tr><td><a name="l30" href="#l30">30</a><td> * @type {string}<tr><td><a name="l31" href="#l31">31</a><td> * @const<tr><td><a name="l32" href="#l32">32</a><td> */<tr><td><a name="l33" href="#l33">33</a><td>var CHROMEDRIVER_EXE =<tr><td><a name="l34" href="#l34">34</a><td> process.platform === &#39;win32&#39; ? &#39;chromedriver.exe&#39; : &#39;chromedriver&#39;;<tr><td><a name="l35" href="#l35">35</a><td><tr><td><a name="l36" href="#l36">36</a><td><tr><td><a name="l37" href="#l37">37</a><td>/**<tr><td><a name="l38" href="#l38">38</a><td> * Creates {@link remote.DriverService} instances that manage a ChromeDriver<tr><td><a name="l39" href="#l39">39</a><td> * server.<tr><td><a name="l40" href="#l40">40</a><td> * @param {string=} opt_exe Path to the server executable to use. If omitted,<tr><td><a name="l41" href="#l41">41</a><td> * the builder will attempt to locate the chromedriver on the current<tr><td><a name="l42" href="#l42">42</a><td> * PATH.<tr><td><a name="l43" href="#l43">43</a><td> * @throws {Error} If provided executable does not exist, or the chromedriver<tr><td><a name="l44" href="#l44">44</a><td> * cannot be found on the PATH.<tr><td><a name="l45" href="#l45">45</a><td> * @constructor<tr><td><a name="l46" href="#l46">46</a><td> */<tr><td><a name="l47" href="#l47">47</a><td>var ServiceBuilder = function(opt_exe) {<tr><td><a name="l48" href="#l48">48</a><td> /** @private {string} */<tr><td><a name="l49" href="#l49">49</a><td> this.exe_ = opt_exe || io.findInPath(CHROMEDRIVER_EXE, true);<tr><td><a name="l50" href="#l50">50</a><td> if (!this.exe_) {<tr><td><a name="l51" href="#l51">51</a><td> throw Error(<tr><td><a name="l52" href="#l52">52</a><td> &#39;The ChromeDriver could not be found on the current PATH. Please &#39; +<tr><td><a name="l53" href="#l53">53</a><td> &#39;download the latest version of the ChromeDriver from &#39; +<tr><td><a name="l54" href="#l54">54</a><td> &#39;http://chromedriver.storage.googleapis.com/index.html and ensure &#39; +<tr><td><a name="l55" href="#l55">55</a><td> &#39;it can be found on your PATH.&#39;);<tr><td><a name="l56" href="#l56">56</a><td> }<tr><td><a name="l57" href="#l57">57</a><td><tr><td><a name="l58" href="#l58">58</a><td> if (!fs.existsSync(this.exe_)) {<tr><td><a name="l59" href="#l59">59</a><td> throw Error(&#39;File does not exist: &#39; + this.exe_);<tr><td><a name="l60" href="#l60">60</a><td> }<tr><td><a name="l61" href="#l61">61</a><td><tr><td><a name="l62" href="#l62">62</a><td> /** @private {!Array.&lt;string&gt;} */<tr><td><a name="l63" href="#l63">63</a><td> this.args_ = [];<tr><td><a name="l64" href="#l64">64</a><td> this.stdio_ = &#39;ignore&#39;;<tr><td><a name="l65" href="#l65">65</a><td>};<tr><td><a name="l66" href="#l66">66</a><td><tr><td><a name="l67" href="#l67">67</a><td><tr><td><a name="l68" href="#l68">68</a><td>/** @private {number} */<tr><td><a name="l69" href="#l69">69</a><td>ServiceBuilder.prototype.port_ = 0;<tr><td><a name="l70" href="#l70">70</a><td><tr><td><a name="l71" href="#l71">71</a><td><tr><td><a name="l72" href="#l72">72</a><td>/** @private {(string|!Array.&lt;string|number|!Stream|null|undefined&gt;)} */<tr><td><a name="l73" href="#l73">73</a><td>ServiceBuilder.prototype.stdio_ = &#39;ignore&#39;;<tr><td><a name="l74" href="#l74">74</a><td><tr><td><a name="l75" href="#l75">75</a><td><tr><td><a name="l76" href="#l76">76</a><td>/** @private {Object.&lt;string, string&gt;} */<tr><td><a name="l77" href="#l77">77</a><td>ServiceBuilder.prototype.env_ = null;<tr><td><a name="l78" href="#l78">78</a><td><tr><td><a name="l79" href="#l79">79</a><td><tr><td><a name="l80" href="#l80">80</a><td>/**<tr><td><a name="l81" href="#l81">81</a><td> * Sets the port to start the ChromeDriver on.<tr><td><a name="l82" href="#l82">82</a><td> * @param {number} port The port to use, or 0 for any free port.<tr><td><a name="l83" href="#l83">83</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a name="l84" href="#l84">84</a><td> * @throws {Error} If the port is invalid.<tr><td><a name="l85" href="#l85">85</a><td> */<tr><td><a name="l86" href="#l86">86</a><td>ServiceBuilder.prototype.usingPort = function(port) {<tr><td><a name="l87" href="#l87">87</a><td> if (port &lt; 0) {<tr><td><a name="l88" href="#l88">88</a><td> throw Error(&#39;port must be &gt;= 0: &#39; + port);<tr><td><a name="l89" href="#l89">89</a><td> }<tr><td><a name="l90" href="#l90">90</a><td> this.port_ = port;<tr><td><a name="l91" href="#l91">91</a><td> return this;<tr><td><a name="l92" href="#l92">92</a><td>};<tr><td><a name="l93" href="#l93">93</a><td><tr><td><a name="l94" href="#l94">94</a><td><tr><td><a name="l95" href="#l95">95</a><td>/**<tr><td><a name="l96" href="#l96">96</a><td> * Sets the path of the log file the driver should log to. If a log file is<tr><td><a name="l97" href="#l97">97</a><td> * not specified, the driver will log to stderr.<tr><td><a name="l98" href="#l98">98</a><td> * @param {string} path Path of the log file to use.<tr><td><a name="l99" href="#l99">99</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a name="l100" href="#l100">100</a><td> */<tr><td><a name="l101" href="#l101">101</a><td>ServiceBuilder.prototype.loggingTo = function(path) {<tr><td><a name="l102" href="#l102">102</a><td> this.args_.push(&#39;--log-path=&#39; + path);<tr><td><a name="l103" href="#l103">103</a><td> return this;<tr><td><a name="l104" href="#l104">104</a><td>};<tr><td><a name="l105" href="#l105">105</a><td><tr><td><a name="l106" href="#l106">106</a><td><tr><td><a name="l107" href="#l107">107</a><td>/**<tr><td><a name="l108" href="#l108">108</a><td> * Enables verbose logging.<tr><td><a name="l109" href="#l109">109</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a name="l110" href="#l110">110</a><td> */<tr><td><a name="l111" href="#l111">111</a><td>ServiceBuilder.prototype.enableVerboseLogging = function() {<tr><td><a name="l112" href="#l112">112</a><td> this.args_.push(&#39;--verbose&#39;);<tr><td><a name="l113" href="#l113">113</a><td> return this;<tr><td><a name="l114" href="#l114">114</a><td>};<tr><td><a name="l115" href="#l115">115</a><td><tr><td><a name="l116" href="#l116">116</a><td><tr><td><a name="l117" href="#l117">117</a><td>/**<tr><td><a name="l118" href="#l118">118</a><td> * Sets the number of threads the driver should use to manage HTTP requests.<tr><td><a name="l119" href="#l119">119</a><td> * By default, the driver will use 4 threads.<tr><td><a name="l120" href="#l120">120</a><td> * @param {number} n The number of threads to use.<tr><td><a name="l121" href="#l121">121</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a name="l122" href="#l122">122</a><td> */<tr><td><a name="l123" href="#l123">123</a><td>ServiceBuilder.prototype.setNumHttpThreads = function(n) {<tr><td><a name="l124" href="#l124">124</a><td> this.args_.push(&#39;--http-threads=&#39; + n);<tr><td><a name="l125" href="#l125">125</a><td> return this;<tr><td><a name="l126" href="#l126">126</a><td>};<tr><td><a name="l127" href="#l127">127</a><td><tr><td><a name="l128" href="#l128">128</a><td><tr><td><a name="l129" href="#l129">129</a><td>/**<tr><td><a name="l130" href="#l130">130</a><td> * Sets the base path for WebDriver REST commands (e.g. &quot;/wd/hub&quot;).<tr><td><a name="l131" href="#l131">131</a><td> * By default, the driver will accept commands relative to &quot;/&quot;.<tr><td><a name="l132" href="#l132">132</a><td> * @param {string} path The base path to use.<tr><td><a name="l133" href="#l133">133</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a name="l134" href="#l134">134</a><td> */<tr><td><a name="l135" href="#l135">135</a><td>ServiceBuilder.prototype.setUrlBasePath = function(path) {<tr><td><a name="l136" href="#l136">136</a><td> this.args_.push(&#39;--url-base=&#39; + path);<tr><td><a name="l137" href="#l137">137</a><td> return this;<tr><td><a name="l138" href="#l138">138</a><td>};<tr><td><a name="l139" href="#l139">139</a><td><tr><td><a name="l140" href="#l140">140</a><td><tr><td><a name="l141" href="#l141">141</a><td>/**<tr><td><a name="l142" href="#l142">142</a><td> * Defines the stdio configuration for the driver service. See<tr><td><a name="l143" href="#l143">143</a><td> * {@code child_process.spawn} for more information.<tr><td><a name="l144" href="#l144">144</a><td> * @param {(string|!Array.&lt;string|number|!Stream|null|undefined&gt;)} config The<tr><td><a name="l145" href="#l145">145</a><td> * configuration to use.<tr><td><a name="l146" href="#l146">146</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a name="l147" href="#l147">147</a><td> */<tr><td><a name="l148" href="#l148">148</a><td>ServiceBuilder.prototype.setStdio = function(config) {<tr><td><a name="l149" href="#l149">149</a><td> this.stdio_ = config;<tr><td><a name="l150" href="#l150">150</a><td> return this;<tr><td><a name="l151" href="#l151">151</a><td>};<tr><td><a name="l152" href="#l152">152</a><td><tr><td><a name="l153" href="#l153">153</a><td><tr><td><a name="l154" href="#l154">154</a><td>/**<tr><td><a name="l155" href="#l155">155</a><td> * Defines the environment to start the server under. This settings will be<tr><td><a name="l156" href="#l156">156</a><td> * inherited by every browser session started by the server.<tr><td><a name="l157" href="#l157">157</a><td> * @param {!Object.&lt;string, string&gt;} env The environment to use.<tr><td><a name="l158" href="#l158">158</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a name="l159" href="#l159">159</a><td> */<tr><td><a name="l160" href="#l160">160</a><td>ServiceBuilder.prototype.withEnvironment = function(env) {<tr><td><a name="l161" href="#l161">161</a><td> this.env_ = env;<tr><td><a name="l162" href="#l162">162</a><td> return this;<tr><td><a name="l163" href="#l163">163</a><td>};<tr><td><a name="l164" href="#l164">164</a><td><tr><td><a name="l165" href="#l165">165</a><td><tr><td><a name="l166" href="#l166">166</a><td>/**<tr><td><a name="l167" href="#l167">167</a><td> * Creates a new DriverService using this instance&#39;s current configuration.<tr><td><a name="l168" href="#l168">168</a><td> * @return {remote.DriverService} A new driver service using this instance&#39;s<tr><td><a name="l169" href="#l169">169</a><td> * current configuration.<tr><td><a name="l170" href="#l170">170</a><td> * @throws {Error} If the driver exectuable was not specified and a default<tr><td><a name="l171" href="#l171">171</a><td> * could not be found on the current PATH.<tr><td><a name="l172" href="#l172">172</a><td> */<tr><td><a name="l173" href="#l173">173</a><td>ServiceBuilder.prototype.build = function() {<tr><td><a name="l174" href="#l174">174</a><td> var port = this.port_ || portprober.findFreePort();<tr><td><a name="l175" href="#l175">175</a><td> var args = this.args_.concat(); // Defensive copy.<tr><td><a name="l176" href="#l176">176</a><td><tr><td><a name="l177" href="#l177">177</a><td> return new remote.DriverService(this.exe_, {<tr><td><a name="l178" href="#l178">178</a><td> loopback: true,<tr><td><a name="l179" href="#l179">179</a><td> port: port,<tr><td><a name="l180" href="#l180">180</a><td> args: webdriver.promise.when(port, function(port) {<tr><td><a name="l181" href="#l181">181</a><td> return args.concat(&#39;--port=&#39; + port);<tr><td><a name="l182" href="#l182">182</a><td> }),<tr><td><a name="l183" href="#l183">183</a><td> env: this.env_,<tr><td><a name="l184" href="#l184">184</a><td> stdio: this.stdio_<tr><td><a name="l185" href="#l185">185</a><td> });<tr><td><a name="l186" href="#l186">186</a><td>};<tr><td><a name="l187" href="#l187">187</a><td><tr><td><a name="l188" href="#l188">188</a><td><tr><td><a name="l189" href="#l189">189</a><td>/** @type {remote.DriverService} */<tr><td><a name="l190" href="#l190">190</a><td>var defaultService = null;<tr><td><a name="l191" href="#l191">191</a><td><tr><td><a name="l192" href="#l192">192</a><td><tr><td><a name="l193" href="#l193">193</a><td>/**<tr><td><a name="l194" href="#l194">194</a><td> * Sets the default service to use for new ChromeDriver instances.<tr><td><a name="l195" href="#l195">195</a><td> * @param {!remote.DriverService} service The service to use.<tr><td><a name="l196" href="#l196">196</a><td> * @throws {Error} If the default service is currently running.<tr><td><a name="l197" href="#l197">197</a><td> */<tr><td><a name="l198" href="#l198">198</a><td>function setDefaultService(service) {<tr><td><a name="l199" href="#l199">199</a><td> if (defaultService &amp;&amp; defaultService.isRunning()) {<tr><td><a name="l200" href="#l200">200</a><td> throw Error(<tr><td><a name="l201" href="#l201">201</a><td> &#39;The previously configured ChromeDriver service is still running. &#39; +<tr><td><a name="l202" href="#l202">202</a><td> &#39;You must shut it down before you may adjust its configuration.&#39;);<tr><td><a name="l203" href="#l203">203</a><td> }<tr><td><a name="l204" href="#l204">204</a><td> defaultService = service;<tr><td><a name="l205" href="#l205">205</a><td>}<tr><td><a name="l206" href="#l206">206</a><td><tr><td><a name="l207" href="#l207">207</a><td><tr><td><a name="l208" href="#l208">208</a><td>/**<tr><td><a name="l209" href="#l209">209</a><td> * Returns the default ChromeDriver service. If such a service has not been<tr><td><a name="l210" href="#l210">210</a><td> * configured, one will be constructed using the default configuration for<tr><td><a name="l211" href="#l211">211</a><td> * a ChromeDriver executable found on the system PATH.<tr><td><a name="l212" href="#l212">212</a><td> * @return {!remote.DriverService} The default ChromeDriver service.<tr><td><a name="l213" href="#l213">213</a><td> */<tr><td><a name="l214" href="#l214">214</a><td>function getDefaultService() {<tr><td><a name="l215" href="#l215">215</a><td> if (!defaultService) {<tr><td><a name="l216" href="#l216">216</a><td> defaultService = new ServiceBuilder().build();<tr><td><a name="l217" href="#l217">217</a><td> }<tr><td><a name="l218" href="#l218">218</a><td> return defaultService;<tr><td><a name="l219" href="#l219">219</a><td>}<tr><td><a name="l220" href="#l220">220</a><td><tr><td><a name="l221" href="#l221">221</a><td><tr><td><a name="l222" href="#l222">222</a><td>/**<tr><td><a name="l223" href="#l223">223</a><td> * @type {string}<tr><td><a name="l224" href="#l224">224</a><td> * @const<tr><td><a name="l225" href="#l225">225</a><td> */<tr><td><a name="l226" href="#l226">226</a><td>var OPTIONS_CAPABILITY_KEY = &#39;chromeOptions&#39;;<tr><td><a name="l227" href="#l227">227</a><td><tr><td><a name="l228" href="#l228">228</a><td><tr><td><a name="l229" href="#l229">229</a><td>/**<tr><td><a name="l230" href="#l230">230</a><td> * Class for managing ChromeDriver specific options.<tr><td><a name="l231" href="#l231">231</a><td> * @constructor<tr><td><a name="l232" href="#l232">232</a><td> */<tr><td><a name="l233" href="#l233">233</a><td>var Options = function() {<tr><td><a name="l234" href="#l234">234</a><td> /** @private {!Array.&lt;string&gt;} */<tr><td><a name="l235" href="#l235">235</a><td> this.args_ = [];<tr><td><a name="l236" href="#l236">236</a><td><tr><td><a name="l237" href="#l237">237</a><td> /** @private {!Array.&lt;(string|!Buffer)&gt;} */<tr><td><a name="l238" href="#l238">238</a><td> this.extensions_ = [];<tr><td><a name="l239" href="#l239">239</a><td>};<tr><td><a name="l240" href="#l240">240</a><td><tr><td><a name="l241" href="#l241">241</a><td><tr><td><a name="l242" href="#l242">242</a><td>/**<tr><td><a name="l243" href="#l243">243</a><td> * Extracts the ChromeDriver specific options from the given capabilities<tr><td><a name="l244" href="#l244">244</a><td> * object.<tr><td><a name="l245" href="#l245">245</a><td> * @param {!webdriver.Capabilities} capabilities The capabilities object.<tr><td><a name="l246" href="#l246">246</a><td> * @return {!Options} The ChromeDriver options.<tr><td><a name="l247" href="#l247">247</a><td> */<tr><td><a name="l248" href="#l248">248</a><td>Options.fromCapabilities = function(capabilities) {<tr><td><a name="l249" href="#l249">249</a><td> var options = new Options();<tr><td><a name="l250" href="#l250">250</a><td><tr><td><a name="l251" href="#l251">251</a><td> var o = capabilities.get(OPTIONS_CAPABILITY_KEY);<tr><td><a name="l252" href="#l252">252</a><td> if (o instanceof Options) {<tr><td><a name="l253" href="#l253">253</a><td> options = o;<tr><td><a name="l254" href="#l254">254</a><td> } else if (o) {<tr><td><a name="l255" href="#l255">255</a><td> options.<tr><td><a name="l256" href="#l256">256</a><td> addArguments(o.args || []).<tr><td><a name="l257" href="#l257">257</a><td> addExtensions(o.extensions || []).<tr><td><a name="l258" href="#l258">258</a><td> detachDriver(!!o.detach).<tr><td><a name="l259" href="#l259">259</a><td> setChromeBinaryPath(o.binary).<tr><td><a name="l260" href="#l260">260</a><td> setChromeLogFile(o.logFile).<tr><td><a name="l261" href="#l261">261</a><td> setLocalState(o.localState).<tr><td><a name="l262" href="#l262">262</a><td> setUserPreferences(o.prefs);<tr><td><a name="l263" href="#l263">263</a><td> }<tr><td><a name="l264" href="#l264">264</a><td><tr><td><a name="l265" href="#l265">265</a><td> if (capabilities.has(webdriver.Capability.PROXY)) {<tr><td><a name="l266" href="#l266">266</a><td> options.setProxy(capabilities.get(webdriver.Capability.PROXY));<tr><td><a name="l267" href="#l267">267</a><td> }<tr><td><a name="l268" href="#l268">268</a><td><tr><td><a name="l269" href="#l269">269</a><td> if (capabilities.has(webdriver.Capability.LOGGING_PREFS)) {<tr><td><a name="l270" href="#l270">270</a><td> options.setLoggingPrefs(<tr><td><a name="l271" href="#l271">271</a><td> capabilities.get(webdriver.Capability.LOGGING_PREFS));<tr><td><a name="l272" href="#l272">272</a><td> }<tr><td><a name="l273" href="#l273">273</a><td><tr><td><a name="l274" href="#l274">274</a><td> return options;<tr><td><a name="l275" href="#l275">275</a><td>};<tr><td><a name="l276" href="#l276">276</a><td><tr><td><a name="l277" href="#l277">277</a><td><tr><td><a name="l278" href="#l278">278</a><td>/**<tr><td><a name="l279" href="#l279">279</a><td> * Add additional command line arguments to use when launching the Chrome<tr><td><a name="l280" href="#l280">280</a><td> * browser. Each argument may be specified with or without the &quot;--&quot; prefix<tr><td><a name="l281" href="#l281">281</a><td> * (e.g. &quot;--foo&quot; and &quot;foo&quot;). Arguments with an associated value should be<tr><td><a name="l282" href="#l282">282</a><td> * delimited by an &quot;=&quot;: &quot;foo=bar&quot;.<tr><td><a name="l283" href="#l283">283</a><td> * @param {...(string|!Array.&lt;string&gt;)} var_args The arguments to add.<tr><td><a name="l284" href="#l284">284</a><td> * @return {!Options} A self reference.<tr><td><a name="l285" href="#l285">285</a><td> */<tr><td><a name="l286" href="#l286">286</a><td>Options.prototype.addArguments = function(var_args) {<tr><td><a name="l287" href="#l287">287</a><td> this.args_ = this.args_.concat.apply(this.args_, arguments);<tr><td><a name="l288" href="#l288">288</a><td> return this;<tr><td><a name="l289" href="#l289">289</a><td>};<tr><td><a name="l290" href="#l290">290</a><td><tr><td><a name="l291" href="#l291">291</a><td><tr><td><a name="l292" href="#l292">292</a><td>/**<tr><td><a name="l293" href="#l293">293</a><td> * Add additional extensions to install when launching Chrome. Each extension<tr><td><a name="l294" href="#l294">294</a><td> * should be specified as the path to the packed CRX file, or a Buffer for an<tr><td><a name="l295" href="#l295">295</a><td> * extension.<tr><td><a name="l296" href="#l296">296</a><td> * @param {...(string|!Buffer|!Array.&lt;(string|!Buffer)&gt;)} var_args The<tr><td><a name="l297" href="#l297">297</a><td> * extensions to add.<tr><td><a name="l298" href="#l298">298</a><td> * @return {!Options} A self reference.<tr><td><a name="l299" href="#l299">299</a><td> */<tr><td><a name="l300" href="#l300">300</a><td>Options.prototype.addExtensions = function(var_args) {<tr><td><a name="l301" href="#l301">301</a><td> this.extensions_ = this.extensions_.concat.apply(<tr><td><a name="l302" href="#l302">302</a><td> this.extensions_, arguments);<tr><td><a name="l303" href="#l303">303</a><td> return this;<tr><td><a name="l304" href="#l304">304</a><td>};<tr><td><a name="l305" href="#l305">305</a><td><tr><td><a name="l306" href="#l306">306</a><td><tr><td><a name="l307" href="#l307">307</a><td>/**<tr><td><a name="l308" href="#l308">308</a><td> * Sets the path to the Chrome binary to use. On Mac OS X, this path should<tr><td><a name="l309" href="#l309">309</a><td> * reference the actual Chrome executable, not just the application binary<tr><td><a name="l310" href="#l310">310</a><td> * (e.g. &quot;/Applications/Google Chrome.app/Contents/MacOS/Google Chrome&quot;).<tr><td><a name="l311" href="#l311">311</a><td> *<tr><td><a name="l312" href="#l312">312</a><td> * The binary path be absolute or relative to the chromedriver server<tr><td><a name="l313" href="#l313">313</a><td> * executable, but it must exist on the machine that will launch Chrome.<tr><td><a name="l314" href="#l314">314</a><td> *<tr><td><a name="l315" href="#l315">315</a><td> * @param {string} path The path to the Chrome binary to use.<tr><td><a name="l316" href="#l316">316</a><td> * @return {!Options} A self reference.<tr><td><a name="l317" href="#l317">317</a><td> */<tr><td><a name="l318" href="#l318">318</a><td>Options.prototype.setChromeBinaryPath = function(path) {<tr><td><a name="l319" href="#l319">319</a><td> this.binary_ = path;<tr><td><a name="l320" href="#l320">320</a><td> return this;<tr><td><a name="l321" href="#l321">321</a><td>};<tr><td><a name="l322" href="#l322">322</a><td><tr><td><a name="l323" href="#l323">323</a><td><tr><td><a name="l324" href="#l324">324</a><td>/**<tr><td><a name="l325" href="#l325">325</a><td> * Sets whether to leave the started Chrome browser running if the controlling<tr><td><a name="l326" href="#l326">326</a><td> * ChromeDriver service is killed before {@link webdriver.WebDriver#quit()} is<tr><td><a name="l327" href="#l327">327</a><td> * called.<tr><td><a name="l328" href="#l328">328</a><td> * @param {boolean} detach Whether to leave the browser running if the<tr><td><a name="l329" href="#l329">329</a><td> * chromedriver service is killed before the session.<tr><td><a name="l330" href="#l330">330</a><td> * @return {!Options} A self reference.<tr><td><a name="l331" href="#l331">331</a><td> */<tr><td><a name="l332" href="#l332">332</a><td>Options.prototype.detachDriver = function(detach) {<tr><td><a name="l333" href="#l333">333</a><td> this.detach_ = detach;<tr><td><a name="l334" href="#l334">334</a><td> return this;<tr><td><a name="l335" href="#l335">335</a><td>};<tr><td><a name="l336" href="#l336">336</a><td><tr><td><a name="l337" href="#l337">337</a><td><tr><td><a name="l338" href="#l338">338</a><td>/**<tr><td><a name="l339" href="#l339">339</a><td> * Sets the user preferences for Chrome&#39;s user profile. See the &quot;Preferences&quot;<tr><td><a name="l340" href="#l340">340</a><td> * file in Chrome&#39;s user data directory for examples.<tr><td><a name="l341" href="#l341">341</a><td> * @param {!Object} prefs Dictionary of user preferences to use.<tr><td><a name="l342" href="#l342">342</a><td> * @return {!Options} A self reference.<tr><td><a name="l343" href="#l343">343</a><td> */<tr><td><a name="l344" href="#l344">344</a><td>Options.prototype.setUserPreferences = function(prefs) {<tr><td><a name="l345" href="#l345">345</a><td> this.prefs_ = prefs;<tr><td><a name="l346" href="#l346">346</a><td> return this;<tr><td><a name="l347" href="#l347">347</a><td>};<tr><td><a name="l348" href="#l348">348</a><td><tr><td><a name="l349" href="#l349">349</a><td><tr><td><a name="l350" href="#l350">350</a><td>/**<tr><td><a name="l351" href="#l351">351</a><td> * Sets the logging preferences for the new session.<tr><td><a name="l352" href="#l352">352</a><td> * @param {!webdriver.logging.Preferences} prefs The logging preferences.<tr><td><a name="l353" href="#l353">353</a><td> * @return {!Options} A self reference.<tr><td><a name="l354" href="#l354">354</a><td> */<tr><td><a name="l355" href="#l355">355</a><td>Options.prototype.setLoggingPrefs = function(prefs) {<tr><td><a name="l356" href="#l356">356</a><td> this.logPrefs_ = prefs;<tr><td><a name="l357" href="#l357">357</a><td> return this;<tr><td><a name="l358" href="#l358">358</a><td>};<tr><td><a name="l359" href="#l359">359</a><td><tr><td><a name="l360" href="#l360">360</a><td><tr><td><a name="l361" href="#l361">361</a><td>/**<tr><td><a name="l362" href="#l362">362</a><td> * Sets preferences for the &quot;Local State&quot; file in Chrome&#39;s user data<tr><td><a name="l363" href="#l363">363</a><td> * directory.<tr><td><a name="l364" href="#l364">364</a><td> * @param {!Object} state Dictionary of local state preferences.<tr><td><a name="l365" href="#l365">365</a><td> * @return {!Options} A self reference.<tr><td><a name="l366" href="#l366">366</a><td> */<tr><td><a name="l367" href="#l367">367</a><td>Options.prototype.setLocalState = function(state) {<tr><td><a name="l368" href="#l368">368</a><td> this.localState_ = state;<tr><td><a name="l369" href="#l369">369</a><td> return this;<tr><td><a name="l370" href="#l370">370</a><td>};<tr><td><a name="l371" href="#l371">371</a><td><tr><td><a name="l372" href="#l372">372</a><td><tr><td><a name="l373" href="#l373">373</a><td>/**<tr><td><a name="l374" href="#l374">374</a><td> * Sets the path to Chrome&#39;s log file. This path should exist on the machine<tr><td><a name="l375" href="#l375">375</a><td> * that will launch Chrome.<tr><td><a name="l376" href="#l376">376</a><td> * @param {string} path Path to the log file to use.<tr><td><a name="l377" href="#l377">377</a><td> * @return {!Options} A self reference.<tr><td><a name="l378" href="#l378">378</a><td> */<tr><td><a name="l379" href="#l379">379</a><td>Options.prototype.setChromeLogFile = function(path) {<tr><td><a name="l380" href="#l380">380</a><td> this.logFile_ = path;<tr><td><a name="l381" href="#l381">381</a><td> return this;<tr><td><a name="l382" href="#l382">382</a><td>};<tr><td><a name="l383" href="#l383">383</a><td><tr><td><a name="l384" href="#l384">384</a><td><tr><td><a name="l385" href="#l385">385</a><td>/**<tr><td><a name="l386" href="#l386">386</a><td> * Sets the proxy settings for the new session.<tr><td><a name="l387" href="#l387">387</a><td> * @param {webdriver.ProxyConfig} proxy The proxy configuration to use.<tr><td><a name="l388" href="#l388">388</a><td> * @return {!Options} A self reference.<tr><td><a name="l389" href="#l389">389</a><td> */<tr><td><a name="l390" href="#l390">390</a><td>Options.prototype.setProxy = function(proxy) {<tr><td><a name="l391" href="#l391">391</a><td> this.proxy_ = proxy;<tr><td><a name="l392" href="#l392">392</a><td> return this;<tr><td><a name="l393" href="#l393">393</a><td>};<tr><td><a name="l394" href="#l394">394</a><td><tr><td><a name="l395" href="#l395">395</a><td><tr><td><a name="l396" href="#l396">396</a><td>/**<tr><td><a name="l397" href="#l397">397</a><td> * Converts this options instance to a {@link webdriver.Capabilities} object.<tr><td><a name="l398" href="#l398">398</a><td> * @param {webdriver.Capabilities=} opt_capabilities The capabilities to merge<tr><td><a name="l399" href="#l399">399</a><td> * these options into, if any.<tr><td><a name="l400" href="#l400">400</a><td> * @return {!webdriver.Capabilities} The capabilities.<tr><td><a name="l401" href="#l401">401</a><td> */<tr><td><a name="l402" href="#l402">402</a><td>Options.prototype.toCapabilities = function(opt_capabilities) {<tr><td><a name="l403" href="#l403">403</a><td> var capabilities = opt_capabilities || webdriver.Capabilities.chrome();<tr><td><a name="l404" href="#l404">404</a><td> capabilities.<tr><td><a name="l405" href="#l405">405</a><td> set(webdriver.Capability.PROXY, this.proxy_).<tr><td><a name="l406" href="#l406">406</a><td> set(webdriver.Capability.LOGGING_PREFS, this.logPrefs_).<tr><td><a name="l407" href="#l407">407</a><td> set(OPTIONS_CAPABILITY_KEY, this);<tr><td><a name="l408" href="#l408">408</a><td> return capabilities;<tr><td><a name="l409" href="#l409">409</a><td>};<tr><td><a name="l410" href="#l410">410</a><td><tr><td><a name="l411" href="#l411">411</a><td><tr><td><a name="l412" href="#l412">412</a><td>/**<tr><td><a name="l413" href="#l413">413</a><td> * Converts this instance to its JSON wire protocol representation. Note this<tr><td><a name="l414" href="#l414">414</a><td> * function is an implementation not intended for general use.<tr><td><a name="l415" href="#l415">415</a><td> * @return {{args: !Array.&lt;string&gt;,<tr><td><a name="l416" href="#l416">416</a><td> * binary: (string|undefined),<tr><td><a name="l417" href="#l417">417</a><td> * detach: boolean,<tr><td><a name="l418" href="#l418">418</a><td> * extensions: !Array.&lt;string&gt;,<tr><td><a name="l419" href="#l419">419</a><td> * localState: (Object|undefined),<tr><td><a name="l420" href="#l420">420</a><td> * logFile: (string|undefined),<tr><td><a name="l421" href="#l421">421</a><td> * prefs: (Object|undefined)}} The JSON wire protocol representation<tr><td><a name="l422" href="#l422">422</a><td> * of this instance.<tr><td><a name="l423" href="#l423">423</a><td> */<tr><td><a name="l424" href="#l424">424</a><td>Options.prototype.toJSON = function() {<tr><td><a name="l425" href="#l425">425</a><td> return {<tr><td><a name="l426" href="#l426">426</a><td> args: this.args_,<tr><td><a name="l427" href="#l427">427</a><td> binary: this.binary_,<tr><td><a name="l428" href="#l428">428</a><td> detach: !!this.detach_,<tr><td><a name="l429" href="#l429">429</a><td> extensions: this.extensions_.map(function(extension) {<tr><td><a name="l430" href="#l430">430</a><td> if (Buffer.isBuffer(extension)) {<tr><td><a name="l431" href="#l431">431</a><td> return extension.toString(&#39;base64&#39;);<tr><td><a name="l432" href="#l432">432</a><td> }<tr><td><a name="l433" href="#l433">433</a><td> return fs.readFileSync(extension, &#39;base64&#39;);<tr><td><a name="l434" href="#l434">434</a><td> }),<tr><td><a name="l435" href="#l435">435</a><td> localState: this.localState_,<tr><td><a name="l436" href="#l436">436</a><td> logFile: this.logFile_,<tr><td><a name="l437" href="#l437">437</a><td> prefs: this.prefs_<tr><td><a name="l438" href="#l438">438</a><td> };<tr><td><a name="l439" href="#l439">439</a><td>};<tr><td><a name="l440" href="#l440">440</a><td><tr><td><a name="l441" href="#l441">441</a><td><tr><td><a name="l442" href="#l442">442</a><td>/**<tr><td><a name="l443" href="#l443">443</a><td> * Creates a new ChromeDriver session.<tr><td><a name="l444" href="#l444">444</a><td> * @param {(webdriver.Capabilities|Options)=} opt_options The session options.<tr><td><a name="l445" href="#l445">445</a><td> * @param {remote.DriverService=} opt_service The session to use; will use<tr><td><a name="l446" href="#l446">446</a><td> * the {@link getDefaultService default service} by default.<tr><td><a name="l447" href="#l447">447</a><td> * @param {webdriver.promise.ControlFlow=} opt_flow The control flow to use, or<tr><td><a name="l448" href="#l448">448</a><td> * {@code null} to use the currently active flow.<tr><td><a name="l449" href="#l449">449</a><td> * @return {!webdriver.WebDriver} A new WebDriver instance.<tr><td><a name="l450" href="#l450">450</a><td> * @deprecated Use {@link Driver new Driver()}.<tr><td><a name="l451" href="#l451">451</a><td> */<tr><td><a name="l452" href="#l452">452</a><td>function createDriver(opt_options, opt_service, opt_flow) {<tr><td><a name="l453" href="#l453">453</a><td> return new Driver(opt_options, opt_service, opt_flow);<tr><td><a name="l454" href="#l454">454</a><td>}<tr><td><a name="l455" href="#l455">455</a><td><tr><td><a name="l456" href="#l456">456</a><td><tr><td><a name="l457" href="#l457">457</a><td>/**<tr><td><a name="l458" href="#l458">458</a><td> * Creates a new WebDriver client for Chrome.<tr><td><a name="l459" href="#l459">459</a><td> *<tr><td><a name="l460" href="#l460">460</a><td> * @param {(webdriver.Capabilities|Options)=} opt_config The configuration<tr><td><a name="l461" href="#l461">461</a><td> * options.<tr><td><a name="l462" href="#l462">462</a><td> * @param {remote.DriverService=} opt_service The session to use; will use<tr><td><a name="l463" href="#l463">463</a><td> * the {@link getDefaultService default service} by default.<tr><td><a name="l464" href="#l464">464</a><td> * @param {webdriver.promise.ControlFlow=} opt_flow The control flow to use, or<tr><td><a name="l465" href="#l465">465</a><td> * {@code null} to use the currently active flow.<tr><td><a name="l466" href="#l466">466</a><td> * @constructor<tr><td><a name="l467" href="#l467">467</a><td> * @extends {webdriver.WebDriver}<tr><td><a name="l468" href="#l468">468</a><td> */<tr><td><a name="l469" href="#l469">469</a><td>var Driver = function(opt_config, opt_service, opt_flow) {<tr><td><a name="l470" href="#l470">470</a><td> var service = opt_service || getDefaultService();<tr><td><a name="l471" href="#l471">471</a><td> var executor = executors.createExecutor(service.start());<tr><td><a name="l472" href="#l472">472</a><td><tr><td><a name="l473" href="#l473">473</a><td> var capabilities =<tr><td><a name="l474" href="#l474">474</a><td> opt_config instanceof Options ? opt_config.toCapabilities() :<tr><td><a name="l475" href="#l475">475</a><td> (opt_config || webdriver.Capabilities.chrome());<tr><td><a name="l476" href="#l476">476</a><td><tr><td><a name="l477" href="#l477">477</a><td> var driver = webdriver.WebDriver.createSession(<tr><td><a name="l478" href="#l478">478</a><td> executor, capabilities, opt_flow);<tr><td><a name="l479" href="#l479">479</a><td><tr><td><a name="l480" href="#l480">480</a><td> webdriver.WebDriver.call(<tr><td><a name="l481" href="#l481">481</a><td> this, driver.getSession(), executor, driver.controlFlow());<tr><td><a name="l482" href="#l482">482</a><td>};<tr><td><a name="l483" href="#l483">483</a><td>util.inherits(Driver, webdriver.WebDriver);<tr><td><a name="l484" href="#l484">484</a><td><tr><td><a name="l485" href="#l485">485</a><td><tr><td><a name="l486" href="#l486">486</a><td>// PUBLIC API<tr><td><a name="l487" href="#l487">487</a><td><tr><td><a name="l488" href="#l488">488</a><td><tr><td><a name="l489" href="#l489">489</a><td>exports.Driver = Driver;<tr><td><a name="l490" href="#l490">490</a><td>exports.Options = Options;<tr><td><a name="l491" href="#l491">491</a><td>exports.ServiceBuilder = ServiceBuilder;<tr><td><a name="l492" href="#l492">492</a><td>exports.createDriver = createDriver;<tr><td><a name="l493" href="#l493">493</a><td>exports.getDefaultService = getDefaultService;<tr><td><a name="l494" href="#l494">494</a><td>exports.setDefaultService = setDefaultService;</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../types.js"></script><script src="../dossier.js"></script>
1
+ <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>chrome.js</title><link href="../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>chrome.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2013 Selenium committers<tr><td><a name="l2" href="#l2">2</a><td>// Copyright 2013 Software Freedom Conservancy<tr><td><a name="l3" href="#l3">3</a><td>//<tr><td><a name="l4" href="#l4">4</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l5" href="#l5">5</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l6" href="#l6">6</a><td>// You may obtain a copy of the License at<tr><td><a name="l7" href="#l7">7</a><td>//<tr><td><a name="l8" href="#l8">8</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l9" href="#l9">9</a><td>//<tr><td><a name="l10" href="#l10">10</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l11" href="#l11">11</a><td>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<tr><td><a name="l12" href="#l12">12</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l13" href="#l13">13</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l14" href="#l14">14</a><td>// limitations under the License.<tr><td><a name="l15" href="#l15">15</a><td><tr><td><a name="l16" href="#l16">16</a><td>&#39;use strict&#39;;<tr><td><a name="l17" href="#l17">17</a><td><tr><td><a name="l18" href="#l18">18</a><td>var fs = require(&#39;fs&#39;),<tr><td><a name="l19" href="#l19">19</a><td> util = require(&#39;util&#39;);<tr><td><a name="l20" href="#l20">20</a><td><tr><td><a name="l21" href="#l21">21</a><td>var webdriver = require(&#39;./index&#39;),<tr><td><a name="l22" href="#l22">22</a><td> executors = require(&#39;./executors&#39;),<tr><td><a name="l23" href="#l23">23</a><td> io = require(&#39;./io&#39;),<tr><td><a name="l24" href="#l24">24</a><td> portprober = require(&#39;./net/portprober&#39;),<tr><td><a name="l25" href="#l25">25</a><td> remote = require(&#39;./remote&#39;);<tr><td><a name="l26" href="#l26">26</a><td><tr><td><a name="l27" href="#l27">27</a><td><tr><td><a name="l28" href="#l28">28</a><td>/**<tr><td><a name="l29" href="#l29">29</a><td> * Name of the ChromeDriver executable.<tr><td><a name="l30" href="#l30">30</a><td> * @type {string}<tr><td><a name="l31" href="#l31">31</a><td> * @const<tr><td><a name="l32" href="#l32">32</a><td> */<tr><td><a name="l33" href="#l33">33</a><td>var CHROMEDRIVER_EXE =<tr><td><a name="l34" href="#l34">34</a><td> process.platform === &#39;win32&#39; ? &#39;chromedriver.exe&#39; : &#39;chromedriver&#39;;<tr><td><a name="l35" href="#l35">35</a><td><tr><td><a name="l36" href="#l36">36</a><td><tr><td><a name="l37" href="#l37">37</a><td>/**<tr><td><a name="l38" href="#l38">38</a><td> * Creates {@link remote.DriverService} instances that manage a ChromeDriver<tr><td><a name="l39" href="#l39">39</a><td> * server.<tr><td><a name="l40" href="#l40">40</a><td> * @param {string=} opt_exe Path to the server executable to use. If omitted,<tr><td><a name="l41" href="#l41">41</a><td> * the builder will attempt to locate the chromedriver on the current<tr><td><a name="l42" href="#l42">42</a><td> * PATH.<tr><td><a name="l43" href="#l43">43</a><td> * @throws {Error} If provided executable does not exist, or the chromedriver<tr><td><a name="l44" href="#l44">44</a><td> * cannot be found on the PATH.<tr><td><a name="l45" href="#l45">45</a><td> * @constructor<tr><td><a name="l46" href="#l46">46</a><td> */<tr><td><a name="l47" href="#l47">47</a><td>var ServiceBuilder = function(opt_exe) {<tr><td><a name="l48" href="#l48">48</a><td> /** @private {string} */<tr><td><a name="l49" href="#l49">49</a><td> this.exe_ = opt_exe || io.findInPath(CHROMEDRIVER_EXE, true);<tr><td><a name="l50" href="#l50">50</a><td> if (!this.exe_) {<tr><td><a name="l51" href="#l51">51</a><td> throw Error(<tr><td><a name="l52" href="#l52">52</a><td> &#39;The ChromeDriver could not be found on the current PATH. Please &#39; +<tr><td><a name="l53" href="#l53">53</a><td> &#39;download the latest version of the ChromeDriver from &#39; +<tr><td><a name="l54" href="#l54">54</a><td> &#39;http://chromedriver.storage.googleapis.com/index.html and ensure &#39; +<tr><td><a name="l55" href="#l55">55</a><td> &#39;it can be found on your PATH.&#39;);<tr><td><a name="l56" href="#l56">56</a><td> }<tr><td><a name="l57" href="#l57">57</a><td><tr><td><a name="l58" href="#l58">58</a><td> if (!fs.existsSync(this.exe_)) {<tr><td><a name="l59" href="#l59">59</a><td> throw Error(&#39;File does not exist: &#39; + this.exe_);<tr><td><a name="l60" href="#l60">60</a><td> }<tr><td><a name="l61" href="#l61">61</a><td><tr><td><a name="l62" href="#l62">62</a><td> /** @private {!Array.&lt;string&gt;} */<tr><td><a name="l63" href="#l63">63</a><td> this.args_ = [];<tr><td><a name="l64" href="#l64">64</a><td> this.stdio_ = &#39;ignore&#39;;<tr><td><a name="l65" href="#l65">65</a><td>};<tr><td><a name="l66" href="#l66">66</a><td><tr><td><a name="l67" href="#l67">67</a><td><tr><td><a name="l68" href="#l68">68</a><td>/** @private {number} */<tr><td><a name="l69" href="#l69">69</a><td>ServiceBuilder.prototype.port_ = 0;<tr><td><a name="l70" href="#l70">70</a><td><tr><td><a name="l71" href="#l71">71</a><td><tr><td><a name="l72" href="#l72">72</a><td>/** @private {(string|!Array.&lt;string|number|!Stream|null|undefined&gt;)} */<tr><td><a name="l73" href="#l73">73</a><td>ServiceBuilder.prototype.stdio_ = &#39;ignore&#39;;<tr><td><a name="l74" href="#l74">74</a><td><tr><td><a name="l75" href="#l75">75</a><td><tr><td><a name="l76" href="#l76">76</a><td>/** @private {Object.&lt;string, string&gt;} */<tr><td><a name="l77" href="#l77">77</a><td>ServiceBuilder.prototype.env_ = null;<tr><td><a name="l78" href="#l78">78</a><td><tr><td><a name="l79" href="#l79">79</a><td><tr><td><a name="l80" href="#l80">80</a><td>/**<tr><td><a name="l81" href="#l81">81</a><td> * Sets the port to start the ChromeDriver on.<tr><td><a name="l82" href="#l82">82</a><td> * @param {number} port The port to use, or 0 for any free port.<tr><td><a name="l83" href="#l83">83</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a name="l84" href="#l84">84</a><td> * @throws {Error} If the port is invalid.<tr><td><a name="l85" href="#l85">85</a><td> */<tr><td><a name="l86" href="#l86">86</a><td>ServiceBuilder.prototype.usingPort = function(port) {<tr><td><a name="l87" href="#l87">87</a><td> if (port &lt; 0) {<tr><td><a name="l88" href="#l88">88</a><td> throw Error(&#39;port must be &gt;= 0: &#39; + port);<tr><td><a name="l89" href="#l89">89</a><td> }<tr><td><a name="l90" href="#l90">90</a><td> this.port_ = port;<tr><td><a name="l91" href="#l91">91</a><td> return this;<tr><td><a name="l92" href="#l92">92</a><td>};<tr><td><a name="l93" href="#l93">93</a><td><tr><td><a name="l94" href="#l94">94</a><td><tr><td><a name="l95" href="#l95">95</a><td>/**<tr><td><a name="l96" href="#l96">96</a><td> * Sets the path of the log file the driver should log to. If a log file is<tr><td><a name="l97" href="#l97">97</a><td> * not specified, the driver will log to stderr.<tr><td><a name="l98" href="#l98">98</a><td> * @param {string} path Path of the log file to use.<tr><td><a name="l99" href="#l99">99</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a name="l100" href="#l100">100</a><td> */<tr><td><a name="l101" href="#l101">101</a><td>ServiceBuilder.prototype.loggingTo = function(path) {<tr><td><a name="l102" href="#l102">102</a><td> this.args_.push(&#39;--log-path=&#39; + path);<tr><td><a name="l103" href="#l103">103</a><td> return this;<tr><td><a name="l104" href="#l104">104</a><td>};<tr><td><a name="l105" href="#l105">105</a><td><tr><td><a name="l106" href="#l106">106</a><td><tr><td><a name="l107" href="#l107">107</a><td>/**<tr><td><a name="l108" href="#l108">108</a><td> * Enables verbose logging.<tr><td><a name="l109" href="#l109">109</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a name="l110" href="#l110">110</a><td> */<tr><td><a name="l111" href="#l111">111</a><td>ServiceBuilder.prototype.enableVerboseLogging = function() {<tr><td><a name="l112" href="#l112">112</a><td> this.args_.push(&#39;--verbose&#39;);<tr><td><a name="l113" href="#l113">113</a><td> return this;<tr><td><a name="l114" href="#l114">114</a><td>};<tr><td><a name="l115" href="#l115">115</a><td><tr><td><a name="l116" href="#l116">116</a><td><tr><td><a name="l117" href="#l117">117</a><td>/**<tr><td><a name="l118" href="#l118">118</a><td> * Sets the number of threads the driver should use to manage HTTP requests.<tr><td><a name="l119" href="#l119">119</a><td> * By default, the driver will use 4 threads.<tr><td><a name="l120" href="#l120">120</a><td> * @param {number} n The number of threads to use.<tr><td><a name="l121" href="#l121">121</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a name="l122" href="#l122">122</a><td> */<tr><td><a name="l123" href="#l123">123</a><td>ServiceBuilder.prototype.setNumHttpThreads = function(n) {<tr><td><a name="l124" href="#l124">124</a><td> this.args_.push(&#39;--http-threads=&#39; + n);<tr><td><a name="l125" href="#l125">125</a><td> return this;<tr><td><a name="l126" href="#l126">126</a><td>};<tr><td><a name="l127" href="#l127">127</a><td><tr><td><a name="l128" href="#l128">128</a><td><tr><td><a name="l129" href="#l129">129</a><td>/**<tr><td><a name="l130" href="#l130">130</a><td> * Sets the base path for WebDriver REST commands (e.g. &quot;/wd/hub&quot;).<tr><td><a name="l131" href="#l131">131</a><td> * By default, the driver will accept commands relative to &quot;/&quot;.<tr><td><a name="l132" href="#l132">132</a><td> * @param {string} path The base path to use.<tr><td><a name="l133" href="#l133">133</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a name="l134" href="#l134">134</a><td> */<tr><td><a name="l135" href="#l135">135</a><td>ServiceBuilder.prototype.setUrlBasePath = function(path) {<tr><td><a name="l136" href="#l136">136</a><td> this.args_.push(&#39;--url-base=&#39; + path);<tr><td><a name="l137" href="#l137">137</a><td> return this;<tr><td><a name="l138" href="#l138">138</a><td>};<tr><td><a name="l139" href="#l139">139</a><td><tr><td><a name="l140" href="#l140">140</a><td><tr><td><a name="l141" href="#l141">141</a><td>/**<tr><td><a name="l142" href="#l142">142</a><td> * Defines the stdio configuration for the driver service. See<tr><td><a name="l143" href="#l143">143</a><td> * {@code child_process.spawn} for more information.<tr><td><a name="l144" href="#l144">144</a><td> * @param {(string|!Array.&lt;string|number|!Stream|null|undefined&gt;)} config The<tr><td><a name="l145" href="#l145">145</a><td> * configuration to use.<tr><td><a name="l146" href="#l146">146</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a name="l147" href="#l147">147</a><td> */<tr><td><a name="l148" href="#l148">148</a><td>ServiceBuilder.prototype.setStdio = function(config) {<tr><td><a name="l149" href="#l149">149</a><td> this.stdio_ = config;<tr><td><a name="l150" href="#l150">150</a><td> return this;<tr><td><a name="l151" href="#l151">151</a><td>};<tr><td><a name="l152" href="#l152">152</a><td><tr><td><a name="l153" href="#l153">153</a><td><tr><td><a name="l154" href="#l154">154</a><td>/**<tr><td><a name="l155" href="#l155">155</a><td> * Defines the environment to start the server under. This settings will be<tr><td><a name="l156" href="#l156">156</a><td> * inherited by every browser session started by the server.<tr><td><a name="l157" href="#l157">157</a><td> * @param {!Object.&lt;string, string&gt;} env The environment to use.<tr><td><a name="l158" href="#l158">158</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a name="l159" href="#l159">159</a><td> */<tr><td><a name="l160" href="#l160">160</a><td>ServiceBuilder.prototype.withEnvironment = function(env) {<tr><td><a name="l161" href="#l161">161</a><td> this.env_ = env;<tr><td><a name="l162" href="#l162">162</a><td> return this;<tr><td><a name="l163" href="#l163">163</a><td>};<tr><td><a name="l164" href="#l164">164</a><td><tr><td><a name="l165" href="#l165">165</a><td><tr><td><a name="l166" href="#l166">166</a><td>/**<tr><td><a name="l167" href="#l167">167</a><td> * Creates a new DriverService using this instance&#39;s current configuration.<tr><td><a name="l168" href="#l168">168</a><td> * @return {remote.DriverService} A new driver service using this instance&#39;s<tr><td><a name="l169" href="#l169">169</a><td> * current configuration.<tr><td><a name="l170" href="#l170">170</a><td> * @throws {Error} If the driver exectuable was not specified and a default<tr><td><a name="l171" href="#l171">171</a><td> * could not be found on the current PATH.<tr><td><a name="l172" href="#l172">172</a><td> */<tr><td><a name="l173" href="#l173">173</a><td>ServiceBuilder.prototype.build = function() {<tr><td><a name="l174" href="#l174">174</a><td> var port = this.port_ || portprober.findFreePort();<tr><td><a name="l175" href="#l175">175</a><td> var args = this.args_.concat(); // Defensive copy.<tr><td><a name="l176" href="#l176">176</a><td><tr><td><a name="l177" href="#l177">177</a><td> return new remote.DriverService(this.exe_, {<tr><td><a name="l178" href="#l178">178</a><td> loopback: true,<tr><td><a name="l179" href="#l179">179</a><td> port: port,<tr><td><a name="l180" href="#l180">180</a><td> args: webdriver.promise.when(port, function(port) {<tr><td><a name="l181" href="#l181">181</a><td> return args.concat(&#39;--port=&#39; + port);<tr><td><a name="l182" href="#l182">182</a><td> }),<tr><td><a name="l183" href="#l183">183</a><td> env: this.env_,<tr><td><a name="l184" href="#l184">184</a><td> stdio: this.stdio_<tr><td><a name="l185" href="#l185">185</a><td> });<tr><td><a name="l186" href="#l186">186</a><td>};<tr><td><a name="l187" href="#l187">187</a><td><tr><td><a name="l188" href="#l188">188</a><td><tr><td><a name="l189" href="#l189">189</a><td>/** @type {remote.DriverService} */<tr><td><a name="l190" href="#l190">190</a><td>var defaultService = null;<tr><td><a name="l191" href="#l191">191</a><td><tr><td><a name="l192" href="#l192">192</a><td><tr><td><a name="l193" href="#l193">193</a><td>/**<tr><td><a name="l194" href="#l194">194</a><td> * Sets the default service to use for new ChromeDriver instances.<tr><td><a name="l195" href="#l195">195</a><td> * @param {!remote.DriverService} service The service to use.<tr><td><a name="l196" href="#l196">196</a><td> * @throws {Error} If the default service is currently running.<tr><td><a name="l197" href="#l197">197</a><td> */<tr><td><a name="l198" href="#l198">198</a><td>function setDefaultService(service) {<tr><td><a name="l199" href="#l199">199</a><td> if (defaultService &amp;&amp; defaultService.isRunning()) {<tr><td><a name="l200" href="#l200">200</a><td> throw Error(<tr><td><a name="l201" href="#l201">201</a><td> &#39;The previously configured ChromeDriver service is still running. &#39; +<tr><td><a name="l202" href="#l202">202</a><td> &#39;You must shut it down before you may adjust its configuration.&#39;);<tr><td><a name="l203" href="#l203">203</a><td> }<tr><td><a name="l204" href="#l204">204</a><td> defaultService = service;<tr><td><a name="l205" href="#l205">205</a><td>}<tr><td><a name="l206" href="#l206">206</a><td><tr><td><a name="l207" href="#l207">207</a><td><tr><td><a name="l208" href="#l208">208</a><td>/**<tr><td><a name="l209" href="#l209">209</a><td> * Returns the default ChromeDriver service. If such a service has not been<tr><td><a name="l210" href="#l210">210</a><td> * configured, one will be constructed using the default configuration for<tr><td><a name="l211" href="#l211">211</a><td> * a ChromeDriver executable found on the system PATH.<tr><td><a name="l212" href="#l212">212</a><td> * @return {!remote.DriverService} The default ChromeDriver service.<tr><td><a name="l213" href="#l213">213</a><td> */<tr><td><a name="l214" href="#l214">214</a><td>function getDefaultService() {<tr><td><a name="l215" href="#l215">215</a><td> if (!defaultService) {<tr><td><a name="l216" href="#l216">216</a><td> defaultService = new ServiceBuilder().build();<tr><td><a name="l217" href="#l217">217</a><td> }<tr><td><a name="l218" href="#l218">218</a><td> return defaultService;<tr><td><a name="l219" href="#l219">219</a><td>}<tr><td><a name="l220" href="#l220">220</a><td><tr><td><a name="l221" href="#l221">221</a><td><tr><td><a name="l222" href="#l222">222</a><td>/**<tr><td><a name="l223" href="#l223">223</a><td> * @type {string}<tr><td><a name="l224" href="#l224">224</a><td> * @const<tr><td><a name="l225" href="#l225">225</a><td> */<tr><td><a name="l226" href="#l226">226</a><td>var OPTIONS_CAPABILITY_KEY = &#39;chromeOptions&#39;;<tr><td><a name="l227" href="#l227">227</a><td><tr><td><a name="l228" href="#l228">228</a><td><tr><td><a name="l229" href="#l229">229</a><td>/**<tr><td><a name="l230" href="#l230">230</a><td> * Class for managing ChromeDriver specific options.<tr><td><a name="l231" href="#l231">231</a><td> * @constructor<tr><td><a name="l232" href="#l232">232</a><td> */<tr><td><a name="l233" href="#l233">233</a><td>var Options = function() {<tr><td><a name="l234" href="#l234">234</a><td> /** @private {!Array.&lt;string&gt;} */<tr><td><a name="l235" href="#l235">235</a><td> this.args_ = [];<tr><td><a name="l236" href="#l236">236</a><td><tr><td><a name="l237" href="#l237">237</a><td> /** @private {!Array.&lt;(string|!Buffer)&gt;} */<tr><td><a name="l238" href="#l238">238</a><td> this.extensions_ = [];<tr><td><a name="l239" href="#l239">239</a><td>};<tr><td><a name="l240" href="#l240">240</a><td><tr><td><a name="l241" href="#l241">241</a><td><tr><td><a name="l242" href="#l242">242</a><td>/**<tr><td><a name="l243" href="#l243">243</a><td> * Extracts the ChromeDriver specific options from the given capabilities<tr><td><a name="l244" href="#l244">244</a><td> * object.<tr><td><a name="l245" href="#l245">245</a><td> * @param {!webdriver.Capabilities} capabilities The capabilities object.<tr><td><a name="l246" href="#l246">246</a><td> * @return {!Options} The ChromeDriver options.<tr><td><a name="l247" href="#l247">247</a><td> */<tr><td><a name="l248" href="#l248">248</a><td>Options.fromCapabilities = function(capabilities) {<tr><td><a name="l249" href="#l249">249</a><td> var options = new Options();<tr><td><a name="l250" href="#l250">250</a><td><tr><td><a name="l251" href="#l251">251</a><td> var o = capabilities.get(OPTIONS_CAPABILITY_KEY);<tr><td><a name="l252" href="#l252">252</a><td> if (o instanceof Options) {<tr><td><a name="l253" href="#l253">253</a><td> options = o;<tr><td><a name="l254" href="#l254">254</a><td> } else if (o) {<tr><td><a name="l255" href="#l255">255</a><td> options.<tr><td><a name="l256" href="#l256">256</a><td> addArguments(o.args || []).<tr><td><a name="l257" href="#l257">257</a><td> addExtensions(o.extensions || []).<tr><td><a name="l258" href="#l258">258</a><td> detachDriver(!!o.detach).<tr><td><a name="l259" href="#l259">259</a><td> setChromeBinaryPath(o.binary).<tr><td><a name="l260" href="#l260">260</a><td> setChromeLogFile(o.logFile).<tr><td><a name="l261" href="#l261">261</a><td> setLocalState(o.localState).<tr><td><a name="l262" href="#l262">262</a><td> setUserPreferences(o.prefs);<tr><td><a name="l263" href="#l263">263</a><td> }<tr><td><a name="l264" href="#l264">264</a><td><tr><td><a name="l265" href="#l265">265</a><td> if (capabilities.has(webdriver.Capability.PROXY)) {<tr><td><a name="l266" href="#l266">266</a><td> options.setProxy(capabilities.get(webdriver.Capability.PROXY));<tr><td><a name="l267" href="#l267">267</a><td> }<tr><td><a name="l268" href="#l268">268</a><td><tr><td><a name="l269" href="#l269">269</a><td> if (capabilities.has(webdriver.Capability.LOGGING_PREFS)) {<tr><td><a name="l270" href="#l270">270</a><td> options.setLoggingPrefs(<tr><td><a name="l271" href="#l271">271</a><td> capabilities.get(webdriver.Capability.LOGGING_PREFS));<tr><td><a name="l272" href="#l272">272</a><td> }<tr><td><a name="l273" href="#l273">273</a><td><tr><td><a name="l274" href="#l274">274</a><td> return options;<tr><td><a name="l275" href="#l275">275</a><td>};<tr><td><a name="l276" href="#l276">276</a><td><tr><td><a name="l277" href="#l277">277</a><td><tr><td><a name="l278" href="#l278">278</a><td>/**<tr><td><a name="l279" href="#l279">279</a><td> * Add additional command line arguments to use when launching the Chrome<tr><td><a name="l280" href="#l280">280</a><td> * browser. Each argument may be specified with or without the &quot;--&quot; prefix<tr><td><a name="l281" href="#l281">281</a><td> * (e.g. &quot;--foo&quot; and &quot;foo&quot;). Arguments with an associated value should be<tr><td><a name="l282" href="#l282">282</a><td> * delimited by an &quot;=&quot;: &quot;foo=bar&quot;.<tr><td><a name="l283" href="#l283">283</a><td> * @param {...(string|!Array.&lt;string&gt;)} var_args The arguments to add.<tr><td><a name="l284" href="#l284">284</a><td> * @return {!Options} A self reference.<tr><td><a name="l285" href="#l285">285</a><td> */<tr><td><a name="l286" href="#l286">286</a><td>Options.prototype.addArguments = function(var_args) {<tr><td><a name="l287" href="#l287">287</a><td> this.args_ = this.args_.concat.apply(this.args_, arguments);<tr><td><a name="l288" href="#l288">288</a><td> return this;<tr><td><a name="l289" href="#l289">289</a><td>};<tr><td><a name="l290" href="#l290">290</a><td><tr><td><a name="l291" href="#l291">291</a><td><tr><td><a name="l292" href="#l292">292</a><td>/**<tr><td><a name="l293" href="#l293">293</a><td> * Add additional extensions to install when launching Chrome. Each extension<tr><td><a name="l294" href="#l294">294</a><td> * should be specified as the path to the packed CRX file, or a Buffer for an<tr><td><a name="l295" href="#l295">295</a><td> * extension.<tr><td><a name="l296" href="#l296">296</a><td> * @param {...(string|!Buffer|!Array.&lt;(string|!Buffer)&gt;)} var_args The<tr><td><a name="l297" href="#l297">297</a><td> * extensions to add.<tr><td><a name="l298" href="#l298">298</a><td> * @return {!Options} A self reference.<tr><td><a name="l299" href="#l299">299</a><td> */<tr><td><a name="l300" href="#l300">300</a><td>Options.prototype.addExtensions = function(var_args) {<tr><td><a name="l301" href="#l301">301</a><td> this.extensions_ = this.extensions_.concat.apply(<tr><td><a name="l302" href="#l302">302</a><td> this.extensions_, arguments);<tr><td><a name="l303" href="#l303">303</a><td> return this;<tr><td><a name="l304" href="#l304">304</a><td>};<tr><td><a name="l305" href="#l305">305</a><td><tr><td><a name="l306" href="#l306">306</a><td><tr><td><a name="l307" href="#l307">307</a><td>/**<tr><td><a name="l308" href="#l308">308</a><td> * Sets the path to the Chrome binary to use. On Mac OS X, this path should<tr><td><a name="l309" href="#l309">309</a><td> * reference the actual Chrome executable, not just the application binary<tr><td><a name="l310" href="#l310">310</a><td> * (e.g. &quot;/Applications/Google Chrome.app/Contents/MacOS/Google Chrome&quot;).<tr><td><a name="l311" href="#l311">311</a><td> *<tr><td><a name="l312" href="#l312">312</a><td> * The binary path be absolute or relative to the chromedriver server<tr><td><a name="l313" href="#l313">313</a><td> * executable, but it must exist on the machine that will launch Chrome.<tr><td><a name="l314" href="#l314">314</a><td> *<tr><td><a name="l315" href="#l315">315</a><td> * @param {string} path The path to the Chrome binary to use.<tr><td><a name="l316" href="#l316">316</a><td> * @return {!Options} A self reference.<tr><td><a name="l317" href="#l317">317</a><td> */<tr><td><a name="l318" href="#l318">318</a><td>Options.prototype.setChromeBinaryPath = function(path) {<tr><td><a name="l319" href="#l319">319</a><td> this.binary_ = path;<tr><td><a name="l320" href="#l320">320</a><td> return this;<tr><td><a name="l321" href="#l321">321</a><td>};<tr><td><a name="l322" href="#l322">322</a><td><tr><td><a name="l323" href="#l323">323</a><td><tr><td><a name="l324" href="#l324">324</a><td>/**<tr><td><a name="l325" href="#l325">325</a><td> * Sets whether to leave the started Chrome browser running if the controlling<tr><td><a name="l326" href="#l326">326</a><td> * ChromeDriver service is killed before {@link webdriver.WebDriver#quit()} is<tr><td><a name="l327" href="#l327">327</a><td> * called.<tr><td><a name="l328" href="#l328">328</a><td> * @param {boolean} detach Whether to leave the browser running if the<tr><td><a name="l329" href="#l329">329</a><td> * chromedriver service is killed before the session.<tr><td><a name="l330" href="#l330">330</a><td> * @return {!Options} A self reference.<tr><td><a name="l331" href="#l331">331</a><td> */<tr><td><a name="l332" href="#l332">332</a><td>Options.prototype.detachDriver = function(detach) {<tr><td><a name="l333" href="#l333">333</a><td> this.detach_ = detach;<tr><td><a name="l334" href="#l334">334</a><td> return this;<tr><td><a name="l335" href="#l335">335</a><td>};<tr><td><a name="l336" href="#l336">336</a><td><tr><td><a name="l337" href="#l337">337</a><td><tr><td><a name="l338" href="#l338">338</a><td>/**<tr><td><a name="l339" href="#l339">339</a><td> * Sets the user preferences for Chrome&#39;s user profile. See the &quot;Preferences&quot;<tr><td><a name="l340" href="#l340">340</a><td> * file in Chrome&#39;s user data directory for examples.<tr><td><a name="l341" href="#l341">341</a><td> * @param {!Object} prefs Dictionary of user preferences to use.<tr><td><a name="l342" href="#l342">342</a><td> * @return {!Options} A self reference.<tr><td><a name="l343" href="#l343">343</a><td> */<tr><td><a name="l344" href="#l344">344</a><td>Options.prototype.setUserPreferences = function(prefs) {<tr><td><a name="l345" href="#l345">345</a><td> this.prefs_ = prefs;<tr><td><a name="l346" href="#l346">346</a><td> return this;<tr><td><a name="l347" href="#l347">347</a><td>};<tr><td><a name="l348" href="#l348">348</a><td><tr><td><a name="l349" href="#l349">349</a><td><tr><td><a name="l350" href="#l350">350</a><td>/**<tr><td><a name="l351" href="#l351">351</a><td> * Sets the logging preferences for the new session.<tr><td><a name="l352" href="#l352">352</a><td> * @param {!webdriver.logging.Preferences} prefs The logging preferences.<tr><td><a name="l353" href="#l353">353</a><td> * @return {!Options} A self reference.<tr><td><a name="l354" href="#l354">354</a><td> */<tr><td><a name="l355" href="#l355">355</a><td>Options.prototype.setLoggingPrefs = function(prefs) {<tr><td><a name="l356" href="#l356">356</a><td> this.logPrefs_ = prefs;<tr><td><a name="l357" href="#l357">357</a><td> return this;<tr><td><a name="l358" href="#l358">358</a><td>};<tr><td><a name="l359" href="#l359">359</a><td><tr><td><a name="l360" href="#l360">360</a><td><tr><td><a name="l361" href="#l361">361</a><td>/**<tr><td><a name="l362" href="#l362">362</a><td> * Sets preferences for the &quot;Local State&quot; file in Chrome&#39;s user data<tr><td><a name="l363" href="#l363">363</a><td> * directory.<tr><td><a name="l364" href="#l364">364</a><td> * @param {!Object} state Dictionary of local state preferences.<tr><td><a name="l365" href="#l365">365</a><td> * @return {!Options} A self reference.<tr><td><a name="l366" href="#l366">366</a><td> */<tr><td><a name="l367" href="#l367">367</a><td>Options.prototype.setLocalState = function(state) {<tr><td><a name="l368" href="#l368">368</a><td> this.localState_ = state;<tr><td><a name="l369" href="#l369">369</a><td> return this;<tr><td><a name="l370" href="#l370">370</a><td>};<tr><td><a name="l371" href="#l371">371</a><td><tr><td><a name="l372" href="#l372">372</a><td><tr><td><a name="l373" href="#l373">373</a><td>/**<tr><td><a name="l374" href="#l374">374</a><td> * Sets the path to Chrome&#39;s log file. This path should exist on the machine<tr><td><a name="l375" href="#l375">375</a><td> * that will launch Chrome.<tr><td><a name="l376" href="#l376">376</a><td> * @param {string} path Path to the log file to use.<tr><td><a name="l377" href="#l377">377</a><td> * @return {!Options} A self reference.<tr><td><a name="l378" href="#l378">378</a><td> */<tr><td><a name="l379" href="#l379">379</a><td>Options.prototype.setChromeLogFile = function(path) {<tr><td><a name="l380" href="#l380">380</a><td> this.logFile_ = path;<tr><td><a name="l381" href="#l381">381</a><td> return this;<tr><td><a name="l382" href="#l382">382</a><td>};<tr><td><a name="l383" href="#l383">383</a><td><tr><td><a name="l384" href="#l384">384</a><td><tr><td><a name="l385" href="#l385">385</a><td>/**<tr><td><a name="l386" href="#l386">386</a><td> * Sets the proxy settings for the new session.<tr><td><a name="l387" href="#l387">387</a><td> * @param {webdriver.ProxyConfig} proxy The proxy configuration to use.<tr><td><a name="l388" href="#l388">388</a><td> * @return {!Options} A self reference.<tr><td><a name="l389" href="#l389">389</a><td> */<tr><td><a name="l390" href="#l390">390</a><td>Options.prototype.setProxy = function(proxy) {<tr><td><a name="l391" href="#l391">391</a><td> this.proxy_ = proxy;<tr><td><a name="l392" href="#l392">392</a><td> return this;<tr><td><a name="l393" href="#l393">393</a><td>};<tr><td><a name="l394" href="#l394">394</a><td><tr><td><a name="l395" href="#l395">395</a><td><tr><td><a name="l396" href="#l396">396</a><td>/**<tr><td><a name="l397" href="#l397">397</a><td> * Converts this options instance to a {@link webdriver.Capabilities} object.<tr><td><a name="l398" href="#l398">398</a><td> * @param {webdriver.Capabilities=} opt_capabilities The capabilities to merge<tr><td><a name="l399" href="#l399">399</a><td> * these options into, if any.<tr><td><a name="l400" href="#l400">400</a><td> * @return {!webdriver.Capabilities} The capabilities.<tr><td><a name="l401" href="#l401">401</a><td> */<tr><td><a name="l402" href="#l402">402</a><td>Options.prototype.toCapabilities = function(opt_capabilities) {<tr><td><a name="l403" href="#l403">403</a><td> var capabilities = opt_capabilities || webdriver.Capabilities.chrome();<tr><td><a name="l404" href="#l404">404</a><td> capabilities.<tr><td><a name="l405" href="#l405">405</a><td> set(webdriver.Capability.PROXY, this.proxy_).<tr><td><a name="l406" href="#l406">406</a><td> set(webdriver.Capability.LOGGING_PREFS, this.logPrefs_).<tr><td><a name="l407" href="#l407">407</a><td> set(OPTIONS_CAPABILITY_KEY, this);<tr><td><a name="l408" href="#l408">408</a><td> return capabilities;<tr><td><a name="l409" href="#l409">409</a><td>};<tr><td><a name="l410" href="#l410">410</a><td><tr><td><a name="l411" href="#l411">411</a><td><tr><td><a name="l412" href="#l412">412</a><td>/**<tr><td><a name="l413" href="#l413">413</a><td> * Converts this instance to its JSON wire protocol representation. Note this<tr><td><a name="l414" href="#l414">414</a><td> * function is an implementation not intended for general use.<tr><td><a name="l415" href="#l415">415</a><td> * @return {{args: !Array.&lt;string&gt;,<tr><td><a name="l416" href="#l416">416</a><td> * binary: (string|undefined),<tr><td><a name="l417" href="#l417">417</a><td> * detach: boolean,<tr><td><a name="l418" href="#l418">418</a><td> * extensions: !Array.&lt;string&gt;,<tr><td><a name="l419" href="#l419">419</a><td> * localState: (Object|undefined),<tr><td><a name="l420" href="#l420">420</a><td> * logFile: (string|undefined),<tr><td><a name="l421" href="#l421">421</a><td> * prefs: (Object|undefined)}} The JSON wire protocol representation<tr><td><a name="l422" href="#l422">422</a><td> * of this instance.<tr><td><a name="l423" href="#l423">423</a><td> */<tr><td><a name="l424" href="#l424">424</a><td>Options.prototype.toJSON = function() {<tr><td><a name="l425" href="#l425">425</a><td> return {<tr><td><a name="l426" href="#l426">426</a><td> args: this.args_,<tr><td><a name="l427" href="#l427">427</a><td> binary: this.binary_,<tr><td><a name="l428" href="#l428">428</a><td> detach: !!this.detach_,<tr><td><a name="l429" href="#l429">429</a><td> extensions: this.extensions_.map(function(extension) {<tr><td><a name="l430" href="#l430">430</a><td> if (Buffer.isBuffer(extension)) {<tr><td><a name="l431" href="#l431">431</a><td> return extension.toString(&#39;base64&#39;);<tr><td><a name="l432" href="#l432">432</a><td> }<tr><td><a name="l433" href="#l433">433</a><td> return fs.readFileSync(extension, &#39;base64&#39;);<tr><td><a name="l434" href="#l434">434</a><td> }),<tr><td><a name="l435" href="#l435">435</a><td> localState: this.localState_,<tr><td><a name="l436" href="#l436">436</a><td> logFile: this.logFile_,<tr><td><a name="l437" href="#l437">437</a><td> prefs: this.prefs_<tr><td><a name="l438" href="#l438">438</a><td> };<tr><td><a name="l439" href="#l439">439</a><td>};<tr><td><a name="l440" href="#l440">440</a><td><tr><td><a name="l441" href="#l441">441</a><td><tr><td><a name="l442" href="#l442">442</a><td>/**<tr><td><a name="l443" href="#l443">443</a><td> * Creates a new ChromeDriver session.<tr><td><a name="l444" href="#l444">444</a><td> * @param {(webdriver.Capabilities|Options)=} opt_options The session options.<tr><td><a name="l445" href="#l445">445</a><td> * @param {remote.DriverService=} opt_service The session to use; will use<tr><td><a name="l446" href="#l446">446</a><td> * the {@link getDefaultService default service} by default.<tr><td><a name="l447" href="#l447">447</a><td> * @param {webdriver.promise.ControlFlow=} opt_flow The control flow to use, or<tr><td><a name="l448" href="#l448">448</a><td> * {@code null} to use the currently active flow.<tr><td><a name="l449" href="#l449">449</a><td> * @return {!webdriver.WebDriver} A new WebDriver instance.<tr><td><a name="l450" href="#l450">450</a><td> * @deprecated Use {@link Driver new Driver()}.<tr><td><a name="l451" href="#l451">451</a><td> */<tr><td><a name="l452" href="#l452">452</a><td>function createDriver(opt_options, opt_service, opt_flow) {<tr><td><a name="l453" href="#l453">453</a><td> return new Driver(opt_options, opt_service, opt_flow);<tr><td><a name="l454" href="#l454">454</a><td>}<tr><td><a name="l455" href="#l455">455</a><td><tr><td><a name="l456" href="#l456">456</a><td><tr><td><a name="l457" href="#l457">457</a><td>/**<tr><td><a name="l458" href="#l458">458</a><td> * Creates a new WebDriver client for Chrome.<tr><td><a name="l459" href="#l459">459</a><td> *<tr><td><a name="l460" href="#l460">460</a><td> * @param {(webdriver.Capabilities|Options)=} opt_config The configuration<tr><td><a name="l461" href="#l461">461</a><td> * options.<tr><td><a name="l462" href="#l462">462</a><td> * @param {remote.DriverService=} opt_service The session to use; will use<tr><td><a name="l463" href="#l463">463</a><td> * the {@link getDefaultService default service} by default.<tr><td><a name="l464" href="#l464">464</a><td> * @param {webdriver.promise.ControlFlow=} opt_flow The control flow to use, or<tr><td><a name="l465" href="#l465">465</a><td> * {@code null} to use the currently active flow.<tr><td><a name="l466" href="#l466">466</a><td> * @constructor<tr><td><a name="l467" href="#l467">467</a><td> * @extends {webdriver.WebDriver}<tr><td><a name="l468" href="#l468">468</a><td> */<tr><td><a name="l469" href="#l469">469</a><td>var Driver = function(opt_config, opt_service, opt_flow) {<tr><td><a name="l470" href="#l470">470</a><td> var service = opt_service || getDefaultService();<tr><td><a name="l471" href="#l471">471</a><td> var executor = executors.createExecutor(service.start());<tr><td><a name="l472" href="#l472">472</a><td><tr><td><a name="l473" href="#l473">473</a><td> var capabilities =<tr><td><a name="l474" href="#l474">474</a><td> opt_config instanceof Options ? opt_config.toCapabilities() :<tr><td><a name="l475" href="#l475">475</a><td> (opt_config || webdriver.Capabilities.chrome());<tr><td><a name="l476" href="#l476">476</a><td><tr><td><a name="l477" href="#l477">477</a><td> var driver = webdriver.WebDriver.createSession(<tr><td><a name="l478" href="#l478">478</a><td> executor, capabilities, opt_flow);<tr><td><a name="l479" href="#l479">479</a><td><tr><td><a name="l480" href="#l480">480</a><td> webdriver.WebDriver.call(<tr><td><a name="l481" href="#l481">481</a><td> this, driver.getSession(), executor, driver.controlFlow());<tr><td><a name="l482" href="#l482">482</a><td>};<tr><td><a name="l483" href="#l483">483</a><td>util.inherits(Driver, webdriver.WebDriver);<tr><td><a name="l484" href="#l484">484</a><td><tr><td><a name="l485" href="#l485">485</a><td><tr><td><a name="l486" href="#l486">486</a><td>// PUBLIC API<tr><td><a name="l487" href="#l487">487</a><td><tr><td><a name="l488" href="#l488">488</a><td><tr><td><a name="l489" href="#l489">489</a><td>exports.Driver = Driver;<tr><td><a name="l490" href="#l490">490</a><td>exports.Options = Options;<tr><td><a name="l491" href="#l491">491</a><td>exports.ServiceBuilder = ServiceBuilder;<tr><td><a name="l492" href="#l492">492</a><td>exports.createDriver = createDriver;<tr><td><a name="l493" href="#l493">493</a><td>exports.getDefaultService = getDefaultService;<tr><td><a name="l494" href="#l494">494</a><td>exports.setDefaultService = setDefaultService;</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="../license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../types.js"></script><script src="../dossier.js"></script>
package/docs/source/error.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>error.js</title><link href="../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>error.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2014 Selenium committers<tr><td><a name="l2" href="#l2">2</a><td>// Copyright 2014 Software Freedom Conservancy<tr><td><a name="l3" href="#l3">3</a><td>//<tr><td><a name="l4" href="#l4">4</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l5" href="#l5">5</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l6" href="#l6">6</a><td>// You may obtain a copy of the License at<tr><td><a name="l7" href="#l7">7</a><td>//<tr><td><a name="l8" href="#l8">8</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l9" href="#l9">9</a><td>//<tr><td><a name="l10" href="#l10">10</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l11" href="#l11">11</a><td>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<tr><td><a name="l12" href="#l12">12</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l13" href="#l13">13</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l14" href="#l14">14</a><td>// limitations under the License.<tr><td><a name="l15" href="#l15">15</a><td><tr><td><a name="l16" href="#l16">16</a><td>&#39;use strict&#39;;<tr><td><a name="l17" href="#l17">17</a><td><tr><td><a name="l18" href="#l18">18</a><td>var base = require(&#39;./_base&#39;);<tr><td><a name="l19" href="#l19">19</a><td><tr><td><a name="l20" href="#l20">20</a><td><tr><td><a name="l21" href="#l21">21</a><td>/** @type {function(new: bot.Error)} */<tr><td><a name="l22" href="#l22">22</a><td>exports.Error = base.require(&#39;bot.Error&#39;);<tr><td><a name="l23" href="#l23">23</a><td><tr><td><a name="l24" href="#l24">24</a><td>/** @type {bot.ErrorCode.} */<tr><td><a name="l25" href="#l25">25</a><td>exports.ErrorCode = base.require(&#39;bot.ErrorCode&#39;);</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../types.js"></script><script src="../dossier.js"></script>
1
+ <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>error.js</title><link href="../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>error.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2014 Selenium committers<tr><td><a name="l2" href="#l2">2</a><td>// Copyright 2014 Software Freedom Conservancy<tr><td><a name="l3" href="#l3">3</a><td>//<tr><td><a name="l4" href="#l4">4</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l5" href="#l5">5</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l6" href="#l6">6</a><td>// You may obtain a copy of the License at<tr><td><a name="l7" href="#l7">7</a><td>//<tr><td><a name="l8" href="#l8">8</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l9" href="#l9">9</a><td>//<tr><td><a name="l10" href="#l10">10</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l11" href="#l11">11</a><td>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<tr><td><a name="l12" href="#l12">12</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l13" href="#l13">13</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l14" href="#l14">14</a><td>// limitations under the License.<tr><td><a name="l15" href="#l15">15</a><td><tr><td><a name="l16" href="#l16">16</a><td>&#39;use strict&#39;;<tr><td><a name="l17" href="#l17">17</a><td><tr><td><a name="l18" href="#l18">18</a><td>var base = require(&#39;./_base&#39;);<tr><td><a name="l19" href="#l19">19</a><td><tr><td><a name="l20" href="#l20">20</a><td><tr><td><a name="l21" href="#l21">21</a><td>/** @type {function(new: bot.Error)} */<tr><td><a name="l22" href="#l22">22</a><td>exports.Error = base.require(&#39;bot.Error&#39;);<tr><td><a name="l23" href="#l23">23</a><td><tr><td><a name="l24" href="#l24">24</a><td>/** @type {bot.ErrorCode.} */<tr><td><a name="l25" href="#l25">25</a><td>exports.ErrorCode = base.require(&#39;bot.ErrorCode&#39;);</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="../license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../types.js"></script><script src="../dossier.js"></script>
package/docs/source/executors.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>executors.js</title><link href="../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>executors.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2013 Software Freedom Conservancy. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>/**<tr><td><a name="l16" href="#l16">16</a><td> * @fileoverview Various utilities for working with<tr><td><a name="l17" href="#l17">17</a><td> * {@link webdriver.CommandExecutor} implementations.<tr><td><a name="l18" href="#l18">18</a><td> */<tr><td><a name="l19" href="#l19">19</a><td><tr><td><a name="l20" href="#l20">20</a><td>var HttpClient = require(&#39;./http&#39;).HttpClient,<tr><td><a name="l21" href="#l21">21</a><td> HttpExecutor = require(&#39;./http&#39;).Executor,<tr><td><a name="l22" href="#l22">22</a><td> promise = require(&#39;./_base&#39;).require(&#39;webdriver.promise&#39;);<tr><td><a name="l23" href="#l23">23</a><td><tr><td><a name="l24" href="#l24">24</a><td><tr><td><a name="l25" href="#l25">25</a><td><tr><td><a name="l26" href="#l26">26</a><td>/**<tr><td><a name="l27" href="#l27">27</a><td> * Wraps a promised {@link webdriver.CommandExecutor}, ensuring no commands<tr><td><a name="l28" href="#l28">28</a><td> * are executed until the wrapped executor has been fully built.<tr><td><a name="l29" href="#l29">29</a><td> * @param {!webdriver.promise.Promise.&lt;!webdriver.CommandExecutor&gt;} delegate The<tr><td><a name="l30" href="#l30">30</a><td> * promised delegate.<tr><td><a name="l31" href="#l31">31</a><td> * @constructor<tr><td><a name="l32" href="#l32">32</a><td> * @implements {webdriver.CommandExecutor}<tr><td><a name="l33" href="#l33">33</a><td> */<tr><td><a name="l34" href="#l34">34</a><td>var DeferredExecutor = function(delegate) {<tr><td><a name="l35" href="#l35">35</a><td><tr><td><a name="l36" href="#l36">36</a><td> /** @override */<tr><td><a name="l37" href="#l37">37</a><td> this.execute = function(command, callback) {<tr><td><a name="l38" href="#l38">38</a><td> delegate.then(function(executor) {<tr><td><a name="l39" href="#l39">39</a><td> executor.execute(command, callback);<tr><td><a name="l40" href="#l40">40</a><td> }, callback);<tr><td><a name="l41" href="#l41">41</a><td> };<tr><td><a name="l42" href="#l42">42</a><td>};<tr><td><a name="l43" href="#l43">43</a><td><tr><td><a name="l44" href="#l44">44</a><td><tr><td><a name="l45" href="#l45">45</a><td>// PUBLIC API<tr><td><a name="l46" href="#l46">46</a><td><tr><td><a name="l47" href="#l47">47</a><td><tr><td><a name="l48" href="#l48">48</a><td>/**<tr><td><a name="l49" href="#l49">49</a><td> * Creates a command executor that uses WebDriver&#39;s JSON wire protocol.<tr><td><a name="l50" href="#l50">50</a><td> * @param {(string|!webdriver.promise.Promise.&lt;string&gt;)} url The server&#39;s URL,<tr><td><a name="l51" href="#l51">51</a><td> * or a promise that will resolve to that URL.<tr><td><a name="l52" href="#l52">52</a><td> * @returns {!webdriver.CommandExecutor} The new command executor.<tr><td><a name="l53" href="#l53">53</a><td> */<tr><td><a name="l54" href="#l54">54</a><td>exports.createExecutor = function(url) {<tr><td><a name="l55" href="#l55">55</a><td> return new DeferredExecutor(promise.when(url, function(url) {<tr><td><a name="l56" href="#l56">56</a><td> var client = new HttpClient(url);<tr><td><a name="l57" href="#l57">57</a><td> return new HttpExecutor(client);<tr><td><a name="l58" href="#l58">58</a><td> }));<tr><td><a name="l59" href="#l59">59</a><td>};</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../types.js"></script><script src="../dossier.js"></script>
1
+ <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>executors.js</title><link href="../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>executors.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2013 Software Freedom Conservancy. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>/**<tr><td><a name="l16" href="#l16">16</a><td> * @fileoverview Various utilities for working with<tr><td><a name="l17" href="#l17">17</a><td> * {@link webdriver.CommandExecutor} implementations.<tr><td><a name="l18" href="#l18">18</a><td> */<tr><td><a name="l19" href="#l19">19</a><td><tr><td><a name="l20" href="#l20">20</a><td>var HttpClient = require(&#39;./http&#39;).HttpClient,<tr><td><a name="l21" href="#l21">21</a><td> HttpExecutor = require(&#39;./http&#39;).Executor,<tr><td><a name="l22" href="#l22">22</a><td> promise = require(&#39;./_base&#39;).require(&#39;webdriver.promise&#39;);<tr><td><a name="l23" href="#l23">23</a><td><tr><td><a name="l24" href="#l24">24</a><td><tr><td><a name="l25" href="#l25">25</a><td><tr><td><a name="l26" href="#l26">26</a><td>/**<tr><td><a name="l27" href="#l27">27</a><td> * Wraps a promised {@link webdriver.CommandExecutor}, ensuring no commands<tr><td><a name="l28" href="#l28">28</a><td> * are executed until the wrapped executor has been fully built.<tr><td><a name="l29" href="#l29">29</a><td> * @param {!webdriver.promise.Promise.&lt;!webdriver.CommandExecutor&gt;} delegate The<tr><td><a name="l30" href="#l30">30</a><td> * promised delegate.<tr><td><a name="l31" href="#l31">31</a><td> * @constructor<tr><td><a name="l32" href="#l32">32</a><td> * @implements {webdriver.CommandExecutor}<tr><td><a name="l33" href="#l33">33</a><td> */<tr><td><a name="l34" href="#l34">34</a><td>var DeferredExecutor = function(delegate) {<tr><td><a name="l35" href="#l35">35</a><td><tr><td><a name="l36" href="#l36">36</a><td> /** @override */<tr><td><a name="l37" href="#l37">37</a><td> this.execute = function(command, callback) {<tr><td><a name="l38" href="#l38">38</a><td> delegate.then(function(executor) {<tr><td><a name="l39" href="#l39">39</a><td> executor.execute(command, callback);<tr><td><a name="l40" href="#l40">40</a><td> }, callback);<tr><td><a name="l41" href="#l41">41</a><td> };<tr><td><a name="l42" href="#l42">42</a><td>};<tr><td><a name="l43" href="#l43">43</a><td><tr><td><a name="l44" href="#l44">44</a><td><tr><td><a name="l45" href="#l45">45</a><td>// PUBLIC API<tr><td><a name="l46" href="#l46">46</a><td><tr><td><a name="l47" href="#l47">47</a><td><tr><td><a name="l48" href="#l48">48</a><td>/**<tr><td><a name="l49" href="#l49">49</a><td> * Creates a command executor that uses WebDriver&#39;s JSON wire protocol.<tr><td><a name="l50" href="#l50">50</a><td> * @param {(string|!webdriver.promise.Promise.&lt;string&gt;)} url The server&#39;s URL,<tr><td><a name="l51" href="#l51">51</a><td> * or a promise that will resolve to that URL.<tr><td><a name="l52" href="#l52">52</a><td> * @returns {!webdriver.CommandExecutor} The new command executor.<tr><td><a name="l53" href="#l53">53</a><td> */<tr><td><a name="l54" href="#l54">54</a><td>exports.createExecutor = function(url) {<tr><td><a name="l55" href="#l55">55</a><td> return new DeferredExecutor(promise.when(url, function(url) {<tr><td><a name="l56" href="#l56">56</a><td> var client = new HttpClient(url);<tr><td><a name="l57" href="#l57">57</a><td> return new HttpExecutor(client);<tr><td><a name="l58" href="#l58">58</a><td> }));<tr><td><a name="l59" href="#l59">59</a><td>};</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="../license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../types.js"></script><script src="../dossier.js"></script>
package/docs/source/firefox/binary.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>binary.js</title><link href="../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>firefox/binary.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2014 Selenium committers<tr><td><a name="l2" href="#l2">2</a><td>// Copyright 2014 Software Freedom Conservancy<tr><td><a name="l3" href="#l3">3</a><td>//<tr><td><a name="l4" href="#l4">4</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l5" href="#l5">5</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l6" href="#l6">6</a><td>// You may obtain a copy of the License at<tr><td><a name="l7" href="#l7">7</a><td>//<tr><td><a name="l8" href="#l8">8</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l9" href="#l9">9</a><td>//<tr><td><a name="l10" href="#l10">10</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l11" href="#l11">11</a><td>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<tr><td><a name="l12" href="#l12">12</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l13" href="#l13">13</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l14" href="#l14">14</a><td>// limitations under the License.<tr><td><a name="l15" href="#l15">15</a><td><tr><td><a name="l16" href="#l16">16</a><td>&#39;use strict&#39;;<tr><td><a name="l17" href="#l17">17</a><td><tr><td><a name="l18" href="#l18">18</a><td>var child = require(&#39;child_process&#39;),<tr><td><a name="l19" href="#l19">19</a><td> fs = require(&#39;fs&#39;),<tr><td><a name="l20" href="#l20">20</a><td> path = require(&#39;path&#39;),<tr><td><a name="l21" href="#l21">21</a><td> util = require(&#39;util&#39;);<tr><td><a name="l22" href="#l22">22</a><td><tr><td><a name="l23" href="#l23">23</a><td>var promise = require(&#39;..&#39;).promise,<tr><td><a name="l24" href="#l24">24</a><td> _base = require(&#39;../_base&#39;),<tr><td><a name="l25" href="#l25">25</a><td> io = require(&#39;../io&#39;),<tr><td><a name="l26" href="#l26">26</a><td> exec = require(&#39;../io/exec&#39;);<tr><td><a name="l27" href="#l27">27</a><td><tr><td><a name="l28" href="#l28">28</a><td><tr><td><a name="l29" href="#l29">29</a><td><tr><td><a name="l30" href="#l30">30</a><td>/** @const */<tr><td><a name="l31" href="#l31">31</a><td>var NO_FOCUS_LIB_X86 = _base.isDevMode() ?<tr><td><a name="l32" href="#l32">32</a><td> path.join(__dirname, &#39;../../../../cpp/prebuilt/i386/libnoblur.so&#39;) :<tr><td><a name="l33" href="#l33">33</a><td> path.join(__dirname, &#39;../lib/firefox/i386/libnoblur.so&#39;) ;<tr><td><a name="l34" href="#l34">34</a><td><tr><td><a name="l35" href="#l35">35</a><td>/** @const */<tr><td><a name="l36" href="#l36">36</a><td>var NO_FOCUS_LIB_AMD64 = _base.isDevMode() ?<tr><td><a name="l37" href="#l37">37</a><td> path.join(__dirname, &#39;../../../../cpp/prebuilt/amd64/libnoblur64.so&#39;) :<tr><td><a name="l38" href="#l38">38</a><td> path.join(__dirname, &#39;../lib/firefox/amd64/libnoblur64.so&#39;) ;<tr><td><a name="l39" href="#l39">39</a><td><tr><td><a name="l40" href="#l40">40</a><td>var X_IGNORE_NO_FOCUS_LIB = &#39;x_ignore_nofocus.so&#39;;<tr><td><a name="l41" href="#l41">41</a><td><tr><td><a name="l42" href="#l42">42</a><td>var foundBinary = null;<tr><td><a name="l43" href="#l43">43</a><td><tr><td><a name="l44" href="#l44">44</a><td><tr><td><a name="l45" href="#l45">45</a><td>/**<tr><td><a name="l46" href="#l46">46</a><td> * Checks the default Windows Firefox locations in Program Files.<tr><td><a name="l47" href="#l47">47</a><td> * @return {!promise.Promise.&lt;?string&gt;} A promise for the located executable.<tr><td><a name="l48" href="#l48">48</a><td> * The promise will resolve to {@code null} if Fireox was not found.<tr><td><a name="l49" href="#l49">49</a><td> */<tr><td><a name="l50" href="#l50">50</a><td>function defaultWindowsLocation() {<tr><td><a name="l51" href="#l51">51</a><td> var files = [<tr><td><a name="l52" href="#l52">52</a><td> process.env[&#39;PROGRAMFILES&#39;] || &#39;C:\\Program Files&#39;,<tr><td><a name="l53" href="#l53">53</a><td> process.env[&#39;PROGRAMFILES(X86)&#39;] || &#39;C:\\Program Files (x86)&#39;<tr><td><a name="l54" href="#l54">54</a><td> ].map(function(prefix) {<tr><td><a name="l55" href="#l55">55</a><td> return path.join(prefix, &#39;Mozilla Firefox\\firefox.exe&#39;);<tr><td><a name="l56" href="#l56">56</a><td> });<tr><td><a name="l57" href="#l57">57</a><td> return io.exists(files[0]).then(function(exists) {<tr><td><a name="l58" href="#l58">58</a><td> return exists ? files[0] : io.exists(files[1]).then(function(exists) {<tr><td><a name="l59" href="#l59">59</a><td> return exists ? files[1] : null;<tr><td><a name="l60" href="#l60">60</a><td> });<tr><td><a name="l61" href="#l61">61</a><td> });<tr><td><a name="l62" href="#l62">62</a><td>}<tr><td><a name="l63" href="#l63">63</a><td><tr><td><a name="l64" href="#l64">64</a><td><tr><td><a name="l65" href="#l65">65</a><td>/**<tr><td><a name="l66" href="#l66">66</a><td> * Locates the Firefox binary for the current system.<tr><td><a name="l67" href="#l67">67</a><td> * @return {!promise.Promise.&lt;string&gt;} A promise for the located binary. The<tr><td><a name="l68" href="#l68">68</a><td> * promise will be rejected if Firefox cannot be located.<tr><td><a name="l69" href="#l69">69</a><td> */<tr><td><a name="l70" href="#l70">70</a><td>function findFirefox() {<tr><td><a name="l71" href="#l71">71</a><td> if (foundBinary) {<tr><td><a name="l72" href="#l72">72</a><td> return foundBinary;<tr><td><a name="l73" href="#l73">73</a><td> }<tr><td><a name="l74" href="#l74">74</a><td><tr><td><a name="l75" href="#l75">75</a><td> if (process.platform === &#39;darwin&#39;) {<tr><td><a name="l76" href="#l76">76</a><td> var osxExe = &#39;/Applications/Firefox.app/Contents/MacOS/firefox-bin&#39;;<tr><td><a name="l77" href="#l77">77</a><td> foundBinary = io.exists(osxExe).then(function(exists) {<tr><td><a name="l78" href="#l78">78</a><td> return exists ? osxExe : null;<tr><td><a name="l79" href="#l79">79</a><td> });<tr><td><a name="l80" href="#l80">80</a><td> } else if (process.platform === &#39;win32&#39;) {<tr><td><a name="l81" href="#l81">81</a><td> foundBinary = defaultWindowsLocation();<tr><td><a name="l82" href="#l82">82</a><td> } else {<tr><td><a name="l83" href="#l83">83</a><td> foundBinary = promise.fulfilled(io.findInPath(&#39;firefox&#39;));<tr><td><a name="l84" href="#l84">84</a><td> }<tr><td><a name="l85" href="#l85">85</a><td><tr><td><a name="l86" href="#l86">86</a><td> return foundBinary = foundBinary.then(function(found) {<tr><td><a name="l87" href="#l87">87</a><td> if (found) {<tr><td><a name="l88" href="#l88">88</a><td> return found;<tr><td><a name="l89" href="#l89">89</a><td> }<tr><td><a name="l90" href="#l90">90</a><td> throw Error(&#39;Could not locate Firefox on the current system&#39;);<tr><td><a name="l91" href="#l91">91</a><td> });<tr><td><a name="l92" href="#l92">92</a><td>}<tr><td><a name="l93" href="#l93">93</a><td><tr><td><a name="l94" href="#l94">94</a><td><tr><td><a name="l95" href="#l95">95</a><td>/**<tr><td><a name="l96" href="#l96">96</a><td> * Copies the no focus libs into the given profile directory.<tr><td><a name="l97" href="#l97">97</a><td> * @param {string} profileDir Path to the profile directory to install into.<tr><td><a name="l98" href="#l98">98</a><td> * @return {!promise.Promise.&lt;string&gt;} The LD_LIBRARY_PATH prefix string to use<tr><td><a name="l99" href="#l99">99</a><td> * for the installed libs.<tr><td><a name="l100" href="#l100">100</a><td> */<tr><td><a name="l101" href="#l101">101</a><td>function installNoFocusLibs(profileDir) {<tr><td><a name="l102" href="#l102">102</a><td> var x86 = path.join(profileDir, &#39;x86&#39;);<tr><td><a name="l103" href="#l103">103</a><td> var amd64 = path.join(profileDir, &#39;amd64&#39;);<tr><td><a name="l104" href="#l104">104</a><td><tr><td><a name="l105" href="#l105">105</a><td> return mkdir(x86)<tr><td><a name="l106" href="#l106">106</a><td> .then(copyLib.bind(null, NO_FOCUS_LIB_X86, x86))<tr><td><a name="l107" href="#l107">107</a><td> .then(mkdir.bind(null, amd64))<tr><td><a name="l108" href="#l108">108</a><td> .then(copyLib.bind(null, NO_FOCUS_LIB_AMD64, amd64))<tr><td><a name="l109" href="#l109">109</a><td> .then(function() {<tr><td><a name="l110" href="#l110">110</a><td> return x86 + &#39;:&#39; + amd64;<tr><td><a name="l111" href="#l111">111</a><td> });<tr><td><a name="l112" href="#l112">112</a><td><tr><td><a name="l113" href="#l113">113</a><td> function mkdir(dir) {<tr><td><a name="l114" href="#l114">114</a><td> return io.exists(dir).then(function(exists) {<tr><td><a name="l115" href="#l115">115</a><td> if (!exists) {<tr><td><a name="l116" href="#l116">116</a><td> return promise.checkedNodeCall(fs.mkdir, dir);<tr><td><a name="l117" href="#l117">117</a><td> }<tr><td><a name="l118" href="#l118">118</a><td> });<tr><td><a name="l119" href="#l119">119</a><td> }<tr><td><a name="l120" href="#l120">120</a><td><tr><td><a name="l121" href="#l121">121</a><td> function copyLib(src, dir) {<tr><td><a name="l122" href="#l122">122</a><td> return io.copy(src, path.join(dir, X_IGNORE_NO_FOCUS_LIB));<tr><td><a name="l123" href="#l123">123</a><td> }<tr><td><a name="l124" href="#l124">124</a><td>}<tr><td><a name="l125" href="#l125">125</a><td><tr><td><a name="l126" href="#l126">126</a><td><tr><td><a name="l127" href="#l127">127</a><td>/**<tr><td><a name="l128" href="#l128">128</a><td> * Silently runs Firefox to install a profile directory (which is assumed to be<tr><td><a name="l129" href="#l129">129</a><td> * defined in the given environment variables).<tr><td><a name="l130" href="#l130">130</a><td> * @param {string} firefox Path to the Firefox executable.<tr><td><a name="l131" href="#l131">131</a><td> * @param {!Object.&lt;string, string&gt;} env The environment variables to use.<tr><td><a name="l132" href="#l132">132</a><td> * @return {!promise.Promise} A promise for when the profile has been installed.<tr><td><a name="l133" href="#l133">133</a><td> */<tr><td><a name="l134" href="#l134">134</a><td>function installProfile(firefox, env) {<tr><td><a name="l135" href="#l135">135</a><td> var installed = promise.defer();<tr><td><a name="l136" href="#l136">136</a><td> child.exec(firefox + &#39; -silent&#39;, {env: env, timeout: 180 * 1000},<tr><td><a name="l137" href="#l137">137</a><td> function(err) {<tr><td><a name="l138" href="#l138">138</a><td> if (err) {<tr><td><a name="l139" href="#l139">139</a><td> installed.reject(new Error(<tr><td><a name="l140" href="#l140">140</a><td> &#39;Failed to install Firefox profile: &#39; + err));<tr><td><a name="l141" href="#l141">141</a><td> return;<tr><td><a name="l142" href="#l142">142</a><td> }<tr><td><a name="l143" href="#l143">143</a><td> installed.fulfill();<tr><td><a name="l144" href="#l144">144</a><td> });<tr><td><a name="l145" href="#l145">145</a><td> return installed.promise;<tr><td><a name="l146" href="#l146">146</a><td>}<tr><td><a name="l147" href="#l147">147</a><td><tr><td><a name="l148" href="#l148">148</a><td><tr><td><a name="l149" href="#l149">149</a><td>/**<tr><td><a name="l150" href="#l150">150</a><td> * Manages a Firefox subprocess configured for use with WebDriver.<tr><td><a name="l151" href="#l151">151</a><td> * @param {string=} opt_exe Path to the Firefox binary to use. If not<tr><td><a name="l152" href="#l152">152</a><td> * specified, will attempt to locate Firefox on the current system.<tr><td><a name="l153" href="#l153">153</a><td> * @constructor<tr><td><a name="l154" href="#l154">154</a><td> */<tr><td><a name="l155" href="#l155">155</a><td>var Binary = function(opt_exe) {<tr><td><a name="l156" href="#l156">156</a><td> /** @private {(string|undefined)} */<tr><td><a name="l157" href="#l157">157</a><td> this.exe_ = opt_exe;<tr><td><a name="l158" href="#l158">158</a><td><tr><td><a name="l159" href="#l159">159</a><td> /** @private {!Array.&lt;string&gt;} */<tr><td><a name="l160" href="#l160">160</a><td> this.args_ = [];<tr><td><a name="l161" href="#l161">161</a><td><tr><td><a name="l162" href="#l162">162</a><td> /** @private {!Object.&lt;string, string&gt;} */<tr><td><a name="l163" href="#l163">163</a><td> this.env_ = {};<tr><td><a name="l164" href="#l164">164</a><td> Object.keys(process.env).forEach(function(key) {<tr><td><a name="l165" href="#l165">165</a><td> this.env_[key] = process.env[key];<tr><td><a name="l166" href="#l166">166</a><td> }.bind(this));<tr><td><a name="l167" href="#l167">167</a><td> this.env_[&#39;MOZ_CRASHREPORTER_DISABLE&#39;] = &#39;1&#39;;<tr><td><a name="l168" href="#l168">168</a><td> this.env_[&#39;MOZ_NO_REMOTE&#39;] = &#39;1&#39;;<tr><td><a name="l169" href="#l169">169</a><td> this.env_[&#39;NO_EM_RESTART&#39;] = &#39;1&#39;;<tr><td><a name="l170" href="#l170">170</a><td><tr><td><a name="l171" href="#l171">171</a><td> /** @private {promise.Promise.&lt;!exec.Command&gt;} */<tr><td><a name="l172" href="#l172">172</a><td> this.command_ = null;<tr><td><a name="l173" href="#l173">173</a><td>};<tr><td><a name="l174" href="#l174">174</a><td><tr><td><a name="l175" href="#l175">175</a><td><tr><td><a name="l176" href="#l176">176</a><td>/**<tr><td><a name="l177" href="#l177">177</a><td> * Add arguments to the command line used to start Firefox.<tr><td><a name="l178" href="#l178">178</a><td> * @param {...(string|!Array.&lt;string&gt;)} var_args Either the arguments to add as<tr><td><a name="l179" href="#l179">179</a><td> * varargs, or the arguments as an array.<tr><td><a name="l180" href="#l180">180</a><td> */<tr><td><a name="l181" href="#l181">181</a><td>Binary.prototype.addArguments = function(var_args) {<tr><td><a name="l182" href="#l182">182</a><td> for (var i = 0; i &lt; arguments.length; i++) {<tr><td><a name="l183" href="#l183">183</a><td> if (util.isArray(arguments[i])) {<tr><td><a name="l184" href="#l184">184</a><td> this.args_ = this.args_.concat(arguments[i]);<tr><td><a name="l185" href="#l185">185</a><td> } else {<tr><td><a name="l186" href="#l186">186</a><td> this.args_.push(arguments[i]);<tr><td><a name="l187" href="#l187">187</a><td> }<tr><td><a name="l188" href="#l188">188</a><td> }<tr><td><a name="l189" href="#l189">189</a><td>};<tr><td><a name="l190" href="#l190">190</a><td><tr><td><a name="l191" href="#l191">191</a><td><tr><td><a name="l192" href="#l192">192</a><td>/**<tr><td><a name="l193" href="#l193">193</a><td> * Launches Firefox and eturns a promise that will be fulfilled when the process<tr><td><a name="l194" href="#l194">194</a><td> * terminates.<tr><td><a name="l195" href="#l195">195</a><td> * @param {string} profile Path to the profile directory to use.<tr><td><a name="l196" href="#l196">196</a><td> * @return {!promise.Promise.&lt;!exec.Result&gt;} A promise for the process result.<tr><td><a name="l197" href="#l197">197</a><td> * @throws {Error} If this instance has already been started.<tr><td><a name="l198" href="#l198">198</a><td> */<tr><td><a name="l199" href="#l199">199</a><td>Binary.prototype.launch = function(profile) {<tr><td><a name="l200" href="#l200">200</a><td> if (this.command_) {<tr><td><a name="l201" href="#l201">201</a><td> throw Error(&#39;Firefox is already running&#39;);<tr><td><a name="l202" href="#l202">202</a><td> }<tr><td><a name="l203" href="#l203">203</a><td><tr><td><a name="l204" href="#l204">204</a><td> var env = {};<tr><td><a name="l205" href="#l205">205</a><td> Object.keys(this.env_).forEach(function(key) {<tr><td><a name="l206" href="#l206">206</a><td> env[key] = this.env_[key];<tr><td><a name="l207" href="#l207">207</a><td> }.bind(this));<tr><td><a name="l208" href="#l208">208</a><td> env[&#39;XRE_PROFILE_PATH&#39;] = profile;<tr><td><a name="l209" href="#l209">209</a><td><tr><td><a name="l210" href="#l210">210</a><td> var args = [&#39;-foreground&#39;].concat(this.args_);<tr><td><a name="l211" href="#l211">211</a><td><tr><td><a name="l212" href="#l212">212</a><td> var self = this;<tr><td><a name="l213" href="#l213">213</a><td><tr><td><a name="l214" href="#l214">214</a><td> this.command_ = promise.when(this.exe_ || findFirefox(), function(firefox) {<tr><td><a name="l215" href="#l215">215</a><td> if (process.platform === &#39;win32&#39; || process.platform === &#39;darwin&#39;) {<tr><td><a name="l216" href="#l216">216</a><td> return firefox;<tr><td><a name="l217" href="#l217">217</a><td> }<tr><td><a name="l218" href="#l218">218</a><td> return installNoFocusLibs(profile).then(function(ldLibraryPath) {<tr><td><a name="l219" href="#l219">219</a><td> env[&#39;LD_LIBRARY_PATH&#39;] = ldLibraryPath + &#39;:&#39; + env[&#39;LD_LIBRARY_PATH&#39;];<tr><td><a name="l220" href="#l220">220</a><td> env[&#39;LD_PRELOAD&#39;] = X_IGNORE_NO_FOCUS_LIB;<tr><td><a name="l221" href="#l221">221</a><td> return firefox;<tr><td><a name="l222" href="#l222">222</a><td> });<tr><td><a name="l223" href="#l223">223</a><td> }).then(function(firefox) {<tr><td><a name="l224" href="#l224">224</a><td> var install = exec(firefox, {args: [&#39;-silent&#39;], env: env});<tr><td><a name="l225" href="#l225">225</a><td> return install.result().then(function(result) {<tr><td><a name="l226" href="#l226">226</a><td> if (result.code !== 0) {<tr><td><a name="l227" href="#l227">227</a><td> throw Error(<tr><td><a name="l228" href="#l228">228</a><td> &#39;Failed to install profile; firefox terminated with &#39; + result);<tr><td><a name="l229" href="#l229">229</a><td> }<tr><td><a name="l230" href="#l230">230</a><td><tr><td><a name="l231" href="#l231">231</a><td> return exec(firefox, {args: args, env: env});<tr><td><a name="l232" href="#l232">232</a><td> });<tr><td><a name="l233" href="#l233">233</a><td> });<tr><td><a name="l234" href="#l234">234</a><td><tr><td><a name="l235" href="#l235">235</a><td> return this.command_.then(function() {<tr><td><a name="l236" href="#l236">236</a><td> // Don&#39;t return the actual command handle, just a promise to signal it has<tr><td><a name="l237" href="#l237">237</a><td> // been started.<tr><td><a name="l238" href="#l238">238</a><td> });<tr><td><a name="l239" href="#l239">239</a><td>};<tr><td><a name="l240" href="#l240">240</a><td><tr><td><a name="l241" href="#l241">241</a><td><tr><td><a name="l242" href="#l242">242</a><td>/**<tr><td><a name="l243" href="#l243">243</a><td> * Kills the managed Firefox process.<tr><td><a name="l244" href="#l244">244</a><td> * @return {!promise.Promise} A promise for when the process has terminated.<tr><td><a name="l245" href="#l245">245</a><td> */<tr><td><a name="l246" href="#l246">246</a><td>Binary.prototype.kill = function() {<tr><td><a name="l247" href="#l247">247</a><td> if (!this.command_) {<tr><td><a name="l248" href="#l248">248</a><td> return promise.defer(); // Not running.<tr><td><a name="l249" href="#l249">249</a><td> }<tr><td><a name="l250" href="#l250">250</a><td> return this.command_.then(function(command) {<tr><td><a name="l251" href="#l251">251</a><td> command.kill();<tr><td><a name="l252" href="#l252">252</a><td> return command.result();<tr><td><a name="l253" href="#l253">253</a><td> });<tr><td><a name="l254" href="#l254">254</a><td>};<tr><td><a name="l255" href="#l255">255</a><td><tr><td><a name="l256" href="#l256">256</a><td><tr><td><a name="l257" href="#l257">257</a><td>// PUBLIC API<tr><td><a name="l258" href="#l258">258</a><td><tr><td><a name="l259" href="#l259">259</a><td><tr><td><a name="l260" href="#l260">260</a><td>exports.Binary = Binary;<tr><td><a name="l261" href="#l261">261</a><td></table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../types.js"></script><script src="../../dossier.js"></script>
1
+ <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>binary.js</title><link href="../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>firefox/binary.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2014 Selenium committers<tr><td><a name="l2" href="#l2">2</a><td>// Copyright 2014 Software Freedom Conservancy<tr><td><a name="l3" href="#l3">3</a><td>//<tr><td><a name="l4" href="#l4">4</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l5" href="#l5">5</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l6" href="#l6">6</a><td>// You may obtain a copy of the License at<tr><td><a name="l7" href="#l7">7</a><td>//<tr><td><a name="l8" href="#l8">8</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l9" href="#l9">9</a><td>//<tr><td><a name="l10" href="#l10">10</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l11" href="#l11">11</a><td>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<tr><td><a name="l12" href="#l12">12</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l13" href="#l13">13</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l14" href="#l14">14</a><td>// limitations under the License.<tr><td><a name="l15" href="#l15">15</a><td><tr><td><a name="l16" href="#l16">16</a><td>&#39;use strict&#39;;<tr><td><a name="l17" href="#l17">17</a><td><tr><td><a name="l18" href="#l18">18</a><td>var child = require(&#39;child_process&#39;),<tr><td><a name="l19" href="#l19">19</a><td> fs = require(&#39;fs&#39;),<tr><td><a name="l20" href="#l20">20</a><td> path = require(&#39;path&#39;),<tr><td><a name="l21" href="#l21">21</a><td> util = require(&#39;util&#39;);<tr><td><a name="l22" href="#l22">22</a><td><tr><td><a name="l23" href="#l23">23</a><td>var promise = require(&#39;..&#39;).promise,<tr><td><a name="l24" href="#l24">24</a><td> _base = require(&#39;../_base&#39;),<tr><td><a name="l25" href="#l25">25</a><td> io = require(&#39;../io&#39;),<tr><td><a name="l26" href="#l26">26</a><td> exec = require(&#39;../io/exec&#39;);<tr><td><a name="l27" href="#l27">27</a><td><tr><td><a name="l28" href="#l28">28</a><td><tr><td><a name="l29" href="#l29">29</a><td><tr><td><a name="l30" href="#l30">30</a><td>/** @const */<tr><td><a name="l31" href="#l31">31</a><td>var NO_FOCUS_LIB_X86 = _base.isDevMode() ?<tr><td><a name="l32" href="#l32">32</a><td> path.join(__dirname, &#39;../../../../cpp/prebuilt/i386/libnoblur.so&#39;) :<tr><td><a name="l33" href="#l33">33</a><td> path.join(__dirname, &#39;../lib/firefox/i386/libnoblur.so&#39;) ;<tr><td><a name="l34" href="#l34">34</a><td><tr><td><a name="l35" href="#l35">35</a><td>/** @const */<tr><td><a name="l36" href="#l36">36</a><td>var NO_FOCUS_LIB_AMD64 = _base.isDevMode() ?<tr><td><a name="l37" href="#l37">37</a><td> path.join(__dirname, &#39;../../../../cpp/prebuilt/amd64/libnoblur64.so&#39;) :<tr><td><a name="l38" href="#l38">38</a><td> path.join(__dirname, &#39;../lib/firefox/amd64/libnoblur64.so&#39;) ;<tr><td><a name="l39" href="#l39">39</a><td><tr><td><a name="l40" href="#l40">40</a><td>var X_IGNORE_NO_FOCUS_LIB = &#39;x_ignore_nofocus.so&#39;;<tr><td><a name="l41" href="#l41">41</a><td><tr><td><a name="l42" href="#l42">42</a><td>var foundBinary = null;<tr><td><a name="l43" href="#l43">43</a><td><tr><td><a name="l44" href="#l44">44</a><td><tr><td><a name="l45" href="#l45">45</a><td>/**<tr><td><a name="l46" href="#l46">46</a><td> * Checks the default Windows Firefox locations in Program Files.<tr><td><a name="l47" href="#l47">47</a><td> * @return {!promise.Promise.&lt;?string&gt;} A promise for the located executable.<tr><td><a name="l48" href="#l48">48</a><td> * The promise will resolve to {@code null} if Fireox was not found.<tr><td><a name="l49" href="#l49">49</a><td> */<tr><td><a name="l50" href="#l50">50</a><td>function defaultWindowsLocation() {<tr><td><a name="l51" href="#l51">51</a><td> var files = [<tr><td><a name="l52" href="#l52">52</a><td> process.env[&#39;PROGRAMFILES&#39;] || &#39;C:\\Program Files&#39;,<tr><td><a name="l53" href="#l53">53</a><td> process.env[&#39;PROGRAMFILES(X86)&#39;] || &#39;C:\\Program Files (x86)&#39;<tr><td><a name="l54" href="#l54">54</a><td> ].map(function(prefix) {<tr><td><a name="l55" href="#l55">55</a><td> return path.join(prefix, &#39;Mozilla Firefox\\firefox.exe&#39;);<tr><td><a name="l56" href="#l56">56</a><td> });<tr><td><a name="l57" href="#l57">57</a><td> return io.exists(files[0]).then(function(exists) {<tr><td><a name="l58" href="#l58">58</a><td> return exists ? files[0] : io.exists(files[1]).then(function(exists) {<tr><td><a name="l59" href="#l59">59</a><td> return exists ? files[1] : null;<tr><td><a name="l60" href="#l60">60</a><td> });<tr><td><a name="l61" href="#l61">61</a><td> });<tr><td><a name="l62" href="#l62">62</a><td>}<tr><td><a name="l63" href="#l63">63</a><td><tr><td><a name="l64" href="#l64">64</a><td><tr><td><a name="l65" href="#l65">65</a><td>/**<tr><td><a name="l66" href="#l66">66</a><td> * Locates the Firefox binary for the current system.<tr><td><a name="l67" href="#l67">67</a><td> * @return {!promise.Promise.&lt;string&gt;} A promise for the located binary. The<tr><td><a name="l68" href="#l68">68</a><td> * promise will be rejected if Firefox cannot be located.<tr><td><a name="l69" href="#l69">69</a><td> */<tr><td><a name="l70" href="#l70">70</a><td>function findFirefox() {<tr><td><a name="l71" href="#l71">71</a><td> if (foundBinary) {<tr><td><a name="l72" href="#l72">72</a><td> return foundBinary;<tr><td><a name="l73" href="#l73">73</a><td> }<tr><td><a name="l74" href="#l74">74</a><td><tr><td><a name="l75" href="#l75">75</a><td> if (process.platform === &#39;darwin&#39;) {<tr><td><a name="l76" href="#l76">76</a><td> var osxExe = &#39;/Applications/Firefox.app/Contents/MacOS/firefox-bin&#39;;<tr><td><a name="l77" href="#l77">77</a><td> foundBinary = io.exists(osxExe).then(function(exists) {<tr><td><a name="l78" href="#l78">78</a><td> return exists ? osxExe : null;<tr><td><a name="l79" href="#l79">79</a><td> });<tr><td><a name="l80" href="#l80">80</a><td> } else if (process.platform === &#39;win32&#39;) {<tr><td><a name="l81" href="#l81">81</a><td> foundBinary = defaultWindowsLocation();<tr><td><a name="l82" href="#l82">82</a><td> } else {<tr><td><a name="l83" href="#l83">83</a><td> foundBinary = promise.fulfilled(io.findInPath(&#39;firefox&#39;));<tr><td><a name="l84" href="#l84">84</a><td> }<tr><td><a name="l85" href="#l85">85</a><td><tr><td><a name="l86" href="#l86">86</a><td> return foundBinary = foundBinary.then(function(found) {<tr><td><a name="l87" href="#l87">87</a><td> if (found) {<tr><td><a name="l88" href="#l88">88</a><td> return found;<tr><td><a name="l89" href="#l89">89</a><td> }<tr><td><a name="l90" href="#l90">90</a><td> throw Error(&#39;Could not locate Firefox on the current system&#39;);<tr><td><a name="l91" href="#l91">91</a><td> });<tr><td><a name="l92" href="#l92">92</a><td>}<tr><td><a name="l93" href="#l93">93</a><td><tr><td><a name="l94" href="#l94">94</a><td><tr><td><a name="l95" href="#l95">95</a><td>/**<tr><td><a name="l96" href="#l96">96</a><td> * Copies the no focus libs into the given profile directory.<tr><td><a name="l97" href="#l97">97</a><td> * @param {string} profileDir Path to the profile directory to install into.<tr><td><a name="l98" href="#l98">98</a><td> * @return {!promise.Promise.&lt;string&gt;} The LD_LIBRARY_PATH prefix string to use<tr><td><a name="l99" href="#l99">99</a><td> * for the installed libs.<tr><td><a name="l100" href="#l100">100</a><td> */<tr><td><a name="l101" href="#l101">101</a><td>function installNoFocusLibs(profileDir) {<tr><td><a name="l102" href="#l102">102</a><td> var x86 = path.join(profileDir, &#39;x86&#39;);<tr><td><a name="l103" href="#l103">103</a><td> var amd64 = path.join(profileDir, &#39;amd64&#39;);<tr><td><a name="l104" href="#l104">104</a><td><tr><td><a name="l105" href="#l105">105</a><td> return mkdir(x86)<tr><td><a name="l106" href="#l106">106</a><td> .then(copyLib.bind(null, NO_FOCUS_LIB_X86, x86))<tr><td><a name="l107" href="#l107">107</a><td> .then(mkdir.bind(null, amd64))<tr><td><a name="l108" href="#l108">108</a><td> .then(copyLib.bind(null, NO_FOCUS_LIB_AMD64, amd64))<tr><td><a name="l109" href="#l109">109</a><td> .then(function() {<tr><td><a name="l110" href="#l110">110</a><td> return x86 + &#39;:&#39; + amd64;<tr><td><a name="l111" href="#l111">111</a><td> });<tr><td><a name="l112" href="#l112">112</a><td><tr><td><a name="l113" href="#l113">113</a><td> function mkdir(dir) {<tr><td><a name="l114" href="#l114">114</a><td> return io.exists(dir).then(function(exists) {<tr><td><a name="l115" href="#l115">115</a><td> if (!exists) {<tr><td><a name="l116" href="#l116">116</a><td> return promise.checkedNodeCall(fs.mkdir, dir);<tr><td><a name="l117" href="#l117">117</a><td> }<tr><td><a name="l118" href="#l118">118</a><td> });<tr><td><a name="l119" href="#l119">119</a><td> }<tr><td><a name="l120" href="#l120">120</a><td><tr><td><a name="l121" href="#l121">121</a><td> function copyLib(src, dir) {<tr><td><a name="l122" href="#l122">122</a><td> return io.copy(src, path.join(dir, X_IGNORE_NO_FOCUS_LIB));<tr><td><a name="l123" href="#l123">123</a><td> }<tr><td><a name="l124" href="#l124">124</a><td>}<tr><td><a name="l125" href="#l125">125</a><td><tr><td><a name="l126" href="#l126">126</a><td><tr><td><a name="l127" href="#l127">127</a><td>/**<tr><td><a name="l128" href="#l128">128</a><td> * Silently runs Firefox to install a profile directory (which is assumed to be<tr><td><a name="l129" href="#l129">129</a><td> * defined in the given environment variables).<tr><td><a name="l130" href="#l130">130</a><td> * @param {string} firefox Path to the Firefox executable.<tr><td><a name="l131" href="#l131">131</a><td> * @param {!Object.&lt;string, string&gt;} env The environment variables to use.<tr><td><a name="l132" href="#l132">132</a><td> * @return {!promise.Promise} A promise for when the profile has been installed.<tr><td><a name="l133" href="#l133">133</a><td> */<tr><td><a name="l134" href="#l134">134</a><td>function installProfile(firefox, env) {<tr><td><a name="l135" href="#l135">135</a><td> var installed = promise.defer();<tr><td><a name="l136" href="#l136">136</a><td> child.exec(firefox + &#39; -silent&#39;, {env: env, timeout: 180 * 1000},<tr><td><a name="l137" href="#l137">137</a><td> function(err) {<tr><td><a name="l138" href="#l138">138</a><td> if (err) {<tr><td><a name="l139" href="#l139">139</a><td> installed.reject(new Error(<tr><td><a name="l140" href="#l140">140</a><td> &#39;Failed to install Firefox profile: &#39; + err));<tr><td><a name="l141" href="#l141">141</a><td> return;<tr><td><a name="l142" href="#l142">142</a><td> }<tr><td><a name="l143" href="#l143">143</a><td> installed.fulfill();<tr><td><a name="l144" href="#l144">144</a><td> });<tr><td><a name="l145" href="#l145">145</a><td> return installed.promise;<tr><td><a name="l146" href="#l146">146</a><td>}<tr><td><a name="l147" href="#l147">147</a><td><tr><td><a name="l148" href="#l148">148</a><td><tr><td><a name="l149" href="#l149">149</a><td>/**<tr><td><a name="l150" href="#l150">150</a><td> * Manages a Firefox subprocess configured for use with WebDriver.<tr><td><a name="l151" href="#l151">151</a><td> * @param {string=} opt_exe Path to the Firefox binary to use. If not<tr><td><a name="l152" href="#l152">152</a><td> * specified, will attempt to locate Firefox on the current system.<tr><td><a name="l153" href="#l153">153</a><td> * @constructor<tr><td><a name="l154" href="#l154">154</a><td> */<tr><td><a name="l155" href="#l155">155</a><td>var Binary = function(opt_exe) {<tr><td><a name="l156" href="#l156">156</a><td> /** @private {(string|undefined)} */<tr><td><a name="l157" href="#l157">157</a><td> this.exe_ = opt_exe;<tr><td><a name="l158" href="#l158">158</a><td><tr><td><a name="l159" href="#l159">159</a><td> /** @private {!Array.&lt;string&gt;} */<tr><td><a name="l160" href="#l160">160</a><td> this.args_ = [];<tr><td><a name="l161" href="#l161">161</a><td><tr><td><a name="l162" href="#l162">162</a><td> /** @private {!Object.&lt;string, string&gt;} */<tr><td><a name="l163" href="#l163">163</a><td> this.env_ = {};<tr><td><a name="l164" href="#l164">164</a><td> Object.keys(process.env).forEach(function(key) {<tr><td><a name="l165" href="#l165">165</a><td> this.env_[key] = process.env[key];<tr><td><a name="l166" href="#l166">166</a><td> }.bind(this));<tr><td><a name="l167" href="#l167">167</a><td> this.env_[&#39;MOZ_CRASHREPORTER_DISABLE&#39;] = &#39;1&#39;;<tr><td><a name="l168" href="#l168">168</a><td> this.env_[&#39;MOZ_NO_REMOTE&#39;] = &#39;1&#39;;<tr><td><a name="l169" href="#l169">169</a><td> this.env_[&#39;NO_EM_RESTART&#39;] = &#39;1&#39;;<tr><td><a name="l170" href="#l170">170</a><td><tr><td><a name="l171" href="#l171">171</a><td> /** @private {promise.Promise.&lt;!exec.Command&gt;} */<tr><td><a name="l172" href="#l172">172</a><td> this.command_ = null;<tr><td><a name="l173" href="#l173">173</a><td>};<tr><td><a name="l174" href="#l174">174</a><td><tr><td><a name="l175" href="#l175">175</a><td><tr><td><a name="l176" href="#l176">176</a><td>/**<tr><td><a name="l177" href="#l177">177</a><td> * Add arguments to the command line used to start Firefox.<tr><td><a name="l178" href="#l178">178</a><td> * @param {...(string|!Array.&lt;string&gt;)} var_args Either the arguments to add as<tr><td><a name="l179" href="#l179">179</a><td> * varargs, or the arguments as an array.<tr><td><a name="l180" href="#l180">180</a><td> */<tr><td><a name="l181" href="#l181">181</a><td>Binary.prototype.addArguments = function(var_args) {<tr><td><a name="l182" href="#l182">182</a><td> for (var i = 0; i &lt; arguments.length; i++) {<tr><td><a name="l183" href="#l183">183</a><td> if (util.isArray(arguments[i])) {<tr><td><a name="l184" href="#l184">184</a><td> this.args_ = this.args_.concat(arguments[i]);<tr><td><a name="l185" href="#l185">185</a><td> } else {<tr><td><a name="l186" href="#l186">186</a><td> this.args_.push(arguments[i]);<tr><td><a name="l187" href="#l187">187</a><td> }<tr><td><a name="l188" href="#l188">188</a><td> }<tr><td><a name="l189" href="#l189">189</a><td>};<tr><td><a name="l190" href="#l190">190</a><td><tr><td><a name="l191" href="#l191">191</a><td><tr><td><a name="l192" href="#l192">192</a><td>/**<tr><td><a name="l193" href="#l193">193</a><td> * Launches Firefox and eturns a promise that will be fulfilled when the process<tr><td><a name="l194" href="#l194">194</a><td> * terminates.<tr><td><a name="l195" href="#l195">195</a><td> * @param {string} profile Path to the profile directory to use.<tr><td><a name="l196" href="#l196">196</a><td> * @return {!promise.Promise.&lt;!exec.Result&gt;} A promise for the process result.<tr><td><a name="l197" href="#l197">197</a><td> * @throws {Error} If this instance has already been started.<tr><td><a name="l198" href="#l198">198</a><td> */<tr><td><a name="l199" href="#l199">199</a><td>Binary.prototype.launch = function(profile) {<tr><td><a name="l200" href="#l200">200</a><td> if (this.command_) {<tr><td><a name="l201" href="#l201">201</a><td> throw Error(&#39;Firefox is already running&#39;);<tr><td><a name="l202" href="#l202">202</a><td> }<tr><td><a name="l203" href="#l203">203</a><td><tr><td><a name="l204" href="#l204">204</a><td> var env = {};<tr><td><a name="l205" href="#l205">205</a><td> Object.keys(this.env_).forEach(function(key) {<tr><td><a name="l206" href="#l206">206</a><td> env[key] = this.env_[key];<tr><td><a name="l207" href="#l207">207</a><td> }.bind(this));<tr><td><a name="l208" href="#l208">208</a><td> env[&#39;XRE_PROFILE_PATH&#39;] = profile;<tr><td><a name="l209" href="#l209">209</a><td><tr><td><a name="l210" href="#l210">210</a><td> var args = [&#39;-foreground&#39;].concat(this.args_);<tr><td><a name="l211" href="#l211">211</a><td><tr><td><a name="l212" href="#l212">212</a><td> var self = this;<tr><td><a name="l213" href="#l213">213</a><td><tr><td><a name="l214" href="#l214">214</a><td> this.command_ = promise.when(this.exe_ || findFirefox(), function(firefox) {<tr><td><a name="l215" href="#l215">215</a><td> if (process.platform === &#39;win32&#39; || process.platform === &#39;darwin&#39;) {<tr><td><a name="l216" href="#l216">216</a><td> return firefox;<tr><td><a name="l217" href="#l217">217</a><td> }<tr><td><a name="l218" href="#l218">218</a><td> return installNoFocusLibs(profile).then(function(ldLibraryPath) {<tr><td><a name="l219" href="#l219">219</a><td> env[&#39;LD_LIBRARY_PATH&#39;] = ldLibraryPath + &#39;:&#39; + env[&#39;LD_LIBRARY_PATH&#39;];<tr><td><a name="l220" href="#l220">220</a><td> env[&#39;LD_PRELOAD&#39;] = X_IGNORE_NO_FOCUS_LIB;<tr><td><a name="l221" href="#l221">221</a><td> return firefox;<tr><td><a name="l222" href="#l222">222</a><td> });<tr><td><a name="l223" href="#l223">223</a><td> }).then(function(firefox) {<tr><td><a name="l224" href="#l224">224</a><td> var install = exec(firefox, {args: [&#39;-silent&#39;], env: env});<tr><td><a name="l225" href="#l225">225</a><td> return install.result().then(function(result) {<tr><td><a name="l226" href="#l226">226</a><td> if (result.code !== 0) {<tr><td><a name="l227" href="#l227">227</a><td> throw Error(<tr><td><a name="l228" href="#l228">228</a><td> &#39;Failed to install profile; firefox terminated with &#39; + result);<tr><td><a name="l229" href="#l229">229</a><td> }<tr><td><a name="l230" href="#l230">230</a><td><tr><td><a name="l231" href="#l231">231</a><td> return exec(firefox, {args: args, env: env});<tr><td><a name="l232" href="#l232">232</a><td> });<tr><td><a name="l233" href="#l233">233</a><td> });<tr><td><a name="l234" href="#l234">234</a><td><tr><td><a name="l235" href="#l235">235</a><td> return this.command_.then(function() {<tr><td><a name="l236" href="#l236">236</a><td> // Don&#39;t return the actual command handle, just a promise to signal it has<tr><td><a name="l237" href="#l237">237</a><td> // been started.<tr><td><a name="l238" href="#l238">238</a><td> });<tr><td><a name="l239" href="#l239">239</a><td>};<tr><td><a name="l240" href="#l240">240</a><td><tr><td><a name="l241" href="#l241">241</a><td><tr><td><a name="l242" href="#l242">242</a><td>/**<tr><td><a name="l243" href="#l243">243</a><td> * Kills the managed Firefox process.<tr><td><a name="l244" href="#l244">244</a><td> * @return {!promise.Promise} A promise for when the process has terminated.<tr><td><a name="l245" href="#l245">245</a><td> */<tr><td><a name="l246" href="#l246">246</a><td>Binary.prototype.kill = function() {<tr><td><a name="l247" href="#l247">247</a><td> if (!this.command_) {<tr><td><a name="l248" href="#l248">248</a><td> return promise.defer(); // Not running.<tr><td><a name="l249" href="#l249">249</a><td> }<tr><td><a name="l250" href="#l250">250</a><td> return this.command_.then(function(command) {<tr><td><a name="l251" href="#l251">251</a><td> command.kill();<tr><td><a name="l252" href="#l252">252</a><td> return command.result();<tr><td><a name="l253" href="#l253">253</a><td> });<tr><td><a name="l254" href="#l254">254</a><td>};<tr><td><a name="l255" href="#l255">255</a><td><tr><td><a name="l256" href="#l256">256</a><td><tr><td><a name="l257" href="#l257">257</a><td>// PUBLIC API<tr><td><a name="l258" href="#l258">258</a><td><tr><td><a name="l259" href="#l259">259</a><td><tr><td><a name="l260" href="#l260">260</a><td>exports.Binary = Binary;<tr><td><a name="l261" href="#l261">261</a><td></table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="../../license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../types.js"></script><script src="../../dossier.js"></script>