Fix mutability of job arguments

The model name, method name, recordset ids, arguments and keyword
arguments must never ever be modified after the creation of a job.
This change fix a bug when a job with a mutable argument see the content
of the argument being modified during the execution of a job.

Author: Guewen Baconnier

queue_job/job.py

@@ -380,12 +380,6 @@ def store(self):
                 'date_started': False,
                 'date_done': False,
                 'eta': False,
-                'model_name': self.model_name,
-                'method_name': self.method_name,
-                'record_ids': self.recordset.ids,
-                # TODO: use custom serializer for recordsets
-                'args': self.args,
-                'kwargs': self.kwargs,
                 }
 
         dt_to_string = odoo.fields.Datetime.to_string
@@ -403,9 +397,16 @@ def store(self):
             db_record.write(vals)
         else:
             date_created = dt_to_string(self.date_created)
+            # The following values must never be modified after the
+            # creation of the job
             vals.update({'uuid': self.uuid,
                          'name': self.description,
                          'date_created': date_created,
+                         'model_name': self.model_name,
+                         'method_name': self.method_name,
+                         'record_ids': self.recordset.ids,
+                         'args': self.args,
+                         'kwargs': self.kwargs,
                          })
 
             self.env[self.job_model_name].sudo().create(vals)

test_queue_job/models/test_models.py

@@ -67,6 +67,12 @@ def job_with_retry_pattern__no_zero(self):
     def mapped(self, func):
         return super(TestQueueJob, self).mapped(func)
 
+    @job
+    def job_alter_mutable(self, mutable_arg, mutable_kwarg=None):
+        mutable_arg.append(2)
+        mutable_kwarg['b'] = 2
+        return mutable_arg, mutable_kwarg
+
 
 class TestQueueChannel(models.Model):
 

test_queue_job/tests/test_job.py

@@ -380,6 +380,28 @@ def test_job_delay_model_method_multi(self):
         self.assertEquals(job_instance.method_name, 'mapped')
         self.assertEquals(['test1', 'test2'], job_instance.perform())
 
+    def test_job_with_mutable_arguments(self):
+        """ Job with mutable arguments do not mutate on perform() """
+        delayable = self.env['test.queue.job'].with_delay()
+        job_instance = delayable.job_alter_mutable([1], mutable_kwarg={'a': 1})
+        self.assertTrue(job_instance)
+        result = job_instance.perform()
+        self.assertEquals(
+            result,
+            ([1, 2], {'a': 1, 'b': 2})
+        )
+        job_instance.set_done()
+        # at this point, the 'args' and 'kwargs' of the job instance
+        # might have been modified, but they must never be modified in
+        # the queue_job table after their creation, so a new 'load' will
+        # get the initial values.
+        job_instance.store()
+        # jobs are always loaded before being performed, so we simulate
+        # this behavior here to check if we have the correct initial arguments
+        job_instance = Job.load(self.env, job_instance.uuid)
+        self.assertEquals(([1],), job_instance.args)
+        self.assertEquals({'mutable_kwarg': {'a': 1}}, job_instance.kwargs)
+
 
 class TestJobModel(common.TransactionCase):