$populate does not seem to work

Steps to reproduce

Create a linked relationship between two models

Expected behavior

When I query a basic endpoint I expect the $populate parameter to include my related model.

Actual behavior

The related model is not included in my results. The include never gets sent to sequelize and therefore the inner join is never made.

[daffl]

Yes, you can do that by setting params.sequelize in a hook:

app.service('sequelizeService').before({
  find(hook) {
    hook.params.sequelize = {
      include: hook.params.query.$populate
    }
  }
});

[sarkistlt]

@L3V147H4N it won’t work because ‘Role’ is string not a model, I’m using this hook:

function resolveModels(arr, models) {
  const include = [];

  arr.forEach((entity) => {
    if (typeof entity === 'string') {
      include.push(entity);
    } else if (typeof entity === 'object') {
      if (entity.model && typeof models[entity.model] === 'function') {
        entity.model = models[entity.model];
      }
      if (entity.include && Array.isArray(entity.include)) {
        entity.include = resolveModels(entity.include, models);
      }
      include.push(entity);
    }
  });

  return include;
}

export default function sequalizePopulateHook(ctx) {
  if (
    ctx.params.query &&
    ctx.params.query.$populate &&
    Array.isArray(ctx.params.query.$populate)
  ) {
    const { models } = ctx.app.get('sequelize');

    ctx.params.sequelize = ctx.params.sequelize || {};
    ctx.params.sequelize.include = resolveModels(ctx.params.query.$populate, models);
    ctx.params.sequelize.raw = false;

    delete ctx.params.query.$populate;
  }
  return ctx;
}

it will resolve model from string in:

$populate: [
  {
    model: 'Role', as: 'roles'
  }
]