Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[18.0][MIG] queue_job_cron_jobrunner: Migration to 18.0 #709

Open
wants to merge 25 commits into
base: 18.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
8bb1473
[ADD] queue_job_cron_jobrunner
ivantodorovich Mar 2, 2022
f6fd97a
[UPD] Update queue_job_cron_jobrunner.pot
Apr 11, 2022
99f159c
[UPD] README.rst
OCA-git-bot Apr 11, 2022
351d699
[ADD] icon.png
OCA-git-bot Apr 11, 2022
87ae330
Initialize 16.0
sbidoul Oct 3, 2022
df19199
Add enqueue of graph dependencies in queue_job_cron_jobrunner
guewen Nov 1, 2022
e9b1fd2
queue_job_cron_jobrunner 15.0.2.0.0
OCA-git-bot Nov 15, 2022
0589384
Added translation using Weblate (Romanian)
dhongu Nov 23, 2022
9a2f8bb
Translated using Weblate (Romanian)
dhongu Nov 23, 2022
72458e4
[MIG] queue_job_cron_jobrunner: Migration to 16.0
nilshamerlinck Dec 14, 2022
a3382f0
[UPD] Update queue_job_cron_jobrunner.pot
Feb 20, 2023
24df2fd
[UPD] README.rst
OCA-git-bot Feb 20, 2023
e4f6a74
[UPD] README.rst
OCA-git-bot Sep 3, 2023
7f1fd85
Update translation files
weblate Oct 9, 2023
c1efbec
[IMP] queue_job_cron_jobrunner: pre-commit auto fixes
sanderlienaerts Dec 1, 2023
4e1151e
[MIG] queue_job_cron_jobrunner: Migration to 17.0
sanderlienaerts Dec 6, 2023
b3e5706
[UPD] Update queue_job_cron_jobrunner.pot
Dec 13, 2023
0167752
[BOT] post-merge updates
OCA-git-bot Dec 13, 2023
dd393b4
Update translation files
weblate Feb 3, 2024
b5de87a
Added translation using Weblate (Italian)
mymage Feb 5, 2024
3874161
Translated using Weblate (Italian)
mymage Feb 12, 2024
f763833
Added translation using Weblate (Chinese (Simplified) (zh_CN))
xtanuiha Jul 2, 2024
6e65b55
Translated using Weblate (Chinese (Simplified) (zh_CN))
xtanuiha Jul 2, 2024
17ad576
[IMP] queue_job_cron_jobrunner: pre-commit auto fixes
achulii Nov 18, 2024
a04ea9b
[MIG] queue_job_cron_jobrunner: Migration to 18.0
achulii Nov 18, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 143 additions & 0 deletions queue_job_cron_jobrunner/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
========================
Queue Job Cron Jobrunner
========================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:a9ff3bc27cff35398d24b6b1dc300a5b8acc9c06d417b1969b1c2e2974e39ec9
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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/18.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-18-0/queue-18-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=18.0
:alt: Try me on Runboat

|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 <https://odoo-community.org/page/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 <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:%2018.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>`__

- Iván Todorovich <[email protected]>

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 <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-ivantodorovich|

This module is part of the `OCA/queue <https://github.com/OCA/queue/tree/18.0/queue_job_cron_jobrunner>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
1 change: 1 addition & 0 deletions queue_job_cron_jobrunner/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import models
17 changes: 17 additions & 0 deletions queue_job_cron_jobrunner/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"name": "Queue Job Cron Jobrunner",
"summary": "Run jobs without a dedicated JobRunner",
"version": "18.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",
],
"installable": True,
}
13 changes: 13 additions & 0 deletions queue_job_cron_jobrunner/data/ir_cron.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?xml version="1.0" encoding="utf-8" ?>
<odoo noupdate="1">
<record id="queue_job_cron" model="ir.cron">
<field name="name">Queue Job Runner</field>
<field name="model_id" ref="queue_job.model_queue_job" />
<field name="state">code</field>
<field name="code">model._job_runner()</field>
<field name="queue_job_runner" eval="True" />
<field name="user_id" ref="base.user_root" />
<field name="interval_number">1</field>
<field name="interval_type">days</field>
</record>
</odoo>
45 changes: 45 additions & 0 deletions queue_job_cron_jobrunner/i18n/it.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * queue_job_cron_jobrunner
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 17.0\n"
"Report-Msgid-Bugs-To: \n"
"PO-Revision-Date: 2024-02-12 11:39+0000\n"
"Last-Translator: mymage <[email protected]>\n"
"Language-Team: none\n"
"Language: it\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: nplurals=2; plural=n != 1;\n"
"X-Generator: Weblate 4.17\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 "Se selezionata, il cron è considerato un esecutore del queue.job."

#. module: queue_job_cron_jobrunner
#. odoo-python
#: code:addons/queue_job_cron_jobrunner/models/queue_job.py:0
#, python-format
msgid "Job interrupted and set to Done: nothing to do."
msgstr "Lavoro interrotto e impostato a completato: nulla da fare."

#. module: queue_job_cron_jobrunner
#: model:ir.model,name:queue_job_cron_jobrunner.model_queue_job
msgid "Queue Job"
msgstr "Lavoro in coda"

#. module: queue_job_cron_jobrunner
#: model:ir.actions.server,name:queue_job_cron_jobrunner.queue_job_cron_ir_actions_server
#: model:ir.model.fields,field_description:queue_job_cron_jobrunner.field_ir_cron__queue_job_runner
msgid "Queue Job Runner"
msgstr "Esecutore lavoro in coda"

#. module: queue_job_cron_jobrunner
#: model:ir.model,name:queue_job_cron_jobrunner.model_ir_cron
msgid "Scheduled Actions"
msgstr "Azioni pianificate"
42 changes: 42 additions & 0 deletions queue_job_cron_jobrunner/i18n/queue_job_cron_jobrunner.pot
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * queue_job_cron_jobrunner
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 17.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
#. odoo-python
#: 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.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 ""
46 changes: 46 additions & 0 deletions queue_job_cron_jobrunner/i18n/ro.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * queue_job_cron_jobrunner
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 16.0\n"
"Report-Msgid-Bugs-To: \n"
"PO-Revision-Date: 2022-11-23 09:45+0000\n"
"Last-Translator: Dorin Hongu <[email protected]>\n"
"Language-Team: none\n"
"Language: ro\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: nplurals=3; plural=n==1 ? 0 : (n==0 || (n%100 > 0 && n%100 < "
"20)) ? 1 : 2;\n"
"X-Generator: Weblate 4.14.1\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 "Dacă este bifat, cron-ul este considerat a fi un runner queue.job."

#. module: queue_job_cron_jobrunner
#. odoo-python
#: code:addons/queue_job_cron_jobrunner/models/queue_job.py:0
#, python-format
msgid "Job interrupted and set to Done: nothing to do."
msgstr "Job întrerupt și setat la Terminat: nimic de făcut."

#. module: queue_job_cron_jobrunner
#: model:ir.model,name:queue_job_cron_jobrunner.model_queue_job
msgid "Queue Job"
msgstr "Coadă sarcini"

#. module: queue_job_cron_jobrunner
#: model:ir.actions.server,name:queue_job_cron_jobrunner.queue_job_cron_ir_actions_server
#: 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 ""
45 changes: 45 additions & 0 deletions queue_job_cron_jobrunner/i18n/zh_CN.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * queue_job_cron_jobrunner
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 17.0\n"
"Report-Msgid-Bugs-To: \n"
"PO-Revision-Date: 2024-07-02 09:47+0000\n"
"Last-Translator: xtanuiha <[email protected]>\n"
"Language-Team: none\n"
"Language: zh_CN\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: nplurals=1; plural=0;\n"
"X-Generator: Weblate 4.17\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 "如果选中,cron任务将被视为队列.job的执行器。"

#. module: queue_job_cron_jobrunner
#. odoo-python
#: 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.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 "计划的动作"
2 changes: 2 additions & 0 deletions queue_job_cron_jobrunner/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
from . import ir_cron
from . import queue_job
13 changes: 13 additions & 0 deletions queue_job_cron_jobrunner/models/ir_cron.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Copyright 2022 Camptocamp SA (https://www.camptocamp.com).
# @author Iván Todorovich <[email protected]>
# 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.",
)
Loading
Loading