Fix #202

Author: cunla

scheduler/models/old_scheduled_task.py

@@ -201,7 +201,7 @@ def rqueue(self) -> DjangoQueue:
         """Returns django-queue for job"""
         return get_queue(self.queue)
 
-    def ready_for_schedule(self) -> bool:
+    def _ready_for_schedule(self) -> bool:
         """Is the task ready to be scheduled?
 
         If the task is already scheduled or disabled, then it is not
@@ -217,11 +217,11 @@ def ready_for_schedule(self) -> bool:
             return False
         return True
 
-    def schedule(self) -> bool:
+    def _schedule(self) -> bool:
         """Schedule the next execution for the task to run.
         :returns: True if a job was scheduled, False otherwise.
         """
-        if not self.ready_for_schedule():
+        if not self._ready_for_schedule():
             return False
         schedule_time = self._schedule_time()
         kwargs = self._enqueue_args()
@@ -323,7 +323,7 @@ def save(self, **kwargs):
             kwargs["update_fields"] = set(update_fields).union({"modified"})
         super(BaseTask, self).save(**kwargs)
         if schedule_job:
-            self.schedule()
+            self._schedule()
             super(BaseTask, self).save()
 
     def delete(self, **kwargs):
@@ -395,8 +395,8 @@ class Meta:
 class ScheduledTask(ScheduledTimeMixin, BaseTask):
     task_type = "ScheduledTask"
 
-    def ready_for_schedule(self) -> bool:
-        return super(ScheduledTask, self).ready_for_schedule() and (
+    def _ready_for_schedule(self) -> bool:
+        return super(ScheduledTask, self)._ready_for_schedule() and (
                 self.scheduled_time is None or self.scheduled_time >= timezone.now()
         )
 
@@ -486,8 +486,8 @@ def _schedule_time(self):
             self.repeat = (self.repeat - gap) if self.repeat is not None else None
         return super()._schedule_time()
 
-    def ready_for_schedule(self):
-        if super(RepeatableTask, self).ready_for_schedule() is False:
+    def _ready_for_schedule(self):
+        if super(RepeatableTask, self)._ready_for_schedule() is False:
             return False
         if self._schedule_time() < timezone.now():
             return False

scheduler/models/task.py

@@ -253,42 +253,6 @@ def rqueue(self) -> DjangoQueue:
         """Returns django-queue for job"""
         return get_queue(self.queue)
 
-    def ready_for_schedule(self) -> bool:
-        """Is the task ready to be scheduled?
-
-        If the task is already scheduled or disabled, then it is not
-        ready to be scheduled.
-
-        :returns: True if the task is ready to be scheduled.
-        """
-        if self.is_scheduled():
-            logger.debug(f"Task {self.name} already scheduled")
-            return False
-        if not self.enabled:
-            logger.debug(f"Task {str(self)} disabled, enable task before scheduling")
-            return False
-        if self.task_type in {TaskType.REPEATABLE, TaskType.ONCE} and self._schedule_time() < timezone.now():
-            return False
-        return True
-
-    def schedule(self) -> bool:
-        """Schedule the next execution for the task to run.
-        :returns: True if a job was scheduled, False otherwise.
-        """
-        if not self.ready_for_schedule():
-            return False
-        schedule_time = self._schedule_time()
-        kwargs = self._enqueue_args()
-        job = self.rqueue.enqueue_at(
-            schedule_time,
-            tools.run_task,
-            args=(self.task_type, self.id),
-            **kwargs,
-        )
-        self.job_id = job.id
-        super(Task, self).save()
-        return True
-
     def enqueue_to_run(self) -> bool:
         """Enqueue task to run now."""
         kwargs = self._enqueue_args()
@@ -380,14 +344,39 @@ def __str__(self):
         func = self.function_string()
         return f"{self.task_type}[{self.name}={func}]"
 
+    def _schedule(self) -> bool:
+        """Schedule the next execution for the task to run.
+        :returns: True if a job was scheduled, False otherwise.
+        """
+        self.refresh_from_db()
+        if self.is_scheduled():
+            logger.debug(f"Task {self.name} already scheduled")
+            return False
+        if not self.enabled:
+            logger.debug(f"Task {str(self)} disabled, enable task before scheduling")
+            return False
+        if self.task_type in {TaskType.REPEATABLE, TaskType.ONCE} and self._schedule_time() < timezone.now():
+            return False
+        schedule_time = self._schedule_time()
+        kwargs = self._enqueue_args()
+        job = self.rqueue.enqueue_at(
+            schedule_time,
+            tools.run_task,
+            args=(self.task_type, self.id),
+            **kwargs,
+        )
+        self.job_id = job.id
+        super(Task, self).save()
+        return True
+
     def save(self, **kwargs):
         schedule_job = kwargs.pop("schedule_job", True)
         update_fields = kwargs.get("update_fields", None)
         if update_fields is not None:
             kwargs["update_fields"] = set(update_fields).union({"modified"})
         super(Task, self).save(**kwargs)
         if schedule_job:
-            self.schedule()
+            self._schedule()
             super(Task, self).save()
 
     def delete(self, **kwargs):

scheduler/tests/test_old_models/test_old_models.py

@@ -96,7 +96,7 @@ def test_is_schedulable_already_scheduled(self):
             task = old_task_factory(
                 self.TaskModelClass,
             )
-            task.schedule()
+            task._schedule()
             self.assertTrue(task.is_scheduled())
 
         def test_is_schedulable_disabled(self):
@@ -151,7 +151,7 @@ def test_schedule2(self):
             task.queue = list(settings.QUEUES)[0]
             task.enabled = False
             task.scheduled_time = timezone.now() + timedelta(minutes=1)
-            self.assertFalse(task.schedule())
+            self.assertFalse(task._schedule())
 
         def test_delete_and_unschedule(self):
             task = old_task_factory(

scheduler/tests/test_old_models/test_old_repeatable_task.py

@@ -153,7 +153,7 @@ def test_repeat_none_interval_2_min(self):
         task = old_task_factory(self.TaskModelClass, scheduled_time=base_time - timedelta(minutes=29), repeat=None)
         task.interval = 120
         task.interval_unit = "seconds"
-        task.schedule()
+        task._schedule()
         self.assertTrue(task.scheduled_time > base_time)
         self.assertTrue(task.is_scheduled())
 

scheduler/tests/test_task_types/test_repeatable_task.py

@@ -145,12 +145,12 @@ def test_repeat_old_job_remaining(self):
 
     def test_repeat_none_interval_2_min(self):
         base_time = timezone.now()
-        job = task_factory(self.task_type, scheduled_time=base_time - timedelta(minutes=29), repeat=None)
-        job.interval = 120
-        job.interval_unit = "seconds"
-        job.schedule()
-        self.assertTrue(job.scheduled_time > base_time)
-        self.assertTrue(job.is_scheduled())
+        task = task_factory(self.task_type, scheduled_time=base_time - timedelta(minutes=29), repeat=None)
+        task.interval = 120
+        task.interval_unit = "seconds"
+        task._schedule()
+        self.assertTrue(task.scheduled_time > base_time)
+        self.assertTrue(task.is_scheduled())
 
     def test_check_rescheduled_after_execution(self):
         task = task_factory(self.task_type, scheduled_time=timezone.now() + timedelta(seconds=1), repeat=10)

scheduler/tests/test_task_types/test_task_model.py

@@ -95,7 +95,7 @@ def test_clean_invalid_queue(self):
 
         def test_is_schedulable_already_scheduled(self):
             task = task_factory(self.task_type)
-            task.schedule()
+            task._schedule()
             self.assertTrue(task.is_scheduled())
 
         def test_is_schedulable_disabled(self):
@@ -144,7 +144,7 @@ def test_schedule2(self):
             task.queue = list(settings.QUEUES)[0]
             task.enabled = False
             task.scheduled_time = timezone.now() + timedelta(minutes=1)
-            self.assertFalse(task.schedule())
+            self.assertFalse(task._schedule())
 
         def test_delete_and_unschedule(self):
             task = task_factory(self.task_type)