[FIX] webservice: deprecate implicit content_only=True default#144
Open
HasanAlsaafen wants to merge 1 commit into
Open
[FIX] webservice: deprecate implicit content_only=True default#144HasanAlsaafen wants to merge 1 commit into
HasanAlsaafen wants to merge 1 commit into
Conversation
- Add explicit deprecation warning when content_only is not set - Fix inconsistency in OAuth2 adapters that ignored content_only entirely - Add tests covering default behavior, explicit True, and explicit False Fixes OCA#142
Contributor
|
Hi @etobella, |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Fixes #142
Problem
BaseRestRequestsAdapter._request()defaultscontent_onlytoTrue,returning raw
bytesinstead of the expectedrequests.Responseobject.This violates the Principle of Least Astonishment, as most HTTP client
libraries return a Response object by default.
Additionally,
BackendApplicationOAuth2RestRequestsAdapter._request()ignored
content_onlyentirely, always returning.content, which wasinconsistent with the base adapter.
Solution
content_onlynow defaults toNone. When not explicitly set, adeprecation warning is logged and the current behavior (
True) ispreserved for backward compatibility.
content_onlyconsistently with the base adapter.
content_only=True, and explicitcontent_only=False.Testing
All 25 existing tests pass alongside the 3 new tests added.