[IMP] queue_job_cron: Avoid parallel run

By default, odoo never runs the same cron job in parallel. This commit uses the identity key mechanism to enforce this mechanism when a cron job is run as a queue job. This behaviour can be controlled by a new setting on the cron definition but is activated by default to keep the original behaviour

Author: lmignon

queue_job_cron/models/ir_cron.py

@@ -4,12 +4,23 @@
 
 from odoo import api, fields, models
 
+from odoo.addons.queue_job.job import identity_exact
+
 _logger = logging.getLogger(__name__)
 
 
 class IrCron(models.Model):
     _inherit = "ir.cron"
 
+    no_parallel_queue_job_run = fields.Boolean(
+        help="Avoid parallel run. "
+        "If the cron job is already running, the new one will be skipped. "
+        "By default, odoo never runs the same cron job in parallel. This "
+        "option is therefore set to True by default when job is run as a "
+        "queue job.",
+        default=True,
+    )
+
     run_as_queue_job = fields.Boolean(
         help="Specify if this cron should be ran as a queue job"
     )
@@ -39,23 +50,29 @@ def method_direct_trigger(self):
                 _cron = cron.with_user(cron.user_id).with_context(
                     lastcall=cron.lastcall
                 )
-                _cron.with_delay(
-                    priority=_cron.priority,
-                    description=_cron.name,
-                    channel=_cron.channel_id.complete_name,
-                )._run_job_as_queue_job(server_action=_cron.ir_actions_server_id)
+                _cron._delay_run_job_as_queue_job(
+                    server_action=_cron.ir_actions_server_id
+                )
         return True
 
     def _callback(self, cron_name, server_action_id, job_id):
         cron = self.env["ir.cron"].sudo().browse(job_id)
         if cron.run_as_queue_job:
             server_action = self.env["ir.actions.server"].browse(server_action_id)
-            return self.with_delay(
-                priority=cron.priority,
-                description=cron.name,
-                channel=cron.channel_id.complete_name,
-            )._run_job_as_queue_job(server_action=server_action)
+            return cron._delay_run_job_as_queue_job(server_action=server_action)
         else:
             return super()._callback(
                 cron_name=cron_name, server_action_id=server_action_id, job_id=job_id
             )
+
+    def _delay_run_job_as_queue_job(self, server_action):
+        self.ensure_one()
+        identity_key = None
+        if self.no_parallel_queue_job_run:
+            identity_key = identity_exact
+        return self.with_delay(
+            priority=self.priority,
+            description=self.name,
+            channel=self.channel_id.complete_name,
+            identity_key=identity_key,
+        )._run_job_as_queue_job(server_action=server_action)

queue_job_cron/tests/test_queue_job_cron.py

@@ -39,3 +39,22 @@ def test_queue_job_cron_run(self):
         cron = self.env.ref("queue_job.ir_cron_autovacuum_queue_jobs")
         IrCron = self.env["ir.cron"]
         IrCron._run_job_as_queue_job(server_action=cron.ir_actions_server_id)
+
+    def test_queue_job_no_parallelism(self):
+        cron = self.env.ref("queue_job.ir_cron_autovacuum_queue_jobs")
+        default_channel = self.env.ref("queue_job_cron.channel_root_ir_cron")
+        cron.write(
+            {
+                "no_parallel_queue_job_run": True,
+                "run_as_queue_job": True,
+                "channel_id": default_channel.id,
+            }
+        )
+        cron.method_direct_trigger()
+        cron.method_direct_trigger()
+        nb_jobs = self.env["queue.job"].search_count([("name", "=", cron.name)])
+        self.assertEqual(nb_jobs, 1)
+        cron.no_parallel_queue_job_run = False
+        cron.method_direct_trigger()
+        nb_jobs = self.env["queue.job"].search_count([("name", "=", cron.name)])
+        self.assertEqual(nb_jobs, 2)

queue_job_cron/views/ir_cron_view.xml

@@ -7,6 +7,10 @@
         <field name="arch" type="xml">
             <field name="doall" position="after">
                 <field name="run_as_queue_job" />
+                <field
+                    name="no_parallel_queue_job_run"
+                    attrs="{'invisible': [('run_as_queue_job', '=', False)]}"
+                />
                 <field
                     name="channel_id"
                     attrs="{'invisible': [('run_as_queue_job', '=', False)],