Upgrade to v4

The purpose of this note is to help developers to upgrade their agent from v3 to v4. 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 v4

Upgrading to v4

Before upgrading to v4, 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 v4, simply run:

SQL

npm install forest-express-sequelize@4.0.2

Mongoose

npm install forest-express-mongoose@4.1.2

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

Breaking changes

New JWT authentication token

The information format of the session token have changed in v4.

You could be impacted if you use the user session in Smart Action controllers or Smart Routes

Calling req.user in v3

v3 format

{
  "id": "172",
  "type": "users",
  "data": {
    "email": "[email protected]",
    "first_name": "Angelica",
    "last_name": "Bengtsson",
    "teams": ["Pole Vault"],
  },
  "relationships": {
    "renderings": {
      "data": [{
        "type": "renderings",
        "id": "4998",
      }],
    },
  },
  "iat": 1569913709,
  "exp": 1571123309
}

Calling req.user in v4

v4 format

{
  "id": "172",
  "email": "[email protected]",
  "firstName": "Angelica",
  "lastName": "Bengtsson",
  "team": "Pole Vault",
  "renderingId": "4998",
  "iat": 1569913709,
  "exp": 1571123309
}

Consequently, the user information is now accessible as described below:

Property	v3	v4
email	req.user.data.email	req.user.email
first name	req.user.data.first_name	req.user.firstName
last name	req.user.data.last_name	req.user.lastName
team	req.user.data.teams[0]	req.user.team
rendering id	req.user.relationships.renderings.data[0].id	req.user.renderingId

New filters query parameters format

The query parameters sent for filtering purposes have changed in v4.

You could be impacted if you have custom filter implementations.

Below are a few example of the new filter conditions format you can access usingreq.params.filters:

Simple condition example:

{
  "field": "planLimitationReachedAt",
  "operator": "previous_year_to_date",
  "value": null
}

Multiple conditions example:

{
  "aggregator": "and",
  "conditions": [{
    "field": "planLimitationReachedAt",
    "operator": "previous_year_to_date",
    "value": null
  }, {
    "field": "planLimitationStatus",
    "operator": "equal",
    "value": "warning"
  }]
}

MongoDB

This section is dedicated to breaking changes on projects using MongoDB connections.

MongoDB version support

The minimal version supported by the agent v4 is MongoDB v3.2 (December 2015).

If your project uses an older MongoDB version, you should not upgrade to v4.

The way the agent implements the resources filtering changed and this new implementation uses features that does not exist in MongoDB versions older than 3.2.

Smart Field search implementation

The Smart Field search implementation has changed:

• The function signature now has only one search parameter.

• The expected value to be returned is a hash of the conditions (instead of the query object).

See the following implementation migration example:

Before (v3)

 search(query, search) {
  let names = search.split(' ');
​
  query._conditions.$or.push({
    firstname: names[0],
    lastname: names[1]
  });
​
  return query;
}

After (v4)

search(search) {
  let names = search.split(' ');
​
  return {
    firstname: names[0],
    lastname: names[1]
  };
}

Condition operator changes

For consistency reasons, contains, starts with and ends with operators are now case sensitive.

Smart relationships reference syntax

If you had a reference property in a Smart relationship you implemented, the syntax has changed:

Before (v3)

reference: 'Address';

After (v4)

reference: 'Address._id';

Important Notice

Agent logout

A consequence of the new session token format is:

Once an agent v4 deployed, all users of your project will be automatically logged out and be forced to re-authenticate to generate a newly formatted token. ​

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