[17.0][MIG] queue_job_cron_jobrunner: Migration to 17.0

queue_job_cron_jobrunner/README.rst

@@ -0,0 +1,143 @@
+========================
+Queue Job Cron Jobrunner
+========================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:ea15f976f55eddd46d51fc2bb989455756811717bbdc8f69764d02a0d6014b32
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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/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-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=17.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:%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>`__
+
+      -  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/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.

queue_job_cron_jobrunner/__init__.py

@@ -0,0 +1 @@
+from . import models

queue_job_cron_jobrunner/__manifest__.py

@@ -0,0 +1,17 @@
+{
+    "name": "Queue Job Cron Jobrunner",
+    "summary": "Run jobs without a dedicated JobRunner",
+    "version": "17.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,
+}

queue_job_cron_jobrunner/data/ir_cron.xml

@@ -0,0 +1,16 @@
+<?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>
+        <field name="numbercall">-1</field>
+    </record>
+
+</odoo>

queue_job_cron_jobrunner/i18n/es.po

@@ -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: 2023-12-01 19:35+0000\n"
+"Last-Translator: Ivorra78 <[email protected]>\n"
+"Language-Team: none\n"
+"Language: es\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 "Si está marcada, el cron se considera un ejecutor de queue.job runner."
+
+#. 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 "Trabajo interrumpido y marcado como hecho: nada que hacer."
+
+#. module: queue_job_cron_jobrunner
+#: model:ir.model,name:queue_job_cron_jobrunner.model_queue_job
+msgid "Queue Job"
+msgstr "Cola de Trabajo"
+
+#. 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.model.fields,field_description:queue_job_cron_jobrunner.field_ir_cron__queue_job_runner
+msgid "Queue Job Runner"
+msgstr "Cola de Ejecución de Trabajos"
+
+#. module: queue_job_cron_jobrunner
+#: model:ir.model,name:queue_job_cron_jobrunner.model_ir_cron
+msgid "Scheduled Actions"
+msgstr "Acciones Planificadas"

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 16.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.cron,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 ""

queue_job_cron_jobrunner/i18n/ro.po

@@ -0,0 +1,47 @@
+# 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.cron,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 ""

queue_job_cron_jobrunner/models/__init__.py

@@ -0,0 +1,2 @@
+from . import ir_cron
+from . import queue_job

queue_job_cron_jobrunner/models/ir_cron.py

@@ -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.",
+    )