Upgrade to v9

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

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

Python

PHP

Upgrade to v9

Please follow the recommended procedure to upgrade your agent version by following this note.

This upgrade unlocks the following features:

• Use templating in the filters of Chart components

• Add conditions to your role permissions

Upgrading to v9

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 v9, first update your project according to the Breaking Changes section below.

If you're upgrading from an older version, please make sure you've also read the previous upgrade notes (v8, v7,..)

Once you're done with the above steps, run the following:

SQL

npm install "forest-express-sequelize@^9.0.0"

MongoDB

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

Roles v2.0

This new version (v9) drops the support of the legacy Roles system (v1.0). If you are in this legacy configuration, please follow this procedure in order to migrate to the new Roles system (v2.0) before you attempt to upgrade to version 9.

How do I know if I'm using the legacy or new Roles system?

If you have access to Roles (Project settings > Roles) as designed below... then you are using the new Role system.

Approval Workflow

This new major version makes the configuration, described below, mandatory to ensure that actions are not triggered directly and approvals requests are properly created for the reviewers.

Whether or not your project currently uses the Approval Workflow feature, you must ensure that all your Smart Actions routes are configured with the Smart Action middleware: permissionMiddlewareCreator.smartAction().

// BEFORE v9, this configuration, although unsecured, was working.
router.post('/actions/mark-as-live', (req, res) => {
  // ...
});

// NOW in v9, this configuration is mandatory to make approvals work as expected.
const { PermissionMiddlewareCreator } = require('forest-express-xxx');
const permissionMiddlewareCreator = new PermissionMiddlewareCreator(
  'companies'
);

router.post(
  '/actions/mark-as-live',
  permissionMiddlewareCreator.smartAction(),
  (req, res) => {
    // ...
  }
);