-
-
Notifications
You must be signed in to change notification settings - Fork 460
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[IMP] queue_job_cron_jobrunner: pre-commit auto fixes
- Loading branch information
1 parent
e786195
commit 87eb6f0
Showing
11 changed files
with
129 additions
and
107 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,31 +17,34 @@ Queue Job Cron Jobrunner | |
| :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/16.0/queue_job_cron_jobrunner | ||
| :target: https://github.com/OCA/queue/tree/17.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-16-0/queue-16-0-queue_job_cron_jobrunner | ||
| :target: https://translation.odoo-community.org/projects/queue-17-0/queue-17-0-queue_job_cron_jobrunner | ||
| :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=16.0 | ||
| :target: https://runboat.odoo-community.org/builds?repo=OCA/queue&target_branch=17.0 | ||
| :alt: Try me on Runboat | ||
|
|
||
| |badge1| |badge2| |badge3| |badge4| |badge5| | ||
|
|
||
| This module implements a simple ``queue.job`` runner using ``ir.cron`` triggers. | ||
| 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. | ||
| 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: | ||
| 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. | ||
| - 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. | ||
| 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. | ||
|
|
@@ -56,62 +59,66 @@ no channel capacity nor priorities. Please check the ROADMAP for further details | |
| Configuration | ||
| ============= | ||
|
|
||
| .. warning:: | ||
| Warning | ||
|
|
||
| Don't use this module if you're already running the regular ``queue_job`` runner. | ||
| 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. | ||
|
|
||
| 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. | ||
|
|
||
| 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 | ||
|
|
||
| .. note:: | ||
| In Odoo.sh, this is done by default. | ||
|
|
||
| In Odoo.sh, this is done by default. | ||
| Parallel execution of jobs can be achieved by leveraging multiple | ||
| ``ir.cron`` records: | ||
|
|
||
|
|
||
| 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. | ||
| - 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``) | ||
| - 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 <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_cron_jobrunner%0Aversion:%2016.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_cron_jobrunner%0Aversion:%2017.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. | ||
|
|
||
| Credits | ||
| ======= | ||
|
|
||
| Authors | ||
| ~~~~~~~ | ||
| ------- | ||
|
|
||
| * Camptocamp SA | ||
|
|
||
| Contributors | ||
| ~~~~~~~~~~~~ | ||
| ------------ | ||
|
|
||
| * `Camptocamp <https://www.camptocamp.com>`_ | ||
| - `Camptocamp <https://www.camptocamp.com>`__ | ||
|
|
||
| * Iván Todorovich <[email protected]> | ||
| - Iván Todorovich <[email protected]> | ||
|
|
||
| Maintainers | ||
| ~~~~~~~~~~~ | ||
| ----------- | ||
|
|
||
| This module is maintained by the OCA. | ||
|
|
||
|
|
@@ -131,6 +138,6 @@ Current `maintainer <https://odoo-community.org/page/maintainer-role>`__: | |
|
|
||
| |maintainer-ivantodorovich| | ||
|
|
||
| This module is part of the `OCA/queue <https://github.com/OCA/queue/tree/16.0/queue_job_cron_jobrunner>`_ project on GitHub. | ||
| This module is part of the `OCA/queue <https://github.com/OCA/queue/tree/17.0/queue_job_cron_jobrunner>`_ project on GitHub. | ||
|
|
||
| You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| [build-system] | ||
| requires = ["whool"] | ||
| build-backend = "whool.buildapi" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| 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. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| - [Camptocamp](https://www.camptocamp.com) | ||
|
|
||
| > - Iván Todorovich \<<[email protected]>\> |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| 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. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| - 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`) |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters