-
Notifications
You must be signed in to change notification settings - Fork 82
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
Restrict Snowflake range, type changes, consistent naming #384
Merged
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
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.
This PR combines #380, #382 and some additional changes. I would want to keep this PR open until discord/discord-api-docs#3745 gets accepted.
Change some types from
String
toSnowflake
(#380)DiscordGuildBan.guildId
see:
https://discord.com/developers/docs/topics/gateway#guild-ban-add-guild-ban-add-event-fields
https://discord.com/developers/docs/topics/gateway#guild-ban-remove-guild-ban-remove-event-fields
DMCreatRequest.userId
see: https://discord.com/developers/docs/resources/user#create-dm
ChannelFollowRequest.webhookChannelId
see: https://discord.com/developers/docs/resources/channel#follow-news-channel
Restrict
Snowflake
s to valid range (#382)Implement the Snowflake limitations described in discord/discord-api-docs#3745. This will e.g. fix an error in pagination (invalid Snowflakes were used before).
The valid range for a
Snowflake
's raw value is represented by the newvalidValues
property ofSnowflake
's companion object. All constructors will coerce their input in that range so there is no way to create an invalidSnowflake
.If Discord ever decides to widen the valid range, it would just be a matter of adjusting
validValues
accordingly to support that. (I intended this range to be the single point of truth).b96f3bb removes a test that was depending on an invalid
Snowflake
to pass. Since there is no longer a way to create such invalidSnowflake
s, it is impossible to make this test pass.Consistent naming
Snowflake.discordEpochStart
toSnowflake.discordEpoch
as it is the term used in Discord's documentationXxxTimestamp
classes and properties