apollo-passport-rethinkdbdash

<!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" /> <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'> 100% Statements 29/29 </div> <div class='fl pad1y space-right2'> 95.83% Branches 23/24 </div> <div class='fl pad1y space-right2'> 100% Functions 5/5 </div> <div class='fl pad1y space-right2'> 100% Lines 29/29 </div> </div> </div> <div class='status-line high'></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 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264</td><td class="line-coverage quiet">1x                                 12x 6x 6x 6x 6x 6x 6x     6x 5x                   5x     5x   5x   5x 5x             25x 25x 25x 19x   6x                                                                                                         1x 1x 1x   1x                                                                                           2x 1x                                                               4x                                                                                   2x                                             1x          </td><td class="text"><pre class="prettyprint lang-js">import 'regenerator-runtime/runtime';   /** Class implementing the Apollo Passport DBDriver interface */ class RethinkDBDashDriver {   /** * Returns a DBDriver instance (for use by Apollo Passport). Parameters are * driver-specific and should be clearly specificied in the README. * This documents the RethinkDBDash DBDriver specifically, although some * *options* are relevant for all drivers. * * @param {rethinkdbdash} r, e.g. var r = require('rethinkdbdash')(); * * @param {string} options.userTableName default: 'users' * @param {string} options.configTableName default: 'apolloPassportConfig' * @param {string} options.dbName default: current database */ constructor(r, options = {}) { this.r = r; this.userTableName = options.userTableName || 'users'; this.configTableName = options.configTableName || 'apolloPassportConfig'; this.dbName = options.dbName || (r._poolMaster && r._poolMaster._options.db); this.db = r.db(this.dbName); this.readySubs = [];   // don't await the init, run async if (options.init !== false) this._init(); }   /** * Internal method, documented for benefit of driver authors. Most important * is to call fetchConfig() (XXX unfinished), but may also assert that all * tables exist, and run ready callbacks. */ async _init() { await this._assertTableExists(this.userTableName); this.users = this.db.table(this.userTableName);   await this._assertTableExists(this.configTableName); this.config = this.db.table(this.configTableName);   this.initted = true;   while(this.readySubs.length) this.readySubs.shift().call(); }   /** * Internal method, documented for benefit of driver authors. An awaitable * promise that returns if the driver is ready (or when it becomes ready). */ _ready() { return new Promise((resolve) => { if (this.initted) resolve(); else this.readySubs.push(resolve); }); }   ////////////////// // DB UTILITIES // //////////////////   /** * Internal method, documented for benefit of driver authors. Asserts (and * awaits) that the given table name exists. This is a convenience for the * user but with RethinkDB **there is no safe way to do this** other than * creating the table in advance (outside of the app). It's fine if the * table is created with only one app instance running, which is usually * the case for initial setup. * * @param {string} name - the name of the table to assert */ async _assertTableExists(name) { try { await this.db.tableCreate(name).run(); } catch (err) { if (err.msg !== `Table \`${this.dbName}.${name}\` already exists.`) { throw err; } // XXX give a warning about the caveat in the docs above. } }   ////////////////// // CONFIG TABLE // //////////////////   /** * Retrieves _all_ configuration from the database. * @return {object} A nested dictionary arranged by type, i.e. * * ```js * { * service: { // type * facebook: { // id * ...data // value (de-JSONified if from non-document DB) * } * } * } * ``` */ async fetchConfig() { await this._ready();   const results = await this.config.run(); const out = {};   results.forEach(row => { Eif (!out[row.type]) out[row.type] = {};   out[row.type][row.id] = row; });   return out; }   /** * Creates or updates the key with the given value. * NoSQL databases can store the destructured value as part of the record. * Fixed-schema databases should JSON-encode the 'value' column. * * @param {string} type - e.g. "service" * @param {string} id - e.g. "facebook" * @param {object} value - e.g. { id: 1, ...profile } */ async setConfigKey(type, id, value) { await this._ready(); await this.config.insert({ type, id, ...value }); }   /////////// // USERS // ///////////   /** * Given a user record, save it to the database, and return its given id. * NoSQL databases should store the entire object, schema-based databases * should honor the 'emails' and 'services' keys and store as necessary * in another table. * * @param {object} user * * { * emails: [ { address: "me@me.com" } ], * services: [ { facebook: { id: 1, ...profile } } ] * ...anyOtherDataForUserRecordAtCreationTimeFromAppHooks * } * * @return {string} the id of the inserted user record */ async createUser(user) { await this._ready(); let id = user.id;   const result = await this.users.insert(user);   if (!id) id = result.generated_keys[0];   return id; }   /** * Fetches a user record by id. Schema-based databases should merge * appropriate user-data from e.g. `user_emails` and `user_services`. * * @param {string} id - the user record's id * * @return {object} user object in the same format expected by * {@link RethinkDBDashDriver#createUser}, or *null* if none found. */ async fetchUserById(userId) { await this._ready(); return this.users.get(userId).run(); }   /** * Given a single "email" param, returns the matching user record if one * exists, or null, otherwise. * * @param {string} email - the email address to search for, e.g. "me@me.com" * * @return {object} user object in the same format expected by * {@link RethinkDBDashDriver#createUser}, or *null* if none found. */ async fetchUserByEmail(email) { await this._ready();   const results = await this.users .filter(this.r.row('emails').contains(row => row('address').eq(email))) .limit(1) .run();   return results[0] || null; }   /** * Returns a user who has *either* a matching email address or matching * service record, or null, otherwise. * * @param {string} service - name of the service, e.g. "facebook" * @param {string} id - id of the service record, e.g. "152356242" * @param {string} email - the email address to search for, e.g. "me@me.com" * * @return {object} user object in the same format expected by * {@link RethinkDBDashDriver#createUser}, or *null* if none found */ async fetchUserByServiceIdOrEmail(service, id, email) { await this._ready();   const results = await this.users.filter( this.r.or( this.r.row('services')(service)('id').eq(id).default(false), this.r.row('emails').contains({ address: email }).default(false) ) ).limit(1).run();   return results[0] || null; }   /** * Given a userId, ensures the user record contains the given email * address, and updates it with optional data. * * @param {string} userId - the id of the user to assert * @param {string} email - the email address to ensure exists * @param {object} data - optional, e.g. { type: 'work', verified: true } */ async assertUserEmailData(userId, email, data) { await this._ready();   await this.users.get(userId).update(row => ({ emails: row('emails').default([]) .filter(row('emails').default([]).contains({ address: email }).not()) .append({ address: email, ...data }) })); }   /** * Given a userId, ensure the user record contains the given service * record, and updates it with the given data. * * @param {string} userId - the id of the user to assert * @param {string} service - the name of the service, e.g. "facebook" * @param {object} data - e.g. { id: "4321", displayName: "John Sheppard" } */ async assertUserServiceData(userId, service, data) { await this._ready(); await this.users.get(userId).update({ services: { [service]: data } }); }   // Not sure if we need this anymore, since fetch*() functions return // normalized data. But let's see. mapUserToServiceData(user, service) { return user && user.services && user.services[service]; } }   export default RethinkDBDashDriver;  </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="http://istanbul-js.org/" target="_blank">istanbul</a> at Sat Aug 20 2016 13:35:48 GMT+0300 (IDT) </div> </div> <script src="prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="sorter.js"></script> </body> </html>