refactor(core-api): dot-separated-query hapi plugin #3965
Merged
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.
Summary
Hapi plugin that folds dot-separated query keys into object. Query such as
/wallets?balance.from=100&balance.to=200
enters validation and controller as single propertyrequest.query.balance
instead of two separate propertiesrequest.query["balance.from"]
andrequest.query["balance.to"]
. Without it many schema has to be written twice (GET
andPOST
).It's enabled by default and there is no option to disable it.
I tried
Joi.tailor
and other techniques in attempts to avoid creating this plugin. It changes the way hapi is passing query object into controller which might be confusing in itself, but folding dot-separated parameters is also kind-of intuitive. The way query object is changed also limits what kind of query can be passed. Sending/wallets?balance=100&balance.from=100&balance.to=200
will overridebalance=100
parameter with object made out of other two. This is an edge case and it's unlikely to cause any real problems.Checklist