Add mention decorator for GitHub command handling #90

joshuadavidthomas · 2025-06-19T04:01:45Z

closes #15

Updates the kwarg passed to mention handlers from "mention" to "context" to better reflect that it contains a MentionContext object with comment, triggered_by, and scope fields. Also removes unused _mention_permission attribute from MentionHandlerBase protocol. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>

…ngo-github-app into gh-command

for more information, see https://pre-commit.ci

Copilot

Pull Request Overview

This PR introduces a new mention decorator for handling GitHub event routing based on @-mentions in comments. The decorator allows filtering handlers by username patterns and event scopes (issues, PRs, or commits).

Adds comprehensive mention extraction and parsing functionality with ReDoS protection
Introduces a new @router.mention() decorator that automatically triggers handlers when users are mentioned
Provides extensive test coverage for the mention system across different event types and scenarios

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
`src/django_github_app/mentions.py`	New module implementing mention extraction, parsing, and scope detection
`src/django_github_app/routing.py`	Extended GitHubRouter with mention decorator functionality
`tests/test_mentions.py`	Comprehensive test suite for mention functionality
`tests/test_routing.py`	Tests for the mention decorator integration
`tests/conftest.py`	Enhanced test fixtures with async mock support
`tests/test_models.py`	Fixed fixture usage in async test
`tests/settings.py`	Added timezone configuration

Comments suppressed due to low confidence (1)

tests/test_routing.py:158

The test case uses a regex pattern that matches usernames ending with '-bot', but the expected count is 2 while the comment contains '@deploy-bot', '@Test-bot', and '@user'. The '@user' should not match the pattern, so the count should be correct, but this test doesn't verify that '@user' is actually excluded - only that the total count is 2.

            (re.compile(r".*-bot"), "@deploy-bot start @test-bot check @user help", 2),

Copilot · 2025-07-25T16:22:59Z

tests/test_mentions.py

+        mentions = list(Mention.from_event(event, username=username, scope=scope))
+
+        assert len(mentions) == expected_count
+        for mention, expected in zip(mentions, expected_mentions, strict=False):


Using strict=False in the zip operation could mask bugs where the lengths of mentions and expected_mentions don't match. Since the test already asserts len(mentions) == expected_count on line 680, using strict=True would be safer to catch any inconsistencies.

for more information, see https://pre-commit.ci

…ngo-github-app into gh-command

for more information, see https://pre-commit.ci

joshuadavidthomas had a problem deploying to integration June 19, 2025 04:01 — with GitHub Actions Failure

pre-commit-ci bot had a problem deploying to integration June 19, 2025 04:03 Failure

joshuadavidthomas had a problem deploying to integration June 19, 2025 16:51 — with GitHub Actions Error

pre-commit-ci bot had a problem deploying to integration June 19, 2025 16:52 Failure

joshuadavidthomas had a problem deploying to integration June 19, 2025 17:03 — with GitHub Actions Failure

joshuadavidthomas force-pushed the gh-command branch from f258928 to aac1884 Compare June 19, 2025 23:07

joshuadavidthomas had a problem deploying to integration June 19, 2025 23:07 — with GitHub Actions Failure

joshuadavidthomas temporarily deployed to integration June 19, 2025 23:09 — with GitHub Actions Inactive

joshuadavidthomas had a problem deploying to integration June 19, 2025 23:21 — with GitHub Actions Failure

joshuadavidthomas had a problem deploying to integration June 19, 2025 23:28 — with GitHub Actions Failure

joshuadavidthomas had a problem deploying to integration June 19, 2025 23:31 — with GitHub Actions Failure

joshuadavidthomas temporarily deployed to integration June 20, 2025 19:35 — with GitHub Actions Inactive

pre-commit-ci bot temporarily deployed to integration June 20, 2025 19:38 Inactive

joshuadavidthomas temporarily deployed to integration June 23, 2025 21:13 — with GitHub Actions Inactive

joshuadavidthomas requested a review from Copilot July 25, 2025 15:24

This comment was marked as outdated.

Sign in to view

joshuadavidthomas temporarily deployed to integration July 25, 2025 16:08 — with GitHub Actions Inactive

joshuadavidthomas mentioned this pull request Jul 25, 2025

Consider duplicating sync/async code vs relying on async_to_sync from asgiref #96

Open

joshuadavidthomas and others added 12 commits July 25, 2025 11:14

Add mention decorator for GitHub command handling

9b14143

Add mention parsing and command extraction logic

d09b071

Add scope validation to mention decorator

e4406a4

Refactor check_event functions to accept sansio.Event

fdb03f3

Rename commands module to mentions and CommandScope to MentionScope

82e07d0

Add GitHub permission checking utilities

25b2338

Integrate permission checking into mention decorator

0175403

Refactor mention decorator from gatekeeper to enrichment pattern

0577ecd

Refactor mention system to use explicit re.Pattern API

27dba6c

Simplify permission checking and remove optional return types

f139a7e

Strip mention system down to core functionality

b2b6a2d

joshuadavidthomas and others added 10 commits July 25, 2025 11:14

Use app settings SLUG as default mention pattern

1785cfc

Merge branch 'gh-command' of https://github.com/joshuadavidthomas/dja…

24465f8

…ngo-github-app into gh-command

Replace manual event creation with consolidated create_event fixture

1511264

Refactor tests to use faker and reduce manual field setting

f2e1b24

Remove unused mention handler attributes from routing decorator

623e7e8

Clean up comments and formatting

ecd9f52

adjust and refactor test suite for mentions

3fe197d

[pre-commit.ci] auto fixes from pre-commit.com hooks

3212976

for more information, see https://pre-commit.ci

Simplify mention parsing and remove text extraction

f85a6f5

update sync version of mock_github_api client

d396bd7

joshuadavidthomas force-pushed the gh-command branch from fca9488 to d396bd7 Compare July 25, 2025 16:15

joshuadavidthomas temporarily deployed to integration July 25, 2025 16:15 — with GitHub Actions Inactive

joshuadavidthomas requested a review from Copilot July 25, 2025 16:22

Copilot AI reviewed Jul 25, 2025

View reviewed changes

joshuadavidthomas added 2 commits July 25, 2025 13:17

update README documentation for new feature

c250a4a

update changelog

71249f5

joshuadavidthomas had a problem deploying to integration July 25, 2025 18:18 — with GitHub Actions Error

[pre-commit.ci] auto fixes from pre-commit.com hooks

d3a8bab

for more information, see https://pre-commit.ci

pre-commit-ci bot temporarily deployed to integration July 25, 2025 18:19 Inactive

joshuadavidthomas added 2 commits July 25, 2025 13:22

blacken and lint readme

28e6c66

Merge branch 'gh-command' of https://github.com/joshuadavidthomas/dja…

1e10d7a

…ngo-github-app into gh-command

joshuadavidthomas had a problem deploying to integration July 25, 2025 18:22 — with GitHub Actions Error

[pre-commit.ci] auto fixes from pre-commit.com hooks

e2fe6a4

for more information, see https://pre-commit.ci

pre-commit-ci bot temporarily deployed to integration July 25, 2025 18:23 Inactive

joshuadavidthomas marked this pull request as ready for review July 25, 2025 18:23

tweak

3554ad4

joshuadavidthomas temporarily deployed to integration July 25, 2025 19:00 — with GitHub Actions Inactive

joshuadavidthomas merged commit 01e2bcf into main Jul 25, 2025
21 checks passed

joshuadavidthomas deleted the gh-command branch July 25, 2025 19:03

joshuadavidthomas mentioned this pull request Jul 25, 2025

🔖 bump version 0.7.0 -> 0.8.0 #98

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Add mention decorator for GitHub command handling #90

Add mention decorator for GitHub command handling #90

Uh oh!

joshuadavidthomas commented Jun 19, 2025 •

edited

Loading

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 25, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Add mention decorator for GitHub command handling #90

Add mention decorator for GitHub command handling #90

Uh oh!

Conversation

joshuadavidthomas commented Jun 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

joshuadavidthomas commented Jun 19, 2025 •

edited

Loading