[IMP] web_form_banner: Partially support in-group target XPath

- Add (partial) support for elements inside groups to be a target
  XPath without distorting the presentation
- Remove obsolete bits

Author: yostashiro

web_form_banner/README.rst

@@ -212,8 +212,9 @@ Known issues / Roadmap
 Banner presentation inside `<group>`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Placing a full-width inline banner inside `<group>` is currently not supported. The
-presentation of the banner and the child fields will be distorted.
+Placing a full-width inline banner inside a `<group>` is only partially supported.
+Depending on the target XPath (especially when targeting a `<field/>` rendered by
+certain widgets), the banner or surrounding fields may render distorted.
 
 Limitations of `draft` eval context variable
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

web_form_banner/models/ir_model.py

@@ -36,30 +36,28 @@ def get_view(self, view_id=None, view_type="form", **options):
         except Exception:
             return res
         for rule in rules:
-            target = root.xpath(rule.target_xpath or "//sheet")
-            if not target:
+            targets = root.xpath(rule.target_xpath or "//sheet")
+            if not targets:
                 continue
-            # Lightweight placeholder; JS will fill and toggle visibility
-            css = "o_form_banner alert alert-%s" % (rule.severity or "danger")
+            target = targets[0]
             trigger_fields = ",".join(rule.trigger_field_ids.mapped("name"))
-            node = etree.Element(
+            banner = etree.Element(
                 "div",
                 {
-                    "class": css,
-                    "role": "alert",
+                    "class": "o_form_banner alert o_invisible_modifier",
+                    "role": "status",
                     "data-rule-id": str(rule.id),
                     "data-model": self._name,
-                    "data-default-severity": (rule.severity or "danger"),
                     "data-trigger-fields": trigger_fields,
-                    "style": "display:none;",
                 },
             )
-            parent = target[0].getparent()
-            if parent is None:
-                continue
+            in_group = any(a.tag == "group" for a in target.iterancestors())
+            if in_group:
+                # To avoid the layout distortion issue when the target is inside a group
+                banner.set("colspan", "2")
             if rule.position == "before":
-                parent.insert(parent.index(target[0]), node)
+                target.addprevious(banner)
             else:
-                target[0].addnext(node)
+                target.addnext(banner)
         res["arch"] = etree.tostring(root, encoding="unicode")
         return res

web_form_banner/readme/ROADMAP.rst

@@ -1,8 +1,9 @@
 Banner presentation inside `<group>`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Placing a full-width inline banner inside `<group>` is currently not supported. The
-presentation of the banner and the child fields will be distorted.
+Placing a full-width inline banner inside a `<group>` is only partially supported.
+Depending on the target XPath (especially when targeting a `<field/>` rendered by
+certain widgets), the banner or surrounding fields may render distorted.
 
 Limitations of `draft` eval context variable
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

web_form_banner/static/description/index.html

@@ -557,8 +557,9 @@ <h2><a class="toc-backref" href="#toc-entry-5">Message setting examples:</a></h2
 <h1><a class="toc-backref" href="#toc-entry-6">Known issues / Roadmap</a></h1>
 <div class="section" id="banner-presentation-inside-group">
 <h2><a class="toc-backref" href="#toc-entry-7">Banner presentation inside <cite>&lt;group&gt;</cite></a></h2>
-<p>Placing a full-width inline banner inside <cite>&lt;group&gt;</cite> is currently not supported. The
-presentation of the banner and the child fields will be distorted.</p>
+<p>Placing a full-width inline banner inside a <cite>&lt;group&gt;</cite> is only partially supported.
+Depending on the target XPath (especially when targeting a <cite>&lt;field/&gt;</cite> rendered by
+certain widgets), the banner or surrounding fields may render distorted.</p>
 </div>
 <div class="section" id="limitations-of-draft-eval-context-variable">
 <h2><a class="toc-backref" href="#toc-entry-8">Limitations of <cite>draft</cite> eval context variable</a></h2>

web_form_banner/static/src/js/web_form_banner.esm.js

@@ -85,10 +85,10 @@ async function refreshBanners(ctrl, extraChanges) {
             null
         );
         if ((ctrl.__wfbSeq || 0) !== seq) return;
-        const v = r && r.visible;
-        el.style.display = v ? "" : "none";
-        if (!v) continue;
-        el.className = "o_form_banner alert alert-" + r.severity;
+        // Replace only the alert class
+        el.classList.remove("alert-info", "alert-warning", "alert-danger");
+        el.classList.add("alert-" + r.severity);
+        el.classList.toggle("o_invisible_modifier", !(r && r.visible));
         setHtml(el, r.html);
     }
 }

web_form_banner/static/src/scss/web_form_banner.scss

@@ -5,11 +5,6 @@
     padding-bottom: 6px;
 }
 
-// keep only a tiny gap between banners
-.o_form_view .o_form_banner.alert + .o_form_banner.alert {
-    margin-top: 4px;
-}
-
 // avoid extra gaps from paragraphs inside the banner
 .o_form_view .o_form_banner.alert p:last-child {
     margin-bottom: 0;

web_form_banner/tests/test_web_form_banner.py

@@ -3,11 +3,11 @@
 
 from lxml import etree
 
-from odoo.tests.common import SavepointCase, tagged
+from odoo.tests.common import TransactionCase, tagged
 
 
 @tagged("post_install", "-at_install")
-class TestFieldsViewGetPartnerBanner(SavepointCase):
+class TestFieldsViewGetPartnerBanner(TransactionCase):
     @classmethod
     def setUpClass(cls):
         super().setUpClass()
@@ -25,12 +25,7 @@ def setUpClass(cls):
         cls.p_len22 = cls.Partner.create({"name": "Professor Charles Xavier"})  # 22
 
     def _get_arch_tree(self, model, view):
-        res = model.fields_view_get(
-            view_id=view.id,
-            view_type="form",
-            toolbar=False,
-            submenu=False,
-        )
+        res = model.get_view(view_id=view.id, view_type="form")
         return etree.fromstring(res["arch"])
 
     def _find_banner_node(self, tree, rule):
@@ -63,18 +58,10 @@ def test_injected_once_with_expected_attrs(self):
         banner_node = self._find_banner_node(tree, self.rule_name)
         # Basic attributes from the server injection
         self.assertEqual(banner_node.get("data-model"), "res.partner")
-        self.assertEqual(
-            banner_node.get("data-default-severity"), self.rule_name.severity
-        )
-        self.assertEqual(banner_node.get("role"), "alert")
-        self.assertEqual(banner_node.get("style"), "display:none;")
+        self.assertEqual(banner_node.get("role"), "status")
         # Class list includes the expected CSS classes
         classes = (banner_node.get("class") or "").split()
-        for required in (
-            "o_form_banner",
-            "alert",
-            "alert-%s" % (self.rule_name.severity),
-        ):
+        for required in ("o_form_banner", "alert", "o_invisible_modifier"):
             self.assertIn(required, classes)
         # Ensure it's not duplicated
         all_banners = tree.xpath("//div[contains(@class,'o_form_banner')]")
@@ -99,7 +86,7 @@ def test_position_relative_to_sheet(self):
     def test_not_injected_on_unrelated_model(self):
         Company = self.env["res.company"]
         view = self.env.ref("base.view_company_form")
-        res = Company.fields_view_get(view_id=view.id, view_type="form")
+        res = Company.get_view(view_id=view.id, view_type="form")
         tree = etree.fromstring(res["arch"])
         self.assertFalse(tree.xpath("//div[contains(@class,'o_form_banner')]"))