offshore

<!doctype html> <html lang="en"> <head> <title>Code coverage report for lib/offshore/query/integrator/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> / <a href="index.html">lib/offshore/query/integrator/</a> index.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> 100% Statements 41/41 </div> <div class='fl pad1y space-right2'> 96.15% Branches 25/26 </div> <div class='fl pad1y space-right2'> 100% Functions 3/3 </div> <div class='fl pad1y space-right2'> 100% Lines 40/40 </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</td><td class="line-coverage quiet">      2× 2× 2× 2× 2×                                                     2×     236× 236× 236× 236× 236× 236× 236× 236× 236×       234× 234×         234×             234×     239×     239×       115× 115× 115× 115×                                                       115×                                                 124×       124× 124× 124× 124×       124×     55×                                               124×                                           124×   65× 77× 77× 77×                       234×      </td><td class="text"><pre class="prettyprint lang-js">/** * Module dependencies */ var validator = require('offshore-validator'); var _ = require('lodash'); var leftOuterJoin = require('./leftOuterJoin'); var innerJoin = require('./innerJoin'); var populate = require('./populate');     /** * Query Integrator * * Combines the results from multiple child queries into * the final return format using an in-memory join. * Final step in fulfilling a `.find()` with one or more * `populate(alias[n])` modifiers. * * > Why is this asynchronous? * > * > While this function isn't doing anything strictly * > asynchronous, it still expects a callback to enable * > future use of `process[setImmediate|nextTick]()` as * > an optimization. * * @param {Object} cache * @param {Array} joinInstructions - see JOIN_INSTRUCTIONS.md * @callback {Function} cb(err, results) * @param {Error} * @param {Array} [results, complete w/ populations] * * @throws {Error} on invalid input * @asynchronous */ module.exports = function integrate(cache, joinInstructions, primaryKey, cb) {   // Ensure valid usage var invalid = false; invalid = invalid || validator(cache).to({ type: 'object' }); invalid = invalid || validator(joinInstructions).to({ type: 'array' }); invalid = invalid || validator(joinInstructions[0]).to({ type: 'object' }); invalid = invalid || validator(joinInstructions[0].parent).to({ type: 'string' }); invalid = invalid || validator(cache[joinInstructions[0].parent]).to({ type: 'object' }); invalid = invalid || typeof primaryKey !== 'string'; invalid = invalid || typeof cb !== 'function'; if (invalid) return cb(invalid);     // Constant: String prepended to child attribute keys for use in namespacing. var CHILD_ATTR_PREFIX = '.'; var GRANDCHILD_ATTR_PREFIX = '..';     // We'll reuse the cached data from the `parent` table modifying it in-place // and returning it as our result set. (`results`) var results = cache[ joinInstructions[0].parent ];   // Group the joinInstructions array by alias, then interate over each one // s.t. `instructions` in our lambda function contains a list of join instructions // for the particular `populate` on the specified key (i.e. alias). // // Below, `results` are mutated inline. _.each(_.groupBy(joinInstructions, 'alias'), function eachAssociation(instructions, alias) {   var parentPK, fkToParent, fkToChild, childPK;   // N..N Association if (instructions.length === 2) {   // Name keys explicitly // (makes it easier to see what's going on) parentPK = instructions[0].parentKey; fkToParent = instructions[0].childKey; fkToChild = instructions[1].parentKey; childPK = instructions[1].childKey;   // console.log('\n\n------------:: n..m leftOuterJoin ::--------\n', // leftOuterJoin({ // left: cache[instructions[0].parent], // right: cache[instructions[0].child], // leftKey: parentPK, // rightKey: fkToParent // }) // ); // console.log('------------:: / ::--------\n');   // console.log('\n\n------------:: n..m childRows ::--------\n',innerJoin({ // left: leftOuterJoin({ // left: cache[instructions[0].parent], // right: cache[instructions[0].child], // leftKey: parentPK, // rightKey: fkToParent // }), // right: cache[instructions[1].child], // leftKey: CHILD_ATTR_PREFIX+fkToChild, // rightKey: childPK, // childNamespace: GRANDCHILD_ATTR_PREFIX // })); // console.log('------------:: / ::--------\n');   // Calculate and sanitize join data, // then shove it into the parent results under `alias` populate({ parentRows: results, alias: alias,   childRows: innerJoin({ left: leftOuterJoin({ left: cache[instructions[0].parent], right: cache[instructions[0].child], leftKey: parentPK, rightKey: fkToParent }), right: cache[instructions[1].child], leftKey: CHILD_ATTR_PREFIX + fkToChild, rightKey: childPK, childNamespace: GRANDCHILD_ATTR_PREFIX }),   parentPK: parentPK, // e.g. `id` (of message) fkToChild: CHILD_ATTR_PREFIX + fkToChild, // e.g. `user_id` (of join table) childPK: GRANDCHILD_ATTR_PREFIX + childPK, // e.g. `id` (of user)   childNamespace: GRANDCHILD_ATTR_PREFIX });   // 1 ..N Association } else Eif (instructions.length === 1) {   // Name keys explicitly // (makes it easier to see what's going on) parentPK = primaryKey; fkToParent = parentPK; fkToChild = instructions[0].parentKey; childPK = instructions[0].childKey;   // Determine if this is a "hasOne" or a "belongsToMany" // if the parent's primary key is the same as the fkToChild, it must be belongsToMany if (parentPK === fkToChild) { // In belongsToMany case, fkToChild needs prefix because it's actually the // console.log('belongsToMany'); fkToChild = CHILD_ATTR_PREFIX + fkToChild; // "hasOne" case } else { // console.log('hasOne'); }   // var childRows = innerJoin({ // left: cache[instructions[0].parent], // right: cache[instructions[0].child], // leftKey: instructions[0].parentKey, // rightKey: instructions[0].childKey // });   // console.log('1..N JOIN--------------\n',instructions,'\n^^^^^^^^^^^^^^^^^^^^^^'); // console.log('1..N KEYS--------------\n',{ // parentPK: parentPK, // fkToParent: fkToParent, // fkToChild: fkToChild, // childPK: childPK, // },'\n^^^^^^^^^^^^^^^^^^^^^^'); // console.log('1..N CHILD ROWS--------\n',childRows);   // Calculate and sanitize join data, // then shove it into the parent results under `alias` populate({ parentRows: results, alias: alias,   childRows: innerJoin({ left: cache[instructions[0].parent], right: cache[instructions[0].child], leftKey: instructions[0].parentKey, rightKey: instructions[0].childKey }),   parentPK: fkToParent, // e.g. `id` (of message) fkToChild: fkToChild, // e.g. `from` childPK: childPK, // e.g. `id` (of user)   childNamespace: CHILD_ATTR_PREFIX });   // If the alias isn't the same as the parent_key AND removeParentKey is set to true // in the instructions this means that we are turning a FK into an embedded record and a // columnName was used. We need to move the values attached to the alias property to // the parent key value. If we don't then when we run the transformer everything would get crazy. if (alias !== instructions[0].parentKey && instructions[0].removeParentKey === true) {   results = _.map(results, function(result) { result[instructions[0].parentKey] = result[alias]; delete result[alias]; return result; });   } }   } );     // And call the callback // (the final joined data is in the cache -- also referenced by `results`) return cb(null, results);   };  </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 Tue Apr 17 2018 10:49:40 GMT+0200 (CEST) </div> </div> <script src="../../../../prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="../../../../sorter.js"></script> </body> </html>