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
13 KiB
1 line
13 KiB
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>logging.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/webdriver/logging.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2013 Selenium comitters<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 "License");<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 "AS IS" 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>goog.provide('webdriver.logging');<tr><td><a name="l17" href="#l17">17</a><td>goog.provide('webdriver.logging.Preferences');<tr><td><a name="l18" href="#l18">18</a><td><tr><td><a name="l19" href="#l19">19</a><td>goog.require('goog.object');<tr><td><a name="l20" href="#l20">20</a><td><tr><td><a name="l21" href="#l21">21</a><td><tr><td><a name="l22" href="#l22">22</a><td>/**<tr><td><a name="l23" href="#l23">23</a><td> * Log level names from WebDriver's JSON wire protocol.<tr><td><a name="l24" href="#l24">24</a><td> * @enum {string}<tr><td><a name="l25" href="#l25">25</a><td> */<tr><td><a name="l26" href="#l26">26</a><td>webdriver.logging.LevelName = {<tr><td><a name="l27" href="#l27">27</a><td> ALL: 'ALL',<tr><td><a name="l28" href="#l28">28</a><td> DEBUG: 'DEBUG',<tr><td><a name="l29" href="#l29">29</a><td> INFO: 'INFO',<tr><td><a name="l30" href="#l30">30</a><td> WARNING: 'WARNING',<tr><td><a name="l31" href="#l31">31</a><td> SEVERE: 'SEVERE',<tr><td><a name="l32" href="#l32">32</a><td> OFF: 'OFF'<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>/**<tr><td><a name="l37" href="#l37">37</a><td> * Logging levels.<tr><td><a name="l38" href="#l38">38</a><td> * @enum {{value: number, name: webdriver.logging.LevelName}}<tr><td><a name="l39" href="#l39">39</a><td> */<tr><td><a name="l40" href="#l40">40</a><td>webdriver.logging.Level = {<tr><td><a name="l41" href="#l41">41</a><td> ALL: {value: Number.MIN_VALUE, name: webdriver.logging.LevelName.ALL},<tr><td><a name="l42" href="#l42">42</a><td> DEBUG: {value: 700, name: webdriver.logging.LevelName.DEBUG},<tr><td><a name="l43" href="#l43">43</a><td> INFO: {value: 800, name: webdriver.logging.LevelName.INFO},<tr><td><a name="l44" href="#l44">44</a><td> WARNING: {value: 900, name: webdriver.logging.LevelName.WARNING},<tr><td><a name="l45" href="#l45">45</a><td> SEVERE: {value: 1000, name: webdriver.logging.LevelName.SEVERE},<tr><td><a name="l46" href="#l46">46</a><td> OFF: {value: Number.MAX_VALUE, name: webdriver.logging.LevelName.OFF}<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><tr><td><a name="l50" href="#l50">50</a><td>/**<tr><td><a name="l51" href="#l51">51</a><td> * Converts a level name or value to a {@link webdriver.logging.Level} value.<tr><td><a name="l52" href="#l52">52</a><td> * If the name/value is not recognized, {@link webdriver.logging.Level.ALL}<tr><td><a name="l53" href="#l53">53</a><td> * will be returned.<tr><td><a name="l54" href="#l54">54</a><td> * @param {(number|string)} nameOrValue The log level name, or value, to<tr><td><a name="l55" href="#l55">55</a><td> * convert .<tr><td><a name="l56" href="#l56">56</a><td> * @return {!webdriver.logging.Level} The converted level.<tr><td><a name="l57" href="#l57">57</a><td> */<tr><td><a name="l58" href="#l58">58</a><td>webdriver.logging.getLevel = function(nameOrValue) {<tr><td><a name="l59" href="#l59">59</a><td> var predicate = goog.isString(nameOrValue) ?<tr><td><a name="l60" href="#l60">60</a><td> function(val) { return val.name === nameOrValue; } :<tr><td><a name="l61" href="#l61">61</a><td> function(val) { return val.value === nameOrValue; };<tr><td><a name="l62" href="#l62">62</a><td><tr><td><a name="l63" href="#l63">63</a><td> return goog.object.findValue(webdriver.logging.Level, predicate) ||<tr><td><a name="l64" href="#l64">64</a><td> webdriver.logging.Level.ALL;<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>/**<tr><td><a name="l69" href="#l69">69</a><td> * Common log types.<tr><td><a name="l70" href="#l70">70</a><td> * @enum {string}<tr><td><a name="l71" href="#l71">71</a><td> */<tr><td><a name="l72" href="#l72">72</a><td>webdriver.logging.Type = {<tr><td><a name="l73" href="#l73">73</a><td> /** Logs originating from the browser. */<tr><td><a name="l74" href="#l74">74</a><td> BROWSER: 'browser',<tr><td><a name="l75" href="#l75">75</a><td> /** Logs from a WebDriver client. */<tr><td><a name="l76" href="#l76">76</a><td> CLIENT: 'client',<tr><td><a name="l77" href="#l77">77</a><td> /** Logs from a WebDriver implementation. */<tr><td><a name="l78" href="#l78">78</a><td> DRIVER: 'driver',<tr><td><a name="l79" href="#l79">79</a><td> /** Logs related to performance. */<tr><td><a name="l80" href="#l80">80</a><td> PERFORMANCE: 'performance',<tr><td><a name="l81" href="#l81">81</a><td> /** Logs from the remote server. */<tr><td><a name="l82" href="#l82">82</a><td> SERVER: 'server'<tr><td><a name="l83" href="#l83">83</a><td>};<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>/**<tr><td><a name="l87" href="#l87">87</a><td> * A hash describing log preferences.<tr><td><a name="l88" href="#l88">88</a><td> * @typedef {Object.<webdriver.logging.Type, webdriver.logging.LevelName>}<tr><td><a name="l89" href="#l89">89</a><td> */<tr><td><a name="l90" href="#l90">90</a><td>webdriver.logging.Preferences;<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> * A single log entry.<tr><td><a name="l95" href="#l95">95</a><td> * @param {(!webdriver.logging.Level|string)} level The entry level.<tr><td><a name="l96" href="#l96">96</a><td> * @param {string} message The log message.<tr><td><a name="l97" href="#l97">97</a><td> * @param {number=} opt_timestamp The time this entry was generated, in<tr><td><a name="l98" href="#l98">98</a><td> * milliseconds since 0:00:00, January 1, 1970 UTC. If omitted, the<tr><td><a name="l99" href="#l99">99</a><td> * current time will be used.<tr><td><a name="l100" href="#l100">100</a><td> * @param {string=} opt_type The log type, if known.<tr><td><a name="l101" href="#l101">101</a><td> * @constructor<tr><td><a name="l102" href="#l102">102</a><td> */<tr><td><a name="l103" href="#l103">103</a><td>webdriver.logging.Entry = function(level, message, opt_timestamp, opt_type) {<tr><td><a name="l104" href="#l104">104</a><td><tr><td><a name="l105" href="#l105">105</a><td> /** @type {!webdriver.logging.Level} */<tr><td><a name="l106" href="#l106">106</a><td> this.level =<tr><td><a name="l107" href="#l107">107</a><td> goog.isString(level) ? webdriver.logging.getLevel(level) : level;<tr><td><a name="l108" href="#l108">108</a><td><tr><td><a name="l109" href="#l109">109</a><td> /** @type {string} */<tr><td><a name="l110" href="#l110">110</a><td> this.message = message;<tr><td><a name="l111" href="#l111">111</a><td><tr><td><a name="l112" href="#l112">112</a><td> /** @type {number} */<tr><td><a name="l113" href="#l113">113</a><td> this.timestamp = goog.isNumber(opt_timestamp) ? opt_timestamp : goog.now();<tr><td><a name="l114" href="#l114">114</a><td><tr><td><a name="l115" href="#l115">115</a><td> /** @type {string} */<tr><td><a name="l116" href="#l116">116</a><td> this.type = opt_type || '';<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> * @return {{level: string, message: string, timestamp: number,<tr><td><a name="l122" href="#l122">122</a><td> * type: string}} The JSON representation of this entry.<tr><td><a name="l123" href="#l123">123</a><td> */<tr><td><a name="l124" href="#l124">124</a><td>webdriver.logging.Entry.prototype.toJSON = function() {<tr><td><a name="l125" href="#l125">125</a><td> return {<tr><td><a name="l126" href="#l126">126</a><td> 'level': this.level.name,<tr><td><a name="l127" href="#l127">127</a><td> 'message': this.message,<tr><td><a name="l128" href="#l128">128</a><td> 'timestamp': this.timestamp,<tr><td><a name="l129" href="#l129">129</a><td> 'type': this.type<tr><td><a name="l130" href="#l130">130</a><td> };<tr><td><a name="l131" href="#l131">131</a><td>};<tr><td><a name="l132" href="#l132">132</a><td><tr><td><a name="l133" href="#l133">133</a><td><tr><td><a name="l134" href="#l134">134</a><td>/**<tr><td><a name="l135" href="#l135">135</a><td> * Converts a {@link goog.debug.LogRecord} into a<tr><td><a name="l136" href="#l136">136</a><td> * {@link webdriver.logging.Entry}.<tr><td><a name="l137" href="#l137">137</a><td> * @param {!goog.debug.LogRecord} logRecord The record to convert.<tr><td><a name="l138" href="#l138">138</a><td> * @param {string=} opt_type The log type.<tr><td><a name="l139" href="#l139">139</a><td> * @return {!webdriver.logging.Entry} The converted entry.<tr><td><a name="l140" href="#l140">140</a><td> */<tr><td><a name="l141" href="#l141">141</a><td>webdriver.logging.Entry.fromClosureLogRecord = function(logRecord, opt_type) {<tr><td><a name="l142" href="#l142">142</a><td> var closureLevel = logRecord.getLevel();<tr><td><a name="l143" href="#l143">143</a><td> var level = webdriver.logging.Level.SEVERE;<tr><td><a name="l144" href="#l144">144</a><td><tr><td><a name="l145" href="#l145">145</a><td> if (closureLevel.value <= webdriver.logging.Level.DEBUG.value) {<tr><td><a name="l146" href="#l146">146</a><td> level = webdriver.logging.Level.DEBUG;<tr><td><a name="l147" href="#l147">147</a><td> } else if (closureLevel.value <= webdriver.logging.Level.INFO.value) {<tr><td><a name="l148" href="#l148">148</a><td> level = webdriver.logging.Level.INFO;<tr><td><a name="l149" href="#l149">149</a><td> } else if (closureLevel.value <= webdriver.logging.Level.WARNING.value) {<tr><td><a name="l150" href="#l150">150</a><td> level = webdriver.logging.Level.WARNING;<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> return new webdriver.logging.Entry(<tr><td><a name="l154" href="#l154">154</a><td> level,<tr><td><a name="l155" href="#l155">155</a><td> '[' + logRecord.getLoggerName() + '] ' + logRecord.getMessage(),<tr><td><a name="l156" href="#l156">156</a><td> logRecord.getMillis(),<tr><td><a name="l157" href="#l157">157</a><td> opt_type);<tr><td><a name="l158" href="#l158">158</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> |