Merge pull request #4029 from pimterry/aggregate-with-include

Do not automatically add primary key to attributes (or include[].attributes) if raw is set

lib/model.js

@@ -437,7 +437,7 @@ var validateIncludedElements = function(options, tableNames) {
   // validate all included elements
   var includes = options.include;
   for (var index = 0; index < includes.length; index++) {
-    var include = includes[index] = validateIncludedElement.call(this, includes[index], tableNames);
+    var include = includes[index] = validateIncludedElement.call(this, includes[index], tableNames, options);
 
     include.parent = options;
     // associations that are required or have a required child and is not a ?:M association are candidates for the subquery
@@ -461,7 +461,7 @@ var validateIncludedElements = function(options, tableNames) {
 };
 Model.$validateIncludedElements = validateIncludedElements;
 
-validateIncludedElement = function(include, tableNames) {
+validateIncludedElement = function(include, tableNames, options) {
   if (!include.hasOwnProperty('model') && !include.hasOwnProperty('association')) {
     throw new Error('Include malformed. Expected attributes: model or association');
   }
@@ -476,17 +476,17 @@ validateIncludedElement = function(include, tableNames) {
 
   tableNames[include.model.getTableName()] = true;
 
-  if (include.attributes) {
+  if (include.attributes && !options.raw) {
     include.originalAttributes = include.attributes.slice(0);
 
     if (include.attributes.length) {
-      include.model.primaryKeyAttributes.forEach(function(attr) {
+      include.model.primaryKeyAttributes.forEach(function (attr) {
         if (include.attributes.indexOf(attr) === -1) {
           include.attributes.unshift(attr);
         }
       });
     }
-  } else {
+  } else if (!include.attributes) {
     include.attributes = Object.keys(include.model.tableAttributes);
   }
 
@@ -536,7 +536,7 @@ validateIncludedElement = function(include, tableNames) {
 
     // Validate child includes
     if (include.hasOwnProperty('include')) {
-      validateIncludedElements.call(include.model, include, tableNames);
+      validateIncludedElements.call(include.model, include, tableNames, options);
     }
 
     return include;
@@ -1186,7 +1186,8 @@ Model.prototype.findAll = function(options) {
 
         validateIncludedElements.call(this, options, tableNames);
 
-        if (options.attributes) {
+        // If we're not raw, we have to make sure we include the primary key for deduplication
+        if (options.attributes && !options.raw) {
           if (options.attributes.indexOf(this.primaryKeyAttribute) === -1) {
             options.originalAttributes = options.attributes;
             options.attributes = [this.primaryKeyAttribute].concat(options.attributes);

test/integration/include/findAll.test.js

@@ -1920,5 +1920,46 @@ describe(Support.getTestDialectTeaser('Include'), function() {
         expect(parseInt(post.get('commentCount'), 10)).to.equal(3);
       });
     });
+
+    it('should not add primary key when including and aggregating with raw: true', function () {
+      var Post = this.sequelize.define('Post', {
+          title: DataTypes.STRING
+        })
+        , Comment = this.sequelize.define('Comment', {
+          content: DataTypes.TEXT
+        });
+
+      Post.Comments = Post.hasMany(Comment, {as: 'comments'});
+
+      return this.sequelize.sync({force: true}).bind(this).then(function () {
+        return Post.create({
+          title: Math.random().toString(),
+          comments: [
+            {content: Math.random().toString()},
+            {content: Math.random().toString()},
+            {content: Math.random().toString()},
+          ]
+        }, {
+          include: [Post.Comments]
+        });
+      }).then(function () {
+        return Post.findAll({
+          attributes: [],
+          include: [
+            {
+              association: Post.Comments,
+              attributes: [[this.sequelize.fn('COUNT', this.sequelize.col('comments.id')), 'commentCount']]
+            }
+          ],
+          raw: true
+        });
+      }).then(function (posts) {
+        expect(posts.length).to.equal(1);
+
+        var post = posts[0];
+        expect(post.id).not.to.be.ok;
+        expect(parseInt(post["comments.commentCount"], 10)).to.equal(3);
+      });
+    });
   });
 });