Question: Apply Scopes to Eager Loaded Modules

[dexwiz]

I am trying to write a scope that returns select number of fields for serialization.

module.exports = function(sequelize, DataTypes) {
  var User= sequelize.define('User', {
    field1: {
      type: DataTypes.JSON,
      allowNull: false,
      defaultValue: {}
    },
    field2: {
      type: DataTypes.JSON,
      allowNull: false,
      defaultValue: {}
    }
  }, 
  {
    scopes: {
      json: {
        attributes: ['field1', 'field2' ]
      }
    },
    classMethods: {
      associate: function(models) {
        User.hasMany(models.Role);
      }
    },
  });

  return User;
};

This works in combination with user.get({ plain: true}) to produce a valid serialized object for exposing via an API. However, I cannot seem to find a way to to apply scopes to eagerly loaded models.

Tried

User.scope(['json']).findById(user.id, {
      include: [{
        model: Role,
        scope: 'json'
      }]
    })

Does not apply any scope

And specific scopes

User.scope(['userJson', 'roleJson']).findById(user.id, {
      include: [{
        model: Role,
        scope: 'json'
      }]
    })

Throws an error.

Is there is a there no way to apply scopes to eagerly loaded objects?

[dexwiz]

I was able to apply scopes, but it appears to only work for where clauses. Attribute filters do not seem to work.

User.scope(['json']).findById(user.id, {
      include: [{
        model: Role.scope('json')
      }]
    })

[mickhansen]

That might actually not be supported. A solution could be to build in support for include.scope which then applies options and scopes the model.

/cc @janmeier

[dexwiz]

Its in the unit tests, but only seems to apply to some scope types

sequelize/test/integration/model/scope/associations.test.js

Line 146 in 538a095

include: [{ model: this.ScopeMe.scope('isTony'), as: 'users'}]

[janmeier]

Role.scope is the supported way for wheres, but yeah it might not support attributes

[mickhansen]

sequelize/lib/model.js

Line 590 in 538a095

Model.$injectScope(model.$scope, include);

we do call injectScope for include.

sequelize/lib/model.js

Line 2408 in 538a095

Model.$injectScope = function (scope, options) {

Doesn't look like $injectScope supports attributes at all actually @janmeier?

[mickhansen]

Or actually it should copy attributes here:

sequelize/lib/model.js

Line 2411 in 538a095

_.defaults(options, filteredScope);