[ADD] util.fields: handle ir.exports model/fields renames/removal

Implement proper fixing and/or removal of ir.exports and
ir.exports.line records on model/fields renames/removal:
- renamed fields: update affected ir.exports.line records
- removed fields: remove affected ir.exports.line records
- renamed models: update affected ir.exports records `resource`
- removed models: remove affected ir.exports.line / ir.exports records

Some of these cases were already handled but have been improved.

Specifically:
- for renamed fields, previously was done by doing a simple string
  replacement, which is not good enough because export lines can
  reference fields paths, and these in turn *might* contain paths to
  multiple fields with the same name on different models, only some of
  which are affected. Now the fields path get properly resolved for
  renaming, only the affected fields path parts are updated.
- for removed fields, previously no action was taken, leaving a broken
  export template and UI traceback. Now the affected export lines are
  removed, using fields paths resolution.
- for renamed and removed models, this was already handled by the
  indirect_references mechanism, but now export lines for the removed
  models are checked with the same mechanism for fields above.

Additionally, unit tests have been added to make sure these cases are
properly handled by the code.

closes #84

Signed-off-by: Christophe Simonis (chs) <[email protected]>
Co-authored-by: Alvaro Fuentes <[email protected]>

Author: andreabak

src/base/tests/test_util.py

@@ -407,6 +407,63 @@ def test_remove_field(self, domain, expected):
         self.assertEqual(altered_domain, expected)
 
 
+class TestIrExports(UnitTestCase):
+    def setUp(self):
+        super().setUp()
+        self.export = self.env["ir.exports"].create(
+            [
+                {
+                    "name": "Test currency export",
+                    "resource": "res.currency",
+                    "export_fields": [
+                        (0, 0, {"name": "full_name"}),
+                        (0, 0, {"name": "rate_ids/company_id/user_ids/name"}),
+                        (0, 0, {"name": "rate_ids/company_id/user_ids/partner_id/user_ids/name"}),
+                        (0, 0, {"name": "rate_ids/name"}),
+                    ],
+                }
+            ]
+        )
+        util.flush(self.export)
+
+    def _invalidate(self):
+        util.invalidate(self.export.export_fields)
+        util.invalidate(self.export)
+
+    def test_rename_field(self):
+        util.rename_field(self.cr, "res.partner", "user_ids", "renamed_user_ids")
+        self._invalidate()
+        self.assertEqual(
+            self.export.export_fields[2].name, "rate_ids/company_id/user_ids/partner_id/renamed_user_ids/name"
+        )
+
+        util.rename_field(self.cr, "res.users", "name", "new_name")
+        self._invalidate()
+        self.assertEqual(self.export.export_fields[1].name, "rate_ids/company_id/user_ids/new_name")
+
+    def test_remove_field(self):
+        util.remove_field(self.cr, "res.currency.rate", "company_id")
+        self._invalidate()
+        self.assertEqual(len(self.export.export_fields), 2)
+        self.assertEqual(self.export.export_fields[0].name, "full_name")
+        self.assertEqual(self.export.export_fields[1].name, "rate_ids/name")
+
+    def test_rename_model(self):
+        util.rename_model(self.cr, "res.currency", "res.currency2")
+        self._invalidate()
+        self.assertEqual(self.export.resource, "res.currency2")
+
+    def test_remove_model(self):
+        util.remove_model(self.cr, "res.currency.rate")
+        self._invalidate()
+        self.assertEqual(len(self.export.export_fields), 1)
+        self.assertEqual(self.export.export_fields[0].name, "full_name")
+
+        util.remove_model(self.cr, "res.currency")
+        self.cr.execute("SELECT * FROM ir_exports WHERE id = %s", [self.export.id])
+        self.assertFalse(self.cr.fetchall())
+
+
 class TestIterBrowse(UnitTestCase):
     def test_iter_browse_iter(self):
         cr = self.env.cr

src/util/fields.py

@@ -40,7 +40,13 @@ def make_index_name(table_name, column_name):
 from .const import ENVIRON
 from .domains import _adapt_one_domain, _replace_path, _valid_path_to, adapt_domains
 from .exceptions import SleepyDeveloperError
-from .helpers import _dashboard_actions, _validate_model, table_of_model
+from .helpers import (
+    _dashboard_actions,
+    _remove_export_lines,
+    _validate_model,
+    resolve_model_fields_path,
+    table_of_model,
+)
 from .inherit import for_each_inherit
 from .misc import SelfPrintEvalContext, log_progress, version_gte
 from .orm import env, invalidate
@@ -202,6 +208,9 @@ def clean_context(context):
             [(fieldname, fieldname + " desc"), model, r"\y{}\y".format(fieldname)],
         )
 
+    # ir.exports.line
+    _remove_export_lines(cr, model, fieldname)
+
     def adapter(leaf, is_or, negated):
         # replace by TRUE_LEAF, unless negated or in a OR operation but not negated
         if is_or ^ negated:
@@ -1071,21 +1080,32 @@ def _update_field_usage_multi(cr, models, old, new, domain_adapter=None, skip_in
         cr.execute(q.format(col_prefix=col_prefix), p)
 
         # ir.exports.line
-        q = """
-            UPDATE ir_exports_line l
-               SET name = regexp_replace(l.name, %(old)s, %(new)s, 'g')
-        """
         if only_models:
-            q += """
-              FROM ir_exports e
-             WHERE e.id = l.export_id
-               AND e.resource IN %(models)s
-               AND
-            """
-        else:
-            q += "WHERE "
-        q += "l.name ~ %(old)s"
-        cr.execute(q, p)
+            cr.execute(
+                """
+                SELECT el.id,
+                       e.resource,
+                       STRING_TO_ARRAY(el.name, '/')
+                  FROM ir_exports_line el
+                  JOIN ir_exports e
+                    ON el.export_id = e.id
+                 WHERE el.name ~ %s
+                """,
+                [r"\y{}\y".format(old)],
+            )
+            fixed_lines_paths = {}
+            for line_id, line_model, line_path in cr.fetchall():
+                new_path = [
+                    new if x.field_name == old and x.field_model in only_models else x.field_name
+                    for x in resolve_model_fields_path(cr, line_model, line_path)
+                ]
+                if len(new_path) == len(line_path) and new_path != line_path:
+                    fixed_lines_paths[line_id] = "/".join(new_path)
+            if fixed_lines_paths:
+                cr.execute(
+                    "UPDATE ir_exports_line SET name = (%s::jsonb)->>(id::text) WHERE id IN %s",
+                    [Json(fixed_lines_paths), tuple(fixed_lines_paths)],
+                )
 
         # mail.alias
         if column_exists(cr, "mail_alias", "alias_defaults"):

src/util/helpers.py

@@ -315,3 +315,27 @@ def resolve_model_fields_path(cr, model, path):
         {"model": model, "path": list(path)},
     )
     return [FieldsPathPart(**row) for row in cr.dictfetchall()]
+
+
+def _remove_export_lines(cr, model, field=None):
+    q = """
+    SELECT el.id,
+           e.resource,
+           STRING_TO_ARRAY(el.name, '/')
+      FROM ir_exports_line el
+      JOIN ir_exports e
+        ON el.export_id = e.id
+    """
+    if field:
+        q = cr.mogrify(q + " WHERE el.name ~ %s ", [r"\y{}\y".format(field)]).decode()
+    cr.execute(q)
+    to_rem = [
+        line_id
+        for line_id, line_model, line_path in cr.fetchall()
+        if any(
+            x.field_model == model and (field is None or x.field_name == field)
+            for x in resolve_model_fields_path(cr, line_model, line_path)
+        )
+    ]
+    if to_rem:
+        cr.execute("DELETE FROM ir_exports_line WHERE id IN %s", [tuple(to_rem)])

src/util/indirect_references.py

@@ -39,7 +39,7 @@ def indirect_references(cr, bound_only=False):
         IR("ir_model_fields", "relation", None),  # destination of a relation field
         IR("ir_model_data", "model", "res_id"),
         IR("ir_filters", "model_id", None, set_unknown=True),  # YUCK!, not an id
-        IR("ir_exports", "resource", None, set_unknown=True),
+        IR("ir_exports", "resource", None),
         IR("ir_ui_view", "model", None, set_unknown=True),
         IR("ir_values", "model", "res_id"),
         IR("wkf_transition", "trigger_model", None),

src/util/models.py

@@ -11,7 +11,7 @@
 
 from .const import ENVIRON
 from .fields import IMD_FIELD_PATTERN, remove_field
-from .helpers import _ir_values_value, _validate_model, model_of_table, table_of_model
+from .helpers import _ir_values_value, _remove_export_lines, _validate_model, model_of_table, table_of_model
 from .indirect_references import indirect_references
 from .inherit import for_each_inherit, inherit_parents
 from .misc import _cached, chunks, log_progress
@@ -129,6 +129,9 @@ def remove_model(cr, model, drop_table=True, ignore_m2m=()):
                 cr.execute(query, args + (tuple(ids),))
                 notify = notify or bool(cr.rowcount)
 
+    # for ir.exports.line we have to take care of "nested" references in fields "paths"
+    _remove_export_lines(cr, model)
+
     _rm_refs(cr, model)
 
     cr.execute(