diff --git a/README.md b/README.md index 79fc4bae845..cbb2c90eaab 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,7 @@ addon | version | maintainers | summary [session_db](session_db/) | 19.0.1.0.0 | sbidoul | Store sessions in DB [test_auditlog](test_auditlog/) | 19.0.1.0.0 | | Additional unit tests for Audit Log based on accounting models [tracking_manager](tracking_manager/) | 19.0.1.0.0 | Kev-Roche sebastienbeau | This module tracks all fields of a model, including one2many and many2many ones. +[tracking_manager_domain](tracking_manager_domain/) | 19.0.1.0.0 | CRogos | This module extends the tracking manager to allow to define a domain on fields to track changes only when certain conditions apply. [upgrade_analysis](upgrade_analysis/) | 19.0.1.0.4 | StefanRijnhart legalsylvain | Performs a difference analysis between modules installed on two different Odoo instances [//]: # (end addons) diff --git a/setup/_metapackage/pyproject.toml b/setup/_metapackage/pyproject.toml index 825300504f7..b117a7bc5bb 100644 --- a/setup/_metapackage/pyproject.toml +++ b/setup/_metapackage/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "odoo-addons-oca-server-tools" -version = "19.0.20260528.0" +version = "19.0.20260529.0" dependencies = [ "odoo-addon-auditlog==19.0.*", "odoo-addon-base_cron_exclusion==19.0.*", @@ -23,6 +23,7 @@ dependencies = [ "odoo-addon-session_db==19.0.*", "odoo-addon-test_auditlog==19.0.*", "odoo-addon-tracking_manager==19.0.*", + "odoo-addon-tracking_manager_domain==19.0.*", "odoo-addon-upgrade_analysis==19.0.*", ] classifiers=[ diff --git a/tracking_manager_domain/README.rst b/tracking_manager_domain/README.rst new file mode 100644 index 00000000000..434910cdaa0 --- /dev/null +++ b/tracking_manager_domain/README.rst @@ -0,0 +1,105 @@ +.. image:: https://odoo-community.org/readme-banner-image + :target: https://odoo-community.org/get-involved?utm_source=readme + :alt: Odoo Community Association + +======================= +Tracking Manager Domain +======================= + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:5095c579ba93e262e1134ea8e98685295868b7bdb5b1e544d1289c6f8e19d230 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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/license-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%2Fserver--tools-lightgray.png?logo=github + :target: https://github.com/OCA/server-tools/tree/19.0/tracking_manager_domain + :alt: OCA/server-tools +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-tools-19-0/server-tools-19-0-tracking_manager_domain + :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/server-tools&target_branch=19.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module extends the Tracking Manager module to allow defining a +domain filter on tracked fields. Changes are only recorded when the +specified domain condition is satisfied on the parent record. + +This is useful when you want to limit tracking to specific record states +or conditions, for example only tracking a field when a partner is a +company. + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +- Add an optional domain on the field to limit tracking on certain + condition. + +|fields| + +.. |fields| image:: https://raw.githubusercontent.com/OCA/server-tools/19.0/tracking_manager_domain/static/description/fields.drawio.png + +Bug Tracker +=========== + +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. + +Credits +======= + +Authors +------- + +* glueckkanja AG + +Contributors +------------ + +- Christopher Rogos +- Nils Coenen + +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. + +.. |maintainer-CRogos| image:: https://github.com/CRogos.png?size=40px + :target: https://github.com/CRogos + :alt: CRogos + +Current `maintainer `__: + +|maintainer-CRogos| + +This module is part of the `OCA/server-tools `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/tracking_manager_domain/__init__.py b/tracking_manager_domain/__init__.py new file mode 100644 index 00000000000..0650744f6bc --- /dev/null +++ b/tracking_manager_domain/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/tracking_manager_domain/__manifest__.py b/tracking_manager_domain/__manifest__.py new file mode 100644 index 00000000000..9023d23546d --- /dev/null +++ b/tracking_manager_domain/__manifest__.py @@ -0,0 +1,21 @@ +# Copyright 2025 glueckkanja AG () - Christopher Rogos +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +{ + "name": "Tracking Manager Domain", + "summary": "This module extends the tracking manager to" + " allow to define a domain on fields to track changes " + "only when certain conditions apply.", + "version": "19.0.1.0.0", + "category": "Tools", + "website": "https://github.com/OCA/server-tools", + "author": "glueckkanja AG, Odoo Community Association (OCA)", + "maintainers": ["CRogos"], + "license": "AGPL-3", + "application": False, + "installable": True, + "depends": ["tracking_manager"], + "data": [ + "views/ir_model_fields.xml", + ], +} diff --git a/tracking_manager_domain/i18n/it.po b/tracking_manager_domain/i18n/it.po new file mode 100644 index 00000000000..375ce8c5cb8 --- /dev/null +++ b/tracking_manager_domain/i18n/it.po @@ -0,0 +1,41 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * tracking_manager_domain +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 17.0\n" +"Report-Msgid-Bugs-To: \n" +"PO-Revision-Date: 2025-04-08 06:44+0000\n" +"Last-Translator: mymage \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 5.10.4\n" + +#. module: tracking_manager_domain +#: model:ir.model.fields,help:tracking_manager_domain.field_ir_model_fields__tracking_domain +msgid "" +"Add a domain filter to only track changes when certain condition apply on " +"the parent record." +msgstr "" +"Aggiungere un filtro di dominio per tracciare le modifiche solo quando si " +"applicano determinate condizioni al record padre." + +#. module: tracking_manager_domain +#: model:ir.model,name:tracking_manager_domain.model_base +msgid "Base" +msgstr "Base" + +#. module: tracking_manager_domain +#: model:ir.model,name:tracking_manager_domain.model_ir_model_fields +msgid "Fields" +msgstr "Campi" + +#. module: tracking_manager_domain +#: model:ir.model.fields,field_description:tracking_manager_domain.field_ir_model_fields__tracking_domain +msgid "Tracking Domain" +msgstr "Dominio tracciamento" diff --git a/tracking_manager_domain/i18n/tracking_manager_domain.pot b/tracking_manager_domain/i18n/tracking_manager_domain.pot new file mode 100644 index 00000000000..f030e3fce49 --- /dev/null +++ b/tracking_manager_domain/i18n/tracking_manager_domain.pot @@ -0,0 +1,46 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * tracking_manager_domain +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 19.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: tracking_manager_domain +#: model:ir.model.fields,help:tracking_manager_domain.field_ir_model_fields__tracking_domain +msgid "" +"Add a domain filter to only track changes when certain condition apply on " +"the parent record." +msgstr "" + +#. module: tracking_manager_domain +#: model:ir.model,name:tracking_manager_domain.model_base +msgid "Base" +msgstr "" + +#. module: tracking_manager_domain +#: model:ir.model.fields,field_description:tracking_manager_domain.field_ir_model_fields__display_name +msgid "Display Name" +msgstr "" + +#. module: tracking_manager_domain +#: model:ir.model,name:tracking_manager_domain.model_ir_model_fields +msgid "Fields" +msgstr "" + +#. module: tracking_manager_domain +#: model:ir.model.fields,field_description:tracking_manager_domain.field_ir_model_fields__id +msgid "ID" +msgstr "" + +#. module: tracking_manager_domain +#: model:ir.model.fields,field_description:tracking_manager_domain.field_ir_model_fields__tracking_domain +msgid "Tracking Domain" +msgstr "" diff --git a/tracking_manager_domain/models/__init__.py b/tracking_manager_domain/models/__init__.py new file mode 100644 index 00000000000..c0f19c503d0 --- /dev/null +++ b/tracking_manager_domain/models/__init__.py @@ -0,0 +1,2 @@ +from . import ir_model_fields +from . import models diff --git a/tracking_manager_domain/models/ir_model_fields.py b/tracking_manager_domain/models/ir_model_fields.py new file mode 100644 index 00000000000..463c2343fd8 --- /dev/null +++ b/tracking_manager_domain/models/ir_model_fields.py @@ -0,0 +1,22 @@ +# Copyright 2025 glueckkanja AG () - Christopher Rogos +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import fields, models + + +class IrModelFields(models.Model): + _inherit = "ir.model.fields" + + tracking_domain = fields.Char( + help="Add a domain filter to only track changes when" + " certain condition apply on the parent record." + ) + + def write(self, vals): + if "tracking_domain" in vals: + self.env.registry.clear_cache() + self.check_access("write") + custom_tracking_domain = vals.pop("tracking_domain") + self._write({"tracking_domain": custom_tracking_domain}) + self.invalidate_model(fnames=["tracking_domain"]) + return super().write(vals) diff --git a/tracking_manager_domain/models/models.py b/tracking_manager_domain/models/models.py new file mode 100644 index 00000000000..701f734cb33 --- /dev/null +++ b/tracking_manager_domain/models/models.py @@ -0,0 +1,98 @@ +# Copyright 2025 glueckkanja AG () - Christopher Rogos +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + + +from ast import literal_eval +from collections import defaultdict + +from odoo import models, tools + + +class Base(models.AbstractModel): + _inherit = "base" + + @tools.ormcache() + def _tm_all_tracking_domain_fields(self): + cr = self.env.cr + cr.execute( + """ + SELECT id, model, name, tracking_domain + FROM ir_model_fields + WHERE tracking_domain is not null + and tracking_domain != '' + and tracking_domain != '[]' + """ + ) + result = defaultdict(dict) + for row in cr.dictfetchall(): + result[row["model"]][row["name"]] = row + return result + + def _tm_post_message(self, data): + for model_name, model_data in data.items(): + all_tracking_domain_fields = self._tm_all_tracking_domain_fields()[ + model_name + ] + # check if any fields with tracking_domain + if not all_tracking_domain_fields: + continue + record_to_remove = [] + for record_id, messages_by_field in model_data.items(): + fields_to_remove = [] + record = self.env[model_name].browse(record_id) + if not record.exists(): + # if a record have been modify and then deleted + # it's not need to track the change so skip it + continue + for field_name, _messages in messages_by_field.items(): + field_data = all_tracking_domain_fields.get(field_name, False) + if field_data and not record.filtered_domain( + literal_eval(field_data["tracking_domain"]) + ): + fields_to_remove.append(field_name) + for field_name in fields_to_remove: + del model_data[record_id][field_name] + if not model_data[record_id]: + record_to_remove.append(record_id) + + for record_id in record_to_remove: + del model_data[record_id] + return super()._tm_post_message(data) + + def _mail_track(self, tracked_fields, initial_values): + changes, tracking_value_ids = super()._mail_track( + tracked_fields, initial_values + ) + + # TODO: add properties support on domain filters + tracking_value_field_ids = [ + tracking_value_id[2]["field_id"] + for tracking_value_id in tracking_value_ids + if "field_id" in tracking_value_id[2] + ] + if tracking_value_field_ids: + all_tracking_domain_fields = self._tm_all_tracking_domain_fields()[ + self._name + ] + + if all_tracking_domain_fields: + # remove entries that are not matching the tracking_domain of the field + fields_to_remove = [] + for field_name in tracked_fields: + field_data = all_tracking_domain_fields.get(field_name, False) + if field_data and not self.filtered_domain( + literal_eval(field_data["tracking_domain"]) + ): + fields_to_remove.append(field_data["id"]) + res_changes = [] + res_tracking_value_ids = [] + # remove values from tracking result + for change, tracking_value_id in zip( + changes, tracking_value_ids, strict=True + ): + if tracking_value_id[2]["field_id"] not in fields_to_remove: + res_changes.append(change) + res_tracking_value_ids.append(tracking_value_id) + changes = res_changes + tracking_value_ids = res_tracking_value_ids + return changes, tracking_value_ids diff --git a/tracking_manager_domain/pyproject.toml b/tracking_manager_domain/pyproject.toml new file mode 100644 index 00000000000..4231d0cccb3 --- /dev/null +++ b/tracking_manager_domain/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/tracking_manager_domain/readme/CONTRIBUTORS.md b/tracking_manager_domain/readme/CONTRIBUTORS.md new file mode 100644 index 00000000000..335b6f2a372 --- /dev/null +++ b/tracking_manager_domain/readme/CONTRIBUTORS.md @@ -0,0 +1,2 @@ +- Christopher Rogos \<\> +- Nils Coenen \<\> diff --git a/tracking_manager_domain/readme/DESCRIPTION.md b/tracking_manager_domain/readme/DESCRIPTION.md new file mode 100644 index 00000000000..f0562ad5bb5 --- /dev/null +++ b/tracking_manager_domain/readme/DESCRIPTION.md @@ -0,0 +1,6 @@ +This module extends the Tracking Manager module to allow defining a domain +filter on tracked fields. Changes are only recorded when the specified domain +condition is satisfied on the parent record. + +This is useful when you want to limit tracking to specific record states or +conditions, for example only tracking a field when a partner is a company. diff --git a/tracking_manager_domain/readme/USAGE.md b/tracking_manager_domain/readme/USAGE.md new file mode 100644 index 00000000000..494b053e9ed --- /dev/null +++ b/tracking_manager_domain/readme/USAGE.md @@ -0,0 +1,3 @@ +- Add an optional domain on the field to limit tracking on certain condition. + +![fields](./static/description/fields.drawio.png) \ No newline at end of file diff --git a/tracking_manager_domain/static/description/fields.drawio.png b/tracking_manager_domain/static/description/fields.drawio.png new file mode 100644 index 00000000000..070c704a702 Binary files /dev/null and b/tracking_manager_domain/static/description/fields.drawio.png differ diff --git a/tracking_manager_domain/static/description/icon.png b/tracking_manager_domain/static/description/icon.png new file mode 100644 index 00000000000..3a0328b516c Binary files /dev/null and b/tracking_manager_domain/static/description/icon.png differ diff --git a/tracking_manager_domain/static/description/index.html b/tracking_manager_domain/static/description/index.html new file mode 100644 index 00000000000..5886b94a9eb --- /dev/null +++ b/tracking_manager_domain/static/description/index.html @@ -0,0 +1,446 @@ + + + + + +README.rst + + + +
+ + + +Odoo Community Association + +
+

Tracking Manager Domain

+ +

Beta License: AGPL-3 OCA/server-tools Translate me on Weblate Try me on Runboat

+

This module extends the Tracking Manager module to allow defining a +domain filter on tracked fields. Changes are only recorded when the +specified domain condition is satisfied on the parent record.

+

This is useful when you want to limit tracking to specific record states +or conditions, for example only tracking a field when a partner is a +company.

+

Table of contents

+ +
+

Usage

+
    +
  • Add an optional domain on the field to limit tracking on certain +condition.
    • +
+

fields

+
+
+

Bug Tracker

+

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.

+
+
+

Credits

+
+

Authors

+
    +
  • glueckkanja AG
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

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:

+

CRogos

+

This module is part of the OCA/server-tools project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+
+ + diff --git a/tracking_manager_domain/tests/__init__.py b/tracking_manager_domain/tests/__init__.py new file mode 100644 index 00000000000..483288c9af7 --- /dev/null +++ b/tracking_manager_domain/tests/__init__.py @@ -0,0 +1 @@ +from . import test_models diff --git a/tracking_manager_domain/tests/test_models.py b/tracking_manager_domain/tests/test_models.py new file mode 100644 index 00000000000..d7942596d26 --- /dev/null +++ b/tracking_manager_domain/tests/test_models.py @@ -0,0 +1,179 @@ +# Copyright 2025 glueckkanja AG () - Christopher Rogos +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from unittest.mock import patch + +from odoo import Command +from odoo.tests.common import TransactionCase + + +class TestMailTrack(TransactionCase): + def setUp(self): + super().setUp() + + self.Field = self.env["ir.model.fields"] + self.field_phone = self.Field.search( + [("model", "=", "res.partner"), ("name", "=", "phone")], limit=1 + ) + self.field_phone.write({"tracking_domain": "[('is_company', '=', True)]"}) + + def test_mail_track(self): + # arrange + company = self.env.ref("base.main_partner") + tracked_fields = {"phone": {"string": "Phone", "type": "char"}} + initial_values = {"phone": "1234"} + + # act + changes, tracking_value_ids = company._mail_track( + tracked_fields, initial_values + ) + + # assert + # Check if changes and tracking_value_ids are returned correctly + self.assertEqual(len(changes), 1) + self.assertEqual(len(tracking_value_ids), 1) + + # Check if the field is tracked correctly + tracking_value = tracking_value_ids[0][2] + self.assertEqual(tracking_value["field_id"], self.field_phone.id) + + def test_mail_track_with_non_matching_domain(self): + # arrange + person = self.env.ref("base.partner_admin") + + tracked_fields = {"phone": {"string": "Phone", "type": "char"}} + initial_values = {"phone": "1234"} + + # act + changes, tracking_value_ids = person._mail_track(tracked_fields, initial_values) + + # assert + # Check if changes and tracking_value_ids are empty when domain does not match + self.assertEqual(len(changes), 0) + self.assertEqual(len(tracking_value_ids), 0) + + def test_mail_track_lead_properties_noerror(self): + # arrange + person = self.env.ref("base.main_partner") + tracked_fields = { + "lead_properties": {"string": "Properties", "type": "properties"} + } + initial_values = {"3f32dd2678757113": False} + + patch_changes = {1234: "lead_properties"} + patch_tracking_value_ids = [ + Command.create( + { + "old_value_integer": 15, + "new_value_integer": 10, + "old_value_char": "Azure Interior", + "new_value_char": "Deco Addict", + "field_info": { + "desc": "Properties: Ev", + "name": "lead_properties", + "type": "many2one", + }, + } + ) + ] + + with patch( + "odoo.addons.mail.models.models.Base._mail_track", + return_value=(patch_changes, patch_tracking_value_ids), + ): + # act + person._mail_track(tracked_fields, initial_values) + + def test_tm_post_message_keep_all(self): + partner = self.env.ref("base.main_partner") + + data = { + "res.partner": {partner.id: {"phone": [{"mode": "test", "message": "msg"}]}} + } + + fields = { + "res.partner": { + "phone": {"id": 1, "tracking_domain": "[('is_company', '=', True)]"} + } + } + + with patch( + "odoo.addons.tracking_manager.models.models.Base._tm_post_message", + return_value=data, + ): + with patch.object( + type(self.env["base"]), + "_tm_all_tracking_domain_fields", + return_value=fields, + ): + res = self.env["base"]._tm_post_message(data) + + self.assertIn(partner.id, res["res.partner"]) + + def test_tm_post_message_remove_field(self): + partner = self.env.ref("base.main_partner") + + data = { + "res.partner": {partner.id: {"phone": [{"mode": "test", "message": "msg"}]}} + } + + fields = { + "res.partner": { + "phone": {"id": 1, "tracking_domain": "[('is_company', '=', False)]"} + } + } + + with patch( + "odoo.addons.tracking_manager.models.models.Base._tm_post_message", + return_value={"res.partner": {}}, + ): + with patch.object( + type(self.env["base"]), + "_tm_all_tracking_domain_fields", + return_value=fields, + ): + res = self.env["base"]._tm_post_message(data) + + self.assertEqual(res, {"res.partner": {}}) + + def test_tm_post_message_missing_record(self): + data = { + "res.partner": {999999: {"phone": [{"mode": "test", "message": "msg"}]}} + } + + fields = {"res.partner": {"phone": {"id": 1, "tracking_domain": "[]"}}} + + with patch( + "odoo.addons.tracking_manager.models.models.Base._tm_post_message", + return_value={"res.partner": {}}, + ): + with patch.object( + type(self.env["base"]), + "_tm_all_tracking_domain_fields", + return_value=fields, + ): + res = self.env["base"]._tm_post_message(data) + + self.assertEqual(res, {"res.partner": {}}) + + def test_tm_post_message_no_tracking_fields(self): + partner = self.env.ref("base.main_partner") + + data = { + "res.partner": {partner.id: {"phone": [{"mode": "test", "message": "msg"}]}} + } + + fields = {"res.partner": {}} + + with patch( + "odoo.addons.tracking_manager.models.models.Base._tm_post_message", + return_value=data, + ): + with patch.object( + type(self.env["base"]), + "_tm_all_tracking_domain_fields", + return_value=fields, + ): + res = self.env["base"]._tm_post_message(data) + + self.assertEqual(res, data) diff --git a/tracking_manager_domain/views/ir_model_fields.xml b/tracking_manager_domain/views/ir_model_fields.xml new file mode 100644 index 00000000000..13186554a45 --- /dev/null +++ b/tracking_manager_domain/views/ir_model_fields.xml @@ -0,0 +1,21 @@ + + + + ir.model.fields + + + + + + + + +