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 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

Python

PHP

Upgrade to v5

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.

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, update the version in your Gemfile, then run:

bundle install

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

Breaking changes

Select all feature

This version also introduces the new Select all behavior. Once you've updated your bulk Smart Actions according to the below changes, you'll be able to choose between selecting all the records or only those displayed on the current page.

/controllers/forest/companies_controller.rb

# BEFORE
class Forest::CompaniesController < ForestLiana::SmartActionsController
  def mark_as_live
    company_ids = params.dig('data', 'attributes', 'ids')
    # ...
    render json: { success: 'Companies are now live!' }
  end
end
# AFTER
class Forest::CompaniesController < ForestLiana::SmartActionsController
  def mark_as_live
    company_ids = ForestLiana::ResourcesGetter.get_ids_from_request(params)
    # ...
    render json: { success: 'Companies are now live!' }
  end
end

If you altered the default DELETE behavior by overriding or extending it, you'll have to do so as well with the new BULK DELETE route.

Important Notice

Changelogs

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

• Rails changelog