feat(include): provide preliminary through.where support

changelog.md

@@ -2,6 +2,7 @@
 - [BUG] Fixed issue with paranoid deletes and `deletedAt` with a custom field.
 - [BUG] Fixed issue with paranoid deletes and `deletedAt` with a custom field.
 - [BUG] No longer crahes on `where: []`
 - [BUG] No longer crahes on `where: []`
 - [FEATURE] Validations are now enabled by default for upsert.
 - [FEATURE] Validations are now enabled by default for upsert.
+- [FEATURE] Preliminary support for `include.through.where`
 
 
 # 2.0.0-rc7
 # 2.0.0-rc7
 - [FEATURE] Throw an error if no where clause is given to `Model.destroy()`.
 - [FEATURE] Throw an error if no where clause is given to `Model.destroy()`.

lib/dialects/abstract/query-generator.js

@@ -974,7 +974,9 @@ module.exports = (function() {
 
 
               , sourceJoinOn
               , sourceJoinOn
               , targetJoinOn
               , targetJoinOn
-              , targetWhere;
+              , targetWhere
+
+              , throughWhere;
 
 
             if (options.includeIgnoreAttributes !== false) {
             if (options.includeIgnoreAttributes !== false) {
               // Through includes are always hasMany, so we need to add the attributes to the mainAttributes no matter what (Real join will never be executed in subquery)
               // Through includes are always hasMany, so we need to add the attributes to the mainAttributes no matter what (Real join will never be executed in subquery)
@@ -991,12 +993,21 @@ module.exports = (function() {
             targetJoinOn = self.quoteIdentifier(tableTarget) + '.' + self.quoteIdentifier(attrTarget) + ' = ';
             targetJoinOn = self.quoteIdentifier(tableTarget) + '.' + self.quoteIdentifier(attrTarget) + ' = ';
             targetJoinOn += self.quoteIdentifier(throughAs) + '.' + self.quoteIdentifier(identTarget);
             targetJoinOn += self.quoteIdentifier(throughAs) + '.' + self.quoteIdentifier(identTarget);
 
 
+            if (include.through.where) {
+              throughWhere = self.getWhereConditions(include.through.where, self.sequelize.literal(self.quoteIdentifier(throughAs)), include.through.model);
+            }
+
             if (self._dialect.supports.joinTableDependent) {
             if (self._dialect.supports.joinTableDependent) {
               // Generate a wrapped join so that the through table join can be dependent on the target join
               // Generate a wrapped join so that the through table join can be dependent on the target join
               joinQueryItem += joinType + '(';
               joinQueryItem += joinType + '(';
               joinQueryItem += self.quoteTable(throughTable, throughAs);
               joinQueryItem += self.quoteTable(throughTable, throughAs);
               joinQueryItem += joinType + self.quoteTable(table, as) + ' ON ';
               joinQueryItem += joinType + self.quoteTable(table, as) + ' ON ';
               joinQueryItem += targetJoinOn;
               joinQueryItem += targetJoinOn;
+
+              if (throughWhere) {
+                joinQueryItem += ' AND ' + throughWhere;
+              }
+
               joinQueryItem += ') ON '+sourceJoinOn;
               joinQueryItem += ') ON '+sourceJoinOn;
             } else {
             } else {
               // Generate join SQL for left side of through
               // Generate join SQL for left side of through
@@ -1006,11 +1017,18 @@ module.exports = (function() {
               // Generate join SQL for right side of through
               // Generate join SQL for right side of through
               joinQueryItem += joinType + self.quoteTable(table, as) + ' ON ';
               joinQueryItem += joinType + self.quoteTable(table, as) + ' ON ';
               joinQueryItem += targetJoinOn;
               joinQueryItem += targetJoinOn;
+
+              if (throughWhere) {
+                joinQueryItem += ' AND ' + throughWhere;
               }
               }
 
 
+            }
+
+            if (include.where || include.through.where) {
               if (include.where) {
               if (include.where) {
                 targetWhere = self.getWhereConditions(include.where, self.sequelize.literal(self.quoteIdentifier(as)), include.model, whereOptions);
                 targetWhere = self.getWhereConditions(include.where, self.sequelize.literal(self.quoteIdentifier(as)), include.model, whereOptions);
                 joinQueryItem += ' AND ' + targetWhere;
                 joinQueryItem += ' AND ' + targetWhere;
+              }
               if (subQuery && include.required) {
               if (subQuery && include.required) {
                 if (!options.where) options.where = {};
                 if (!options.where) options.where = {};
                 (function (include) {
                 (function (include) {
@@ -1050,12 +1068,13 @@ module.exports = (function() {
                         include: topInclude.include,
                         include: topInclude.include,
                         _pseudo: true
                         _pseudo: true
                       }],
                       }],
-                      where: {
-                        $join: self.sequelize.asIs([
+                      where: self.sequelize.and(
+                        self.sequelize.asIs([
                           self.quoteTable(topParent.model.name) + '.' + self.quoteIdentifier(topParent.model.primaryKeyAttributes[0]),
                           self.quoteTable(topParent.model.name) + '.' + self.quoteIdentifier(topParent.model.primaryKeyAttributes[0]),
                           self.quoteIdentifier(topInclude.through.model.name) + '.' + self.quoteIdentifier(topInclude.association.identifierField)
                           self.quoteIdentifier(topInclude.through.model.name) + '.' + self.quoteIdentifier(topInclude.association.identifierField)
-                        ].join(" = "))
-                      },
+                        ].join(" = ")),
+                        topInclude.through.where
+                      ),
                       limit: 1,
                       limit: 1,
                       includeIgnoreAttributes: false
                       includeIgnoreAttributes: false
                     }, topInclude.through.model);
                     }, topInclude.through.model);

test/include/findAll.test.js

@@ -1776,6 +1776,32 @@ describe(Support.getTestDialectTeaser('Include'), function() {
       });
       });
     });
     });
 
 
+    it('should be possible to select on columns inside a through table and a limit', function(done) {
+      var self = this;
+      this.fixtureA(function() {
+        self.models.Product.findAll({
+          attributes: ['title'],
+          include: [
+            {
+              model: self.models.Tag,
+              through: {
+                where: {
+                  ProductId: 3
+                }
+              },
+              required: true
+            }
+          ],
+          limit: 5
+        }).done(function(err, products) {
+          expect(err).not.to.be.ok;
+          expect(products).have.length(1);
+
+          done();
+        });
+      });
+    });
+
     // Test case by @eshell
     // Test case by @eshell
     it('should be possible not to include the main id in the attributes', function(done) {
     it('should be possible not to include the main id in the attributes', function(done) {
       var Member = this.sequelize.define('Member', {
       var Member = this.sequelize.define('Member', {