.toJSON not including getterMethods

Recently upgraded to v5 from v4. Version 5.8.6

User model with fullName getterMethod

module.exports = (sequelize, DataTypes) => {
  const User = sequelize.define('User', {
    firstName: {
      type: DataTypes.STRING,
      allowNull: false
    },
    lastName: {
      type: DataTypes.STRING,
      allowNull: false
    },
    email: {
      type: DataTypes.STRING,
      allowNull: false,
      unique: true
    },
    password: {
      type: DataTypes.STRING,
      allowNull: false
    }
  }, {
    getterMethods: {
      // TODO: Not working in latest sequelize
      fullName () {
        const fullName = `${this.firstName} ${this.lastName}`

        return fullName
      }
    },
    paranoid: true
  })

  User.associate = (models) => {
    User.belongsToMany(models.Project, {
      through: models.UserProject,
      foreignKey: 'userId'
    })
    User.belongsTo(models.Company, {
      foreignKey: 'companyId',
      onDelete: 'CASCADE'
    })
  }

  return User
}

Controller endpoint:

  async show (req, res) {
    try {
      const result = await User.findByPk(req.params.id, {
        include: [{
          through: {
            attributes: ['default']
          },
          model: Project
        }]
      })

      res.status(200).send(result)
    } catch (error) {
      sendTeamsError(error)
      res.status(400).send(error)
    }
  },

Bug:

result has fullName property but result.toJSON() does not include fullName

[gabegorelick]

It would be nice if this was documented in https://github.com/sequelize/sequelize/blob/master/docs/upgrade-to-v5.md, especially if a fix may take a while.

[mjy78]

I’ve noticed if you add a VIRTUAL field fullName with no get function defined, then the getterMethod appears to work…

const User = sequelize.define('User', {
  firstName: {
    type: DataTypes.STRING,
    allowNull: false
  },
  lastName: {
    type: DataTypes.STRING,
    allowNull: false
  },
  fullName: {
    type: DataTypes.VIRTUAL
  }    
  }, {
  getterMethods: {
    fullName () {
      return `${this.firstName} ${this.lastName}`;
    }
  }
})

Not sure if this is good/recommended practice?