Skip to content

feat(snippets): change snippet command behavior #875

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

Merged
merged 4 commits into from
Jun 1, 2025

Conversation

CapnRyna
Copy link
Contributor

@CapnRyna CapnRyna commented May 30, 2025

Description

resolves #870 and changes snippet behavior to reply to the command

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)

locally hosted and tested in ATL's dev server

Summary by Sourcery

Enhancements:

  • Change snippet command to reply to the invoking or referenced message instead of sending a standalone message.

Copy link
Contributor

sourcery-ai bot commented May 30, 2025

Reviewer's Guide

Modified the snippet command to reply contextually rather than broadcasting via ctx.send: it inspects message references and uses Message.reply or ctx.reply accordingly, preserving allowed_mentions and falling back if no reference exists.

Sequence Diagram: Snippet Command Reply Behavior

sequenceDiagram
    actor User
    participant Bot

    User->>Bot: Executes snippet command (e.g., /snippet name)
    activate Bot
    Bot->>Bot: Retrieves snippet text
    alt Command is a reply to an existing message
        participant RepliedMessage as "Message User Replied To"
        Bot->>Bot: Detects command is a reply to RepliedMessage
        Bot->>Bot: resolved_reference = RepliedMessage
        Bot-->>RepliedMessage: reply(snippet_text)
    else Command is not a reply or reference is not a message
        participant CommandMessage as "User's Command Message"
        Bot->>Bot: No valid message reference found
        Bot-->>CommandMessage: reply(snippet_text) to user's command
    end
    deactivate Bot
Loading

File-Level Changes

Change Details Files
Replace generic send with contextual reply logic
  • Removed direct ctx.send invocation
  • Added check for ctx.message.reference and its resolved target
  • Branch to reply to the referenced message if it’s a Message
  • Fallback to ctx.reply when no valid reference is present
tux/cogs/snippets/get_snippet.py

Assessment against linked issues

Issue Objective Addressed Explanation
#870 When a snippet command is invoked as a reply to a message, the snippet response should also reply to that message.

Possibly linked issues


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
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 @CapnRyna - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 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.

Copy link
Contributor

@HikariNee HikariNee left a comment

Choose a reason for hiding this comment

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

Looks good.

@jakobdylanc
Copy link
Contributor

jakobdylanc commented Jun 1, 2025

# pagination if text > 2000 characters
if len(text) <= 2000:
# Check if there is a message being replied to
if ctx.message.reference and ctx.message.reference.resolved:
reference = ctx.message.reference.resolved
if isinstance(reference, Message):
await reference.reply(text, allowed_mentions=AllowedMentions.none())
else:
await ctx.reply(text, allowed_mentions=AllowedMentions.none())
else:
await ctx.reply(text, allowed_mentions=AllowedMentions.none())
return

This can be simplified to just:

# pagination if text > 2000 characters
if len(text) <= 2000:
    # Check if there is a message being replied to
    reference = getattr(ctx.message.reference, "resolved", None)
    reply_target = reference if isinstance(reference, Message) else ctx

    await reply_target.reply(text, allowed_mentions=AllowedMentions.none())
    return

@anemoijereja-eden
Copy link
Collaborator

Looks great, appreciate the improvements.

@anemoijereja-eden anemoijereja-eden merged commit 43c1e05 into allthingslinux:main Jun 1, 2025
3 of 4 checks passed
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.

[FEATURE] - Add reply to snippets
4 participants