[IMP] web_refresh_from_backend U

ivs-cetmix · ivs-cetmix · commit 8d628ac39d77 · 2026-03-09T22:24:16.000+01:00
- Coalesce notifications in case multiple notifications are sent in a
  short period of time.
  This allows to avoid multiple refreshes of the same view and potential
  UI glitches.
- Use explicitly created users in tests. Using demo data was a bad idea,
  sorry.

Task: 5286
diff --git a/web_refresh_from_backend/static/src/views/form/form_controller_patch.esm.js b/web_refresh_from_backend/static/src/views/form/form_controller_patch.esm.js
@@ -30,63 +30,61 @@ patch(FormController.prototype, {
     },
 
     /**
-     * Handle bus notification for view refresh.
-     * Listens for notifications with type "web.refresh_view" and delegates
-     * processing to _handleViewRefresh.
+     * Handle bus notification batch for view refresh.
+     * Coalesces the batch: if any notification matches, refreshes once.
      *
      * @param {Event} event - Bus notification event
      */
     async _onBusNotification({detail: notifications}) {
         if (!this.model || !this.model.root) {
             return;
         }
-
-        for (const {payload, type} of notifications) {
-            if (type === "web.refresh_view") {
-                await this._handleViewRefresh(payload);
-            }
+        const shouldRefresh = notifications.some(
+            ({type, payload}) =>
+                type === "web.refresh_view" && this._shouldRefreshView(payload)
+        );
+        if (shouldRefresh) {
+            await this.refreshForm();
         }
     },
 
     /**
-     * Handle view refresh notification.
+     * Check whether a refresh notification is relevant to this form.
      *
-     * Only refreshes when:
+     * Returns true when all of the following hold:
      *  - model matches current form model
-     *  - requested view types include "form" (if specified)
-     *  - record id matches current record (if specified)
+     *  - requested view types include "form" (or none specified)
+     *  - record id matches current record (or none specified)
+     *  - form is not inside a dialog / wizard
      *
-     * @param {Object} notification - Notification payload
+     * @param {Object} payload - Notification payload
+     * @returns {Boolean}
      */
-    async _handleViewRefresh(notification) {
-        const {model, view_types = [], rec_ids = []} = notification;
+    _shouldRefreshView(payload) {
+        const {model, view_types = [], rec_ids = []} = payload;
 
         if (this.props.resModel !== model) {
-            return;
+            return false;
         }
-
         if (view_types.length > 0 && !view_types.includes("form")) {
-            return;
+            return false;
         }
-
         const currentResId = this.model && this.model.root && this.model.root.resId;
         if (rec_ids.length > 0 && (!currentResId || !rec_ids.includes(currentResId))) {
-            return;
+            return false;
         }
-
         // Skip refresh when form is in a dialog or when a wizard is on top
         // of the stack. Refreshing in that context can leave wizard/confirmation
         // dialogs stuck open (e.g. confirm="..." in wizard view).
         if (this.env.inDialog) {
-            return;
+            return false;
         }
         const currentController = this.actionService.currentController;
         const currentAction = currentController && currentController.action;
         if (currentAction && currentAction.target === "new") {
-            return;
+            return false;
         }
-
-        await this.refreshForm();
+        return true;
     },
 
     /**
diff --git a/web_refresh_from_backend/static/src/views/kanban/kanban_controller_patch.esm.js b/web_refresh_from_backend/static/src/views/kanban/kanban_controller_patch.esm.js
@@ -26,48 +26,51 @@ patch(KanbanController.prototype, {
     },
 
     /**
-     * Handle bus notification for view refresh.
+     * Handle bus notification batch for view refresh.
+     * Coalesces the batch: if any notification matches, refreshes once.
      *
      * @param {Event} event - Bus notification event
      */
     async _onBusNotification({detail: notifications}) {
         if (!this.model || !this.model.root) {
             return;
         }
-
-        for (const {payload, type} of notifications) {
-            if (type === "web.refresh_view") {
-                await this._handleViewRefresh(payload);
-            }
+        const shouldRefresh = notifications.some(
+            ({type, payload}) =>
+                type === "web.refresh_view" && this._shouldRefreshView(payload)
+        );
+        if (shouldRefresh) {
+            await this.refreshList();
         }
     },
 
     /**
-     * Handle view refresh notification.
+     * Check whether a refresh notification is relevant to this kanban.
+     *
+     * Returns true when all of the following hold:
+     *  - model matches current kanban model
+     *  - requested view types include "kanban" (or none specified)
+     *  - at least one loaded record id is in rec_ids (or none specified)
      *
-     * @param {Object} notification - Notification payload
+     * @param {Object} payload - Notification payload
+     * @returns {Boolean}
      */
-    async _handleViewRefresh(notification) {
-        const {model, view_types = [], rec_ids = []} = notification;
+    _shouldRefreshView(payload) {
+        const {model, view_types = [], rec_ids = []} = payload;
 
         if (this.props.resModel !== model) {
-            return;
+            return false;
         }
-
         if (view_types.length > 0 && !view_types.includes("kanban")) {
-            return;
+            return false;
         }
-
         if (rec_ids.length > 0) {
             const loadedIds = this.getLoadedRecordIds();
-            const shouldReload = loadedIds.some((id) => rec_ids.includes(id));
-
-            if (!shouldReload) {
-                return;
+            if (!loadedIds.some((id) => rec_ids.includes(id))) {
+                return false;
             }
         }
-
-        await this.refreshList();
+        return true;
     },
 
     /**
diff --git a/web_refresh_from_backend/static/src/views/list/list_controller_patch.esm.js b/web_refresh_from_backend/static/src/views/list/list_controller_patch.esm.js
@@ -27,52 +27,55 @@ patch(ListController.prototype, {
     },
 
     /**
-     * Handle bus notification for view refresh.
+     * Handle bus notification batch for view refresh.
+     * Coalesces the batch: if any notification matches, refreshes once.
      *
      * @param {Event} event - Bus notification event
      */
     async _onBusNotification({detail: notifications}) {
         if (!this.model || !this.model.root) {
             return;
         }
-
-        for (const {payload, type} of notifications) {
-            if (type === "web.refresh_view") {
-                await this._handleViewRefresh(payload);
-            }
+        const shouldRefresh = notifications.some(
+            ({type, payload}) =>
+                type === "web.refresh_view" && this._shouldRefreshView(payload)
+        );
+        if (shouldRefresh) {
+            await this.refreshList();
         }
     },
 
     /**
-     * Handle view refresh notification.
+     * Check whether a refresh notification is relevant to this list.
+     *
+     * Returns true when all of the following hold:
+     *  - model matches current list model
+     *  - requested view types include "list" or "tree" (or none specified)
+     *  - at least one loaded record id is in rec_ids (or none specified)
      *
-     * @param {Object} notification - Notification payload
+     * @param {Object} payload - Notification payload
+     * @returns {Boolean}
      */
-    async _handleViewRefresh(notification) {
-        const {model, view_types = [], rec_ids = []} = notification;
+    _shouldRefreshView(payload) {
+        const {model, view_types = [], rec_ids = []} = payload;
 
         if (this.props.resModel !== model) {
-            return;
+            return false;
         }
-
         if (
             view_types.length > 0 &&
             !view_types.includes("list") &&
             !view_types.includes("tree")
         ) {
-            return;
+            return false;
         }
-
         if (rec_ids.length > 0) {
             const loadedIds = this.getLoadedRecordIds();
-            const shouldReload = loadedIds.some((id) => rec_ids.includes(id));
-
-            if (!shouldReload) {
-                return;
+            if (!loadedIds.some((id) => rec_ids.includes(id))) {
+                return false;
             }
         }
-
-        await this.refreshList();
+        return true;
     },
 
     /**
diff --git a/web_refresh_from_backend/tests/test_reload_views.py b/web_refresh_from_backend/tests/test_reload_views.py
@@ -4,19 +4,21 @@
 from unittest.mock import patch
 
 from odoo.tests import tagged
-from odoo.tests.common import TransactionCase
+
+from odoo.addons.base.tests.common import BaseCommon
 
 
 @tagged("post_install", "-at_install")
-class TestReloadViews(TransactionCase):
+class TestReloadViews(BaseCommon):
     @classmethod
     def setUpClass(cls):
         super().setUpClass()
         cls.user_admin = cls.env.ref("base.user_admin")
-        cls.user_demo = cls.env.ref("base.user_demo")
-        cls.partner = cls.env["res.partner"].create(
+        cls.user_demo = cls.env["res.users"].create(
             {
-                "name": "Test Partner",
+                "name": "Test User",
+                "login": "test_refresh_user",
+                "email": "test_refresh@example.com",
             }
         )
 
