Repository navigation
fix(web): raise SlackApiError instead of JSONDecodeError on a malformed body #2072
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
agustin18
wants to merge
2
commits into
slackapi:main
Choose a base branch
from
agustin18:fix/web-malformed-json-body
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -290,3 +290,26 @@ def test_non_json_response_body_raises_api_error(self): | |
| with self.assertRaises(err.SlackApiError) as raised: | ||
| self.client.api_test() | ||
| self.assertTrue(raised.exception.response["error"].startswith("Received a response in a non-JSON format")) | ||
|
|
||
| def test_non_json_response_body_starting_with_brace_raises_api_error(self): | ||
| # The retry-handler branch parses any 200 body that starts with "{", so a | ||
| # truncated body must not escape from it as a JSONDecodeError. | ||
| response = {"status": 200, "headers": {}, "body": '{"ok": tru'} | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. praise: Thanks for reusing the exact repro from #2070, so this fails on |
||
| with patch.object(self.client, "_perform_urllib_http_request_internal", return_value=response): | ||
| with self.assertRaises(err.SlackApiError) as raised: | ||
| self.client.api_test() | ||
| self.assertTrue(raised.exception.response["error"].startswith("Received a response in a non-JSON format")) | ||
|
|
||
| def test_non_json_response_body_during_pagination_raises_api_error(self): | ||
| pages = [ | ||
| { | ||
| "status": 200, | ||
| "headers": {}, | ||
| "body": json.dumps({"ok": True, "channels": [], "response_metadata": {"next_cursor": "next"}}), | ||
| }, | ||
| {"status": 200, "headers": {}, "body": '{"ok": tru'}, | ||
| ] | ||
| with patch.object(self.client, "_perform_urllib_http_request_internal", side_effect=pages): | ||
| with self.assertRaises(err.SlackApiError) as raised: | ||
| list(self.client.conversations_list(limit=1)) | ||
| self.assertTrue(raised.exception.response["error"].startswith("Received a response in a non-JSON format")) | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion (non-blocking): Could we guard the
json.loadsin_request_for_paginationin this PR too? #2070 has this as a 4.x breaking change, so fixing both sync paths together means callers see the raised type change once instead of across two releases.