Fix array query string parsing #5268
Merged
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
nflaig
commented
Mar 14, 2023
| // defaults to 20 but Beacon API spec allows max items of 30 | ||
| arrayLimit: 30, | ||
| // array as comma-separated values must be supported to be OpenAPI spec compliant | ||
| comma: true, |
There was a problem hiding this comment.
koa openapi req/res validator uses this library as well and sets comma: true, this is required to be OpenAPI spec compliant, see Parameter Serialization
| @@ -43,7 +43,15 @@ export class RestApiServer { | |||
| const server = fastify({ | |||
| logger: false, | |||
| ajv: {customOptions: {coerceTypes: "array"}}, | |||
| querystringParser: querystring.parse, | |||
| querystringParser: (str) => | |||
| qs.parse(str, { | |||
There was a problem hiding this comment.
| querystringParser: (str) => | ||
| qs.parse(str, { | ||
| // defaults to 20 but Beacon API spec allows max items of 30 | ||
| arrayLimit: 30, |
There was a problem hiding this comment.
Beacon API spec defines 30 as maxItems for some values, e.g. getStateValidators - id query, see spec value
Performance Report✔️ no performance regression detected Full benchmark results
|
nflaig
force-pushed
the
nflaig/fix-query-spec-compliance
branch
from
a198b7e
to
a9641a9
Compare
nazarhussain
approved these changes
Mar 14, 2023
There was a problem hiding this comment.
The changes seems ok as it does not show up any regression. I tried to identify what are the changes in the minor release update but seems their repo does not document it well.
|
@nazarhussain they document their changes in changelog file, see CHANGELOG.md |
twoeths
approved these changes
Mar 15, 2023
g11tech
approved these changes
Mar 15, 2023
|
@tuyennhv yeah, I looked into adding a test for this but there was no quick way to do it. I think for general cases such as this we just need to improve our spec compliance tests |
|
🎉 This PR is included in v1.6.0 🎉 |
|
🎉 This PR is included in v1.7.0 🎉 |
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.
Motivation
The query string parser we use at the moment does not support an array as comma-separated values and on top of that the package itself is deprecated and last release was 2 years ago, querystring node API is considered legacy as well and does not support all parsing requirements we need.
The following request it not correctly parsed at the moment, it result in just one value
curl 'http://localhost:9596/eth/v1/beacon/states/head/validators?id=0xb89bebc699769726a318c8e9971bd3171297c61aea4a6578a7a4f94b547dcba5bac16a89108b6b6a1fe3695d1a874a0b,0xa99a76ed7796f7be22d5b7e85deeb7c5677e88e511e0b337618f8c4eb61349b4bf2d153f649f7b53359fe8b94a38e44c'To be OpenAPI spec compliant we need to support this query string format, all other 4 CLs support this format as well.
The issue was reported by jcrtp from rocketpool, see discord thread.
Description
Updates fastify querystringParser to use qs instead of querystring.
qsseems to be really popular and is actively maintained. The code looks clean as well and has a good test suite.We also already use
qspackage in several other places (e.g. here) in the monorepo.