Upgrade to v5

The purpose of this note is to help developers to upgrade their agent from v4 to v5. Please read carefully and integrate the following breaking changes to ensure a smooth upgrade.​

Upgrading to v5

Before upgrading to v5, consider the below breaking changes.

As for any dependency upgrade, it’s very important to test this upgrade in your testing environments. Not doing so could result in your admin panel being unusable.

To upgrade to v5, simply run:

SQL

npm install forest-express-sequelize@^5.0.0

Mongoose

npm install forest-express-mongoose@^5.0.0

In case of a regression introduced in Production after the upgrade, a rollback to your previous agent is the fastest way to restore your admin panel.

Breaking changes

Smart Actions defined with custom routes

If your Forest configuration contains Smart Actions using POST or PUT method with a custom endpoint, you’ll have to adapt your Smart Action code.

Here is an example of Smart Action to adapt:

SQL

const Liana = require('forest-express-sequelize');

Liana.collection('companies', {
  actions: [
    {
      name: 'Mark as live',
      httpMethod: 'POST',
      endpoint: 'my-custom-route/mark-as-live', // custom route
    },
  ],
});

Mongoose

const Liana = require('forest-express-mongoose');

Liana.collection('companies', {
  actions: [
    {
      name: 'Mark as live',
      httpMethod: 'POST',
      endpoint: 'my-custom-route/mark-as-live', // custom route
    },
  ],
});

SQL

const express = require('express');
const router = express.Router();
const Liana = require('forest-express-sequelize');
const models = require('../models');

router.post(
  '/my-custom-route/mark-as-live',
  Liana.ensureAuthenticated,
  (req, res) => {
    let companyId = req.body.data.attributes.ids[0];

    return models.companies
      .update({ status: 'live' }, { where: { id: companyId } })
      .then(() => {
        res.send({ success: 'Company is now live!' });
      });
  }
);

module.exports = router;

Mongoose

const express = require('express');
const router = express.Router();
const Liana = require('forest-express-mongoose');
const models = require('../models');

router.post(
  '/my-custom-route/mark-as-live',
  Liana.ensureAuthenticated,
  (req, res) => {
    let companyId = req.body.data.attributes.ids[0];

    return models.companies
      .update({ status: 'live' }, { where: { id: companyId } })
      .then(() => {
        res.send({ success: 'Company is now live!' });
      });
  }
);

module.exports = router;

To make sure it doesn’t break when you upgrade to v5, you must use thebodyParser.json() middleware in the route configuration:

router.post('/my-custom-route/mark-as-live', Liana.ensureAuthenticated, bodyParser.json(),

The v5-compatible result would look like this:

SQL

const express = require('express');
const router = express.Router();
const Liana = require('forest-express-sequelize');
const models = require('../models');
const bodyParser = require('body-parser'); // NOTICE: Require the body-parser dependency.

router.post(
  '/my-custom-route/mark-as-live',
  Liana.ensureAuthenticated,
  bodyParser.json(),
  (req, res) => {
    let companyId = req.body.data.attributes.ids[0];

    return models.companies
      .update({ status: 'live' }, { where: { id: companyId } })
      .then(() => {
        res.send({ success: 'Company is now live!' });
      });
  }
);

module.exports = router;

Mongoose

const express = require('express');
const router = express.Router();
const Liana = require('forest-express-mongoose');
const models = require('../models');
const bodyParser = require('body-parser'); // NOTICE: Require the body-parser dependency.

router.post(
  '/my-custom-route/mark-as-live',
  Liana.ensureAuthenticated,
  bodyParser.json(),
  (req, res) => {
    let companyId = req.body.data.attributes.ids[0];

    return models.companies
      .update({ status: 'live' }, { where: { id: companyId } })
      .then(() => {
        res.send({ success: 'Company is now live!' });
      });
  }
);

module.exports = router;

Important Notice

Changelogs

This release note covers only the major changes. To learn more, please refer to the changelogs in our different repositories:

• Express-sequelize changelog
• Express-mongoose changelog