Skip to content

fix(afk): make afk command responses ephemeral #847

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 1 commit into
base: main
Choose a base branch
from

Conversation

thanosengine
Copy link
Collaborator

@thanosengine thanosengine commented May 7, 2025

Description

updated response messages in the afk cog to include ephemeral=True, so that when invoked as a slash command the messages do not appear to other members

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)

Please describe how you tested your code. e.g describe what commands you ran, what arguments, and any config stuff (if applicable)

Screenshots (if applicable)

Please add screenshots to help explain your changes.

Additional Information

Please add any other information that is important to this PR.

Summary by Sourcery

Update AFK command responses to be ephemeral when used as slash commands

Bug Fixes:

  • Made AFK command responses ephemeral to prevent visibility to other members

Enhancements:

  • Modified ctx.send() and ctx.reply() methods to include ephemeral=True parameter

Copy link

trunk-io bot commented May 7, 2025

⏱️ 4m total CI duration on this PR

Job Cumulative Duration Recent Runs
docker 2m 🟩
Analyze (python) 1m 🟩
Analyze (actions) 43s 🟩
pyright 37s 🟩
Ruff 21s 🟩

settingsfeedbackdocs ⋅ learn more about trunk.io

Copy link
Contributor

sourcery-ai bot commented May 7, 2025

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

Copy link

Deploying tux with  Cloudflare Pages  Cloudflare Pages

Latest commit: b358a9c
Status: ✅  Deploy successful!
Preview URL: https://06dac903.tux-afh.pages.dev
Branch Preview URL: https://afk-ephemeral.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 @thanosengine - I've reviewed your changes - here's some feedback:

  • Consider ensuring a consistent response style (e.g., ctx.send vs ctx.reply, and resulting ping behavior for prefix commands) for similar confirmation messages across the AFK commands, such as the confirmations for setting afk and permafk.
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant