remove auto detection of webhook type and use app settings (#36)

* remove auto detection of webhook type and use app settings

* ordering

* remove extra paren

* adjust test

Author: joshuadavidthomas

CHANGELOG.md

@@ -18,6 +18,14 @@ and this project attempts to adhere to [Semantic Versioning](https://semver.org/
 
 ## [Unreleased]
 
+### Added
+
+- Added `GITHUB_APP["WEBHOOK_TYPE"]` setting to configure async/sync handler selection.
+
+### Removed
+
+- Removed automatic detection of webhook type from URL configuration.
+
 ## [0.4.0]
 
 ### Added

README.md

@@ -75,6 +75,12 @@ Fully supports both sync (WSGI) and async (ASGI) Django applications.
    ]
    ```
 
+> [!IMPORTANT]
+> Make sure your `GITHUB_APP["WEBHOOK_TYPE"]` setting matches your view choice:
+>
+> - Use `"async"` with `AsyncWebhookView`
+> - Use `"sync"` with `SyncWebhookView`
+
 5. Setup your GitHub App, either by registering a new one or importing an existing one, and configure django-github-app using your GitHub App's information.
 
    You will need the following information from your GitHub App:
@@ -126,6 +132,7 @@ Fully supports both sync (WSGI) and async (ASGI) Django applications.
        "NAME": env.str("GITHUB_NAME"),
        "PRIVATE_KEY": env.str("GITHUB_PRIVATE_KEY"),
        "WEBHOOK_SECRET": env.str("GITHUB_WEBHOOK_SECRET"),
+       "WEBHOOK_TYPE": "async",  # Use "async" for ASGI projects or "sync" for WSGI projects
    }
    ```
 
@@ -162,6 +169,7 @@ Fully supports both sync (WSGI) and async (ASGI) Django applications.
        "NAME": env.str("GITHUB_NAME"),
        "PRIVATE_KEY": env.str("GITHUB_PRIVATE_KEY"),
        "WEBHOOK_SECRET": env.str("GITHUB_WEBHOOK_SECRET"),
+       "WEBHOOK_TYPE": "async",  # Use "async" for ASGI projects or "sync" for WSGI projects
    }
    ```
 
@@ -452,7 +460,7 @@ The library includes event handlers for managing GitHub App installations and re
 - Repository events:
   - `repository.renamed`: Updates repository details
 
-The library automatically detects whether you're using `AsyncWebhookView` or `SyncWebhookView` in your URL configuration and loads the corresponding async or sync versions of these handlers.
+The library loads either async or sync versions of these handlers based on your `GITHUB_APP["WEBHOOK_TYPE"]` setting.
 
 ### System Checks
 
@@ -482,6 +490,7 @@ GITHUB_APP = {
     "NAME": "",
     "PRIVATE_KEY": "",
     "WEBHOOK_SECRET": "",
+    "WEBHOOK_TYPE": "async",
 }
 ```
 
@@ -492,6 +501,7 @@ The following settings are required:
 - `NAME`
 - `PRIVATE_KEY`
 - `WEBHOOK_SECRET`
+- `WEBHOOK_TYPE`
 
 ### `APP_ID`
 
@@ -573,6 +583,15 @@ GITHUB_APP = {
 
 Secret used to verify webhook payloads from GitHub.
 
+### `WEBHOOK_TYPE`
+
+> 🔴 **Required** | `Literal["async", "sync"]` | Default: `"async"`
+
+Determines whether the library uses async or sync handlers for processing webhook events:
+
+- `"async"`: Use with `AsyncWebhookView` in ASGI projects
+- `"sync"`: Use with `SyncWebhookView` in WSGI projects
+
 ## Development
 
 For detailed instructions on setting up a development environment and contributing to this project, see [CONTRIBUTING.md](CONTRIBUTING.md).

src/django_github_app/apps.py

@@ -13,22 +13,9 @@ class GitHubAppConfig(AppConfig):
     @override
     def ready(self):
         from . import checks  # noqa: F401
+        from .conf import app_settings
 
-        try:
-            webhook_type = self.detect_webhook_type()
-            if webhook_type == "async":
-                from .events import ahandlers  # noqa: F401
-            elif webhook_type == "sync":
-                from .events import handlers  # noqa: F401
-        except (ImportError, ValueError):
-            pass
-
-    @classmethod
-    def detect_webhook_type(cls):
-        from .views import AsyncWebhookView
-        from .views import get_webhook_views
-
-        views = get_webhook_views()
-        if views:
-            return "async" if issubclass(views[0], AsyncWebhookView) else "sync"
-        return None
+        if app_settings.WEBHOOK_TYPE == "async":
+            from .events import ahandlers  # noqa: F401
+        elif app_settings.WEBHOOK_TYPE == "sync":
+            from .events import handlers  # noqa: F401

src/django_github_app/checks.py

@@ -3,9 +3,25 @@
 from django.core.checks import Error
 from django.core.checks import Tags
 from django.core.checks import register
+from django.urls import get_resolver
 
-from django_github_app.views import AsyncWebhookView
-from django_github_app.views import get_webhook_views
+from .views import AsyncWebhookView
+from .views import SyncWebhookView
+
+
+def get_webhook_views():
+    resolver = get_resolver()
+    found_views = []
+
+    for pattern in resolver.url_patterns:
+        if hasattr(pattern, "callback"):
+            callback = pattern.callback
+            view_class = getattr(callback, "view_class", None)
+            if view_class:
+                if issubclass(view_class, (AsyncWebhookView, SyncWebhookView)):
+                    found_views.append(view_class)
+
+    return found_views
 
 
 @register(Tags.urls)

src/django_github_app/conf.py

@@ -3,6 +3,7 @@
 from dataclasses import dataclass
 from pathlib import Path
 from typing import Any
+from typing import Literal
 
 from django.conf import settings
 from django.utils.text import slugify
@@ -21,6 +22,7 @@ class AppSettings:
     NAME: str = ""
     PRIVATE_KEY: str = ""
     WEBHOOK_SECRET: str = ""
+    WEBHOOK_TYPE: Literal["async", "sync"] = "async"
 
     @override
     def __getattribute__(self, __name: str) -> Any:

src/django_github_app/views.py

@@ -12,7 +12,6 @@
 from django.core.exceptions import BadRequest
 from django.http import HttpRequest
 from django.http import JsonResponse
-from django.urls import get_resolver
 from django.utils.decorators import method_decorator
 from django.views.decorators.csrf import csrf_exempt
 from django.views.generic import View
@@ -107,18 +106,3 @@ def post(self, request: HttpRequest) -> JsonResponse:  # pragma: no cover
             self.router.dispatch(event, gh)
 
         return self.get_response(event_log)
-
-
-def get_webhook_views():
-    resolver = get_resolver()
-    found_views = []
-
-    for pattern in resolver.url_patterns:
-        if hasattr(pattern, "callback"):
-            callback = pattern.callback
-            view_class = getattr(callback, "view_class", None)
-            if view_class:
-                if issubclass(view_class, (AsyncWebhookView, SyncWebhookView)):
-                    found_views.append(view_class)
-
-    return found_views

tests/test_apps.py

@@ -1,13 +1,8 @@
 from __future__ import annotations
 
-from unittest.mock import patch
-
 import pytest
-from django.views.generic import View
 
 from django_github_app.apps import GitHubAppConfig
-from django_github_app.views import AsyncWebhookView
-from django_github_app.views import SyncWebhookView
 
 
 class TestGitHubAppConfig:
@@ -16,34 +11,12 @@ def app(self):
         return GitHubAppConfig.create("django_github_app")
 
     @pytest.mark.parametrize(
-        "urls",
+        "webhook_type",
         [
-            [SyncWebhookView],
-            [AsyncWebhookView],
-            [View],
-            [],
+            "async",
+            "sync",
         ],
     )
-    def test_app_ready_urls(self, urls, app, urlpatterns):
-        with urlpatterns(urls):
-            app.ready()
-
-    @pytest.mark.parametrize("error", [ImportError, ValueError])
-    def test_app_ready_error(self, error, app):
-        with patch.object(GitHubAppConfig, "detect_webhook_type", side_effect=error):
+    def test_app_ready_urls(self, webhook_type, app, override_app_settings):
+        with override_app_settings(WEBHOOK_TYPE=webhook_type):
             app.ready()
-
-    @pytest.mark.parametrize(
-        "urls, expected",
-        [
-            ([SyncWebhookView], "sync"),
-            ([AsyncWebhookView], "async"),
-            ([View], None),
-            ([], None),
-        ],
-    )
-    def test_detect_webhook_type(self, urls, expected, urlpatterns):
-        with urlpatterns(urls):
-            webhook_type = GitHubAppConfig.detect_webhook_type()
-
-        assert webhook_type == expected

tests/test_checks.py

@@ -4,10 +4,47 @@
 from django.views.generic import View
 
 from django_github_app.checks import check_webhook_views
+from django_github_app.checks import get_webhook_views
 from django_github_app.views import AsyncWebhookView
 from django_github_app.views import SyncWebhookView
 
 
+class TestProjectWebhookViews:
+    def test_get_async(self, urlpatterns):
+        with urlpatterns([AsyncWebhookView]):
+            views = get_webhook_views()
+
+        assert len(views) == 1
+        assert views[0] == AsyncWebhookView
+
+    def test_get_sync(self, urlpatterns):
+        with urlpatterns([SyncWebhookView]):
+            views = get_webhook_views()
+
+        assert len(views) == 1
+        assert views[0] == SyncWebhookView
+
+    def test_get_both(self, urlpatterns):
+        with urlpatterns([AsyncWebhookView, SyncWebhookView]):
+            views = get_webhook_views()
+
+        assert len(views) == 2
+        assert AsyncWebhookView in views
+        assert SyncWebhookView in views
+
+    def test_get_normal_view(self, urlpatterns):
+        with urlpatterns([View]):
+            views = get_webhook_views()
+
+        assert len(views) == 0
+
+    def test_get_none(self, urlpatterns):
+        with urlpatterns([]):
+            views = get_webhook_views()
+
+        assert len(views) == 0
+
+
 class TestCheckWebhookViews:
     def test_async(self, urlpatterns):
         with urlpatterns([AsyncWebhookView]):

tests/test_conf.py

@@ -19,6 +19,7 @@
         ("NAME", ""),
         ("PRIVATE_KEY", ""),
         ("WEBHOOK_SECRET", ""),
+        ("WEBHOOK_TYPE", "async"),
     ],
 )
 def test_default_settings(setting, default_setting):

tests/test_views.py

@@ -10,7 +10,6 @@
 from django.core.exceptions import BadRequest
 from django.http import JsonResponse
 from django.utils import timezone
-from django.views.generic import View
 from gidgethub import sansio
 from gidgethub.abc import GitHubAPI
 from model_bakery import baker
@@ -22,7 +21,6 @@
 from django_github_app.views import AsyncWebhookView
 from django_github_app.views import BaseWebhookView
 from django_github_app.views import SyncWebhookView
-from django_github_app.views import get_webhook_views
 
 pytestmark = pytest.mark.django_db
 
@@ -305,39 +303,3 @@ def test_router_dispatch_unhandled_event(
         response = view.post(request)
 
         assert response.status_code == HTTPStatus.OK
-
-
-class TestProjectWebhookViews:
-    def test_get_async(self, urlpatterns):
-        with urlpatterns([AsyncWebhookView]):
-            views = get_webhook_views()
-
-        assert len(views) == 1
-        assert views[0] == AsyncWebhookView
-
-    def test_get_sync(self, urlpatterns):
-        with urlpatterns([SyncWebhookView]):
-            views = get_webhook_views()
-
-        assert len(views) == 1
-        assert views[0] == SyncWebhookView
-
-    def test_get_both(self, urlpatterns):
-        with urlpatterns([AsyncWebhookView, SyncWebhookView]):
-            views = get_webhook_views()
-
-        assert len(views) == 2
-        assert AsyncWebhookView in views
-        assert SyncWebhookView in views
-
-    def test_get_normal_view(self, urlpatterns):
-        with urlpatterns([View]):
-            views = get_webhook_views()
-
-        assert len(views) == 0
-
-    def test_get_none(self, urlpatterns):
-        with urlpatterns([]):
-            views = get_webhook_views()
-
-        assert len(views) == 0