Sort by smart field that includes value from a belongsTo relationship

Please be sure of your agent type and version and pick the right documentation accordingly.

Node.js

This is the documentation of the forest-express-sequelize and forest-express-mongoose Node.js agents that will soon reach end-of-support.

forest-express-sequelize v9 and forest-express-mongoose v9 are replaced by @forestadmin/agent v1.

Please check your agent type and version and read on or switch to the right documentation.

Ruby on Rails

This is still the latest Ruby on Rails documentation of the forest_liana agent, you’re at the right place, please read on.

Python

This is the documentation of the django-forestadmin Django agent that will soon reach end-of-support.

If you’re using a Django agent, notice that django-forestadmin v1 is replaced by forestadmin-agent-django v1.

If you’re using a Flask agent, go to the forestadmin-agent-flask v1 documentation.

Please check your agent type and version and read on or switch to the right documentation.

PHP

This is the documentation of the forestadmin/laravel-forestadmin Laravel agent that will soon reach end-of-support.

If you’re using a Laravel agent, notice that forestadmin/laravel-forestadmin v1 is replaced by forestadmin/laravel-forestadmin v3.

If you’re using a Symfony agent, go to the forestadmin/symfony-forestadmin v1 documentation.

Please check your agent type and version and read on or switch to the right documentation.

Sort by smart field that includes value from a belongsTo relationship

Context: As a user I want to be able to sort records based on a smart field where the smart field includes data from the current record's parent.

Example: Here I have a model orders that has a belongsTo relationship with the customers model.

I have a smart field in the orders model called customer email that returns the value of the parent customer's email field. I want to sort the orders by the customer email smart field.

Implementation

forest/orders.js

const { collection } = require('forest-express-sequelize');
const models = require('../models');

collection('orders', {
  actions: [],
  fields: [
    {
      field: 'customer email',
      get: (order) =>
        models.customers
          .findByPk(order.customer.dataValues.id)
          .then((customer) => customer.email),
      isSortable: true,
    },
  ],
  segments: [],
});

routes/orders.js

router.get(
  '/orders',
  permissionMiddlewareCreator.list(),
  (request, response, next) => {
    if (request.query.sort.includes('customer email')) {
      request.query.sort = request.query.sort.includes('-')
        ? '-customer.email'
        : 'customer.email';
    }
    next();
  }
);