Add storage of context in jobs recordsets

Author: guewen

queue_job/fields.py

@@ -69,6 +69,9 @@ def convert_to_record(self, value, record):
 class JobEncoder(json.JSONEncoder):
     """Encode Odoo recordsets so that we can later recompose them"""
 
+    def _get_record_context(self, obj):
+        return obj._job_prepare_context_before_enqueue()
+
     def default(self, obj):
         if isinstance(obj, models.BaseModel):
             return {
@@ -77,6 +80,7 @@ def default(self, obj):
                 "ids": obj.ids,
                 "uid": obj.env.uid,
                 "su": obj.env.su,
+                "context": self._get_record_context(obj),
             }
         elif isinstance(obj, datetime):
             return {"_type": "datetime_isoformat", "value": obj.isoformat()}

queue_job/job.py

@@ -423,8 +423,6 @@ def __init__(
         :param identity_key: A hash to uniquely identify a job, or a function
                              that returns this hash (the function takes the job
                              as argument)
-        :param env: Odoo Environment
-        :type env: :class:`odoo.api.Environment`
         """
         if args is None:
             args = ()

queue_job/models/base.py

@@ -216,3 +216,28 @@ def _job_store_values(self, job):
         :return: dictionary for setting job values.
         """
         return {}
+
+    @api.model
+    def _job_prepare_context_before_enqueue_keys(self):
+        """Keys to keep in context of stored jobs
+
+        Empty by default for backward compatibility.
+        """
+        return (
+            "tz",
+            "lang",
+            "allowed_company_ids",
+            "force_company",
+            "active_test",
+        )
+
+    def _job_prepare_context_before_enqueue(self):
+        """Return the context to store in the jobs
+
+        Can be used to keep only safe keys.
+        """
+        return {
+            key: value
+            for key, value in self.env.context.items()
+            if key in self._job_prepare_context_before_enqueue_keys()
+        }

queue_job/readme/USAGE.rst

@@ -118,6 +118,12 @@ Based on this configuration, we can tell that:
 * retries 10 to 15 postponed 30 seconds later
 * all subsequent retries postponed 5 minutes later
 
+**Job Context**
+
+The context of the recordset of the job, or any recordset passed in arguments of
+a job, is transferred to the job according to an allow-list. The allow-list can
+be customized in ``Base._job_prepare_context_before_enqueue_keys``.
+
 **Bypass jobs on running Odoo**
 
 When you are developing (ie: connector modules) you might want

queue_job/tests/test_json_field.py

@@ -16,7 +16,8 @@
 class TestJson(common.TransactionCase):
     def test_encoder_recordset(self):
         demo_user = self.env.ref("base.user_demo")
-        partner = self.env(user=demo_user).ref("base.main_partner")
+        context = demo_user.context_get()
+        partner = self.env(user=demo_user, context=context).ref("base.main_partner")
         value = partner
         value_json = json.dumps(value, cls=JobEncoder)
         expected = {
@@ -25,12 +26,14 @@ def test_encoder_recordset(self):
             "model": "res.partner",
             "ids": [partner.id],
             "su": False,
+            "context": context,
         }
         self.assertEqual(json.loads(value_json), expected)
 
     def test_encoder_recordset_list(self):
         demo_user = self.env.ref("base.user_demo")
-        partner = self.env(user=demo_user).ref("base.main_partner")
+        context = demo_user.context_get()
+        partner = self.env(user=demo_user, context=context).ref("base.main_partner")
         value = ["a", 1, partner]
         value_json = json.dumps(value, cls=JobEncoder)
         expected = [
@@ -42,18 +45,22 @@ def test_encoder_recordset_list(self):
                 "model": "res.partner",
                 "ids": [partner.id],
                 "su": False,
+                "context": context,
             },
         ]
         self.assertEqual(json.loads(value_json), expected)
 
     def test_decoder_recordset(self):
         demo_user = self.env.ref("base.user_demo")
+        context = demo_user.context_get()
         partner = self.env(user=demo_user).ref("base.main_partner")
         value_json = (
             '{"_type": "odoo_recordset",'
             '"model": "res.partner",'
             '"su": false,'
-            '"ids": [%s],"uid": %s}' % (partner.id, demo_user.id)
+            '"ids": [%s],"uid": %s, '
+            '"context": {"tz": "%s", "lang": "%s"}}'
+            % (partner.id, demo_user.id, context["tz"], context["lang"])
         )
         expected = partner
         value = json.loads(value_json, cls=JobDecoder, env=self.env)
@@ -62,13 +69,16 @@ def test_decoder_recordset(self):
 
     def test_decoder_recordset_list(self):
         demo_user = self.env.ref("base.user_demo")
+        context = demo_user.context_get()
         partner = self.env(user=demo_user).ref("base.main_partner")
         value_json = (
             '["a", 1, '
             '{"_type": "odoo_recordset",'
             '"model": "res.partner",'
             '"su": false,'
-            '"ids": [%s],"uid": %s}]' % (partner.id, demo_user.id)
+            '"ids": [%s],"uid": %s, '
+            '"context": {"tz": "%s", "lang": "%s"}}]'
+            % (partner.id, demo_user.id, context["tz"], context["lang"])
         )
         expected = ["a", 1, partner]
         value = json.loads(value_json, cls=JobDecoder, env=self.env)