celery: move pyramid app to celery init rather than per task run

rhodecode/lib/celerylib/__init__.py

@@ -1,228 +1,224 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2010-2016  RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 """
 celery libs for RhodeCode
 """
 
 
 import pylons
 import socket
 import logging
 
 import rhodecode
 
 from os.path import join as jn
 from pylons import config
 from celery.task import Task
 from pyramid.request import Request
 from pyramid.scripting import prepare
 from pyramid.threadlocal import get_current_request
 
 from decorator import decorator
 
 from zope.cachedescriptors.property import Lazy as LazyProperty
 
 from rhodecode.config import utils
 from rhodecode.lib.utils2 import (
     safe_str, md5_safe, aslist, get_routes_generator_for_server_url,
     get_server_url)
 from rhodecode.lib.pidlock import DaemonLock, LockHeld
 from rhodecode.lib.vcs import connect_vcs
 from rhodecode.model import meta
 from rhodecode.lib.auth import AuthUser
 
 log = logging.getLogger(__name__)
 
 
 class ResultWrapper(object):
     def __init__(self, task):
         self.task = task
 
     @LazyProperty
     def result(self):
         return self.task
 
 
 class RhodecodeCeleryTask(Task):
     """
     This is a celery task which will create a rhodecode app instance context
     for the task, patch pyramid + pylons threadlocals with the original request
     that created the task and also add the user to the context.
 
     This class as a whole should be removed once the pylons port is complete
     and a pyramid only solution for celery is implemented as per issue #4139
     """
 
     def apply_async(self, args=None, kwargs=None, task_id=None, producer=None,
                     link=None, link_error=None, **options):
         """ queue the job to run (we are in web request context here) """
 
         request = get_current_request()
 
         # we hook into kwargs since it is the only way to pass our data to the
         # celery worker in celery 2.2
         kwargs.update({
             '_rhodecode_proxy_data': {
                 'environ': {
                     'PATH_INFO': request.environ['PATH_INFO'],
                     'SCRIPT_NAME': request.environ['SCRIPT_NAME'],
                     'HTTP_HOST': request.environ.get('HTTP_HOST',
                         request.environ['SERVER_NAME']),
                     'SERVER_NAME': request.environ['SERVER_NAME'],
                     'SERVER_PORT': request.environ['SERVER_PORT'],
                     'wsgi.url_scheme': request.environ['wsgi.url_scheme'],
                 },
                 'auth_user': {
                     'ip_addr': request.user.ip_addr,
                     'user_id': request.user.user_id
                 },
             }
         })
         return super(RhodecodeCeleryTask, self).apply_async(
             args, kwargs, task_id, producer, link, link_error, **options)
 
     def __call__(self, *args, **kwargs):
         """ rebuild the context and then run task on celery worker """
         proxy_data = kwargs.pop('_rhodecode_proxy_data', {})
 
         if not proxy_data:
             return super(RhodecodeCeleryTask, self).__call__(*args, **kwargs)
 
         log.debug('using celery proxy data to run task: %r', proxy_data)
 
         from rhodecode.config.routing import make_map
-        from rhodecode.config.middleware import make_pyramid_app
-
-        # TODO: this can be done once per worker versus per task
-        pyramid_app = make_pyramid_app(config, **config['app_conf'])
 
         request = Request.blank('/', environ=proxy_data['environ'])
         request.user = AuthUser(user_id=proxy_data['auth_user']['user_id'],
                                 ip_addr=proxy_data['auth_user']['ip_addr'])
 
         pyramid_request = prepare(request) # set pyramid threadlocal request
 
         # pylons routing
         if not rhodecode.CONFIG.get('routes.map'):
             rhodecode.CONFIG['routes.map'] = make_map(config)
         pylons.url._push_object(get_routes_generator_for_server_url(
             get_server_url(request.environ)
         ))
 
         try:
             return super(RhodecodeCeleryTask, self).__call__(*args, **kwargs)
         finally:
             pyramid_request['closer']()
             pylons.url._pop_object()
 
 
 def run_task(task, *args, **kwargs):
     if rhodecode.CELERY_ENABLED:
         celery_is_up = False
         try:
             t = task.apply_async(args=args, kwargs=kwargs)
             log.info('running task %s:%s', t.task_id, task)
             celery_is_up = True
             return t
 
         except socket.error as e:
             if isinstance(e, IOError) and e.errno == 111:
                 log.error('Unable to connect to celeryd. Sync execution')
             else:
                 log.exception("Exception while connecting to celeryd.")
         except KeyError as e:
             log.error('Unable to connect to celeryd. Sync execution')
         except Exception as e:
             log.exception(
                 "Exception while trying to run task asynchronous. "
                 "Fallback to sync execution.")
 
         # keep in mind there maybe a subtle race condition where something
         # depending on rhodecode.CELERY_ENABLED such as @dbsession decorator
         # will see CELERY_ENABLED as True before this has a chance to set False
         rhodecode.CELERY_ENABLED = celery_is_up
     else:
         log.debug('executing task %s in sync mode', task)
     return ResultWrapper(task(*args, **kwargs))
 
 
 def __get_lockkey(func, *fargs, **fkwargs):
     params = list(fargs)
     params.extend(['%s-%s' % ar for ar in fkwargs.items()])
 
     func_name = str(func.__name__) if hasattr(func, '__name__') else str(func)
     _lock_key = func_name + '-' + '-'.join(map(safe_str, params))
     return 'task_%s.lock' % (md5_safe(_lock_key),)
 
 
 def locked_task(func):
     def __wrapper(func, *fargs, **fkwargs):
         lockkey = __get_lockkey(func, *fargs, **fkwargs)
         lockkey_path = config['app_conf']['cache_dir']
 
         log.info('running task with lockkey %s' % lockkey)
         try:
             l = DaemonLock(file_=jn(lockkey_path, lockkey))
             ret = func(*fargs, **fkwargs)
             l.release()
             return ret
         except LockHeld:
             log.info('LockHeld')
             return 'Task with key %s already running' % lockkey
 
     return decorator(__wrapper, func)
 
 
 def get_session():
     if rhodecode.CELERY_ENABLED:
         utils.initialize_database(config)
     sa = meta.Session()
     return sa
 
 
 def dbsession(func):
     def __wrapper(func, *fargs, **fkwargs):
         try:
             ret = func(*fargs, **fkwargs)
             return ret
         finally:
             if rhodecode.CELERY_ENABLED and not rhodecode.CELERY_EAGER:
                 meta.Session.remove()
 
     return decorator(__wrapper, func)
 
 
 def vcsconnection(func):
     def __wrapper(func, *fargs, **fkwargs):
         if rhodecode.CELERY_ENABLED and not rhodecode.CELERY_EAGER:
             settings = rhodecode.PYRAMID_SETTINGS
             backends = settings['vcs.backends']
             for alias in rhodecode.BACKENDS.keys():
                 if alias not in backends:
                     del rhodecode.BACKENDS[alias]
             utils.configure_pyro4(settings)
             utils.configure_vcs(settings)
             connect_vcs(
                 settings['vcs.server'],
                 utils.get_vcs_server_protocol(settings))
         ret = func(*fargs, **fkwargs)
         return ret
 
     return decorator(__wrapper, func)

rhodecode/lib/celerypylons/loader.py

@@ -1,88 +1,92 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2012-2016  RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 from celery.loaders.base import BaseLoader
 from pylons import config
 
 to_pylons = lambda x: x.replace('_', '.').lower()
 to_celery = lambda x: x.replace('.', '_').upper()
 
 LIST_PARAMS = """CELERY_IMPORTS ADMINS ROUTES""".split()
 
 
 class PylonsSettingsProxy(object):
     """Pylons Settings Proxy
 
     Proxies settings from pylons.config
 
     """
     def __getattr__(self, key):
         pylons_key = to_pylons(key)
         try:
             value = config[pylons_key]
             if key in LIST_PARAMS:return value.split()
             return self.type_converter(value)
         except KeyError:
             raise AttributeError(pylons_key)
 
     def get(self, key):
         try:
             return self.__getattr__(key)
         except AttributeError:
             return None
 
     def __getitem__(self, key):
         try:
             return self.__getattr__(key)
         except AttributeError:
             raise KeyError()
 
     def __setattr__(self, key, value):
         pylons_key = to_pylons(key)
         config[pylons_key] = value
 
     def __setitem__(self, key, value):
         self.__setattr__(key, value)
 
     def type_converter(self, value):
         #cast to int
         if value.isdigit():
             return int(value)
 
         #cast to bool
         if value.lower() in ['true', 'false']:
             return value.lower() == 'true'
         return value
 
 class PylonsLoader(BaseLoader):
     """Pylons celery loader
 
     Maps the celery config onto pylons.config
 
     """
     def read_configuration(self):
         self.configured = True
         return PylonsSettingsProxy()
 
     def on_worker_init(self):
         """
         Import task modules.
         """
         self.import_default_modules()
+        from rhodecode.config.middleware import make_pyramid_app
+
+        # adding to self to keep a reference around
+        self.pyramid_app = make_pyramid_app(config, **config['app_conf'])