[REF] queue_job: Move on fail definition to job function

Author: grindtildeath

queue_job/delay.py

@@ -438,7 +438,6 @@ class Delayable:
         "description",
         "channel",
         "identity_key",
-        "on_fail_method",
     )
     __slots__ = _properties + (
         "recordset",
@@ -458,7 +457,6 @@ def __init__(
         description=None,
         channel=None,
         identity_key=None,
-        on_fail_method=None,
     ):
         self._graph = DelayableGraph()
         self._graph.add_vertex(self)
@@ -471,7 +469,6 @@ def __init__(
         self.description = description
         self.channel = channel
         self.identity_key = identity_key
-        self.on_fail_method = on_fail_method
 
         self._job_method = None
         self._job_args = ()
@@ -550,7 +547,6 @@ def split(self, size, chain=False):
                 description=self.description,
                 channel=self.channel,
                 identity_key=self.identity_key,
-                on_fail_method=self.on_fail_method,
             )
             # Update the __self__
             delayable._job_method = getattr(recordset, self._job_method.__name__)
@@ -587,7 +583,6 @@ def _build_job(self):
             description=self.description,
             channel=self.channel,
             identity_key=self.identity_key,
-            on_fail_method=self.on_fail_method,
         )
         return self._generated_job
 
@@ -638,7 +633,6 @@ def __init__(
         description=None,
         channel=None,
         identity_key=None,
-        on_fail_method=None,
     ):
         self.delayable = Delayable(
             recordset,
@@ -648,7 +642,6 @@ def __init__(
             description=description,
             channel=channel,
             identity_key=identity_key,
-            on_fail_method=on_fail_method,
         )
 
     @property

queue_job/job.py

@@ -200,9 +200,6 @@ class Job:
         be added to a channel if the existing job with the same key is not yet
         started or executed.
 
-    .. attribute::on_fail_method
-
-        A function to be called if the job is failed and will not be retried.
     """
 
     @classmethod
@@ -301,9 +298,6 @@ def _load_from_db_record(cls, job_db_record):
             description=stored.name,
             channel=stored.channel,
             identity_key=stored.identity_key,
-            on_fail_method=getattr(recordset, stored.on_fail_method_name)
-            if stored.on_fail_method_name
-            else None,
         )
 
         if stored.date_created:
@@ -371,7 +365,6 @@ def __init__(
         description=None,
         channel=None,
         identity_key=None,
-        on_fail_method=None,
     ):
         """Create a Job
 
@@ -414,14 +407,14 @@ def __init__(
         self.method_name = func.__name__
         self.recordset = recordset
 
-        if on_fail_method:
-            if not _is_model_method(on_fail_method):
-                raise TypeError("Job accepts only methods of Models")
-            self.on_fail_method_name = on_fail_method.__name__
-
         self.job_config = (
             self.env["queue.job.function"].sudo().job_config(self.job_function_name)
         )
+        on_fail_method_name = self.job_config.on_fail_method_name
+        if on_fail_method_name:
+            if not _is_model_method(getattr(self.recordset, on_fail_method_name, None)):
+                raise TypeError("Job accepts only methods of Models")
+            self.on_fail_method_name = on_fail_method_name
 
         self.state = PENDING
 

queue_job/models/base.py

@@ -26,7 +26,6 @@ def with_delay(
         description=None,
         channel=None,
         identity_key=None,
-        on_fail_method=None,
     ):
         """Return a ``DelayableRecordset``
 
@@ -60,7 +59,6 @@ def with_delay(
             description=description,
             channel=channel,
             identity_key=identity_key,
-            on_fail_method=on_fail_method,
         )
 
     def delayable(
@@ -71,7 +69,6 @@ def delayable(
         description=None,
         channel=None,
         identity_key=None,
-        on_fail_method=None,
     ):
         """Return a ``Delayable``
 
@@ -143,7 +140,6 @@ def delayable(
             description=description,
             channel=channel,
             identity_key=identity_key,
-            on_fail_method=on_fail_method,
         )
 
     def _patch_job_auto_delay(self, method_name, context_key=None):

queue_job/models/queue_job.py

@@ -77,7 +77,6 @@ class QueueJob(models.Model):
 
     model_name = fields.Char(string="Model", readonly=True)
     method_name = fields.Char(readonly=True)
-    on_fail_method_name = fields.Char(readonly=True)
     records = JobSerialized(
         string="Record(s)",
         readonly=True,

queue_job/models/queue_job_function.py

@@ -29,7 +29,8 @@ class QueueJobFunction(models.Model):
         "related_action_func_name "
         "related_action_kwargs "
         "job_function_id "
-        "allow_commit",
+        "allow_commit "
+        "on_fail_method_name",
     )
 
     def _default_channel(self):
@@ -48,6 +49,10 @@ def _default_channel(self):
         comodel_name="ir.model", string="Model", ondelete="cascade"
     )
     method = fields.Char()
+    on_fail_method = fields.Char(
+        help="Model function to be called if the job is failed and will not be "
+        "retried.",
+    )
 
     channel_id = fields.Many2one(
         comodel_name="queue.job.channel",
@@ -159,6 +164,7 @@ def job_default_config(self):
             related_action_kwargs={},
             job_function_id=None,
             allow_commit=False,
+            on_fail_method_name=None,
         )
 
     def _parse_retry_pattern(self):
@@ -195,6 +201,7 @@ def job_config(self, name):
             related_action_kwargs=config.related_action.get("kwargs", {}),
             job_function_id=config.id,
             allow_commit=config.allow_commit,
+            on_fail_method_name=config.on_fail_method,
         )
 
     def _retry_pattern_format_error_message(self):

queue_job/tests/test_model_job_function.py

@@ -35,6 +35,7 @@ def test_function_job_config(self):
             {
                 "model_id": self.env.ref("base.model_res_users").id,
                 "method": "read",
+                "on_fail_method": "search_read",
                 "channel_id": channel.id,
                 "edit_retry_pattern": "{1: 2, 3: 4}",
                 "edit_related_action": (
@@ -55,5 +56,6 @@ def test_function_job_config(self):
                 related_action_kwargs={"b": 1},
                 job_function_id=job_function.id,
                 allow_commit=True,
+                on_fail_method_name="search_read",
             ),
         )

queue_job/tests/test_run_rob_controller.py

@@ -34,11 +34,9 @@ def test_runjob_success(self):
         self.assertEqual(job.db_record().state, "done")
 
     def test_runjob_on_fail_hook(self):
-        job = (
-            self.env["queue.job"]
-            .with_delay(on_fail_method=self.env["queue.job"]._test_on_fail_hook)
-            ._test_job(failure_rate=1)
-        )
+        function = self.env.ref("queue_job.job_function_queue_job__test_job")
+        function.on_fail_method = "_test_on_fail_hook"
+        job = self.env["queue.job"].with_delay()._test_job(failure_rate=1)
         with (
             self.assertRaises(JobError),
             patch(