fix: fix clock schedule and one off task stuck

Author: yang.yu

django_celery_beat/admin.py

@@ -245,14 +245,9 @@ class ClockedScheduleAdmin(admin.ModelAdmin):
 
     fields = (
         'clocked_time',
-        'enabled',
-    )
-    readonly_fields = (
-        'enabled',
     )
     list_display = (
         'clocked_time',
-        'enabled',
     )
 
 

django_celery_beat/clockedschedule.py

@@ -2,12 +2,7 @@
 
 from celery import schedules
 from celery.utils.time import maybe_make_aware
-from collections import namedtuple
-
-try:
-    from celery.schedules import schedstate  # Celery >=3.1.0
-except ImportError:
-    schedstate = namedtuple('schedstate', ('is_due', 'next'))
+from .utils import NEVER_CHECK_TIMEOUT
 
 
 class clocked(schedules.BaseSchedule):
@@ -16,36 +11,27 @@ class clocked(schedules.BaseSchedule):
     Depends on PeriodicTask one_off=True
     """
 
-    def __init__(self, clocked_time, enabled=True,
-                 model=None, nowfun=None, app=None):
+    def __init__(self, clocked_time, nowfun=None, app=None):
         """Initialize clocked."""
         self.clocked_time = maybe_make_aware(clocked_time)
-        self.enabled = enabled
-        self.model = model
         super(clocked, self).__init__(nowfun=nowfun, app=app)
 
     def remaining_estimate(self, last_run_at):
         return self.clocked_time - self.now()
 
     def is_due(self, last_run_at):
-        if not self.enabled:
-            return schedstate(is_due=False, next=None)
         rem_delta = self.remaining_estimate(None)
         remaining_s = max(rem_delta.total_seconds(), 0)
         if remaining_s == 0:
-            if self.model:
-                self.model.enabled = False
-                self.model.save()
-            return schedstate(is_due=True, next=None)
-        return schedstate(is_due=False, next=remaining_s)
+            return schedules.schedstate(is_due=True, next=NEVER_CHECK_TIMEOUT)
+        return schedules.schedstate(is_due=False, next=remaining_s)
 
     def __repr__(self):
-        return '<clocked: {} {}>'.format(self.clocked_time, self.enabled)
+        return '<clocked: {}>'.format(self.clocked_time)
 
     def __eq__(self, other):
         if isinstance(other, clocked):
-            return self.clocked_time == other.clocked_time and \
-                self.enabled == other.enabled
+            return self.clocked_time == other.clocked_time
         return False
 
     def __ne__(self, other):

django_celery_beat/migrations/0014_remove_clockedschedule_enabled.py

@@ -0,0 +1,17 @@
+# Generated by Django 2.2.4 on 2019-08-30 00:46
+# flake8: noqa
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_celery_beat', '0013_auto_20200609_0727'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='clockedschedule',
+            name='enabled',
+        ),
+    ]

django_celery_beat/models.py

@@ -201,12 +201,6 @@ class ClockedSchedule(models.Model):
         verbose_name=_('Clock Time'),
         help_text=_('Run the task at clocked time'),
     )
-    enabled = models.BooleanField(
-        default=True,
-        editable=False,
-        verbose_name=_('Enabled'),
-        help_text=_('Set to False to disable the schedule'),
-    )
 
     class Meta:
         """Table information."""
@@ -216,18 +210,16 @@ class Meta:
         ordering = ['clocked_time']
 
     def __str__(self):
-        return '{} {}'.format(self.clocked_time, self.enabled)
+        return '{}'.format(self.clocked_time)
 
     @property
     def schedule(self):
-        c = clocked(clocked_time=self.clocked_time,
-                    enabled=self.enabled, model=self)
+        c = clocked(clocked_time=self.clocked_time)
         return c
 
     @classmethod
     def from_schedule(cls, schedule):
-        spec = {'clocked_time': schedule.clocked_time,
-                'enabled': schedule.enabled}
+        spec = {'clocked_time': schedule.clocked_time}
         try:
             return cls.objects.get(**spec)
         except cls.DoesNotExist:

django_celery_beat/schedulers.py

@@ -24,6 +24,7 @@
     SolarSchedule, ClockedSchedule
 )
 from .clockedschedule import clocked
+from .utils import NEVER_CHECK_TIMEOUT
 
 try:
     from celery.utils.time import is_naive
@@ -128,7 +129,8 @@ def is_due(self):
             self.model.total_run_count = 0  # Reset
             self.model.no_changes = False  # Mark the model entry as changed
             self.model.save()
-            return schedules.schedstate(False, None)  # Don't recheck
+            # Don't recheck
+            return schedules.schedstate(False, NEVER_CHECK_TIMEOUT)
 
         # CAUTION: make_aware assumes settings.TIME_ZONE for naive datetimes,
         # while maybe_make_aware assumes utc for naive datetimes

django_celery_beat/utils.py

@@ -5,6 +5,8 @@
 from django.utils import timezone
 
 is_aware = timezone.is_aware
+# celery schedstate return None will make it not work
+NEVER_CHECK_TIMEOUT = 100000000
 
 # see Issue #222
 now_localtime = getattr(timezone, 'template_localtime', timezone.localtime)

t/unit/test_schedulers.py

@@ -21,7 +21,7 @@
     PeriodicTask, PeriodicTasks, IntervalSchedule, CrontabSchedule,
     SolarSchedule, ClockedSchedule, DAYS
 )
-from django_celery_beat.utils import make_aware
+from django_celery_beat.utils import make_aware, NEVER_CHECK_TIMEOUT
 
 _ids = count(0)
 
@@ -288,7 +288,7 @@ def test_one_off_task(self):
         e2 = self.Entry(m2, app=self.app)
         isdue, delay = e2.is_due()
         assert not isdue
-        assert delay is None
+        assert delay == NEVER_CHECK_TIMEOUT
 
 
 @pytest.mark.django_db()
@@ -638,8 +638,8 @@ def test_PeriodicTask_unicode_clocked(self):
         p = self.create_model_clocked(
             clocked(time), name='clocked_event'
         )
-        assert str(p) == '{0}: {1} {2}'.format(
-            'clocked_event', str(time), True
+        assert str(p) == '{0}: {1}'.format(
+            'clocked_event', str(time)
         )
 
     def test_PeriodicTask_schedule_property(self):
@@ -743,16 +743,7 @@ def test_ClockedSchedule_schedule(self):
         assert s.schedule is not None
         isdue2, nextcheck2 = s.schedule.is_due(dt2_lastrun)
         assert isdue2 is True  # True means task is due and should run.
-        assert (nextcheck2 is None) and (isdue2 is True)
-        print(s.schedule.enabled)
-
-        assert s.schedule is not None
-        isdue3, nextcheck3 = s.schedule.is_due(dt2_lastrun)
-        print(s.schedule.clocked_time, s.schedule.enabled)
-        print(isdue3, nextcheck3)
-        # False means task isn't due, but keep checking.
-        assert isdue3 is False
-        assert (nextcheck3 is None) and (isdue3 is False)
+        assert (nextcheck2 == NEVER_CHECK_TIMEOUT) and (isdue2 is True)
 
 
 @pytest.mark.django_db()