@malijs/logger

<!doctype html> <html lang="en"> <head> <title>Code coverage report for index.js</title> <meta charset="utf-8" /> <link rel="stylesheet" href="prettify.css" /> <link rel="stylesheet" href="base.css" /> <link rel="shortcut icon" type="image/x-icon" href="favicon.png" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <style type='text/css'> .coverage-summary .sorter { background-image: url(sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1><a href="index.html">All files</a> index.js</h1> <div class='clearfix'> <div class='fl pad1y space-right2'> 98.67% Statements 148/150 </div> <div class='fl pad1y space-right2'> 88.64% Branches 39/44 </div> <div class='fl pad1y space-right2'> 100% Functions 8/8 </div> <div class='fl pad1y space-right2'> 98.67% Lines 148/150 </div> </div> Press n or j to go to the next uncovered block, b, p or k for the previous block. </div> <div class='status-line high'></div> <pre><table class="coverage"> <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a> <a name='L2'></a><a href='#L2'>2</a> <a name='L3'></a><a href='#L3'>3</a> <a name='L4'></a><a href='#L4'>4</a> <a name='L5'></a><a href='#L5'>5</a> <a name='L6'></a><a href='#L6'>6</a> <a name='L7'></a><a href='#L7'>7</a> <a name='L8'></a><a href='#L8'>8</a> <a name='L9'></a><a href='#L9'>9</a> <a name='L10'></a><a href='#L10'>10</a> <a name='L11'></a><a href='#L11'>11</a> <a name='L12'></a><a href='#L12'>12</a> <a name='L13'></a><a href='#L13'>13</a> <a name='L14'></a><a href='#L14'>14</a> <a name='L15'></a><a href='#L15'>15</a> <a name='L16'></a><a href='#L16'>16</a> <a name='L17'></a><a href='#L17'>17</a> <a name='L18'></a><a href='#L18'>18</a> <a name='L19'></a><a href='#L19'>19</a> <a name='L20'></a><a href='#L20'>20</a> <a name='L21'></a><a href='#L21'>21</a> <a name='L22'></a><a href='#L22'>22</a> <a name='L23'></a><a href='#L23'>23</a> <a name='L24'></a><a href='#L24'>24</a> <a name='L25'></a><a href='#L25'>25</a> <a name='L26'></a><a href='#L26'>26</a> <a name='L27'></a><a href='#L27'>27</a> <a name='L28'></a><a href='#L28'>28</a> <a name='L29'></a><a href='#L29'>29</a> <a name='L30'></a><a href='#L30'>30</a> <a name='L31'></a><a href='#L31'>31</a> <a name='L32'></a><a href='#L32'>32</a> <a name='L33'></a><a href='#L33'>33</a> <a name='L34'></a><a href='#L34'>34</a> <a name='L35'></a><a href='#L35'>35</a> <a name='L36'></a><a href='#L36'>36</a> <a name='L37'></a><a href='#L37'>37</a> <a name='L38'></a><a href='#L38'>38</a> <a name='L39'></a><a href='#L39'>39</a> <a name='L40'></a><a href='#L40'>40</a> <a name='L41'></a><a href='#L41'>41</a> <a name='L42'></a><a href='#L42'>42</a> <a name='L43'></a><a href='#L43'>43</a> <a name='L44'></a><a href='#L44'>44</a> <a name='L45'></a><a href='#L45'>45</a> <a name='L46'></a><a href='#L46'>46</a> <a name='L47'></a><a href='#L47'>47</a> <a name='L48'></a><a href='#L48'>48</a> <a name='L49'></a><a href='#L49'>49</a> <a name='L50'></a><a href='#L50'>50</a> <a name='L51'></a><a href='#L51'>51</a> <a name='L52'></a><a href='#L52'>52</a> <a name='L53'></a><a href='#L53'>53</a> <a name='L54'></a><a href='#L54'>54</a> <a name='L55'></a><a href='#L55'>55</a> <a name='L56'></a><a href='#L56'>56</a> <a name='L57'></a><a href='#L57'>57</a> <a name='L58'></a><a href='#L58'>58</a> <a name='L59'></a><a href='#L59'>59</a> <a name='L60'></a><a href='#L60'>60</a> <a name='L61'></a><a href='#L61'>61</a> <a name='L62'></a><a href='#L62'>62</a> <a name='L63'></a><a href='#L63'>63</a> <a name='L64'></a><a href='#L64'>64</a> <a name='L65'></a><a href='#L65'>65</a> <a name='L66'></a><a href='#L66'>66</a> <a name='L67'></a><a href='#L67'>67</a> <a name='L68'></a><a href='#L68'>68</a> <a name='L69'></a><a href='#L69'>69</a> <a name='L70'></a><a href='#L70'>70</a> <a name='L71'></a><a href='#L71'>71</a> <a name='L72'></a><a href='#L72'>72</a> <a name='L73'></a><a href='#L73'>73</a> <a name='L74'></a><a href='#L74'>74</a> <a name='L75'></a><a href='#L75'>75</a> <a name='L76'></a><a href='#L76'>76</a> <a name='L77'></a><a href='#L77'>77</a> <a name='L78'></a><a href='#L78'>78</a> <a name='L79'></a><a href='#L79'>79</a> <a name='L80'></a><a href='#L80'>80</a> <a name='L81'></a><a href='#L81'>81</a> <a name='L82'></a><a href='#L82'>82</a> <a name='L83'></a><a href='#L83'>83</a> <a name='L84'></a><a href='#L84'>84</a> <a name='L85'></a><a href='#L85'>85</a> <a name='L86'></a><a href='#L86'>86</a> <a name='L87'></a><a href='#L87'>87</a> <a name='L88'></a><a href='#L88'>88</a> <a name='L89'></a><a href='#L89'>89</a> <a name='L90'></a><a href='#L90'>90</a> <a name='L91'></a><a href='#L91'>91</a> <a name='L92'></a><a href='#L92'>92</a> <a name='L93'></a><a href='#L93'>93</a> <a name='L94'></a><a href='#L94'>94</a> <a name='L95'></a><a href='#L95'>95</a> <a name='L96'></a><a href='#L96'>96</a> <a name='L97'></a><a href='#L97'>97</a> <a name='L98'></a><a href='#L98'>98</a> <a name='L99'></a><a href='#L99'>99</a> <a name='L100'></a><a href='#L100'>100</a> <a name='L101'></a><a href='#L101'>101</a> <a name='L102'></a><a href='#L102'>102</a> <a name='L103'></a><a href='#L103'>103</a> <a name='L104'></a><a href='#L104'>104</a> <a name='L105'></a><a href='#L105'>105</a> <a name='L106'></a><a href='#L106'>106</a> <a name='L107'></a><a href='#L107'>107</a> <a name='L108'></a><a href='#L108'>108</a> <a name='L109'></a><a href='#L109'>109</a> <a name='L110'></a><a href='#L110'>110</a> <a name='L111'></a><a href='#L111'>111</a> <a name='L112'></a><a href='#L112'>112</a> <a name='L113'></a><a href='#L113'>113</a> <a name='L114'></a><a href='#L114'>114</a> <a name='L115'></a><a href='#L115'>115</a> <a name='L116'></a><a href='#L116'>116</a> <a name='L117'></a><a href='#L117'>117</a> <a name='L118'></a><a href='#L118'>118</a> <a name='L119'></a><a href='#L119'>119</a> <a name='L120'></a><a href='#L120'>120</a> <a name='L121'></a><a href='#L121'>121</a> <a name='L122'></a><a href='#L122'>122</a> <a name='L123'></a><a href='#L123'>123</a> <a name='L124'></a><a href='#L124'>124</a> <a name='L125'></a><a href='#L125'>125</a> <a name='L126'></a><a href='#L126'>126</a> <a name='L127'></a><a href='#L127'>127</a> <a name='L128'></a><a href='#L128'>128</a> <a name='L129'></a><a href='#L129'>129</a> <a name='L130'></a><a href='#L130'>130</a> <a name='L131'></a><a href='#L131'>131</a> <a name='L132'></a><a href='#L132'>132</a> <a name='L133'></a><a href='#L133'>133</a> <a name='L134'></a><a href='#L134'>134</a> <a name='L135'></a><a href='#L135'>135</a> <a name='L136'></a><a href='#L136'>136</a> <a name='L137'></a><a href='#L137'>137</a> <a name='L138'></a><a href='#L138'>138</a> <a name='L139'></a><a href='#L139'>139</a> <a name='L140'></a><a href='#L140'>140</a> <a name='L141'></a><a href='#L141'>141</a> <a name='L142'></a><a href='#L142'>142</a> <a name='L143'></a><a href='#L143'>143</a> <a name='L144'></a><a href='#L144'>144</a> <a name='L145'></a><a href='#L145'>145</a> <a name='L146'></a><a href='#L146'>146</a> <a name='L147'></a><a href='#L147'>147</a> <a name='L148'></a><a href='#L148'>148</a> <a name='L149'></a><a href='#L149'>149</a> <a name='L150'></a><a href='#L150'>150</a> <a name='L151'></a><a href='#L151'>151</a></td><td class="line-coverage quiet">1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 9x 9x 8x 8x 9x 9x 1x 9x 5x 5x 9x 9x 1x 9x 7x 7x 9x 9x 1x 9x 7x 7x 9x 9x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 10x 9x 9x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 11x 1x 1x 1x 11x 9x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 11x 11x 11x 11x 11x 11x 11x 11x 10x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 1x 11x 11x 11x     11x 1x 1x  </td><td class="text"><pre class="prettyprint lang-js">const { humanizeNumber } = require('./helpers') const chalk = require('chalk') const isStream = require('is-stream')   /** * Development style logger middleware for Mali. * @module @malijs/logger * * @param {Object} options Options * @param {Boolean} options.fullName To log full name from context, otherwise logs just the name. * Default: <code>false</code> * @param {Boolean | Function} options.timestamp Enables or disables the inclusion of a timestamp in the log message. * If a function is supplied, it is passed a `Date` timestamp and it must synchronously return the string representation to be logged. * There are predefined timestamp functions: `epochTime` (default), `epochTime`, and `isoTime`. * @param {Boolean | Function} options.request Enables or disables the inclusion of request in the log message. * By default `JSON.stringify` is used. If a function is supplied it is passed the request from the context. * @param {Boolean | Function} options.response Enables or disables the inclusion of response in the log message. * By default `JSON.stringify` is used. If a function is supplied it is passed the response from the context. * * @example * const logger = require('@malijs/logger') * app.use(logger()) * * @example <caption>With timestamp</catoin> * const logger = require('@malijs/logger') * app.use(logger({timestamp: true})) * * @example <caption>With custom predefined timestamp</catoin> * const logger = require('@malijs/logger') * app.use(logger({timestamp: logger.isoTime})) * * @example <caption>With custom timestamp function</catoin> * const logger = require('@malijs/logger') * app.use(logger({ timestamp: date => `${date.toDateString()} ${date.toLocaleTimeString()}` })) */ function logger (options = {}) { if (typeof options.fullName !== 'boolean') { options.fullName = false }   if (options.timestamp === true) { options.timestamp = epochTime } else if (typeof options.timestamp !== 'function') { options.timestamp = false }   if (options.request === true) { options.request = JSON.stringify } else if (typeof options.request !== 'function') { options.request = false }   if (options.response === true) { options.response = JSON.stringify } else if (typeof options.response !== 'function') { options.response = false }   return function logger (ctx, next) { const start = new Date() const timestamp = options.timestamp ? ` ${options.timestamp(start)}` : '' const request = options.request ? ` ${options.request(ctx.req)}` : ''   console .log( ` ${chalk.gray('-->')} ${chalk.bold('%s')}%s ${chalk.gray('%s')}`, timestamp, options.fullName ? ctx.fullName : ctx.name, request, ctx.type )   return next().then(() => { if (!isStream(ctx.res) || (ctx.type !== 'response_stream' && ctx.type !== 'duplex')) { return log(options, ctx, start, null, null) }   const res = ctx.res const onfinish = done.bind(null, 'finish') const onclose = done.bind(null, 'close') const onend = done.bind(null, 'end')   res.once('finish', onfinish) res.once('close', onclose) res.once('end', onend)   function done (event) { res.removeListener('finish', onfinish) res.removeListener('close', onclose) res.removeListener('end', onend) log(options, ctx, start, null, event) } }, (err) => { log(options, ctx, start, err) throw err }) } }   /** * Milliseconds since Unix epoch (Default) */ const epochTime = date => `${date.getTime()}`   /** * Seconds since Unix epoch */ const unixTime = date => `${Math.round(date.getTime() / 1000.0)}`   /** * Timestamp in ISO time. */ const isoTime = date => `${date.toISOString()}`   logger.epochTime = epochTime logger.unixTime = unixTime logger.isoTime = isoTime   function log (options, ctx, start, err, event) { const color = err ? 'red' : 'green'   const timestamp = options.timestamp ? options.timestamp(start) : ''   const response = options.response ? options.response(ctx.res) : ''   const upstream = err ? chalk.red('<--') : event === 'close' ? chalk.yellow('-x-') : chalk.gray('<--')   console.log(' ' + upstream + chalk.cyan('%s') + ' ' + chalk.bold('%s') + '%s' + ' ' + chalk.gray('%s') + ' ' + chalk[color]('%s'), timestamp ? ` ${timestamp}` : '', options.fullName ? ctx.fullName : ctx.name, response ? ` ${response}` : '', ctx.type, time(start)) }   function time (start) { const delta = new Date() - start return humanizeNumber(delta < 10000 ? delta + 'ms' : Math.round(delta / 1000) + 's') }   module.exports = logger  </pre></td></tr></table></pre> <div class='push'></div> </div> <div class='footer quiet pad2 space-top1 center small'> Code coverage generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Thu Feb 18 2021 14:56:36 GMT+0300 (GMT+03:00) </div> </div> <script src="prettify.js"></script> <script> window.onload = function () { prettyPrint(); }; </script> <script src="sorter.js"></script> <script src="block-navigation.js"></script> </body> </html>