Upgrade to v8

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

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.

Upgrade to v8

Please be aware that while Forest Admin make every effort to ensure that our platform updates are broadly compatible and offer detailed instructions for upgrading, Forest Admin cannot guarantee that custom code developed by the developers will always be compatible with new versions of our software. This includes any custom modifications or extensions to core functionalities, such as method overrides or custom integrations. It is the responsibility of the developers to review and test their custom code to ensure compatibility with each new version. Our team provides comprehensive upgrade guides to assist in this process, but these cannot encompass the unique customizations that may be present in each customer's environment. Therefore, Forest Admin strongly recommend establishing a thorough testing protocol for your specific customizations to safeguard against potential issues during the upgrade process.

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 v8

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 v8, 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 (v7, v6,..)

To upgrade to v8, update the version in your Gemfile, then run the following and update your project as shown in the Breaking Changes section below.

bundle install

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

Breaking changes

Roles v2.0

This new version (v8) drops the support of the legacy Roles system (v1.0). If you are 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 8.

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 controllers extend from the ForestLiana::SmartActionsController controller.

controller.rb

# NOW in v9, this configuration is mandatory to make approvals work as expected.
class Forest::CompaniesController < ForestLiana::SmartActionsController
  def mark_as_live
    # ...
  end
end

Routes override

If your project overrides routes, using the ForestLiana::PermissionsChecker to check the permissions, you must replace PermissionsChecker.new(...) by ForestLiana::Ability::forest_authorize!(action, forest_user, @resource).

An example can be found here.