feat(command): allow irc users to use snippet command #990

Ow0cast · 2025-07-31T21:37:37Z

Description

Allows users from the IRC to run snippet command via the bridge

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)

Created webhook in test server and ran snippet command and help command. only snippet command worked

Screenshots (if applicable)

Please add screenshots to help explain your changes.

Additional Information

Please add any other information that is important to this PR.
context as to why its only the snippet command: https://discord.com/channels/1184229800332771328/1273687471732949085/1400580384105955338

Summary by Sourcery

Enable the snippet command for users messaging through an IRC bridge by whitelisting specific webhook IDs and adding the corresponding configuration option.

New Features:

Allow IRC-bridged messages to invoke the snippet command

Enhancements:

Add BRIDGE_WEBHOOK_IDS configuration for IRC bridge webhooks

Documentation:

Update example settings.yml with IRC BRIDGE_WEBHOOK_IDS

sourcery-ai · 2025-07-31T21:37:42Z

Reviewer's Guide

Introduces support for the IRC bridge to trigger only the snippet command by detecting webhook messages, invoking the bot’s context, and exposing a new bridge webhook ID configuration.

Sequence diagram for IRC bridge triggering the snippet command

sequenceDiagram
    participant IRC_User as actor IRC User
    participant IRC_Bridge as IRC Bridge (Webhook)
    participant Discord as Discord Server
    participant Bot as Bot
    participant Handler as Event Handler

    IRC_User->>IRC_Bridge: Send snippet command
    IRC_Bridge->>Discord: Post message via webhook
    Discord->>Handler: on_message(message)
    Handler->>Handler: Check if webhook_id in BRIDGE_WEBHOOK_IDS
    Handler->>Handler: Check if message is snippet command
    Handler->>Bot: get_context(message)
    Handler->>Bot: invoke(ctx)
    Bot->>Discord: Execute snippet command

Class diagram for updated Config structure with IRC bridge support

classDiagram
    class Config {
        +BOT_TOKEN: str
        +LIMIT_TO_ROLE_IDS: bool
        +ACCESS_ROLE_IDS: list[int]
        +BRIDGE_WEBHOOK_IDS: list[int]
    }

    class CONFIG {
        <<instance of Config>>
    }

    CONFIG --|> Config

File-Level Changes

Change	Details	Files
Enable snippet command invocation for IRC bridge webhooks	Add conditional in on_message listener to detect messages from configured bridge webhooks Check for commands starting with default prefix 's ' or 'snippet ' Retrieve and invoke the command context for matching messages	`tux/handlers/event.py`
Add and document IRC bridge webhook ID configuration	Introduce BRIDGE_WEBHOOK_IDS in the Config class to load from settings Update example settings file to include IRC.BRIDGE_WEBHOOK_IDS section	`tux/utils/config.py` `config/settings.yml.example`

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

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

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

Prompt for AI Agents

Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `tux/utils/config.py:156` </location>
<code_context>
     ACCESS_ROLE_IDS: Final[list[int]] = config["SNIPPETS"]["ACCESS_ROLE_IDS"]

+    # IRC Bridges
+    BRIDGE_WEBHOOK_IDS: Final[list[int]] = config["IRC"]["BRIDGE_WEBHOOK_IDS"]
+

</code_context>

<issue_to_address>
Type of BRIDGE_WEBHOOK_IDS may not be enforced at runtime.

If BRIDGE_WEBHOOK_IDS is loaded as strings, comparisons to integers may fail. Normalize to int when loading the config to avoid subtle bugs.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
    BRIDGE_WEBHOOK_IDS: Final[list[int]] = config["IRC"]["BRIDGE_WEBHOOK_IDS"]
=======
    BRIDGE_WEBHOOK_IDS: Final[list[int]] = [int(x) for x in config["IRC"]["BRIDGE_WEBHOOK_IDS"]]
>>>>>>> REPLACE

</suggested_fix>

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.}

tux/utils/config.py

meatharvester · 2025-07-31T22:07:01Z

tested it myself looks like everything is working as intended

electron271

fix tests and clarify settings.yml.example

# If you do not have an IRC bridge running, ignore these options
# Allows messages from these webhooks to use only the $s and $snippet commands
IRC:
  BRIDGE_WEBHOOK_IDS:
    - 123456789012345679
    - 123456789012345679
    - 123456789012345679

codecov · 2025-08-03T00:33:54Z

❌ 1 Tests Failed:

Tests completed	Failed	Passed	Skipped
240	1	239	2

View the top 1 failed test(s) by shortest run time

tests/unit/test_main.py::TestMainIntegration::test_module_can_be_executed_as_script

Stack Traces | 0.899s run time

self = <tests.unit.test_main.TestMainIntegration object at 0x7f5f87630640>

    @pytest.mark.slow
    def test_module_can_be_executed_as_script(self) -> None:
        """Test that the module can actually be executed as a Python script."""
        # This is a real integration test that actually tries to run the module
        # We mock the TuxApp to prevent the bot from starting
    
        # Create a temporary script that imports and patches TuxApp
    
        test_script = textwrap.dedent("""
            import sys
            from unittest.mock import Mock, patch
    
            # Add the project root to the path
            sys.path.insert(0, "{project_root}")
    
            # Mock the config loading before importing tux.main to prevent FileNotFoundError in CI
            # We need to mock the file reading operations that happen at module import time
            with patch("pathlib.Path.read_text") as mock_read_text:
                # Mock the YAML content that would be read from config files
                mock_config_content = '''
                USER_IDS:
                  BOT_OWNER: 123456789
                  SYSADMINS: [123456789]
                ALLOW_SYSADMINS_EVAL: false
                BOT_INFO:
                  BOT_NAME: "Test Bot"
                  PROD_PREFIX: "!"
                  DEV_PREFIX: "??"
                  ACTIVITIES: "Testing"
                  HIDE_BOT_OWNER: false
                STATUS_ROLES: []
                TEMPVC_CATEGORY_ID: null
                TEMPVC_CHANNEL_ID: null
                GIF_LIMITER:
                  RECENT_GIF_AGE: 3600
                  GIF_LIMIT_EXCLUDE: []
                  GIF_LIMITS_USER: {{}}
                  GIF_LIMITS_CHANNEL: {{}}
                XP:
                  XP_BLACKLIST_CHANNELS: []
                  XP_ROLES: []
                  XP_MULTIPLIERS: []
                  XP_COOLDOWN: 60
                  LEVELS_EXPONENT: 2
                  SHOW_XP_PROGRESS: false
                  ENABLE_XP_CAP: true
                SNIPPETS:
                  LIMIT_TO_ROLE_IDS: false
                  ACCESS_ROLE_IDS: []
                '''
                mock_read_text.return_value = mock_config_content
    
                with patch("tux.app.TuxApp") as mock_app:
                    mock_instance = Mock()
                    mock_app.return_value = mock_instance
    
                    # Import and run main
                    import tux.main
                    tux.main.run()
    
                    # Verify it was called
                    assert mock_app.called
                    assert mock_instance.run.called
                    print("SUCCESS: Module executed correctly")
        """)
    
        # Get the project root dynamically
        project_root = Path(__file__).parent.parent
        script_content = test_script.format(project_root=project_root)
    
        # Write and execute the test script
        with tempfile.NamedTemporaryFile(mode="w", suffix=".py", delete=False) as f:
            f.write(script_content)
            temp_script = f.name
    
        try:
            result = subprocess.run(
                [sys.executable, temp_script],
                capture_output=True,
                text=True,
                timeout=30,
                check=False,
            )
    
            # Check that the script executed successfully
>           assert result.returncode == 0, f"Script failed: {result.stderr}"
E           AssertionError: Script failed: Traceback (most recent call last):
E               File "/tmp/tmp1cwqt9mu.py", line 45, in <module>
E                 with patch("tux.app.TuxApp") as mock_app:
E                      ~~~~~^^^^^^^^^^^^^^^^^^
E               File ".../hostedtoolcache/Python/3.13.5................../x64/lib/python3.13/unittest/mock.py", line 1481, in __enter__
E                 self.target = self.getter()
E                               ~~~~~~~~~~~^^
E               File ".../hostedtoolcache/Python/3.13.5................../x64/lib/python3.13/pkgutil.py", line 518, in resolve_name
E                 mod = importlib.import_module(s)
E               File ".../hostedtoolcache/Python/3.13.5................../x64/lib/python3.13/importlib/__init__.py", line 88, in import_module
E                 return _bootstrap._gcd_import(name[level:], package, level)
E                        ~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
E               File "<frozen importlib._bootstrap>", line 1387, in _gcd_import
E               File "<frozen importlib._bootstrap>", line 1360, in _find_and_load
E               File "<frozen importlib._bootstrap>", line 1331, in _find_and_load_unlocked
E               File "<frozen importlib._bootstrap>", line 935, in _load_unlocked
E               File "<frozen importlib._bootstrap_external>", line 1026, in exec_module
E               File "<frozen importlib._bootstrap>", line 488, in _call_with_frames_removed
E               File ".../tux/tux/app.py", line 11, in <module>
E                 from tux.bot import Tux
E               File ".../tux/tux/bot.py", line 20, in <module>
E                 from tux.cog_loader import CogLoader
E               File ".../tux/tux/cog_loader.py", line 14, in <module>
E                 from tux.utils.config import CONFIG
E               File ".../tux/utils/config.py", line 55, in <module>
E                 class Config:
E                 ...<100 lines>...
E                     BRIDGE_WEBHOOK_IDS: Final[list[int]] = [int(x) for x in config["IRC"]["BRIDGE_WEBHOOK_IDS"]]
E               File ".../tux/utils/config.py", line 156, in Config
E                 BRIDGE_WEBHOOK_IDS: Final[list[int]] = [int(x) for x in config["IRC"]["BRIDGE_WEBHOOK_IDS"]]
E                                                                         ~~~~~~^^^^^^^
E             KeyError: 'IRC'
E             
E           assert 1 == 0
E            +  where 1 = CompletedProcess(args=['.../tux/tux/.venv/bin/python', '/tmp/tmp1cwqt9mu.py'], returncode=1, stdout='', stderr='Traceback (most recent call last):\n  File "/tmp/tmp1cwqt9mu.py", line 45, in <module>\n    with patch("tux.app.TuxApp") as mock_app:\n         ~~~~~^^^^^^^^^^^^^^^^^^\n  File ".../hostedtoolcache/Python/3.13.5................../x64/lib/python3.13/unittest/mock.py", line 1481, in __enter__\n    self.target = self.getter()\n                  ~~~~~~~~~~~^^\n  File ".../hostedtoolcache/Python/3.13.5................../x64/lib/python3.13/pkgutil.py", line 518, in resolve_name\n    mod = importlib.import_module(s)\n  File ".../hostedtoolcache/Python/3.13.5................../x64/lib/python3.13/importlib/__init__.py", line 88, in import_module\n    return _bootstrap._gcd_import(name[level:], package, level)\n           ~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n  File "<frozen importlib._bootstrap>", line 1387, in _gcd_import\n  File "<frozen importlib._bootstrap>", line 1360, in _find_and_load\n  File "<frozen importlib._bootstrap>", line 1331, in _find_and_load_unlocked\n  File "<frozen importlib._bootstrap>", line 935, in _load_unlocked\n  File "<frozen importlib._bootstrap_external>", line 1026, in exec_module\n  File "<frozen importlib._bootstrap>", line 488, in _call_with_frames_removed\n  File ".../tux/tux/app.py", line 11, in <module>\n    from tux.bot import Tux\n  File ".../tux/tux/bot.py", line 20, in <module>\n    from tux.cog_loader import CogLoader\n  File ".../tux/tux/cog_loader.py", line 14, in <module>\n    from tux.utils.config import CONFIG\n  File ".../tux/utils/config.py", line 55, in <module>\n    class Config:\n    ...<100 lines>...\n        BRIDGE_WEBHOOK_IDS: Final[list[int]] = [int(x) for x in config["IRC"]["BRIDGE_WEBHOOK_IDS"]]\n  File ".../tux/utils/config.py", line 156, in Config\n    BRIDGE_WEBHOOK_IDS: Final[list[int]] = [int(x) for x in config["IRC"]["BRIDGE_WEBHOOK_IDS"]]\n                                                            ~~~~~~^^^^^^^\nKeyError: \'IRC\'\n').returncode

tests/unit/test_main.py:279: AssertionError

To view more test analytics, go to the Test Analytics Dashboard
_{📋 Got 3 mins? Take this short survey to help us improve Test Analytics.}

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

sourcery-ai bot reviewed Jul 31, 2025

View reviewed changes

tux/utils/config.py Outdated Show resolved Hide resolved

electron271 requested changes Aug 3, 2025

View reviewed changes

Ow0cast and others added 4 commits August 2, 2025 20:35

feat(command): allow irc users to use snippet command

2d6aec2

Update tux/utils/config.py

a7cfb9d

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

Update settings.yml.example

9f4c5ed

Update test_main.py

804b26f

Ow0cast force-pushed the main branch from aec90c2 to 804b26f Compare August 3, 2025 00:35

Ow0cast requested a review from electron271 August 3, 2025 00:38

electron271 approved these changes Aug 3, 2025

View reviewed changes

electron271 merged commit c9c539e into allthingslinux:main Aug 3, 2025
35 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(command): allow irc users to use snippet command #990

feat(command): allow irc users to use snippet command #990

Uh oh!

Ow0cast commented Jul 31, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Jul 31, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

Uh oh!

meatharvester commented Jul 31, 2025

Uh oh!

electron271 left a comment

Uh oh!

codecov bot commented Aug 3, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

feat(command): allow irc users to use snippet command #990

feat(command): allow irc users to use snippet command #990

Uh oh!

Conversation

Ow0cast commented Jul 31, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Guidelines

How Has This Been Tested? (if applicable)

Screenshots (if applicable)

Additional Information

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Jul 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide

Sequence diagram for IRC bridge triggering the snippet command

Class diagram for updated Config structure with IRC bridge support

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

meatharvester commented Jul 31, 2025

Uh oh!

electron271 left a comment

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Aug 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

❌ 1 Tests Failed:

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Ow0cast commented Jul 31, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Jul 31, 2025 •

edited

Loading

codecov bot commented Aug 3, 2025 •

edited

Loading