[13.0][UPD] queue_job: use context to execute the job (optional)

Author: acsonefho

queue_job/job.py

@@ -11,6 +11,7 @@
 from datetime import datetime, timedelta
 
 import odoo
+from odoo.tools.safe_eval import safe_eval
 
 from .exception import FailedJobError, NoSuchJobError, RetryableJobError
 
@@ -59,6 +60,7 @@ def __init__(
         description=None,
         channel=None,
         identity_key=None,
+        keep_context=False,
     ):
         self.recordset = recordset
         self.priority = priority
@@ -67,6 +69,7 @@ def __init__(
         self.description = description
         self.channel = channel
         self.identity_key = identity_key
+        self.keep_context = keep_context
 
     def __getattr__(self, name):
         if name in self.recordset:
@@ -88,6 +91,7 @@ def delay(*args, **kwargs):
                 description=self.description,
                 channel=self.channel,
                 identity_key=self.identity_key,
+                keep_context=self.keep_context,
             )
 
         return delay
@@ -339,6 +343,7 @@ def enqueue(
         description=None,
         channel=None,
         identity_key=None,
+        keep_context=False,
     ):
         """Create a Job and enqueue it in the queue. Return the job uuid.
 
@@ -359,6 +364,7 @@ def enqueue(
             description=description,
             channel=channel,
             identity_key=identity_key,
+            keep_context=keep_context,
         )
         if new_job.identity_key:
             existing = new_job.job_record_with_same_identity_key()
@@ -399,6 +405,7 @@ def __init__(
         description=None,
         channel=None,
         identity_key=None,
+        keep_context=False,
     ):
         """ Create a Job
 
@@ -423,8 +430,8 @@ 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`
+        :param keep_context: Determine if the current context should be restored
+        :type keep_context: :bool
         """
         if args is None:
             args = ()
@@ -445,6 +452,7 @@ def __init__(
         self.recordset = recordset
 
         self.env = env
+        self.keep_context = keep_context
         self.job_model = self.env["queue.job"]
         self.job_model_name = "queue.job"
 
@@ -594,8 +602,11 @@ def _store_values(self, create=False):
                     "records": self.recordset,
                     "args": self.args,
                     "kwargs": self.kwargs,
+                    "context": "{}",
                 }
             )
+            if self.keep_context:
+                vals.update({"context": str(self.env.context.copy())})
 
         vals_from_model = self._store_values_from_model()
         # Sanitize values: make sure you cannot screw core values
@@ -615,6 +626,22 @@ def _store_values_from_model(self):
                 vals = handler(self)
         return vals
 
+    def _get_record_context(self):
+        """
+        Get the context to execute the job
+        """
+        # return {}
+        company_ids = []
+        if self.company_id:
+            company_ids = [self.company_id]
+        context_txt = self.db_record().context or {}
+        if isinstance(context_txt, str):
+            context = safe_eval(context_txt)
+        else:
+            context = context_txt
+        context.update({"job_uuid": self.uuid, "allowed_company_ids": company_ids})
+        return context
+
     @property
     def func_string(self):
         model = repr(self.recordset)
@@ -632,12 +659,8 @@ def func(self):
         # Because if you have many, you can have unexpected records due to ir.rule.
         # ir.rule use allowed_company_ids to load every records in many companies.
         # But most of the time, a job should be executed on a single company.
-        company_ids = []
-        if self.company_id:
-            company_ids = [self.company_id]
-        recordset = self.recordset.with_context(
-            job_uuid=self.uuid, allowed_company_ids=company_ids
-        )
+        context = self._get_record_context()
+        recordset = self.recordset.with_context(**context)
         return getattr(recordset, self.method_name)
 
     @property

queue_job/models/base.py

@@ -44,6 +44,7 @@ def with_delay(
         description=None,
         channel=None,
         identity_key=None,
+        keep_context=False,
     ):
         """ Return a ``DelayableRecordset``
 
@@ -81,6 +82,8 @@ def with_delay(
                              the new job will not be added. It is either a
                              string, either a function that takes the job as
                              argument (see :py:func:`..job.identity_exact`).
+        :param keep_context: boolean to set if the current context
+                             should be restored on the recordset (default: False).
         :return: instance of a DelayableRecordset
         :rtype: :class:`odoo.addons.queue_job.job.DelayableRecordset`
 
@@ -108,6 +111,7 @@ def with_delay(
             description=description,
             channel=channel,
             identity_key=identity_key,
+            keep_context=keep_context,
         )
 
     def _patch_job_auto_delay(self, method_name, context_key=None):

queue_job/models/queue_job.py

@@ -57,6 +57,12 @@ class QueueJob(models.Model):
         comodel_name="res.company", string="Company", index=True
     )
     name = fields.Char(string="Description", readonly=True)
+    context = fields.Char(
+        string="Context Value",
+        default="{}",
+        help="Context dictionary as Python expression, empty by default (Default: {})",
+        readonly=True,
+    )
 
     model_name = fields.Char(string="Model", readonly=True)
     method_name = fields.Char(readonly=True)

queue_job/views/queue_job_views.xml

@@ -60,6 +60,9 @@
                             <field name="exec_time" string="Time (s)" />
                         </group>
                     </group>
+                    <group name="context_grp">
+                        <field name="context" />
+                    </group>
                     <group colspan="4">
                         <div>
                             <label for="retry" string="Current try / max. retries" />

test_queue_job/tests/test_job.py

@@ -579,6 +579,56 @@ def test_context_uuid(self):
         self.assertTrue(key_present)
         self.assertEqual(result["job_uuid"], test_job._uuid)
 
+    def test_context_custom_keep_context_default(self):
+        """
+        Use with_delay without specify 'keep_context' key.
+        So ensure the default False value to this params.
+        So the context shouldn't be restored with the recordset.
+        """
+        delayable = (
+            self.env["test.queue.job"].with_context(world_origin=42).with_delay()
+        )
+        test_job = delayable.testing_method()
+        self.assertEqual(test_job.db_record().context, "{}")
+        expected_ctx = {
+            "job_uuid": test_job.uuid,
+            "allowed_company_ids": [test_job.company_id],
+        }
+        self.assertEqual(test_job._get_record_context(), expected_ctx)
+
+    def test_context_custom_keep_context_false(self):
+        """
+        Use with_delay without specify by specifying keep_context to False.
+        So the context shouldn't be restored with the recordset.
+        """
+        delayable = (
+            self.env["test.queue.job"]
+            .with_context(world_origin=42)
+            .with_delay(keep_context=False)
+        )
+        test_job = delayable.testing_method()
+        self.assertEqual(test_job.db_record().context, "{}")
+        expected_ctx = {
+            "job_uuid": test_job.uuid,
+            "allowed_company_ids": [test_job.company_id],
+        }
+        self.assertEqual(test_job._get_record_context(), expected_ctx)
+
+    def test_context_custom_keep_context_true(self):
+        """
+        Use with_delay without specify by specifying keep_context to True.
+        So the context should be restored with the recordset.
+        """
+        recordset = self.env["test.queue.job"].with_context(world_origin=42)
+        delayable = recordset.with_delay(keep_context=True)
+        test_job = delayable.testing_method()
+        self.assertEqual(test_job.db_record().context, str(recordset.env.context))
+        expected_ctx = recordset.env.context.copy()
+        expected_ctx.update(
+            {"job_uuid": test_job.uuid, "allowed_company_ids": [test_job.company_id]}
+        )
+        self.assertEqual(test_job._get_record_context(), expected_ctx)
+
     def test_override_channel(self):
         delayable = self.env["test.queue.job"].with_delay(channel="root.sub.sub")
         test_job = delayable.testing_method(return_context=True)