[IMP] project_task_code: parameter for unicity constraint

SQL constraint may break runboat builds if data is inconsistent.
The constraint is now checked in python and only if
unique_task_code parameter is set to True.

Author: robinkeunen

project_task_code/README.rst

@@ -2,10 +2,13 @@
 Sequential Code for Tasks
 =========================
 
-.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
    !! This file is generated by oca-gen-addon-readme !!
    !! changes will be overwritten.                   !!
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:28fcd535608cf7941d0c7cae839e6e0a5b226e3bce1968cde58bdac4eaced570
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
     :target: https://odoo-community.org/page/development-status
@@ -20,10 +23,10 @@ Sequential Code for Tasks
     :target: https://translation.odoo-community.org/projects/project-16-0/project-16-0-project_task_code
     :alt: Translate me on Weblate
 .. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
-    :target: https://runboat.odoo-community.org/webui/builds.html?repo=OCA/project&target_branch=16.0
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/project&target_branch=16.0
     :alt: Try me on Runboat
 
-|badge1| |badge2| |badge3| |badge4| |badge5| 
+|badge1| |badge2| |badge3| |badge4| |badge5|
 
 This module adds a sequential code for tasks.
 
@@ -35,11 +38,8 @@ This module adds a sequential code for tasks.
 Configuration
 =============
 
-To change the task code sequence, you must:
-
-#. Activate the developer mode.
-#. Go to Settings > Technical > Sequences & Identifiers > Sequences.
-#. Click on "Task code" sequence to edit.
+To check the task code unicity (recommended) check "Unique Task Code"
+in the settings of the Project app.
 
 Usage
 =====
@@ -55,7 +55,7 @@ Bug Tracker
 
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/project/issues>`_.
 In case of trouble, please check there if your issue has already been reported.
-If you spotted it first, help us smashing it by providing a detailed and welcomed
+If you spotted it first, help us to smash it by providing a detailed and welcomed
 `feedback <https://github.com/OCA/project/issues/new?body=module:%20project_task_code%0Aversion:%2016.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.

project_task_code/__manifest__.py

@@ -17,6 +17,7 @@
     "data": [
         "data/task_sequence.xml",
         "views/project_view.xml",
+        "views/res_config_settings_view.xml",
     ],
     "installable": True,
     "pre_init_hook": "pre_init_hook",

project_task_code/hooks.py

@@ -3,6 +3,9 @@
 
 from odoo import SUPERUSER_ID, api
 
+# todo add parameter constraint in migration
+# add param to view
+
 
 def pre_init_hook(cr):
     """

project_task_code/migrations/16.0.1.0.0/post-migration.py

@@ -0,0 +1,12 @@
+# Copyright 2023 Coop IT Easy
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import SUPERUSER_ID, api
+
+
+def migrate(cr, version):
+    # In previous version of the module, the unicity constraint
+    # was checked in sql. It is now checked with python if unique_task_code
+    # is True.
+    env = api.Environment(cr, SUPERUSER_ID, {})
+    env["ir.config_parameter"].set_param("project_task_code.unique_task_code", True)

project_task_code/migrations/16.0.1.0.0/pre-migration.py

@@ -0,0 +1,12 @@
+# Copyright 2023 Coop IT Easy
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+
+def migrate(cr, version):
+    cr.execute(
+        """
+    ALTER TABLE project_task
+    DROP CONSTRAINT IF EXISTS
+     project_task_project_task_unique_code
+    """
+    )

project_task_code/models/__init__.py

@@ -1,3 +1,4 @@
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
 
 from . import project_task
+from . import res_config_settings

project_task_code/models/project_task.py

@@ -2,6 +2,7 @@
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
 
 from odoo import _, api, fields, models
+from odoo.exceptions import ValidationError
 
 
 class ProjectTask(models.Model):
@@ -15,10 +16,6 @@ class ProjectTask(models.Model):
         copy=False,
     )
 
-    _sql_constraints = [
-        ("project_task_unique_code", "UNIQUE (code)", _("The code must be unique!")),
-    ]
-
     @api.model_create_multi
     def create(self, vals_list):
         for vals in vals_list:
@@ -37,3 +34,28 @@ def name_get(self):
             name = "[{}] {}".format(rec.code, task[1])
             new_result.append((rec.id, name))
         return new_result
+
+    @api.constrains("code")
+    def _check_project_task_unique_code(self):
+        unique_task_code = bool(
+            self.env["ir.config_parameter"]
+            .sudo()
+            .get_param("project_task_code.unique_task_code")
+        )
+        if not unique_task_code:
+            return
+
+        for task in self:
+            if (
+                task.code
+                and task.code != "/"
+                and self.search(
+                    [
+                        ("code", "=", task.code),
+                        ("id", "!=", task.id),
+                        ("company_id", "=", task.company_id.id),
+                    ],
+                    limit=1,
+                )
+            ):
+                raise ValidationError(_("The code must be unique!"))

project_task_code/models/res_config_settings.py

@@ -0,0 +1,13 @@
+# Copyright 2023 Coop IT Easy
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import fields, models
+
+
+class ResConfigSettings(models.TransientModel):
+    _inherit = "res.config.settings"
+
+    unique_task_code = fields.Boolean(
+        default=False,
+        config_parameter="project_task_code.unique_task_code",
+    )

project_task_code/readme/CONFIGURE.rst

@@ -1,5 +1,2 @@
-To change the task code sequence, you must:
-
-#. Activate the developer mode.
-#. Go to Settings > Technical > Sequences & Identifiers > Sequences.
-#. Click on "Task code" sequence to edit.
+To check the task code unicity (recommended) check "Unique Task Code"
+in the settings of the Project app.

project_task_code/static/description/index.html

@@ -1,20 +1,20 @@
-<?xml version="1.0" encoding="utf-8" ?>
+<?xml version="1.0" encoding="utf-8"?>
 <!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: http://docutils.sourceforge.net/" />
+<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
 <title>Sequential Code for Tasks</title>
 <style type="text/css">
 
 /*
 :Author: David Goodger ([email protected])
-:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
 :Copyright: This stylesheet has been placed in the public domain.
 
 Default cascading style sheet for the HTML output of Docutils.
 
-See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
 customize this style sheet.
 */
 
@@ -366,59 +366,57 @@ <h1 class="title">Sequential Code for Tasks</h1>
 <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! This file is generated by oca-gen-addon-readme !!
 !! changes will be overwritten.                   !!
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!! source digest: sha256:28fcd535608cf7941d0c7cae839e6e0a5b226e3bce1968cde58bdac4eaced570
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<p><a class="reference external" 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" 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" href="https://github.com/OCA/project/tree/16.0/project_task_code"><img alt="OCA/project" src="https://img.shields.io/badge/github-OCA%2Fproject-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/project-16-0/project-16-0-project_task_code"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runboat.odoo-community.org/webui/builds.html?repo=OCA/project&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
+<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/project/tree/16.0/project_task_code"><img alt="OCA/project" src="https://img.shields.io/badge/github-OCA%2Fproject-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/project-16-0/project-16-0-project_task_code"><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/project&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
 <p>This module adds a sequential code for tasks.</p>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
-<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
-<li><a class="reference internal" href="#usage" id="id2">Usage</a></li>
-<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li>
-<li><a class="reference internal" href="#credits" id="id4">Credits</a><ul>
-<li><a class="reference internal" href="#authors" id="id5">Authors</a></li>
-<li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="id7">Maintainers</a></li>
+<li><a class="reference internal" href="#configuration" id="toc-entry-1">Configuration</a></li>
+<li><a class="reference internal" href="#usage" id="toc-entry-2">Usage</a></li>
+<li><a class="reference internal" href="#bug-tracker" id="toc-entry-3">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="toc-entry-4">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="toc-entry-5">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="toc-entry-6">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-7">Maintainers</a></li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="section" id="configuration">
-<h1><a class="toc-backref" href="#id1">Configuration</a></h1>
-<p>To change the task code sequence, you must:</p>
-<ol class="arabic simple">
-<li>Activate the developer mode.</li>
-<li>Go to Settings &gt; Technical &gt; Sequences &amp; Identifiers &gt; Sequences.</li>
-<li>Click on “Task code” sequence to edit.</li>
-</ol>
+<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
+<p>To check the task code unicity (recommended) check “Unique Task Code”
+in the settings of the Project app.</p>
 </div>
 <div class="section" id="usage">
-<h1><a class="toc-backref" href="#id2">Usage</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
 <p>To use this module, you need to:</p>
 <p>#. Go to menu Project &gt; Search &gt; Tasks and create a new task, and you get a
 new code saving it.
 #. If you duplicate a task, you will get a new code for the new task.</p>
 </div>
 <div class="section" id="bug-tracker">
-<h1><a class="toc-backref" href="#id3">Bug Tracker</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-3">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/project/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 smashing it by providing a detailed and welcomed
+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/project/issues/new?body=module:%20project_task_code%0Aversion:%2016.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="#id4">Credits</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-4">Credits</a></h1>
 <div class="section" id="authors">
-<h2><a class="toc-backref" href="#id5">Authors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-5">Authors</a></h2>
 <ul class="simple">
 <li>OdooMRP team</li>
 <li>AvanzOSC</li>
 <li>Tecnativa</li>
 </ul>
 </div>
 <div class="section" id="contributors">
-<h2><a class="toc-backref" href="#id6">Contributors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
 <ul class="simple">
 <li>Oihane Crucelaegui &lt;<a class="reference external" href="mailto:oihanecrucelaegi&#64;avanzosc.es">oihanecrucelaegi&#64;avanzosc.es</a>&gt;</li>
 <li>Pedro M. Baeza &lt;<a class="reference external" href="mailto:pedro.baeza&#64;serviciosbaeza.com">pedro.baeza&#64;serviciosbaeza.com</a>&gt;</li>
@@ -436,7 +434,7 @@ <h2><a class="toc-backref" href="#id6">Contributors</a></h2>
 </ul>
 </div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#id7">Maintainers</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-7">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

project_task_code/tests/test_project_task_code.py

@@ -2,15 +2,17 @@
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
 
 import odoo.tests.common as common
+from odoo.exceptions import ValidationError
 
 
 class TestProjectTaskCode(common.TransactionCase):
-    def setUp(self):
-        super().setUp()
-        self.project_task_model = self.env["project.task"]
-        self.ir_sequence_model = self.env["ir.sequence"]
-        self.task_sequence = self.env.ref("project_task_code.sequence_task")
-        self.project_task = self.env.ref("project.project_1_task_1")
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.project_task_model = cls.env["project.task"]
+        cls.ir_sequence_model = cls.env["ir.sequence"]
+        cls.task_sequence = cls.env.ref("project_task_code.sequence_task")
+        cls.project_task = cls.env.ref("project.project_1_task_1")
 
     def test_old_task_code_assign(self):
         project_tasks = self.project_task_model.search([])
@@ -38,3 +40,28 @@ def test_name_get(self):
         )
         result = project_task.name_get()
         self.assertEqual(result[0][1], "[%s] Task Testing Get Name" % code)
+
+    def test_unique_task_code(self):
+        task_1 = self.project_task_model.create(
+            {
+                "name": "Task 1",
+            }
+        )
+        task_2 = self.project_task_model.create(
+            {
+                "name": "Task 2",
+            }
+        )
+        task_3 = self.project_task_model.create(
+            {
+                "name": "Task 3",
+            }
+        )
+        # by default, unicity is not checked
+        task_2.code = task_1.code
+
+        self.env["ir.config_parameter"].sudo().set_param(
+            "project_task_code.unique_task_code", True
+        )
+        with self.assertRaises(ValidationError, msg="The code must be unique!"):
+            task_3.code = task_1.code

project_task_code/views/project_view.xml

@@ -6,8 +6,15 @@
         <field name="inherit_id" ref="project.view_task_form2" />
         <field name="arch" type="xml">
             <field name="name" position="before">
-                <field name="code" class="oe_inline" />
-                <span class="oe_inline"> - </span>
+                <field
+                    name="code"
+                    class="oe_inline"
+                    attrs="{'invisible': [('code', 'in', ['/', False])]}"
+                />
+                <span
+                    class="oe_inline"
+                    attrs="{'invisible': [('code', 'in', ['/', False])]}"
+                > - </span>
             </field>
         </field>
     </record>
@@ -17,7 +24,7 @@
         <field name="inherit_id" ref="project.view_task_tree2" />
         <field name="arch" type="xml">
             <field name="name" position="before">
-                <field name="code" />
+                <field name="code" optional="hide" />
             </field>
         </field>
     </record>
@@ -26,9 +33,13 @@
         <field name="model">project.task</field>
         <field name="inherit_id" ref="project.view_task_kanban" />
         <field name="arch" type="xml">
-            <field name="name" position="before">
-                <field name="code" />
-            </field>
+            <xpath expr="//field[@name='name']/.." position="before">
+                <field
+                    name="code"
+                    class="me-2"
+                    attrs="{'invisible': [('code', '=', '/')]}"
+                />
+            </xpath>
         </field>
     </record>
     <record id="project_task_code_search_view" model="ir.ui.view">