This addon adds an integrated Job Queue to Odoo.
It allows to postpone method calls executed asynchronously.
Jobs are executed in the background by a Jobrunner, in their own transaction.
Example:
from odoo import models, fields, api class MyModel(models.Model): _name = 'my.model' def my_method(self, a, k=None): _logger.info('executed with a: %s and k: %s', a, k) class MyOtherModel(models.Model): _name = 'my.other.model' def button_do_stuff(self): self.env['my.model'].with_delay().my_method('a', k=2)
In the snippet of code above, when we call button_do_stuff, a job capturing the method and arguments will be postponed. It will be executed as soon as the Jobrunner has a free bucket, which can be instantaneous if no other job is running.
Features:
Table of contents
Be sure to have the requests library.
[options] (...) workers = 6 server_wide_modules = web,queue_job (...) [queue_job] channels = root:2
...INFO...queue_job.jobrunner.runner: starting ...INFO...queue_job.jobrunner.runner: initializing database connections ...INFO...queue_job.jobrunner.runner: queue job runner ready for db <dbname> ...INFO...queue_job.jobrunner.runner: database connections ready
| [1] | It works with the threaded Odoo server too, although this way of running Odoo is obviously not for production purposes. |
To use this module, you need to:
Configure default options for jobs
In earlier versions, jobs could be configured using the @job decorator. This is now obsolete, they can be configured using optional queue.job.function and queue.job.channel XML records.
Example of channel:
<record id="channel_sale" model="queue.job.channel"> <field name="name">sale</field> <field name="parent_id" ref="queue_job.channel_root" /> </record>
Example of job function:
<record id="job_function_sale_order_action_done" model="queue.job.function"> <field name="model_id" ref="sale.model_sale_order" /> <field name="method">action_done</field> <field name="channel_id" ref="channel_sale" /> <field name="related_action" eval='{"func_name": "custom_related_action"}' /> <field name="retry_pattern" eval="{1: 60, 2: 180, 3: 10, 5: 300}" /> </record>
The general form for the name is: <model.name>.method.
The channel, related action and retry pattern options are optional, they are documented below.
When writing modules, if 2+ modules add a job function or channel with the same name (and parent for channels), they’ll be merged in the same record, even if they have different xmlids. On uninstall, the merged record is deleted when all the modules using it are uninstalled.
Job function: channel
The channel where the job will be delayed. The default channel is root.
Job function: related action
The Related Action appears as a button on the Job’s view. The button will execute the defined action.
The default one is to open the view of the record related to the job (form view when there is a single record, list view for several records). In many cases, the default related action is enough and doesn’t need customization, but it can be customized by providing a dictionary on the job function:
{ "enable": False, "func_name": "related_action_partner", "kwargs": {"name": "Partner"}, }
Example of related action code:
class QueueJob(models.Model): _inherit = 'queue.job' def related_action_partner(self, name): self.ensure_one() model = self.model_name partner = self.records action = { 'name': name, 'type': 'ir.actions.act_window', 'res_model': model, 'view_type': 'form', 'view_mode': 'form', 'res_id': partner.id, } return action
Job function: retry pattern
When a job fails with a retryable error type, it is automatically retried later. By default, the retry is always 10 minutes later.
A retry pattern can be configured on the job function. What a pattern represents is “from X tries, postpone to Y seconds”. It is expressed as a dictionary where keys are tries and values are seconds to postpone as integers:
{ 1: 10, 5: 20, 10: 30, 15: 300, }
Based on this configuration, we can tell that:
Job Context
The context of the recordset of the job, or any recordset passed in arguments of a job, is transferred to the job according to an allow-list.
The default allow-list is empty for backward compatibility. The allow-list can be customized in Base._job_prepare_context_before_enqueue_keys.
Example:
class Base(models.AbstractModel): _inherit = "base" @api.model def _job_prepare_context_before_enqueue_keys(self): """Keys to keep in context of stored jobs Empty by default for backward compatibility. """ return ("tz", "lang", "allowed_company_ids", "force_company", "active_test")
Bypass jobs on running Odoo
When you are developing (ie: connector modules) you might want to bypass the queue job and run your code immediately.
To do so you can set TEST_QUEUE_JOB_NO_DELAY=1 in your enviroment.
Bypass jobs in tests
When writing tests on job-related methods is always tricky to deal with delayed recordsets. To make your testing life easier you can set test_queue_job_no_delay=True in the context.
Tip: you can do this at test case level like this
@classmethod def setUpClass(cls): super().setUpClass() cls.env = cls.env(context=dict( cls.env.context, test_queue_job_no_delay=True, # no jobs thanks ))
Then all your tests execute the job methods synchronously without delaying any jobs.
update queue_job set state='pending' where state in ('started', 'enqueued')
Important: the license has been changed from AGPL3 to LGPL3.
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 to smash it by providing a detailed and welcomed feedback.
Do not contact contributors directly about support or help with technical issues.
This module is maintained by the OCA.
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:
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.