Skip to content

Jail/unjail fix #888

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Jail/unjail fix #888

wants to merge 2 commits into from

Conversation

RainzDev
Copy link

@RainzDev RainzDev commented Jun 5, 2025

Description

There was a problem with Tux where the jail command would add and remove the jail role from the member once ran and the unjail command having the similar issue as well. The fix had to do with caching and enabling atomic for remove_roles and add_roles.

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.

How Has This Been Tested? (if applicable)

Ran the jail/unjail slash command from one of Tux dev bots.

Screenshots (if applicable)

N/A

Additional Information

N/A

Summary by Sourcery

Bug Fixes:

  • Remove atomic=False from remove_roles in jail command and add_roles in unjail command to enforce atomic role modifications and fix jail/unjail role assignment issues

Copy link
Contributor

sourcery-ai bot commented Jun 5, 2025

Reviewer's Guide

This PR fixes issues in the jail and unjail slash commands by removing the explicit atomic=False flag on role operations, enabling default atomic behavior to ensure all role additions/removals succeed as a single operation.

Sequence Diagram: Updated Unjail Process with Atomic Role Restoration

sequenceDiagram
    actor Moderator
    participant Bot
    participant DiscordAPI

    Moderator->>Bot: /unjail [member, reason]
    Bot->>Bot: Identify Jail Role to remove
    Bot->>DiscordAPI: remove_roles(member, JailRole, reason)
    DiscordAPI-->>Bot: Jail Role removed
    Bot->>Bot: Identify member's roles to restore (roles_to_restore)
    Bot->>DiscordAPI: add_roles(member, roles_to_restore, reason) [Atomic]
    DiscordAPI-->>Bot: Roles restored (all or none)
    Bot-->>Moderator: Confirmation of unjailing
Loading

File-Level Changes

Change Details Files
Enable atomic role removal in jail command
  • Removed atomic=False argument from the member.remove_roles call
tux/cogs/moderation/jail.py
Enable atomic role addition in unjail command
  • Removed atomic=False argument from the member.add_roles call
tux/cogs/moderation/unjail.py

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

Copy link

Deploying tux with  Cloudflare Pages  Cloudflare Pages

Latest commit: 03cdd0c
Status: ✅  Deploy successful!
Preview URL: https://933a59a4.tux-afh.pages.dev
Branch Preview URL: https://jail-unjail-fix.tux-afh.pages.dev

View logs

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 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 and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant