Merge pull request #4601 from scottdillon/3994-fix-background-job-tim…

…eout

3994 fix background job timeout

ckan/config/deployment.ini_tmpl

@@ -191,6 +191,8 @@ ckan.hide_activity_from_users = %(ckan.site_id)s
 #smtp.password = your_password
 #smtp.mail_from =
 
+## Background Job Settings
+ckan.jobs.timeout = 180
 
 ## Logging configuration
 [loggers]

ckan/lib/jobs.py

@@ -36,6 +36,7 @@
 log = logging.getLogger(__name__)
 
 DEFAULT_QUEUE_NAME = u'default'
+DEFAULT_JOB_TIMEOUT = config.get(u'ckan.jobs.timeout', 180)
 
 # RQ job queues. Do not use this directly, use ``get_queue`` instead.
 _queues = {}
@@ -123,7 +124,8 @@ def get_queue(name=DEFAULT_QUEUE_NAME):
         return queue
 
 
-def enqueue(fn, args=None, kwargs=None, title=None, queue=DEFAULT_QUEUE_NAME):
+def enqueue(fn, args=None, kwargs=None, title=None, queue=DEFAULT_QUEUE_NAME,
+            timeout=DEFAULT_JOB_TIMEOUT):
     u'''
     Enqueue a job to be run in the background.
 
@@ -141,14 +143,18 @@ def enqueue(fn, args=None, kwargs=None, title=None, queue=DEFAULT_QUEUE_NAME):
     :param string queue: Name of the queue. If not given then the
         default queue is used.
 
+    :param integer timeout: The timeout, in seconds, to be passed
+        to the background job via rq.
+
     :returns: The enqueued job.
     :rtype: ``rq.job.Job``
     '''
     if args is None:
         args = []
     if kwargs is None:
         kwargs = {}
-    job = get_queue(queue).enqueue_call(func=fn, args=args, kwargs=kwargs)
+    job = get_queue(queue).enqueue_call(func=fn, args=args, kwargs=kwargs,
+                                        timeout=timeout)
     job.meta[u'title'] = title
     job.save()
     msg = u'Added background job {}'.format(job.id)

ckan/tests/lib/test_jobs.py

@@ -74,6 +74,18 @@ def test_enqueue_queue(self):
         assert_equal(all_jobs[1].origin,
                      jobs.add_queue_name_prefix(u'my_queue'))
 
+    def test_enqueue_timeout(self):
+        self.enqueue()
+        self.enqueue(timeout=0)
+        self.enqueue(timeout=-1)
+        self.enqueue(timeout=3600)
+        all_jobs = self.all_jobs()
+        assert_equal(len(all_jobs), 4)
+        assert_equal(all_jobs[0].timeout, 180)
+        assert_equal(all_jobs[1].timeout, 180)
+        assert_equal(all_jobs[2].timeout, -1)
+        assert_equal(all_jobs[3].timeout, 3600)
+
 
 class TestGetAllQueues(RQTestBase):
 

doc/maintaining/background-tasks.rst

@@ -99,6 +99,12 @@ You can also give the job a title which can be useful for identifying it when
 
     jobs.enqueue(log_job, [u'My log message'], title=u'My log job')
 
+A timeout can also be set on a job iwth the ``timeout`` keyword argument::
+
+    jobs.enqueue(log_job, [u'My log message'], timeout=3600)
+
+The default background job timeout is 180 seconds. This is set in the
+ckan config ``.ini`` file under the ``ckan.jobs.timeout`` item.
 
 Accessing the database from background jobs
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

test-core.ini

@@ -101,6 +101,9 @@ who.config_file = %(here)s/who.ini
 who.log_level = warning
 who.log_file = %(cache_dir)s/who_log.ini
 
+## background jobs
+ckan.jobs.timeout = 180
+
 # Logging configuration
 [loggers]
 keys = root, ckan, sqlalchemy