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.
Please be sure of your agent type and version and pick the right documentation accordingly.
This is the documentation of the forest-express-sequelize
and forest-express-mongoose
Node.js agents that will soon reach end-of-support.
Please check your agent type and version and read on or switch to the right documentation.
Upgrade to v5
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:
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 Admin 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:
To make sure it doesn't break when you upgrade to v5, you must use thebodyParser.json()
middleware in the route configuration:
The v5-compatible result would look like this:
Important Notice
Changelogs
This release note covers only the major changes. To learn more, please refer to the changelogs in our different repositories:
Last updated