Make create to return with scope

I have this model

module.exports = (sequelize, DataTypes) => {
  const Partner = sequelize.define('Partner', {
    id: {
      type: DataTypes.INTEGER,
      primaryKey: true,
      autoIncrement: true
    },
    name: {
      type: DataTypes.STRING,
      allowNull: false
    }
  }, {
    tableName: 'partners',
    paranoid: true,
    underscored: true,
    freezeTableName: false,
    scopes: {
      clean: {
        attributes: { exclude: [
          'createdAt',
          'updatedAt',
          'deletedAt'
        ] }
      }
    }
  })

  return Partner
}

When doing a Partner.scope('clean').find(), the query runs

SELECT "id", "name", "logo_id" AS "logoId" FROM "partners" AS "Partner" [...]

Whereas doing a Partner.scope('clean').create() runs

INSERT INTO "partners" ("id","name","created_at","updated_at") VALUES (DEFAULT,$1,$2,$3) RETURNING *

So it doesn’t respect the scope.

I think it would be very more consistent (and actually, relatively easy) to tweak the RETURNING * part automatically to respect scopes ?

Furthermore, I can’t even do this manually, becasecreate() returning option is only boolean (whereas bulkCreate can take an array of columns)

[cyrilchapon]

Hey @papb

You mean Partner.scope(‘clean’).create({ returning: true }), right?

Yes about the original issue; but actually yes and no. Yes for the insert / returning of Postgres. But I’m thinking more broadly about UPDATE / .reload() now. What do you think ?

One should produce failing tests maybe.

Thanks for the report!! I agree with you that the current behavior is a potential leak, and your suggested behavior is better 😃

Hum… I didn’t find anything in the docs mentionning any of this… (I had to actually test it)

So… It’s a “breaking” change in the mean it should break stuff; but SEMVER-speaking, no…

Ninja commiting it would break stuff for sure, and I think it can be added as a breaking change.

[github-actions[bot]]

This issue has been automatically marked as stale because it has been open for 7 days without activity. It will be closed if no further activity occurs. If this is still an issue, just leave a comment or remove the “stale” label. 🙂