[TECH] Améliorer le parsing et la validation des query parameters côté API. #9416
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
HEYGUL
added
cross-team
|
Une fois les applications déployées, elles seront accessibles via les liens suivants :
Les variables d'environnement seront accessibles via les liens suivants : |
HEYGUL
force-pushed
the
tech-improve-query-parsing
branch
from
2906be5
to
1ff1e26
Compare
matthiasferraina
approved these changes
Jul 2, 2024
frinyvonnick
reviewed
Jul 2, 2024
api/src/prescription/campaign/application/campaign-detail-controller.js
Outdated
Show resolved
Hide resolved
api/tests/prescription/campaign/unit/application/campaign-administration-controller_test.js
Outdated
Show resolved
Hide resolved
VincentHardouin
approved these changes
Jul 2, 2024
HEYGUL
force-pushed
the
tech-improve-query-parsing
branch
4 times, most recently
from
59c1e14
to
4750308
Compare
This allow for better definition of query parameters validation See https://hapi.dev/api/\?v\=21.3.3\#-serveroptionsquery
HEYGUL
force-pushed
the
tech-improve-query-parsing
branch
from
4750308
to
cb377e3
Compare
HEYGUL
added
Tech Review OK
🚀 Ready to Merge
Func Review OK
AndreiaPena
reviewed
Jul 8, 2024
| @@ -55,7 +54,7 @@ const findPaginatedFilteredCertificationCenters = async function (request) { | |||
| const findPaginatedSessionSummaries = async function (request) { | |||
| const certificationCenterId = request.params.id; | |||
| const userId = request.auth.credentials.userId; | |||
| const options = extractParameters(request.query); | |||
| const options = request.query; | |||
There was a problem hiding this comment.
extractParameters retiré ici mais pas de validation Joi sur la route
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🦄 Problème
Hapi permet de valider les query parameters via des schémas
Joi.Par défaut, les query parameters sont parsés en chaine de caractère.
Il est donc nécessaire de connaitre la façon dont sont encodés ceux-ci pour définir leur validation.
Par exemple, un tableau
arrayinclus dans objetobjectest encodé :object[array][].Il faut également parser les query parameters pour retrouver un objet utilisable par le restee du code.
Actuellement, chaque contrôleur doit le faire, en utilisant
query-parameters-utilsqui se base sur des RegExp pour parser.🤖 Proposition
Tirer profit de
server.options.query.parserde Hapi.Cela permet de s'affranchir du fichier
query-parameters-utilset utiliser la dépendanceqspour parser les query parameters.Cette responsabilité est alors déplacée des contrôleurs et confiée directement au serveur Hapi.
Dans la définition des routes, on peut alors utiliser un schéma
Joiplus juste pour définir les query parameters.Par exemple, pour la pagination,
page[size] = Joi....devientpage: { size: Joi... }🌈 Remarques
Il y a énormément de fichiers modifiés dans cette PR.
Comme le parsing de query parameter est une option du serveur, il n'est pas possible de le configurer différemment entre 2 routes.
Il a donc fallu passer sur l'ensemble de la base de code pour modifier les définitions de query parameters et ajuster le code du contrôleur et les tests.
Ce travail a mis également en lumière que certaines routes utilisent des query parameters mais ne les spécifient pas dans leur définition.
💯 Pour tester
S'assurer que la CI est verte.
S'assurer que les différents query parameters sont correctement définis et couverts par des tests automatisés.
Faire une passe sur les différents applications pour vérifier que les filtres et la pagination sont fonctionnels.