Properly encode URL query parameters when building a cloning URL #5641
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
Test the query parameters of a Location when the Description contains a & character.
Utilize urllib.parse to handle encoding the param dictionary.
…repare_cloned_field_space_characters
glennmatthews
approved these changes
Apr 26, 2024
There was a problem hiding this comment.
Looks great. Can you add a changes/5640.fixed changelog fragment to the diffs?
| @@ -269,7 +270,7 @@ def prepare_cloned_fields(instance): | |||
| for tag in instance.tags.all(): | |||
| params.append(("tags", tag.pk)) | |||
|
|
|||
| # Concatenate parameters into a URL query string | |||
| param_string = "&".join([f"{k}={v}" for k, v in params]) | |||
There was a problem hiding this comment.
Oof. I'm surprised this stuck around for as long as it has. Thanks for the fix!
If you'd like to go wild, there's some similarly sketchy-looking logic in nautobot.core.tables.LinkedCountColumn.render() that probably could do with a similar fix, though based on its context it's likely a lot less impactful. Not required for this PR!
|
I'll add that changelog fragment here shortly and update the PR. |
…repare-cloned-fileds-special-characters
glennmatthews
approved these changes
Apr 29, 2024
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.
Closes #5640
What's Changed
Switch to utilize urllib.parse.urlencode to generate the query parameter string when cloning an object.
Screenshots
Before
Before this patch a location with the description "9th & Vine" (well anything with a special character in it) would not populate the dialog properly when cloning.
After
Now the clone dialog shows the description as expected.
TODO