Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Encode 'task_args' and 'task_kwargs' in 'store_result'. #78

Merged
merged 1 commit into from
Oct 20, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions django_celery_results/backends/database.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,13 @@ def _store_result(self, task_id, result, status,
'children': self.current_task_children(request),
})

task_name = getattr(request, 'task', None) if request else None
task_args = getattr(request,
'argsrepr', getattr(request, 'args', None))
task_kwargs = getattr(request,
'kwargsrepr', getattr(request, 'kwargs', None))
task_name = getattr(request, 'task', None)
_, _, task_args = self.encode_content(
getattr(request, 'argsrepr', getattr(request, 'args', None))
)
_, _, task_kwargs = self.encode_content(
getattr(request, 'kwargsrepr', getattr(request, 'kwargs', None))
)
worker = getattr(request, 'hostname', None)

self.TaskModel._default_manager.store_result(
Expand All @@ -46,8 +48,13 @@ def _get_task_meta_for(self, task_id):
obj = self.TaskModel._default_manager.get_task(task_id)
res = obj.as_dict()
meta = self.decode_content(obj, res.pop('meta', None)) or {}
res.update(meta,
result=self.decode_content(obj, res.get('result')))
result = self.decode_content(obj, res.get('result'))
task_args = self.decode_content(obj, res.get('task_args'))
task_kwargs = self.decode_content(obj, res.get('task_kwargs'))
auvipy marked this conversation as resolved.
Show resolved Hide resolved
res.update(
meta, result=result, task_args=task_args,
task_kwargs=task_kwargs,
)
return self.meta_from_decoded(res)

def encode_content(self, data):
Expand Down
90 changes: 84 additions & 6 deletions t/unit/backends/test_database.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,36 @@ def setup_backend(self):
'django_celery_results.backends:DatabaseBackend')
self.b = DatabaseBackend(app=self.app)

def test_backend__pickle_serialization(self):
def test_backend__pickle_serialization__dict_result(self):
self.app.conf.result_serializer = 'pickle'
self.app.conf.accept_content = {'pickle', 'json'}
self.b = DatabaseBackend(app=self.app)

tid2 = uuid()
result = {'foo': 'baz', 'bar': SomeClass(12345)}
self.b.mark_as_done(tid2, result)
# is serialized properly.
rindb = self.b.get_result(tid2)
assert rindb.get('foo') == 'baz'
assert rindb.get('bar').data == 12345
request = mock.MagicMock()
request.task = 'my_task'
request.args = ['a', 1, SomeClass(67)]
request.kwargs = {'c': 6, 'd': 'e', 'f': SomeClass(89)}
request.hostname = 'celery@ip-0-0-0-0'
del request.argsrepr, request.kwargsrepr

self.b.mark_as_done(tid2, result, request=request)
mindb = self.b.get_task_meta(tid2)

assert mindb.get('result').get('foo') == 'baz'
assert mindb.get('result').get('bar').data == 12345
assert mindb.get('task_name') == 'my_task'

assert len(mindb.get('task_args')) == 3
assert mindb.get('task_args')[0] == 'a'
assert mindb.get('task_args')[1] == 1
assert mindb.get('task_args')[2].data == 67

assert len(mindb.get('task_kwargs')) == 3
assert mindb.get('task_kwargs')['c'] == 6
assert mindb.get('task_kwargs')['d'] == 'e'
assert mindb.get('task_kwargs')['f'].data == 89

tid3 = uuid()
try:
Expand All @@ -49,6 +67,66 @@ def test_backend__pickle_serialization(self):
assert self.b.get_status(tid3) == states.FAILURE
assert isinstance(self.b.get_result(tid3), KeyError)

def test_backend__pickle_serialization__str_result(self):
self.app.conf.result_serializer = 'pickle'
self.app.conf.accept_content = {'pickle', 'json'}
self.b = DatabaseBackend(app=self.app)

tid2 = uuid()
result = 'foo'
request = mock.MagicMock()
request.task = 'my_task'
request.args = ['a', 1, SomeClass(67)]
request.kwargs = {'c': 6, 'd': 'e', 'f': SomeClass(89)}
request.hostname = 'celery@ip-0-0-0-0'
del request.argsrepr, request.kwargsrepr

self.b.mark_as_done(tid2, result, request=request)
mindb = self.b.get_task_meta(tid2)

assert mindb.get('result') == 'foo'
assert mindb.get('task_name') == 'my_task'

assert len(mindb.get('task_args')) == 3
assert mindb.get('task_args')[0] == 'a'
assert mindb.get('task_args')[1] == 1
assert mindb.get('task_args')[2].data == 67

assert len(mindb.get('task_kwargs')) == 3
assert mindb.get('task_kwargs')['c'] == 6
assert mindb.get('task_kwargs')['d'] == 'e'
assert mindb.get('task_kwargs')['f'].data == 89

def test_backend__pickle_serialization__bytes_result(self):
self.app.conf.result_serializer = 'pickle'
self.app.conf.accept_content = {'pickle', 'json'}
self.b = DatabaseBackend(app=self.app)

tid2 = uuid()
result = b'foo'
request = mock.MagicMock()
request.task = 'my_task'
request.args = ['a', 1, SomeClass(67)]
request.kwargs = {'c': 6, 'd': 'e', 'f': SomeClass(89)}
request.hostname = 'celery@ip-0-0-0-0'
del request.argsrepr, request.kwargsrepr

self.b.mark_as_done(tid2, result, request=request)
mindb = self.b.get_task_meta(tid2)

assert mindb.get('result') == b'foo'
assert mindb.get('task_name') == 'my_task'

assert len(mindb.get('task_args')) == 3
assert mindb.get('task_args')[0] == 'a'
assert mindb.get('task_args')[1] == 1
assert mindb.get('task_args')[2].data == 67

assert len(mindb.get('task_kwargs')) == 3
assert mindb.get('task_kwargs')['c'] == 6
assert mindb.get('task_kwargs')['d'] == 'e'
assert mindb.get('task_kwargs')['f'].data == 89

def xxx_backend(self):
tid = uuid()

Expand Down