[20.0][MIG] queue_job: Migration to 20.0

.pre-commit-config.yaml

@@ -1,6 +1,13 @@
 exclude: |
   (?x)
   # NOT INSTALLABLE ADDONS
+  ^base_import_async/|
+  ^queue_job_batch/|
+  ^queue_job_cron/|
+  ^queue_job_cron_jobrunner/|
+  ^queue_job_subscribe/|
+  ^test_queue_job/|
+  ^test_queue_job_batch/|
   # END NOT INSTALLABLE ADDONS
   # Files and folders generated by bots, to avoid loops
   ^setup/|/static/description/index\.html$|

queue_job/README.rst

@@ -11,7 +11,7 @@ Job Queue
    !! This file is generated by oca-gen-addon-readme !!
    !! changes will be overwritten.                   !!
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-   !! source digest: sha256:aee74431fafa74d2abc078c3686e4d9c6390bacc001cac7c4afa01b9db77ca06
+   !! source digest: sha256:460e4b0b5d6e441724a1f52de8971e99adb543c530a8746134d0ad044070a9ea
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 .. |badge1| image:: https://img.shields.io/badge/maturity-Mature-brightgreen.png
@@ -21,13 +21,13 @@ Job Queue
     :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
     :alt: License: LGPL-3
 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fqueue-lightgray.png?logo=github
-    :target: https://github.com/OCA/queue/tree/19.0/queue_job
+    :target: https://github.com/OCA/queue/tree/20.0/queue_job
     :alt: OCA/queue
 .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
-    :target: https://translation.odoo-community.org/projects/queue-19-0/queue-19-0-queue_job
+    :target: https://translation.odoo-community.org/projects/queue-20-0/queue-20-0-queue_job
     :alt: Translate me on Weblate
 .. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
-    :target: https://runboat.odoo-community.org/builds?repo=OCA/queue&target_branch=19.0
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/queue&target_branch=20.0
     :alt: Try me on Runboat
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
@@ -685,7 +685,7 @@ Bug Tracker
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/queue/issues>`_.
 In case of trouble, please check there if your issue has already been reported.
 If you spotted it first, help us to smash it by providing a detailed and welcomed
-`feedback <https://github.com/OCA/queue/issues/new?body=module:%20queue_job%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/queue/issues/new?body=module:%20queue_job%0Aversion:%2020.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
 
 Do not contact contributors directly about support or help with technical issues.
 
@@ -747,6 +747,6 @@ Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:
 
 |maintainer-guewen| |maintainer-sbidoul| 
 
-This module is part of the `OCA/queue <https://github.com/OCA/queue/tree/19.0/queue_job>`_ project on GitHub.
+This module is part of the `OCA/queue <https://github.com/OCA/queue/tree/20.0/queue_job>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

queue_job/__manifest__.py

@@ -2,7 +2,7 @@
 
 {
     "name": "Job Queue",
-    "version": "19.0.2.1.3",
+    "version": "20.0.1.0.0",
     "author": "Camptocamp,ACSONE SA/NV,Odoo Community Association (OCA)",
     "website": "https://github.com/OCA/queue",
     "license": "LGPL-3",
@@ -11,7 +11,7 @@
     "external_dependencies": {"python": ["requests", "openupgradelib"]},
     "data": [
         "security/security.xml",
-        "security/ir.model.access.csv",
+        "security/ir.access.csv",
         "views/queue_job_views.xml",
         "views/queue_job_channel_views.xml",
         "views/queue_job_function_views.xml",
@@ -27,7 +27,7 @@
             "queue_job/static/src/views/**/*",
         ],
     },
-    "installable": False,
+    "installable": True,
     "development_status": "Mature",
     "maintainers": ["guewen", "sbidoul"],
     "post_init_hook": "post_init_hook",

queue_job/controllers/main.py

@@ -13,7 +13,7 @@
 from werkzeug.exceptions import BadRequest, Forbidden
 
 from odoo import SUPERUSER_ID, api, http
-from odoo.service.model import PG_CONCURRENCY_ERRORS_TO_RETRY
+from odoo.sql_db import PG_CONCURRENCY_EXCEPTIONS_TO_RETRY
 from odoo.tools import config
 
 from ..delay import chain, group
@@ -98,10 +98,14 @@ def _try_perform_job(cls, env, job):
         # TODO refactor, the relation between env and job.env is not clear
         assert env.cr is job.env.cr
         with _prevent_commit(env.cr):
-            job.perform()
-            # Triggers any stored computed fields before calling 'set_done'
-            # so that will be part of the 'exec_time'
-            env.flush_all()
+            # On failure, rolling back the savepoint releases the row locks
+            # the job took on the records it updated: the failure is handled
+            # from another cursor, which may write on the same records (e.g.
+            # the on fail hook).
+            # On success, leaving the savepoint flushes, before 'set_done', so
+            # that the stored computed fields are part of the 'exec_time'.
+            with env.cr.savepoint():
+                job.perform()
             job.set_done()
             job.store()
             env.flush_all()
@@ -123,7 +127,7 @@ def _enqueue_dependent_jobs(cls, env, job):
             except OperationalError as err:
                 # Automatically retry the typical transaction serialization
                 # errors
-                if err.pgcode not in PG_CONCURRENCY_ERRORS_TO_RETRY:
+                if not isinstance(err, PG_CONCURRENCY_EXCEPTIONS_TO_RETRY):
                     raise
                 if tries >= DEPENDS_MAX_TRIES_ON_CONCURRENCY_FAILURE:
                     _logger.error(
@@ -148,7 +152,7 @@ def _enqueue_dependent_jobs(cls, env, job):
     @classmethod
     def _runjob(cls, env: api.Environment, job: Job) -> None:
         def retry_postpone(job, message, seconds=None):
-            job.env.clear()
+            job.env.transaction.clear()
             with job.in_temporary_env():
                 job.postpone(result=message, seconds=seconds)
                 job.set_pending(reset_retry=False)
@@ -160,7 +164,7 @@ def retry_postpone(job, message, seconds=None):
             except OperationalError as err:
                 # Automatically retry the typical transaction serialization
                 # errors
-                if err.pgcode not in PG_CONCURRENCY_ERRORS_TO_RETRY:
+                if not isinstance(err, PG_CONCURRENCY_EXCEPTIONS_TO_RETRY):
                     raise
 
                 _logger.debug("%s OperationalError, postponed", job)
@@ -181,7 +185,7 @@ def retry_postpone(job, message, seconds=None):
             traceback.print_exc(file=buff)
             traceback_txt = buff.getvalue()
             _logger.error(traceback_txt)
-            job.env.clear()
+            job.env.transaction.clear()
             with job.in_temporary_env():
                 vals = cls._get_failure_values(job, traceback_txt, orig_exception)
                 job.set_failed(**vals)
@@ -388,6 +392,5 @@ def _create_graph_test_jobs(
 
         root_delayable.delay()
 
-        return (
-            f"graph uuid: {list(root_delayable._head())[0]._generated_job.graph_uuid}"
-        )
+        head = next(iter(root_delayable._head()))
+        return f"graph uuid: {head._generated_job.graph_uuid}"

queue_job/data/queue_data.xml

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8" ?>
+<?xml version="1.0" encoding="UTF-8" ?>
 <odoo>
     <data noupdate="1">
         <!-- Queue-job-related subtypes for messaging / Chatter -->
@@ -12,14 +12,14 @@
             <field ref="model_queue_job" name="model_id" />
             <field eval="True" name="active" />
             <field name="user_id" ref="base.user_root" />
-            <field name="interval_number">1</field>
+            <field name="interval_number" eval="1" />
             <field name="interval_type">days</field>
             <field name="state">code</field>
             <field name="code">model.autovacuum()</field>
         </record>
     </data>
     <data noupdate="0">
-        <record model="queue.job.channel" id="channel_root">
+        <record id="channel_root" model="queue.job.channel">
             <field name="name">root</field>
         </record>
     </data>

queue_job/data/queue_job_function_data.xml

@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="UTF-8" ?>
 <odoo noupdate="1">
     <record id="job_function_queue_job__test_job" model="queue.job.function">
         <field name="model_id" ref="queue_job.model_queue_job" />

queue_job/delay.py

@@ -58,7 +58,7 @@ class Graph:
     instances, although ultimately it is used for this purpose.
     """
 
-    __slots__ = "_graph"
+    __slots__ = ("_graph",)
 
     def __init__(self, graph=None):
         if graph:
@@ -314,7 +314,7 @@ class DelayableChain:
     delayable/chain/group object of the graph.
     """
 
-    __slots__ = ("_graph", "__head", "__tail")
+    __slots__ = ("__head", "__tail", "_graph")
 
     def __init__(self, *delayables):
         self._graph = DelayableGraph()
@@ -371,7 +371,7 @@ class DelayableGroup:
     delayable/chain/group object of the graph.
     """
 
-    __slots__ = ("_graph", "_delayables")
+    __slots__ = ("_delayables", "_graph")
 
     def __init__(self, *delayables):
         self._graph = DelayableGraph()

queue_job/fields.py

@@ -30,7 +30,7 @@ class JobSerialized(fields.Json):
     _base_type = None
 
     # these are the default values when we convert an empty value
-    _default_json_mapping = {
+    _default_json_mapping = {  # noqa: RUF012
         dict: "{}",
         list: "[]",
         tuple: "[]",
@@ -42,8 +42,8 @@ class JobSerialized(fields.Json):
     def __init__(self, string=SENTINEL, base_type=SENTINEL, **kwargs):
         super().__init__(string=string, _base_type=base_type, **kwargs)
 
-    def _setup_attrs(self, model, name):  # pylint: disable=missing-return
-        super()._setup_attrs(model, name)
+    def _setup_attrs__(self, model_class, name):  # pylint: disable=missing-return
+        super()._setup_attrs__(model_class, name)
         if self._base_type not in self._default_json_mapping:
             msg = f"{self._base_type} is not a supported base type"
             raise ValueError(msg)

queue_job/job.py

@@ -461,7 +461,7 @@ def __init__(
         if self.priority is None:
             self.priority = DEFAULT_PRIORITY
 
-        self.date_created = datetime.now()
+        self.date_created = datetime.now()  # noqa: DTZ005
         self._description = description
 
         if isinstance(identity_key, str):
@@ -524,7 +524,7 @@ def perform(self):
             elif not self.max_retries:  # infinite retries
                 raise
             elif self.retry >= self.max_retries:
-                type_, value, traceback = sys.exc_info()
+                type_, value, _traceback = sys.exc_info()
                 # change the exception type but keep the original
                 # traceback and message:
                 # http://blog.ianbicking.org/2007/09/12/re-raising-exceptions/
@@ -745,9 +745,8 @@ def job_function_name(self):
 
     @property
     def identity_key(self):
-        if self._identity_key is None:
-            if self._identity_key_func:
-                self._identity_key = self._identity_key_func(self)
+        if self._identity_key is None and self._identity_key_func:
+            self._identity_key = self._identity_key_func(self)
         return self._identity_key
 
     @identity_key.setter
@@ -808,9 +807,9 @@ def eta(self, value):
         if not value:
             self._eta = None
         elif isinstance(value, timedelta):
-            self._eta = datetime.now() + value
+            self._eta = datetime.now() + value  # noqa: DTZ005
         elif isinstance(value, int):
-            self._eta = datetime.now() + timedelta(seconds=value)
+            self._eta = datetime.now() + timedelta(seconds=value)  # noqa: DTZ005
         else:
             self._eta = value
 
@@ -845,27 +844,27 @@ def set_pending(self, result=None, reset_retry=True):
 
     def set_enqueued(self):
         self.state = ENQUEUED
-        self.date_enqueued = datetime.now()
+        self.date_enqueued = datetime.now()  # noqa: DTZ005
         self.date_started = None
         self.worker_pid = None
 
     def set_started(self):
         self.state = STARTED
-        self.date_started = datetime.now()
+        self.date_started = datetime.now()  # noqa: DTZ005
         self.worker_pid = os.getpid()
         self.add_lock_record()
 
     def set_done(self, result=None):
         self.state = DONE
         self.exc_name = None
         self.exc_info = None
-        self.date_done = datetime.now()
+        self.date_done = datetime.now()  # noqa: DTZ005
         if result is not None:
             self.result = result
 
     def set_cancelled(self, result=None):
         self.state = CANCELLED
-        self.date_cancelled = datetime.now()
+        self.date_cancelled = datetime.now()  # noqa: DTZ005
         if result is not None:
             self.result = result
 
@@ -925,7 +924,7 @@ def related_action(self):
         if not funcname:
             funcname = record._default_related_action
         if not isinstance(funcname, str):
-            raise ValueError(
+            raise ValueError(  # noqa: TRY004
                 "related_action must be the name of the method on queue.job as string"
             )
         action = getattr(record, funcname)

queue_job/jobrunner/__init__.py

@@ -30,7 +30,7 @@
             queue_job_config = dict(cp["queue_job"])
 
 
-from .runner import QueueJobRunner, _channels  # noqa: E402
+from .runner import QueueJobRunner, _channels
 
 _logger = logging.getLogger(__name__)
 
@@ -151,7 +151,8 @@ def prefork_worker_pop(server, pid):
 
 def threaded_start(server, *args, **kwargs):
     res = orig_threaded_start(server, *args, **kwargs)
-    _start_runner_thread("threaded server")
+    if not kwargs.get("stop"):
+        _start_runner_thread("threaded server")
     return res
 
 

queue_job/jobrunner/channels.py

@@ -179,7 +179,7 @@ class ChannelJob:
 
     """
 
-    __slots__ = ("db_name", "channel", "uuid", "_sorting_key", "__weakref__")
+    __slots__ = ("__weakref__", "_sorting_key", "channel", "db_name", "uuid")
 
     def __init__(self, db_name, channel, uuid, seq, date_created, priority, eta):
         self.db_name = db_name