From c519d5ca953e4e8475196b4b778f879dcc79424b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Iv=C3=A0n=20Todorovich?= Date: Wed, 2 Mar 2022 16:08:03 -0300 Subject: [PATCH 1/3] [ADD] queue_job_cron_jobrunner --- queue_job_cron_jobrunner/README.rst | 1 + queue_job_cron_jobrunner/__init__.py | 1 + queue_job_cron_jobrunner/__manifest__.py | 16 ++ queue_job_cron_jobrunner/data/ir_cron.xml | 16 ++ queue_job_cron_jobrunner/models/__init__.py | 2 + queue_job_cron_jobrunner/models/ir_cron.py | 13 ++ queue_job_cron_jobrunner/models/queue_job.py | 164 ++++++++++++++++++ queue_job_cron_jobrunner/readme/CONFIGURE.rst | 21 +++ .../readme/CONTRIBUTORS.rst | 3 + .../readme/DESCRIPTION.rst | 14 ++ queue_job_cron_jobrunner/readme/ROADMAP.rst | 3 + queue_job_cron_jobrunner/tests/__init__.py | 1 + .../tests/test_queue_job.py | 54 ++++++ queue_job_cron_jobrunner/views/ir_cron.xml | 22 +++ .../odoo/addons/queue_job_cron_jobrunner | 1 + setup/queue_job_cron_jobrunner/setup.py | 6 + 16 files changed, 338 insertions(+) create mode 100644 queue_job_cron_jobrunner/README.rst create mode 100644 queue_job_cron_jobrunner/__init__.py create mode 100644 queue_job_cron_jobrunner/__manifest__.py create mode 100644 queue_job_cron_jobrunner/data/ir_cron.xml create mode 100644 queue_job_cron_jobrunner/models/__init__.py create mode 100644 queue_job_cron_jobrunner/models/ir_cron.py create mode 100644 queue_job_cron_jobrunner/models/queue_job.py create mode 100644 queue_job_cron_jobrunner/readme/CONFIGURE.rst create mode 100644 queue_job_cron_jobrunner/readme/CONTRIBUTORS.rst create mode 100644 queue_job_cron_jobrunner/readme/DESCRIPTION.rst create mode 100644 queue_job_cron_jobrunner/readme/ROADMAP.rst create mode 100644 queue_job_cron_jobrunner/tests/__init__.py create mode 100644 queue_job_cron_jobrunner/tests/test_queue_job.py create mode 100644 queue_job_cron_jobrunner/views/ir_cron.xml create mode 120000 setup/queue_job_cron_jobrunner/odoo/addons/queue_job_cron_jobrunner create mode 100644 setup/queue_job_cron_jobrunner/setup.py diff --git a/queue_job_cron_jobrunner/README.rst b/queue_job_cron_jobrunner/README.rst new file mode 100644 index 0000000000..d0cc046d68 --- /dev/null +++ b/queue_job_cron_jobrunner/README.rst @@ -0,0 +1 @@ +TO BE GENERATED AUTOMATICALLY diff --git a/queue_job_cron_jobrunner/__init__.py b/queue_job_cron_jobrunner/__init__.py new file mode 100644 index 0000000000..0650744f6b --- /dev/null +++ b/queue_job_cron_jobrunner/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/queue_job_cron_jobrunner/__manifest__.py b/queue_job_cron_jobrunner/__manifest__.py new file mode 100644 index 0000000000..6c0caa52f9 --- /dev/null +++ b/queue_job_cron_jobrunner/__manifest__.py @@ -0,0 +1,16 @@ +{ + "name": "Queue Job Cron Jobrunner", + "summary": "Run jobs without a dedicated JobRunner", + "version": "15.0.1.0.0", + "development_status": "Alpha", + "author": "Camptocamp SA, Odoo Community Association (OCA)", + "maintainers": ["ivantodorovich"], + "website": "https://github.com/OCA/queue", + "license": "AGPL-3", + "category": "Others", + "depends": ["queue_job"], + "data": [ + "data/ir_cron.xml", + "views/ir_cron.xml", + ], +} diff --git a/queue_job_cron_jobrunner/data/ir_cron.xml b/queue_job_cron_jobrunner/data/ir_cron.xml new file mode 100644 index 0000000000..5cb7436dcc --- /dev/null +++ b/queue_job_cron_jobrunner/data/ir_cron.xml @@ -0,0 +1,16 @@ + + + + + Queue Job Runner + + code + model._job_runner() + + + 1 + days + -1 + + + diff --git a/queue_job_cron_jobrunner/models/__init__.py b/queue_job_cron_jobrunner/models/__init__.py new file mode 100644 index 0000000000..4ba9dd1a16 --- /dev/null +++ b/queue_job_cron_jobrunner/models/__init__.py @@ -0,0 +1,2 @@ +from . import ir_cron +from . import queue_job diff --git a/queue_job_cron_jobrunner/models/ir_cron.py b/queue_job_cron_jobrunner/models/ir_cron.py new file mode 100644 index 0000000000..61235dc45a --- /dev/null +++ b/queue_job_cron_jobrunner/models/ir_cron.py @@ -0,0 +1,13 @@ +# Copyright 2022 Camptocamp SA (https://www.camptocamp.com). +# @author Iván Todorovich +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from odoo import fields, models + + +class IrCron(models.Model): + _inherit = "ir.cron" + + queue_job_runner = fields.Boolean( + help="If checked, the cron is considered to be a queue.job runner.", + ) diff --git a/queue_job_cron_jobrunner/models/queue_job.py b/queue_job_cron_jobrunner/models/queue_job.py new file mode 100644 index 0000000000..6a374fcb22 --- /dev/null +++ b/queue_job_cron_jobrunner/models/queue_job.py @@ -0,0 +1,164 @@ +# Copyright 2022 Camptocamp SA (https://www.camptocamp.com). +# @author Iván Todorovich +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +import logging +import traceback +from io import StringIO + +from psycopg2 import OperationalError + +from odoo import _, api, models, tools +from odoo.service.model import PG_CONCURRENCY_ERRORS_TO_RETRY + +from odoo.addons.queue_job.controllers.main import PG_RETRY +from odoo.addons.queue_job.exception import ( + FailedJobError, + NothingToDoJob, + RetryableJobError, +) +from odoo.addons.queue_job.job import Job + +_logger = logging.getLogger(__name__) + + +class QueueJob(models.Model): + _inherit = "queue.job" + + @api.model + def _acquire_one_job(self): + """Acquire the next job to be run. + + :returns: queue.job record (locked for update) + """ + # TODO: This method should respect channel priority and capacity, + # rather than just fetching them by creation date. + self.flush() + self.env.cr.execute( + """ + SELECT id + FROM queue_job + WHERE state = 'pending' + AND (eta IS NULL OR eta <= (now() AT TIME ZONE 'UTC')) + ORDER BY date_created DESC + LIMIT 1 FOR NO KEY UPDATE SKIP LOCKED + """ + ) + row = self.env.cr.fetchone() + return self.browse(row and row[0]) + + def _process(self, commit=False): + """Process the job""" + self.ensure_one() + job = Job._load_from_db_record(self) + # Set it as started + job.set_started() + job.store() + _logger.debug("%s started", job.uuid) + # TODO: Commit the state change so that the state can be read from the UI + # while the job is processing. However, doing this will release the + # lock on the db, so we need to find another way. + # if commit: + # self.flush() + # self.env.cr.commit() + + # Actual processing + try: + try: + with self.env.cr.savepoint(): + job.perform() + job.set_done() + job.store() + except OperationalError as err: + # Automatically retry the typical transaction serialization errors + if err.pgcode not in PG_CONCURRENCY_ERRORS_TO_RETRY: + raise + message = tools.ustr(err.pgerror, errors="replace") + job.postpone(result=message, seconds=PG_RETRY) + job.set_pending(reset_retry=False) + job.store() + _logger.debug("%s OperationalError, postponed", job) + + except NothingToDoJob as err: + if str(err): + msg = str(err) + else: + msg = _("Job interrupted and set to Done: nothing to do.") + job.set_done(msg) + job.store() + + except RetryableJobError as err: + # delay the job later, requeue + job.postpone(result=str(err), seconds=5) + job.set_pending(reset_retry=False) + job.store() + _logger.debug("%s postponed", job) + + except (FailedJobError, Exception): + with StringIO() as buff: + traceback.print_exc(file=buff) + _logger.error(buff.getvalue()) + job.set_failed(exc_info=buff.getvalue()) + job.store() + + if commit: # pragma: no cover + self.env["base"].flush() + self.env.cr.commit() # pylint: disable=invalid-commit + + @api.model + def _job_runner(self, commit=True): + """Short-lived job runner, triggered by async crons""" + job = self._acquire_one_job() + while job: + job._process(commit=commit) + job = self._acquire_one_job() + # TODO: If limit_time_real_cron is reached before all the jobs are done, + # the worker will be killed abruptly. + # Ideally, find a way to know if we're close to reaching this limit, + # stop processing, and trigger a new execution to continue. + # + # if job and limit_time_real_cron_reached_or_about_to_reach: + # self._cron_trigger() + # break + + @api.model + def _cron_trigger(self, at=None): + """Trigger the cron job runners + + Odoo will prevent concurrent cron jobs from running. + So, to support parallel execution, we'd need to have (at least) the + same number of ir.crons records as cron workers. + + All crons should be triggered at the same time. + """ + crons = self.env["ir.cron"].sudo().search([("queue_job_runner", "=", True)]) + for cron in crons: + cron._trigger(at=at) + + def _ensure_cron_trigger(self): + """Create cron triggers for these jobs""" + records = self.filtered(lambda r: r.state == "pending") + if not records: + return + # Trigger immediate runs + immediate = any(not rec.eta for rec in records) + if immediate: + self._cron_trigger() + # Trigger delayed eta runs + delayed_etas = {rec.eta for rec in records if rec.eta} + if delayed_etas: + self._cron_trigger(at=list(delayed_etas)) + + @api.model_create_multi + def create(self, vals_list): + # When jobs are created, also create the cron trigger + records = super().create(vals_list) + records._ensure_cron_trigger() + return records + + def write(self, vals): + # When a job state or eta changes, make sure a cron trigger is created + res = super().write(vals) + if "state" in vals or "eta" in vals: + self._ensure_cron_trigger() + return res diff --git a/queue_job_cron_jobrunner/readme/CONFIGURE.rst b/queue_job_cron_jobrunner/readme/CONFIGURE.rst new file mode 100644 index 0000000000..0de15596d2 --- /dev/null +++ b/queue_job_cron_jobrunner/readme/CONFIGURE.rst @@ -0,0 +1,21 @@ +.. warning:: + + Don't use this module if you're already running the regular ``queue_job`` runner. + + +For the easiest case, no configuration is required besides installing the module. + +To avoid CronWorker CPU timeout from abruptly stopping the job processing cron, it's +recommended to launch Odoo with ``--limit-time-real-cron=0``, to disable the CronWorker +timeout altogether. + +.. note:: + + In Odoo.sh, this is done by default. + + +Parallel execution of jobs can be achieved by leveraging multiple ``ir.cron`` records: + +* Make sure you have enough CronWorkers available (Odoo CLI ``--max-cron-threads``) +* Duplicate the ``queue_job_cron`` cron record as many times as needed, until you have + as much records as cron workers. diff --git a/queue_job_cron_jobrunner/readme/CONTRIBUTORS.rst b/queue_job_cron_jobrunner/readme/CONTRIBUTORS.rst new file mode 100644 index 0000000000..59b447f28a --- /dev/null +++ b/queue_job_cron_jobrunner/readme/CONTRIBUTORS.rst @@ -0,0 +1,3 @@ +* `Camptocamp `_ + + * Iván Todorovich diff --git a/queue_job_cron_jobrunner/readme/DESCRIPTION.rst b/queue_job_cron_jobrunner/readme/DESCRIPTION.rst new file mode 100644 index 0000000000..e713aa89a9 --- /dev/null +++ b/queue_job_cron_jobrunner/readme/DESCRIPTION.rst @@ -0,0 +1,14 @@ +This module implements a simple ``queue.job`` runner using ``ir.cron`` triggers. + +It's meant to be used on environments where the regular job runner can't be run, like +on Odoo.sh. + +Unlike the regular job runner, where jobs are dispatched to the HttpWorkers, jobs are +processed on the CronWorker threads by the job runner crons. This is a design decision +because: + +* Odoo.sh puts HttpWorkers to sleep when there's no network activity +* HttpWorkers are meant for traffic. Users shouldn't pay the price of background tasks. + +For now, it only implements the most basic features of the ``queue_job`` runner, notably +no channel capacity nor priorities. Please check the ROADMAP for further details. diff --git a/queue_job_cron_jobrunner/readme/ROADMAP.rst b/queue_job_cron_jobrunner/readme/ROADMAP.rst new file mode 100644 index 0000000000..b82e199202 --- /dev/null +++ b/queue_job_cron_jobrunner/readme/ROADMAP.rst @@ -0,0 +1,3 @@ +* Support channel capacity and priority. (See ``_acquire_one_job``) +* Gracefully handle CronWorker CPU timeouts. (See ``_job_runner``) +* Commit transaction after job state updated to started. (See ``_process``) diff --git a/queue_job_cron_jobrunner/tests/__init__.py b/queue_job_cron_jobrunner/tests/__init__.py new file mode 100644 index 0000000000..42bd479ed0 --- /dev/null +++ b/queue_job_cron_jobrunner/tests/__init__.py @@ -0,0 +1 @@ +from . import test_queue_job diff --git a/queue_job_cron_jobrunner/tests/test_queue_job.py b/queue_job_cron_jobrunner/tests/test_queue_job.py new file mode 100644 index 0000000000..3798e63778 --- /dev/null +++ b/queue_job_cron_jobrunner/tests/test_queue_job.py @@ -0,0 +1,54 @@ +# Copyright 2022 Camptocamp SA (https://www.camptocamp.com). +# @author Iván Todorovich +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from datetime import timedelta + +from freezegun import freeze_time + +from odoo import fields +from odoo.tests.common import TransactionCase +from odoo.tools import mute_logger + + +class TestQueueJob(TransactionCase): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.env = cls.env(context=dict(cls.env.context, tracking_disable=True)) + cls.cron = cls.env.ref("queue_job_cron_jobrunner.queue_job_cron") + # Cleanup triggers just in case + cls.env["ir.cron.trigger"].search([]).unlink() + + def assertTriggerAt(self, at, message=None): + """Ensures a cron trigger is created at the given time""" + return self.assertTrue( + self.env["ir.cron.trigger"].search([("call_at", "=", at)]), + message, + ) + + @freeze_time("2022-02-22 22:22:22") + def test_queue_job_cron_trigger(self): + """Test that ir.cron triggers are created for every queue.job""" + job = self.env["res.partner"].with_delay().create({"name": "test"}) + job_record = job.db_record() + self.assertTriggerAt(fields.Datetime.now(), "Trigger should've been created") + job_record.eta = fields.Datetime.now() + timedelta(hours=1) + self.assertTriggerAt(job_record.eta, "A new trigger should've been created") + + @mute_logger("odoo.addons.queue_job_cron_jobrunner.models.queue_job") + def test_queue_job_process(self): + """Test that jobs are processed by the queue job cron""" + # Create some jobs + job1 = self.env["res.partner"].with_delay().create({"name": "test"}) + job1_record = job1.db_record() + job2 = self.env["res.partner"].with_delay().create(False) + job2_record = job2.db_record() + job3 = self.env["res.partner"].with_delay(eta=3600).create({"name": "Test"}) + job3_record = job3.db_record() + # Run the job processing cron + self.env["queue.job"]._job_runner(commit=False) + # Check that the jobs were processed + self.assertEqual(job1_record.state, "done", "Processed OK") + self.assertEqual(job2_record.state, "failed", "Has errors") + self.assertEqual(job3_record.state, "pending", "Still pending, because of eta") diff --git a/queue_job_cron_jobrunner/views/ir_cron.xml b/queue_job_cron_jobrunner/views/ir_cron.xml new file mode 100644 index 0000000000..f1fe6a7455 --- /dev/null +++ b/queue_job_cron_jobrunner/views/ir_cron.xml @@ -0,0 +1,22 @@ + + + + + + ir.cron + + + + + + + + + diff --git a/setup/queue_job_cron_jobrunner/odoo/addons/queue_job_cron_jobrunner b/setup/queue_job_cron_jobrunner/odoo/addons/queue_job_cron_jobrunner new file mode 120000 index 0000000000..9ec9686861 --- /dev/null +++ b/setup/queue_job_cron_jobrunner/odoo/addons/queue_job_cron_jobrunner @@ -0,0 +1 @@ +../../../../queue_job_cron_jobrunner \ No newline at end of file diff --git a/setup/queue_job_cron_jobrunner/setup.py b/setup/queue_job_cron_jobrunner/setup.py new file mode 100644 index 0000000000..28c57bb640 --- /dev/null +++ b/setup/queue_job_cron_jobrunner/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +) From 46a7c8e38c667a1d121f3e01f037d678e9ac8db9 Mon Sep 17 00:00:00 2001 From: Guewen Baconnier Date: Tue, 1 Nov 2022 14:52:01 +0100 Subject: [PATCH 2/3] Add enqueue of graph dependencies in queue_job_cron_jobrunner --- queue_job_cron_jobrunner/models/queue_job.py | 4 ++++ .../tests/test_queue_job.py | 17 +++++++++++++++++ 2 files changed, 21 insertions(+) diff --git a/queue_job_cron_jobrunner/models/queue_job.py b/queue_job_cron_jobrunner/models/queue_job.py index 6a374fcb22..4efd8b21d5 100644 --- a/queue_job_cron_jobrunner/models/queue_job.py +++ b/queue_job_cron_jobrunner/models/queue_job.py @@ -105,6 +105,10 @@ def _process(self, commit=False): self.env["base"].flush() self.env.cr.commit() # pylint: disable=invalid-commit + _logger.debug("%s enqueue depends started", job) + job.enqueue_waiting() + _logger.debug("%s enqueue depends done", job) + @api.model def _job_runner(self, commit=True): """Short-lived job runner, triggered by async crons""" diff --git a/queue_job_cron_jobrunner/tests/test_queue_job.py b/queue_job_cron_jobrunner/tests/test_queue_job.py index 3798e63778..3f2e0ef637 100644 --- a/queue_job_cron_jobrunner/tests/test_queue_job.py +++ b/queue_job_cron_jobrunner/tests/test_queue_job.py @@ -52,3 +52,20 @@ def test_queue_job_process(self): self.assertEqual(job1_record.state, "done", "Processed OK") self.assertEqual(job2_record.state, "failed", "Has errors") self.assertEqual(job3_record.state, "pending", "Still pending, because of eta") + + @freeze_time("2022-02-22 22:22:22") + def test_queue_job_cron_trigger_enqueue_dependencies(self): + """Test that ir.cron execution enqueue waiting dependencies""" + delayable = self.env["res.partner"].delayable().create({"name": "test"}) + delayable2 = self.env["res.partner"].delayable().create({"name": "test2"}) + delayable.on_done(delayable2) + delayable.delay() + job_record = delayable._generated_job.db_record() + job_record_depends = delayable2._generated_job.db_record() + + self.env["queue.job"]._job_runner(commit=False) + + self.assertEqual(job_record.state, "done", "Processed OK") + # if the state is "waiting_dependencies", it means the "enqueue_waiting()" + # step has not been doen when the parent job has been done + self.assertEqual(job_record_depends.state, "done", "Processed OK") From 9513d9dff213abb717be8202ff66bdd7aff720d2 Mon Sep 17 00:00:00 2001 From: Chris Bergman Date: Mon, 31 Oct 2022 19:38:25 +0100 Subject: [PATCH 3/3] Backport from 15.0 to 14.0 for queue_job_cron_jobrunner --- README.md | 1 + queue_job_cron_jobrunner/README.rst | 138 ++++- queue_job_cron_jobrunner/__manifest__.py | 2 +- .../i18n/queue_job_cron_jobrunner.pot | 43 ++ queue_job_cron_jobrunner/models/queue_job.py | 17 +- .../static/description/icon.png | Bin 0 -> 9455 bytes .../static/description/index.html | 475 ++++++++++++++++++ .../tests/test_queue_job.py | 30 +- setup/_metapackage/VERSION.txt | 1 - setup/_metapackage/setup.py | 26 - .../odoo/addons/base_import_async | 2 +- .../odoo/addons/test_base_import_async | 2 +- 12 files changed, 678 insertions(+), 59 deletions(-) create mode 100644 queue_job_cron_jobrunner/i18n/queue_job_cron_jobrunner.pot create mode 100644 queue_job_cron_jobrunner/static/description/icon.png create mode 100644 queue_job_cron_jobrunner/static/description/index.html delete mode 100644 setup/_metapackage/VERSION.txt delete mode 100644 setup/_metapackage/setup.py diff --git a/README.md b/README.md index 9614ddff71..b3d7e77e27 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,7 @@ addon | version | maintainers | summary [queue_job_batch](queue_job_batch/) | 14.0.1.0.0 | | Job Queue Batch [queue_job_context](queue_job_context/) | 14.0.1.0.1 | [![AshishHirapara](https://github.com/AshishHirapara.png?size=30px)](https://github.com/AshishHirapara) | Queue Job, prepare context before enqueue keys [queue_job_cron](queue_job_cron/) | 14.0.1.1.0 | | Scheduled Actions as Queue Jobs +[queue_job_cron_jobrunner](queue_job_cron_jobrunner/) | 14.0.1.0.0 | | Run jobs without a dedicated JobRunner [queue_job_subscribe](queue_job_subscribe/) | 14.0.1.0.0 | | Control which users are subscribed to queue job notifications [test_base_import_async](test_base_import_async/) | 14.0.1.0.1 | | Test suite for base_import_async. Normally you don't need to install this. [test_queue_job](test_queue_job/) | 14.0.3.0.1 | | Queue Job Tests diff --git a/queue_job_cron_jobrunner/README.rst b/queue_job_cron_jobrunner/README.rst index d0cc046d68..26fd243a6d 100644 --- a/queue_job_cron_jobrunner/README.rst +++ b/queue_job_cron_jobrunner/README.rst @@ -1 +1,137 @@ -TO BE GENERATED AUTOMATICALLY +======================== +Queue Job Cron Jobrunner +======================== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png + :target: https://odoo-community.org/page/development-status + :alt: Alpha +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fqueue-lightgray.png?logo=github + :target: https://github.com/OCA/queue/tree/14.0/queue_job_cron_jobrunner + :alt: OCA/queue +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/queue-14-0/queue-14-0-queue_job_cron_jobrunner + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/230/14.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module implements a simple ``queue.job`` runner using ``ir.cron`` triggers. + +It's meant to be used on environments where the regular job runner can't be run, like +on Odoo.sh. + +Unlike the regular job runner, where jobs are dispatched to the HttpWorkers, jobs are +processed on the CronWorker threads by the job runner crons. This is a design decision +because: + +* Odoo.sh puts HttpWorkers to sleep when there's no network activity +* HttpWorkers are meant for traffic. Users shouldn't pay the price of background tasks. + +For now, it only implements the most basic features of the ``queue_job`` runner, notably +no channel capacity nor priorities. Please check the ROADMAP for further details. + +.. IMPORTANT:: + This is an alpha version, the data model and design can change at any time without warning. + Only for development or testing purpose, do not use in production. + `More details on development status `_ + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +.. warning:: + + Don't use this module if you're already running the regular ``queue_job`` runner. + + +For the easiest case, no configuration is required besides installing the module. + +To avoid CronWorker CPU timeout from abruptly stopping the job processing cron, it's +recommended to launch Odoo with ``--limit-time-real-cron=0``, to disable the CronWorker +timeout altogether. + +.. note:: + + In Odoo.sh, this is done by default. + + +Parallel execution of jobs can be achieved by leveraging multiple ``ir.cron`` records: + +* Make sure you have enough CronWorkers available (Odoo CLI ``--max-cron-threads``) +* Duplicate the ``queue_job_cron`` cron record as many times as needed, until you have + as much records as cron workers. + +Known issues / Roadmap +====================== + +* Support channel capacity and priority. (See ``_acquire_one_job``) +* Gracefully handle CronWorker CPU timeouts. (See ``_job_runner``) +* Commit transaction after job state updated to started. (See ``_process``) + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Camptocamp SA + +Contributors +~~~~~~~~~~~~ + +* `Camptocamp `_ + + * Iván Todorovich + +* `codeforward B.V. `_ + + * Chris Bergman + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +.. |maintainer-ivantodorovich| image:: https://github.com/ivantodorovich.png?size=40px + :target: https://github.com/ivantodorovich + :alt: ivantodorovich + +Current `maintainer `__: + +|maintainer-ivantodorovich| + +This module is part of the `OCA/queue `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/queue_job_cron_jobrunner/__manifest__.py b/queue_job_cron_jobrunner/__manifest__.py index 6c0caa52f9..4891883594 100644 --- a/queue_job_cron_jobrunner/__manifest__.py +++ b/queue_job_cron_jobrunner/__manifest__.py @@ -1,7 +1,7 @@ { "name": "Queue Job Cron Jobrunner", "summary": "Run jobs without a dedicated JobRunner", - "version": "15.0.1.0.0", + "version": "14.0.1.0.1", "development_status": "Alpha", "author": "Camptocamp SA, Odoo Community Association (OCA)", "maintainers": ["ivantodorovich"], diff --git a/queue_job_cron_jobrunner/i18n/queue_job_cron_jobrunner.pot b/queue_job_cron_jobrunner/i18n/queue_job_cron_jobrunner.pot new file mode 100644 index 0000000000..d81b10a5bd --- /dev/null +++ b/queue_job_cron_jobrunner/i18n/queue_job_cron_jobrunner.pot @@ -0,0 +1,43 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * queue_job_cron_jobrunner +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 15.0\n" +"Report-Msgid-Bugs-To: \n" +"Last-Translator: \n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: \n" + +#. module: queue_job_cron_jobrunner +#: model:ir.model.fields,help:queue_job_cron_jobrunner.field_ir_cron__queue_job_runner +msgid "If checked, the cron is considered to be a queue.job runner." +msgstr "" + +#. module: queue_job_cron_jobrunner +#: code:addons/queue_job_cron_jobrunner/models/queue_job.py:0 +#, python-format +msgid "Job interrupted and set to Done: nothing to do." +msgstr "" + +#. module: queue_job_cron_jobrunner +#: model:ir.model,name:queue_job_cron_jobrunner.model_queue_job +msgid "Queue Job" +msgstr "" + +#. module: queue_job_cron_jobrunner +#: model:ir.actions.server,name:queue_job_cron_jobrunner.queue_job_cron_ir_actions_server +#: model:ir.cron,cron_name:queue_job_cron_jobrunner.queue_job_cron +#: model:ir.cron,name:queue_job_cron_jobrunner.queue_job_cron +#: model:ir.model.fields,field_description:queue_job_cron_jobrunner.field_ir_cron__queue_job_runner +msgid "Queue Job Runner" +msgstr "" + +#. module: queue_job_cron_jobrunner +#: model:ir.model,name:queue_job_cron_jobrunner.model_ir_cron +msgid "Scheduled Actions" +msgstr "" diff --git a/queue_job_cron_jobrunner/models/queue_job.py b/queue_job_cron_jobrunner/models/queue_job.py index 4efd8b21d5..ba5825410e 100644 --- a/queue_job_cron_jobrunner/models/queue_job.py +++ b/queue_job_cron_jobrunner/models/queue_job.py @@ -4,11 +4,12 @@ import logging import traceback +from datetime import datetime from io import StringIO from psycopg2 import OperationalError -from odoo import _, api, models, tools +from odoo import _, api, fields, models, tools from odoo.service.model import PG_CONCURRENCY_ERRORS_TO_RETRY from odoo.addons.queue_job.controllers.main import PG_RETRY @@ -135,9 +136,21 @@ def _cron_trigger(self, at=None): All crons should be triggered at the same time. """ + if at is not None: + if isinstance(at, list) and not all([isinstance(x, datetime) for x in at]): + raise TypeError(f"Invalid parameter 'at': {str(at)}") + elif not isinstance(at, list) and not isinstance(at, datetime): + raise TypeError(f"Invalid parameter 'at': {str(at)}") crons = self.env["ir.cron"].sudo().search([("queue_job_runner", "=", True)]) + nextcall = fields.Datetime.now() + if at is not None: + if isinstance(at, list) and len(at): + nextcall = sorted(at).pop() + elif isinstance(at, datetime): + nextcall = at for cron in crons: - cron._trigger(at=at) + if nextcall < cron.nextcall: + cron.nextcall = nextcall def _ensure_cron_trigger(self): """Create cron triggers for these jobs""" diff --git a/queue_job_cron_jobrunner/static/description/icon.png b/queue_job_cron_jobrunner/static/description/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..3a0328b516c4980e8e44cdb63fd945757ddd132d GIT binary patch literal 9455 zcmW++2RxMjAAjx~&dlBk9S+%}OXg)AGE&Cb*&}d0jUxM@u(PQx^-s)697TX`ehR4?GS^qbkof1cslKgkU)h65qZ9Oc=ml_0temigYLJfnz{IDzUf>bGs4N!v3=Z3jMq&A#7%rM5eQ#dc?k~! zVpnB`o+K7|Al`Q_U;eD$B zfJtP*jH`siUq~{KE)`jP2|#TUEFGRryE2`i0**z#*^6~AI|YzIWy$Cu#CSLW3q=GA z6`?GZymC;dCPk~rBS%eCb`5OLr;RUZ;D`}um=H)BfVIq%7VhiMr)_#G0N#zrNH|__ zc+blN2UAB0=617@>_u;MPHN;P;N#YoE=)R#i$k_`UAA>WWCcEVMh~L_ zj--gtp&|K1#58Yz*AHCTMziU1Jzt_jG0I@qAOHsk$2}yTmVkBp_eHuY$A9)>P6o~I z%aQ?!(GqeQ-Y+b0I(m9pwgi(IIZZzsbMv+9w{PFtd_<_(LA~0H(xz{=FhLB@(1&qHA5EJw1>>=%q2f&^X>IQ{!GJ4e9U z&KlB)z(84HmNgm2hg2C0>WM{E(DdPr+EeU_N@57;PC2&DmGFW_9kP&%?X4}+xWi)( z;)z%wI5>D4a*5XwD)P--sPkoY(a~WBw;E~AW`Yue4kFa^LM3X`8x|}ZUeMnqr}>kH zG%WWW>3ml$Yez?i%)2pbKPI7?5o?hydokgQyZsNEr{a|mLdt;X2TX(#B1j35xPnPW z*bMSSOauW>o;*=kO8ojw91VX!qoOQb)zHJ!odWB}d+*K?#sY_jqPdg{Sm2HdYzdEx zOGVPhVRTGPtv0o}RfVP;Nd(|CB)I;*t&QO8h zFfekr30S!-LHmV_Su-W+rEwYXJ^;6&3|L$mMC8*bQptyOo9;>Qb9Q9`ySe3%V$A*9 zeKEe+b0{#KWGp$F+tga)0RtI)nhMa-K@JS}2krK~n8vJ=Ngm?R!9G<~RyuU0d?nz# z-5EK$o(!F?hmX*2Yt6+coY`6jGbb7tF#6nHA zuKk=GGJ;ZwON1iAfG$E#Y7MnZVmrY|j0eVI(DN_MNFJmyZ|;w4tf@=CCDZ#5N_0K= z$;R~bbk?}TpfDjfB&aiQ$VA}s?P}xPERJG{kxk5~R`iRS(SK5d+Xs9swCozZISbnS zk!)I0>t=A<-^z(cmSFz3=jZ23u13X><0b)P)^1T_))Kr`e!-pb#q&J*Q`p+B6la%C zuVl&0duN<;uOsB3%T9Fp8t{ED108<+W(nOZd?gDnfNBC3>M8WE61$So|P zVvqH0SNtDTcsUdzaMDpT=Ty0pDHHNL@Z0w$Y`XO z2M-_r1S+GaH%pz#Uy0*w$Vdl=X=rQXEzO}d6J^R6zjM1u&c9vYLvLp?W7w(?np9x1 zE_0JSAJCPB%i7p*Wvg)pn5T`8k3-uR?*NT|J`eS#_#54p>!p(mLDvmc-3o0mX*mp_ zN*AeS<>#^-{S%W<*mz^!X$w_2dHWpcJ6^j64qFBft-o}o_Vx80o0>}Du;>kLts;$8 zC`7q$QI(dKYG`Wa8#wl@V4jVWBRGQ@1dr-hstpQL)Tl+aqVpGpbSfN>5i&QMXfiZ> zaA?T1VGe?rpQ@;+pkrVdd{klI&jVS@I5_iz!=UMpTsa~mBga?1r}aRBm1WS;TT*s0f0lY=JBl66Upy)-k4J}lh=P^8(SXk~0xW=T9v*B|gzIhN z>qsO7dFd~mgxAy4V?&)=5ieYq?zi?ZEoj)&2o)RLy=@hbCRcfT5jigwtQGE{L*8<@Yd{zg;CsL5mvzfDY}P-wos_6PfprFVaeqNE%h zKZhLtcQld;ZD+>=nqN~>GvROfueSzJD&BE*}XfU|H&(FssBqY=hPCt`d zH?@s2>I(|;fcW&YM6#V#!kUIP8$Nkdh0A(bEVj``-AAyYgwY~jB zT|I7Bf@%;7aL7Wf4dZ%VqF$eiaC38OV6oy3Z#TER2G+fOCd9Iaoy6aLYbPTN{XRPz z;U!V|vBf%H!}52L2gH_+j;`bTcQRXB+y9onc^wLm5wi3-Be}U>k_u>2Eg$=k!(l@I zcCg+flakT2Nej3i0yn+g+}%NYb?ta;R?(g5SnwsQ49U8Wng8d|{B+lyRcEDvR3+`O{zfmrmvFrL6acVP%yG98X zo&+VBg@px@i)%o?dG(`T;n*$S5*rnyiR#=wW}}GsAcfyQpE|>a{=$Hjg=-*_K;UtD z#z-)AXwSRY?OPefw^iI+ z)AXz#PfEjlwTes|_{sB?4(O@fg0AJ^g8gP}ex9Ucf*@_^J(s_5jJV}c)s$`Myn|Kd z$6>}#q^n{4vN@+Os$m7KV+`}c%4)4pv@06af4-x5#wj!KKb%caK{A&Y#Rfs z-po?Dcb1({W=6FKIUirH&(yg=*6aLCekcKwyfK^JN5{wcA3nhO(o}SK#!CINhI`-I z1)6&n7O&ZmyFMuNwvEic#IiOAwNkR=u5it{B9n2sAJV5pNhar=j5`*N!Na;c7g!l$ z3aYBqUkqqTJ=Re-;)s!EOeij=7SQZ3Hq}ZRds%IM*PtM$wV z@;rlc*NRK7i3y5BETSKuumEN`Xu_8GP1Ri=OKQ$@I^ko8>H6)4rjiG5{VBM>B|%`&&s^)jS|-_95&yc=GqjNo{zFkw%%HHhS~e=s zD#sfS+-?*t|J!+ozP6KvtOl!R)@@-z24}`9{QaVLD^9VCSR2b`b!KC#o;Ki<+wXB6 zx3&O0LOWcg4&rv4QG0)4yb}7BFSEg~=IR5#ZRj8kg}dS7_V&^%#Do==#`u zpy6{ox?jWuR(;pg+f@mT>#HGWHAJRRDDDv~@(IDw&R>9643kK#HN`!1vBJHnC+RM&yIh8{gG2q zA%e*U3|N0XSRa~oX-3EAneep)@{h2vvd3Xvy$7og(sayr@95+e6~Xvi1tUqnIxoIH zVWo*OwYElb#uyW{Imam6f2rGbjR!Y3`#gPqkv57dB6K^wRGxc9B(t|aYDGS=m$&S!NmCtrMMaUg(c zc2qC=2Z`EEFMW-me5B)24AqF*bV5Dr-M5ig(l-WPS%CgaPzs6p_gnCIvTJ=Y<6!gT zVt@AfYCzjjsMEGi=rDQHo0yc;HqoRNnNFeWZgcm?f;cp(6CNylj36DoL(?TS7eU#+ z7&mfr#y))+CJOXQKUMZ7QIdS9@#-}7y2K1{8)cCt0~-X0O!O?Qx#E4Og+;A2SjalQ zs7r?qn0H044=sDN$SRG$arw~n=+T_DNdSrarmu)V6@|?1-ZB#hRn`uilTGPJ@fqEy zGt(f0B+^JDP&f=r{#Y_wi#AVDf-y!RIXU^0jXsFpf>=Ji*TeqSY!H~AMbJdCGLhC) zn7Rx+sXw6uYj;WRYrLd^5IZq@6JI1C^YkgnedZEYy<&4(z%Q$5yv#Boo{AH8n$a zhb4Y3PWdr269&?V%uI$xMcUrMzl=;w<_nm*qr=c3Rl@i5wWB;e-`t7D&c-mcQl7x! zZWB`UGcw=Y2=}~wzrfLx=uet<;m3~=8I~ZRuzvMQUQdr+yTV|ATf1Uuomr__nDf=X zZ3WYJtHp_ri(}SQAPjv+Y+0=fH4krOP@S&=zZ-t1jW1o@}z;xk8 z(Nz1co&El^HK^NrhVHa-_;&88vTU>_J33=%{if;BEY*J#1n59=07jrGQ#IP>@u#3A z;!q+E1Rj3ZJ+!4bq9F8PXJ@yMgZL;>&gYA0%_Kbi8?S=XGM~dnQZQ!yBSgcZhY96H zrWnU;k)qy`rX&&xlDyA%(a1Hhi5CWkmg(`Gb%m(HKi-7Z!LKGRP_B8@`7&hdDy5n= z`OIxqxiVfX@OX1p(mQu>0Ai*v_cTMiw4qRt3~NBvr9oBy0)r>w3p~V0SCm=An6@3n)>@z!|o-$HvDK z|3D2ZMJkLE5loMKl6R^ez@Zz%S$&mbeoqH5`Bb){Ei21q&VP)hWS2tjShfFtGE+$z zzCR$P#uktu+#!w)cX!lWN1XU%K-r=s{|j?)Akf@q#3b#{6cZCuJ~gCxuMXRmI$nGtnH+-h z+GEi!*X=AP<|fG`1>MBdTb?28JYc=fGvAi2I<$B(rs$;eoJCyR6_bc~p!XR@O-+sD z=eH`-ye})I5ic1eL~TDmtfJ|8`0VJ*Yr=hNCd)G1p2MMz4C3^Mj?7;!w|Ly%JqmuW zlIEW^Ft%z?*|fpXda>Jr^1noFZEwFgVV%|*XhH@acv8rdGxeEX{M$(vG{Zw+x(ei@ zmfXb22}8-?Fi`vo-YVrTH*C?a8%M=Hv9MqVH7H^J$KsD?>!SFZ;ZsvnHr_gn=7acz z#W?0eCdVhVMWN12VV^$>WlQ?f;P^{(&pYTops|btm6aj>_Uz+hqpGwB)vWp0Cf5y< zft8-je~nn?W11plq}N)4A{l8I7$!ks_x$PXW-2XaRFswX_BnF{R#6YIwMhAgd5F9X zGmwdadS6(a^fjHtXg8=l?Rc0Sm%hk6E9!5cLVloEy4eh(=FwgP`)~I^5~pBEWo+F6 zSf2ncyMurJN91#cJTy_u8Y}@%!bq1RkGC~-bV@SXRd4F{R-*V`bS+6;W5vZ(&+I<9$;-V|eNfLa5n-6% z2(}&uGRF;p92eS*sE*oR$@pexaqr*meB)VhmIg@h{uzkk$9~qh#cHhw#>O%)b@+(| z^IQgqzuj~Sk(J;swEM-3TrJAPCq9k^^^`q{IItKBRXYe}e0Tdr=Huf7da3$l4PdpwWDop%^}n;dD#K4s#DYA8SHZ z&1!riV4W4R7R#C))JH1~axJ)RYnM$$lIR%6fIVA@zV{XVyx}C+a-Dt8Y9M)^KU0+H zR4IUb2CJ{Hg>CuaXtD50jB(_Tcx=Z$^WYu2u5kubqmwp%drJ6 z?Fo40g!Qd<-l=TQxqHEOuPX0;^z7iX?Ke^a%XT<13TA^5`4Xcw6D@Ur&VT&CUe0d} z1GjOVF1^L@>O)l@?bD~$wzgf(nxX1OGD8fEV?TdJcZc2KoUe|oP1#=$$7ee|xbY)A zDZq+cuTpc(fFdj^=!;{k03C69lMQ(|>uhRfRu%+!k&YOi-3|1QKB z z?n?eq1XP>p-IM$Z^C;2L3itnbJZAip*Zo0aw2bs8@(s^~*8T9go!%dHcAz2lM;`yp zD=7&xjFV$S&5uDaiScyD?B-i1ze`+CoRtz`Wn+Zl&#s4&}MO{@N!ufrzjG$B79)Y2d3tBk&)TxUTw@QS0TEL_?njX|@vq?Uz(nBFK5Pq7*xj#u*R&i|?7+6# z+|r_n#SW&LXhtheZdah{ZVoqwyT{D>MC3nkFF#N)xLi{p7J1jXlmVeb;cP5?e(=f# zuT7fvjSbjS781v?7{)-X3*?>tq?)Yd)~|1{BDS(pqC zC}~H#WXlkUW*H5CDOo<)#x7%RY)A;ShGhI5s*#cRDA8YgqG(HeKDx+#(ZQ?386dv! zlXCO)w91~Vw4AmOcATuV653fa9R$fyK8ul%rG z-wfS zihugoZyr38Im?Zuh6@RcF~t1anQu7>#lPpb#}4cOA!EM11`%f*07RqOVkmX{p~KJ9 z^zP;K#|)$`^Rb{rnHGH{~>1(fawV0*Z#)}M`m8-?ZJV<+e}s9wE# z)l&az?w^5{)`S(%MRzxdNqrs1n*-=jS^_jqE*5XDrA0+VE`5^*p3CuM<&dZEeCjoz zR;uu_H9ZPZV|fQq`Cyw4nscrVwi!fE6ciMmX$!_hN7uF;jjKG)d2@aC4ropY)8etW=xJvni)8eHi`H$%#zn^WJ5NLc-rqk|u&&4Z6fD_m&JfSI1Bvb?b<*n&sfl0^t z=HnmRl`XrFvMKB%9}>PaA`m-fK6a0(8=qPkWS5bb4=v?XcWi&hRY?O5HdulRi4?fN zlsJ*N-0Qw+Yic@s0(2uy%F@ib;GjXt01Fmx5XbRo6+n|pP(&nodMoap^z{~q ziEeaUT@Mxe3vJSfI6?uLND(CNr=#^W<1b}jzW58bIfyWTDle$mmS(|x-0|2UlX+9k zQ^EX7Nw}?EzVoBfT(-LT|=9N@^hcn-_p&sqG z&*oVs2JSU+N4ZD`FhCAWaS;>|wH2G*Id|?pa#@>tyxX`+4HyIArWDvVrX)2WAOQff z0qyHu&-S@i^MS-+j--!pr4fPBj~_8({~e1bfcl0wI1kaoN>mJL6KUPQm5N7lB(ui1 zE-o%kq)&djzWJ}ob<-GfDlkB;F31j-VHKvQUGQ3sp`CwyGJk_i!y^sD0fqC@$9|jO zOqN!r!8-p==F@ZVP=U$qSpY(gQ0)59P1&t@y?5rvg<}E+GB}26NYPp4f2YFQrQtot5mn3wu_qprZ=>Ig-$ zbW26Ws~IgY>}^5w`vTB(G`PTZaDiGBo5o(tp)qli|NeV( z@H_=R8V39rt5J5YB2Ky?4eJJ#b`_iBe2ot~6%7mLt5t8Vwi^Jy7|jWXqa3amOIoRb zOr}WVFP--DsS`1WpN%~)t3R!arKF^Q$e12KEqU36AWwnCBICpH4XCsfnyrHr>$I$4 z!DpKX$OKLWarN7nv@!uIA+~RNO)l$$w}p(;b>mx8pwYvu;dD_unryX_NhT8*Tj>BTrTTL&!?O+%Rv;b?B??gSzdp?6Uug9{ zd@V08Z$BdI?fpoCS$)t4mg4rT8Q_I}h`0d-vYZ^|dOB*Q^S|xqTV*vIg?@fVFSmMpaw0qtTRbx} z({Pg?#{2`sc9)M5N$*N|4;^t$+QP?#mov zGVC@I*lBVrOU-%2y!7%)fAKjpEFsgQc4{amtiHb95KQEwvf<(3T<9-Zm$xIew#P22 zc2Ix|App^>v6(3L_MCU0d3W##AB0M~3D00EWoKZqsJYT(#@w$Y_H7G22M~ApVFTRHMI_3be)Lkn#0F*V8Pq zc}`Cjy$bE;FJ6H7p=0y#R>`}-m4(0F>%@P|?7fx{=R^uFdISRnZ2W_xQhD{YuR3t< z{6yxu=4~JkeA;|(J6_nv#>Nvs&FuLA&PW^he@t(UwFFE8)|a!R{`E`K`i^ZnyE4$k z;(749Ix|oi$c3QbEJ3b~D_kQsPz~fIUKym($a_7dJ?o+40*OLl^{=&oq$<#Q(yyrp z{J-FAniyAw9tPbe&IhQ|a`DqFTVQGQ&Gq3!C2==4x{6EJwiPZ8zub-iXoUtkJiG{} zPaR&}_fn8_z~(=;5lD-aPWD3z8PZS@AaUiomF!G8I}Mf>e~0g#BelA-5#`cj;O5>N Xviia!U7SGha1wx#SCgwmn*{w2TRX*I literal 0 HcmV?d00001 diff --git a/queue_job_cron_jobrunner/static/description/index.html b/queue_job_cron_jobrunner/static/description/index.html new file mode 100644 index 0000000000..a878a31c23 --- /dev/null +++ b/queue_job_cron_jobrunner/static/description/index.html @@ -0,0 +1,475 @@ + + + + + + +Queue Job Cron Jobrunner + + + +
+

Queue Job Cron Jobrunner

+ + +

Alpha License: AGPL-3 OCA/queue Translate me on Weblate Try me on Runbot

+

This module implements a simple queue.job runner using ir.cron triggers.

+

It’s meant to be used on environments where the regular job runner can’t be run, like +on Odoo.sh.

+

Unlike the regular job runner, where jobs are dispatched to the HttpWorkers, jobs are +processed on the CronWorker threads by the job runner crons. This is a design decision +because:

+
    +
  • Odoo.sh puts HttpWorkers to sleep when there’s no network activity
    • +
  • HttpWorkers are meant for traffic. Users shouldn’t pay the price of background tasks.
    • +
+

For now, it only implements the most basic features of the queue_job runner, notably +no channel capacity nor priorities. Please check the ROADMAP for further details.

+
+

Important

+

This is an alpha version, the data model and design can change at any time without warning. +Only for development or testing purpose, do not use in production. +More details on development status

+
+

Table of contents

+ +
+

Configuration

+
+

Warning

+

Don’t use this module if you’re already running the regular queue_job runner.

+
+

For the easiest case, no configuration is required besides installing the module.

+

To avoid CronWorker CPU timeout from abruptly stopping the job processing cron, it’s +recommended to launch Odoo with --limit-time-real-cron=0, to disable the CronWorker +timeout altogether.

+
+

Note

+

In Odoo.sh, this is done by default.

+
+

Parallel execution of jobs can be achieved by leveraging multiple ir.cron records:

+
    +
  • Make sure you have enough CronWorkers available (Odoo CLI --max-cron-threads)
    • +
  • Duplicate the queue_job_cron cron record as many times as needed, until you have +as much records as cron workers.
    • +
+
+
+

Known issues / Roadmap

+
    +
  • Support channel capacity and priority. (See _acquire_one_job)
    • +
  • Gracefully handle CronWorker CPU timeouts. (See _job_runner)
    • +
  • Commit transaction after job state updated to started. (See _process)
    • +
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Camptocamp SA
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

Current maintainer:

+

ivantodorovich

+

This module is part of the OCA/queue project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/queue_job_cron_jobrunner/tests/test_queue_job.py b/queue_job_cron_jobrunner/tests/test_queue_job.py index 3f2e0ef637..dd338bb3f7 100644 --- a/queue_job_cron_jobrunner/tests/test_queue_job.py +++ b/queue_job_cron_jobrunner/tests/test_queue_job.py @@ -2,39 +2,17 @@ # @author Iván Todorovich # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). -from datetime import timedelta - from freezegun import freeze_time -from odoo import fields from odoo.tests.common import TransactionCase from odoo.tools import mute_logger class TestQueueJob(TransactionCase): - @classmethod - def setUpClass(cls): - super().setUpClass() - cls.env = cls.env(context=dict(cls.env.context, tracking_disable=True)) - cls.cron = cls.env.ref("queue_job_cron_jobrunner.queue_job_cron") - # Cleanup triggers just in case - cls.env["ir.cron.trigger"].search([]).unlink() - - def assertTriggerAt(self, at, message=None): - """Ensures a cron trigger is created at the given time""" - return self.assertTrue( - self.env["ir.cron.trigger"].search([("call_at", "=", at)]), - message, - ) - - @freeze_time("2022-02-22 22:22:22") - def test_queue_job_cron_trigger(self): - """Test that ir.cron triggers are created for every queue.job""" - job = self.env["res.partner"].with_delay().create({"name": "test"}) - job_record = job.db_record() - self.assertTriggerAt(fields.Datetime.now(), "Trigger should've been created") - job_record.eta = fields.Datetime.now() + timedelta(hours=1) - self.assertTriggerAt(job_record.eta, "A new trigger should've been created") + def setUp(self): + super().setUp() + self.env = self.env(context=dict(self.env.context, tracking_disable=True)) + self.cron = self.env.ref("queue_job_cron_jobrunner.queue_job_cron") @mute_logger("odoo.addons.queue_job_cron_jobrunner.models.queue_job") def test_queue_job_process(self): diff --git a/setup/_metapackage/VERSION.txt b/setup/_metapackage/VERSION.txt deleted file mode 100644 index 786588ab49..0000000000 --- a/setup/_metapackage/VERSION.txt +++ /dev/null @@ -1 +0,0 @@ -14.0.20221019.0 \ No newline at end of file diff --git a/setup/_metapackage/setup.py b/setup/_metapackage/setup.py deleted file mode 100644 index c493dfc17a..0000000000 --- a/setup/_metapackage/setup.py +++ /dev/null @@ -1,26 +0,0 @@ -import setuptools - -with open('VERSION.txt', 'r') as f: - version = f.read().strip() - -setuptools.setup( - name="odoo14-addons-oca-queue", - description="Meta package for oca-queue Odoo addons", - version=version, - install_requires=[ - 'odoo14-addon-base_import_async', - 'odoo14-addon-queue_job', - 'odoo14-addon-queue_job_batch', - 'odoo14-addon-queue_job_context', - 'odoo14-addon-queue_job_cron', - 'odoo14-addon-queue_job_subscribe', - 'odoo14-addon-test_base_import_async', - 'odoo14-addon-test_queue_job', - 'odoo14-addon-test_queue_job_batch', - ], - classifiers=[ - 'Programming Language :: Python', - 'Framework :: Odoo', - 'Framework :: Odoo :: 14.0', - ] -) diff --git a/setup/base_import_async/odoo/addons/base_import_async b/setup/base_import_async/odoo/addons/base_import_async index 9c5e2709fa..0a110e42a8 120000 --- a/setup/base_import_async/odoo/addons/base_import_async +++ b/setup/base_import_async/odoo/addons/base_import_async @@ -1 +1 @@ -../../../../base_import_async/ \ No newline at end of file +../../../../base_import_async \ No newline at end of file diff --git a/setup/test_base_import_async/odoo/addons/test_base_import_async b/setup/test_base_import_async/odoo/addons/test_base_import_async index 5a932030c6..1da8a69c67 120000 --- a/setup/test_base_import_async/odoo/addons/test_base_import_async +++ b/setup/test_base_import_async/odoo/addons/test_base_import_async @@ -1 +1 @@ -../../../../test_base_import_async/ \ No newline at end of file +../../../../test_base_import_async \ No newline at end of file