This repository has been archived by the owner on Apr 26, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Fix error raised on invalid JSON #8291
Merged
Merged
Changes from 3 commits
Commits
Show all changes
5 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 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 |
---|---|---|
@@ -0,0 +1 @@ | ||
Fix a bug introduced in v1.20.0rc1 that the wrong exception was raised when invalid JSON data is encountered. |
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
# -*- coding: utf-8 -*- | ||
# Copyright 2020 The Matrix.org Foundation C.I.C. | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
import json | ||
from io import BytesIO | ||
|
||
from mock import Mock | ||
|
||
from synapse.api.errors import SynapseError | ||
from synapse.http.servlet import ( | ||
parse_json_object_from_request, | ||
parse_json_value_from_request, | ||
) | ||
|
||
from tests import unittest | ||
|
||
|
||
def make_request(content): | ||
"""Make an object that acts enough like a request.""" | ||
request = Mock(spec=["content"]) | ||
|
||
if isinstance(content, dict): | ||
content = json.dumps(content).encode("utf8") | ||
|
||
request.content = BytesIO(content) | ||
return request | ||
|
||
|
||
class TestServletUtils(unittest.TestCase): | ||
def test_parse_json_value(self): | ||
"""Basic tests for parse_json_value_from_request.""" | ||
# Test round-tripping. | ||
obj = {"foo": 1} | ||
result = parse_json_value_from_request(make_request(obj)) | ||
self.assertEqual(result, obj) | ||
|
||
# Results don't have to be objects. | ||
result = parse_json_value_from_request(make_request(b'["foo"]')) | ||
self.assertEqual(result, ["foo"]) | ||
|
||
# Test empty. | ||
with self.assertRaises(SynapseError): | ||
parse_json_value_from_request(make_request(b"")) | ||
|
||
result = parse_json_value_from_request(make_request(b""), allow_empty_body=True) | ||
self.assertIsNone(result) | ||
|
||
# Invalid UTF-8. | ||
with self.assertRaises(SynapseError): | ||
parse_json_value_from_request(make_request(b"\xFF\x00")) | ||
|
||
# Invalid JSON. | ||
with self.assertRaises(SynapseError): | ||
parse_json_value_from_request(make_request(b"foo")) | ||
|
||
with self.assertRaises(SynapseError): | ||
parse_json_value_from_request(make_request(b'{"foo": Infinity}')) | ||
|
||
def test_parse_json_object(self): | ||
"""Basic tests for parse_json_object_from_request.""" | ||
# Test empty. | ||
result = parse_json_object_from_request( | ||
make_request(b""), allow_empty_body=True | ||
) | ||
self.assertEqual(result, {}) | ||
|
||
# Test not an object | ||
with self.assertRaises(SynapseError): | ||
parse_json_object_from_request(make_request(b'["foo"]')) |
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.
Looks like this requires upping the minimum version of treq to 18.6.0. Do we have any issues with that?
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.
Fedora 31 (EOL Nov. 17) only has treq 17.8.0, so I decided to essentially inline part of
json_content
.