offshore

<!doctype html> <html lang="en"> <head> <title>Code coverage report for lib/offshore/query/finders/operations.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/finders/</a> operations.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> 93.21% Statements 247/265 </div> <div class='fl pad1y space-right2'> 78.3% Branches 83/106 </div> <div class='fl pad1y space-right2'> 100% Functions 36/36 </div> <div class='fl pad1y space-right2'> 95.95% Lines 237/247 </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 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748</td><td class="line-coverage quiet">          2× 2× 2× 2× 2×                 2×     1266×     1266×     1266×     1266×   1266×     1266×     1266×     1266×   1266×                                       2×   1266×     1266×     1266×   1266×     1255×     1255×     841× 841× 841×                                           2× 1266×     1266× 41465×                     2× 1266×     1266×     741×     741×   741×             741×         525×             525×   525×                   2×   525× 525×     525×     525×     525×     525×         751×                 751×   751×   783× 783×   783×               783× 525× 525×       258× 258× 260× 249× 249×     258× 11×     751×     525×                     2×   525× 525×           525×   521× 521×     521×     521× 778× 280×       521× 295×               295×   295×         230× 230× 230× 230×   230×             230×                     2×   525× 525×     525×                 525× 783× 783× 783×   1× 1813× 1813× 1813× 1813×               783×     247× 247×       247×     247× 247×     247× 247× 247×     247× 247× 247×       247×       536× 536×   536× 536× 536×       525×                                 2×     1624×         1624×     1624×                             2×   841×       841× 841×     841× 232×                                         2×   841× 841×     841×   233× 233× 233×       233×   334× 333× 333×         233×     232× 232×   232×     232× 121× 121× 121×     121× 121×         121×             121× 121×                 121×       232×     232× 232× 232× 232× 232×     232× 13×   28× 28×     28× 28×       28×                         219×                     232× 121× 121×     111×               111×   111×   841×                             2×   232× 232× 232×   232×       232× 358× 358×       358× 118×       358× 358×     358× 358×   358× 358×                                   2× 358×           358× 247× 247× 247×           111×     111×     111× 347×     111× 111×     111× 111×     111× 111×       111× 111× 1× 1×   1×           111× 111× 111× 111× 111×   111× 111× 111×   111×     111×     111× 111×   111× 111×     111× 331× 1061×         111× 111×   111×                       2× 469×   469× 1917× 1917× 469× 469×       469×    </td><td class="text"><pre class="prettyprint lang-js">  /** * Module Dependencies */   var _ = require('lodash'); var async = require('async'); var utils = require('../../utils/helpers'); var normalize = require('../../utils/normalize'); var hasOwnProperty = utils.object.hasOwnProperty;   /** * Builds up a set of operations to perform based on search criteria. * * This allows the ability to do cross-adapter joins as well as fake joins * on adapters that haven't implemented the join interface yet. */   var Operations = module.exports = function(context, criteria, parent, metaContainer) {   // Build up a cache this.cache = {};   // Set context this.context = context;   // Set criteria this.criteria = criteria;   // Set parent this.parent = parent;   this.metaContainer = metaContainer;   // Hold a default value for pre-combined results (native joins) this.preCombined = false;   // Seed the Cache this._seedCache();   // Build Up Operations this.operations = this._buildOperations();   return this; };     /* *********************************************************************************** * PUBLIC METHODS ***********************************************************************************/     /** * Run Operations * * Execute a set of generated operations returning an array of results that can * joined in-memory to build out a valid results set. * * @param {Function} cb * @api public */   Operations.prototype.run = function run(cb) {   var self = this;   // Grab the parent operation, it will always be the very first operation var parentOp = this.operations.shift();   // Run The Parent Operation this._runOperation(parentOp.collection, parentOp.method, parentOp.criteria, function(err, results) {   if (err) return cb(err);   // Set the cache values self.cache[parentOp.collection] = results;   // If results are empty, or we're already combined, nothing else to so do return if (!results || self.preCombined) return cb(null, { combined: true, cache: self.cache });   // Run child operations and populate the cache self._execChildOpts(results, function(err) { Iif (err) return cb(err); cb(null, { combined: self.preCombined, cache: self.cache }); });   });   };     /* *********************************************************************************** * PRIVATE METHODS ***********************************************************************************/     /** * Seed Cache with empty values. * * For each Offshore Collection set an empty array of values into the cache. * * @api private */   Operations.prototype._seedCache = function _seedCache() { var self = this;   // Fill the cache with empty values for each collection Object.keys(this.context.offshore.schema).forEach(function(key) { self.cache[key] = []; }); };   /** * Build up the operations needed to perform the query based on criteria. * * @return {Array} * @api private */   Operations.prototype._buildOperations = function _buildOperations() { var operations = [];   // Check if joins were used, if not only a single operation is needed on a single connection if (!hasOwnProperty(this.criteria, 'joins')) {   // Grab the collection var collection = this.context.offshore.collections[this.context.identity]._loadQuery(this.context._query);   // Find the name of the connection to run the query on using the dictionary var connectionName = collection.connection;   operations.push({ connection: connectionName, collection: this.context.identity, method: this.parent, criteria: this.criteria });   return operations; }   // Joins were used in this operation. Lets grab the connections needed for these queries. It may // only be a single connection in a simple case or it could be multiple connections in some cases. var connections = this._getConnections();   // Now that all the connections are created, build up operations needed to accomplish the end // goal of getting all the results no matter which connection they are on. To do this, // figure out if a connection supports joins and if so pass down a criteria object containing // join instructions. If joins are not supported by a connection, build a series of operations // to achieve the end result. operations = this._stageOperations(connections);   return operations; };   /** * Stage Operation Sets * * @param {Object} connections * @api private */   Operations.prototype._stageOperations = function _stageOperations(connections) {   var self = this; var operations = [];   // Build the parent operation and set it as the first operation in the array operations = operations.concat(this._createParentOperation(connections));   // Parent Connection Name var parentConnection = this.context.connection;   // Parent Operation var parentOperation = operations[0];   // For each additional connection build operations Object.keys(connections).forEach(function(connection) {   // Ignore the connection used for the parent operation if a join can be used on it. // This means all of the operations for the query can take place on a single connection // using a single query. Iif (connection === parentConnection && parentOperation.method === 'join') return;   // Operations are needed that will be run after the parent operation has been completed. // If there are more than a single join, set the parent join and build up children operations. // This occurs in a many-to-many relationship when a join table is needed.   // Criteria is omitted until after the parent operation has been run so that an IN query can // be formed on child operations.   var localOpts = [];   connections[connection].joins.forEach(function(join, idx) {   var optCollection = self.context.offshore.collections[join.child]._loadQuery(self.context._query); var optConnectionName = optCollection.connection;   var operation = { connection: optConnectionName, collection: join.child, method: 'find', join: join };   // If this is the first join, it can't have any parents if (idx === 0) { localOpts.push(operation); return; }   // Look into the previous operations and see if this is a child of any of them var child = false; localOpts.forEach(function(localOpt) { if (localOpt.join.child !== join.parent) return; localOpt.child = operation; child = true; });   if (child) return; localOpts.push(operation); });   operations = operations.concat(localOpts); });   return operations; };   /** * Create The Parent Operation * * @param {Object} connections * @return {Object} * @api private */   Operations.prototype._createParentOperation = function _createParentOperation(connections) {   var nativeJoin = this.context.adapter.hasJoin(); var operation, connectionName, connection;   // If the parent supports native joins, check if all the joins on the connection can be // run on the same connection and if so just send the entire criteria down to the connection. if (nativeJoin) {   connectionName = this.context.connection; connection = connections[connectionName];   // Hold any joins that can't be r