Initial commit: Odoo 18.0-20251222 extra-addons

sale_automatic_workflow_job/README.rst

@@ -0,0 +1,99 @@
+===========================
+Sale Automatic Workflow Job
+===========================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:530fd5f9a887344d84d80c8f0eadd1193d52d578beb1f90b46784814fde5c1d7
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |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%2Fsale--workflow-lightgray.png?logo=github
+    :target: https://github.com/OCA/sale-workflow/tree/18.0/sale_automatic_workflow_job
+    :alt: OCA/sale-workflow
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/sale-workflow-18-0/sale-workflow-18-0-sale_automatic_workflow_job
+    :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/sale-workflow&target_branch=18.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+Use Queue Jobs to process the Sales Automatic Workflow actions.
+
+The default behavior of the automatic workflow module is to use a
+scheduled action that searches all the record that need a workflow
+action and sequentially process all of them.
+
+It can hit some limits when the number of records is too high.
+
+This module keeps the scheduled action to search the records, but
+instead of directly executing the actions (confirm a sales order, create
+invoices for a sales order, validate invoices, ...), it creates one job
+per operation to do.
+
+It uses an identity key on the jobs so it will not create the same job
+for the same record and same operation twice.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/sale-workflow/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/sale-workflow/issues/new?body=module:%20sale_automatic_workflow_job%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
+
+Contributors
+------------
+
+- Guewen Baconnier <guewen.baconnier@camptocamp.com>
+- Saran Lim. <saranl@ecosoft.co.th>
+- Kitti U. <kittiu@ecosoft.co.th>
+- Chau Le <chaulb@trobz.com>
+
+Other credits
+-------------
+
+The migration of this module from 16.0 to 18.0 was financially supported
+by Camptocamp.
+
+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.
+
+This module is part of the `OCA/sale-workflow <https://github.com/OCA/sale-workflow/tree/18.0/sale_automatic_workflow_job>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

sale_automatic_workflow_job/__init__.py

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

sale_automatic_workflow_job/__manifest__.py

@@ -0,0 +1,16 @@
+# Copyright 2020 Camptocamp (https://www.camptocamp.com)
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+{
+    "name": "Sale Automatic Workflow Job",
+    "summary": "Execute sale automatic workflows in queue jobs",
+    "version": "18.0.1.0.0",
+    "category": "Sales Management",
+    "license": "AGPL-3",
+    "author": "Camptocamp, " "Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/sale-workflow",
+    "depends": ["sale_automatic_workflow", "queue_job"],
+    "data": [
+        "data/queue_job_data.xml",
+    ],
+}

sale_automatic_workflow_job/data/queue_job_data.xml

@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo>
+    <!-- Queue Job Channel -->
+    <record id="channel_sale_automatic_workflow" model="queue.job.channel">
+        <field name="name">channel.sale.automatic.workflow</field>
+        <field name="parent_id" ref="queue_job.channel_root" />
+    </record>
+
+    <!-- Queue Job Function -->
+    <record id="job_function_do_validate_sale_order" model="queue.job.function">
+        <field
+            name="model_id"
+            ref="sale_automatic_workflow_job.model_automatic_workflow_job"
+        />
+        <field name="method">_do_validate_sale_order</field>
+        <field name="channel_id" ref="channel_sale_automatic_workflow" />
+        <field
+            name="related_action"
+            eval='{"func_name": "_related_action_sale_automatic_workflow"}'
+        />
+    </record>
+
+    <record
+        id="job_function_do_send_order_confirmation_mail"
+        model="queue.job.function"
+    >
+        <field
+            name="model_id"
+            ref="sale_automatic_workflow_job.model_automatic_workflow_job"
+        />
+        <field name="method">_do_send_order_confirmation_mail</field>
+        <field name="channel_id" ref="channel_sale_automatic_workflow" />
+        <field
+            name="related_action"
+            eval='{"func_name": "_related_action_sale_automatic_workflow"}'
+        />
+    </record>
+
+    <record id="job_function_do_create_invoice" model="queue.job.function">
+        <field
+            name="model_id"
+            ref="sale_automatic_workflow_job.model_automatic_workflow_job"
+        />
+        <field name="method">_do_create_invoice</field>
+        <field name="channel_id" ref="channel_sale_automatic_workflow" />
+        <field
+            name="related_action"
+            eval='{"func_name": "_related_action_sale_automatic_workflow"}'
+        />
+    </record>
+
+    <record id="job_function_do_validate_invoice" model="queue.job.function">
+        <field
+            name="model_id"
+            ref="sale_automatic_workflow_job.model_automatic_workflow_job"
+        />
+        <field name="method">_do_validate_invoice</field>
+        <field name="channel_id" ref="channel_sale_automatic_workflow" />
+        <field
+            name="related_action"
+            eval='{"func_name": "_related_action_sale_automatic_workflow"}'
+        />
+    </record>
+
+    <record id="job_function_do_sale_done" model="queue.job.function">
+        <field
+            name="model_id"
+            ref="sale_automatic_workflow_job.model_automatic_workflow_job"
+        />
+        <field name="method">_do_sale_done</field>
+        <field name="channel_id" ref="channel_sale_automatic_workflow" />
+        <field
+            name="related_action"
+            eval='{"func_name": "_related_action_sale_automatic_workflow"}'
+        />
+    </record>
+</odoo>

sale_automatic_workflow_job/i18n/es.po

@@ -0,0 +1,73 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# 	* sale_automatic_workflow_job
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 16.0\n"
+"Report-Msgid-Bugs-To: \n"
+"PO-Revision-Date: 2023-09-20 04:33+0000\n"
+"Last-Translator: Ivorra78 <informatica@totmaterial.es>\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: sale_automatic_workflow_job
+#. odoo-python
+#: code:addons/sale_automatic_workflow_job/models/automatic_workflow_job.py:0
+#, python-format
+msgid "Create invoices for sales order {}"
+msgstr "Cree facturas para pedidos de venta {}"
+
+#. module: sale_automatic_workflow_job
+#. odoo-python
+#: code:addons/sale_automatic_workflow_job/models/automatic_workflow_job.py:0
+#, python-format
+msgid "Mark sales order {} as done"
+msgstr "Marcar el pedido de ventas {} como hecho"
+
+#. module: sale_automatic_workflow_job
+#: model:ir.model,name:sale_automatic_workflow_job.model_queue_job
+msgid "Queue Job"
+msgstr "Cola de trabajo"
+
+#. module: sale_automatic_workflow_job
+#. odoo-python
+#: code:addons/sale_automatic_workflow_job/models/queue_job.py:0
+#, python-format
+msgid "Sale Automatic Workflow Job"
+msgstr "Flujo Automático de Trabajo"
+
+#. module: sale_automatic_workflow_job
+#: model:ir.model,name:sale_automatic_workflow_job.model_automatic_workflow_job
+msgid ""
+"Scheduler that will play automatically the validation of invoices, "
+"pickings..."
+msgstr ""
+"Programador que reproducirá automáticamente la validación de facturas, "
+"recogidas..."
+
+#. module: sale_automatic_workflow_job
+#. odoo-python
+#: code:addons/sale_automatic_workflow_job/models/automatic_workflow_job.py:0
+#, python-format
+msgid "Validate invoice {}"
+msgstr "Validar factura {}"
+
+#. module: sale_automatic_workflow_job
+#. odoo-python
+#: code:addons/sale_automatic_workflow_job/models/automatic_workflow_job.py:0
+#, python-format
+msgid "Validate sales order {}"
+msgstr "Validar pedido de venta {}"
+
+#. module: sale_automatic_workflow_job
+#. odoo-python
+#: code:addons/sale_automatic_workflow_job/models/automatic_workflow_job.py:0
+#, python-format
+msgid "Validate transfer {}"
+msgstr "Validar transferencia {}"

sale_automatic_workflow_job/i18n/it.po

@@ -0,0 +1,73 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# 	* sale_automatic_workflow_job
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 16.0\n"
+"Report-Msgid-Bugs-To: \n"
+"PO-Revision-Date: 2023-12-15 18:33+0000\n"
+"Last-Translator: mymage <stefano.consolaro@mymage.it>\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: sale_automatic_workflow_job
+#. odoo-python
+#: code:addons/sale_automatic_workflow_job/models/automatic_workflow_job.py:0
+#, python-format
+msgid "Create invoices for sales order {}"
+msgstr "Crea fattura per ordine di vendita {}"
+
+#. module: sale_automatic_workflow_job
+#. odoo-python
+#: code:addons/sale_automatic_workflow_job/models/automatic_workflow_job.py:0
+#, python-format
+msgid "Mark sales order {} as done"
+msgstr "Segna l'ordine di vendita {} come fatto"
+
+#. module: sale_automatic_workflow_job
+#: model:ir.model,name:sale_automatic_workflow_job.model_queue_job
+msgid "Queue Job"
+msgstr "Lavoro in coda"
+
+#. module: sale_automatic_workflow_job
+#. odoo-python
+#: code:addons/sale_automatic_workflow_job/models/queue_job.py:0
+#, python-format
+msgid "Sale Automatic Workflow Job"
+msgstr "Lavoro flusso automatico vendita"
+
+#. module: sale_automatic_workflow_job
+#: model:ir.model,name:sale_automatic_workflow_job.model_automatic_workflow_job
+msgid ""
+"Scheduler that will play automatically the validation of invoices, "
+"pickings..."
+msgstr ""
+"Schedulatore che riprodurrà in automatico la validazione delle fatture, "
+"prelievi..."
+
+#. module: sale_automatic_workflow_job
+#. odoo-python
+#: code:addons/sale_automatic_workflow_job/models/automatic_workflow_job.py:0
+#, python-format
+msgid "Validate invoice {}"
+msgstr "Validare la fattura {}"
+
+#. module: sale_automatic_workflow_job
+#. odoo-python
+#: code:addons/sale_automatic_workflow_job/models/automatic_workflow_job.py:0
+#, python-format
+msgid "Validate sales order {}"
+msgstr "Valida ordine di vendita {}"
+
+#. module: sale_automatic_workflow_job
+#. odoo-python
+#: code:addons/sale_automatic_workflow_job/models/automatic_workflow_job.py:0
+#, python-format
+msgid "Validate transfer {}"
+msgstr "Valida trasferimento {}"

sale_automatic_workflow_job/i18n/sale_automatic_workflow_job.pot

@@ -0,0 +1,62 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# 	* sale_automatic_workflow_job
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 18.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: sale_automatic_workflow_job
+#. odoo-python
+#: code:addons/sale_automatic_workflow_job/models/automatic_workflow_job.py:0
+msgid "Create invoices for sales order %s"
+msgstr ""
+
+#. module: sale_automatic_workflow_job
+#. odoo-python
+#: code:addons/sale_automatic_workflow_job/models/automatic_workflow_job.py:0
+msgid "Mark sales order %s as done"
+msgstr ""
+
+#. module: sale_automatic_workflow_job
+#: model:ir.model,name:sale_automatic_workflow_job.model_queue_job
+msgid "Queue Job"
+msgstr ""
+
+#. module: sale_automatic_workflow_job
+#. odoo-python
+#: code:addons/sale_automatic_workflow_job/models/queue_job.py:0
+msgid "Sale Automatic Workflow Job"
+msgstr ""
+
+#. module: sale_automatic_workflow_job
+#: model:ir.model,name:sale_automatic_workflow_job.model_automatic_workflow_job
+msgid ""
+"Scheduler that will play automatically the validation of invoices, "
+"pickings..."
+msgstr ""
+
+#. module: sale_automatic_workflow_job
+#. odoo-python
+#: code:addons/sale_automatic_workflow_job/models/automatic_workflow_job.py:0
+msgid "Send order %s confirmation mail"
+msgstr ""
+
+#. module: sale_automatic_workflow_job
+#. odoo-python
+#: code:addons/sale_automatic_workflow_job/models/automatic_workflow_job.py:0
+msgid "Validate invoice %s"
+msgstr ""
+
+#. module: sale_automatic_workflow_job
+#. odoo-python
+#: code:addons/sale_automatic_workflow_job/models/automatic_workflow_job.py:0
+msgid "Validate sales order %s"
+msgstr ""

sale_automatic_workflow_job/models/__init__.py

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

sale_automatic_workflow_job/models/automatic_workflow_job.py

@@ -0,0 +1,97 @@
+# Copyright 2020 Camptocamp (https://www.camptocamp.com)
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import models
+
+from odoo.addons.queue_job.job import identity_exact
+
+
+class AutomaticWorkflowJob(models.Model):
+    _inherit = "automatic.workflow.job"
+
+    def _do_validate_sale_order_job_options(self, sale, domain_filter):
+        description = self.env._("Validate sales order %s", sale.display_name)
+        return {
+            "description": description,
+            "identity_key": identity_exact,
+        }
+
+    def _do_send_order_confirmation_mail_job_options(self, sale):
+        description = self.env._("Send order %s confirmation mail", sale.display_name)
+        return {"description": description, "identity_key": identity_exact}
+
+    def _do_validate_sale_order(self, sale, domain_filter):
+        result = super()._do_validate_sale_order(sale, domain_filter)
+
+        if self.env.context.get("send_order_confirmation_mail"):
+            self.with_context(
+                auto_delay_do_validation_finished=True
+            )._do_send_order_confirmation_mail(sale)
+
+        return result
+
+    def _do_send_order_confirmation_mail(self, sale):
+        if self.env.context.get("auto_delay_do_validation_finished"):
+            return super()._do_send_order_confirmation_mail(sale)
+
+    def _validate_sale_orders(self, domain_filter):
+        with_context = self.with_context(
+            auto_delay_do_validation=True,
+            auto_delay_do_send_mail=True,
+            auto_delay_do_validation_finished=False,
+        )
+        return super(AutomaticWorkflowJob, with_context)._validate_sale_orders(
+            domain_filter
+        )
+
+    def _do_create_invoice_job_options(self, sale, domain_filter):
+        description = self.env._(
+            "Create invoices for sales order %s", sale.display_name
+        )
+        return {
+            "description": description,
+            "identity_key": identity_exact,
+        }
+
+    def _create_invoices(self, domain_filter):
+        with_context = self.with_context(auto_delay_do_create_invoice=True)
+        return super(AutomaticWorkflowJob, with_context)._create_invoices(domain_filter)
+
+    def _do_validate_invoice_job_options(self, invoice, domain_filter):
+        description = self.env._("Validate invoice %s", invoice.display_name)
+        return {
+            "description": description,
+            "identity_key": identity_exact,
+        }
+
+    def _validate_invoices(self, domain_filter):
+        with_context = self.with_context(auto_delay_do_validation=True)
+        return super(AutomaticWorkflowJob, with_context)._validate_invoices(
+            domain_filter
+        )
+
+    def _do_sale_done_job_options(self, sale, domain_filter):
+        description = self.env._("Mark sales order %s as done", sale.display_name)
+        return {
+            "description": description,
+            "identity_key": identity_exact,
+        }
+
+    def _sale_done(self, domain_filter):
+        with_context = self.with_context(auto_delay_do_sale_done=True)
+        return super(AutomaticWorkflowJob, with_context)._sale_done(domain_filter)
+
+    def _register_hook(self):
+        mapping = {
+            "_do_validate_sale_order": "auto_delay_do_validation",
+            "_do_send_order_confirmation_mail": "auto_delay_do_send_mail",
+            "_do_create_invoice": "auto_delay_do_create_invoice",
+            "_do_validate_invoice": "auto_delay_do_validation",
+            "_do_sale_done": "auto_delay_do_sale_done",
+        }
+        for method_name, context_key in mapping.items():
+            self._patch_method(
+                method_name,
+                self._patch_job_auto_delay(method_name, context_key=context_key),
+            )
+        return super()._register_hook()

sale_automatic_workflow_job/models/queue_job.py

@@ -0,0 +1,21 @@
+# Copyright 2020 Ecosoft Co., Ltd. (http://ecosoft.co.th)
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+from odoo import models
+
+
+class QueueJob(models.Model):
+    """Job status and result"""
+
+    _inherit = "queue.job"
+
+    def _related_action_sale_automatic_workflow(self):
+        obj = self.args[0]
+        action = {
+            "name": self.env._("Sale Automatic Workflow Job"),
+            "type": "ir.actions.act_window",
+            "res_model": obj._name,
+            "view_mode": "form",
+            "res_id": obj.id,
+        }
+        return action

sale_automatic_workflow_job/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["whool"]
+build-backend = "whool.buildapi"

sale_automatic_workflow_job/readme/CONTRIBUTORS.md

@@ -0,0 +1,5 @@
+- Guewen Baconnier \<<guewen.baconnier@camptocamp.com>\>
+- Saran Lim. \<<saranl@ecosoft.co.th>\>
+- Kitti U. \<<kittiu@ecosoft.co.th>\>
+- Chau Le \<<chaulb@trobz.com>\>
+

sale_automatic_workflow_job/readme/CREDITS.md

@@ -0,0 +1 @@
+The migration of this module from 16.0 to 18.0 was financially supported by Camptocamp.

sale_automatic_workflow_job/readme/DESCRIPTION.md

@@ -0,0 +1,15 @@
+Use Queue Jobs to process the Sales Automatic Workflow actions.
+
+The default behavior of the automatic workflow module is to use a
+scheduled action that searches all the record that need a workflow
+action and sequentially process all of them.
+
+It can hit some limits when the number of records is too high.
+
+This module keeps the scheduled action to search the records, but
+instead of directly executing the actions (confirm a sales order, create
+invoices for a sales order, validate invoices, ...), it creates one job
+per operation to do.
+
+It uses an identity key on the jobs so it will not create the same job
+for the same record and same operation twice.

sale_automatic_workflow_job/static/description/index.html

@@ -0,0 +1,442 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
+<title>Sale Automatic Workflow Job</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+Despite the name, some widely supported CSS2 features are used.
+
+See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+  border: 0 }
+
+table.borderless td, table.borderless th {
+  /* Override padding for "table.docutils td" with "! important".
+     The right padding separates the table cells. */
+  padding: 0 0.5em 0 0 ! important }
+
+.first {
+  /* Override more specific margin styles with "! important". */
+  margin-top: 0 ! important }
+
+.last, .with-subtitle {
+  margin-bottom: 0 ! important }
+
+.hidden {
+  display: none }
+
+.subscript {
+  vertical-align: sub;
+  font-size: smaller }
+
+.superscript {
+  vertical-align: super;
+  font-size: smaller }
+
+a.toc-backref {
+  text-decoration: none ;
+  color: black }
+
+blockquote.epigraph {
+  margin: 2em 5em ; }
+
+dl.docutils dd {
+  margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+  overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+  font-weight: bold }
+*/
+
+div.abstract {
+  margin: 2em 5em }
+
+div.abstract p.topic-title {
+  font-weight: bold ;
+  text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+  margin: 2em ;
+  border: medium outset ;
+  padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+  font-weight: bold ;
+  font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+  color: red ;
+  font-weight: bold ;
+  font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+   compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+  margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+  margin-top: 0.5em }
+*/
+
+div.dedication {
+  margin: 2em 5em ;
+  text-align: center ;
+  font-style: italic }
+
+div.dedication p.topic-title {
+  font-weight: bold ;
+  font-style: normal }
+
+div.figure {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+div.footer, div.header {
+  clear: both;
+  font-size: smaller }
+
+div.line-block {
+  display: block ;
+  margin-top: 1em ;
+  margin-bottom: 1em }
+
+div.line-block div.line-block {
+  margin-top: 0 ;
+  margin-bottom: 0 ;
+  margin-left: 1.5em }
+
+div.sidebar {
+  margin: 0 0 0.5em 1em ;
+  border: medium outset ;
+  padding: 1em ;
+  background-color: #ffffee ;
+  width: 40% ;
+  float: right ;
+  clear: right }
+
+div.sidebar p.rubric {
+  font-family: sans-serif ;
+  font-size: medium }
+
+div.system-messages {
+  margin: 5em }
+
+div.system-messages h1 {
+  color: red }
+
+div.system-message {
+  border: medium outset ;
+  padding: 1em }
+
+div.system-message p.system-message-title {
+  color: red ;
+  font-weight: bold }
+
+div.topic {
+  margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+  margin-top: 0.4em }
+
+h1.title {
+  text-align: center }
+
+h2.subtitle {
+  text-align: center }
+
+hr.docutils {
+  width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+  clear: left ;
+  float: left ;
+  margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+  clear: right ;
+  float: right ;
+  margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+table.align-center {
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.align-left {
+  text-align: left }
+
+.align-center {
+  clear: both ;
+  text-align: center }
+
+.align-right {
+  text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+  text-align: inherit }
+
+/* div.align-center * { */
+/*   text-align: left } */
+
+.align-top    {
+  vertical-align: top }
+
+.align-middle {
+  vertical-align: middle }
+
+.align-bottom {
+  vertical-align: bottom }
+
+ol.simple, ul.simple {
+  margin-bottom: 1em }
+
+ol.arabic {
+  list-style: decimal }
+
+ol.loweralpha {
+  list-style: lower-alpha }
+
+ol.upperalpha {
+  list-style: upper-alpha }
+
+ol.lowerroman {
+  list-style: lower-roman }
+
+ol.upperroman {
+  list-style: upper-roman }
+
+p.attribution {
+  text-align: right ;
+  margin-left: 50% }
+
+p.caption {
+  font-style: italic }
+
+p.credits {
+  font-style: italic ;
+  font-size: smaller }
+
+p.label {
+  white-space: nowrap }
+
+p.rubric {
+  font-weight: bold ;
+  font-size: larger ;
+  color: maroon ;
+  text-align: center }
+
+p.sidebar-title {
+  font-family: sans-serif ;
+  font-weight: bold ;
+  font-size: larger }
+
+p.sidebar-subtitle {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+p.topic-title {
+  font-weight: bold }
+
+pre.address {
+  margin-bottom: 0 ;
+  margin-top: 0 ;
+  font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+pre.code .ln { color: gray; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+  font-family: sans-serif ;
+  font-style: oblique }
+
+span.classifier-delimiter {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+span.interpreted {
+  font-family: sans-serif }
+
+span.option {
+  white-space: nowrap }
+
+span.pre {
+  white-space: pre }
+
+span.problematic, pre.problematic {
+  color: red }
+
+span.section-subtitle {
+  /* font-size relative to parent (h1..h6 element) */
+  font-size: 80% }
+
+table.citation {
+  border-left: solid 1px gray;
+  margin-left: 1px }
+
+table.docinfo {
+  margin: 2em 4em }
+
+table.docutils {
+  margin-top: 0.5em ;
+  margin-bottom: 0.5em }
+
+table.footnote {
+  border-left: solid 1px black;
+  margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+  padding-left: 0.5em ;
+  padding-right: 0.5em ;
+  vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+  font-weight: bold ;
+  text-align: left ;
+  white-space: nowrap ;
+  padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+  border: 0px;
+  border-top: 2px solid;
+  border-bottom: 2px solid;
+  border-collapse: collapse;
+}
+table.docutils.booktabs * {
+  border: 0px;
+}
+table.docutils.booktabs th {
+  border-bottom: thin solid;
+  text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+  font-size: 100% }
+
+ul.auto-toc {
+  list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="sale-automatic-workflow-job">
+<h1 class="title">Sale Automatic Workflow Job</h1>
+
+<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!! This file is generated by oca-gen-addon-readme !!
+!! changes will be overwritten.                   !!
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!! source digest: sha256:530fd5f9a887344d84d80c8f0eadd1193d52d578beb1f90b46784814fde5c1d7
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
+<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/sale-workflow/tree/18.0/sale_automatic_workflow_job"><img alt="OCA/sale-workflow" src="https://img.shields.io/badge/github-OCA%2Fsale--workflow-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/sale-workflow-18-0/sale-workflow-18-0-sale_automatic_workflow_job"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/sale-workflow&amp;target_branch=18.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
+<p>Use Queue Jobs to process the Sales Automatic Workflow actions.</p>
+<p>The default behavior of the automatic workflow module is to use a
+scheduled action that searches all the record that need a workflow
+action and sequentially process all of them.</p>
+<p>It can hit some limits when the number of records is too high.</p>
+<p>This module keeps the scheduled action to search the records, but
+instead of directly executing the actions (confirm a sales order, create
+invoices for a sales order, validate invoices, …), it creates one job
+per operation to do.</p>
+<p>It uses an identity key on the jobs so it will not create the same job
+for the same record and same operation twice.</p>
+<p><strong>Table of contents</strong></p>
+<div class="contents local topic" id="contents">
+<ul class="simple">
+<li><a class="reference internal" href="#bug-tracker" id="toc-entry-1">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="toc-entry-2">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="toc-entry-3">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="toc-entry-4">Contributors</a></li>
+<li><a class="reference internal" href="#other-credits" id="toc-entry-5">Other credits</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-6">Maintainers</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="section" id="bug-tracker">
+<h1><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h1>
+<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/sale-workflow/issues">GitHub Issues</a>.
+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
+<a class="reference external" href="https://github.com/OCA/sale-workflow/issues/new?body=module:%20sale_automatic_workflow_job%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<p>Do not contact contributors directly about support or help with technical issues.</p>
+</div>
+<div class="section" id="credits">
+<h1><a class="toc-backref" href="#toc-entry-2">Credits</a></h1>
+<div class="section" id="authors">
+<h2><a class="toc-backref" href="#toc-entry-3">Authors</a></h2>
+<ul class="simple">
+<li>Camptocamp</li>
+</ul>
+</div>
+<div class="section" id="contributors">
+<h2><a class="toc-backref" href="#toc-entry-4">Contributors</a></h2>
+<ul class="simple">
+<li>Guewen Baconnier &lt;<a class="reference external" href="mailto:guewen.baconnier&#64;camptocamp.com">guewen.baconnier&#64;camptocamp.com</a>&gt;</li>
+<li>Saran Lim. &lt;<a class="reference external" href="mailto:saranl&#64;ecosoft.co.th">saranl&#64;ecosoft.co.th</a>&gt;</li>
+<li>Kitti U. &lt;<a class="reference external" href="mailto:kittiu&#64;ecosoft.co.th">kittiu&#64;ecosoft.co.th</a>&gt;</li>
+<li>Chau Le &lt;<a class="reference external" href="mailto:chaulb&#64;trobz.com">chaulb&#64;trobz.com</a>&gt;</li>
+</ul>
+</div>
+<div class="section" id="other-credits">
+<h2><a class="toc-backref" href="#toc-entry-5">Other credits</a></h2>
+<p>The migration of this module from 16.0 to 18.0 was financially supported
+by Camptocamp.</p>
+</div>
+<div class="section" id="maintainers">
+<h2><a class="toc-backref" href="#toc-entry-6">Maintainers</a></h2>
+<p>This module is maintained by the OCA.</p>
+<a class="reference external image-reference" href="https://odoo-community.org">
+<img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
+</a>
+<p>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.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/sale-workflow/tree/18.0/sale_automatic_workflow_job">OCA/sale-workflow</a> project on GitHub.</p>
+<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
+</div>
+</div>
+</div>
+</body>
+</html>

sale_automatic_workflow_job/tests/__init__.py

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

sale_automatic_workflow_job/tests/test_auto_workflow_job.py

@@ -0,0 +1,168 @@
+# Copyright 2020 Camptocamp (https://www.camptocamp.com)
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo.tests import tagged
+
+from odoo.addons.queue_job.job import identity_exact
+from odoo.addons.queue_job.tests.common import trap_jobs
+from odoo.addons.sale_automatic_workflow.tests.common import (
+    TestAutomaticWorkflowMixin,
+    TestCommon,
+)
+
+
+@tagged("post_install", "-at_install")
+class TestAutoWorkflowJob(TestCommon, TestAutomaticWorkflowMixin):
+    def create_sale_order(self, workflow, override=None):
+        order = super().create_sale_order(workflow, override)
+        order.order_line.product_id.invoice_policy = "order"
+        return order
+
+    def assert_job_delayed(self, delayable_cls, delayable, method_name, args):
+        # .with_delay() has been called once
+        self.assertEqual(delayable_cls.call_count, 1)
+        delay_args, delay_kwargs = delayable_cls.call_args
+        # .with_delay() has been called on self.env["automatic.workflow.job"]
+        self.assertEqual(delay_args, (self.env["automatic.workflow.job"],))
+        # .with_delay() with the following options
+        self.assertEqual(delay_kwargs.get("identity_key"), identity_exact)
+        # check what's passed to the job method
+        method = getattr(delayable, method_name)
+        self.assertEqual(method.call_count, 1)
+        delay_args, delay_kwargs = method.call_args
+        self.assertEqual(delay_args, args)
+        self.assertDictEqual(delay_kwargs, {})
+
+    def test_validate_sale_order(self):
+        workflow = self.create_full_automatic({"send_order_confirmation_mail": True})
+        self.sale = self.create_sale_order(workflow)
+
+        with trap_jobs() as trap:
+            self.run_job()  # run automatic workflow cron
+
+            trap.assert_jobs_count(
+                1, only=self.env["automatic.workflow.job"]._do_validate_sale_order
+            )
+
+            args = (
+                self.sale,
+                [
+                    ("state", "=", "draft"),
+                    ("workflow_process_id", "=", self.sale.workflow_process_id.id),
+                ],
+            )
+
+            trap.assert_enqueued_job(
+                self.env["automatic.workflow.job"]._do_validate_sale_order,
+                args=args,
+                kwargs={},
+                properties=dict(
+                    identity_key=identity_exact,
+                ),
+            )
+
+            trap.assert_jobs_count(
+                1,
+                only=self.env[
+                    "automatic.workflow.job"
+                ]._do_send_order_confirmation_mail,
+            )
+
+    def test_create_invoice(self):
+        workflow = self.create_full_automatic()
+        self.sale = self.create_sale_order(workflow)
+        self.sale.action_confirm()
+
+        with trap_jobs() as trap:
+            self.run_job()  # run automatic workflow cron
+
+            trap.assert_jobs_count(
+                1, only=self.env["automatic.workflow.job"]._do_create_invoice
+            )
+
+            args = (
+                self.sale,
+                [
+                    ("state", "=", "sale"),
+                    ("invoice_status", "=", "to invoice"),
+                    ("workflow_process_id", "=", self.sale.workflow_process_id.id),
+                ],
+            )
+
+            trap.assert_enqueued_job(
+                self.env["automatic.workflow.job"]._do_create_invoice,
+                args=args,
+                kwargs={},
+                properties=dict(
+                    identity_key=identity_exact,
+                ),
+            )
+
+    def test_validate_invoice(self):
+        workflow = self.create_full_automatic()
+        self.sale = self.create_sale_order(workflow)
+        self.sale.action_confirm()
+        self.sale._create_invoices()
+        invoice = self.sale.invoice_ids
+
+        with trap_jobs() as trap:
+            self.run_job()  # run automatic workflow cron
+
+            trap.assert_jobs_count(
+                1, only=self.env["automatic.workflow.job"]._do_validate_invoice
+            )
+
+            args = (
+                invoice,
+                [
+                    ("state", "=", "draft"),
+                    ("posted_before", "=", False),
+                    ("workflow_process_id", "=", self.sale.workflow_process_id.id),
+                ],
+            )
+
+            trap.assert_enqueued_job(
+                self.env["automatic.workflow.job"]._do_validate_invoice,
+                args=args,
+                kwargs={},
+                properties=dict(
+                    identity_key=identity_exact,
+                ),
+            )
+
+    def test_sale_done(self):
+        workflow = self.create_full_automatic()
+        self.sale = self.create_sale_order(workflow)
+        self.sale.action_confirm()
+        self.sale._create_invoices()
+
+        # disable invoice validation for we don't care
+        # in this test
+        self.sale.workflow_process_id.validate_invoice = False
+        # activate the 'sale done' workflow
+        self.sale.workflow_process_id.sale_done = True
+
+        with trap_jobs() as trap:
+            self.run_job()  # run automatic workflow cron
+
+            trap.assert_jobs_count(
+                1, only=self.env["automatic.workflow.job"]._do_sale_done
+            )
+
+            args = (
+                self.sale,
+                [
+                    ("state", "=", "sale"),
+                    ("invoice_status", "=", "invoiced"),
+                    ("workflow_process_id", "=", self.sale.workflow_process_id.id),
+                ],
+            )
+
+            trap.assert_enqueued_job(
+                self.env["automatic.workflow.job"]._do_sale_done,
+                args=args,
+                kwargs={},
+                properties=dict(
+                    identity_key=identity_exact,
+                ),
+            )