Suggestion Command Draft PR #869

Atmois · 2025-05-18T08:43:22Z

Description

When the command is run makes a post in a defined channel which has two buttons, approve and deny, those buttons can only be interacted with by admins. It also will add thumps up and down reaction for user votes and create a thread attached to it.

Guidelines

My code follows the style guidelines of this project (formatted with Ruff)
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation if needed
My changes generate no new warnings
I have tested this change
Any dependent changes have been merged and published in downstream modules
I have added all appropriate labels to this PR
I have followed all of these guidelines.

Additional Information

Most of it has been completed, the major missing component is button persistence on restart.

Summary by Sourcery

Implement a suggestion submission feature allowing users to submit suggestions via a slash command, log them to a configurable channel, and enable admin-only approve/deny interactions with vote tracking and threaded discussions.

New Features:

Add /suggest slash command that opens a SuggestionModal for users to submit suggestions
Introduce SuggestionModal and ButtonView to post suggestions as embeds with Approve/Deny buttons for admins
Enable users to vote on suggestions via 👍/👎 reactions and automatically create a discussion thread for each suggestion

Enhancements:

Add suggestion_log_id field to guild configuration with corresponding getters and setters
Implement SuggestionController for ensuring guild records and creating suggestion entries in the database
Register persistent ButtonView in bot startup to handle suggestion approval/denial interactions

…d by kaizen

sourcery-ai · 2025-05-18T08:43:27Z

Reviewer's Guide

Introduces a new suggestion command flow: a modal for user submissions, configuration UI for setting the suggestion channel, database support for persisting suggestions and channel settings, and interactive approve/deny buttons with reactions and thread creation.

Sequence Diagram: Admin Reviewing a Suggestion

sequenceDiagram
    actor Admin
    participant DiscordClient as Discord Client
    participant SuggestionMessage as Suggestion Message (in Channel)
    participant ButtonView as ButtonView (Tux Bot Component)
    participant DiscordAPI as Discord API

    Admin->>DiscordClient: Clicks "Approve" or "Deny" button on SuggestionMessage
    DiscordClient->>ButtonView: Button interaction received
    ButtonView->>ButtonView: Perform permission check (e.g., checks.has_pl(5))
    alt Admin has required permissions
        ButtonView->>ButtonView: Update internal embed state (e.g., status to "Accepted"/"Rejected", add reviewer)
        ButtonView->>DiscordAPI: Edit original SuggestionMessage with updated embed and buttons
    else Admin lacks permissions
        ButtonView->>Admin: (Interaction fails or ephemeral error - not explicitly shown in diff)
    end

Class Diagram: New UI Components - `SuggestionModal` and `ButtonView`

classDiagram
    class SuggestionModal {
        <<UI Modal>>
        +bot: commands.Bot
        +config: GuildConfigController
        +suggestion_title: discord.ui.TextInput
        +suggestion_description: discord.ui.TextInput
        +__init__(title: str, bot: commands.Bot)
        +on_submit(interaction: discord.Interaction) void
    }
    note for SuggestionModal "New modal for users to submit suggestions."

    class ButtonView {
        <<UI View>>
        +embed: discord.Embed
        +__init__(embed: discord.Embed)
        +green_button(interaction: discord.Interaction, button: discord.ui.Button) void
        note for green_button "Handles 'Accept' button. Requires @checks.has_pl(5)."
        +red_button(interaction: discord.Interaction, button: discord.ui.Button) void
        note for red_button "Handles 'Deny' button. Requires @checks.has_pl(5)."
    }
    note for ButtonView "New view with 'Accept' and 'Deny' buttons for suggestion messages."

    SuggestionModal --|> discord.ui.Modal
    ButtonView --|> discord.ui.View
    SuggestionModal ..> GuildConfigController : uses
    SuggestionModal ..> discord.Embed : creates
    ButtonView ..> discord.Embed : manipulates

Class Diagram: New Backend Components - `Suggestion` Cog and `SuggestionController`

classDiagram
    class Suggestion {
        <<Cog>>
        +bot: commands.Bot
        +__init__(bot: commands.Bot)
        +suggestion(interaction: discord.Interaction) void
        note for suggestion "App command '/suggest'. Sends SuggestionModal to the user."
    }
    note for Suggestion "New Cog to handle the '/suggest' application command."

    class SuggestionController {
        <<Database Controller>>
        +table: PrismaTable_Suggestion "prisma.suggestion table accessor"
        +guild_table: PrismaTable_Guild "prisma.guild table accessor"
        +__init__()
        +ensure_guild_exists(guild_id: int) Guild
        +create_suggestion(suggestion_title: str, suggestion_description: str, suggestion_status: SuggestionStatus, suggestion_user_id: int, guild_id: int) Suggestion
    }
    note for SuggestionController "New controller for creating and managing suggestion records in the database."

    Suggestion --|> discord.ext.commands.Cog
    Suggestion ..> SuggestionModal : creates and sends
    SuggestionController ..> prisma.models.Guild : uses
    SuggestionController ..> prisma.models.Suggestion : uses
    SuggestionController ..> prisma.enums.SuggestionStatus : uses

Class Diagram: Updates to `GuildConfigController` for Suggestions

classDiagram
    class GuildConfigController {
        <<Existing Controller>>
        #get_guild_config_field_value(guild_id, field_name)
        #ensure_guild_exists(guild_id)
        #table
        +get_log_channel(guild_id: int, log_type: str) int | None
        note for get_log_channel "Internal 'log_channel_ids' map updated to include 'suggestion'."
        +get_suggestion_log_channel(guild_id: int) int | None
        note for get_suggestion_log_channel "New method to retrieve the suggestion log channel ID."
        +update_suggestion_log_id(guild_id: int, suggestion_log_id: int) GuildConfig | None
        note for update_suggestion_log_id "New method to set or update the suggestion log channel ID."
    }
    note for GuildConfigController "Modified to manage configuration for suggestion log channels."

Class Diagram: Updates to `ConfigSetLogChannel` View for Suggestions

classDiagram
    class ConfigSetLogChannel {
        <<Existing UI View>>
        +db: GuildConfigController
        +__init__(timeout: float)
        %% Other select handlers like _set_join_log(...)
        +_set_suggestion_log(interaction: discord.Interaction, select: discord.ui.ChannelSelect) void
        note for _set_suggestion_log "New discord.ui.ChannelSelect element and handler added to set the suggestion channel."
    }
    note for ConfigSetLogChannel "Modified to include a UI ChannelSelect dropdown for configuring the suggestion log channel."

    ConfigSetLogChannel --|> discord.ui.View
    ConfigSetLogChannel ..> GuildConfigController : uses (via self.db)

Class Diagram: Updates to `DatabaseController` and `Tux` Bot for Suggestions

classDiagram
    class DatabaseController {
        <<Existing Controller Aggregator>>
        +note: NoteController
        +reminder: ReminderController
        +snippet: SnippetController
        +guild: GuildController
        +guild_config: GuildConfigController
        +suggestion: SuggestionController
        note for suggestion "New SuggestionController instance added for suggestion data management."
        +__init__()
    }
    note for DatabaseController "Modified to integrate the new SuggestionController."

    class Tux {
        <<Bot Class>>
        %% Other attributes and methods
        +on_ready() void
        note for on_ready "Modified to add ButtonView persistently using self.add_view(). This is a step towards button persistence on restart."
    }
    note for Tux "Bot class updated to register the new ButtonView for suggestions."

    Tux --|> discord.ext.commands.Bot
    DatabaseController ..> SuggestionController : aggregates
    Tux ..> ButtonView : registers globally

File-Level Changes

Change	Details	Files
Add suggestion channel configuration support	Extend guild_config mapping with suggestion_log_id Implement get_suggestion_log_channel and update_suggestion_log_id methods Add ChannelSelect UI to set suggestion log channel	`tux/database/controllers/guild_config.py` `tux/ui/views/config.py`
Register persistent suggestion button view on bot startup	Import ButtonView in the bot entrypoint Call add_view for ButtonView in on_ready	`tux/bot.py`
Implement suggestion modal and interactive button view	Create SuggestionModal to collect title and description Query configured channel, send embed with Under Review status Attach reactions and start a thread on the message Define ButtonView with Accept/Deny buttons and PL-level permission checks	`tux/ui/modals/suggestion.py`
Add SuggestionController for database operations	Implement ensure_guild_exists to upsert guild records Implement create_suggestion to record suggestions	`tux/database/controllers/suggestion.py`
Add slash command Cog for suggestions	Create Suggestion Cog with /suggest command Send SuggestionModal on command invocation	`tux/cogs/misc/suggestions.py`

Possibly linked issues

#1: Implements the /suggest command, adding channel posting, reactions, admin buttons, and discussion threads as requested.

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

anemoijereja-eden · 2025-06-20T17:13:31Z

will need rewrites following completion of #853

anemoijereja-eden · 2025-06-23T01:03:45Z

tux/bot.py

does this need to be in bot.py?

anemoijereja-eden · 2025-06-23T01:06:23Z

tux/database/controllers/guild_config.py

@@ -116,7 +117,10 @@ async def get_private_log_id(self, guild_id: int) -> int | None:
    async def get_report_log_id(self, guild_id: int) -> int | None:
        return await self.get_guild_config_field_value(guild_id, "report_log_id")

-    async def get_dev_log_id(self, guild_id: int) -> int | None:


is this rename necessary?

anemoijereja-eden · 2025-06-23T01:09:00Z

tux/database/controllers/suggestion.py

+from tux.database.client import db
+
+
+class SuggestionController:


This controller should probably have a method for retrieving suggestions and maybe even searching them.
create_suggestion should be an upsert method, rather than a pure insert.

anemoijereja-eden · 2025-06-23T01:11:35Z

tux/ui/modals/suggestion.py

+            auto_archive_duration=1440,
+        )
+
+        reactions = ["👍", "👎"]


Move this to constants file, or ideally make configurable.

Atmois added 8 commits August 13, 2024 00:09

Create suggestion command based on the reporting command

9b9e38c

Add buttons

7ab2de5

Create thread with every suggestion message

3007f7a

Edit buttonview class

b35c714

Merge remote-tracking branch 'origin/main' into suggestioncmd

e62938e

Merge remote-tracking branch 'origin/main' into suggestioncmd

3d2c45e

Add in the controller and db model for suggest command, to be finishe…

c6167a9

…d by kaizen

Merge remote-tracking branch 'origin/main' into suggestioncmd

6d0cd26

Atmois requested a review from electron271 May 18, 2025 08:43

Atmois assigned electron271 May 18, 2025

Atmois linked an issue May 18, 2025 that may be closed by this pull request

/suggest command #391

Closed

anemoijereja-eden requested changes Jun 23, 2025

View reviewed changes

anemoijereja-eden added the status: waiting for db migration changes require extensive use of the database system label Jun 23, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Suggestion Command Draft PR #869

Suggestion Command Draft PR #869

Uh oh!

Atmois commented May 18, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented May 18, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

anemoijereja-eden commented Jun 20, 2025

Uh oh!

anemoijereja-eden Jun 23, 2025

Uh oh!

anemoijereja-eden Jun 23, 2025

Uh oh!

anemoijereja-eden Jun 23, 2025

Uh oh!

anemoijereja-eden Jun 23, 2025

Uh oh!

Uh oh!

		from tux.database.client import db


		class SuggestionController:

Uh oh!

Suggestion Command Draft PR #869

Are you sure you want to change the base?

Suggestion Command Draft PR #869

Uh oh!

Conversation

Atmois commented May 18, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Guidelines

Additional Information

Summary by Sourcery

Uh oh!

sourcery-ai bot commented May 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide

Sequence Diagram: Admin Reviewing a Suggestion

Class Diagram: New UI Components - SuggestionModal and ButtonView

Class Diagram: New Backend Components - Suggestion Cog and SuggestionController

Class Diagram: Updates to GuildConfigController for Suggestions

Class Diagram: Updates to ConfigSetLogChannel View for Suggestions

Class Diagram: Updates to DatabaseController and Tux Bot for Suggestions

File-Level Changes

Possibly linked issues

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

anemoijereja-eden commented Jun 20, 2025

Uh oh!

anemoijereja-eden Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

anemoijereja-eden Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

anemoijereja-eden Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

anemoijereja-eden Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Atmois commented May 18, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented May 18, 2025 •

edited

Loading

Class Diagram: New UI Components - `SuggestionModal` and `ButtonView`

Class Diagram: New Backend Components - `Suggestion` Cog and `SuggestionController`

Class Diagram: Updates to `GuildConfigController` for Suggestions

Class Diagram: Updates to `ConfigSetLogChannel` View for Suggestions

Class Diagram: Updates to `DatabaseController` and `Tux` Bot for Suggestions