cc: implement new DiagnoseCCTriggers command #1712
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
This change unlocks using this function in a later commit (where we only have a guild ID, not the full guild data.) It's also more proper: ManageServerURL only needs the guild ID, so it need not be tied to dcmd.
The action of computing this limit is repeated throughout this file, so factor it out. Since we are using the limit for more than just messages, rename it appropriately.
Currently the comparator is internal to sortTriggeredCCs (which accepts a slice of *TriggeredCC), but we will need to sort a slice of custom commands directly to implement the debug command. Extract the comparator out, document the priority order, and then refactor the implementation for clarity. To prove that the old and new comparator implementations are functionally equivalent, see the following test: https://go.dev/play/p/NEUrG1wu0OI. It exhaustively enumerates all pairs of custom commands and ensures the old and new comparators agree.
galen8183
pushed a commit
to galen8183/yagpdb
that referenced
this pull request
Nov 12, 2024
* web: make ManageServerURL take guild ID directly This change unlocks using this function in a later commit (where we only have a guild ID, not the full guild data.) It's also more proper: ManageServerURL only needs the guild ID, so it need not be tied to dcmd. * cc: factor out CCActionExecLimit function The action of computing this limit is repeated throughout this file, so factor it out. Since we are using the limit for more than just messages, rename it appropriately. * cc: extract hasHigherPriority comparator Currently the comparator is internal to sortTriggeredCCs (which accepts a slice of *TriggeredCC), but we will need to sort a slice of custom commands directly to implement the debug command. Extract the comparator out, document the priority order, and then refactor the implementation for clarity. To prove that the old and new comparator implementations are functionally equivalent, see the following test: https://go.dev/play/p/NEUrG1wu0OI. It exhaustively enumerates all pairs of custom commands and ensures the old and new comparators agree. * cc: implement new DiagnoseCCTriggers command
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.
Review commit-by-commit.
Add a new debug command,
DiagnoseCCTriggers, that lists all custom commands triggering on its input and identifies potential issues. The intent is for support members to instruct users to runDiagnoseCCTriggersin the event of custom commands not triggering as the user expects; we can also consider adding a note in the documentation and/or control panel pointing to this command where appropriate.Sample output:
To implement
DiagnoseCCTriggers, some light refactoring to enable code reuse was necessary (see first 3 commits.)In the server, Henri proposed that, instead of a command, a control panel warning could be generated when there are conflicting triggers. Though such a warning would definitely be more discoverable, it is difficult to implement--requiring significantly more code than this PR--and near-impossible to make as robust as a command, so it would not catch all cases.) So we stick with the command here.