Package: odoo13-addon-queue-job
This addon adds an integrated Job Queue to Odoo.It allows to postpone method calls executed asynchronously.Jobs are executed in the background by aJobrunner, in their own transaction.Example:fromodooimportmodels,fields,apiclassMyModel(models.Model):_name='my.model'defmy_method(self,a,k=None):_logger.info('executed with a:%sand k:%s',a,k)classMyOtherModel(models.Model):_name='my.other.model'defbutton_do_stuff(self):self.env['my.model'].with_delay().my_method('a',k=2)In the snippet of code above, when we callbutton_do_stuff, a jobcapturing
the method and argumentswill 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:Views for jobs, jobs are stored in PostgreSQLJobrunner: execute the jobs, highly efficient thanks to PostgreSQL’s NOTIFYChannels: give a capacity for the root channel and its sub-channels and
segregate jobs in them. Allow for instance to restrict heavy jobs to be
executed one at a time while little ones are executed 4 at a times.Retries: Ability to retry jobs by raising a type of exceptionRetry Pattern: the 3 first tries, retry after 10 seconds, the 5 next tries,
retry after 1 minutes, …Job properties: priorities, estimated time of arrival (ETA), custom
description, number of retriesRelated Actions: link an action on the job view, such as open the record
concerned by the jobTable of contentsInstallationConfigurationUsageDevelopersKnown issues / RoadmapChangelogNext13.0.1.2.0 (2020-03-10)13.0.1.1.0 (2019-11-01)13.0.1.0.0 (2019-10-14)Bug TrackerCreditsAuthorsContributorsMaintainersInstallationBe sure to have therequestslibrary.ConfigurationUsing environment variables and command line:Adjust environment variables (optional):ODOO_QUEUE_JOB_CHANNELS=root:4or any other channels configuration.
The default isroot:1ifxmlrpc_portis not set:ODOO_QUEUE_JOB_PORT=8069Start Odoo with--load=web,queue_joband--workersgreater than 1.[1]Using the Odoo configuration file:[options](...)workers=6server_wide_modules=web,queue_job(...)[queue_job]channels=root:2Confirm the runner is starting correctly by checking the odoo log file:...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 readyCreate jobs (eg usingbase_import_async) and observe they
start immediately and in parallel.Tip: to enable debug logging for the queue job, use--log-handler=odoo.addons.queue_job:DEBUG[1]It works with the threaded Odoo server too, although this way
of running Odoo is obviously not for production purposes.UsageTo use this module, you need to:Go toJob QueuemenuDevelopersConfigure default options for jobsIn earlier versions, jobs could be configured using the@jobdecorator.
This is now obsolete, they can be configured using optionalqueue.job.functionandqueue.job.channelXML records.Example of channel:<recordid="channel_sale"model="queue.job.channel"><fieldname="name">sale</field><fieldname="parent_id"ref="queue_job.channel_root"/></record>Example of job function:<recordid="job_function_sale_order_action_done"model="queue.job.function"><fieldname="model_id"ref="sale.model_sale_order"/><fieldname="method">action_done</field><fieldname="channel_id"ref="channel_sale"/><fieldname="related_action"eval='{"func_name": "custom_related_action"}'/><fieldname="retry_pattern"eval="{1: 60, 2: 180, 3: 10, 5: 300}"/></record>The general form for thenameis:<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: channelThe channel where the job will be delayed. The default channel isroot.Job function: related actionTheRelated Actionappears 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"},}enable: whenFalse, the button has no effect (default:True)func_name: name of the method onqueue.jobthat returns an actionkwargs: extra arguments to pass to the related action methodExample of related action code:classQueueJob(models.Model):_inherit='queue.job'defrelated_action_partner(self,name):self.ensure_one()model=self.model_namepartner=self.recordsaction={'name':name,'type':'ir.actions.act_window','res_model':model,'view_type':'form','view_mode':'form','res_id':partner.id,}returnactionJob function: retry patternWhen 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:5 first retries are postponed 10 seconds laterretries 5 to 10 postponed 20 seconds laterretries 10 to 15 postponed 30 seconds laterall subsequent retries postponed 5 minutes laterJob ContextThe 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 inBase._job_prepare_context_before_enqueue_keys.Example:classBase(models.AbstractModel):_inherit="base"@api.modeldef_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 OdooWhen you are developing (ie: connector modules) you might want
to bypass the queue job and run your code immediately.To do so you can setTEST_QUEUE_JOB_NO_DELAY=1in your enviroment.Bypass jobs in testsWhen writing tests on job-related methods is always tricky to deal with
delayed recordsets. To make your testing life easier
you can settest_queue_job_no_delay=Truein the context.Tip: you can do this at test case level like this@classmethoddefsetUpClass(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.Known issues / RoadmapAfter creating a new database or installingqueue_jobon an
existing database, Odoo must be restarted for the runner to detect it.When Odoo shuts down normally, it waits for running jobs to finish.
However, when the Odoo server crashes or is otherwise force-stopped,
running jobs are interrupted while the runner has no chance to know
they have been aborted. In such situations, jobs may remain instartedorenqueuedstate after the Odoo server is halted.
Since the runner has no way to know if they are actually running or
not, and does not know for sure if it is safe to restart the jobs,
it does not attempt to restart them automatically. Such stale jobs
therefore fill the running queue and prevent other jobs to start.
You must therefore requeue them manually, either from the Jobs view,
or by running the following SQL statementbefore starting Odoo:updatequeue_jobsetstate='pending'wherestatein('started','enqueued')ChangelogNext[ADD] Run jobrunner as a worker process instead of a thread in the main
process (when running with –workers > 0)[REF]@joband@related_actiondeprecated, any method can be delayed,
and configured usingqueue.job.functionrecords13.0.1.2.0 (2020-03-10)Fix Multi-company access rules13.0.1.1.0 (2019-11-01)Important: the license has been changed from AGPL3 to LGPL3.Remove deprecated default company method
(details on#180)13.0.1.0.0 (2019-10-14)[MIGRATION] from 12.0 branched at rev. 0138cd0Bug TrackerBugs are tracked onGitHub 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 welcomedfeedback.Do not contact contributors directly about support or help with technical issues.CreditsAuthorsCamptocampACSONE SA/NVContributorsGuewen Baconnier <guewen.baconnier@camptocamp.com>Stéphane Bidoul <stephane.bidoul@acsone.eu>Matthieu Dietrich <matthieu.dietrich@camptocamp.com>Jos De Graeve <Jos.DeGraeve@apertoso.be>David Lefever <dl@taktik.be>Laurent Mignon <laurent.mignon@acsone.eu>Laetitia Gangloff <laetitia.gangloff@acsone.eu>Cédric Pigeon <cedric.pigeon@acsone.eu>Tatiana Deribina <tatiana.deribina@avoin.systems>Souheil Bejaoui <souheil.bejaoui@acsone.eu>MaintainersThis 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.Currentmaintainer:This module is part of theOCA/queueproject on GitHub.You are welcome to contribute. To learn how please visithttps://odoo-community.org/page/Contribute.