ETA scheduler moved to external timer2 module.

Author: Ask Solem

celery/conf.py

@@ -48,7 +48,7 @@
     "CELERYD_POOL_PUTLOCKS": True,
     "CELERYD_POOL": "celery.concurrency.processes.TaskPool",
     "CELERYD_MEDIATOR": "celery.worker.controllers.Mediator",
-    "CELERYD_ETA_SCHEDULER": "celery.worker.controllers.ScheduleController",
+    "CELERYD_ETA_SCHEDULER": "timer2.Timer",
     "CELERYD_LISTENER": "celery.worker.listener.CarrotListener",
     "CELERYD_CONCURRENCY": 0, # defaults to cpu count
     "CELERYD_PREFETCH_MULTIPLIER": 4,

celery/tests/test_worker.py

@@ -7,6 +7,7 @@
 
 from carrot.backends.base import BaseMessage
 from carrot.connection import BrokerConnection
+from timer2 import Timer
 
 from celery import conf
 from celery.decorators import task as task_dec
@@ -17,7 +18,6 @@
 from celery.worker.buckets import FastQueue
 from celery.worker.job import TaskRequest
 from celery.worker.listener import CarrotListener, QoS, RUN
-from celery.worker.scheduler import Scheduler
 
 from celery.tests.compat import catch_warnings
 from celery.tests.utils import execute_context
@@ -160,7 +160,7 @@ class test_CarrotListener(unittest.TestCase):
 
     def setUp(self):
         self.ready_queue = FastQueue()
-        self.eta_schedule = Scheduler(self.ready_queue)
+        self.eta_schedule = Timer()
         self.logger = get_logger()
         self.logger.setLevel(0)
 
@@ -336,7 +336,7 @@ def qos(self, **kwargs):
         items = [entry[2] for entry in self.eta_schedule.queue]
         found = 0
         for item in items:
-            if item.task_name == foo_task.name:
+            if item.args[0].task_name == foo_task.name:
                 found = True
         self.assertTrue(found)
         self.assertTrue(l.task_consumer.prefetch_count_incremented)
@@ -388,10 +388,10 @@ def test_receieve_message_eta(self):
         l.receive_message(m.decode(), m)
 
         in_hold = self.eta_schedule.queue[0]
-        self.assertEqual(len(in_hold), 4)
-        eta, priority, task, on_accept = in_hold
+        self.assertEqual(len(in_hold), 3)
+        eta, priority, entry = in_hold
+        task = entry.args[0]
         self.assertIsInstance(task, TaskRequest)
-        self.assertTrue(callable(on_accept))
         self.assertEqual(task.task_name, foo_task.name)
         self.assertEqual(task.execute(), 2 * 4 * 8)
         self.assertRaises(Empty, self.ready_queue.get_nowait)
@@ -466,7 +466,7 @@ def test_with_rate_limits_disabled(self):
 
     def test_attrs(self):
         worker = self.worker
-        self.assertIsInstance(worker.eta_schedule, Scheduler)
+        self.assertIsInstance(worker.scheduler, Timer)
         self.assertTrue(worker.scheduler)
         self.assertTrue(worker.pool)
         self.assertTrue(worker.listener)

celery/tests/test_worker_control.py

@@ -1,6 +1,8 @@
 import socket
 import unittest2 as unittest
 
+from timer2 import Timer
+
 from celery import conf
 from celery.decorators import task
 from celery.registry import tasks
@@ -10,7 +12,6 @@
 from celery.worker.buckets import FastQueue
 from celery.worker.job import TaskRequest
 from celery.worker.state import revoked
-from celery.worker.scheduler import Scheduler
 
 hostname = socket.gethostname()
 
@@ -44,7 +45,7 @@ def __init__(self):
                                          task_id=gen_unique_id(),
                                          args=(2, 2),
                                          kwargs={}))
-        self.eta_schedule = Scheduler(self.ready_queue)
+        self.eta_schedule = Timer()
         self.event_dispatcher = Dispatcher()
 
 
@@ -81,7 +82,8 @@ def test_dump_schedule(self):
         listener = Listener()
         panel = self.create_panel(listener=listener)
         self.assertFalse(panel.execute("dump_schedule"))
-        listener.eta_schedule.enter("foo", eta=100)
+        import operator
+        listener.eta_schedule.schedule.enter(100, operator.add, (2, 2))
         self.assertTrue(panel.execute("dump_schedule"))
 
     def test_dump_reserved(self):

celery/tests/test_worker_controllers.py

@@ -1,10 +1,9 @@
-import time
 import unittest2 as unittest
+
 from Queue import Queue
 
 from celery.utils import gen_unique_id
 from celery.worker.controllers import Mediator
-from celery.worker.controllers import BackgroundThread, ScheduleController
 from celery.worker.state import revoked as revoked_tasks
 
 
@@ -26,35 +25,7 @@ def revoked(self):
         return False
 
 
-class MyBackgroundThread(BackgroundThread):
-
-    def on_iteration(self):
-        time.sleep(1)
-
-
-class TestBackgroundThread(unittest.TestCase):
-
-    def test_on_iteration(self):
-        self.assertRaises(NotImplementedError,
-                BackgroundThread().on_iteration)
-
-    def test_run(self):
-        t = MyBackgroundThread()
-        t._shutdown.set()
-        t.run()
-        self.assertTrue(t._stopped.isSet())
-
-    def test_start_stop(self):
-        t = MyBackgroundThread()
-        t.start()
-        self.assertFalse(t._shutdown.isSet())
-        self.assertFalse(t._stopped.isSet())
-        t.stop()
-        self.assertTrue(t._shutdown.isSet())
-        self.assertTrue(t._stopped.isSet())
-
-
-class TestMediator(unittest.TestCase):
+class test_Mediator(unittest.TestCase):
 
     def test_mediator_start__stop(self):
         ready_queue = Queue()
@@ -67,7 +38,7 @@ def test_mediator_start__stop(self):
         self.assertTrue(m._shutdown.isSet())
         self.assertTrue(m._stopped.isSet())
 
-    def test_mediator_on_iteration(self):
+    def test_mediator_move(self):
         ready_queue = Queue()
         got = {}
 
@@ -77,11 +48,11 @@ def mycallback(value):
         m = Mediator(ready_queue, mycallback)
         ready_queue.put(MockTask("George Costanza"))
 
-        m.on_iteration()
+        m.move()
 
         self.assertEqual(got["value"], "George Costanza")
 
-    def test_mediator_on_iteration_revoked(self):
+    def test_mediator_move_revoked(self):
         ready_queue = Queue()
         got = {}
 
@@ -94,30 +65,7 @@ def mycallback(value):
         revoked_tasks.add(t.task_id)
         ready_queue.put(t)
 
-        m.on_iteration()
+        m.move()
 
         self.assertNotIn("value", got)
         self.assertTrue(t.acked)
-
-
-class TestScheduleController(unittest.TestCase):
-
-    def test_on_iteration(self):
-        times = range(10) + [None]
-        c = ScheduleController(times)
-
-        import time
-        slept = [None]
-
-        def _sleep(count):
-            slept[0] = count
-
-        old_sleep = time.sleep
-        time.sleep = _sleep
-        try:
-            for i in times:
-                c.on_iteration()
-                res = i or 1
-                self.assertEqual(slept[0], res)
-        finally:
-            time.sleep = old_sleep

celery/tests/test_worker_scheduler.py

@@ -8,7 +8,10 @@
 import traceback
 from multiprocessing.util import Finalize
 
+from timer2 import Timer
+
 from celery import conf
+from celery import log
 from celery import registry
 from celery import platform
 from celery import signals
@@ -18,7 +21,6 @@
 
 from celery.worker import state
 from celery.worker.buckets import TaskBucket, FastQueue
-from celery.worker.scheduler import Scheduler
 
 RUN = 0x1
 CLOSE = 0x2
@@ -146,6 +148,8 @@ def __init__(self, concurrency=None, logfile=None, loglevel=None,
         self.task_soft_time_limit = task_soft_time_limit
         self.max_tasks_per_child = max_tasks_per_child
         self.pool_putlocks = pool_putlocks
+        self.timer_debug = log.SilenceRepeated(self.logger.debug,
+                                               max_iterations=10)
         self.db = db
         self._finalize = Finalize(self, self.stop, exitpriority=1)
 
@@ -158,7 +162,6 @@ def __init__(self, concurrency=None, logfile=None, loglevel=None,
             self.ready_queue = FastQueue()
         else:
             self.ready_queue = TaskBucket(task_registry=registry.tasks)
-        self.eta_schedule = Scheduler(self.ready_queue, logger=self.logger)
 
         self.logger.debug("Instantiating thread components...")
 
@@ -174,7 +177,9 @@ def __init__(self, concurrency=None, logfile=None, loglevel=None,
                                     callback=self.process_task,
                                     logger=self.logger)
         self.scheduler = instantiate(eta_scheduler_cls,
-                                     self.eta_schedule, logger=self.logger)
+                               precision=conf.CELERYD_ETA_SCHEDULER_PRECISION,
+                               on_error=self.on_timer_error,
+                               on_tick=self.on_timer_tick)
 
         self.clockservice = None
         if self.embed_clockservice:
@@ -184,7 +189,7 @@ def __init__(self, concurrency=None, logfile=None, loglevel=None,
         prefetch_count = self.concurrency * conf.CELERYD_PREFETCH_MULTIPLIER
         self.listener = instantiate(listener_cls,
                                     self.ready_queue,
-                                    self.eta_schedule,
+                                    self.scheduler,
                                     logger=self.logger,
                                     hostname=self.hostname,
                                     send_events=self.send_events,
@@ -252,3 +257,11 @@ def _shutdown(self, warm=True):
 
         self.listener.close_connection()
         self._state = TERMINATE
+
+    def on_timer_error(self, exc_info):
+        _, exc, _ = exc_info
+        self.logger.error("Timer error: %r" % (exc, ))
+
+    def on_timer_tick(self, delay):
+        self.timer_debug("Scheduler wake-up! Next eta %s secs." % delay)
+

celery/worker/__init__.py

@@ -99,7 +99,7 @@ def rate_limit(panel, task_name, rate_limit, **kwargs):
 
 @Panel.register
 def dump_schedule(panel, safe=False, **kwargs):
-    schedule = panel.listener.eta_schedule
+    schedule = panel.listener.eta_schedule.schedule
     if not schedule.queue:
         panel.logger.info("--Empty schedule--")
         return []