[http] validate request parameters #146
Closed
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
When creating HTTP requests, validate the request parameters. This includes things like checking that the content length of a message is less than or equal to 2000 characters[1], that a new channel's name is within the range of 2-100 characters[2], and more. The request methods that do validation now return results with an error type that is local to the module. For example, the `http::request::channel::UpdateChannel::name` method can return an error, which is defined at `http::request::channel::update_channel::UpdateChannelError`. Validation functions are located in `http::request::validation`, which includes functions that simply return booleans of whether the input is valid or not. Each of these sources where the validation limits are documented. Some things, such as custom emoji names, don't have a documented length limit[3], so validation isn't done for them. [1]: https://discordapp.com/developers/docs/resources/channel#create-message-params [2]: https://discordapp.com/developers/docs/resources/channel#channel-object-channel-structure [3]: https://discordapp.com/developers/docs/resources/emoji#create-guild-emoji-json-params Closes issue #29. Signed-off-by: Vivian Hellyer <vivian@hellyer.dev>
zeylahellyer
added
t-feature
Signed-off-by: Vivian Hellyer <vivian@hellyer.dev>
Erk-
reviewed
Apr 17, 2020
| self.fields.content.replace(content.into()); | ||
| /// Set the content of the message. | ||
| /// | ||
| /// The maximum length is 2000 UTF-8 characters. |
There was a problem hiding this comment.
The maximum length on discord is actually 2000 UTF-16 codepoints as they use python which calculates it in that way.
Though this may be a bit pedantic and I am not sure how to calculate the limit
in that case.
discord/discord-api-docs#1315 (comment)
https://stackoverflow.com/a/30775818
There was a problem hiding this comment.
After looking a bit more into it, It will still have the same amount of codepoints, but a different amount of code units. so the only thing left to resolve is if we should say utf-16 instead of utf-8.
zeylahellyer
added a commit
that referenced
this pull request
May 26, 2020
http: validate request parameters This patch is a continuation of PR #146 with the comments applied. When creating HTTP requests, validate the request parameters. This includes things like checking that the content length of a message is less than or equal to 2000 characters[1], that a new channel's name is within the range of 2-100 characters[2], and more. The request methods that do validation now return results with an error type that is local to the module. For example, the `http::request::channel::UpdateChannel::name` method can return an error, which is defined at `http::request::channel::update_channel::UpdateChannelError`. Validation functions are located in `http::request::validation`, which includes functions that simply return booleans of whether the input is valid or not. Each of these sources where the validation limits are documented. Some things, such as custom emoji names, don't have a documented length limit[3], so validation isn't done for them. [1]: https://discordapp.com/developers/docs/resources/channel#create-message-params [2]: https://discordapp.com/developers/docs/resources/channel#channel-object-channel-structure [3]: https://discordapp.com/developers/docs/resources/emoji#create-guild-emoji-json-params Closes issue #29. Approved-by: Erk- Merged-by: Vivian Hellyer <vivian@hellyer.dev> Signed-off-by: Vivian Hellyer <vivian@hellyer.dev>
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.
When creating HTTP requests, validate the request parameters. This
includes things like checking that the content length of a message is
less than or equal to 2000 characters1, that a new channel's name is
within the range of 2-100 characters2, and more.
The request methods that do validation now return results with an error
type that is local to the module. For example, the
http::request::channel::UpdateChannel::namemethod can return anerror, which is defined at
http::request::channel::update_channel::UpdateChannelError.Validation functions are located in
http::request::validation, whichincludes functions that simply return booleans of whether the input is
valid or not. Each of these sources where the validation limits are
documented. Some things, such as custom emoji names, don't have a
documented length limit3, so validation isn't done for them.
Closes issue #29.
Signed-off-by: Vivian Hellyer vivian@hellyer.dev