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.
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
Mongoose
npm install forest-express-[email protected]4.0.2
npm install forest-express-[email protected]4.1.2
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.
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 v3v3 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 v4v4 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 |
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 using
req.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"
}]
}
This section is dedicated to breaking changes on projects using MongoDB connections.
The minimal version supported by the liana v4 is MongoDB v3.2 (December 2015).
If your project uses an older MongoDB version, you should not upgrade to v4.
The way the liana implements the resources filtering changed and this new implementation uses features that does not exist in MongoDB versions older than 3.2.
The Smart Field search implementation has changed:
- The function signature now has only one
searchparameter. - The expected value to be returned is a hash of the conditions (instead of the
queryobject).
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]
};
}
For consistency reasons,
contains, starts with and ends with operators are now case sensitive.Before (v3)
reference: 'Address'
After (v4)
reference: 'Address._id'
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.
This release note covers only the major changes. To learn more, please refer to the changelogs in our different repositories:
Last modified 1yr ago