[TECH] Mise à jour de la dépendance Joi dans l'API

[laura-bergoens]

🦄 Problème

La version de la dépendance de Joi incluse dans l'API est dépréciée. De plus, la dépendance a été déplacée vers @hapi/joi.

🤖 Solution

Modification de la dépendance de joi vers @hapi/joi
Mise à jour de 14.3.1 vers 16.0.0
Adaptation de la validation des competence-marks pour fonctionner avec la nouvelle version.

🌈 Remarques

Changelog :
de 14.3.1 vers 16.0.0 : hapijs/joi#2037

[pix-service]

I'm deploying this PR to these urls:

• App: https://app-pr704.review.pix.fr
• Orga: https://orga-pr704.review.pix.fr
• Certif: https://certif-pr704.review.pix.fr
• Admin: https://admin-pr704.review.pix.fr
• API: https://pix-api-integration-pr704.scalingo.io

Please check it out

[lisequesnel]

Attention, cela peut changer le fonctionnel.

[sroccaserra]

Qu'est-ce qui fait qu'on souhaite avoir un comportement différent pour null et pour undefined ?

[sroccaserra]

Liste des modèles Joi que j'ai trouvés :

lib/domain/models/CompetenceMark.js
lib/domain/validators/campaign-validator.js
lib/domain/validators/session-validator.js
lib/domain/validators/user-validator.js
lib/domain/validators/organization-creation-validator.js
lib/application/passwords/index.js
lib/application/users/index.js
lib/application/authentication/index.js

[sroccaserra]

Il reste des require('joi') à changer en require('@hapi/joi'). Attention, je pense que ça ne se voit pas car il nous reste des dépendances qui dépendent de 'joi' donc il se trouve toujours dans nos node_modules.
Ici :

lib/application/passwords/index.js
lib/application/authentication/index.js
lib/application/users/index.js
lib/domain/validators/campaign-validator.js
lib/domain/validators/user-validator.js
lib/domain/validators/session-validator.js
lib/domain/validators/organization-creation-validator.js

[sroccaserra]

On peut renommer string().regex() en string().pattern() (pas obligé, il y a un alias, c'est listé dans les breaking changes cependant).
Ici :

lib/application/users/index.js
lib/domain/validators/session-validator.js

[sroccaserra]

Il y a des requires à corriger et des breaking changes à faire

[sroccaserra]

Je pense qu'il vaut mieux passer à Hapi 18.3.3 ou 18.4.0 avant de faire ce changement. Attention : "hapi" est devenu "@hapi/hapi" sur npm.

[sroccaserra]

Le truc le plus casse-pieds à faire sera probablement de mettre à jour l'extension qu'on utilise pour valider les passwords (Joi.extend() a bien changé).

Tentative non terminée (des tests échouent encore) :

diff --git a/api/lib/domain/validators/user-validator.js b/api/lib/domain/validators/user-validator.js
index 326767fbd..e079dccec 100644
--- a/api/lib/domain/validators/user-validator.js
+++ b/api/lib/domain/validators/user-validator.js
@@ -6,20 +6,18 @@ const validationConfiguration = { abortEarly: false, allowUnknown: true };

 // TODO this check on password format should be done in create user use case and not user validation
 const joiWithPasswordValidation = Joi.extend((joi) => ({
-  name: 'string',
+  type: 'string',
   base: joi.string(),
-  rules: [
-    {
-      name: 'password',
-      validate(params, value, state, options) {
+  rules: {
+    password: {
+      validate(value, helpers) {
         const isValid = validatePassword(value);
         if (!isValid) {
-          return this.createError('string.password', { v: value }, state, options);
+          return { value, errors: helpers.error('string.password') };
         }
-        return value;
       }
     }
-  ]
+  }
 }));

 const userValidationJoiSchema = Joi.object().keys({

[laura-bergoens]

Implique d'abord une mise à jour de Hapi