UNPKG

blackbird-server

Version:
465 lines (464 loc) 16.6 kB
<!doctype html> <html lang="en"> <head> <title>Code coverage report for modules/middleware/session/RedisStore.js</title> <meta charset="utf-8" /> <link rel="stylesheet" href="../../../prettify.css" /> <link rel="stylesheet" href="../../../base.css" /> <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> / <a href="index.html">modules/middleware/session/</a> RedisStore.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> <span class="strong">26.92% </span> <span class="quiet">Statements</span> <span class='fraction'>14/52</span> </div> <div class='fl pad1y space-right2'> <span class="strong">16.67% </span> <span class="quiet">Branches</span> <span class='fraction'>4/24</span> </div> <div class='fl pad1y space-right2'> <span class="strong">7.14% </span> <span class="quiet">Functions</span> <span class='fraction'>1/14</span> </div> <div class='fl pad1y space-right2'> <span class="strong">26.92% </span> <span class="quiet">Lines</span> <span class='fraction'>14/52</span> </div> </div> </div> <div class='status-line low'></div> <pre><table class="coverage"> <tr><td class="line-count quiet">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134</td><td class="line-coverage quiet"><span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">const d = require("describe-property"); const redis = require("redis"); const makeToken = require("../../utils/makeToken"); const Promise = require("../../utils/Promise"); const parseURL = require("../../utils/parseURL"); &nbsp; <span class="fstat-no" title="function not covered" >function sendCommand(client, command, args) {</span> <span class="cstat-no" title="statement not covered" > args = args || [];</span> &nbsp; <span class="cstat-no" title="statement not covered" > return new Promise(<span class="fstat-no" title="function not covered" >function (resolve, reject) {</span></span> <span class="cstat-no" title="statement not covered" > client.send_command(command, args, <span class="fstat-no" title="function not covered" >function (error, value) {</span></span> <span class="cstat-no" title="statement not covered" > if (error) {</span> <span class="cstat-no" title="statement not covered" > reject(error);</span> } else { <span class="cstat-no" title="statement not covered" > resolve(value);</span> } }); }); } &nbsp; <span class="fstat-no" title="function not covered" >function makeUniqueKey(client, keyLength) {</span> <span class="cstat-no" title="statement not covered" > const key = makeToken(keyLength);</span> &nbsp; // Try to set an empty string to reserve the key. <span class="cstat-no" title="statement not covered" > return sendCommand(client, "setnx", [key, ""]).then(<span class="fstat-no" title="function not covered" >function (result) {</span></span> <span class="cstat-no" title="statement not covered" > if (result === 1) {</span> <span class="cstat-no" title="statement not covered" > return key; </span>// The key was available. } &nbsp; <span class="cstat-no" title="statement not covered" > return makeUniqueKey(client, keyLength); </span>// Try again. }); } &nbsp; /** * Server-side storage for sessions using Redis. * * Options may be any of the following: * * - url The URL of the Redis instance * - keyLength The length (in bytes) that will be used for unique * cache keys. Defaults to 32 * - expireAfter The number of seconds after which sessions expire. * Defaults to 0 (no expiration) * * Additionally, all options are passed through to `redis.createClient`. * * Example: * * let RedisStore = require('mach/middleware/session/RedisStore'); * * app.use(mach.session, { * store: new RedisStore({ url: 'redis://127.0.0.1:6379' }) * }); * * Note: This store always checks for availability of keys in Redis before * using them, so it should be safe to use alongside other programs that are * using the same database. However, if you purge the store of all keys it will * issue a FLUSHDB command to the database, so be careful. This operation never * happens automatically. */ function RedisStore(options) { options = options || <span class="branch-1 cbranch-no" title="branch not covered" >{};</span> &nbsp; this.options = options; this.keyLength = options.keyLength || 32; this.ttl = options.expireAfter ? <span class="branch-0 cbranch-no" title="branch not covered" >1000 * options.expireAfter </span>// expireAfter is given in seconds : 0; } &nbsp; Object.defineProperties(RedisStore.prototype, { &nbsp; getClient: d(<span class="fstat-no" title="function not covered" >function () {</span> <span class="cstat-no" title="statement not covered" > if (!this._client) {</span> <span class="cstat-no" title="statement not covered" > const options = this.options;</span> &nbsp; <span class="cstat-no" title="statement not covered" > let hostname, port;</span> <span class="cstat-no" title="statement not covered" > if (typeof options.url === "string") {</span> <span class="cstat-no" title="statement not covered" > const parsedURL = parseURL(options.url);</span> <span class="cstat-no" title="statement not covered" > hostname = parsedURL.hostname;</span> <span class="cstat-no" title="statement not covered" > port = parsedURL.port;</span> } &nbsp; <span class="cstat-no" title="statement not covered" > this._client = redis.createClient(port, hostname, options);</span> } &nbsp; <span class="cstat-no" title="statement not covered" > return this._client;</span> }), &nbsp; load: d(<span class="fstat-no" title="function not covered" >function (value) {</span> <span class="cstat-no" title="statement not covered" > return sendCommand(this.getClient(), "get", [value]).then(<span class="fstat-no" title="function not covered" >function (json) {</span></span> <span class="cstat-no" title="statement not covered" > return json ? JSON.parse(json) : {};</span> }); }), &nbsp; save: d(<span class="fstat-no" title="function not covered" >function (session) {</span> <span class="cstat-no" title="statement not covered" > const client = this.getClient();</span> <span class="cstat-no" title="statement not covered" > const keyLength = this.keyLength;</span> <span class="cstat-no" title="statement not covered" > const ttl = this.ttl;</span> &nbsp; <span class="cstat-no" title="statement not covered" > return Promise.resolve(session._id || makeUniqueKey(client, keyLength)).then(<span class="fstat-no" title="function not covered" >function (key) {</span></span> <span class="cstat-no" title="statement not covered" > session._id = key;</span> &nbsp; <span class="cstat-no" title="statement not covered" > const json = JSON.stringify(session);</span> &nbsp; <span class="cstat-no" title="statement not covered" > let promise;</span> <span class="cstat-no" title="statement not covered" > if (ttl) {</span> <span class="cstat-no" title="statement not covered" > promise = sendCommand(client, "psetex", [key, ttl, json]);</span> } else { <span class="cstat-no" title="statement not covered" > promise = sendCommand(client, "set", [key, json]);</span> } &nbsp; <span class="cstat-no" title="statement not covered" > return promise.then(<span class="fstat-no" title="function not covered" >function () {</span></span> <span class="cstat-no" title="statement not covered" > return key;</span> }); }); }), &nbsp; purge: d(<span class="fstat-no" title="function not covered" >function (key) {</span> <span class="cstat-no" title="statement not covered" > if (key) {</span> <span class="cstat-no" title="statement not covered" > return sendCommand(this.getClient(), "del", [key]);</span> } &nbsp; <span class="cstat-no" title="statement not covered" > return sendCommand(this.getClient(), "flushdb");</span> }), &nbsp; destroy: d(<span class="fstat-no" title="function not covered" >function () {</span> <span class="cstat-no" title="statement not covered" > return sendCommand(this.getClient(), "quit");</span> }) &nbsp; }); &nbsp; module.exports = RedisStore; &nbsp;</pre></td></tr> </table></pre> <div class='push'></div><!-- for sticky footer --> </div><!-- /wrapper --> <div class='footer quiet pad2 space-top1 center small'> Code coverage generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Wed Jul 06 2016 20:37:18 GMT-0500 (CDT) </div> </div> <script src="../../../prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="../../../sorter.js"></script> </body> </html>