cron_scheduler_details.html now shows crob job details (#766)

* cron_scheduler_details.html now shows crob job details

* Add compatibility with redis-py 7.2

Author: selwin

django_rq/cron.py

@@ -170,6 +170,44 @@ def connection_index(self) -> int:
         # This should never happen - if we have a connection_config, it must be in the list
         raise ValueError('Could not find matching connection config in unique configs.')
 
+    def get_jobs_data(self) -> list[dict[str, Any]]:
+        """Returns a list of dicts describing each registered cron job for display purposes."""
+        cron_jobs_data: list[dict[str, object]] = []
+
+        for job in self.get_jobs():
+            cron_string = job.cron
+            interval = job.interval
+
+            if cron_string:
+                schedule = f"cron: {cron_string}"
+            elif interval is not None:
+                schedule = f"every {interval} seconds"
+            else:
+                schedule = "-"
+
+            job_options = job.job_options
+            options: list[str] = []
+            for key in ('job_timeout', 'result_ttl', 'ttl', 'failure_ttl'):
+                value = job_options.get(key)
+                if value is not None:
+                    options.append(f"{key}={value}")
+
+            cron_jobs_data.append(
+                {
+                    "func_name": job.func_name,
+                    "queue_name": job.queue_name,
+                    "schedule": schedule,
+                    "latest_enqueue_time": job.latest_enqueue_time,
+                    "next_enqueue_time": job.next_enqueue_time,
+                    "args": job.args,
+                    "kwargs": job.kwargs,
+                    "meta": job_options.get('meta'),
+                    "options": options,
+                }
+            )
+
+        return cron_jobs_data
+
     @classmethod
     def all(cls, connection: Redis, cleanup: bool = True) -> list['DjangoCronScheduler']:  # type: ignore[override]
         """

django_rq/cron_views.py

@@ -39,6 +39,7 @@ def cron_scheduler_detail(request, connection_index: int, scheduler_name: str):
         context_data = {
             **each_context(request),
             "scheduler": scheduler,
+            "cron_jobs": scheduler.get_jobs_data(),
         }
 
         return render(request, 'django_rq/cron_scheduler_detail.html', context_data)

django_rq/templates/django_rq/cron_scheduler_detail.html

@@ -5,6 +5,7 @@
 {% block extrastyle %}
     {{ block.super }}
     <link rel="stylesheet" href="{% static 'admin/css/forms.css' %}">
+    <link rel="stylesheet" href="{% static 'admin/css/changelists.css' %}">
 {% endblock %}
 
 {% block title %}Cron Scheduler: {{ scheduler.name }}{% endblock %}
@@ -94,5 +95,63 @@
 
     </fieldset>
 
+    <div class="module" id="changelist">
+        <h2>Cron Jobs</h2>
+        <div class="results">
+            {% if cron_jobs %}
+            <table id="result_list">
+                <thead>
+                    <tr>
+                        <th><div class="text"><span>Callable</span></div></th>
+                        <th><div class="text"><span>Queue</span></div></th>
+                        <th><div class="text"><span>Schedule</span></div></th>
+                        <th><div class="text"><span>Next Enqueue</span></div></th>
+                        <th><div class="text"><span>Latest Enqueue</span></div></th>
+                        <th><div class="text"><span>Args</span></div></th>
+                        <th><div class="text"><span>Kwargs</span></div></th>
+                        <th><div class="text"><span>Meta</span></div></th>
+                        <th><div class="text"><span>Options</span></div></th>
+                    </tr>
+                </thead>
+                <tbody>
+                    {% for cron_job in cron_jobs %}
+                    <tr class="{% cycle 'row1' 'row2' %}">
+                        <td>{{ cron_job.func_name|default:"-" }}</td>
+                        <td>{{ cron_job.queue_name|default:"-" }}</td>
+                        <td>{{ cron_job.schedule }}</td>
+                        <td>
+                            {% if cron_job.next_enqueue_time %}
+                                {{ cron_job.next_enqueue_time|to_localtime|date:"Y-m-d, H:i:s" }}
+                            {% else %}
+                                -
+                            {% endif %}
+                        </td>
+                        <td>
+                            {% if cron_job.latest_enqueue_time %}
+                                {{ cron_job.latest_enqueue_time|to_localtime|date:"Y-m-d, H:i:s" }}
+                            {% else %}
+                                -
+                            {% endif %}
+                        </td>
+                        <td>{{ cron_job.args|default_if_none:"-" }}</td>
+                        <td>{{ cron_job.kwargs|default_if_none:"-" }}</td>
+                        <td>{{ cron_job.meta|default_if_none:"-" }}</td>
+                        <td>
+                            {% for option in cron_job.options %}
+                                {{ option }}{% if not forloop.last %}<br>{% endif %}
+                            {% empty %}
+                                -
+                            {% endfor %}
+                        </td>
+                    </tr>
+                    {% endfor %}
+                </tbody>
+            </table>
+            {% else %}
+            <p class="paginator">No persisted cron jobs found</p>
+            {% endif %}
+        </div>
+    </div>
+
 </div>
 {% endblock %}

django_rq/utils.py

@@ -75,6 +75,7 @@ def get_statistics(run_maintenance_tasks: bool = False) -> dict[str, list[dict[s
         connection_kwargs.pop('parser_class', None)
         connection_kwargs.pop('retry', None)
         connection_kwargs.pop('password', None)
+        connection_kwargs.pop('driver_info', None)
 
         queue_data = {
             'name': queue.name,

tests/test_cron.py

@@ -9,6 +9,7 @@
 from django.urls import reverse
 from rq.cron import CronJob
 
+from django_rq import get_connection
 from django_rq.cron import DjangoCronScheduler
 from tests.fixtures import say_hello
 
@@ -180,7 +181,19 @@ def test_cron_scheduler_detail_view(self):
         """Test cron scheduler detail view with various scenarios."""
         # Create a real scheduler and register it
         scheduler = DjangoCronScheduler(name='test-scheduler')
-        scheduler.register(say_hello, "default", interval=60)
+        scheduler.register(
+            say_hello,
+            "default",
+            interval=60,
+            args=("hello",),
+            kwargs={"target": "world"},
+            meta={"source": "test"},
+            job_timeout=20,
+            result_ttl=500,
+            ttl=60,
+            failure_ttl=120,
+        )
+        scheduler.register(say_hello, "default", cron="*/5 * * * *")
         scheduler.register_birth()
 
         for prefix in ('admin:django_rq_', 'django_rq:'):
@@ -190,7 +203,24 @@ def test_cron_scheduler_detail_view(self):
             response = self.client.get(url)
             self.assertEqual(response.status_code, 200)
             self.assertEqual(response.context['scheduler'].name, 'test-scheduler')
+            self.assertEqual(len(response.context['cron_jobs']), 2)
+            first_cron_job = response.context['cron_jobs'][0]
+            self.assertEqual(first_cron_job['func_name'], 'tests.fixtures.say_hello')
+            self.assertEqual(first_cron_job['queue_name'], 'default')
+            self.assertEqual(first_cron_job['schedule'], 'every 60 seconds')
             self.assertContains(response, 'test-scheduler')
+            self.assertContains(response, 'Cron Jobs')
+            self.assertContains(response, 'tests.fixtures.say_hello')
+            self.assertContains(response, 'default')
+            self.assertContains(response, 'every 60 seconds')
+            self.assertContains(response, 'cron: */5 * * * *')
+            self.assertContains(response, 'hello')
+            self.assertContains(response, 'world')
+            self.assertContains(response, 'source')
+            self.assertContains(response, 'job_timeout=20')
+            self.assertContains(response, 'result_ttl=500')
+            self.assertContains(response, 'ttl=60')
+            self.assertContains(response, 'failure_ttl=120')
 
             # Test 2: Non-existent scheduler returns 404
             url = reverse(f'{prefix}cron_scheduler_detail', args=[connection_index, 'nonexistent-scheduler'])
@@ -204,3 +234,18 @@ def test_cron_scheduler_detail_view(self):
 
         # Clean up
         scheduler.register_death()
+
+    def test_cron_scheduler_detail_view_with_no_jobs(self):
+        """Test cron scheduler detail view gracefully handles schedulers with no jobs."""
+        scheduler = DjangoCronScheduler(connection=get_connection("default"), name='empty-scheduler')
+        scheduler.register_birth()
+
+        for prefix in ('admin:django_rq_', 'django_rq:'):
+            url = reverse(f'{prefix}cron_scheduler_detail', args=[scheduler.connection_index, 'empty-scheduler'])
+            response = self.client.get(url)
+            self.assertEqual(response.status_code, 200)
+            self.assertEqual(response.context['scheduler'].name, 'empty-scheduler')
+            self.assertEqual(response.context['cron_jobs'], [])
+            self.assertContains(response, 'No persisted cron jobs found')
+
+        scheduler.register_death()