Automatically add Django RQ views to admin (#747)

* By default show Django-RQ link in admin sidebar

* Automatically add DjangoRQ views to Django's admin inteface

* Improve test_admin_integration.py

* Delete unused variable

* Split AdminURLIntegrationTest into two different test cases

* Check for invalid API calls by asserting status codes

* Changed the dashboard URL from /queue to /dashboard

* Updated README.md

Author: selwin

README.md

@@ -77,14 +77,30 @@ RQ_QUEUES = {
 RQ_EXCEPTION_HANDLERS = ['path.to.my.handler']  # If you need custom exception handlers
 ```
 
-- Include `django_rq.urls` in your `urls.py`:
+## Admin Integration
+
+_Changed in Version 3.0_
+Django-RQ automatically integrates with Django's admin interface. Once installed, navigate to `/admin/django_rq/dashboard/` to access:
+- Queue statistics and monitoring dashboard
+- Job registry browsers (scheduled, started, finished, failed, deferred)
+- Worker management
+- Prometheus metrics endpoint (if `prometheus_client` is installed)
+
+The views are automatically registered in Django admin and a link to the dashboard is added to the admin interface's sidebar. If you want to disable this link, add `RQ_SHOW_ADMIN_LINK = False` in `settings.py`.
+
+### Standalone URLs (Alternative)
+
+For advanced use cases, you can also include Django-RQ views at a custom URL prefix:
 
 ```python
+# urls.py
 urlpatterns += [
     path('django-rq/', include('django_rq.urls'))
 ]
 ```
 
+This makes views accessible at `/django-rq/` instead of within the admin interface at `/admin/django_rq/dashboard/`.
+
 ## Usage
 
 ### Putting jobs in the queue
@@ -307,11 +323,9 @@ python manage.py rqresume
 
 ### Queue Statistics
 
-`django_rq` also provides a dashboard to monitor the status of your queues at `/django-rq/` (or whatever URL you set in your `urls.py` during installation).
-
-You can also add a link to this dashboard in `/admin` by adding `RQ_SHOW_ADMIN_LINK = True` in `settings.py`. Be careful though, this will override the default admin template so it may interfere with other apps that modify the default admin template.
+_Changed in Version 3.0_
 
-These statistics are also available in JSON format via `/django-rq/stats.json`, which is accessible to staff members. If you need to access this view via other HTTP clients (for monitoring purposes), you can define `RQ_API_TOKEN`. Then, include the token in the Authorization header as a Bearer token: `Authorization: Bearer <token>` and access it via `/django-rq/stats.json`.
+Various queue statistics are also available in JSON format via `/django-rq/stats.json`, which is accessible via a bearer token authentication scheme (defined in `settings.py` as `RQ_API_TOKEN`). Then, include the token in the Authorization header as a Bearer token: `Authorization: Bearer <token>` and access it via `/django-rq/stats.json`.
 
 ![Django RQ JSON dashboard](demo-django-rq-json-dashboard.png)
 

django_rq/admin.py

@@ -1,3 +1,4 @@
+from functools import wraps
 from typing import Any, Optional
 
 from django.contrib import admin
@@ -34,6 +35,37 @@ def changelist_view(self, request: HttpRequest, extra_context: Optional[dict[str
         # proxy request to stats view
         return stats_views.stats(request)
 
+    def get_urls(self):
+        """
+        Register Django-RQ views within Django admin.
+
+        URLs will be available at /admin/django_rq/dashboard/<pattern>/
+        This provides automatic integration without requiring users to edit urls.py.
+
+        Uses two sets of URL patterns:
+        - API patterns (stats_json, prometheus_metrics): NOT wrapped, support API token auth
+        - Admin patterns (all other views): Wrapped with admin_view for session auth
+        """
+        # Import inside method to avoid circular imports
+        from .urls import get_admin_urlpatterns, get_api_urlpatterns
+
+        def wrap(view):
+            """Wrap view with admin_site.admin_view for permission checking"""
+
+            @wraps(view)
+            def wrapper(*args, **kwargs):
+                return self.admin_site.admin_view(view)(*args, **kwargs)
+
+            return wrapper
+
+        # Get both sets of URL patterns
+        api_urls = get_api_urlpatterns()  # Not wrapped - have their own auth
+        admin_urls = get_admin_urlpatterns(view_wrapper=wrap)  # Wrapped with admin auth
+
+        # Combine and add to standard ModelAdmin URLs
+        return api_urls + admin_urls + super().get_urls()
+
 
+# Register the Dashboard model with admin if enabled.
 if settings.SHOW_ADMIN_LINK:
-    admin.site.register(models.Queue, QueueAdmin)
+    admin.site.register(models.Dashboard, QueueAdmin)

django_rq/models.py

@@ -10,11 +10,14 @@
     got_request_exception.connect(thread_queue.clear)
 
 
-class Queue(models.Model):
-    """Placeholder model with no database table, but with django admin page
-    and contenttype permission"""
+class Dashboard(models.Model):
+    """
+    Admin-only model for Django-RQ dashboard integration.
+    """
 
     class Meta:
-        managed = False  # not in Django's database
+        managed = False  # No database table - admin integration only
         default_permissions = ()
         permissions = [['view', 'Access admin page']]
+        verbose_name = 'Django-RQ'
+        verbose_name_plural = 'Django-RQ'

django_rq/settings.py

@@ -4,7 +4,7 @@
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 
-SHOW_ADMIN_LINK = getattr(settings, 'RQ_SHOW_ADMIN_LINK', False)
+SHOW_ADMIN_LINK = getattr(settings, 'RQ_SHOW_ADMIN_LINK', True)
 
 NAME = getattr(settings, 'RQ_NAME', 'default')
 BURST: bool = getattr(settings, 'RQ_BURST', False)

django_rq/urls.py

@@ -1,43 +1,89 @@
-from django.urls import path, re_path
+from typing import Callable, Optional
+
+from django.urls import URLPattern, path, re_path
 
 from . import cron_views, stats_views, views
 from .contrib.prometheus import RQCollector
 
-metrics_view = (
-    [
-        re_path(r'^metrics/?$', stats_views.prometheus_metrics, name='rq_metrics'),
+
+def get_api_urlpatterns() -> list[URLPattern]:
+    """
+    Get URL patterns for views that have their own authentication (API tokens).
+
+    These views should NOT be wrapped with admin_view because they support
+    API token authentication that must work without Django session auth.
+
+    Returns:
+        List of URL patterns for API-authenticated views.
+    """
+    # Conditional metrics view (only if prometheus_client is installed)
+    metrics_view = (
+        [
+            re_path(r'^metrics/?$', stats_views.prometheus_metrics, name='rq_metrics'),
+        ]
+        if RQCollector is not None
+        else []
+    )
+
+    return [
+        # Stats JSON (supports API token authentication)
+        re_path(r'^stats.json/?$', stats_views.stats_json, name='rq_home_json'),
+        re_path(r'^stats.json/(?P<token>[\w]+)?/?$', stats_views.stats_json, name='rq_home_json'),
+        # Prometheus metrics (supports API token authentication)
+        *metrics_view,
+    ]
+
+
+def get_admin_urlpatterns(view_wrapper: Optional[Callable] = None) -> list[URLPattern]:
+    """
+    Get URL patterns for views that should be wrapped with admin authentication.
+
+    Args:
+        view_wrapper: Optional function to wrap each view (e.g., admin_site.admin_view).
+
+    Returns:
+        List of URL patterns for admin-authenticated views.
+    """
+
+    def maybe_wrap(view: Callable) -> Callable:
+        """Apply wrapper if provided, otherwise return view as-is"""
+        return view_wrapper(view) if view_wrapper else view
+
+    return [
+        # Dashboard
+        path('', maybe_wrap(stats_views.stats), name='rq_home'),
+        # Queue views
+        path('queues/<int:queue_index>/', maybe_wrap(views.jobs), name='rq_jobs'),
+        path('queues/<int:queue_index>/finished/', maybe_wrap(views.finished_jobs), name='rq_finished_jobs'),
+        path('queues/<int:queue_index>/failed/', maybe_wrap(views.failed_jobs), name='rq_failed_jobs'),
+        path('queues/<int:queue_index>/failed/clear/', maybe_wrap(views.delete_failed_jobs), name='rq_delete_failed_jobs'),
+        path('queues/<int:queue_index>/scheduled/', maybe_wrap(views.scheduled_jobs), name='rq_scheduled_jobs'),
+        path('queues/<int:queue_index>/started/', maybe_wrap(views.started_jobs), name='rq_started_jobs'),
+        path('queues/<int:queue_index>/deferred/', maybe_wrap(views.deferred_jobs), name='rq_deferred_jobs'),
+        path('queues/<int:queue_index>/empty/', maybe_wrap(views.clear_queue), name='rq_clear'),
+        path('queues/<int:queue_index>/requeue-all/', maybe_wrap(views.requeue_all), name='rq_requeue_all'),
+        # Job detail and actions
+        path('queues/<int:queue_index>/<str:job_id>/', maybe_wrap(views.job_detail), name='rq_job_detail'),
+        path('queues/<int:queue_index>/<str:job_id>/delete/', maybe_wrap(views.delete_job), name='rq_delete_job'),
+        path('queues/<int:queue_index>/<str:job_id>/requeue/', maybe_wrap(views.requeue_job_view), name='rq_requeue_job'),
+        path('queues/<int:queue_index>/<str:job_id>/enqueue/', maybe_wrap(views.enqueue_job), name='rq_enqueue_job'),
+        path('queues/<int:queue_index>/<str:job_id>/stop/', maybe_wrap(views.stop_job), name='rq_stop_job'),
+        # Bulk actions
+        path('queues/confirm-action/<int:queue_index>/', maybe_wrap(views.confirm_action), name='rq_confirm_action'),
+        path('queues/actions/<int:queue_index>/', maybe_wrap(views.actions), name='rq_actions'),
+        # Workers
+        path('workers/<int:queue_index>/', maybe_wrap(views.workers), name='rq_workers'),
+        path('workers/<int:queue_index>/<str:key>/', maybe_wrap(views.worker_details), name='rq_worker_details'),
+        # Schedulers
+        path('schedulers/<int:scheduler_index>/', maybe_wrap(views.scheduler_jobs), name='rq_scheduler_jobs'),
+        path(
+            'cron-schedulers/<int:connection_index>/<str:scheduler_name>/',
+            maybe_wrap(cron_views.cron_scheduler_detail),
+            name='rq_cron_scheduler_detail',
+        ),
     ]
-    if RQCollector is not None
-    else []
-)
-
-urlpatterns = [
-    path('', stats_views.stats, name='rq_home'),
-    re_path(r'^stats.json/?$', stats_views.stats_json, name='rq_home_json'),
-    re_path(r'^stats.json/(?P<token>[\w]+)?/?$', stats_views.stats_json, name='rq_home_json'),
-    *metrics_view,
-    path('queues/<int:queue_index>/', views.jobs, name='rq_jobs'),
-    path('workers/<int:queue_index>/', views.workers, name='rq_workers'),
-    path('workers/<int:queue_index>/<str:key>/', views.worker_details, name='rq_worker_details'),
-    path('queues/<int:queue_index>/finished/', views.finished_jobs, name='rq_finished_jobs'),
-    path('queues/<int:queue_index>/failed/', views.failed_jobs, name='rq_failed_jobs'),
-    path('queues/<int:queue_index>/failed/clear/', views.delete_failed_jobs, name='rq_delete_failed_jobs'),
-    path('queues/<int:queue_index>/scheduled/', views.scheduled_jobs, name='rq_scheduled_jobs'),
-    path('queues/<int:queue_index>/started/', views.started_jobs, name='rq_started_jobs'),
-    path('queues/<int:queue_index>/deferred/', views.deferred_jobs, name='rq_deferred_jobs'),
-    path('queues/<int:queue_index>/empty/', views.clear_queue, name='rq_clear'),
-    path('queues/<int:queue_index>/requeue-all/', views.requeue_all, name='rq_requeue_all'),
-    path('queues/<int:queue_index>/<str:job_id>/', views.job_detail, name='rq_job_detail'),
-    path('queues/<int:queue_index>/<str:job_id>/delete/', views.delete_job, name='rq_delete_job'),
-    path('queues/confirm-action/<int:queue_index>/', views.confirm_action, name='rq_confirm_action'),
-    path('queues/actions/<int:queue_index>/', views.actions, name='rq_actions'),
-    path('queues/<int:queue_index>/<str:job_id>/requeue/', views.requeue_job_view, name='rq_requeue_job'),
-    path('queues/<int:queue_index>/<str:job_id>/enqueue/', views.enqueue_job, name='rq_enqueue_job'),
-    path('queues/<int:queue_index>/<str:job_id>/stop/', views.stop_job, name='rq_stop_job'),
-    path('schedulers/<int:scheduler_index>/', views.scheduler_jobs, name='rq_scheduler_jobs'),
-    path(
-        'cron-schedulers/<int:connection_index>/<str:scheduler_name>/',
-        cron_views.cron_scheduler_detail,
-        name='rq_cron_scheduler_detail',
-    ),
-]
+
+
+# Standalone URL patterns (for use with include('django_rq.urls'))
+# Combines both API and admin patterns without wrapping
+urlpatterns = get_api_urlpatterns() + get_admin_urlpatterns()