Upgrade to v4

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

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, 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 liana 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 forest_user in v3

v3 format
{
"id": "172",
"type": "users",
"data": {
"email": "angelicabengtsson@doha2019.com",
"first_name": "Angelica",
"last_name": "Bengtsson",
"teams": ["Pole Vault"],
},
"relationships": {
"renderings": {
"data": [{
"type": "renderings",
"id": "4998",
}],
},
},
"iat": 1569913709,
"exp": 1571123309
}

Calling forest_user in v4

v4 format
{
"id": "172",
"email": "angelicabengtsson@doha2019.com",
"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

forest_user.data.email

forest_user.email

first name

forest_user.data.first_name

forest_user.firstName

last name

forest_user.data.last_name

forest_user.lastName

team

forest_user.data.teams[0]

forest_user.team

rendering id

forest_user.relationships.renderings.data[0].id

forest_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 usingparams[: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"
}]
}

Important Notice

Liana logout

A consequence of the new session token format is:

Once a liana 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: