Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Can't select object properties to serialize

See original GitHub issue

I have data in my Mongo DB that looks like this:

[
  {
    role: 'admin',
    local: {
      password: '___password_hash___',
      email: 'admin@example.com'
    }
  },
  {
    role: 'standard',
    local: {
      password: '___password_hash___',
      email: 'standard@example.com'
    }
  }
]

I want to write a serializer that excludes the password property (for obvious reasons), so that each user object would look like this:

{
  role: 'admin',
  local: {
    email: 'admin@example.com'
  }
}

I’ve tried this as a serializer:

const JSONAPISerializer = require('jsonapi-serializer').Serializer;

module.exports = new JSONAPISerializer('user', {
  attributes: ['role', 'local'],
  local: {
    attributes: ['email']
  },
  pluralizeType: false,
  keyForAttribute: 'camelCase'
});

My understanding is that the attributes: ['email'] line specifies the list of attributes in the local object that should be returned – and that no other attributes will be returned.

However, even using that serializer, I still get this returned:

{
  "data": [
    {
      "type": "user",
      "id": "587e6c7a62af4891d801b0c8",
      "attributes": {
        "role": "admin",
        "local": {
          "email": "admin@example.com",
          "password": "___password_hash___"
        }
      }
    },
    {
      ...
    }
]

Help! What should I be doing? I must be missing something small.