feat(postgres): change returning option to only return model attributes (#11526)

lib/dialects/mssql/query-generator.js

@@ -316,7 +316,9 @@ class MSSQLQueryGenerator extends AbstractQueryGenerator {
       outputFragment = '';
       outputFragment = '';
 
 
     if (options.returning) {
     if (options.returning) {
-      outputFragment = ' OUTPUT INSERTED.*';
+      const returnValues = this.generateReturnValues(attributes, options);
+
+      outputFragment = returnValues.outputFragment;
     }
     }
 
 
     const emptyQuery = `INSERT INTO ${quotedTable}${outputFragment} DEFAULT VALUES`;
     const emptyQuery = `INSERT INTO ${quotedTable}${outputFragment} DEFAULT VALUES`;

lib/dialects/postgres/query-generator.js

@@ -343,7 +343,7 @@ class PostgresQueryGenerator extends AbstractQueryGenerator {
   upsertQuery(tableName, insertValues, updateValues, where, model, options) {
   upsertQuery(tableName, insertValues, updateValues, where, model, options) {
     const primaryField = this.quoteIdentifier(model.primaryKeyField);
     const primaryField = this.quoteIdentifier(model.primaryKeyField);
 
 
-    const upsertOptions = _.defaults({ bindParam: false }, options);
+    const upsertOptions = _.defaults({ bindParam: false, returning: ['*'] }, options);
     const insert = this.insertQuery(tableName, insertValues, model.rawAttributes, upsertOptions);
     const insert = this.insertQuery(tableName, insertValues, model.rawAttributes, upsertOptions);
     const update = this.updateQuery(tableName, updateValues, where, upsertOptions, model.rawAttributes);
     const update = this.updateQuery(tableName, updateValues, where, upsertOptions, model.rawAttributes);
 
 

test/integration/model.test.js

@@ -929,14 +929,16 @@ describe(Support.getTestDialectTeaser('Model'), () => {
       return User.sync({ force: true }).then(() => {
       return User.sync({ force: true }).then(() => {
         return User.create({ username: 'Peter', secretValue: '42' }).then(user => {
         return User.create({ username: 'Peter', secretValue: '42' }).then(user => {
           return user.update({ secretValue: '43' }, {
           return user.update({ secretValue: '43' }, {
-            fields: ['secretValue'], logging(sql) {
+            fields: ['secretValue'],
+            logging(sql) {
               test = true;
               test = true;
               if (dialect === 'mssql') {
               if (dialect === 'mssql') {
                 expect(sql).to.not.contain('createdAt');
                 expect(sql).to.not.contain('createdAt');
               } else {
               } else {
                 expect(sql).to.match(/UPDATE\s+[`"]+User1s[`"]+\s+SET\s+[`"]+secretValue[`"]=(\$1|\?),[`"]+updatedAt[`"]+=(\$2|\?)\s+WHERE [`"]+id[`"]+\s=\s(\$3|\?)/);
                 expect(sql).to.match(/UPDATE\s+[`"]+User1s[`"]+\s+SET\s+[`"]+secretValue[`"]=(\$1|\?),[`"]+updatedAt[`"]+=(\$2|\?)\s+WHERE [`"]+id[`"]+\s=\s(\$3|\?)/);
               }
               }
-            }
+            },
+            returning: ['*']
           });
           });
         });
         });
       }).then(() => {
       }).then(() => {

test/integration/model/bulk-create.test.js

@@ -628,6 +628,56 @@ describe(Support.getTestDialectTeaser('Model'), () => {
               });
               });
             });
             });
         });
         });
+
+        it('should only return fields that are not defined in the model (with returning: true)', function() {
+          const User = this.sequelize.define('user');
+
+          return User
+            .sync({ force: true })
+            .then(() => this.sequelize.queryInterface.addColumn('users', 'not_on_model', Sequelize.STRING))
+            .then(() => User.bulkCreate([
+              {},
+              {},
+              {}
+            ], {
+              returning: true
+            }))
+            .then(users =>
+              User.findAll()
+                .then(actualUsers => [users, actualUsers])
+            )
+            .then(([users, actualUsers]) => {
+              expect(users.length).to.eql(actualUsers.length);
+              users.forEach(user => {
+                expect(user.get()).not.to.have.property('not_on_model');
+              });
+            });
+        });
+
+        it('should return fields that are not defined in the model (with returning: ["*"])', function() {
+          const User = this.sequelize.define('user');
+
+          return User
+            .sync({ force: true })
+            .then(() => this.sequelize.queryInterface.addColumn('users', 'not_on_model', Sequelize.STRING))
+            .then(() => User.bulkCreate([
+              {},
+              {},
+              {}
+            ], {
+              returning: ['*']
+            }))
+            .then(users =>
+              User.findAll()
+                .then(actualUsers => [users, actualUsers])
+            )
+            .then(([users, actualUsers]) => {
+              expect(users.length).to.eql(actualUsers.length);
+              users.forEach(user => {
+                expect(user.get()).to.have.property('not_on_model');
+              });
+            });
+        });
       });
       });
     }
     }
 
 

test/integration/model/create.test.js

@@ -393,6 +393,18 @@ describe(Support.getTestDialectTeaser('Model'), () => {
       });
       });
     });
     });
 
 
+    it('should ignore option returning', function() {
+      return this.User.findOrCreate({
+        where: { username: 'Username' },
+        defaults: { data: 'ThisIsData' },
+        returning: false
+      }).then(([user, created]) => {
+        expect(user.username).to.equal('Username');
+        expect(user.data).to.equal('ThisIsData');
+        expect(created).to.be.true;
+      });
+    });
+
     if (current.dialect.supports.transactions) {
     if (current.dialect.supports.transactions) {
       it('should release transaction when meeting errors', function() {
       it('should release transaction when meeting errors', function() {
         const test = times => {
         const test = times => {

test/unit/sql/insert.test.js

@@ -28,8 +28,8 @@ describe(Support.getTestDialectTeaser('SQL'), () => {
       expectsql(sql.insertQuery(User.tableName, { user_name: 'triggertest' }, User.rawAttributes, options),
       expectsql(sql.insertQuery(User.tableName, { user_name: 'triggertest' }, User.rawAttributes, options),
         {
         {
           query: {
           query: {
-            mssql: 'declare @tmp table ([id] INTEGER,[user_name] NVARCHAR(255));INSERT INTO [users] ([user_name]) OUTPUT INSERTED.[id],INSERTED.[user_name] into @tmp VALUES ($1);select * from @tmp;',
-            postgres: 'INSERT INTO "users" ("user_name") VALUES ($1) RETURNING *;',
+            mssql: 'DECLARE @tmp TABLE ([id] INTEGER,[user_name] NVARCHAR(255)); INSERT INTO [users] ([user_name]) OUTPUT INSERTED.[id],INSERTED.[user_name] INTO @tmp VALUES ($1); SELECT * FROM @tmp;',
+            postgres: 'INSERT INTO "users" ("user_name") VALUES ($1) RETURNING "id","user_name";',
             default: 'INSERT INTO `users` (`user_name`) VALUES ($1);'
             default: 'INSERT INTO `users` (`user_name`) VALUES ($1);'
           },
           },
           bind: ['triggertest']
           bind: ['triggertest']

test/unit/sql/update.test.js

@@ -28,8 +28,8 @@ describe(Support.getTestDialectTeaser('SQL'), () => {
       expectsql(sql.updateQuery(User.tableName, { user_name: 'triggertest' }, { id: 2 }, options, User.rawAttributes),
       expectsql(sql.updateQuery(User.tableName, { user_name: 'triggertest' }, { id: 2 }, options, User.rawAttributes),
         {
         {
           query: {
           query: {
-            mssql: 'declare @tmp table ([id] INTEGER,[user_name] NVARCHAR(255)); UPDATE [users] SET [user_name]=$1 OUTPUT INSERTED.[id],INSERTED.[user_name] into @tmp WHERE [id] = $2;select * from @tmp',
-            postgres: 'UPDATE "users" SET "user_name"=$1 WHERE "id" = $2 RETURNING *',
+            mssql: 'DECLARE @tmp TABLE ([id] INTEGER,[user_name] NVARCHAR(255)); UPDATE [users] SET [user_name]=$1 OUTPUT INSERTED.[id],INSERTED.[user_name] INTO @tmp WHERE [id] = $2; SELECT * FROM @tmp',
+            postgres: 'UPDATE "users" SET "user_name"=$1 WHERE "id" = $2 RETURNING "id","user_name"',
             default: 'UPDATE `users` SET `user_name`=$1 WHERE `id` = $2'
             default: 'UPDATE `users` SET `user_name`=$1 WHERE `id` = $2'
           },
           },
           bind: {
           bind: {