Home Original page

fix(afk): make afk command responses ephemeral by anemoijereja-eden · Pull Request #847 · allthingslinux/tux

Reviewer's Guide

This pull request updates the afk and permafk commands in the afk cog to send ephemeral responses. This ensures that when these commands are invoked (e.g., as slash commands), their confirmation messages are only visible to the user who executed the command, preventing chat clutter for other server members.

Sequence Diagram: afk Command Ephemeral Response

sequenceDiagram
    actor User
    participant Bot as AFK Cog
    User->>Bot: Executes /afk command (e.g., /afk Meeting)
    Bot-->>User: Replies with ephemeral "You are now afk! Reason: Meeting" message
    Note right of Bot: Message only visible to the User who invoked the command.
Loading

Sequence Diagram: permafk Command Ephemeral Responses

sequenceDiagram
    actor User
    participant Bot as AFK Cog

    alt User sets permanent AFK status
        User->>Bot: Executes /permafk command (e.g., /permafk Vacation)
        Bot-->>User: Replies with ephemeral "You are now permanently afk! Reason: Vacation" message
        Note right of Bot: Message only visible to the User who invoked the command.
    else User removes permanent AFK status (when already permafk)
        User->>Bot: Executes /permafk command
        Bot-->>User: Replies with ephemeral "Welcome back!" message
        Note right of Bot: Message only visible to the User who invoked the command.
    end
Loading

Class Diagram: Updates to AFK Cog for Ephemeral Responses

classDiagram
    class AFK {
        <<Cog>>
        +afk(ctx, target, reason)
        +permafk(ctx, reason)
        # Other methods like on_message not directly changed by this PR's core logic
    }
    note for AFK "The `afk` and `permafk` command methods were updated to send ephemeral responses.\nThis means confirmation messages are only visible to the user who invoked the command."
Loading

File-Level Changes

Change Details Files
Made response messages ephemeral for afk and permafk commands.
  • Modified the afk command to use ctx.reply with ephemeral=True for its response.
  • Updated the permafk command to send its "Welcome back!" message with ephemeral=True.
  • Updated the permafk command to send its confirmation message with ephemeral=True.
 tux/cogs/utility/afk.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