[CURA-12067] The json-decorator-scope didn't set the user-agent yet. #962
+4
−0
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
Add the header-dictionaries from base (which should've got the User-Agent set, at the very least in case we wrap around something that inherits from DefaultUserAgentScope, which is the only use-case I encountered) with the json-specific settings that are already in there. In order to prevent breaking the API, don't directly change the inheritance of the JsonDecoratorScope, but instead check for the existance of the header-dict in the base. CURA-12067
wawanbreton
reviewed
Aug 15, 2024
| @@ -51,6 +51,10 @@ def __init__(self, base: HttpRequestScope) -> None: | |||
| "Content-Type": "application/json", | |||
| "Accept": "application/json" | |||
| } | |||
| # JsonDecorator probably _should_ have inherited from DefaultUserAgentScope in the first place. | |||
| # In order to prevent a break in the API by forcing that, just check if there are extra header specs needed. | |||
There was a problem hiding this comment.
I'm not sure it should actually inherit from DefaultUserAgentScope. You may want to use this decorator without the user-agent, or with a different one. Those decorators are, as I understood them, designed to be chained.
I would suggest to either:
- Commit to your suggestion and force the inheritance
- Commit to this new behavior and don't mention the inheritence in the comment
On the other hand, I'm overall surprised by this fix. The header_dict values should be applied in the requestHook method, both the ones from the base and the instance, so I don't see what good this does. I'm probably missing something.
There was a problem hiding this comment.
Ah, I missed that, sorry.
I think we should close this PR -- sorry 😓
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.
Add the header-dictionaries from base (which should've got the User-Agent set, at the very least in case we wrap around something that inherits from DefaultUserAgentScope, which is the only use-case I encountered) with the json-specific settings that are already in there. In order to prevent breaking the API, don't directly change the inheritance of the JsonDecoratorScope, but instead check for the existence of the header-dict in the base.