Override visibility options of nested relations #2038

romanmatolych · 2019-12-06T09:57:29Z

Issue Description

Let's say that I have 2 Bookshelf models: Profiles and Users. Here are the simplified versions of them:

Bookshelf.model('User', Bookshelf.Model.extend({
  tableName: 'users',
  hidden: ['password', 'salt'],
  hasTimestamps: true,
  ...
  profile: function () {
    return this.hasOne('Profile', 'id', 'id');
  },
  ...
}));

Bookshelf.model('Profile', Bookshelf.Model.extend({
  tableName: 'profiles',
  hidden: ['name', 'email'],
  hasTimestamps: true,
  ...
  user() {
    return this.belongsTo('User', 'id', 'id');
  },
  ...
}));

What I am trying to do in some controller is:

return new User()
  .fetchPage({
    pageSize: PageLimit,
    page: PageNumber,
    withRelated: ['profile']
  })
  .then(result => {
    return res.status(200).send({
      data: result.toJSON({
        hidden: ['name'],
      }),
      pagination: result.pagination
    }));
  })
  .catch(next);

So I want to return a list of users with their profiles, but I also want to show the email values, for instance. That's why I override the hidden list in the toJSON call. After that, all other properties show up in the result, including hidden ones from the Users model that I still want to hide. My email column, that I have to write even without dot notation (i.e., "table.column") btw., is not there, though.

I was able to trace how this argument is passed down with:

serialize(...args) {
    console.log(args);
    return Bookshelf.Model.prototype.serialize.apply(this, args);
},

And it's just the array ['name'], that I gave to the toJSON call for all nested models.

I thought, that I could gather all hidden members, then exclude the needed columns and utilize this new list. So I came up with this function:

function getAllFieldsToHide(model, hidden = []) {
  if (model instanceof Bookshelf.Collection && model.length > 0) {
    return getAllFieldsToHide(model.at(0), hidden);
  } else if (model instanceof Bookshelf.Model) {
    hidden = hidden.concat(model.hidden === null ? [] : model.hidden);
    Object.values(model.relations).forEach(relation => {
      hidden = getAllFieldsToHide(relation, hidden);
    });
    return hidden;
  } else {
    return hidden;
  }
}

And then I do:

const hiddenFieldsToInclude = ['email'];
const newHiddenList = getAllFieldsToHide(result)
  // exclude column names that we need to show
  .filter(field => hiddenFieldsToInclude.indexOf(field) === -1);

It retrieves an array of attributes to remove from the output for the given Bookshelf model and its nested relations. But, name conflict may occur here, if models have columns with the same names. The function works, but maybe there is some more sophisticated way to achieve this? Or it can be an issue request.

Thanks!

Oct	NOV	Dec
	21
2019	2020	2021

bookshelf / bookshelf

Override visibility options of nested relations #2038

Override visibility options of nested relations #2038

romanmatolych commented Dec 6, 2019

bookshelf / bookshelf

Join GitHub today

GitHub is where the world builds software

Override visibility options of nested relations #2038

Override visibility options of nested relations #2038

Comments

romanmatolych commented Dec 6, 2019

Issue Description

Essential cookies

Always active

Analytics cookies