feat(twilight-model,twilight-validate)!: Implement select menu default values #2281
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
github-actions
bot
added
c-model
archer-321
added a commit
to archer-321/twilight-select-menus
that referenced
this pull request
Sep 28, 2023
This commit updates the README to mention the second pull request using this project (twilight-rs/twilight#2281). Moreover, it removes the references to the new removed `!select` text command.
|
Interestingly enough, the test passed with the (outdated) version I had in my |
laralove143
requested changes
Sep 28, 2023
AEnterprise
approved these changes
Oct 15, 2023
laralove143
previously approved these changes
Nov 1, 2023
|
@laralove143, I could reproduce the CI failure locally (after setting the necessary environment variables). |
|
I believe the CI error this PR is experiencing will be fixed by #2295. |
…t values This commit implements the default_values field for auto-populated select menu components. Currently, it's supported by user-, role-, mentionable-, and channel select menus. In addition to adding the `SelectDefaultValue` type and its field to `SelectMenu`, this commit updates the existing tests to also test this new feature. Moreover, it updates twilight-validate to validate the invariants specified by Discord's API reference.
This commit updates the component unit tests to use `UnitVariant` instead of `Str` for the adjacently tagged `SelectDefaultValue` enum. Introduced by a SemVer-compatible update of the `serde` crate, this implementation detail was enough to break this unit test when using an up-to-date `Cargo.lock`.
This commit implements select menu serialization tests. With most parts of (text) select menus already tested by `component_full`, this commit focuses on the `default_values` field. In addition to updating the select menu component tests, this patch implements Copy for `SelectMenuType`. Moreover, it moves the individual validation parts for the `default_values` field to separate functions. Those functions then received unit tests. Overall, this design matches the rest of the component validation code.
This commit removes all tokens related to the default_values field from the `component_full` test. The previous commit set this field to `None` but didn't update the expected tokens. With this commit, all tests should pass again.
This commit changes the inner `check_select` function in `message::component::tests::select_menu` to take a vector of select menu default values *and* the respective &'static str. This allows removing the previous Box::leak that was necessary to convert a dynamically generated string into a 'static str slice.
archer-321
force-pushed
the
feat/select-menu-default-values
branch
from
e33f30f to
f07f652
Compare
|
I rebased the PR, and this fixed the CI. Please let me know if there are any other changes you'd like to see c: |
laralove143
approved these changes
Nov 7, 2023
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 pull request adds the
default_valuesfield Discord recently introduced for select menus. This field allows selecting default values for auto-populated select menu types (currently,user,role,mentionable, andchannel).Setting this field to
Some(...)for any other select menu type is an error at runtime. However, I've changed the twilight-verify implementation to detect mistakes like this before sending the data to Discord.Given the previous decision to implement select menu types as entirely flattened structs, I added the
default_valuesfield as an option toSelectMenu. While this doesn't statically enforce the type requirement explained above, this matches the behaviour of other type-specific fields.Testing
I've updated my simple test project to use the feature introduced by this PR. As with my last PR, you can use it to get a quick overview of how the new API works.
Breaking changes
I'm aware of the following breaking change that this PR introduces:
SelectMenu(exhaustive) received a newdefault_valuesfield.I've updated the documentation and tests wherever necessary, but if I missed something or you want me to rephrase a comment, please request changes.
I believe you should add the
d-apiandd-breakinglabels to this PR.