Celery

Put a model-method on the Celery Task Queue

Just Python code to call from an Odoo model

Example

Model and method:

• model: "celery.example"
• method: "schedule_import"

Celery Options:

Shall be provided to kwargs of the call_task method

celery = {
    'queue': 'high.priority',
    'countdown': 5,
    'retry': True,
    'retry_countdown_setting': 'MUL_RETRIES_SECS',
    'retry_countdown_multiply_retries_seconds': 60,
    'retry_policy': {
        'interval_start': 30
    }
}

Calling the task:

self.env["celery.task"].call_task("celery.example", "schedule_import", celery=celery)

Celery Options

All Celery options are optional (not required).

Extra kwargs

Extra kwargs are optional (not required).

Installation and configuration

# celery -A odoo worker --loglevel=info

# celery -A odoo worker --loglevel=info -Q high.priority -n high.priority

Changelog

0.27

• Improvement: Add tracking for field exc_info (Exception Info).
  (GitHub PR: https://github.com/novacode-nl/odoo-celery/pull/38)
• Imrpvovement: Implement broker connection based on env.vars
  (GitHub PR: https://github.com/novacode-nl/odoo-celery/pull/41)

0.26

• Fix: AccessDenied error is raised if no password was passed to the function, but this exception was not imported.
  (GitHub PR: https://github.com/novacode-nl/odoo-celery/pull/37)

0.25

• Fix relating to 0.21 (support inactive Celery User). Inactive user not allowed anymore, since recent Odoo 14.0
  Override the res.users access check method: only for Celery user (from config) remove the active check.

0.24

• Fix crash (upon install, update) due to faulty config of Window Action "Flag/update task: Stuck" (action_celery_task_set_state_stuck) - introduced by porting to Odoo 14.0.

0.23

• Fix cancellation of stucked tasks(s) wasn't possible.
• Fix requeue of stucked tasks(s) wasn't possible.

0.22

• Upon processing task rpc_run_task (method), only update the related record fields (res_model, res_ids) if these have a value set in the method its result.
  This enables the API to store these related record fields upfront, when the task is created.

0.21

• Some security hardening: support inactive Celery User, which refuses regular (web) authentication/login.

0.20

• [FIX] In call_task() the search of celery.task.setting results in Access Denied by ACLs for operation: read, model: celery.task.setting.
  Solved by calling the celery.task.setting search() with sudo().

0.19

• [FIX] Related record: res_ids (now ListSerialized field).
• Also change kwargs field to sensible class(name): TaskSerialized to KwargsSerialized.

0.18

• Configurable (database) transaction strategy, when the task shall apply (ORM create and send to Celery MQ).
• From now on - by default a task shall apply after commit of the main/caller transaction, instead of immediately in the main/caller transaction.

0.17

• Task scheduling added - being able to schedule tasks in a specified time interval or certain day(s) of the week.
• A new task state - Scheduled, is handled by an Odoo cron job - "Celery: Handle Scheduled Tasks".

0.16

• Configurable celery queues added to task settings.

0.15

• Scheduled (cron) cleanup of tasks - with optionally specifying/overriding: (1) timedelta (days=90, hours, minutes, seconds), (2) states to keep and (3) batch_size=100.
• Create database index for the State Time (state_date) field.

0.14

• Create database index for the Reference field (ref).

0.13

• Get XML-RPC URL from ir.config.parameter (celery.celery_base_url) by Settings.

0.12

• Also support to get the Celery (Odoo) user and password from the odoo.conf file, under section [options] too.

0.11

• Put task into a new state "Retrying", right before the Retry starts.

0.10

• Renamed task retry settings: 'MUL_RETR' to 'MUL_RETRIES', 'MUL_RETR_SECS' to 'MUL_RETRIES_SECS'.

0.9

• Hide (Odoo) password in the "retry" payload used by the MQ broker for XML-RPC authentication.
  GitHub issue: https://github.com/novacode-nl/odoo-celery/issues/17

0.8

• Fix task retry countdown/interval ignored. For more info see https://github.com/novacode-nl/odoo-celery/issues/14
• Add task retry countdown settings, to increase countdown during retries ('ADD_SECS', 'MUL_RETRY', 'MUL_RETRY_SECS').
• Search view of stuck tasks: (1) Add/show field reference (2) search-view with filters and grouping.
• Track task changes of fields model, method, handle_stuck
• Disable create/copy in the task form-view.

0.7

• Task Reference, which serves:
  • Easier searching for tasks by Reference.
  • Check (ORM query) before call_task() call, to prevent redundant creation of recurring Pending tasks.

0.6

• Settings: to specify when a task (model, method) is Stuck after seconds from Started or Retry (states).
• Stuck Tasks Report: which shows Stuck (not completed) tasks.
• Cron or manually put tasks in "Stuck" state.
• Ability to cancel (Pending or Stuck) tasks, which never completed.
• Track and messaging about state change. Chatter on form view.

0.5

• Routing tasks to specific (named) queues.

0.4

• FIX: Store task state (Started, Retry) before execution.

0.3

• Hide (Odoo) password in payload used by the broker for XML-RPC authentication.
  GitHub issue: https://github.com/novacode-nl/odoo-celery/issues/4

0.2

• Task state information.

0.1

• Initial version.