Show More
@@ -1,228 +1,228 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | |
|
3 | 3 | # Copyright (C) 2010-2016 RhodeCode GmbH |
|
4 | 4 | # |
|
5 | 5 | # This program is free software: you can redistribute it and/or modify |
|
6 | 6 | # it under the terms of the GNU Affero General Public License, version 3 |
|
7 | 7 | # (only), as published by the Free Software Foundation. |
|
8 | 8 | # |
|
9 | 9 | # This program is distributed in the hope that it will be useful, |
|
10 | 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
11 | 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
12 | 12 | # GNU General Public License for more details. |
|
13 | 13 | # |
|
14 | 14 | # You should have received a copy of the GNU Affero General Public License |
|
15 | 15 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
|
16 | 16 | # |
|
17 | 17 | # This program is dual-licensed. If you wish to learn more about the |
|
18 | 18 | # RhodeCode Enterprise Edition, including its added features, Support services, |
|
19 | 19 | # and proprietary license terms, please see https://rhodecode.com/licenses/ |
|
20 | 20 | """ |
|
21 | 21 | celery libs for RhodeCode |
|
22 | 22 | """ |
|
23 | 23 | |
|
24 | 24 | |
|
25 | 25 | import pylons |
|
26 | 26 | import socket |
|
27 | 27 | import logging |
|
28 | 28 | |
|
29 | 29 | import rhodecode |
|
30 | 30 | |
|
31 | 31 | from os.path import join as jn |
|
32 | 32 | from pylons import config |
|
33 | 33 | from celery.task import Task |
|
34 | 34 | from pyramid.request import Request |
|
35 | 35 | from pyramid.scripting import prepare |
|
36 | 36 | from pyramid.threadlocal import get_current_request |
|
37 | 37 | |
|
38 | 38 | from decorator import decorator |
|
39 | 39 | |
|
40 | 40 | from zope.cachedescriptors.property import Lazy as LazyProperty |
|
41 | 41 | |
|
42 | 42 | from rhodecode.config import utils |
|
43 | 43 | from rhodecode.lib.utils2 import ( |
|
44 | 44 | safe_str, md5_safe, aslist, get_routes_generator_for_server_url, |
|
45 | 45 | get_server_url) |
|
46 | 46 | from rhodecode.lib.pidlock import DaemonLock, LockHeld |
|
47 | 47 | from rhodecode.lib.vcs import connect_vcs |
|
48 | 48 | from rhodecode.model import meta |
|
49 | 49 | from rhodecode.lib.auth import AuthUser |
|
50 | 50 | |
|
51 | 51 | log = logging.getLogger(__name__) |
|
52 | 52 | |
|
53 | 53 | |
|
54 | 54 | class ResultWrapper(object): |
|
55 | 55 | def __init__(self, task): |
|
56 | 56 | self.task = task |
|
57 | 57 | |
|
58 | 58 | @LazyProperty |
|
59 | 59 | def result(self): |
|
60 | 60 | return self.task |
|
61 | 61 | |
|
62 | 62 | |
|
63 | 63 | class RhodecodeCeleryTask(Task): |
|
64 | 64 | """ |
|
65 | 65 | This is a celery task which will create a rhodecode app instance context |
|
66 | 66 | for the task, patch pyramid + pylons threadlocals with the original request |
|
67 | 67 | that created the task and also add the user to the context. |
|
68 | 68 | |
|
69 | 69 | This class as a whole should be removed once the pylons port is complete |
|
70 | 70 | and a pyramid only solution for celery is implemented as per issue #4139 |
|
71 | 71 | """ |
|
72 | 72 | |
|
73 | 73 | def apply_async(self, args=None, kwargs=None, task_id=None, producer=None, |
|
74 | 74 | link=None, link_error=None, **options): |
|
75 | 75 | """ queue the job to run (we are in web request context here) """ |
|
76 | 76 | |
|
77 | 77 | request = get_current_request() |
|
78 | 78 | |
|
79 | 79 | # we hook into kwargs since it is the only way to pass our data to the |
|
80 | 80 | # celery worker in celery 2.2 |
|
81 | 81 | kwargs.update({ |
|
82 | 82 | '_rhodecode_proxy_data': { |
|
83 | 83 | 'environ': { |
|
84 | 84 | 'PATH_INFO': request.environ['PATH_INFO'], |
|
85 | 85 | 'SCRIPT_NAME': request.environ['SCRIPT_NAME'], |
|
86 | 86 | 'HTTP_HOST': request.environ.get('HTTP_HOST', |
|
87 | 87 | request.environ['SERVER_NAME']), |
|
88 | 88 | 'SERVER_NAME': request.environ['SERVER_NAME'], |
|
89 | 89 | 'SERVER_PORT': request.environ['SERVER_PORT'], |
|
90 | 90 | 'wsgi.url_scheme': request.environ['wsgi.url_scheme'], |
|
91 | 91 | }, |
|
92 | 92 | 'auth_user': { |
|
93 | 93 | 'ip_addr': request.user.ip_addr, |
|
94 | 94 | 'user_id': request.user.user_id |
|
95 | 95 | }, |
|
96 | 96 | } |
|
97 | 97 | }) |
|
98 | 98 | return super(RhodecodeCeleryTask, self).apply_async( |
|
99 | 99 | args, kwargs, task_id, producer, link, link_error, **options) |
|
100 | 100 | |
|
101 | 101 | def __call__(self, *args, **kwargs): |
|
102 | 102 | """ rebuild the context and then run task on celery worker """ |
|
103 | 103 | proxy_data = kwargs.pop('_rhodecode_proxy_data', {}) |
|
104 | 104 | |
|
105 | 105 | if not proxy_data: |
|
106 | 106 | return super(RhodecodeCeleryTask, self).__call__(*args, **kwargs) |
|
107 | 107 | |
|
108 | 108 | log.debug('using celery proxy data to run task: %r', proxy_data) |
|
109 | 109 | |
|
110 | 110 | from rhodecode.config.routing import make_map |
|
111 | 111 | from rhodecode.config.middleware import make_pyramid_app |
|
112 | 112 | |
|
113 | 113 | # TODO: this can be done once per worker versus per task |
|
114 | 114 | pyramid_app = make_pyramid_app(config, **config['app_conf']) |
|
115 | 115 | |
|
116 | 116 | request = Request.blank('/', environ=proxy_data['environ']) |
|
117 | 117 | request.user = AuthUser(user_id=proxy_data['auth_user']['user_id'], |
|
118 | 118 | ip_addr=proxy_data['auth_user']['ip_addr']) |
|
119 | 119 | |
|
120 | 120 | pyramid_request = prepare(request) # set pyramid threadlocal request |
|
121 | 121 | |
|
122 | 122 | # pylons routing |
|
123 | 123 | if not rhodecode.CONFIG.get('routes.map'): |
|
124 | 124 | rhodecode.CONFIG['routes.map'] = make_map(config) |
|
125 | 125 | pylons.url._push_object(get_routes_generator_for_server_url( |
|
126 | 126 | get_server_url(request.environ) |
|
127 | 127 | )) |
|
128 | 128 | |
|
129 | 129 | try: |
|
130 | 130 | return super(RhodecodeCeleryTask, self).__call__(*args, **kwargs) |
|
131 | 131 | finally: |
|
132 | 132 | pyramid_request['closer']() |
|
133 | 133 | pylons.url._pop_object() |
|
134 | 134 | |
|
135 | 135 | |
|
136 | 136 | def run_task(task, *args, **kwargs): |
|
137 | 137 | if rhodecode.CELERY_ENABLED: |
|
138 | 138 | celery_is_up = False |
|
139 | 139 | try: |
|
140 | 140 | t = task.apply_async(args=args, kwargs=kwargs) |
|
141 | 141 | log.info('running task %s:%s', t.task_id, task) |
|
142 | 142 | celery_is_up = True |
|
143 | 143 | return t |
|
144 | 144 | |
|
145 | 145 | except socket.error as e: |
|
146 | 146 | if isinstance(e, IOError) and e.errno == 111: |
|
147 | 147 | log.error('Unable to connect to celeryd. Sync execution') |
|
148 | 148 | else: |
|
149 | 149 | log.exception("Exception while connecting to celeryd.") |
|
150 | 150 | except KeyError as e: |
|
151 | 151 | log.error('Unable to connect to celeryd. Sync execution') |
|
152 | 152 | except Exception as e: |
|
153 | 153 | log.exception( |
|
154 | 154 | "Exception while trying to run task asynchronous. " |
|
155 | 155 | "Fallback to sync execution.") |
|
156 | 156 | |
|
157 | 157 | # keep in mind there maybe a subtle race condition where something |
|
158 | 158 | # depending on rhodecode.CELERY_ENABLED such as @dbsession decorator |
|
159 | 159 | # will see CELERY_ENABLED as True before this has a chance to set False |
|
160 | 160 | rhodecode.CELERY_ENABLED = celery_is_up |
|
161 | 161 | else: |
|
162 | 162 | log.debug('executing task %s in sync mode', task) |
|
163 | 163 | return ResultWrapper(task(*args, **kwargs)) |
|
164 | 164 | |
|
165 | 165 | |
|
166 | 166 | def __get_lockkey(func, *fargs, **fkwargs): |
|
167 | 167 | params = list(fargs) |
|
168 | 168 | params.extend(['%s-%s' % ar for ar in fkwargs.items()]) |
|
169 | 169 | |
|
170 | 170 | func_name = str(func.__name__) if hasattr(func, '__name__') else str(func) |
|
171 | 171 | _lock_key = func_name + '-' + '-'.join(map(safe_str, params)) |
|
172 | 172 | return 'task_%s.lock' % (md5_safe(_lock_key),) |
|
173 | 173 | |
|
174 | 174 | |
|
175 | 175 | def locked_task(func): |
|
176 | 176 | def __wrapper(func, *fargs, **fkwargs): |
|
177 | 177 | lockkey = __get_lockkey(func, *fargs, **fkwargs) |
|
178 | 178 | lockkey_path = config['app_conf']['cache_dir'] |
|
179 | 179 | |
|
180 | 180 | log.info('running task with lockkey %s' % lockkey) |
|
181 | 181 | try: |
|
182 | 182 | l = DaemonLock(file_=jn(lockkey_path, lockkey)) |
|
183 | 183 | ret = func(*fargs, **fkwargs) |
|
184 | 184 | l.release() |
|
185 | 185 | return ret |
|
186 | 186 | except LockHeld: |
|
187 | 187 | log.info('LockHeld') |
|
188 | 188 | return 'Task with key %s already running' % lockkey |
|
189 | 189 | |
|
190 | 190 | return decorator(__wrapper, func) |
|
191 | 191 | |
|
192 | 192 | |
|
193 | 193 | def get_session(): |
|
194 | 194 | if rhodecode.CELERY_ENABLED: |
|
195 | 195 | utils.initialize_database(config) |
|
196 | 196 | sa = meta.Session() |
|
197 | 197 | return sa |
|
198 | 198 | |
|
199 | 199 | |
|
200 | 200 | def dbsession(func): |
|
201 | 201 | def __wrapper(func, *fargs, **fkwargs): |
|
202 | 202 | try: |
|
203 | 203 | ret = func(*fargs, **fkwargs) |
|
204 | 204 | return ret |
|
205 | 205 | finally: |
|
206 | 206 | if rhodecode.CELERY_ENABLED and not rhodecode.CELERY_EAGER: |
|
207 | 207 | meta.Session.remove() |
|
208 | 208 | |
|
209 | 209 | return decorator(__wrapper, func) |
|
210 | 210 | |
|
211 | 211 | |
|
212 | 212 | def vcsconnection(func): |
|
213 | 213 | def __wrapper(func, *fargs, **fkwargs): |
|
214 | 214 | if rhodecode.CELERY_ENABLED and not rhodecode.CELERY_EAGER: |
|
215 | backends = config['vcs.backends'] = aslist( | |
|
216 | config.get('vcs.backends', 'hg,git'), sep=',') | |
|
215 | settings = rhodecode.PYRAMID_SETTINGS | |
|
216 | backends = settings['vcs.backends'] | |
|
217 | 217 | for alias in rhodecode.BACKENDS.keys(): |
|
218 | 218 | if alias not in backends: |
|
219 | 219 | del rhodecode.BACKENDS[alias] |
|
220 |
utils.configure_pyro4( |
|
|
221 |
utils.configure_vcs( |
|
|
220 | utils.configure_pyro4(settings) | |
|
221 | utils.configure_vcs(settings) | |
|
222 | 222 | connect_vcs( |
|
223 |
|
|
|
224 |
utils.get_vcs_server_protocol( |
|
|
223 | settings['vcs.server'], | |
|
224 | utils.get_vcs_server_protocol(settings)) | |
|
225 | 225 | ret = func(*fargs, **fkwargs) |
|
226 | 226 | return ret |
|
227 | 227 | |
|
228 | 228 | return decorator(__wrapper, func) |
General Comments 0
You need to be logged in to leave comments.
Login now