Fix support of JSON body in /store-invite requests #170
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
The spec says that /store-invite requests should be done using the 'application/json' mimetype, but currently Sydent chokes on such requests, because it first extracts its params from the request, doing the right thing if the content-type is JSON, but, when trying to compute the dict of substitutions to apply to the email template, looks for them in request.args, which is empty when using 'application/json'. On top of that, json.dumps() outputs a dict which keys and string values are of type 'unicode', which Python 2 doesn't consider to be strings (or at least not the same as 'str'), so the arguments wouldn't be added to the substitutions dict. This bug went unnoticed because Synapse isn't compliant with the spec here and sends that data using the 'application/x-www-form-urlencoded' mimetype. This is tracked in matrix-org/synapse#5634. This makes Sydent not try to re-extract the params from the request.args, but instead use the ones it has already extracted the right way. It also changes the type comparison on the params' values, comparing them with six.string_types instead of only the 'str' type.
|
FTR I tested these changes on a personal box, and they work both when the HS sends the request with a |
|
(I wonder if this mandates a new release of Sydent) |
richvdh
approved these changes
Jul 9, 2019
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.
The spec says that
/store-inviterequests should be done using theapplication/jsonmimetype, but currently Sydent chokes on such requests, because it first extracts its params from the request, doing the right thing if the content-type is JSON, but, when trying to compute the dict of substitutions to apply to the email template, looks for them inrequest.args, which is empty when usingapplication/json.On top of that,
json.dumps()outputs a dict which keys and string values are of typeunicode, which Python 2 doesn't consider to be strings (or at least not the same asstr), so the arguments wouldn't be added to the substitutions dict.This bug went unnoticed because Synapse isn't compliant with the spec here and sends that data using the
application/x-www-form-urlencodedmimetype. This is tracked in matrix-org/synapse#5634.This makes Sydent not try to re-extract the params from the
request.args, but instead use the ones it has already extracted the right way. It also changes the type comparison on the params' values, comparing them withsix.string_typesinstead of only thestrtype.