Add snippet banning and unbanning #443

Atmois · 2024-08-22T12:15:06Z

Added two hybrid moderation commands, snippet ban {prefix}snippetban and snippet unban {prefix}snippetunban to prevent users from creating snippets. Both are registered as cases and have checks to ensure a snippet banned user isn't snippet banned again and vice versa. Requires Mod (Level 3) permissions to use.
Closes #439

…re executing the command

sourcery-ai · 2024-08-22T12:15:15Z

Reviewer's Guide by Sourcery

This pull request implements snippet banning and unbanning functionality for a Discord bot. It adds two new moderation commands, snippetban and snippetunban, which allow moderators to prevent users from creating snippets. The implementation includes new flag classes for command arguments, modifications to existing files to support the new functionality, and two new files for the snippet ban and unban commands. The changes also include updates to the case management system to handle these new moderation actions.

File-Level Changes

Files	Changes
`tux/utils/flags.py`	Added new flag classes `SnippetBanFlags` and `SnippetUnbanFlags` for handling command arguments
`tux/cogs/utility/snippets.py`	Implemented `is_snippetbanned` method to check if a user is currently snippet banned
`tux/cogs/utility/snippets.py`	Added snippet ban check in the `create_snippet` command to prevent banned users from creating snippets
`tux/cogs/moderation/cases.py`	Updated case management system to include new case types for snippet ban and unban
`tux/cogs/moderation/snippetban.py`	Created new `SnippetBan` cog with `snippet_ban` command and related functionality
`tux/cogs/moderation/snippetunban.py`	Created new `SnippetUnban` cog with `snippet_unban` command and related functionality

Tips

Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
Continue your discussion with Sourcery by replying directly to review comments.
You can change your review settings at any time by accessing your dashboard:
- Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
- Change the review language;
You can always contact us if you have any questions or feedback.

sourcery-ai

Hey @Atmois - I've reviewed your changes and they look great!

Here's what I looked at during the review

🟡 General issues: 4 issues found
🟢 Security: all looks good
🟢 Testing: all looks good
🟡 Complexity: 1 issue found
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

sourcery-ai · 2024-08-22T12:16:31Z

tux/utils/flags.py

    )
+
+
+class SnippetBanFlags(commands.FlagConverter, delimiter=" ", prefix="-"):


suggestion: Consider creating a base class for flag converters to reduce duplication

The SnippetBanFlags, SnippetUnbanFlags, and WarnFlags classes share similar structure. Consider creating a base class to reduce code duplication and improve maintainability.

class BaseFlags(commands.FlagConverter, delimiter=" ", prefix="-"): pass class SnippetBanFlags(BaseFlags):

sourcery-ai · 2024-08-22T12:16:31Z

tux/cogs/moderation/snippetban.py

+        await self.send_embed(ctx, embed, log_type="mod")
+        await ctx.send(embed=embed, delete_after=30, ephemeral=True)
+
+    async def is_snippetbanned(self, guild_id: int, user_id: int) -> bool:


suggestion: Move is_snippetbanned method to a common location to avoid duplication

This method is duplicated in both snippetban.py and snippetunban.py. Consider moving it to a shared utility module or base class to ensure consistency and reduce duplication.

from tux.utils.moderation import is_snippetbanned class SnippetBan(commands.Cog): # ... existing code ... @commands.command() async def snippetban(self, ctx, user: discord.Member): if await is_snippetbanned(self.case_controller, ctx.guild.id, user.id): # ... rest of the method

sourcery-ai · 2024-08-22T12:16:31Z

tux/cogs/moderation/snippetban.py

+        await self.send_dm(ctx, flags.silent, target, flags.reason, "Snippet Banned")
+        await self.handle_case_response(ctx, case, "created", flags.reason, target)
+
+    async def handle_case_response(


suggestion: Refactor shared functionality into a base class

The handle_case_response method and overall command structure are very similar in both snippetban.py and snippetunban.py. Consider creating a base class or utility functions to reduce code duplication and improve maintainability.

class SnippetModBase: async def handle_case_response( self, ctx: commands.Context[commands.Bot], case: Case, action: str, reason: str, target: discord.Member ) -> None: # Implementation here

sourcery-ai · 2024-08-22T12:16:31Z

tux/cogs/utility/snippets.py

            await ctx.send("This command cannot be used in direct messages.")
            return

+        if await self.is_snippetbanned(ctx.guild.id, ctx.author.id):


suggestion (performance): Consider optimizing the is_snippetbanned check

The current implementation of is_snippetbanned fetches all cases and then counts them. Consider optimizing this by using a more efficient database query to directly get the count or the latest status.

snippet_ban_status = await self.get_snippet_ban_status(ctx.guild.id, ctx.author.id) if snippet_ban_status: await ctx.send("You are banned from using snippets.") return

sourcery-ai · 2024-08-22T12:16:31Z

tux/cogs/utility/snippets.py

        self.config = DatabaseController().guild_config
+        self.case_controller = CaseController()
+
+    async def is_snippetbanned(self, guild_id: int, user_id: int) -> bool:


issue (complexity): Consider separating the user ban check into a utility function or service.

The new code introduces additional complexity due to the added dependencies on CaseController and CaseType, as well as the new is_snippetbanned method. This increases coupling and makes the code harder to maintain. To improve, consider separating the concern of checking if a user is banned into a utility function or service, which would keep the Snippets class focused on its primary responsibility. Additionally, if possible, simplify the logic for determining if a user is banned, perhaps by leveraging a method in CaseController that directly checks this status. This refactoring would enhance readability and maintainability.

sourcery-ai · 2024-08-22T12:16:32Z

tux/cogs/moderation/snippetban.py

+        unban_cases = await self.case_controller.get_all_cases_by_type(guild_id, CaseType.SNIPPETUNBAN)
+
+        ban_count = sum(1 for case in ban_cases if case.case_target_id == user_id)
+        unban_count = sum(1 for case in unban_cases if case.case_target_id == user_id)


suggestion (code-quality): Simplify constant sum() call (simplify-constant-sum)

Suggested change

unban_count = sum(1 for case in unban_cases if case.case_target_id == user_id)

unban_count = sum(bool(case.case_target_id == user_id)

Explanation
As sum add the values it treats True as 1, and False as 0. We make use
of this fact to simplify the generator expression inside the sum call.

sourcery-ai · 2024-08-22T12:16:32Z

tux/cogs/moderation/snippetunban.py

+        ban_cases = await self.case_controller.get_all_cases_by_type(guild_id, CaseType.SNIPPETBAN)
+        unban_cases = await self.case_controller.get_all_cases_by_type(guild_id, CaseType.SNIPPETUNBAN)
+
+        ban_count = sum(1 for case in ban_cases if case.case_target_id == user_id)


suggestion (code-quality): Simplify constant sum() call (simplify-constant-sum)

Suggested change

ban_count = sum(1 for case in ban_cases if case.case_target_id == user_id)

ban_count = sum(bool(case.case_target_id == user_id)

Explanation
As sum add the values it treats True as 1, and False as 0. We make use
of this fact to simplify the generator expression inside the sum call.

sourcery-ai · 2024-08-22T12:16:32Z

tux/cogs/moderation/snippetunban.py

+        unban_cases = await self.case_controller.get_all_cases_by_type(guild_id, CaseType.SNIPPETUNBAN)
+
+        ban_count = sum(1 for case in ban_cases if case.case_target_id == user_id)
+        unban_count = sum(1 for case in unban_cases if case.case_target_id == user_id)


suggestion (code-quality): Simplify constant sum() call (simplify-constant-sum)

Suggested change

unban_count = sum(1 for case in unban_cases if case.case_target_id == user_id)

unban_count = sum(bool(case.case_target_id == user_id)

Explanation
As sum add the values it treats True as 1, and False as 0. We make use
of this fact to simplify the generator expression inside the sum call.

sourcery-ai · 2024-08-22T12:16:32Z

tux/cogs/utility/snippets.py

+        ban_cases = await self.case_controller.get_all_cases_by_type(guild_id, CaseType.SNIPPETBAN)
+        unban_cases = await self.case_controller.get_all_cases_by_type(guild_id, CaseType.SNIPPETUNBAN)
+
+        ban_count = sum(1 for case in ban_cases if case.case_target_id == user_id)


suggestion (code-quality): Simplify constant sum() call (simplify-constant-sum)

Suggested change

ban_count = sum(1 for case in ban_cases if case.case_target_id == user_id)

ban_count = sum(bool(case.case_target_id == user_id)

Explanation
As sum add the values it treats True as 1, and False as 0. We make use
of this fact to simplify the generator expression inside the sum call.

sourcery-ai · 2024-08-22T12:16:32Z

tux/cogs/utility/snippets.py

+        unban_cases = await self.case_controller.get_all_cases_by_type(guild_id, CaseType.SNIPPETUNBAN)
+
+        ban_count = sum(1 for case in ban_cases if case.case_target_id == user_id)
+        unban_count = sum(1 for case in unban_cases if case.case_target_id == user_id)


suggestion (code-quality): Simplify constant sum() call (simplify-constant-sum)

Suggested change

unban_count = sum(1 for case in unban_cases if case.case_target_id == user_id)

unban_count = sum(bool(case.case_target_id == user_id)

Explanation
As sum add the values it treats True as 1, and False as 0. We make use
of this fact to simplify the generator expression inside the sum call.

sentry · 2024-08-24T08:03:35Z

Suspect Issues

This pull request was deployed and Sentry observed the following issues:

‼️ DataError: Error occurred during query execution: tux.database.controllers.case in get_all_cases_... View Issue

_{Did you find this useful? React with a 👍 or 👎}

Atmois added 8 commits August 21, 2024 11:43

make the base of the logic for the snippet bans

3bad160

revert change to implement it differently

727adfd

add snippet ban as a moderation command

e3266a8

add check if user is already snippet banned

8b8138e

add check if user is snippet banned

6af7576

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

b737ea6

Add checks to ensure that user is not snippet banned or unbanned befo…

61ce0b3

…re executing the command

Add snippet unban

b3acb6d

Atmois added category: commands type: feature-request status: approved priority: high labels Aug 22, 2024

Atmois requested a review from kzndotsh August 22, 2024 12:15

Atmois self-assigned this Aug 22, 2024

sourcery-ai bot reviewed Aug 22, 2024

View reviewed changes

kzndotsh merged commit fdd2360 into main Aug 23, 2024

kzndotsh deleted the snippetban branch August 23, 2024 16:23

		)


		class SnippetBanFlags(commands.FlagConverter, delimiter=" ", prefix="-"):

	unban_count = sum(1 for case in unban_cases if case.case_target_id == user_id)
	unban_count = sum(bool(case.case_target_id == user_id)

	ban_count = sum(1 for case in ban_cases if case.case_target_id == user_id)
	ban_count = sum(bool(case.case_target_id == user_id)

Uh oh!

Add snippet banning and unbanning #443

Add snippet banning and unbanning #443

Uh oh!

Conversation

Atmois commented Aug 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sourcery-ai bot commented Aug 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide by Sourcery

File-Level Changes

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Aug 22, 2024

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Aug 22, 2024

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Aug 22, 2024

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Aug 22, 2024

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Aug 22, 2024

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Aug 22, 2024

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Aug 22, 2024

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Aug 22, 2024

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Aug 22, 2024

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Aug 22, 2024

Choose a reason for hiding this comment

Uh oh!

sentry bot commented Aug 24, 2024

Suspect Issues

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Atmois commented Aug 22, 2024 •

edited

Loading

sourcery-ai bot commented Aug 22, 2024 •

edited

Loading