You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1 line
9.4 KiB
1 line
9.4 KiB
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>response.js</title><link href="../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/atoms/response.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2011 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 "License");<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 "AS IS" 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 Utilities for working with WebDriver response objects.<tr><td><a name="l17" href="#l17">17</a><td> * @see: http://code.google.com/p/selenium/wiki/JsonWireProtocol#Responses<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>goog.provide('bot.response');<tr><td><a name="l21" href="#l21">21</a><td>goog.provide('bot.response.ResponseObject');<tr><td><a name="l22" href="#l22">22</a><td><tr><td><a name="l23" href="#l23">23</a><td>goog.require('bot.Error');<tr><td><a name="l24" href="#l24">24</a><td>goog.require('bot.ErrorCode');<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>/**<tr><td><a name="l28" href="#l28">28</a><td> * Type definition for a response object, as defined by the JSON wire protocol.<tr><td><a name="l29" href="#l29">29</a><td> * @typedef {{status: bot.ErrorCode, value: (*|{message: string})}}<tr><td><a name="l30" href="#l30">30</a><td> * @see http://code.google.com/p/selenium/wiki/JsonWireProtocol#Responses<tr><td><a name="l31" href="#l31">31</a><td> */<tr><td><a name="l32" href="#l32">32</a><td>bot.response.ResponseObject;<tr><td><a name="l33" href="#l33">33</a><td><tr><td><a name="l34" href="#l34">34</a><td><tr><td><a name="l35" href="#l35">35</a><td>/**<tr><td><a name="l36" href="#l36">36</a><td> * @param {*} value The value to test.<tr><td><a name="l37" href="#l37">37</a><td> * @return {boolean} Whether the given value is a response object.<tr><td><a name="l38" href="#l38">38</a><td> */<tr><td><a name="l39" href="#l39">39</a><td>bot.response.isResponseObject = function(value) {<tr><td><a name="l40" href="#l40">40</a><td> return goog.isObject(value) && goog.isNumber(value['status']);<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> * Creates a new success response object with the provided value.<tr><td><a name="l46" href="#l46">46</a><td> * @param {*} value The response value.<tr><td><a name="l47" href="#l47">47</a><td> * @return {!bot.response.ResponseObject} The new response object.<tr><td><a name="l48" href="#l48">48</a><td> */<tr><td><a name="l49" href="#l49">49</a><td>bot.response.createResponse = function(value) {<tr><td><a name="l50" href="#l50">50</a><td> if (bot.response.isResponseObject(value)) {<tr><td><a name="l51" href="#l51">51</a><td> return /** @type {!bot.response.ResponseObject} */ (value);<tr><td><a name="l52" href="#l52">52</a><td> }<tr><td><a name="l53" href="#l53">53</a><td> return {<tr><td><a name="l54" href="#l54">54</a><td> 'status': bot.ErrorCode.SUCCESS,<tr><td><a name="l55" href="#l55">55</a><td> 'value': value<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><tr><td><a name="l59" href="#l59">59</a><td><tr><td><a name="l60" href="#l60">60</a><td>/**<tr><td><a name="l61" href="#l61">61</a><td> * Converts an error value into its JSON representation as defined by the<tr><td><a name="l62" href="#l62">62</a><td> * WebDriver wire protocol.<tr><td><a name="l63" href="#l63">63</a><td> * @param {(bot.Error|Error|*)} error The error value to convert.<tr><td><a name="l64" href="#l64">64</a><td> * @return {!bot.response.ResponseObject} The new response object.<tr><td><a name="l65" href="#l65">65</a><td> */<tr><td><a name="l66" href="#l66">66</a><td>bot.response.createErrorResponse = function(error) {<tr><td><a name="l67" href="#l67">67</a><td> if (bot.response.isResponseObject(error)) {<tr><td><a name="l68" href="#l68">68</a><td> return /** @type {!bot.response.ResponseObject} */ (error);<tr><td><a name="l69" href="#l69">69</a><td> }<tr><td><a name="l70" href="#l70">70</a><td><tr><td><a name="l71" href="#l71">71</a><td> var statusCode = error && goog.isNumber(error.code) ? error.code :<tr><td><a name="l72" href="#l72">72</a><td> bot.ErrorCode.UNKNOWN_ERROR;<tr><td><a name="l73" href="#l73">73</a><td> return {<tr><td><a name="l74" href="#l74">74</a><td> 'status': /** @type {bot.ErrorCode} */ (statusCode),<tr><td><a name="l75" href="#l75">75</a><td> 'value': {<tr><td><a name="l76" href="#l76">76</a><td> 'message': (error && error.message || error) + ''<tr><td><a name="l77" href="#l77">77</a><td> }<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><tr><td><a name="l82" href="#l82">82</a><td>/**<tr><td><a name="l83" href="#l83">83</a><td> * Checks that a response object does not specify an error as defined by the<tr><td><a name="l84" href="#l84">84</a><td> * WebDriver wire protocol. If the response object defines an error, it will<tr><td><a name="l85" href="#l85">85</a><td> * be thrown. Otherwise, the response will be returned as is.<tr><td><a name="l86" href="#l86">86</a><td> * @param {!bot.response.ResponseObject} responseObj The response object to<tr><td><a name="l87" href="#l87">87</a><td> * check.<tr><td><a name="l88" href="#l88">88</a><td> * @return {!bot.response.ResponseObject} The checked response object.<tr><td><a name="l89" href="#l89">89</a><td> * @throws {bot.Error} If the response describes an error.<tr><td><a name="l90" href="#l90">90</a><td> * @see http://code.google.com/p/selenium/wiki/JsonWireProtocol#Failed_Commands<tr><td><a name="l91" href="#l91">91</a><td> */<tr><td><a name="l92" href="#l92">92</a><td>bot.response.checkResponse = function(responseObj) {<tr><td><a name="l93" href="#l93">93</a><td> var status = responseObj['status'];<tr><td><a name="l94" href="#l94">94</a><td> if (status == bot.ErrorCode.SUCCESS) {<tr><td><a name="l95" href="#l95">95</a><td> return responseObj;<tr><td><a name="l96" href="#l96">96</a><td> }<tr><td><a name="l97" href="#l97">97</a><td><tr><td><a name="l98" href="#l98">98</a><td> // If status is not defined, assume an unknown error.<tr><td><a name="l99" href="#l99">99</a><td> status = status || bot.ErrorCode.UNKNOWN_ERROR;<tr><td><a name="l100" href="#l100">100</a><td><tr><td><a name="l101" href="#l101">101</a><td> var value = responseObj['value'];<tr><td><a name="l102" href="#l102">102</a><td> if (!value || !goog.isObject(value)) {<tr><td><a name="l103" href="#l103">103</a><td> throw new bot.Error(status, value + '');<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> throw new bot.Error(status, value['message'] + '');<tr><td><a name="l107" href="#l107">107</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>No data</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>No data</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>No data</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> |