fix: query parameters containing a colon (:) are not parsed correctly when changed #3045
+46
−4
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
pietrygamat
force-pushed
the
bugfix/3037
branch
2 times, most recently
from
9c718da to
d7465f0
Compare
pietrygamat
force-pushed
the
bugfix/3037
branch
2 times, most recently
from
9a160ff to
24a633f
Compare
pietrygamat
commented
Sep 13, 2024
| @@ -4,6 +4,10 @@ const { indentString } = require('../../v1/src/utils'); | |||
|
|
|||
| const enabled = (items = []) => items.filter((item) => item.enabled); | |||
| const disabled = (items = []) => items.filter((item) => !item.enabled); | |||
| const quoteKey = (key) => { | |||
| const quotableChars = [':', '"', '{', '}', ' ']; | |||
There was a problem hiding this comment.
The characters
: { } "
are important for bru syntax, and so they should be escaped by default. The question of space is open for discussion, as it may be solved in a different way (#2898) without forcing changes onto users' bru files.
pietrygamat
force-pushed
the
bugfix/3037
branch
from
24a633f to
d64dffe
Compare
This was referenced Jan 20, 2025
pietrygamat
force-pushed
the
bugfix/3037
branch
from
d64dffe to
189ee5c
Compare
… names query parameters
Automatically quote query parameter keys if they contain characters sensitive for bru syntax: ':', '"', '{', '}' or ' '.
Quoted keys stored in .bru files now support escaping, so it is possible to store keys that themselves contain '"' character.
Fixes usebruno#3037
Fixes usebruno#2810
Fixes usebruno#2878
pietrygamat
force-pushed
the
bugfix/3037
branch
from
189ee5c to
b02f6b6
Compare
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.
Description
After saving the request, the colon (
:) in a parameter name is being consumed by bru parser and what follows is treated as parameter value - so there must be a way to allow either quoting bru keys, or escaping problematic characters. In this PR I introduce a way to store dictionary keys for query params quoted. The quotes are discarded when loading collections, so they will be invisible in the UI.fixes #3037
fixes #2810 (alternative to #2898)
fixes #2878 (alternative to #2898)
Automatic quoting is currently only applied when saving query parameters. It does not make a lot of sense for request headers, where colon is disallowed by HTTP spec. It may make sense to add in multipart-form body key-value table and vars table (#3178).
Example
Screencast.from.2024-09-14.00-41-20.mp4
Contribution Checklist: